MultiEditorRowPropertiesCollection Class

Represents a collection of items within a multi-editor row.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

Declaration

C#

[ListBindable(false)]
public class MultiEditorRowPropertiesCollection :
    IList,
    ICollection,
    IEnumerable,
    IRowViewScaler,
    IEnumerable<RowProperties>

VB.NET

<ListBindable(False)>
Public Class MultiEditorRowPropertiesCollection
    Implements IList,
               ICollection,
               IEnumerable,
               IRowViewScaler,
               IEnumerable(Of RowProperties)

Related API Members

The following members return MultiEditorRowPropertiesCollection objects:

• MultiEditorRow.PropertiesCollection

Remarks

The MultiEditorRowPropertiesCollection object represents a collection of regular data rows contained within a multi-editor row. An empty row item collection is created automatically when a multi-editor row is instantiated so, you do not need to create and initialize it manually. A collection can be accessed by the MultiEditorRow.PropertiesCollection property of a multi-editor row. Use the methods and properties of the MultiEditorRowPropertiesCollection object to manipulate row items within the collection.

A particular row item and its settings can be accessed by the MultiEditorRowPropertiesCollection.Item property. An item can be specified either by its index within the collection or by the name of the bound data field. The MultiEditorRowProperties object represents the item settings of an individual row, its properties can be modified to set the row item caption (via the RowProperties.Caption property), bind to a data field (via the RowProperties.FieldName property), specify the editor type for it (via the RowProperties.RowEdit property), etc.

You can programmatically add new row items to the collection by using the MultiEditorRowPropertiesCollection.Add and MultiEditorRowPropertiesCollection.AddRange methods. While the overloaded variants of the MultiEditorRowPropertiesCollection.Add method automatically create and return new instances of the MultiEditorRowProperties class, the MultiEditorRowPropertiesCollection.AddRange method allows you to add already existing row item objects to the collection.

If the row item collection is not empty, you can use the MultiEditorRowPropertiesCollection.Remove, MultiEditorRowPropertiesCollection.RemoveAt or the MultiEditorRowPropertiesCollection.Clear method to delete existing row items from the collection.

The item order in the collection determines the order in which row items are displayed within a multi-editor row. To obtain a specific item’s index, use the collection’s MultiEditorRowPropertiesCollection.IndexOf property. The MultiEditorRowPropertiesCollection.Count property indicates the total number of row items in the collection.

Use the MultiEditorRowPropertiesCollection.Contains method to determine whether a particular row item belongs to the collection.

Inheritance

Object

MultiEditorRowPropertiesCollection