GridView.IsFilterRow(Int32) Method

Indicates whether the specified row is the auto filter row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public bool IsFilterRow(
    int rowHandle
)

VB.NET

Public Function IsFilterRow(
    rowHandle As Integer
) As Boolean

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the tested row by its handle.

Returns

Type	Description
Boolean	true if the specified row is the auto filter row; otherwise, false.

Remarks

Refer to the Rows document for more information on row handles and the Filter and Search document for details on the filtering feature.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the IsFilterRow member must not be invoked for these Views. The IsFilterRow member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IsFilterRow(Int32) 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-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/CS/GridView_RowPreview/CustomGridView.cs#L294

{
    if (!View.OptionsView.ShowPreview || View.IsGroupRow(rowHandle) || View.IsFilterRow(rowHandle)) return 0;
    int res = (View.OptionsView.ShowPreviewRowLines != DevExpress.Utils.DefaultBoolean.False ? 1 : 0);

VB.NET

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/VB/GridView_RowPreview/CustomGridView.vb#L323

Protected Overridable Function CalcRowPreviewEditorHeight(ByVal rowHandle As Integer, ByVal item As RepositoryItem) As Integer
    If Not View.OptionsView.ShowPreview OrElse View.IsGroupRow(rowHandle) OrElse View.IsFilterRow(rowHandle) Then
        Return 0