Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

RecordFilters Property (RecordManager)

Specifies the filter criteria with which to filter recods.
Syntax
'Declaration
 
Public ReadOnly Property RecordFilters As RecordFilterCollection
public RecordFilterCollection RecordFilters {get;}
Remarks

RecordFilters property gets the record filters collection for this record manager. You can use this collection to specify filter criteria to filter data records. These filters will be applied to all data records associated with this record manager. Note that if the RecordFilterScope is set to AllRecords then the FieldLayout's RecordFilters will be used. For the root field layout, that's always the case. However for child field layouts, RecordFilterScope property determines whether the FieldLayout's RecordFilters get used or the RecordManager's RecordFilters get used. Since the root RecordManager's RecordFilterCollection never gets used, modifying it will raise an exception.

Also note that you can enable record filtering user interface by setting AllowRecordFiltering and FilterUIType properties. When the user modifies filter criteria, this collection will be updated to reflect the new criteria.

Note: if both CrossFieldRecordFilters and RecordFilters are specified, the CrossFieldRecordFilters will be applied first and then the RecordFilterswill be applied to any records that are not filtered out.

Example
The following sample code shows how you can specify record filters in code. It adds record filter criteria to root records and also child records, which is only applicable if you have hierarchical data source.

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

    Private Sub Window1_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
        
        Dim fieldLayout As FieldLayout = _dp.FieldLayouts(0)

        ' Create a new RecordFilter for 'Country' field.
        Dim filter As RecordFilter = New RecordFilter()
        filter.FieldName = "Country"
        filter.Conditions.Add(New ComparisonCondition(ComparisonOperator.Equals, "US"))

        ' Add the RecordFilter to field layout's RecordFilters collection.
        fieldLayout.RecordFilters.Add(filter)

        ' If you have hierarchical data source then you can also filter child records.
        ' Create a RecordFilter that filters the child records.
        filter = New RecordFilter()
        filter.FieldName = "Product"
        filter.Conditions.Add(New ComparisonCondition(ComparisonOperator.Equals, "A"))

        ' Now add the filter. For child field layouts, each individual parent
        ' record's child records can be filtered independently. That is one parent
        ' record's child records can have different filter criteria from another
        ' parent record's child records. This is the default mode of filtering. You
        ' can change it by setting RecordFilterScope property to AllRecords in which
        ' case all child records in the child field layout are affected by the
        ' filter. However depending on the mode, the place where you specify the
        ' filter criteria is different. For the default SiblingDataRecords mode, you
        ' need to specify the filter criteria on RecordFilters property of the child
        ' RecordManager of a parent record. For the AllRecords mode, use the child
        ' FieldLayout's RecordFilters property. Note that the root field layout
        ' doesn't support SiblingDataRecords mode since it doesn't have multiple
        ' record collections and therefore for the root field layout, always use the
        ' field layout's RecordFilters property.
        ' 
        Dim childDataRecordsManager As RecordManager = _dp.RecordManager.Unsorted(0).ChildRecords(0).ChildRecordManager
        Dim childFieldLayout As FieldLayout = _dp.FieldLayouts(1)
        childFieldLayout.Settings.RecordFilterScope = RecordFilterScope.AllRecords
        If RecordFilterScope.AllRecords = childFieldLayout.Settings.RecordFilterScope Then
            ' When using AllRecords mode, use the field layout's RecordFilters.
            childFieldLayout.RecordFilters.Add(filter)
        Else
            ' When using SiblingDataRecords, use the child RecordManager's RecordFilters.
            childDataRecordsManager.RecordFilters.Add(filter)
        End If

    End Sub
using Infragistics.Windows;
using Infragistics.Windows.Controls;
using Infragistics.Windows.Editors;
using Infragistics.Windows.DataPresenter;

		public void Window1_Loaded( object sender, RoutedEventArgs e )
		{
			FieldLayout fieldLayout = _dp.FieldLayouts[0];

			// Create a new RecordFilter for 'Country' field.
			RecordFilter filter = new RecordFilter( );
			filter.FieldName = "Country";
			filter.Conditions.Add( new ComparisonCondition( ComparisonOperator.Equals, "US" ) );

			// Add the RecordFilter to field layout's RecordFilters collection.
			fieldLayout.RecordFilters.Add( filter );

			// If you have hierarchical data source then you can also filter child records.
			// Create a RecordFilter that filters the child records.
			filter = new RecordFilter( );
			filter.FieldName = "Product";
			filter.Conditions.Add( new ComparisonCondition( ComparisonOperator.Equals, "A" ) );

			// Now add the filter. For child field layouts, each individual parent
			// record's child records can be filtered independently. That is one parent
			// record's child records can have different filter criteria from another
			// parent record's child records. This is the default mode of filtering. You
			// can change it by setting RecordFilterScope property to AllRecords in which
			// case all child records in the child field layout are affected by the
			// filter. However depending on the mode, the place where you specify the
			// filter criteria is different. For the default SiblingDataRecords mode, you
			// need to specify the filter criteria on RecordFilters property of the child
			// RecordManager of a parent record. For the AllRecords mode, use the child
			// FieldLayout's RecordFilters property. Note that the root field layout
			// doesn't support SiblingDataRecords mode since it doesn't have multiple
			// record collections and therefore for the root field layout, always use the
			// field layout's RecordFilters property.
			// 
			RecordManager childDataRecordsManager = _dp.RecordManager.Unsorted[0].ChildRecords[0].ChildRecordManager; 
			FieldLayout childFieldLayout = _dp.FieldLayouts[1];
			childFieldLayout.Settings.RecordFilterScope = RecordFilterScope.AllRecords;
			if ( RecordFilterScope.AllRecords == childFieldLayout.Settings.RecordFilterScope )
			{
				// When using AllRecords mode, use the field layout's RecordFilters.
				childFieldLayout.RecordFilters.Add( filter );
			}
			else
			{
				// When using SiblingDataRecords, use the child RecordManager's RecordFilters.
				childDataRecordsManager.RecordFilters.Add( filter );
			}
		}
        <igDP:XamDataGrid x:Name="_dp" HorizontalAlignment="Stretch" VerticalAlignment="Stretch" >

            <igDP:XamDataGrid.FieldLayouts>
                
                <!--Set filter on root field layout-->
                <igDP:FieldLayout IsDefault="true">
                    <igDP:FieldLayout.Fields>
                        <igDP:Field Name="ID" />
                        <igDP:Field Name="Country" />
                    </igDP:FieldLayout.Fields>
                    
                    <!--Set filter where records with Country=US will be displayed-->
                    <igDP:FieldLayout.RecordFilters>
                        <igDP:RecordFilter FieldName="Country">
                            <igWindows:ComparisonCondition Operator="Equals" Value="US" />
                        </igDP:RecordFilter>
                    </igDP:FieldLayout.RecordFilters>
                    
                </igDP:FieldLayout>

                <!--Set filter on a child field layout. Only applicable if you have hierarchical data source.-->
                <igDP:FieldLayout>
                    <igDP:FieldLayout.Fields>
                        <igDP:Field Name="ID" />
                        <igDP:Field Name="Product" />
                    </igDP:FieldLayout.Fields>

                    <!--For child field layouts, you need to set the RecordFilterScope to AllRecords in order to
                    specify filters on the FieldLayout's RecordFilters.-->
                    <igDP:FieldLayout.Settings>
                        <igDP:FieldLayoutSettings RecordFilterScope="AllRecords" />
                    </igDP:FieldLayout.Settings>

                    <!--Set filter where records with Product that starts with 'A' will be displayed.-->
                    <igDP:FieldLayout.RecordFilters>
                        <igDP:RecordFilter FieldName="Product">
                            <igWindows:ComparisonCondition Operator="StartsWith" Value="A" />
                        </igDP:RecordFilter>
                    </igDP:FieldLayout.RecordFilters>

                </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

See Also