Control Property (CustomFilterSelectionControlOpeningEventArgs)

Returns the control being displayed in the UI for selecting custom filter criteria for field(s) (read-only).

Syntax

Visual Basic

'Declaration
 
Public ReadOnly Property Control As CustomFilterSelectionControl

C#

public CustomFilterSelectionControl Control {get;}

Remarks

If the FilterType is Infragistics.Windows.DataPresenter.CustomFilterSelectionControlFilterType.SingleField then the Infragistics.Windows.DataPresenter.CustomFilterSelectionControl will add/edit filters for the single Infragistics.Windows.DataPresenter.Field associated with the RecordFilter. If the filter type is Infragistics.Windows.DataPresenter.CustomFilterSelectionControlFilterType.CrossField then the control will add/edit filters across one or more Infragistics.Windows.DataPresenter.Fields contained in the FieldLayout.

Example

The following code demonstrates usage of CustomFilterSelectionControlOpening event.

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.Windows
Imports Infragistics.Windows.Controls
Imports Infragistics.Windows.Editors
Imports Infragistics.Windows.DataPresenter
Imports Infragistics.Windows.DataPresenter.Events

    Private Sub Dp_CustomFilterSelectionControlOpening(ByVal sender As Object, ByVal e As CustomFilterSelectionControlOpeningEventArgs)
        ' RecordFilter returns the filter that is to be manipulated by the custom
        ' filter dialog.
        Dim filter As RecordFilter = e.RecordFilter

        ' You can get the field for which the custom filter dialog is opening by
        ' using the RecordFilter's Field property.
        Dim field As Field = filter.Field

        ' Control property returns the CustomFilterSelectionControl that will
        ' be displayed.
        Dim customFilterControl As CustomFilterSelectionControl = e.Control

        ' Print a message.
        Debug.WriteLine("Custom filter dialog is being displayed for field " & field.Name)

        ' You can set Cancel to true to prevent the data presenter from displaying
        ' the custom filter dialog.
        e.Cancel = True

        ' Setting Cancel to true lets you display display your own custom filter 
        ' dialog. All you need to do is update the e.RecordFilter with the conditions
        ' that the user selects from your custom dialog.
    End Sub

C#

using Infragistics.Windows;
using Infragistics.Windows.Controls;
using Infragistics.Windows.Editors;
using Infragistics.Windows.DataPresenter;
using Infragistics.Windows.DataPresenter.Events;

		private void dp_CustomFilterSelectionControlOpening( object sender, CustomFilterSelectionControlOpeningEventArgs e )
		{
			// RecordFilter returns the filter that is to be manipulated by the custom
			// filter dialog.
			RecordFilter filter = e.RecordFilter;

			// You can get the field for which the custom filter dialog is opening by
			// using the RecordFilter's Field property.
			Field field = filter.Field;

			// Control property returns the CustomFilterSelectionControl that will
			// be displayed.
			CustomFilterSelectionControl customFilterControl = e.Control;

			// Print a message.
			Debug.WriteLine( "Custom filter dialog is being displayed for field " + field.Name );

			// You can set Cancel to true to prevent the data presenter from displaying
			// the custom filter dialog.
			e.Cancel = true;

			// Setting Cancel to true lets you display display your own custom filter 
			// dialog. All you need to do is update the e.RecordFilter with the conditions
			// that the user selects from your custom dialog.
		}

XAML

        <igDP:XamDataGrid x:Name="_dp" HorizontalAlignment="Stretch" VerticalAlignment="Stretch"
                                            CustomFilterSelectionControlOpening="dp_CustomFilterSelectionControlOpening"
                                        >

            <igDP:XamDataGrid.FieldSettings>
                <!--Set AllowRecordFiltering to enable filter-record.-->
                <igDP:FieldSettings AllowRecordFiltering="true" />
            </igDP:XamDataGrid.FieldSettings>
            
        </igDP:XamDataGrid>

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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