Libraries.Language.Types.Text

The Text class is the object representation of the primitive type text.

Example Code

class Main
   action Main
      text name = "melissa"
      Text result = test(name)
   end
   action test(Text value) returns Text
        return value
   end
end

This action compares two object values and returns an integer. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

Text o
        Text t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action compares two object values (ignoring case) and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Text o
        Text t
        integer result = o:CompareIgnoringCase(t) //1 (larger), 0 (equal), or -1 (smaller)

This action returns true if the Text value contains the text from the parameter or if the parameter is a substring in the text variable.

Example Code

Text a
        a:SetValue("hello ")
        boolean result = a:Contains("lo")

This action returns true if the Text value ends with the given suffix.

Example Code

Text a
        a:SetValue("hello ")
        boolean result = a:EndsWith("lo")

This action determines if two objects are equal based on their values.

Example Code

Text o
        Text t
        boolean result = o:Equals(t)

This action determines if two objects are equal based on their values(the case is ignored).

Example Code

Text o
        Text t
        boolean result = o:EqualsIgnoringCase(t)

This action gets the carriage return text value. This allows a carriage return to be added to a text variable without using the literal value.

Example Code

text a = "hello world"
        a = a + a:GetCarriageReturn() + "My name is"
        output a

This action gets the character specified by the given index and returns it.

Example Code

Text a
        a:SetValue("abcd")
        output a:GetCharacter(0)

This action gets the double quote text value. This allows a double quote to be added to a text variable without using the literal value.

Example Code

text a = "hello world"
        a = a + a:GetDoubleQuote() + "My name is" + a:GetDoubleQuote()
        output a

This action gets the hash code for an object. In this case, GetHashCode is overriden to be equivalent to the hash code of its containing object, value.

Example Code

Object o
        integer hash = o:GetHashCode()

This action gets the line feed text value. This allows a line feed to be added to a text variable without using the literal value.

Example Code

text a = "hello world"
        a = a + a:GetLineFeed() + "My name is"
        output a

This action returns the length of the text object.

Example Code

Text a
        a:SetValue("X")
        output a:GetSize()

This action returns a substring of the text object.

Example Code

use Libraries.Language.Types.Text
        Text a
        a:SetValue("hello world")
        output a:GetSubtext(0, 5)

This action gets a subtext value between the given start index and the end. This includes the value at the start index.

Example Code

use Libraries.Language.Types.Text
        Text a
        a:SetValue("hello ")
        text result = a:GetSubtext(1)

This action gets the tab text value. This allows a tab to be added to a text variable without using the literal value.

Example Code

text a = "hello world"
        a = a + a:GetTab() + "My name is"
        output a

This action gets a unicode symbol integer value. This allows any unicode symbol to be converted from text to the actual integer.

Example Code

text a = "hello world�?"
        output  "h as a unicode integer value is: " + a:GetUnicodeInteger(0)

This action gets a unicode symbol text value. This allows any unicode symbol to be added to a text variable without using the literal value.

Example Code

text a = "hello world"
        a = a + a:GetCarriageReturn() + "My name is" + a:GetUnicodeValue(2318)
        output a

This action gets the value from the text object.

Example Code

Text name
        text result = name:GetValue()

This action returns the index location of the first occurrence of the sub-text, starting from the given index location.

Example Code

Text a
        a:SetValue("hello ")
        integer result = a:IndexOf("l", 3)

This action returns the index location of the first occurrence of the sub-text.

Example Code

Text a
        a:SetValue("hello ")
        integer result = a:IndexOf("o")

This action returns true if the text is empty and false if it contains any value.

Example Code

Text a
        a:SetValue("hello ")
        boolean result = a:IsEmpty()

This action parses a text value and translates it into a boolean if the text value is a valid boolean value. If the text value is not a boolean then the user will be alerted by an Error.

Example Code

text a = "true"
        boolean result = a:ParseBoolean()

This action parses a text value and translates it into an integer if the text value is a valid integer value. If the text value is not an integer then the user will be alerted by an Error.

Example Code

text a = "12"
        integer result = a:ParseInteger()

This action parses a text value and translates it into a number if the text value is a valid number value. If the text value is not a number then the user will be alerted by an Error.

Example Code

text a = "12.5"
        number result = a:ParseNumber()

This action replaces a specific subtext with a new value.

Example Code

Text a
        a:SetValue("hello ")
        text result = a:Replace("l", "z")

This action sets the value of the text object.

Example Code

Text name
        name:SetValue("Melissa")

This action splits the string based on the given non-empty delimiter. The delimiter can be of any length. The string will be split by the given delimiter and an array of text objects will be returned, without the delimiter.

Example Code

use Libraries.Language.Types.Text
        use Libraries.Containers.Array
        Text a
        a:SetValue("hello world")
        Array<Text> values = a:Split("l")

This action splits the string based on the given non-empty delimiter. The delimiter can be of any length. The string will be split by the given delimiter and an array of text objects will be returned, without the delimiter.

Example Code

use Libraries.Language.Types.Text
        use Libraries.Containers.Array
        Text a
        a:SetValue("hello world")
        Array<Text> values = a:Split("l")

This action splits a text values into lines and returns them in an array.

Example Code

use Libraries.System.File
        use Libraries.Containers.Array
        use Libraries.Containers.Iterator

        File file
        file:SetAbsolutePath("Some/File.txt")
        text value = file:Read()
        Array<text> lines = value:SplitIntoLines()
        Iterator<text> iterator = lines:GetIterator()
        repeat while iterator:HasNext()
            text value1 = iterator:Next()
            output value1
        end

This action returns true if the Text value starts with the given suffix.

Example Code

Text a
        a:SetValue("hello ")
        boolean result = a:StartsWith("h")

This action converts a text value to all lower case.

Example Code

Text a
        a:SetValue("HeLlo ")
        text result = a:ToLowerCase()

This action converts a text value to all upper case.

Example Code

Text a
        a:SetValue("HeLlo ")
        text result = a:ToUpperCase()

This action trims the white space from the beginning and end of the text value.

Example Code

Text a
        a:SetValue(" hello  ")
        text result = a:Trim()