after-substring
Overview
Returns the substring of the argument string, containing all the characters immediately following the first occurrence of the string passed in parameter. If the parameter value is null or empty then the argument value is returned.
Parameters
- substring: The string to seek.
- count (optional) : The number of character positions to examine.
append
Overview
Returns the argument value followed by the parameter value. If the argument is null, it returns the text specified as the parameter.
Parameter
- text: The text to append
append-new-line
Overview
Returns the argument value followed by a space character. If the argument is null, it returns the text specified as the parameter.
append-space
Overview
Returns the argument value followed by a space character. If the argument is null, it returns the text specified as the parameter.
before-substring
Overview
Returns the substring of the argument string, containing all the characters immediately preceding the first occurrence of the string passed in parameter. If the parameter value is null or empty then the function returns empty.
Parameters
- substring: The string to seek.
- count (optional) : The number of character positions to examine.
clean-whitespace
Overview
returns the argument with any whitespace replaced by a space character. \r\n is considered as a single character.
collapse-whitespace
Overview
returns the argument with any two or more consecutive whitespaces replaced by the first whitespace in the sequence and trimming the result. \r\n is considered as a single character.
count-distinct-chars
Overview
Returns the count of distinct chars in the textual argument value. If the value is null or empty then it returns 0. If the value is blank then it returns -1.
count-substring
Overview
Returns the count of non-overlapping occurrences of a substring, defined as a parameter, in the argument value.
Parameter
- substring: The substring to count in the argument value.
empty-to-null
Overview
Returns the argument value except if this value is empty then it returns null.
filter-chars
Overview
Returns only those characters specified in the parameter, in the order, they were originally entered in the input value.
Parameter
- filter: The chars to filter from the argument string.
first-chars
Overview
Returns the first chars of the argument value. The length of the string returned is maximum the parameter value, if the argument string is smaller then the full string is returned.
Parameter
- length: An integer value between 0 and +Infinity, defining the length of the substring to return.
html-to-text
Overview
Returns the argument value that has previously been HTML-encoded into a decoded string.
last-chars
Overview
Returns the last chars of the argument value. The length of the string returned is maximum the parameter value, if the argument string is smaller then the full string is returned.
Parameter
- length: An integer value between 0 and +Infinity, defining the length of the substring to return.
length
Overview
Returns the length of the argument value. If the value is null or empty then it returns 0. If the value is blank then it returns -1.
lower
Overview
Returns the argument value converted to lowercase using the casing rules of the invariant culture.
mask-to-text
Overview
Returns the value that passed to the function TextToMask will return the argument value. If the length of the mask and the length of the argument value are not equal the function returns null. If the non-asterisk characters are not matching between the mask and the argument value then the function also returns null.
Parameter
- mask: The string representing the mask to be unset from the argument string.
null-to-empty
Overview
Returns the argument value except if this value is null then it returns empty.
pad-center
Overview
Returns a new string that center-aligns the characters in this string by padding them on both the left and the right with a specified character, for a specified total length. If the padding cannot be symetrical then the padding char is added on the right. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
Parameters
- length: An integer value between 0 and +Infinity, defining the minimal length of the string returned
- character: The padding character
pad-left
Overview
Returns a new string that right-aligns the characters in this string by padding them on the left with a specified character, for a specified total length. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
Parameters
- length: An integer value between 0 and +Infinity, defining the minimal length of the string returned
- character: The padding character
pad-right
Overview
Returns a new string that left-aligns the characters in this string by padding them on the right with a specified character, for a specified total length. If the length of the argument value is longer than the parameter value then the argument value is returned unmodified.
Parameters
- length: An integer value between 0 and +Infinity, defining the minimal length of the string returned
- character: The padding character
prefix
Overview
Returns the argument value preceeded by the parameter value. If the argument is null, it returns null.
Parameter
- prefix: The text to append
prefix-new-line
Overview
Returns the argument value preceeded by a space character. If the argument is null, it returns null.
prefix-space
Overview
Returns the argument value preceeded by a space character. If the argument is null, it returns null.
prepend
Overview
Returns the argument value preceeded by the parameter value. If the argument is null, it returns the text specified as the parameter.
Parameter
- text: The text to prepend
prepend-new-line
Overview
Returns the argument value preceeded by a space character. If the argument is null, it returns the text specified as the parameter.
prepend-space
Overview
Returns the argument value preceeded by a space character. If the argument is null, it returns the text specified as the parameter.
remove-chars
Overview
Returns the argument value without the specified character. If the argument and the parameter values are white-space characters then it returns empty.
Parameter
- charToRemove: The char to be removed from the argument string.
replace-chars
Overview
Returns the argument value where a specific char has been replaced by another, both specified as parameters.
Parameters
- charToReplace: The char to be replaced from the argument string.
- charReplacing: The replacing char from the argument string.
replace-slice
Overview
Returns the argument value with a subset of the string substitued by a another string.
Parameters
- start: The position to start to replace
- length: The length to replace
- append: The text to append when the slice has been removed
retain-alpha
Overview
Returns the input string with all characters removed except for letters (A-Z, a-z). If the argument is null, it returns null.
retain-alpha-numeric
Overview
Returns the input string with all characters removed except for letters (A-Z, a-z) and digits (0-9). If the argument is null, it returns null.
retain-numeric
Overview
Returns the input string with all non-numeric characters removed, leaving only digits (0-9).. If the argument is null, it returns null.
retain-numeric-symbol
Overview
Returns the input string with all characters removed except for digits (0-9) and the symbols +, -, , and . If the argument is null, it returns null.
skip-first-chars
Overview
Returns the last chars of the argument value. The length of the string omitted at the beginning of the argument value is equal to the parameter value. If the length of the argument value is smaller or equal to the parameter value then the functions returns empty.
Parameter
- length: An integer value between 0 and +Infinity, defining the length of the substring to skip.
skip-last-chars
Overview
Returns the first chars of the argument value. The length of the string omitted at the end of the argument value is equal to the parameter value. If the length of the argument value is smaller or equal to the parameter value then the functions returns empty.
Parameter
- length: An integer value between 0 and +Infinity, defining the length of the substring to skip.
suffix
Overview
Returns the argument value followed by the parameter value. If the argument is null, it returns null.
Parameter
- suffix: The text to append
suffix-new-line
Overview
Returns the argument value followed by a space character. If the argument is null, it returns null.
suffix-space
Overview
Returns the argument value followed by a space character. If the argument is null, it returns null.
text-to-datetime
Overview
Returns a dateTime value matching the argument value parsed by the long format in the culture specified in parameter.
Parameters
- format: A string representing the required format.
- culture (optional) : A string representing a pre-defined culture.
text-to-html
Overview
Returns the argument value converted to an HTML-encoded string
text-to-mask
Overview
Returns the argument value formatted according to the mask specified as parameter. Each asterisk (*) of the mask is replaced by the corresponding character in the argument value. Other charachters of the mask are not substitued. If the length of the argument value is less than the count of charachetsr that must be replaced in the mask, the last asterisk characters are not replaced.
Parameter
- mask: The string representing the mask to apply to the argument string.
token
Overview
Returns the token at the specified index in the argument value. The index of the first token is 0, the second token is 1, and so on. By default, the tokenization is executed based on any white-space characters. If a character is specified then the tokenization is executed based on this character to separate two tokens.
Parameters
- index: An integer value between 0 and +Infinity, defining the position of the token to be returned.
- separator (optional) : A character that delimits the substrings in this instance.
token-count
Overview
Returns the count of token within the argument value. By default, the tokenization is executed based on any white-space characters. If a character is specified then the tokenization is executed based on this character to separate two tokens.
Parameter
- separator: A character that delimits the substrings in this instance.
trim
Overview
Returns the argument value without all leading or trailing white-space characters.
upper
Overview
Returns the argument value converted to uppercase using the casing rules of the invariant culture.
whitespaces-to-empty
Overview
Returns the argument value except if this value only contains white-space characters then it returns empty.
whitespaces-to-null
Overview
Returns the argument value except if this value only contains white-space characters then it returns null.
without-diacritics
Overview
Returns the argument string without diacritics.
without-whitespaces
Overview
Returns the argument string without white-space characters.
