Hierarchical Grid Methods and Properties

Objective Grid for Microsoft .NET User's Guide
Rogue Wave web site: Home Page | Main Documentation Page

7.2 Hierarchical Grid Methods and Properties

When you enable hierarchical grid, the following hierarchical-grid-specific properties and methods are available:

Table 28: Hierarchical Grid Properties

Property	Description
`HierarchicalGrid`	Enables or disables hierarchical grid display. This property should be set to `true` to enable hierarchy display or `false` to prevent it. Note: This property can be assigned at design time or runtime. If the value is changed at runtime, all rows and columns are automatically deleted and must be programmatically added back to the grid.
`HgMap`	For advanced uses. It is described in Section 7.5, "Advanced Topics."

Table 29: Hierarchical Grid Methods

Method	Description
`EnableHierarchicalGrid`	Enables or disables hierarchical grid display. This method is virtual, allowing your derived classes to override this method and do custom initialization steps before or after the mode is changed.
`GetChildAt`	Retrieves the *GridControl*-derived instances at the specified row. Once retrieved, you can directly access the API of the child grid to populate it with data or affect its styles.
`GetParent`	From a child grid, this method returns the parent grid or null if this grid is the topmost grid.
`ExpandRow`	Expands or collapses the specified row, showing or hiding the child grid. This method can be overridden, enabling derived classes to perform application-specific actions following a row expansion or collapse.
`IsChildShown`	Returns `true` if the child at the specified position is shown or `false` if hidden.
`HideExpanderColumn`	Enables you to show or hide the expander column. The expander column is the left-most column containing the plus-minus expander controls for all parent rows.
`DeleteChildAt`	Destroys the child associated with the given row, assuming it has been created. Note: Child grid instances are created on demand.
`DeleteChildren`	Destroys all children within the range of rows specified.
`CreateChildAt`	Virtual method that is responsible for creating and initializing a child grid instance for the specified row. This method can be overridden to enable your own *GridControl*-derived classes to be used as child grid types.
`InstantiateChildAt`	Instantiates the grid control instance to use as the child for the specified row. `CreateChildAt` calls this function, so you can override either method to customize the child grid type.
`InitializeChildAt`	Initializes the child grid just before displaying it.
`IsRowExpandable`	Indicates whether or not the given row contains children and should therefore display a plus-minus expander control.

The non-hierarchical GridControl API members do not change when hierarchical grid is enabled.

The Rogue Wave name and logo, and Stingray, are registered trademarks of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.