Rows Property (BeforeRowFilterDropDownEventArgs)

If UltraGridOverride.RowFilterMode resolves to SiblingRowsOnly, then the RowsCollection associated with the column header that the filter dropdown button is clicked on will be passed in. Otherwise it will be null.

Syntax

Visual Basic

'Declaration
 
Public ReadOnly Property Rows As RowsCollection

C#

public RowsCollection Rows {get;}

Example

Following code shows some of the information available in BeforeRowFilterDropDown event.

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid
Imports System.Diagnostics

   Private Sub UltraGrid1_BeforeRowFilterDropDown(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.BeforeRowFilterDropDownEventArgs) Handles ultraGrid1.BeforeRowFilterDropDown

       ' You can modify the value list and remove or add items if you wanted to prevent cartain
       ' items from being displayed in the drop-down list of values by which to filter rows.
       'e.ValueList.ValueListItems.Remove( 0 );
       'e.ValueList.ValueListItems.Remove( 0 );

       Debug.WriteLine("BeforeRowFilterDropDown: Filtering rows with " & e.Column.Key & " column.")
       Debug.WriteLine("BeforeRowFilterDropDown: Filtering drop down has " & e.ValueList.ValueListItems.Count & " number of items in it.")

       ' Rows property will be null if the UltraGridOverride.RowFilterMode is set to AllRowsInBand.
       If Not Nothing Is e.Rows Then
           Debug.WriteLine("BeforeRowFilterDropDown: Rows collection being filtered has " & e.Rows.Count & " number of rows.")
       Else
           Debug.WriteLine("BeforeRowFilterDropDown: Rows property is null.")
       End If

       ' You can cancel the event to prevent the row filter drop-down from dropping down.			
       e.Cancel = True

   End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void ultraGrid1_BeforeRowFilterDropDown(object sender, Infragistics.Win.UltraWinGrid.BeforeRowFilterDropDownEventArgs e)
{	

	// You can modify the value list and remove or add items if you wanted to prevent cartain
	// items from being displayed in the drop-down list of values by which to filter rows.
	//e.ValueList.ValueListItems.Remove( 0 );
	//e.ValueList.ValueListItems.Remove( 0 );

	Debug.WriteLine( "BeforeRowFilterDropDown: Filtering rows with " + e.Column.Key + " column." );			
	Debug.WriteLine( "BeforeRowFilterDropDown: Filtering drop down has " + e.ValueList.ValueListItems.Count + " number of items in it.");

	// Rows property will be null if the UltraGridOverride.RowFilterMode is set to AllRowsInBand.
	if ( null != e.Rows )
	{
		Debug.WriteLine( "BeforeRowFilterDropDown: Rows collection being filtered has " + e.Rows.Count + " number of rows." );
	}
	else
	{
		Debug.WriteLine( "BeforeRowFilterDropDown: Rows property is null." );
	}

	// You can cancel the event to prevent the row filter drop-down from dropping down.			
	e.Cancel = true;

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2