VGridControl.CustomRecordFilter Event

Allows you to hide a record regardless of the applied filter.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid

Declaration

C#

public event CustomRecordFilterEventHandler CustomRecordFilter

VB.NET

Public Event CustomRecordFilter As CustomRecordFilterEventHandler

Event Data

The CustomRecordFilter event's data class is DevExpress.XtraVerticalGrid.Events.CustomRecordFilterEventArgs.

Remarks

The CustomRecordFilter event fires when a new filter is applied. The event allows you to hide a record regardless of the applied filter.

Read the RecordIndex event parameter to get the processed record’s zero-based index in the underlying data source. The IsFitDefaultFilter parameter returns whether the record fits the applied filter. Set the Handled parameter to true to hide the record.

The code snippet below shows how to hide all records where City row contains Berlin.

C#

private void vGridControl1_CustomRecordFilter(object sender, DevExpress.XtraVerticalGrid.Events.CustomRecordFilterEventArgs e) {
    DevExpress.XtraVerticalGrid.VGridControl grid = sender as DevExpress.XtraVerticalGrid.VGridControl;
    if (sender == null) return;
    DataRowView dataRowView = grid.GetRecordObject(e.RecordIndex) as DataRowView;
    if (dataRowView == null) return;
    if (dataRowView.Row["City"] as String == "Berlin") e.Handled = true;         
}

VB.NET

Private Sub vGridControl1_CustomRecordFilter(sender As Object, e As DevExpress.XtraVerticalGrid.Events.CustomRecordFilterEventArgs)
    Dim grid As DevExpress.XtraVerticalGrid.VGridControl = TryCast(sender, DevExpress.XtraVerticalGrid.VGridControl)
    If sender Is Nothing Then
        Return
    End If
    Dim dataRowView As DataRowView = TryCast(grid.GetRecordObject(e.RecordIndex), DataRowView)
    If dataRowView Is Nothing Then
        Return
    End If
    If TryCast(dataRowView.Row("City"), [String]) = "Berlin" Then
        e.Handled = True
    End If
End Sub