Description
The GridCellGroup object is a collection of GridCell objects within a GridWindow. This object is not creatable in script, but this object type is returned when using the GridWindow.GetAllCells(), GetCellGroup(), GetRow(), and GetColumn() methods, as seen in the examples below:
GridWindow1.GetAllCells().SetValue(12345);
GridWindow1.GetCellGroup(0, 1, 0, 1).SetValue(12345);
GridWindow1.GetRow(0).SetValue(12345);
GridWindow1.GetColumn(0).SetValue(12345);
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->GridCellGroup
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
AlignmentHorizontal
|
The horizontal alignment for all cells in the GridCellGroup.
|
Type: String
Access: Write-Only
|
AlignmentVertical
|
The vertical alignment for all cells in the GridCellGroup.
|
Type: String
Access: Write-Only
|
BackgroundColor
|
The background color for all cells in the GridCellGroup.
|
Type: Variable
Access: Write-Only
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
Font
|
The GridFont object that contains properties pertaining to the font formatting of all cells in the GridCellGroup.
|
Type: GridFont
Access: Write-Only
|
Label
|
The string label for all cells in the GridCellGroup that will display on hover-over in the GridWindow.
|
Type: String
Access: Write-Only
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
TextColor
|
The text color for all cells in the GridCellGroup.
|
Type: Variable
Access: Write-Only
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetCell
|
Returns the GridCell located at the specified index or indices within the GridCellGroup.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
ResetBackgroundColorRules
|
Removes the background color rules for all cells in this GridCellGroup.
|
ResetTextColorRules
|
Removes the text color rules for all cells in this GridCellGroup.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetBackgroundColorRules
|
Applies an array of colors and thresholds or match values as rules so that whenever the value of any cell in the GridCellGroup matches the condition set forth by the specific type of rule applied, the associated color is applied to the background of that cell.
|
SetTextColorRules
|
Applies an array of colors and thresholds or match values as rules so that whenever the value of any cell in the GridCellGroup matches the condition set forth by the specific type of rule applied, the associated color is applied to the text in that cell.
|
SetValue
|
Sets the values for the GridCell objects in the GridCellGroup to the provided values. Will error if the size of the passed values array does not match the size of the GridCellGroup.
|
|
See also
GridWindow Guide
| 