BeforeRowFilterDropDownPopulate Event

Occurs before the row filter drop down is populated.

Syntax

Visual Basic

'Declaration
 
Public Event BeforeRowFilterDropDownPopulate As BeforeRowFilterDropDownPopulateEventHandler

C#

public event BeforeRowFilterDropDownPopulateEventHandler BeforeRowFilterDropDownPopulate

Event Data

The event handler receives an argument of type BeforeRowFilterDropDownPopulateEventArgs containing data related to this event. The following BeforeRowFilterDropDownPopulateEventArgs properties provide information specific to this event.

Property	Description
Column	Column associated with the column header flter drop down button was clicked on.
Handled	Indicates whether the value list was populated and that UltraGrid should not attempt to pupulate the value list. Default value is false.
Rows	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.
ValueList	The value list that will be used as the filter drop down. You can populate the value list and set Handled to true to prevent the UltraGrid from populating the value list.

Remarks

You can use the BeforeRowFilterDropDownPopulate event to prevent the UltraGrid from populating the filter value list and instead populate it yourself. In the AfterRowFilterDropDownPopulate event, which is fired after this event, the filter value list is already populated. You can modify the filter value list there as well.

Example

Following code prevents the UltraGrid from populating the filter drop down with cell values by setting Handled to true in BeforeRowFilterDropDownPopulate event handler.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid


    Private Sub UltraGrid1_BeforeRowFilterDropDownPopulate(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.BeforeRowFilterDropDownPopulateEventArgs) Handles UltraGrid1.BeforeRowFilterDropDownPopulate
        ' Set the Handled to prevent UltraGrid from populating the value list.
        e.Handled = True

        ' Populate the value list with custom filter values.
        e.ValueList.ValueListItems.Add("Test", "Test")
    End Sub

C#

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


		private void ultraGrid1_BeforeRowFilterDropDownPopulate(object sender, Infragistics.Win.UltraWinGrid.BeforeRowFilterDropDownPopulateEventArgs e)
		{
			// Set the Handled to prevent UltraGrid from populating the value list.
			e.Handled = true;

			// Populate the value list with custom filter values.
			e.ValueList.ValueListItems.Add( "Test", "Test" );
		}

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