Warning, /office/calligra/sheets/functions/text.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005 <GroupName>Text</GroupName>
0006
0007 <Function>
0008 <Name>DOLLAR</Name>
0009 <Type>String</Type>
0010 <Parameter>
0011 <Comment>Number</Comment>
0012 <Type>Double</Type>
0013 </Parameter>
0014 <Parameter optional="true">
0015 <Comment>Decimals</Comment>
0016 <Type>Int</Type>
0017 </Parameter>
0018 <Help>
0019 <Text>The DOLLAR() function converts a number to text using currency format, with the decimals rounded to the specified place. Although the name is DOLLAR, this function will do the conversion according to the current locale.</Text>
0020 <Syntax>DOLLAR(number;decimals)</Syntax>
0021 <Example>DOLLAR(1403.77) returns "$ 1,403.77"</Example>
0022 <Example>DOLLAR(-0.123;4) returns "$-0.1230"</Example>
0023 </Help>
0024 </Function>
0025
0026 <Function>
0027 <Name>FIXED</Name>
0028 <Type>String</Type>
0029 <Parameter>
0030 <Comment>Number</Comment>
0031 <Type>Double</Type>
0032 </Parameter>
0033 <Parameter optional="true">
0034 <Comment>Decimals</Comment>
0035 <Type>Int</Type>
0036 </Parameter>
0037 <Parameter optional="true">
0038 <Comment>No_commas</Comment>
0039 <Type>Boolean</Type>
0040 </Parameter>
0041 <Help>
0042 <Text>The FIXED() function rounds a number to the specified number of decimals, formats the number in decimal format string, and returns the result as text. If decimals is negative, number is rounded to the left of the decimal point. If you omit decimals, it is assumed to be 2. If optional parameter no_commas is True, thousand separators will not show up.</Text>
0043 <Syntax>FIXED(number;decimals;no_commas)</Syntax>
0044 <Example>FIXED(1234.567;1) returns "1,234.6"</Example>
0045 <Example>FIXED(1234.567;1;FALSE) returns "1234.6"</Example>
0046 <Example>FIXED(44.332) returns "44.33"</Example>
0047 </Help>
0048 </Function>
0049
0050 <Function>
0051 <Name>SUBSTITUTE</Name>
0052 <Type>String</Type>
0053 <Parameter>
0054 <Comment>Text for which you want to substitute</Comment>
0055 <Type>String</Type>
0056 </Parameter>
0057 <Parameter>
0058 <Comment>Part of text you want to replace</Comment>
0059 <Type>String</Type>
0060 </Parameter>
0061 <Parameter>
0062 <Comment>New text which will be replacement</Comment>
0063 <Type>String</Type>
0064 </Parameter>
0065 <Parameter optional="true">
0066 <Comment>Which occurrence to replace</Comment>
0067 <Type>Int</Type>
0068 </Parameter>
0069 <Help>
0070 <Text>The SUBSTITUTE() substitutes new_text for old_text in a text string. If instance_num is specified, only that instance of old_text is replaced. Otherwise, every occurrence of old_text is changed to new_text. Use SUBSTITUTE when you want to replace specific text, use REPLACE when you want to replace any text that occurs in a specific location.</Text>
0071 <Syntax>SUBSTITUTE(text; old_text; new_text; instance_num)</Syntax>
0072 <Example>SUBSTITUTE("Cost Data";"Cost";"Sales") returns "Sales Data"</Example>
0073 <Example>SUBSTITUTE("Qtr 1, 2001";"1";"3";1) returns "Qtr 3, 2001"</Example>
0074 <Example>SUBSTITUTE("Qtr 1, 2001";"1";"3";4) returns "Qtr 3, 2003"</Example>
0075 <Related>REPLACE</Related>
0076 <Related>REPLACEB</Related>
0077 <Related>FIND</Related>
0078 <Related>FINDB</Related>
0079 </Help>
0080 </Function>
0081
0082 <Function>
0083 <Name>SEARCH</Name>
0084 <Type>Int</Type>
0085 <Parameter>
0086 <Comment>The text you want to find</Comment>
0087 <Type>String</Type>
0088 </Parameter>
0089 <Parameter>
0090 <Comment>The text which may contain find_text</Comment>
0091 <Type>String</Type>
0092 </Parameter>
0093 <Parameter>
0094 <Comment>Specified index to start the search</Comment>
0095 <Type>Int</Type>
0096 </Parameter>
0097 <Help>
0098 <Text>The SEARCH() function finds one text string (find_text) within another text string (within_text) and returns the number of the starting point of find_text, from the leftmost character of within_text.</Text>
0099 <Text>You can use wildcard characters, question mark (?) and asterisk (*). A question mark matches any single character, an asterisk matches any sequences of characters.</Text>
0100 <Text>Parameter start_num specifies the character at which to start the search. The first character is character number 1. If start_num is omitted, it is assumed to be 1. SEARCH does not distinguish between uppercase and lowercase letters.</Text>
0101 <Syntax>SEARCH(find_text;within_text;start_num)</Syntax>
0102 <Example>SEARCH("e";"Statements";6) returns 7</Example>
0103 <Example>SEARCH("margin";"Profit Margin") returns 8</Example>
0104 <Related>FIND</Related>
0105 <Related>FINDB</Related>
0106 <Related>SEARCHB</Related>
0107 </Help>
0108 </Function>
0109
0110 <Function>
0111 <Name>SEARCHB</Name>
0112 <Type>Int</Type>
0113 <Parameter>
0114 <Comment>The text you want to find</Comment>
0115 <Type>String</Type>
0116 </Parameter>
0117 <Parameter>
0118 <Comment>The text which may contain find_text</Comment>
0119 <Type>String</Type>
0120 </Parameter>
0121 <Parameter>
0122 <Comment>Specified byte position to start the search</Comment>
0123 <Type>Int</Type>
0124 </Parameter>
0125 <Help>
0126 <Text>The SEARCHB() function finds one text string (find_text) within another text string (within_text) and returns the number of the starting point of find_text, from the leftmost character of within_text using byte positions.</Text>
0127 <Text>You can use wildcard characters, question mark (?) and asterisk (*). A question mark matches any single character, an asterisk matches any sequences of characters.</Text>
0128 <Text>Parameter BytePosition specifies the character at which to start the search. The first character is character number 2. If BytePosition is omitted, it is assumed to be 2. SEARCHB does not distinguish between uppercase and lowercase letters.</Text>
0129 <Syntax>SEARCHB(find_text;within_text;BytePosition Start)</Syntax>
0130 <Related>FINDB</Related>
0131 <Related>FIND</Related>
0132 <Related>SEARCH</Related>
0133 </Help>
0134 </Function>
0135
0136 <Function>
0137 <Name>T</Name>
0138 <Type>String</Type>
0139 <Parameter>
0140 <Comment>Value</Comment>
0141 <Type>Any</Type>
0142 </Parameter>
0143 <Help>
0144 <Text>The T() function returns the text referred to by value. If value is, or refers to, text then T returns value. If value does not refer to text then T returns empty text.</Text>
0145 <Syntax>T(value)</Syntax>
0146 <Example>T("Calligra") returns "Calligra"</Example>
0147 <Example>T(1.2) returns "" (empty text)</Example>
0148 </Help>
0149 </Function>
0150
0151 <Function>
0152 <Name>TEXT</Name>
0153 <Type>String</Type>
0154 <Parameter>
0155 <Comment>Value</Comment>
0156 <Type>Any</Type>
0157 </Parameter>
0158 <Help>
0159 <Text>The TEXT() function converts a value to text.</Text>
0160 <Syntax>TEXT(value)</Syntax>
0161 <Example>TEXT(1234.56) returns "1234.56"</Example>
0162 <Example>TEXT("KSpread") returns "KSpread"</Example>
0163 </Help>
0164 </Function>
0165
0166 <Function>
0167 <Name>PROPER</Name>
0168 <Type>String</Type>
0169 <Parameter>
0170 <Comment>String</Comment>
0171 <Type>String</Type>
0172 </Parameter>
0173 <Help>
0174 <Text>The PROPER() function converts the first letter of each word to uppercase and the rest of the letters to lowercase.</Text>
0175 <Syntax>PROPER(string)</Syntax>
0176 <Example>PROPER("this is a title") returns "This Is A Title"</Example>
0177 </Help>
0178 </Function>
0179
0180 <Function>
0181 <Name>COMPARE</Name>
0182 <Type>Int</Type>
0183 <Parameter>
0184 <Comment>First string</Comment>
0185 <Type>String</Type>
0186 </Parameter>
0187 <Parameter>
0188 <Comment>String to compare with</Comment>
0189 <Type>String</Type>
0190 </Parameter>
0191 <Parameter>
0192 <Comment>Compare case-sensitive (true/false)</Comment>
0193 <Type>Boolean</Type>
0194 </Parameter>
0195 <Help>
0196 <Text>The COMPARE() function returns 0 if the two strings are equal; -1 if the first one is lower in value than the second one; otherwise it returns 1.</Text>
0197 <Syntax>COMPARE(string1; string2; true|false)</Syntax>
0198 <Example>COMPARE("Calligra"; "Calligra"; true) returns 0</Example>
0199 <Example>COMPARE("calligra"; "Calligra"; true) returns 1</Example>
0200 <Example>COMPARE("kspread"; "Calligra"; false) returns 1</Example>
0201 <Related>EXACT</Related>
0202 </Help>
0203 </Function>
0204
0205 <Function>
0206 <Name>EXACT</Name>
0207 <Type>Boolean</Type>
0208 <Parameter>
0209 <Comment>String</Comment>
0210 <Type>String</Type>
0211 </Parameter>
0212 <Parameter>
0213 <Comment>String</Comment>
0214 <Type>String</Type>
0215 </Parameter>
0216 <Help>
0217 <Text>The EXACT() function returns True if these two strings are equal. Otherwise, it returns False.</Text>
0218 <Syntax>EXACT(string1;string2)</Syntax>
0219 <Example>EXACT("Calligra";"Calligra") returns True</Example>
0220 <Example>EXACT("KSpread";"Calligra") returns False</Example>
0221 <Related>COMPARE</Related>
0222 </Help>
0223 </Function>
0224
0225 <Function>
0226 <Name>REPLACE</Name>
0227 <Type>String</Type>
0228 <Parameter>
0229 <Comment>Text which you want to replace some characters</Comment>
0230 <Type range="false">String</Type>
0231 </Parameter>
0232 <Parameter>
0233 <Comment>Position of the characters to replace</Comment>
0234 <Type>Int</Type>
0235 </Parameter>
0236 <Parameter>
0237 <Comment>Number of characters to replace</Comment>
0238 <Type>Int</Type>
0239 </Parameter>
0240 <Parameter>
0241 <Comment>The text that will replace characters in old text</Comment>
0242 <Type range="false">String</Type>
0243 </Parameter>
0244 <Help>
0245 <Text>The REPLACE() function replaces part of a text string with a different text string.</Text>
0246 <Syntax>REPLACE(text;position;length;new_text)</Syntax>
0247 <Example>REPLACE("abcdefghijk";6;5;"-") returns "abcde-k"</Example>
0248 <Example>REPLACE("2002";3;2;"03") returns "2003"</Example>
0249 <Related>FIND</Related>
0250 <Related>MID</Related>
0251 <Related>FINDB</Related>
0252 <Related>MIDB</Related>
0253 </Help>
0254 </Function>
0255
0256 <Function>
0257 <Name>REPLACEB</Name>
0258 <Type>String</Type>
0259 <Parameter>
0260 <Comment>Text which you want to replace some characters using byte position</Comment>
0261 <Type range="false">String</Type>
0262 </Parameter>
0263 <Parameter>
0264 <Comment>Byte position of the characters to replace</Comment>
0265 <Type>Int</Type>
0266 </Parameter>
0267 <Parameter>
0268 <Comment>The byte length of characters to replace</Comment>
0269 <Type>Int</Type>
0270 </Parameter>
0271 <Parameter>
0272 <Comment>The text that will replace characters in old text</Comment>
0273 <Type range="false">String</Type>
0274 </Parameter>
0275 <Help>
0276 <Text>The REPLACEB() function replaces part of a text string with a different text string using byte positions.</Text>
0277 <Syntax>REPLACEB(text;BytePosition;ByteLength Len;new_text)</Syntax>
0278 <Related>FINDB</Related>
0279 <Related>MIDB</Related>
0280 <Related>FIND</Related>
0281 <Related>MID</Related>
0282 </Help>
0283 </Function>
0284
0285 <Function>
0286 <Name>FIND</Name>
0287 <Type>Int</Type>
0288 <Parameter>
0289 <Comment>The text you want to find</Comment>
0290 <Type>String</Type>
0291 </Parameter>
0292 <Parameter>
0293 <Comment>The text which may contain find_text</Comment>
0294 <Type>String</Type>
0295 </Parameter>
0296 <Parameter optional="true">
0297 <Comment>Specifies index to start the search</Comment>
0298 <Type>Int</Type>
0299 </Parameter>
0300 <Help>
0301 <Text>The FIND() function finds one text string (find_text) within another text string (within_text) and returns the number of the starting point of find_text, from the leftmost character of within_text.</Text>
0302 <Text>Parameter start_num specifies the character at which to start the search. The first character is character number 1. If start_num is omitted, it is assumed to be 1.</Text>
0303 <Text>You can also use function SEARCH, but unlike SEARCH, FIND is case-sensitive and does not allow wildcard characters.</Text>
0304 <Syntax>FIND(find_text;within_text;start_num)</Syntax>
0305 <Example>FIND("Cal";"Calligra") returns 1</Example>
0306 <Example>FIND("i";"Calligra") returns 5</Example>
0307 <Example>FIND("a";"Sheets in Calligra";4) returns 12</Example>
0308 <Related>FINDB</Related>
0309 <Related>SEARCH</Related>
0310 <Related>REPLACE</Related>
0311 <Related>SEARCHB</Related>
0312 <Related>REPLACEB</Related>
0313 </Help>
0314 </Function>
0315
0316 <Function>
0317 <Name>FINDB</Name>
0318 <Type>Int</Type>
0319 <Parameter>
0320 <Comment>The text you want to find</Comment>
0321 <Type>String</Type>
0322 </Parameter>
0323 <Parameter>
0324 <Comment>The text which may contain find_text</Comment>
0325 <Type>String</Type>
0326 </Parameter>
0327 <Parameter optional="true">
0328 <Comment>Specifies byte position to start the search</Comment>
0329 <Type>Int</Type>
0330 </Parameter>
0331 <Help>
0332 <Text>The FINDB() function finds one text string (find_text) within another text string (within_text) and returns the number of the starting point of find_text, from the leftmost character of within_text using byte positions.</Text>
0333 <Text>Parameter BytePosition specifies the character at which to start the search. The first character is character number 2. If start_num is omitted, it is assumed to be 2.</Text>
0334 <!--FIXME rename start_num to BytePosition like in Syntax-->
0335 <Syntax>FINDB(find_text;within_text;BytePosition Start)</Syntax>
0336 <Related>FIND</Related>
0337 <Related>SEARCH</Related>
0338 <Related>REPLACE</Related>
0339 <Related>SEARCHB</Related>
0340 <Related>REPLACEB</Related>
0341 </Help>
0342 </Function>
0343
0344 <Function>
0345 <Name>MID</Name>
0346 <Type>String</Type>
0347 <Parameter>
0348 <Comment>Source string</Comment>
0349 <Type>String</Type>
0350 </Parameter>
0351 <Parameter>
0352 <Comment>Position</Comment>
0353 <Type>Int</Type>
0354 </Parameter>
0355 <Parameter optional="true">
0356 <Comment>Length</Comment>
0357 <Type>Int</Type>
0358 </Parameter>
0359 <Help>
0360 <Text>The MID() function returns a substring that contains 'length' characters of the string, starting at 'position' index.</Text>
0361 <Syntax>MID(text;position;length)</Syntax>
0362 <Syntax>MID(text;position)</Syntax>
0363 <Example>MID("Calligra";2;3) returns "all"</Example>
0364 <Example>MID("Calligra";2) returns "alligra"</Example>
0365 <Related>LEFT</Related>
0366 <Related>RIGHT</Related>
0367 <Related>LEFTB</Related>
0368 <Related>RIGHTB</Related>
0369 <Related>MIDB</Related>
0370 </Help>
0371 </Function>
0372
0373 <Function>
0374 <Name>MIDB</Name>
0375 <Type>String</Type>
0376 <Parameter>
0377 <Comment>Source string</Comment>
0378 <Type>String</Type>
0379 </Parameter>
0380 <Parameter>
0381 <Comment>Byte Position</Comment>
0382 <Type>Int</Type>
0383 </Parameter>
0384 <Parameter optional="true">
0385 <Comment>Byte Length</Comment>
0386 <Type>Int</Type>
0387 </Parameter>
0388 <Help>
0389 <Text>The MIDB() function returns a substring that contains 'length' characters of the string, starting at 'position' index using byte positions.</Text>
0390 <Syntax>MIDB(text;BytePosition Start;ByteLength)</Syntax>
0391 <Syntax>MIDB(text;BytePosition Start)</Syntax>
0392 <Related>LEFT</Related>
0393 <Related>RIGHT</Related>
0394 <Related>LEFTB</Related>
0395 <Related>RIGHTB</Related>
0396 <Related>MID</Related>
0397 </Help>
0398 </Function>
0399
0400 <Function>
0401 <Name>LEN</Name>
0402 <Type>Int</Type>
0403 <Parameter>
0404 <Comment>String</Comment>
0405 <Type>String</Type>
0406 </Parameter>
0407 <Help>
0408 <Text>The LEN() function returns the length of the string.</Text>
0409 <Syntax>LEN(text)</Syntax>
0410 <Example>LEN("hello") returns 5</Example>
0411 <Example>LEN("KSpread") returns 7</Example>
0412 <Related>LENB</Related>
0413 </Help>
0414 </Function>
0415
0416 <Function>
0417 <Name>LENB</Name>
0418 <Type>Int</Type>
0419 <Parameter>
0420 <Comment>String</Comment>
0421 <Type>String</Type>
0422 </Parameter>
0423 <Help>
0424 <Text>The LENB() function returns the length of the string using byte positions.</Text>
0425 <Syntax>LENB(text)</Syntax>
0426 </Help>
0427 </Function>
0428
0429 <Function>
0430 <Name>TRIM</Name>
0431 <Type>String</Type>
0432 <Parameter>
0433 <Comment>String</Comment>
0434 <Type>String</Type>
0435 </Parameter>
0436 <Help>
0437 <Text>The TRIM() function returns text with only single spaces between words.</Text>
0438 <Syntax>TRIM(text)</Syntax>
0439 <Example>TRIM(" hello KSpread ") returns "hello KSpread"</Example>
0440 </Help>
0441 </Function>
0442
0443 <Function>
0444 <Name>CONCATENATE</Name>
0445 <Type>String</Type>
0446 <Parameter optional="true">
0447 <Comment>String values</Comment>
0448 <Type range="true">String</Type>
0449 </Parameter>
0450 <Parameter optional="true">
0451 <Comment>String values</Comment>
0452 <Type range="true">String</Type>
0453 </Parameter>
0454 <Parameter optional="true">
0455 <Comment>String values</Comment>
0456 <Type range="true">String</Type>
0457 </Parameter>
0458 <Parameter optional="true">
0459 <Comment>String values</Comment>
0460 <Type range="true">String</Type>
0461 </Parameter>
0462 <Parameter optional="true">
0463 <Comment>String values</Comment>
0464 <Type range="true">String</Type>
0465 </Parameter>
0466 <Help>
0467 <Text>The CONCATENATE() function returns a string which is the concatenation of the strings passed as parameters.</Text>
0468 <Syntax>CONCATENATE(value;value;...)</Syntax>
0469 <Example>CONCATENATE("Sheets";"Calligra";"KDE") returns "SheetsCalligraKDE"</Example>
0470 </Help>
0471 </Function>
0472
0473 <Function>
0474 <Name>RIGHT</Name>
0475 <Type>String</Type>
0476 <Parameter>
0477 <Comment>Source string</Comment>
0478 <Type>String</Type>
0479 </Parameter>
0480 <Parameter optional="true">
0481 <Comment>Number of characters</Comment>
0482 <Type>Int</Type>
0483 </Parameter>
0484 <Help>
0485 <Text>The RIGHT() function returns a substring that contains the 'length' rightmost characters of the string. The whole string is returned if 'length' exceeds the length of the string.</Text>
0486 <Syntax>RIGHT(text;length)</Syntax>
0487 <Example>RIGHT("hello";2) returns "lo"</Example>
0488 <Example>RIGHT("KSpread";10) returns "KSpread"</Example>
0489 <Example>RIGHT("KSpread") returns "d"</Example>
0490 <Related>LEFT</Related>
0491 <Related>MID</Related>
0492 <Related>LEFTB</Related>
0493 <Related>MIDB</Related>
0494 </Help>
0495 </Function>
0496
0497 <Function>
0498 <Name>RIGHTB</Name>
0499 <Type>String</Type>
0500 <Parameter>
0501 <Comment>Source string</Comment>
0502 <Type>String</Type>
0503 </Parameter>
0504 <Parameter optional="true">
0505 <Comment>Byte Length</Comment>
0506 <Type>Int</Type>
0507 </Parameter>
0508 <Help>
0509 <Text>The RIGHTB() function returns a substring that contains the 'length' rightmost characters of the string using byte positions. The whole string is returned if 'length' exceeds the length of the string.</Text>
0510 <Syntax>RIGHTB(text;ByteLength)</Syntax>
0511 <Related>LEFT</Related>
0512 <Related>MID</Related>
0513 <Related>LEFTB</Related>
0514 <Related>MIDB</Related>
0515 </Help>
0516 </Function>
0517
0518 <Function>
0519 <Name>LEFT</Name>
0520 <Type>String</Type>
0521 <Parameter>
0522 <Comment>Source string</Comment>
0523 <Type>String</Type>
0524 </Parameter>
0525 <Parameter optional="true">
0526 <Comment>Number of characters</Comment>
0527 <Type>Int</Type>
0528 </Parameter>
0529 <Help>
0530 <Text>The LEFT() function returns a substring that contains the 'length' leftmost characters of the string. The whole string is returned if 'length' exceeds the length of the string. It is an error for the number of characters to be less than 0.</Text>
0531 <Syntax>LEFT(text;length)</Syntax>
0532 <Example>LEFT("hello";2) returns "he"</Example>
0533 <Example>LEFT("KSpread";10) returns "KSpread"</Example>
0534 <Example>LEFT("KSpread") returns "K"</Example>
0535 <Related>RIGHT</Related>
0536 <Related>MID</Related>
0537 <Related>RIGHTB</Related>
0538 <Related>MIDB</Related>
0539 </Help>
0540 </Function>
0541
0542 <Function>
0543 <Name>LEFTB</Name>
0544 <Type>String</Type>
0545 <Parameter>
0546 <Comment>Source string</Comment>
0547 <Type>String</Type>
0548 </Parameter>
0549 <Parameter optional="true">
0550 <Comment>Byte Length</Comment>
0551 <Type>Int</Type>
0552 </Parameter>
0553 <Help>
0554 <Text>The LEFTB() function returns a substring that contains the 'length' leftmost characters of the string using byte positions. The whole string is returned if 'length' exceeds the length of the string. It is an error for the number of characters to be less than 0.</Text>
0555 <Syntax>LEFTB(text;ByteLength)</Syntax>
0556 <Related>RIGHT</Related>
0557 <Related>MID</Related>
0558 <Related>RIGHTB</Related>
0559 <Related>MIDB</Related>
0560 </Help>
0561 </Function>
0562
0563 <Function>
0564 <Name>REPT</Name>
0565 <Type>String</Type>
0566 <Parameter>
0567 <Comment>Source string</Comment>
0568 <Type>String</Type>
0569 </Parameter>
0570 <Parameter>
0571 <Comment>Count of repetitions</Comment>
0572 <Type>Int</Type>
0573 </Parameter>
0574 <Help>
0575 <Text>The REPT() function repeats the first parameter as many times as by the second parameter. The second parameter must not be negative, and this function will return an empty string if the second parameter is zero (or rounds down to zero).</Text>
0576 <Syntax>REPT(text;count)</Syntax>
0577 <Example>REPT("KSpread";3) returns "KSpreadKSpreadKSpread"</Example>
0578 <Example>REPT("KSpread";0) returns ""</Example>
0579 </Help>
0580 </Function>
0581
0582 <Function>
0583 <Name>ROT13</Name>
0584 <Type>String</Type>
0585 <Parameter>
0586 <Comment>Text</Comment>
0587 <Type>String</Type>
0588 </Parameter>
0589 <Help>
0590 <Text>The ROT13() function encrypts text by replacing each letter with the one 13 places along in the alphabet. If the 13th position is beyond the letter Z, it begins again at A (rotation).</Text>
0591 <Text>By applying the encryption function again to the resulting text, you can decrypt the text.</Text>
0592 <Syntax>ROT13(Text)</Syntax>
0593 <Example>ROT13("KSpread") returns "XFcernq"</Example>
0594 <Example>ROT13("XFcernq") returns "KSpread"</Example>
0595 </Help>
0596 </Function>
0597
0598 <Function>
0599 <Name>TOGGLE</Name>
0600 <Type>String</Type>
0601 <Parameter>
0602 <Comment>Source string</Comment>
0603 <Type>String</Type>
0604 </Parameter>
0605 <Help>
0606 <Text>The TOGGLE() function changes lowercase characters to uppercase and uppercase characters to lowercase.</Text>
0607 <Syntax>TOGGLE(text)</Syntax>
0608 <Example>TOGGLE("hello") returns "HELLO"</Example>
0609 <Example>TOGGLE("HELLO") returns "hello"</Example>
0610 <Example>TOGGLE("HeLlO") returns "hElLo"</Example>
0611 <Related>UPPER</Related>
0612 <Related>LOWER</Related>
0613 </Help>
0614 </Function>
0615
0616 <Function>
0617 <Name>CLEAN</Name>
0618 <Type>String</Type>
0619 <Parameter>
0620 <Comment>Source string</Comment>
0621 <Type>String</Type>
0622 </Parameter>
0623 <Help>
0624 <Text>The CLEAN() function removes every non-printable character from the string</Text>
0625 <Syntax>CLEAN(text)</Syntax>
0626 <Example>CLEAN(AsciiToChar(7) + "HELLO") returns "HELLO"</Example>
0627 </Help>
0628 </Function>
0629
0630 <Function>
0631 <Name>SLEEK</Name>
0632 <Type>String</Type>
0633 <Parameter>
0634 <Comment>Source string</Comment>
0635 <Type>String</Type>
0636 </Parameter>
0637 <Help>
0638 <Text>The SLEEK() function removes all spaces from the string.</Text>
0639 <Syntax>SLEEK(text)</Syntax>
0640 <Example>SLEEK("This is some text ") returns "Thisissometext"</Example>
0641 <Related>TRIM</Related>
0642 </Help>
0643 </Function>
0644
0645 <Function>
0646 <Name>UPPER</Name>
0647 <Type>String</Type>
0648 <Parameter>
0649 <Comment>Source string</Comment>
0650 <Type>String</Type>
0651 </Parameter>
0652 <Help>
0653 <Text>The UPPER() function converts a string to upper case.</Text>
0654 <Syntax>UPPER(text)</Syntax>
0655 <Example>UPPER("hello") returns "HELLO"</Example>
0656 <Example>UPPER("HELLO") returns "HELLO"</Example>
0657 <Related>LOWER</Related>
0658 <Related>TOGGLE</Related>
0659 </Help>
0660 </Function>
0661
0662 <Function>
0663 <Name>LOWER</Name>
0664 <Type>String</Type>
0665 <Parameter>
0666 <Comment>Source string</Comment>
0667 <Type>String</Type>
0668 </Parameter>
0669 <Help>
0670 <Text>The LOWER() function converts a string to lower case.</Text>
0671 <Syntax>LOWER(text)</Syntax>
0672 <Example>LOWER("hello") returns "hello"</Example>
0673 <Example>LOWER("HELLO") returns "hello"</Example>
0674 <Related>UPPER</Related>
0675 <Related>TOGGLE</Related>
0676 </Help>
0677 </Function>
0678
0679 <Function>
0680 <Name>CHAR</Name>
0681 <Type>String</Type>
0682 <Parameter>
0683 <Comment>Character code</Comment>
0684 <Type>Int</Type>
0685 </Parameter>
0686 <Help>
0687 <Text>The CHAR() function returns the character specified by a number.</Text>
0688 <Syntax>CHAR(code)</Syntax>
0689 <Example>CHAR(65) returns "A"</Example>
0690 <Related>CODE</Related>
0691 </Help>
0692 </Function>
0693
0694 <Function>
0695 <Name>CODE</Name>
0696 <Type>Int</Type>
0697 <Parameter>
0698 <Comment>Text</Comment>
0699 <Type>String</Type>
0700 </Parameter>
0701 <Help>
0702 <Text>The CODE() function returns a numeric code for the first character in a text string.</Text>
0703 <Syntax>CODE(text)</Syntax>
0704 <Example>CODE("KDE") returns 75</Example>
0705 <Related>CHAR</Related>
0706 </Help>
0707 </Function>
0708
0709 <Function>
0710 <Name>VALUE</Name>
0711 <Type>Double</Type>
0712 <Parameter>
0713 <Comment>Text</Comment>
0714 <Type range="false">String</Type>
0715 </Parameter>
0716 <Help>
0717 <Text>Converts text string that represents a value to the real value. </Text>
0718 <Syntax>VALUE(text)</Syntax>
0719 <Example>VALUE("14.03") returns 14.03</Example>
0720 </Help>
0721 </Function>
0722
0723 <Function>
0724 <Name>REGEXP</Name>
0725 <Type>String</Type>
0726 <Parameter>
0727 <Comment>Searched text</Comment>
0728 <Type range="false">String</Type>
0729 </Parameter>
0730 <Parameter>
0731 <Comment>Regular expression</Comment>
0732 <Type range="false">String</Type>
0733 </Parameter>
0734 <Parameter>
0735 <Comment>Default value (optional)</Comment>
0736 <Type range="false">String</Type>
0737 </Parameter>
0738 <Parameter>
0739 <Comment>Back-reference (optional)</Comment>
0740 <Type range="false">Number</Type>
0741 </Parameter>
0742 <Help>
0743 <Text>Returns a part of the string that matches a regular expression. If the string does not match the given regular expression, value specified as default is returned.</Text>
0744 <Text>If a back-reference is provided, then the value of that back-reference is returned.</Text>
0745 <Text>If no default value is given, an empty string is assumed. If no back-reference is given, 0 is assumed (so that entire matching part is returned).</Text>
0746 <Syntax>REGEXP(text; regexp; default; backref)</Syntax>
0747 <Example>REGEXP("Number is 15.";"[0-9]+") = "15" </Example>
0748 <Example>REGEXP("15, 20, 26, 41";"([0-9]+), *[0-9]+$";"";1) = "26" </Example>
0749 </Help>
0750 </Function>
0751
0752 <Function>
0753 <Name>REGEXPRE</Name>
0754 <Type>String</Type>
0755 <Parameter>
0756 <Comment>Searched text</Comment>
0757 <Type range="false">String</Type>
0758 </Parameter>
0759 <Parameter>
0760 <Comment>Regular expression</Comment>
0761 <Type range="false">String</Type>
0762 </Parameter>
0763 <Parameter>
0764 <Comment>Replacement</Comment>
0765 <Type range="false">String</Type>
0766 </Parameter>
0767 <Help>
0768 <Text>Replaces all matches of a regular expression with the replacement text</Text>
0769 <Syntax>REGEXPRE(text; regexp; replacement)</Syntax>
0770 <Example>REGEXPRE("14 and 15 and 16";"[0-9]+";"num") returns "num and num and num"</Example>
0771 </Help>
0772 </Function>
0773
0774 <Function>
0775 <Name>UNICODE</Name>
0776 <Type>Int</Type>
0777 <Parameter>
0778 <Comment>Text</Comment>
0779 <Type>String</Type>
0780 </Parameter>
0781 <Help>
0782 <Text>The UNICODE() function returns a unicode code point for the first character in a text string.</Text>
0783 <Syntax>UNICODE(text)</Syntax>
0784 <Example>UNICODE("KDE") returns 75</Example>
0785 <Related>UNICHAR</Related>
0786 <Related>CODE</Related>
0787 </Help>
0788 </Function>
0789
0790 <Function>
0791 <Name>UNICHAR</Name>
0792 <Type>String</Type>
0793 <Parameter>
0794 <Comment>Character code</Comment>
0795 <Type>Int</Type>
0796 </Parameter>
0797 <Help>
0798 <Text>The UNICHAR() function returns the character specified by a unicode code point.</Text>
0799 <Syntax>UNICHAR(code)</Syntax>
0800 <Example>UNICHAR(65) returns "A"</Example>
0801 <Related>UNICODE</Related>
0802 <Related>CHAR</Related>
0803 </Help>
0804 </Function>
0805
0806 <Function>
0807 <Name>ASC</Name>
0808 <Type>String</Type>
0809 <Parameter>
0810 <Comment>Full width characters</Comment>
0811 <Type>String</Type>
0812 </Parameter>
0813 <Help>
0814 <Text>The ASC() function returns the half-width characters corresponding to the full-width argument.</Text>
0815 <Syntax>ASC(text)</Syntax>
0816 <Related>JIS</Related>
0817 </Help>
0818 </Function>
0819
0820 <Function>
0821 <Name>JIS</Name>
0822 <Type>String</Type>
0823 <Parameter>
0824 <Comment>Half-width characters</Comment>
0825 <Type>String</Type>
0826 </Parameter>
0827 <Help>
0828 <Text>The JIS() function returns the full-width characters corresponding to the half-width argument.</Text>
0829 <Syntax>JIS(text)</Syntax>
0830 <Related>ASC</Related>
0831 </Help>
0832 </Function>
0833
0834 <Function>
0835 <Name>BAHTTEXT</Name>
0836 <Type>String</Type>
0837 <Parameter>
0838 <Comment>Number</Comment>
0839 <Type>Int</Type>
0840 </Parameter>
0841 <Help>
0842 <Text>The BAHTTEXT() function converts a number to a text in Thai characters (baht).</Text>
0843 <Syntax>BAHTTEXT(number)</Syntax>
0844 <Example>BAHTTEXT(23) returns "ยี่สิบสามบาทถ้วน"</Example>
0845 </Help>
0846 </Function>
0847
0848 </Group>
0849
0850 </KSpreadFunctions>