ColumnView.LocateByValue(String, Object, OperationCompleted[]) Method

Locates rows by cell values.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

public int LocateByValue(
    string fieldName,
    object val,
    params OperationCompleted[] completed
)

VB.NET

Public Function LocateByValue(
    fieldName As String,
    val As Object,
    ParamArray completed As OperationCompleted()
) As Integer

Parameters

Name	Type	Description
fieldName	String	A string that specifies the target column’s field name.
val	Object	An object that is the value to search for.
completed	DevExpress.Data.OperationCompleted[]	A DevExpress.Data.OperationCompleted method that will be called when the requested operation is completed. The method’s argument will contain the requested value. This parameter is optional and is only required in Instant Feedback Mode.

Returns

Type	Description
Int32	If the specified value is loaded, the method returns an integer value specifying the handle of the row found. In Instant Feedback Mode, the DevExpress.Data.DataController.OperationInProgress value is returned if the requested search value is not currently loaded. The GridControl.InvalidRowHandle value, if no row is found that matches the specified condition.

Remarks

The LocateByValue method performs a search from the top row. The method calls another LocateByValue overload with four parameters. See its description, to learn more about data searching.

Example

This example shows how to use the LocateByValue method to search for a row in Instant Feedback Mode mode.

C#

using DevExpress.XtraGrid.Views.Grid;

private void locateRowButton_Click(object sender, EventArgs e) {
    int rowHandle = gridView1.LocateByValue("Oid", 53498, OnRowSearchComplete);
    if (rowHandle != DevExpress.Data.DataController.OperationInProgress)
        FocusRow(gridView1, rowHandle);
}

void OnRowSearchComplete(object rh) {
    int rowHandle = (int)rh;
    if (gridView1.IsValidRowHandle(rowHandle))
        FocusRow(gridView1, rowHandle); 
}

public void FocusRow(GridView view, int rowHandle) {
    view.FocusedRowHandle = rowHandle;
}

VB.NET

Imports DevExpress.XtraGrid.Views.Grid

Private Sub locateRowButton_Click(sender As Object, e As EventArgs) Handles locateRowButton.Click
    Dim rowHandle As Integer = gridView1.LocateByValue("Oid", 35265, AddressOf OnRowSearchComplete)
    If Not (rowHandle = DevExpress.Data.DataController.OperationInProgress) Then
        FocusRow(gridView1, rowHandle)
    End If
End Sub

Private Sub OnRowSearchComplete(rh As Object)
    Dim rowHandle As Integer = CInt(rh)
    If gridView1.IsValidRowHandle(rowHandle) Then
        FocusRow(gridView1, rowHandle)
    End If
End Sub

Public Sub FocusRow(view As GridView, rowHandle As Integer)
    view.FocusedRowHandle = rowHandle
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LocateByValue(String, Object, OperationCompleted[]) 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#

winforms-grid-split-presentation/CS/Form1.cs#L39

// Locate a row containing a specific value.
view.FocusedRowHandle = view.LocateByValue("Country", "UK");

VB.NET

winforms-grid-split-presentation/VB/Form1.vb#L41

' Locate a row containing a specific value.
view.FocusedRowHandle = view.LocateByValue("Country", "UK")