MultiEditorRowPropertiesCollection.Item[Int32] Property

Gets a row item object from the MultiEditorRow.PropertiesCollection at the specified position.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v21.1.dll

Declaration

public MultiEditorRowProperties this[int index] { get; }

Parameters

Name Type Description
index Int32

An integer value specifying the zero-based index of the desired row item.

Property Value

Type Description
MultiEditorRowProperties

A MultiEditorRowProperties object or descendant representing the row item located at the specified position within the row item collection.

Remarks

Use this property to obtain a row item representing an individual row properties object for a multi-editor row at the specified location within the row item collection. The collection can be accessed via the MultiEditorRow.PropertiesCollection property. You can use the MultiEditorRowPropertiesCollection.IndexOf method to locate a specific row item.

This property is an indexer for the MultiEditorRowProperties class. It gives you the ability to access a specific row item in the MultiEditorRow.PropertiesCollection by using the following syntax:

someMultiEditorRow.PropertiesCollection[index].

The index number is zero-based. If the parameter value is negative or exceeds the maximum available index, an exception is raised.

If you need to access a row item bound to a specific data field, you should use the overloaded variant of the MultiEditorRowPropertiesCollection.Item property, which accepts the field name as a parameter.

Example

The example below represents a procedure which uses the MultiEditorRowPropertiesCollection.Count and MultiEditorRowPropertiesCollection.Item properties to loop through all the row items of a multi-editor row passed as a parameter and create the corresponding items in a listView control. This example assumes that the form already contains a VGridControl and ListView controls named vGridControl1 and listView1 relatively.

Each newly created ListView item displays the caption and image of the corresponding row item from the MultiEditorRow.PropertiesCollection of the processed multi-editor row.

private void PopulateListView(BaseRow row) {
    // checking whether the passed row is of the multi editor type
    if (row.XtraRowTypeID != 2) return;
    MultiEditorRowPropertiesCollection propsCollection = 
      (row as MultiEditorRow).PropertiesCollection;

    // checking whether the collection of row items is not empty
    if (propsCollection.Count == 0) return;
    listView1.SmallImageList = vGridControl1.ImageList;

    // iterating through the collection of row items and 
    // creating the corresponding items in the list view control
    for (int i=0; i < propsCollection.Count; i++) {
        MultiEditorRowProperties props = propsCollection[i];
        listView1.Items.Add(props.Caption, props.ImageIndex);
    }
}
See Also