Pivot Engine / Functions / Text Functions
In This Topic
    Text Functions
    In This Topic
    Syntax Description Example
    ARGB(nA, nR, nG, nB) Returns a valid color string in ARGB format. All color components are automatically clamped to the [0:255] range. ARGB(128, 255, 0, 0)
    Returns: "(128,255,0,0)" 
    CHAR(nNumber) Returns the character for a number. The resulting string is one character in length. CHAR(9)
    Returns: tab character
    FORMAT(var[,sFormat][,sCulture])

    Returns a formatted string representing a variant value. If format is not specified the default system format is used. If format is specified you can also specify a culture. If culture is not specified the default current culture is used.

    For number variants the format string should be a number format string. See Numeric Format Strings.

    For date time variants the format string should be a date time format string. See: Date Time Format Strings.

    Also see Culture Table for a list of culture names that you can use.

    (assuming current culture is en-US")

    FORMAT(10)
    Returns: "10"

    FORMAT(0.255555, "p")
    Returns: 25.56 %

    FORMAT(1000, "c")
    Returns: $1,000.00

    FORMAT(1000,"c","en-GB")
    Returns: £1,000.00

    FORMAT(DATETIME("2008-09-15T09:30:41.77"),"d")
    Returns: 9/15/2008

    FORMAT(DATETIME("2008-09-15T09:30:41.77"),"d","en-GB")
    Returns: 15/9/2008
    LEN(sString) Returns the number of characters in a text string. LEN("Hello World")
    Returns: 11
    JOIN(arr, sDelimiter) Returns a string variant, which represents the concatenation of the string representations of the variants contained in the array, delimited with delimiter. JOIN(ARRAY("Hello","World"), ";")
    Returns: Hello;World
    LIKE(sString, sPattern)

    Returns true if the pattern was found at least once in the string. The pattern is a regular expression. See:

    Regular Expressions on MSDN

    LIKE("Hello World", "ello")
    Returns: true

    LIKE("Hello World", "elllo")
    Returns: false
    LOWER(sString) Returns a string converted to lowercase. LOWER("Hello World")

    Returns: "hello world"
    REPLACE(sString, sOldText, sNewText) Replaces all occurrences of old text in a string with the specified new text. REPLACE("Hello World", "Hello", "Beautiful")

    Returns: "Beautiful World"
    RGB(nR, nG, nB) Returns a valid color string in RGB format. All color components are automatically clamped to the [0:255] range. RGB(255, 0, 0)
    Returns: "(255,0,0)" 
    SPLIT(sString, sSeparator[, bRemoveEmpty])

    Splits the string, by the specified separator. Optionally you can specify whether empty strings are to be removed - by default they are not removed. Returns an array of strings.

    SPLIT("Hello World", " ")

    Returns: an array containing "Hello" and "World"

    SPLIT(ARRAY("Hello World", "Hello World"), " ")

    Returns: an array containing "Hello", "World", "Hello", "World"

    STRSAME(sString1, sString2[, ignoreCase]) Returns true if the string are the same. Otherwise returns false. The optional ignoreCase argument indicates whether to perform case-insensitive comparison (by default it is false).

    STRSAME("Hello", "hello")
    Returns: false

    STRSAME("Hello", "hello", true)
    Returns: true

    TRIM(sString) Removes all space from string except for single spaces between words. TRIM(" Hello World ")
    Returns: "Hello World"
    UPPER(sString) Returns a string converted to uppercase. UPPER("Hello World")
    Returns: "HELLO WORLD"