SetCrossFieldRecordFilters Method

Sets a CrossFieldRecordFilterGroup containing a logical operator and a collection of filters for the specified FieldLayout.

Syntax

Visual Basic

'Declaration
 
Public Function SetCrossFieldRecordFilters( _
   ByVal fieldLayout As FieldLayout, _
   ByVal filters As CrossFieldRecordFilterGroup, _
   Optional ByVal addToUndo As Boolean _
) As Boolean

C#

public bool SetCrossFieldRecordFilters( 
   FieldLayout fieldLayout,
   CrossFieldRecordFilterGroup filters,
   bool addToUndo
)

Parameters

fieldLayout

The fieldLayout relating to the filters

filters

The new filter group.

addToUndo

If true, the filters will be added to the undo history but only if DataPresenterBase.IsUndoEnabled is also set to true.

Return Value

True is successful or false if canceled.

Exceptions

Exception	Description
System.ArgumentNullException	If fieldLayout is null.
System.InvalidOperationException	If fieldLayout and filters aren't compatible.

Remarks

If the FieldLayoutSettings.RecordFilterScope is set to 'SiblingDataRecords' this method will apply the filters this RecordManager's records. Otherwise it will set the FieldLayout's CrossFieldRecordFilters property so the filters will apply across all records associated with the FieldLayout.

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

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