FieldChooserOpening Event

Raised before the data presenter displays a FieldChooser.

Syntax

Visual Basic

'Declaration
 
Public Event FieldChooserOpening As EventHandler(Of FieldChooserOpeningEventArgs)

C#

public event EventHandler<FieldChooserOpeningEventArgs> FieldChooserOpening

Event Data

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

Property	Description
Cancel (Inherited from Infragistics.Windows.Controls.Events.CancelableRoutedEventArgs)
FieldChooser	The FieldChooser that the data presenter is about to display.
Handled (Inherited from System.Windows.RoutedEventArgs)	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
OriginalSource (Inherited from System.Windows.RoutedEventArgs)	Gets the original reporting source as determined by pure hit testing, before any possible System.Windows.RoutedEventArgs.Source adjustment by a parent class.
RoutedEvent (Inherited from System.Windows.RoutedEventArgs)	Gets or sets the System.Windows.RoutedEventArgs.RoutedEvent associated with this System.Windows.RoutedEventArgs instance.
Source (Inherited from System.Windows.RoutedEventArgs)	Gets or sets a reference to the object that raised the event.
ToolWindow	Gets the ToolWindow being used to display the FieldChooser.

Example

The following code snippet enables the field chooser button in the data presenter and sets some of the commonly used properties in the FieldChooserOpening event. When the field chooser button is clicked, the data presenter displays a field chooser and raises the FieldChooserOpening event which lets you set properties on the field chooser that's about to be displayed.

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_FieldChooserOpening(ByVal sender As Object, ByVal e As FieldChooserOpeningEventArgs)
        Dim fieldChooser As FieldChooser = e.FieldChooser

        ' If the data presenter is bound to a hierarchical data source, a combo editor
        ' is displayed in the field chooser that lets the user select the field-layout
        ' whose fields to be display in the field chooser. You can hide this combo
        ' by setting the FieldGroupSelectorVisibility property.
        fieldChooser.FieldGroupSelectorVisibility = Visibility.Collapsed

        ' By defaults all fields are displayed in the field chooser. If you only want 
        ' to display hidden fields in the field chooser, set DisplayHiddenFieldsOnly
        ' to true, which will as a result also remove the checkboxes next to items.
        fieldChooser.DisplayHiddenFieldsOnly = False

        ' By defaults fields are displayed in alphabetical order. You can also display
        ' the fields in the same order as they appear in the data presenter by setting
        ' the FieldDisplayOrder property to SameAsDataPresenter.
        fieldChooser.FieldDisplayOrder = FieldChooserDisplayOrder.Alphabetical
    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_FieldChooserOpening( object sender, FieldChooserOpeningEventArgs e )
		{
			FieldChooser fieldChooser = e.FieldChooser;

			// If the data presenter is bound to a hierarchical data source, a combo editor
			// is displayed in the field chooser that lets the user select the field-layout
			// whose fields to be display in the field chooser. You can hide this combo
			// by setting the FieldGroupSelectorVisibility property.
			fieldChooser.FieldGroupSelectorVisibility = Visibility.Collapsed;

			// By defaults all fields are displayed in the field chooser. If you only want 
			// to display hidden fields in the field chooser, set DisplayHiddenFieldsOnly
			// to true, which will as a result also remove the checkboxes next to items.
			fieldChooser.DisplayHiddenFieldsOnly = false;

			// By defaults fields are displayed in alphabetical order. You can also display
			// the fields in the same order as they appear in the data presenter by setting
			// the FieldDisplayOrder property to SameAsDataPresenter.
			fieldChooser.FieldDisplayOrder = FieldChooserDisplayOrder.Alphabetical;
		}

This XAML snippet sets the HeaderPrefixAreaDisplayMode property to enable field chooser button and hooks into the FieldChooserOpening event.

XAML

<igDP:XamDataGrid x:Name="_dp" FieldChooserOpening="dp_FieldChooserOpening" >
            <igDP:XamDataGrid.FieldLayoutSettings>
                <igDP:FieldLayoutSettings HeaderPrefixAreaDisplayMode="FieldChooserButton" />
            </igDP:XamDataGrid.FieldLayoutSettings>
</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