Description
A GridCell object is used to hold strings and/or variables to display within a GridWindow. This object is not creatable in script, but this object type is returned when using the GridWindow.GetCell() method, as seen in the example below:
GridWindow1.GetCell(0, 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àGridCell
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
AlignmentHorizontal
|
The horizontal alignment for the cell.
|
AlignmentVertical
|
The vertical alignment for the cell.
|
BackgroundColor
|
The background color for the cell.
|
ColumnSpan
|
The number of columns to the right of the cell's column that this cell encompasses, including the cell itself.
|
DeclaredName
|
The name of the object as declared.
|
Font
|
The GridFont object that contains properties pertaining to the font formatting of the cell.
|
Label
|
The string label for the cell that will display on hover-over in the GridWindow.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
RowSpan
|
The number of rows below the cell's row that this cell encompasses, including the cell itself.
|
TextColor
|
The text color for the cell.
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
GetNumericValue
|
Returns the value of the cell as a number. Errors if the value stored in the cell is a string that cannot be converted to a number.
|
GetStringValue
|
Returns the value of the cell as a 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 the cell.
|
ResetTextColorRules
|
Removes the text color rules for the cell.
|
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 the cell matches the condition set forth by the specific type of rule applies, 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 the cell 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 value stored in the cell.
|
|
See also
GridWindow Guide
|
