ApplyFilter Method

Filters list items out based on whether they meet the filter criteria defined by the specified value.

Syntax

Visual Basic

'Declaration
 
Function ApplyFilter( _
   ByVal value As Object, _
   ByVal filterMode As AutoSuggestFilterMode _
) As Integer

C#

int ApplyFilter( 
   object value,
   AutoSuggestFilterMode filterMode
)

Parameters

value

The value which defines the filter criteria.

filterMode

The value which defines the filtering mode, i.e., whether a 'StartsWith' or 'Contains' condition is applied to filter the items.

Return Value

The number of items that exist in the filtered list. A return value of less than zero implies that no filtering was performed.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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