IsFilteredOut Property (DataRecord)

Indicates whether the record is filtered out. Returns true if the record fails to meet filter criteria.

Syntax

Visual Basic

'Declaration
 
Public ReadOnly Property IsFilteredOut As Nullable(Of Boolean)

C#

public Nullable<bool> IsFilteredOut {get;}

Property Value

True if the record fails to meet the current effective record filters or false if it does not. However, if there are no active record filters then this property returns null

Remarks

IsFilteredOut property indicates whether the record is filtered out. If the record fails to meet the current effective record filters, this property returns True. Otherwise it returns False. However, if there are no active record filters then this property returns null.

Current effective record filters are either RecordManager's RecordManager.RecordFilters or the FieldLayout�s FieldLayout.RecordFilters depending on whether the FilterLayoutSettings� FieldLayoutSettings.RecordFilterScope property is set to SiblingDataRecords or AllRecords respectively. SiblingDataRecords is the default.

Note: To enable the record filtering user interface, set the FieldSettings.AllowRecordFiltering and FieldLayoutSettings.FilterUIType properties.

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