FilterClearButtonLocation Property

Specifies if and where to display the filter clear button. Default is resolved to RecordSelectorAndFilterCell.

Syntax

Visual Basic

'Declaration
 
Public Property FilterClearButtonLocation As FilterClearButtonLocation

C#

public FilterClearButtonLocation FilterClearButtonLocation {get; set;}

Remarks

FilterClearButtonLocation property specifies if and where to display the filter clear button. By default a filter clear button is displayed in the filter record's record selector and each filter cell. It lets the user clear filter criteria.

You can control the visibility of the filter clear button on a per field basis using the FieldSettings' FieldSettings.FilterClearButtonVisibility property.

To manipulate filters, including clear any filters, use the RecordFilterCollection.

Example

The following code snippet sets FilterClearButtonLocation to RecordSelectorAndFilterCell and FilterClearButtonVisibility of 'Country' field to Collapsed. This will result in all fields displaying filter clear button in their filter cells except the 'Country' field.

Visual Basic

Imports Infragistics.Windows
Imports Infragistics.Windows.Controls
Imports Infragistics.Windows.Editors
Imports Infragistics.Windows.DataPresenter
Imports Infragistics.Windows.DataPresenter.Events

    Private Sub Window1_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
        
        ' Enable the record filtering functionality.
        _dp.FieldSettings.AllowRecordFiltering = True

        ' You can use FilterClearButtonLocation to specify whether to display filter clear
        ' button in record selector and/or cells. Note that the filter clear button is 
        ' displayed only if there are active filters. Therefore you must select some filter
        ' criteria in the filter cell to display the filter clear button.
        _dp.FieldLayoutSettings.FilterClearButtonLocation = FilterClearButtonLocation.RecordSelectorAndFilterCell

        ' You can use the FieldSettings' FilterClearButtonVisibility to override filter 
        ' clear button visibility on a specific field, in this case the 'Country' field.
        _dp.FieldLayouts(0).Fields("Country").Settings.FilterClearButtonVisibility = Visibility.Collapsed

    End Sub

C#

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

		public void Window1_Loaded( object sender, RoutedEventArgs e )
		{
			// Enable the record filtering functionality.
			_dp.FieldSettings.AllowRecordFiltering = true;

			// You can use FilterClearButtonLocation to specify whether to display filter clear
			// button in record selector and/or cells. Note that the filter clear button is 
			// displayed only if there are active filters. Therefore you must select some filter
			// criteria in the filter cell to display the filter clear button.
			_dp.FieldLayoutSettings.FilterClearButtonLocation = FilterClearButtonLocation.RecordSelectorAndFilterCell;

			// You can use the FieldSettings' FilterClearButtonVisibility to override filter 
			// clear button visibility on a specific field, in this case the 'Country' field.
			_dp.FieldLayouts[0].Fields["Country"].Settings.FilterClearButtonVisibility = Visibility.Collapsed;
		}

XAML

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

            <igDP:XamDataGrid.FieldSettings>
                <!--Enable the record filtering functionality.-->
                <igDP:FieldSettings
                    AllowRecordFiltering="true"
                />
            </igDP:XamDataGrid.FieldSettings>
            
            <igDP:XamDataGrid.FieldLayoutSettings>
                <!-- You can use FilterClearButtonLocation to specify whether to display filter clear
         button in record selector and/or cells. Note that the filter clear button is 
         displayed only if there are active filters. Therefore you must select some filter
         criteria in the filter cell to display the filter clear button.-->
                <igDP:FieldLayoutSettings
                    FilterClearButtonLocation="RecordSelectorAndFilterCell"
                />
            </igDP:XamDataGrid.FieldLayoutSettings>
            
            <igDP:XamDataGrid.FieldLayouts>
                
                <igDP:FieldLayout>
                    <igDP:FieldLayout.Fields>
                        <igDP:Field Name="ID" />

                        <!-- You can use the FieldSettings' FilterClearButtonVisibility to override filter 
                             clear button visibility on a specific field, in this case the 'Country' field.-->
                        <igDP:Field Name="Country" >
                            <igDP:Field.Settings>
                                <igDP:FieldSettings FilterClearButtonVisibility="Collapsed" />
                            </igDP:Field.Settings>
                        </igDP:Field>
                        
                    </igDP:FieldLayout.Fields>
                </igDP:FieldLayout>
                
            </igDP:XamDataGrid.FieldLayouts>
            
        </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