Row Properties

• Jul 05, 2018
• 3 minutes to read

The vertical grid controls (VGridControl and PropertyGridControl) support various row types as described in the Rows Overview topic. Rows of different types have some common settings, the settings that are available for a particular row type is dependent upon the type of data it displays. Settings which depend upon data are stored in separate objects. This topic describes the manner in which these settings are implemented for different row types and, how they can be accessed and used.

Row Items

There are two key differences between row types. The first is whether a row type is capable of displaying data. The second is the number of cells displayed for each record. These differences define which settings are required by a particular row type. The list below enumerates all the available row types and explains the settings that are required by each type:

• Rows that don’t display any data cells - Category Rows. Rows of this type need only settings that affect their headers, such as the caption and image.
• Rows that display a single cell within each record - Editor Rows. Rows of this type need settings that affect their headers and data settings. The data settings include the editor used to display and edit cell values, a format string, the name of the bound field, etc.
• Rows that are capable of displaying multiple cells within each record - Multi-editor rows. Note that rows of this type have several header cells. Thus, they need several setting objects similar to the settings required by editor and caption rows.

You might already have noticed that the category and editor rows are similar since they require a single settings object - row item settings which is represented by a RowProperties descendant. Multi-editor rows can consist of several row items.

The image below illustrates the notion of a row item.

Accessing Row Properties (Row Item STEM )

Each row type has its own corresponding type of row item settings. Thus, the CategoryRowProperties, RowProperties and MultiEditorRowProperties classes provide settings for the CategoryRow, EditorRow and MultiEditorRow items, respectively. In simple rows the row item settings can be accessed using the row’s Properties property. At design time you can access these settings by switching to the Row Properties tab in the Rows Page. The image below shows how to access the item settings of an editor row.

As explained above, complex rows (Multi-editor rows) can contain several row items and thus maintain a collection of row item settings. At runtime, this collection can be accessed via the row’s MultiEditorRow.PropertiesCollection property. At design time, the Rows Page displays the tab pages that correspond to individual row items as shown in the image below.

The settings provided for row items are listed below:

• The header cell’s caption - the RowProperties.Caption property.
• The index of the image displayed within a header cell - the RowProperties.ImageIndex property.
• The format of the values displayed within data cells - the RowProperties.Format property.
• The editor used to display and edit cell values - the RowProperties.RowEdit property.
• The name of the bound field - the RowProperties.FieldName property. This property isn’t used when working in Unbound Mode.
• The edit value - the RowProperties.Value property. This property is only used when working in Unbound Mode. Otherwise, cells are filled with values from the bound data field or left blank if the bound field isn’t specified.

For details on features specific to each row type, see the Category Rows, Editor Rows and Multi-editor rows topics.