1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
|
<!DOCTYPE KSpreadFunctions>
<KSpreadFunctions>
<Group>
<GroupName>Text</GroupName>
<Function>
<Name>DOLLAR</Name>
<Type>String</Type>
<Parameter>
<Comment>Number</Comment>
<Type>Double</Type>
</Parameter>
<Parameter optional="true">
<Comment>Decimals</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>DOLLAR(number;decimals)</Syntax>
<Example>DOLLAR(1403.77) returns "$ 1,403.77"</Example>
<Example>DOLLAR(-0.123;4) returns "$-0.1230"</Example>
</Help>
</Function>
<Function>
<Name>FIXED</Name>
<Type>String</Type>
<Parameter>
<Comment>Number</Comment>
<Type>Double</Type>
</Parameter>
<Parameter optional="true">
<Comment>Decimals</Comment>
<Type>Int</Type>
</Parameter>
<Parameter optional="true">
<Comment>No_commas</Comment>
<Type>Boolean</Type>
</Parameter>
<Help>
<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>
<Syntax>FIXED(number;decimals;no_commas)</Syntax>
<Example>FIXED(1234.567;1) returns "1,234.6"</Example>
<Example>FIXED(1234.567;1;FALSE) returns "1234.6"</Example>
<Example>FIXED(44.332) returns "44.33"</Example>
</Help>
</Function>
<Function>
<Name>SUBSTITUTE</Name>
<Type>String</Type>
<Parameter>
<Comment>Text for which you want to substitute</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Part of text you want to replace</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>New text which will be replacement</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Which occurrence to replace</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>SUBSTITUTE(text; old_text; new_text; instance_num)</Syntax>
<Example>SUBSTITUTE("Cost Data";"Cost";"Sales") returns "Sales Data"</Example>
<Example>SUBSTITUTE("Qtr 1, 2001";"1";"3";1) returns "Qtr 3, 2001"</Example>
<Example>SUBSTITUTE("Qtr 1, 2001";"1";"3";4) returns "Qtr 3, 2003"</Example>
<Related>REPLACE</Related>
<Related>REPLACEB</Related>
<Related>FIND</Related>
<Related>FINDB</Related>
</Help>
</Function>
<Function>
<Name>SEARCH</Name>
<Type>Int</Type>
<Parameter>
<Comment>The text you want to find</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>The text which may contain find_text</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Specified index to start the search</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<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>
<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>
<Syntax>SEARCH(find_text;within_text;start_num)</Syntax>
<Example>SEARCH("e";"Statements";6) returns 7</Example>
<Example>SEARCH("margin";"Profit Margin") returns 8</Example>
<Related>FIND</Related>
<Related>FINDB</Related>
<Related>SEARCHB</Related>
</Help>
</Function>
<Function>
<Name>SEARCHB</Name>
<Type>Int</Type>
<Parameter>
<Comment>The text you want to find</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>The text which may contain find_text</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Specified byte position to start the search</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<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>
<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>
<Syntax>SEARCHB(find_text;within_text;BytePosition Start)</Syntax>
<Related>FINDB</Related>
<Related>FIND</Related>
<Related>SEARCH</Related>
</Help>
</Function>
<Function>
<Name>T</Name>
<Type>String</Type>
<Parameter>
<Comment>Value</Comment>
<Type>Any</Type>
</Parameter>
<Help>
<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>
<Syntax>T(value)</Syntax>
<Example>T("Calligra") returns "Calligra"</Example>
<Example>T(1.2) returns "" (empty text)</Example>
</Help>
</Function>
<Function>
<Name>TEXT</Name>
<Type>String</Type>
<Parameter>
<Comment>Value</Comment>
<Type>Any</Type>
</Parameter>
<Help>
<Text>The TEXT() function converts a value to text.</Text>
<Syntax>TEXT(value)</Syntax>
<Example>TEXT(1234.56) returns "1234.56"</Example>
<Example>TEXT("KSpread") returns "KSpread"</Example>
</Help>
</Function>
<Function>
<Name>PROPER</Name>
<Type>String</Type>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The PROPER() function converts the first letter of each word to uppercase and the rest of the letters to lowercase.</Text>
<Syntax>PROPER(string)</Syntax>
<Example>PROPER("this is a title") returns "This Is A Title"</Example>
</Help>
</Function>
<Function>
<Name>COMPARE</Name>
<Type>Int</Type>
<Parameter>
<Comment>First string</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>String to compare with</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Compare case-sensitive (true/false)</Comment>
<Type>Boolean</Type>
</Parameter>
<Help>
<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>
<Syntax>COMPARE(string1; string2; true|false)</Syntax>
<Example>COMPARE("Calligra"; "Calligra"; true) returns 0</Example>
<Example>COMPARE("calligra"; "Calligra"; true) returns 1</Example>
<Example>COMPARE("kspread"; "Calligra"; false) returns 1</Example>
<Related>EXACT</Related>
</Help>
</Function>
<Function>
<Name>EXACT</Name>
<Type>Boolean</Type>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The EXACT() function returns True if these two strings are equal. Otherwise, it returns False.</Text>
<Syntax>EXACT(string1;string2)</Syntax>
<Example>EXACT("Calligra";"Calligra") returns True</Example>
<Example>EXACT("KSpread";"Calligra") returns False</Example>
<Related>COMPARE</Related>
</Help>
</Function>
<Function>
<Name>REPLACE</Name>
<Type>String</Type>
<Parameter>
<Comment>Text which you want to replace some characters</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Position of the characters to replace</Comment>
<Type>Int</Type>
</Parameter>
<Parameter>
<Comment>Number of characters to replace</Comment>
<Type>Int</Type>
</Parameter>
<Parameter>
<Comment>The text that will replace characters in old text</Comment>
<Type range="false">String</Type>
</Parameter>
<Help>
<Text>The REPLACE() function replaces part of a text string with a different text string.</Text>
<Syntax>REPLACE(text;position;length;new_text)</Syntax>
<Example>REPLACE("abcdefghijk";6;5;"-") returns "abcde-k"</Example>
<Example>REPLACE("2002";3;2;"03") returns "2003"</Example>
<Related>FIND</Related>
<Related>MID</Related>
<Related>FINDB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>REPLACEB</Name>
<Type>String</Type>
<Parameter>
<Comment>Text which you want to replace some characters using byte position</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Byte position of the characters to replace</Comment>
<Type>Int</Type>
</Parameter>
<Parameter>
<Comment>The byte length of characters to replace</Comment>
<Type>Int</Type>
</Parameter>
<Parameter>
<Comment>The text that will replace characters in old text</Comment>
<Type range="false">String</Type>
</Parameter>
<Help>
<Text>The REPLACEB() function replaces part of a text string with a different text string using byte positions.</Text>
<Syntax>REPLACEB(text;BytePosition;ByteLength Len;new_text)</Syntax>
<Related>FINDB</Related>
<Related>MIDB</Related>
<Related>FIND</Related>
<Related>MID</Related>
</Help>
</Function>
<Function>
<Name>FIND</Name>
<Type>Int</Type>
<Parameter>
<Comment>The text you want to find</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>The text which may contain find_text</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Specifies index to start the search</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<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>
<Text>You can also use function SEARCH, but unlike SEARCH, FIND is case-sensitive and does not allow wildcard characters.</Text>
<Syntax>FIND(find_text;within_text;start_num)</Syntax>
<Example>FIND("Cal";"Calligra") returns 1</Example>
<Example>FIND("i";"Calligra") returns 5</Example>
<Example>FIND("a";"Sheets in Calligra";4) returns 12</Example>
<Related>FINDB</Related>
<Related>SEARCH</Related>
<Related>REPLACE</Related>
<Related>SEARCHB</Related>
<Related>REPLACEB</Related>
</Help>
</Function>
<Function>
<Name>FINDB</Name>
<Type>Int</Type>
<Parameter>
<Comment>The text you want to find</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>The text which may contain find_text</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Specifies byte position to start the search</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<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>
<!--FIXME rename start_num to BytePosition like in Syntax-->
<Syntax>FINDB(find_text;within_text;BytePosition Start)</Syntax>
<Related>FIND</Related>
<Related>SEARCH</Related>
<Related>REPLACE</Related>
<Related>SEARCHB</Related>
<Related>REPLACEB</Related>
</Help>
</Function>
<Function>
<Name>MID</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Position</Comment>
<Type>Int</Type>
</Parameter>
<Parameter optional="true">
<Comment>Length</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<Text>The MID() function returns a substring that contains 'length' characters of the string, starting at 'position' index.</Text>
<Syntax>MID(text;position;length)</Syntax>
<Syntax>MID(text;position)</Syntax>
<Example>MID("Calligra";2;3) returns "all"</Example>
<Example>MID("Calligra";2) returns "alligra"</Example>
<Related>LEFT</Related>
<Related>RIGHT</Related>
<Related>LEFTB</Related>
<Related>RIGHTB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>MIDB</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Byte Position</Comment>
<Type>Int</Type>
</Parameter>
<Parameter optional="true">
<Comment>Byte Length</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<Text>The MIDB() function returns a substring that contains 'length' characters of the string, starting at 'position' index using byte positions.</Text>
<Syntax>MIDB(text;BytePosition Start;ByteLength)</Syntax>
<Syntax>MIDB(text;BytePosition Start)</Syntax>
<Related>LEFT</Related>
<Related>RIGHT</Related>
<Related>LEFTB</Related>
<Related>RIGHTB</Related>
<Related>MID</Related>
</Help>
</Function>
<Function>
<Name>LEN</Name>
<Type>Int</Type>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The LEN() function returns the length of the string.</Text>
<Syntax>LEN(text)</Syntax>
<Example>LEN("hello") returns 5</Example>
<Example>LEN("KSpread") returns 7</Example>
<Related>LENB</Related>
</Help>
</Function>
<Function>
<Name>LENB</Name>
<Type>Int</Type>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The LENB() function returns the length of the string using byte positions.</Text>
<Syntax>LENB(text)</Syntax>
</Help>
</Function>
<Function>
<Name>TRIM</Name>
<Type>String</Type>
<Parameter>
<Comment>String</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The TRIM() function returns text with only single spaces between words.</Text>
<Syntax>TRIM(text)</Syntax>
<Example>TRIM(" hello KSpread ") returns "hello KSpread"</Example>
</Help>
</Function>
<Function>
<Name>CONCATENATE</Name>
<Type>String</Type>
<Parameter optional="true">
<Comment>String values</Comment>
<Type range="true">String</Type>
</Parameter>
<Parameter optional="true">
<Comment>String values</Comment>
<Type range="true">String</Type>
</Parameter>
<Parameter optional="true">
<Comment>String values</Comment>
<Type range="true">String</Type>
</Parameter>
<Parameter optional="true">
<Comment>String values</Comment>
<Type range="true">String</Type>
</Parameter>
<Parameter optional="true">
<Comment>String values</Comment>
<Type range="true">String</Type>
</Parameter>
<Help>
<Text>The CONCATENATE() function returns a string which is the concatenation of the strings passed as parameters.</Text>
<Syntax>CONCATENATE(value;value;...)</Syntax>
<Example>CONCATENATE("Sheets";"Calligra";"KDE") returns "SheetsCalligraKDE"</Example>
</Help>
</Function>
<Function>
<Name>RIGHT</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Number of characters</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>RIGHT(text;length)</Syntax>
<Example>RIGHT("hello";2) returns "lo"</Example>
<Example>RIGHT("KSpread";10) returns "KSpread"</Example>
<Example>RIGHT("KSpread") returns "d"</Example>
<Related>LEFT</Related>
<Related>MID</Related>
<Related>LEFTB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>RIGHTB</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Byte Length</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>RIGHTB(text;ByteLength)</Syntax>
<Related>LEFT</Related>
<Related>MID</Related>
<Related>LEFTB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>LEFT</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Number of characters</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>LEFT(text;length)</Syntax>
<Example>LEFT("hello";2) returns "he"</Example>
<Example>LEFT("KSpread";10) returns "KSpread"</Example>
<Example>LEFT("KSpread") returns "K"</Example>
<Related>RIGHT</Related>
<Related>MID</Related>
<Related>RIGHTB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>LEFTB</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter optional="true">
<Comment>Byte Length</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>LEFTB(text;ByteLength)</Syntax>
<Related>RIGHT</Related>
<Related>MID</Related>
<Related>RIGHTB</Related>
<Related>MIDB</Related>
</Help>
</Function>
<Function>
<Name>REPT</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Parameter>
<Comment>Count of repetitions</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<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>
<Syntax>REPT(text;count)</Syntax>
<Example>REPT("KSpread";3) returns "KSpreadKSpreadKSpread"</Example>
<Example>REPT("KSpread";0) returns ""</Example>
</Help>
</Function>
<Function>
<Name>ROT13</Name>
<Type>String</Type>
<Parameter>
<Comment>Text</Comment>
<Type>String</Type>
</Parameter>
<Help>
<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>
<Text>By applying the encryption function again to the resulting text, you can decrypt the text.</Text>
<Syntax>ROT13(Text)</Syntax>
<Example>ROT13("KSpread") returns "XFcernq"</Example>
<Example>ROT13("XFcernq") returns "KSpread"</Example>
</Help>
</Function>
<Function>
<Name>TOGGLE</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The TOGGLE() function changes lowercase characters to uppercase and uppercase characters to lowercase.</Text>
<Syntax>TOGGLE(text)</Syntax>
<Example>TOGGLE("hello") returns "HELLO"</Example>
<Example>TOGGLE("HELLO") returns "hello"</Example>
<Example>TOGGLE("HeLlO") returns "hElLo"</Example>
<Related>UPPER</Related>
<Related>LOWER</Related>
</Help>
</Function>
<Function>
<Name>CLEAN</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The CLEAN() function removes every non-printable character from the string</Text>
<Syntax>CLEAN(text)</Syntax>
<Example>CLEAN(AsciiToChar(7) + "HELLO") returns "HELLO"</Example>
</Help>
</Function>
<Function>
<Name>SLEEK</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The SLEEK() function removes all spaces from the string.</Text>
<Syntax>SLEEK(text)</Syntax>
<Example>SLEEK("This is some text ") returns "Thisissometext"</Example>
<Related>TRIM</Related>
</Help>
</Function>
<Function>
<Name>UPPER</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The UPPER() function converts a string to upper case.</Text>
<Syntax>UPPER(text)</Syntax>
<Example>UPPER("hello") returns "HELLO"</Example>
<Example>UPPER("HELLO") returns "HELLO"</Example>
<Related>LOWER</Related>
<Related>TOGGLE</Related>
</Help>
</Function>
<Function>
<Name>LOWER</Name>
<Type>String</Type>
<Parameter>
<Comment>Source string</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The LOWER() function converts a string to lower case.</Text>
<Syntax>LOWER(text)</Syntax>
<Example>LOWER("hello") returns "hello"</Example>
<Example>LOWER("HELLO") returns "hello"</Example>
<Related>UPPER</Related>
<Related>TOGGLE</Related>
</Help>
</Function>
<Function>
<Name>CHAR</Name>
<Type>String</Type>
<Parameter>
<Comment>Character code</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<Text>The CHAR() function returns the character specified by a number.</Text>
<Syntax>CHAR(code)</Syntax>
<Example>CHAR(65) returns "A"</Example>
<Related>CODE</Related>
</Help>
</Function>
<Function>
<Name>CODE</Name>
<Type>Int</Type>
<Parameter>
<Comment>Text</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The CODE() function returns a numeric code for the first character in a text string.</Text>
<Syntax>CODE(text)</Syntax>
<Example>CODE("KDE") returns 75</Example>
<Related>CHAR</Related>
</Help>
</Function>
<Function>
<Name>VALUE</Name>
<Type>Double</Type>
<Parameter>
<Comment>Text</Comment>
<Type range="false">String</Type>
</Parameter>
<Help>
<Text>Converts text string that represents a value to the real value. </Text>
<Syntax>VALUE(text)</Syntax>
<Example>VALUE("14.03") returns 14.03</Example>
</Help>
</Function>
<Function>
<Name>REGEXP</Name>
<Type>String</Type>
<Parameter>
<Comment>Searched text</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Regular expression</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Default value (optional)</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Back-reference (optional)</Comment>
<Type range="false">Number</Type>
</Parameter>
<Help>
<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>
<Text>If a back-reference is provided, then the value of that back-reference is returned.</Text>
<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>
<Syntax>REGEXP(text; regexp; default; backref)</Syntax>
<Example>REGEXP("Number is 15.";"[0-9]+") = "15" </Example>
<Example>REGEXP("15, 20, 26, 41";"([0-9]+), *[0-9]+$";"";1) = "26" </Example>
</Help>
</Function>
<Function>
<Name>REGEXPRE</Name>
<Type>String</Type>
<Parameter>
<Comment>Searched text</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Regular expression</Comment>
<Type range="false">String</Type>
</Parameter>
<Parameter>
<Comment>Replacement</Comment>
<Type range="false">String</Type>
</Parameter>
<Help>
<Text>Replaces all matches of a regular expression with the replacement text</Text>
<Syntax>REGEXPRE(text; regexp; replacement)</Syntax>
<Example>REGEXPRE("14 and 15 and 16";"[0-9]+";"num") returns "num and num and num"</Example>
</Help>
</Function>
<Function>
<Name>UNICODE</Name>
<Type>Int</Type>
<Parameter>
<Comment>Text</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The UNICODE() function returns a unicode code point for the first character in a text string.</Text>
<Syntax>UNICODE(text)</Syntax>
<Example>UNICODE("KDE") returns 75</Example>
<Related>UNICHAR</Related>
<Related>CODE</Related>
</Help>
</Function>
<Function>
<Name>UNICHAR</Name>
<Type>String</Type>
<Parameter>
<Comment>Character code</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<Text>The UNICHAR() function returns the character specified by a unicode code point.</Text>
<Syntax>UNICHAR(code)</Syntax>
<Example>UNICHAR(65) returns "A"</Example>
<Related>UNICODE</Related>
<Related>CHAR</Related>
</Help>
</Function>
<Function>
<Name>ASC</Name>
<Type>String</Type>
<Parameter>
<Comment>Full width characters</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The ASC() function returns the half-width characters corresponding to the full-width argument.</Text>
<Syntax>ASC(text)</Syntax>
<Related>JIS</Related>
</Help>
</Function>
<Function>
<Name>JIS</Name>
<Type>String</Type>
<Parameter>
<Comment>Half-width characters</Comment>
<Type>String</Type>
</Parameter>
<Help>
<Text>The JIS() function returns the full-width characters corresponding to the half-width argument.</Text>
<Syntax>JIS(text)</Syntax>
<Related>ASC</Related>
</Help>
</Function>
<Function>
<Name>BAHTTEXT</Name>
<Type>String</Type>
<Parameter>
<Comment>Number</Comment>
<Type>Int</Type>
</Parameter>
<Help>
<Text>The BAHTTEXT() function converts a number to a text in Thai characters (baht).</Text>
<Syntax>BAHTTEXT(number)</Syntax>
<Example>BAHTTEXT(23) returns "ยี่สิบสามบาทถ้วน"</Example>
</Help>
</Function>
</Group>
</KSpreadFunctions>
|