DataControlBase.FindRowByValue(String, Object) Method

Searches for the value in the column and returns the handle of the corresponding row.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.1.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public int FindRowByValue(
    string fieldName,
    object value
)

VB.NET

Public Function FindRowByValue(
    fieldName As String,
    value As Object
) As Integer

Parameters

Name	Type	Description
fieldName	String	A String value that specifies the field name of the column to be searched.
value	Object	An object that is the search value.

Returns

Type	Description
Int32	An integer value that is the handle of the corresponding row.

Remarks

If the value is not found, the FindRowByValue method returns DataControlBase.InvalidRowHandle.

If the column contains more than one search value, the FindRowByValue method returns the handle of the first corresponding row.

If the first parameter is set to String.Empty, the FindRowByValue method searches using the whole row value.

Refer to the following help topic for more information: Obtain Row Handles.

Example

This example shows how to identify a data cell with the specified value and focus it. To do this, click the Focus Cell button.

View Example: Focus a Cell with the Specified Value

XAML

<Grid>
    <Grid.RowDefinitions>
        <RowDefinition/>
        <RowDefinition Height="Auto"/>
    </Grid.RowDefinitions>
    <dxg:GridControl Name="grid" AutoGenerateColumns="AddNew">
        <dxg:GridControl.View>
            <dxg:TableView x:Name="view" AutoWidth="True" FadeSelectionOnLostFocus="False"/>
        </dxg:GridControl.View>
    </dxg:GridControl>
    <StackPanel Grid.Row="1" Orientation="Horizontal">
        <TextBlock Text="Unit Price:" TextAlignment="Right" Padding="4"/>
        <TextBox x:Name="textBox" Width="50" Margin="0,0,5,0" HorizontalAlignment="Left"/>
        <Button  Content="Focus Cell" HorizontalAlignment="Left" Click="FocusCell"/>
    </StackPanel>
</Grid>

C#

void FocusCell(object sender, RoutedEventArgs e) {
    if (!double.TryParse(textBox.Text, out double textValue))
        return;
    var rowHandle = grid.FindRowByValue(grid.Columns[nameof(Product.UnitPrice)], textValue);
    if (rowHandle == DataControlBase.InvalidRowHandle) 
        return;
    grid.CurrentColumn = grid.Columns[nameof(Product.UnitPrice)];
    view.FocusedRowHandle = rowHandle;
}

VB.NET

Private Sub FocusCell(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim textValue As Double = Nothing
    If Not Double.TryParse(Me.textBox.Text, textValue) Then Return
    Dim rowHandle = Me.grid.FindRowByValue(Me.grid.Columns(NameOf(Product.UnitPrice)), textValue)
    If rowHandle = DataControlBase.InvalidRowHandle Then Return
    Me.grid.CurrentColumn = Me.grid.Columns(NameOf(Product.UnitPrice))
    Me.view.FocusedRowHandle = rowHandle
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FindRowByValue(String, Object) method.

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-checkable-grouping-in-gridcontrol-t127563/CS/DevExpress.Example03/CheckableGroupBehavior.cs#L155

foreach(var item in this.AssociatedObject.ItemsSource as IEnumerable<object>) {
    int handle = this.AssociatedObject.FindRowByValue("", item);
    result.Add(handle);

VB.NET

how-to-create-checkable-grouping-in-gridcontrol-t127563/VB/DevExpress.Example03/CheckableGroupBehavior.vb#L170

For Each item In TryCast(Me.AssociatedObject.ItemsSource, IEnumerable(Of Object))
    Dim handle As Integer = Me.AssociatedObject.FindRowByValue("", item)
    result.Add(handle)