sheets/functions/information.xml

0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005     <GroupName>Information</GroupName>
0006
0007    <Function>
0008        <Name>ERRORTYPE</Name>
0009        <Type>Int</Type>
0010        <Parameter>
0011            <Comment>Error</Comment>
0012            <Type>Any</Type>
0013        </Parameter>
0014        <Help>
0015            <Text>The ERRORTYPE() function converts a error to a number. If the value is not an error, an error is returned. Otherwise, a numerical code is returned. Error codes are modelled on Excel.</Text>
0016            <Syntax>ERRORTYPE(value)</Syntax>
0017            <Example>ERRORTYPE(NA()) returns 7</Example>
0018            <Example>ERRORTYPE(0) returns an error</Example>
0019        </Help>
0020    </Function>
0021
0022    <Function>
0023        <Name>FORMULA</Name>
0024        <Type>String</Type>
0025        <Parameter>
0026            <Comment>Reference</Comment>
0027            <Type>Reference</Type>
0028        </Parameter>
0029        <Help>
0030            <Text>The FORMULA() function returns the formula of a cell as string.</Text>
0031            <Syntax>FORMULA(x)</Syntax>
0032            <Example>FORMULA(A1) returns "=SUM(1+2)" if the cell A1 contains such a formula.</Example>
0033        </Help>
0034    </Function>
0035
0036    <Function>
0037        <Name>N</Name>
0038        <Type>Int</Type>
0039        <Parameter>
0040            <Comment>Value</Comment>
0041            <Type>Any</Type>
0042        </Parameter>
0043        <Help>
0044            <Text>The N() function converts a value to a number. If value is or refers to a number, this function returns the number. If value is True, this function returns 1. If a value is a date, this function returns the serial number of that date. Anything else will cause the function to return 0.</Text>
0045            <Syntax>N(value)</Syntax>
0046            <Example>N(3.14) returns 3.14</Example>
0047            <Example>N("7") returns 0 (because "7" is text)</Example>
0048        </Help>
0049    </Function>
0050
0051    <Function>
0052        <Name>INFO</Name>
0053        <Type>String</Type>
0054        <Parameter>
0055            <Comment>Type of information</Comment>
0056            <Type>String</Type>
0057        </Parameter>
0058        <Help>
0059            <Text>The INFO() function returns information about the current operating environment. Parameter type specifies what type of information you want to return. It is one of the following: "directory" returns the path of the current directory, "numfile" returns the number of active documents, "release" returns the version of Calligra Sheets as text, "recalc" returns the current recalculation mode: "Automatic" or "Manual", "system" returns the name of the operating environment, "osversion" returns the current operating system.</Text>
0060            <Syntax>INFO(type)</Syntax>
0061        </Help>
0062    </Function>
0063
0064    <Function>
0065        <Name>ISLOGICAL</Name>
0066        <Type>Boolean</Type>
0067        <Parameter>
0068            <Comment>Any value</Comment>
0069            <Type>Any</Type>
0070        </Parameter>
0071        <Help>
0072            <Text>The ISLOGICAL() function returns True if the parameter is a boolean value. Otherwise it returns False.</Text>
0073            <Syntax>ISLOGICAL(x)</Syntax>
0074            <Example>ISLOGICAL(A1>A2) returns True</Example>
0075            <Example>ISLOGICAL(12) returns False</Example>
0076        </Help>
0077    </Function>
0078
0079    <Function>
0080        <Name>ISBLANK</Name>
0081        <Type>Boolean</Type>
0082        <Parameter>
0083            <Comment>Any value</Comment>
0084            <Type>Any</Type>
0085        </Parameter>
0086        <Help>
0087            <Text>The ISBLANK() function returns True if the parameter is empty. Otherwise it returns False.</Text>
0088            <Syntax>ISBLANK(x)</Syntax>
0089            <Example>ISBLANK(A1) returns True if A1 is empty</Example>
0090            <Example>ISBLANK(A1) returns False if A1 holds a value</Example>
0091        </Help>
0092    </Function>
0093
0094    <Function>
0095        <Name>ISNUMBER</Name>
0096        <Type>Boolean</Type>
0097        <Parameter>
0098            <Comment>Any value</Comment>
0099            <Type>Any</Type>
0100        </Parameter>
0101        <Help>
0102            <Text>The ISNUMBER() function returns True if the parameter is a numerical value. Otherwise it returns False. It's the same as ISNUM.</Text>
0103            <Syntax>ISNUMBER(x)</Syntax>
0104            <Example>ISNUMBER(12) returns True</Example>
0105            <Example>ISNUMBER(hello) returns False</Example>
0106            <Related>ISNUM</Related>
0107        </Help>
0108    </Function>
0109
0110    <Function>
0111        <Name>ISNUM</Name>
0112        <Type>Boolean</Type>
0113        <Parameter>
0114            <Comment>Any value</Comment>
0115            <Type>Any</Type>
0116        </Parameter>
0117        <Help>
0118            <Text>The ISNUM() function returns True if the parameter is a numerical value. Otherwise it returns False. It's the same as ISNUMBER.</Text>
0119            <Syntax>ISNUM(x)</Syntax>
0120            <Example>ISNUM(12) returns True</Example>
0121            <Example>ISNUM(hello) returns False</Example>
0122            <Related>ISNUMBER</Related>
0123        </Help>
0124    </Function>
0125
0126    <Function>
0127        <Name>ISTIME</Name>
0128        <Type>Boolean</Type>
0129        <Parameter>
0130            <Comment>Any value</Comment>
0131            <Type>Any</Type>
0132        </Parameter>
0133        <Help>
0134            <Text>The ISTIME() function returns True if the parameter is a time value. Otherwise it returns False.</Text>
0135            <Syntax>ISTIME(x)</Syntax>
0136            <Example>ISTIME("12:05") returns True</Example>
0137            <Example>ISTIME("hello") returns False</Example>
0138        </Help>
0139    </Function>
0140
0141    <Function>
0142        <Name>ISDATE</Name>
0143        <Type>Boolean</Type>
0144        <Parameter>
0145            <Comment>Any value</Comment>
0146            <Type>Any</Type>
0147        </Parameter>
0148        <Help>
0149            <Text>The ISDATE() function returns True if the parameter is a date value. Otherwise it returns False</Text>
0150            <Syntax>ISDATE(x)</Syntax>
0151            <Example>ISDATE("2000-2-2") returns True</Example>
0152            <Example>ISDATE("hello") returns False</Example>
0153        </Help>
0154    </Function>
0155
0156    <Function>
0157        <Name>ISREF</Name>
0158        <Type>Boolean</Type>
0159        <Parameter>
0160            <Comment>Any value</Comment>
0161            <Type>Any</Type>
0162        </Parameter>
0163        <Help>
0164            <Text>The ISREF() function returns True if the parameter refers to a reference. Otherwise it returns False</Text>
0165            <Syntax>ISREF(x)</Syntax>
0166            <Example>ISREF(A12) returns true</Example>
0167            <Example>ISREF("hello") returns false</Example>
0168        </Help>
0169    </Function>
0170
0171    <Function>
0172        <Name>ISTEXT</Name>
0173        <Type>Boolean</Type>
0174        <Parameter>
0175            <Comment>Any value</Comment>
0176            <Type>Any</Type>
0177        </Parameter>
0178        <Help>
0179            <Text>The ISTEXT() function returns True if the parameter is a string. Otherwise it returns False</Text>
0180            <Syntax>ISTEXT(x)</Syntax>
0181            <Example>ISTEXT(12) returns False</Example>
0182            <Example>ISTEXT("hello") returns True</Example>
0183        </Help>
0184    </Function>
0185
0186    <Function>
0187        <Name>ISNONTEXT</Name>
0188        <Type>Boolean</Type>
0189        <Parameter>
0190            <Comment>Any value</Comment>
0191            <Type>Any</Type>
0192        </Parameter>
0193        <Help>
0194            <Text>The ISNONTEXT() function returns True if the parameter is not a string. Otherwise it returns False. It's the same as ISNOTTEXT.</Text>
0195            <Syntax>ISNONTEXT(x)</Syntax>
0196            <Example>ISNONTEXT(12) returns True</Example>
0197            <Example>ISNONTEXT("hello") returns False</Example>
0198            <Related>ISNOTTEXT</Related>
0199        </Help>
0200    </Function>
0201
0202    <Function>
0203        <Name>ISNOTTEXT</Name>
0204        <Type>Boolean</Type>
0205        <Parameter>
0206            <Comment>Any value</Comment>
0207            <Type>Any</Type>
0208        </Parameter>
0209        <Help>
0210            <Text>The ISNOTTEXT() function returns True if the parameter is not a string. Otherwise it returns False. It's the same as ISNONTEXT.</Text>
0211            <Syntax>ISNOTTEXT(x)</Syntax>
0212            <Example>ISNOTTEXT(12) returns True</Example>
0213            <Example>ISNOTTEXT("hello") returns False</Example>
0214            <Related>ISNONTEXT</Related>
0215        </Help>
0216    </Function>
0217
0218    <Function>
0219        <Name>ISFORMULA</Name>
0220        <Type>Boolean</Type>
0221        <Parameter>
0222            <Comment>Reference</Comment>
0223            <Type>Reference</Type>
0224        </Parameter>
0225        <Help>
0226            <Text>The ISFORMULA() function returns True if the referenced cell contains a formula. Otherwise it returns False</Text>
0227            <Syntax>ISFORMULA(x)</Syntax>
0228        </Help>
0229    </Function>
0230
0231    <Function>
0232        <Name>ISODD</Name>
0233        <Type>Boolean</Type>
0234        <Parameter>
0235            <Comment>Any value</Comment>
0236            <Type>Any</Type>
0237        </Parameter>
0238        <Help>
0239            <Text>The ISODD() function returns True if the number is odd. Otherwise returns False.</Text>
0240            <Syntax>ISODD(x)</Syntax>
0241            <Example>ISODD(12) returns False</Example>
0242            <Example>ISODD(-7) returns True</Example>
0243        </Help>
0244    </Function>
0245
0246    <Function>
0247        <Name>ISEVEN</Name>
0248        <Type>Boolean</Type>
0249        <Parameter>
0250            <Comment>Any value</Comment>
0251            <Type>Any</Type>
0252        </Parameter>
0253        <Help>
0254            <Text>The ISEVEN() function returns True if the number is even. Otherwise returns False.</Text>
0255            <Syntax>ISEVEN(x)</Syntax>
0256            <Example>ISEVEN(12) returns True</Example>
0257            <Example>ISEVEN(-7) returns False</Example>
0258        </Help>
0259    </Function>
0260
0261    <Function>
0262        <Name>ISERR</Name>
0263        <Type>Boolean</Type>
0264        <Parameter>
0265            <Comment>Any value</Comment>
0266            <Type>Any</Type>
0267        </Parameter>
0268        <Help>
0269            <Text>The ISERR() function returns True if its parameter is an error other than N/A. Otherwise, it returns False. Use ISERROR() if you want to include the N/A error as well.</Text>
0270            <Syntax>ISERR(x)</Syntax>
0271            <Related>ISERROR</Related>
0272            <Related>ISNA</Related>
0273        </Help>
0274    </Function>
0275
0276    <Function>
0277        <Name>ISERROR</Name>
0278        <Type>Boolean</Type>
0279        <Parameter>
0280            <Comment>Any value</Comment>
0281            <Type>Any</Type>
0282        </Parameter>
0283        <Help>
0284            <Text>The ISERROR() function returns True if its parameter is an error of any type. Otherwise, it returns False.</Text>
0285            <Syntax>ISERROR(x)</Syntax>
0286            <Related>ISERR</Related>
0287            <Related>ISNA</Related>
0288        </Help>
0289    </Function>
0290
0291    <Function>
0292        <Name>ISNA</Name>
0293        <Type>Boolean</Type>
0294        <Parameter>
0295            <Comment>Any value</Comment>
0296            <Type>Any</Type>
0297        </Parameter>
0298        <Help>
0299            <Text>The ISNA() function returns True if its parameter is a N/A error. In all other cases, it returns False.</Text>
0300            <Syntax>ISNA(x)</Syntax>
0301            <Related>ISERR</Related>
0302            <Related>ISERROR</Related>
0303        </Help>
0304    </Function>
0305
0306    <Function>
0307        <Name>NA</Name>
0308        <Type>Error</Type>
0309        <Help>
0310            <Text>The NA() function returns the constant error value, N/A.</Text>
0311            <Syntax>NA()</Syntax>
0312            <Related>ISNA</Related>
0313            <Related>ISERR</Related>
0314            <Related>ISERROR</Related>
0315        </Help>
0316    </Function>
0317
0318    <Function>
0319        <Name>TYPE</Name>
0320        <Type>Int</Type>
0321        <Parameter>
0322            <Comment>Any value</Comment>
0323            <Type>Any</Type>
0324        </Parameter>
0325        <Help>
0326            <Text>The TYPE() function returns 1 if the value is a number, 2 if it is text, 4 if the value is a logical value, 16 if it is an error value or 64 if the value is an array. If the cell the value represents contains a formula you get its return type.</Text>
0327            <Syntax>TYPE(x)</Syntax>
0328            <Example>TYPE(A1) returns 2, if A1 contains "Text"</Example>
0329            <Example>TYPE(-7) returns 1</Example>
0330            <Example>TYPE(A2) returns 1, if A2 contains "=CURRENTDATE()"</Example>
0331        </Help>
0332    </Function>
0333
0334    <Function>
0335        <Name>FILENAME</Name>
0336        <Type>String</Type>
0337        <Help>
0338            <Text>Returns the current filename. If the current document is not saved, an empty string is returned.</Text>
0339            <Syntax>FILENAME()</Syntax>
0340        </Help>
0341    </Function>
0342
0343 </Group>
0344
0345 </KSpreadFunctions>