RowProperties Class

Represents settings common to all row items.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v18.1.dll

Declaration

C#

public class RowProperties :
    IDisposable,
    IDataColumnInfo,
    IControlFilterColumn

VB.NET

Public Class RowProperties
    Implements IDisposable,
               IDataColumnInfo,
               IControlFilterColumn

Related API Members

The following members accept/return RowProperties objects:

• BaseRow.GetRowProperties(Int32)
• BaseRow.GetRowProperties(String)
• BaseRow.Properties
• CategoryRow.Properties
• CustomDrawRowEventArgs.Properties
• EditorRow.Properties
• MultiEditorRow.Properties
• RowChangedEventArgs.Properties
• VGridControlBase.GetRowPropertiesByFieldName(String)
• VGridRows.GetRowPropertiesByFieldName(String)

Remarks

The RowProperties class represents settings which are common to all row items, it is the base class for classes that represent row item settings for the category and multi editor rows.

Settings that are common to items of different row types are listed below:

• The RowProperties.Caption property specifies the caption displayed within the row item’s header.
• The RowProperties.ImageIndex property specifies the index of the image displayed within the row item’s header.
• The RowProperties.RowEdit property allows you to specify the editor used to display and edit the row item values.
• The RowProperties.FieldName property specifies the name of a bound field. This property is not used when working in the Unbound Mode since the grid control is not bound to any data source in this case.
• The RowProperties.Value property represents the row item’s value. This property is only used when working in the Unbound Mode. Otherwise, cells are filled with values from the bound data field or are left blank if the bound field is not specified.

You have no need to create and initialize the RowProperties objects manually, since they are created automatically when an editor row is instantiated.

The RowProperties object can be accessed using the row’s BaseRow.Properties property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RowProperties class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/CS/dxPaintValue/MyPropertyGridControl.cs#L16

}
public DescriptorContext GetDescriptorContext(RowProperties properties) {
    return DataModeHelper.GetDescriptorContext(properties.FieldName);

VB.NET

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/VB/dxPaintValue/MyPropertyGridControl.vb#L18

End Function
Public Function GetDescriptorContext(ByVal properties As RowProperties) As DescriptorContext
    Return DataModeHelper.GetDescriptorContext(properties.FieldName)

Inheritance

Object

RowProperties

CategoryRowProperties

MultiEditorRowProperties