Skip to content

GridControl Control

Description

Represents a GridControl.

For a list of all members defined in this module, see GridControl Members.

Object Model

Grid Control Object Model
Parallel Multiplier
Field Chooser
Image Manager Icons
Get Image
Focused Row
Focused Column
Data Manager
Create Empty Record
Grid Record Item
Behavior
Sections
Columns
Grid Column
Records
Grid Record
Paint Manager
Rows
Grid Row
Selected Rows
Sort Order
Groups Order
Navigator
Hit Test
Tool Tip Context
Print Options
Add Record
Insert Record
Print Preview Options
Create Records From Drop Array
Create Records
Header Records
Footer Records
Header Rows
Footer Rows
Markup Context

Remarks

A "Grid control" is a window that displays a hierarchical list of items, such as emails in the inbox. Each item is called a GridRow and consists of its properties and corresponding GridRecord, which contains all the corresponding data (mostly text). Each Row item (as well as Record) can have a list of sub items associated with it. By clicking a Row item, the user can expand and collapse the associated list of sub items.

The GridRecords collection holds all the GridRecord objects that are assigned to the GridControl. It can be accessed via the Records property. The records in this collection are referred to as the root records. Any record that is subsequently added to a root record is referred to as a child record. Because each GridRecord can contain a collection of other GridRecord objects, you might find it difficult to determine your location in the tree structure when you iterate through the collection.

Record nodes can be expanded to display the next level of child records. The user can expand the GridRecord by clicking the plus-sign (+) button, if one is displayed, or you can expand the GridRecord by setting the Expanded property to True.

You can collapse the child GridRecord level by setting the Expanded property to False, or the user can press the minus-sign (-) button, if one is displayed.

Each record contains an array of record items which are implemented with GridRecordItem and its descendants.

Each GridRecordItem has an association with the corresponding GridColumn item. The item will be shown below the corresponding column header depending on its position in the Grid control columns array. If a column does not have an associated item in the record, there will be an empty item shown in the corresponding cell.

The Columns array is represented by the GridColumns collection and can be accessed via the Columns property.

As a finalization of adding data to the Grid control, which means adding columns and records, the Populate method should be called. It performs population of control rows with data - creates a rows tree if necessary, rebuilds groups if grouping is enabled, and sorts rows in a specified manner.

You can also change the appearance of the GridControl control by setting some of its display and style properties. Also, the GridControl has the ability to store and restore its settings, which includes all columns with their settings, and some required control's settings.

See Also

GridControl Members


Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.