sheets/functions/conversion.xml

0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005     <GroupName>Conversion</GroupName>
0006
0007     <Function>
0008         <Name>BOOL2STRING</Name>
0009         <Type>String</Type>
0010         <Parameter>
0011             <Comment>Bool value to convert</Comment>
0012             <Type range="false">Boolean</Type>
0013         </Parameter>
0014         <Help>
0015             <Text>The BOOL2STRING() function returns a string value for a given boolean value. This method is intended for using a boolean in methods which require a string</Text>
0016             <Syntax>BOOL2STRING(value)</Syntax>
0017             <Example>BOOL2STRING(true) returns "True"</Example>
0018             <Example>BOOL2STRING(false) returns "False"</Example>
0019             <Example>upper(BOOL2STRING(find("nan";"banana"))) returns TRUE</Example>
0020         </Help>
0021     </Function>
0022
0023     <Function>
0024         <Name>INT2BOOL</Name>
0025         <Type>Boolean</Type>
0026         <Parameter>
0027             <Comment>Integer value to convert</Comment>
0028             <Type range="false">Int</Type>
0029         </Parameter>
0030         <Help>
0031             <Text>The INT2BOOL() function returns a boolean value for a given integer number. This method is intended for using an integer in methods which require a boolean. It only accepts 0 or 1. If any other value is given, false is returned.</Text>
0032             <Syntax>INT2BOOL(value)</Syntax>
0033             <Example>INT2BOOL(1) returns true</Example>
0034             <Example>INT2BOOL(0) returns false</Example>
0035             <Example>OR(INT2BOOL(1); false) returns true</Example>
0036             <Related>BOOL2INT</Related>
0037         </Help>
0038     </Function>
0039
0040     <Function>
0041         <Name>BOOL2INT</Name>
0042         <Type>Int</Type>
0043         <Parameter>
0044             <Comment>Bool value to convert</Comment>
0045             <Type range="false">Boolean</Type>
0046         </Parameter>
0047         <Help>
0048             <Text>The BOOL2INT() function returns an integer value for a given boolean value. This method is intended for using a boolean value in methods which require an integer.</Text>
0049             <Syntax>BOOL2INT(value)</Syntax>
0050             <Example>BOOL2INT(True) returns 1</Example>
0051             <Example>BOOL2INT(False) returns 0</Example>
0052             <Related>INT2BOOL</Related>
0053         </Help>
0054     </Function>
0055
0056     <Function>
0057         <Name>NUM2STRING</Name>
0058         <Type>String</Type>
0059         <Parameter>
0060             <Comment>Number to convert into string</Comment>
0061             <Type range="false">Float</Type>
0062         </Parameter>
0063         <Help>
0064             <Text>The NUM2STRING() function returns a string value for a given number. Note that Calligra Sheets can auto-convert numbers to strings if needed, so this function should rarely be needed.</Text>
0065             <Syntax>NUM2STRING(value)</Syntax>
0066             <Example>NUM2STRING(10) returns "10"</Example>
0067             <Example>NUM2STRING(2.05) returns "2.05"</Example>
0068             <Example>=find("101";NUM2STRING(A1)) (A1 = 2.010102) returns True</Example>
0069             <Related>STRING</Related>
0070         </Help>
0071     </Function>
0072
0073     <Function>
0074         <Name>STRING</Name>
0075         <Type>String</Type>
0076         <Parameter>
0077             <Comment>Number to convert into string</Comment>
0078             <Type range="false">Float</Type>
0079         </Parameter>
0080         <Help>
0081             <Text>The STRING() function returns a string value for a given number. It is the same as the NUM2STRING function.</Text>
0082             <Related>NUM2STRING</Related>
0083         </Help>
0084     </Function>
0085
0086     <Function>
0087         <Name>CHARTOASCII</Name>
0088         <Type>Int</Type>
0089         <Parameter>
0090             <Comment>A one character string to convert</Comment>
0091             <Type>String</Type>
0092         </Parameter>
0093         <Help>
0094             <Text>The CHARTOASCII() function returns the ASCII code for the given character.</Text>
0095             <Syntax>CHARTOASCII(value)</Syntax>
0096             <Example>CHARTOASCII("v") returns 118</Example>
0097             <Example>CHARTOASCII(r) is an error. The character must be in quotes.</Example>
0098         </Help>
0099     </Function>
0100
0101     <Function>
0102         <Name>ASCIITOCHAR</Name>
0103         <Type>String</Type>
0104         <Parameter>
0105             <Comment>The ASCII values to convert</Comment>
0106             <Type>Int</Type>
0107         </Parameter>
0108         <Help>
0109             <Text>The ASCIITOCHAR() function returns the character for each given ASCII code</Text>
0110             <Syntax>ASCIITOCHAR(value)</Syntax>
0111             <Example>ASCIITOCHAR(118) returns "v"</Example>
0112             <Example>ASCIITOCHAR(75; 68; 69) returns "KDE"</Example>
0113         </Help>
0114     </Function>
0115
0116     <Function>
0117         <Name>POLR</Name>
0118         <Type>Double</Type>
0119         <Parameter>
0120             <Comment>Value in X</Comment>
0121             <Type>Double</Type>
0122         </Parameter>
0123         <Parameter>
0124             <Comment>Value in Y</Comment>
0125             <Type>Double</Type>
0126         </Parameter>
0127         <Help>
0128             <Text>The POLR() function returns the radius corresponding to the position of a point in a cartesian landmark.</Text>
0129             <Syntax>POLR(X;Y)</Syntax>
0130             <Example>POLR(12;12) returns 16.9705</Example>
0131             <Example>POLR(12;0) returns 12</Example>
0132             <Related>POLA</Related>
0133             <Related>CARX</Related>
0134             <Related>CARY</Related>
0135         </Help>
0136     </Function>
0137
0138     <Function>
0139         <Name>POLA</Name>
0140         <Type>Double</Type>
0141         <Parameter>
0142             <Comment>Value in X</Comment>
0143             <Type>Double</Type>
0144         </Parameter>
0145         <Parameter>
0146             <Comment>Value in Y</Comment>
0147             <Type>Double</Type>
0148         </Parameter>
0149         <Help>
0150             <Text>The POLA() function returns the angle (in radians) corresponding to the position of a point in a cartesian landmark.</Text>
0151             <Syntax>POLA(X;Y)</Syntax>
0152             <Example>POLA(12;12) returns 0.78539816</Example>
0153             <Example>POLA(12;0) returns 0</Example>
0154             <Example>POLA(0;12) returns 1.5707</Example>
0155             <Related>POLR</Related>
0156             <Related>CARX</Related>
0157             <Related>CARY</Related>
0158         </Help>
0159     </Function>
0160
0161     <Function>
0162         <Name>CARX</Name>
0163         <Type>Double</Type>
0164         <Parameter>
0165             <Comment>Radius</Comment>
0166             <Type>Double</Type>
0167         </Parameter>
0168         <Parameter>
0169             <Comment>Angle (radians)</Comment>
0170             <Type>Double</Type>
0171         </Parameter>
0172         <Help>
0173             <Text>The CARX() function returns the X position corresponding to the position of a point in a polar landmark.</Text>
0174             <Syntax>CARX(Radius;Angle)</Syntax>
0175             <Example>CARX(12;1.5707) returns 0.00115592</Example>
0176             <Example>CARX(12;0) returns 12</Example>
0177             <Related>CARY</Related>
0178             <Related>POLA</Related>
0179             <Related>POLR</Related>
0180         </Help>
0181     </Function>
0182
0183     <Function>
0184         <Name>DECSEX</Name>
0185         <Type>Double</Type>
0186         <Parameter>
0187             <Comment>Value</Comment>
0188             <Type>Double</Type>
0189         </Parameter>
0190         <Help>
0191             <Text>The DECSEX() function converts a double value to a time value.</Text>
0192             <Syntax>DECSEX(double)</Syntax>
0193             <Example>DECSEX(1.6668) returns 1:40 </Example>
0194             <Example>DECSEX(7.8) returns 7:47</Example>
0195         </Help>
0196     </Function>
0197
0198     <Function>
0199         <Name>SEXDEC</Name>
0200         <Type>Double</Type>
0201         <Parameter>
0202             <Comment>Hours</Comment>
0203             <Type>Int</Type>
0204         </Parameter>
0205         <Parameter>
0206             <Comment>Minutes</Comment>
0207             <Type>Int</Type>
0208         </Parameter>
0209         <Parameter>
0210             <Comment>Seconds</Comment>
0211             <Type>Int</Type>
0212         </Parameter>
0213         <Help>
0214             <Text>The SEXDEC() function returns a decimal value. You can also supply a time value.</Text>
0215             <Syntax>SEXDEC(time value) or SEXDEC(hours;minutes;seconds)</Syntax>
0216             <Example>SEXDEC(1;5;7) returns 1.0852778 </Example>
0217             <Example>DECSEX("8:05") returns 8.08333333</Example>
0218         </Help>
0219     </Function>
0220
0221     <Function>
0222         <Name>CARY</Name>
0223         <Type>Double</Type>
0224         <Parameter>
0225             <Comment>Radius</Comment>
0226             <Type>Double</Type>
0227         </Parameter>
0228         <Parameter>
0229             <Comment>Angle (radians)</Comment>
0230             <Type>Double</Type>
0231         </Parameter>
0232         <Help>
0233             <Text>The CARY() function returns the Y position corresponding to the position of a point in a polar landmark.</Text>
0234             <Syntax>CARY(Radius;Angle)</Syntax>
0235             <Example>CARY(12;1.5707) returns 12</Example>
0236             <Example>CARY(12;0) returns 0</Example>
0237             <Related>CARX</Related>
0238             <Related>POLA</Related>
0239             <Related>POLR</Related>
0240         </Help>
0241     </Function>
0242
0243     <Function>
0244         <Name>ROMAN</Name>
0245         <Type>String</Type>
0246         <Parameter>
0247             <Comment>Number</Comment>
0248             <Type>Int</Type>
0249         </Parameter>
0250         <Parameter optional="true">
0251             <Comment>Format</Comment>
0252             <Type>Int</Type>
0253         </Parameter>
0254         <Help>
0255             <Text>The ROMAN() function returns the number in Roman format. Only positive whole numbers can be converted. The optional Format argument specifies the level of conciseness, and defaults to 0.</Text>
0256             <Syntax>ROMAN(Number)</Syntax>
0257             <Example>ROMAN(99) returns "XCIX"</Example>
0258             <Example>ROMAN(-55) returns "Err"</Example>
0259             <Related>ARABIC</Related>
0260         </Help>
0261     </Function>
0262
0263     <Function>
0264         <Name>ARABIC</Name>
0265         <Type>Int</Type>
0266         <Parameter>
0267             <Comment>Numeral</Comment>
0268             <Type>String</Type>
0269         </Parameter>
0270         <Help>
0271             <Text>The ARABIC() function converts a roman numeral into a number.</Text>
0272             <Syntax>ARABIC(Numeral)</Syntax>
0273             <Example>ARABIC("IV") returns 4</Example>
0274             <Example>ARABIC("XCIX") returns 99</Example>
0275             <Related>ROMAN</Related>
0276         </Help>
0277     </Function>
0278
0279 </Group>
0280
0281 </KSpreadFunctions>