AllowRecordFiltering Property (FieldSettings)

Enables the record filtering user interface. Default is resolved to False.

Syntax

Visual Basic

'Declaration
 
Public Property AllowRecordFiltering As Nullable(Of Boolean)

C#

public Nullable<bool> AllowRecordFiltering {get; set;}

Remarks

AllowRecordFiltering property enables the record filtering user interface where the user can specify filter criteria to filter records. Records that do not match the specified filter criteria will hidden (this is default behavior which can be changed by setting the FilterAction property), and thus presenting the user with the view of only the data that matches the filter criteria.

FilterUIType property specifies the type of user interface that the data presenter will use to let the user filter records.

To actually specify filter conditions in code to pre-filter the records, use the FieldLayout's RecordFilters or the RecordManager's RecordManager.RecordFilters depending on the RecordFilterScope property setting. By default FieldLayout's RecordFilters are used.

To check if a data record is filtered out, use the record's DataRecord.IsFilteredOut property. GroupByRecord also exposes GroupByRecord.IsFilteredOut property, which returns true if all of its descendant data records are filtered out.

Note: In filter record if a field's AllowRecordFiltering is set to false, the filter cell will be disabled. However it will display the current filter criteria if any.

Example

The following code snipet enables record filtering functionality.

Visual Basic

Imports Infragistics.Windows
Imports Infragistics.Windows.Editors
Imports Infragistics.Windows.DataPresenter

    Private Sub Window1_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
        
        ' Set AllowRecordFiltering to enable record filter UI.
        _dp.FieldSettings.AllowRecordFiltering = True

        ' Use FilterUIType to specify what type of UI to use: Filter icons 
        ' in the field labels or the filter-record.
        _dp.FieldLayoutSettings.FilterUIType = FilterUIType.FilterRecord

        ' If using filter-record, use FilterRecordLocation to control the location of
        ' the filter record.
        _dp.FieldLayoutSettings.FilterRecordLocation = FilterRecordLocation.OnTopFixed

    End Sub

C#

using Infragistics.Windows;
using Infragistics.Windows.Editors;
using Infragistics.Windows.DataPresenter;

		public void Window1_Loaded( object sender, RoutedEventArgs e )
		{
			// Set AllowRecordFiltering to enable record filter UI.
			_dp.FieldSettings.AllowRecordFiltering = true;

			// Use FilterUIType to specify what type of UI to use: Filter icons 
			// in the field labels or the filter-record.
			_dp.FieldLayoutSettings.FilterUIType = FilterUIType.FilterRecord;

			// If using filter-record, use FilterRecordLocation to control the location of
			// the filter record.
			_dp.FieldLayoutSettings.FilterRecordLocation = FilterRecordLocation.OnTopFixed;
		}

XAML

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

            <igDP:XamDataGrid.FieldSettings>
                <igDP:FieldSettings
                    AllowRecordFiltering="true"    
                />
            </igDP:XamDataGrid.FieldSettings>
            
            <igDP:XamDataGrid.FieldLayoutSettings>
                <igDP:FieldLayoutSettings
                    FilterUIType="FilterRecord"
                    FilterRecordLocation="OnTopFixed"
                />
            </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