Libraries.Interface.Selections.SpreadsheetSelection Documentation

Inherits from: Libraries.Interface.Selections.Selection, Libraries.Language.Object

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.

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)

Empty()

The Empty action sets the selection to be empty, or in other words, there is no cell actively selected. When the selection is empty, the x and y coordinates will be -1.

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)

Get()

This action selects a single cell in the spreadsheet.

Return

Libraries.Interface.Controls.Cell:

GetColumn()

Return

integer

GetDisplayName()

This action gets the name that would be shown to the user.

Return

text: The display name to be given to the user.

Example

action SelectionChanged(Selection selection)
    output selection:GetDisplayName()
end

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()

GetItem()

This action returns the item that contains the selection. It is not the selection itself.

Return

Libraries.Interface.Item:

Example

action SelectionChanged(Selection selection)
    Item theParentItem = selection:GetItem()
end

GetRow()

The Empty action sets the selection to be empty, or in other words, there is no cell actively selected. When the selection is empty, the x and y coordinates will be -1.

Return

integer:

GetSpreadsheet()

This action selects a single cell in the spreadsheet. In this case, the x represents the column number and the y represents the row.

Return

Libraries.Interface.Controls.Spreadsheet:

Initialize(Libraries.Interface.Item item)

Parameters

Initialize(Libraries.Interface.Item item, text displayName)

This action sets up the component with default attributes.

Parameters

IsEmpty()

Return

boolean

NotifySelectionListeners()

This action sends information that the selection was changed to all listeners.

Set(Libraries.Interface.Controls.Cell cell)

This action selects a single cell in the spreadsheet.

Parameters

Set(integer row, integer column)

This action selects a single cell in the spreadsheet. In this case, the x represents the column number and the y represents the row.

Parameters

  • integer row
  • integer column

SetDisplayName(text name)

This action sets the name that would be shown to the user. It also changes the selection, triggering a SelectionEvent.

Parameters

  • text name: The name to display.

Example

action SelectionChanged(Selection selection)
    selection:SetDisplayName("A new name I want to change to")
end