GridWindow Object

Description

The GridWindow object creates an Output Window that displays a group of strings and/or variables in a grid format with a user defined number of rows and columns.

Inheritance Hierarchy: Object->OutputWindow->GridWindow

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description
BeginBatchUpdate	This method marks the beginning of a period where any update to the window will be queued and only processed when the GridWindow.EndBatchUpdate method is called.
ClearSavedStates	Clears previous saved states for this object.
EndBatchUpdate	Processes all updates to the window that have occurred since the GridWindow.BeginBatchUpdate method was called.
GetAllCells	Returns a GridCellGroup containing all of the GridCell objects making up the GridWindow.
GetCell	Returns the GridCell object within the GridWindow that is specified by the row and column arguments.
GetCellGroup	Returns a GridCellGroup containing all of the GridCell objects encapsulated within the specified ranges in the GridWindow. The order of the GridCell objects in the returned group is across by row and down by column.
GetColumn	Returns a GridCellGroup containing all of the GridCell objects making up the specified column in the GridWindow.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetRow	Returns a GridCellGroup containing all of the GridCell objects making up the specified row in the GridWindow.
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.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SaveImage	Saves an image of the OutputWindow to a file. Note that this only works with FF.exe if the --windowed-output-mode switch is used.
SetColumnWidth	Sets the width for the specified column to the value of the width argument, where the type of width used is determined by the widthType argument.
SetRowHeight	Sets the height for the specified row to the value of the height argument, where the type of height used is determined by the heightType argument.
Show	Displays the GridWindow.