String Functions
Function | Description | Syntax |
---|---|---|
Compare | Performs a case-sensitive comparison of String1 to String2. Results are less than 0 if String1 is less than, 0 if equal to, or greater than 0 if greater than String2. | Compare(String1, String2) |
CompareNoCase | Performs a case-insensitive comparison of String1 to String2. Results are less than 0 if less than, 0 if equal to, or greater than 0 if greater than. | CompareNoCase(String1, String2) |
Concat | Concatenates two strings together. For example, Concat(“Hello”, “World”) becomes “HelloWorld” | Concat(String1, String2) |
CropLeft | Searches string left to right for CropString, which must consist of a single character. If found, returns String with the characters up to and including that character deleted. If not found, returns String. | CropLeft(String, CropString) |
CropRight | Searches string right to left for CropString, which must consist of a single character. If found, returns String with the characters from that character to the end of String deleted. If not found, returns String. | CropRight(String, CropString) |
Delete | Deletes at most Count characters from String starting at Index. | Delete(String, Index[, Count = 1]) |
Find | Performs a case-sensitive search of SearchString in String starting at Index and returns the index as a numeric result. If no string is found, the result is -1. | Find(String, SearchString[, Index = 0]) |
FindNoCase | Performs a case-insensitive search of SearchString in String starting at Index and returns the index as a numeric result. Returns -1 if no string is found. | FindNoCase(String, SearchString[, Index = 0]) |
FindOneOf | Performs a case-sensitive search of String for the first character that is also in FindString. Returns -1 if no character is found. | FindOneOf(String, FindString) |
GetLength | Obtains the length of String. | GetLength(String) |
Insert | Inserts InsertionString at Index into String. | Insert(String, Index, InsertionString) |
LeftCount | Extracts the leftmost Count characters from String and returns the string result. If Count exceeds the string length, extracts the entire string. | LeftCount(String, Count) |
LeftIndexString | Extracts the characters to the left of the first occurrence of IndexString. Returns String if String does not contain IndexString. | LeftIndexString(String, IndexString) |
MakeLower | Converts String to lowercase. | MakeLower(String) |
MakeUpper | Converts String to uppercase. | MakeUpper(String) |
MakeReverse | Reverses the order of the characters of String. | MakeReverse(String) |
MidIndex | Extracts at most Count characters from String starting at Index if Count is specified. If Count exceeds the string length, the entire string is extracted. | MidIndex(String, Index, [Count]) |
MidIndexString | Extracts at most Count characters from String starting at the first occurrence of IndexString if Count is specified. If Count exceeds the string length, the entire string is extracted. If String does not contain IndexString, the null string is returned. | MidIndexString(String, IndexString, [Count]) |
Replace | Performs a case-sensitive search and replaces all occurrences of OldString with NewString. | Replace(String, OldString, NewString) |
ReplaceNoCase | Performs a case-insensitive search and replaces all occurrences of OldString with NewString. | ReplaceNoCase(String, OldString, NewString) |
ReverseFind | Searches string right to left for SearchString, which must consist of a single character. If found, the index of the character is returned. If not found, -1 is returned. | ReverseFind(String, SearchString) |
RightCount | Extracts the rightmost Count characters from String and returns the string result. If Count exceeds the string length, extracts the entire string. | RightCount(String, Count) |
RightIndexString | Extracts the characters to the right of the first occurrence of IndexString. If String does not contain IndexString, the null string is returned. | RightIndexString(String, IndexString) |
SetAt | Replaces the characters of String with SetString starting at Index. The end result can be longer than String. | SetAt(String, Index, SetString) |
SpanExcluding | Extracts a string that contains characters in String that are not in SpanString, beginning with the first character in String and ending with the first character found in String that is also in SpanString. (That is, starting with the first character in String and up to but excluding the first character in String that is found in SpanString.) String is returned if no character in SpanString is found. | SpanExcluding(String, SpanString) |
SpanIncluding | Extracts a string that contains the characters in String that are in SpanString, starting with the first character in String and ending when a character is found in String that is not in SpanString. Returns the null string if the first character in String is not in SpanString. | SpanIncluding(String, SpanString) |
ToNumber | Converts a string to a number. Leading and trailing spaces are ignored. A null string is converted to zero. If Value is a number it is returned unchanged. | ToNumber(Value) |
TrimLeft | Returns String with the leading spaces removed. | TrimLeft(String) |
TrimRight | Returns String with the trailing spaces removed. | TrimRight(String) |
ValueToString | Converts a value to a string. For example, if the Value is an attribute of type TrueFalse, is named x, and x = 3, then ValueToString(x) returns "3". If Value is a string it is returned unchanged. | ValueToString(Value) |