Libraries.Interface.Undo.TextBoxEdit Documentation

Inherits from: Libraries.Language.Object, Libraries.Interface.Undo.Edit

Actions Documentation

CanRedo()

This action detects whether an operation can be redone and returns true if it can. By default, not overriding this action means the answer will always be true.

Return

boolean:

Example

use Libraries.Interface.Undo.Edit
Edit edit
output edit:CanRedo()

CanUndo()

This action detects whether an operation can be undone and returns true if it can. By default, not overriding this action means the answer will always be true.

Return

boolean:

Example

use Libraries.Interface.Undo.Edit
Edit edit
output edit:CanUndo()

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.

Parameters

Return

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

Example

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

Dispose()

This action tells this Edit to free up any state it is holding, if any.

Example

use Libraries.Interface.Undo.Edit
Edit edit
edit:Dispose()

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetRedoName()

This action returns the presentation name for redoing this operation.

Return

text:

Example

use Libraries.Interface.Undo.Edit
Edit edit
output edit:GetRedoName()

GetRedoState()

The state of the TextBox after the edit was made (and what it is restored to during a Redo).

Return

Libraries.Interface.Undo.TextBoxEditState:

GetTextBox()

Return

Libraries.Interface.Controls.TextBox

GetUndoName()

This action returns the presentation name for undoing this operation.

Return

text:

Example

use Libraries.Interface.Undo.Edit
Edit edit
output edit:GetUndoName()

GetUndoState()

Return

Libraries.Interface.Undo.TextBoxEditState

Redo()

SetRedoState(Libraries.Interface.Undo.TextBoxEditState state)

The state of the TextBox before the edit was made (and what it is restored to during an Undo).

Parameters

SetTextBox(Libraries.Interface.Controls.TextBox box)

Parameters

SetUndoState(Libraries.Interface.Undo.TextBoxEditState state)

Parameters

Undo()