Libraries.Interface.Undo.TextBoxEditState Documentation

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCaretPosition()This action returns the index position of the caret at the time that this state was captured.
GetEndIndex()This action returns the end index of the TextBox's selection at the time this state was captured.
GetHashCode()This action gets the hash code for an object.
GetMultipleLineText()This action returns the text of the TextBox (as a MultipleLineText object) at the time this state was captured.
GetStartIndex()This action returns the start index of the TextBox's selection at the time this state was captured.
IsCaretAtEnd()This action returns whether or not the caret was at the end of the TextBox's selection at the time this state was captured.
Set(Libraries.Containers.MultipleLineText currentText, integer caretPosition, Libraries.Interface.Selections.TextBoxSelection selection)This action records the state of a TextBox from its current text, caret index, and selection.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

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

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

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

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetCaretPosition()

This action returns the index position of the caret at the time that this state was captured.

Return

integer:

GetEndIndex()

This action returns the end index of the TextBox's selection at the time this state was captured.

Return

integer:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetMultipleLineText()

This action returns the text of the TextBox (as a MultipleLineText object) at the time this state was captured.

Return

Libraries.Containers.MultipleLineText:

GetStartIndex()

This action returns the start index of the TextBox's selection at the time this state was captured.

Return

integer:

IsCaretAtEnd()

This action returns whether or not the caret was at the end of the TextBox's selection at the time this state was captured.

Return

boolean:

Set(Libraries.Containers.MultipleLineText currentText, integer caretPosition, Libraries.Interface.Selections.TextBoxSelection selection)

This action records the state of a TextBox from its current text, caret index, and selection.

Parameters