VGridRows.GetRowByFieldName(String, Boolean) Method

Gets a row by the name of the field to which it’s bound.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

Declaration

C#

public virtual BaseRow GetRowByFieldName(
    string fieldName,
    bool recursive
)

VB.NET

Public Overridable Function GetRowByFieldName(
    fieldName As String,
    recursive As Boolean
) As BaseRow

Parameters

Name	Type	Description
fieldName	String	A String value which specifies the name of the field in the data source.
recursive	Boolean	true to process the child rows that reside at greater nesting levels; false to process only the rows within the current rows collection.

Returns

Type	Description
BaseRow	A BaseRow descendant which represents the row bound to the data source field with the specified name. null (Nothing in Visual Basic) if no row is found.

Remarks

If the recursive parameter is set to true, the GetRowByFieldName method scans the rows within the row collection and their child rows at all nesting levels for a row whose RowProperties.FieldName property matches the parameter’s value. For example, to search for the row bound to the specified data source field amongst all the rows within the grid, the VGridControlBase.Rows collection’s GetRowByFieldName method should be used.

If the processed row is a multi-editor row, the GetRowByFieldName method traverses the row’s MultiEditorRow.Properties collection. If the multi-editor row contains the row item which is bound to the specified field, this multi-editor row is returned.

If the recursive parameter is set to false, only the rows contained within the collection are processed, their child rows (if any) are not processed in this case.