DocumentList.FilterIndex Property

Article
10/15/2009

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Gets or sets the current filter index.

Namespace: Microsoft.WindowsCE.Forms
Assembly: Microsoft.WindowsCE.Forms (in Microsoft.WindowsCE.Forms.dll)

Syntax

'Declaration
Public Property FilterIndex As Integer
    Get
    Set
'Usage
Dim instance As DocumentList
Dim value As Integer

value = instance.FilterIndex

instance.FilterIndex = value

public int FilterIndex { get; set; }

public:
property int FilterIndex {
    int get ();
    void set (int value);
}

member FilterIndex : int with get, set

Property Value

Type: System.Int32
The current filter index. The default is zero.

Exceptions

Exception	Condition
ArgumentException	The specified index value is not represented in the filter string.

Remarks

This property determines which filtering option is used to display the list of files. Use the Filter property to specify the filtering options.

Examples

The following code example sets the FilterIndex property. This code example is part of a larger example provided for the DocumentList class.

.FilterIndex = 0

DocList.FilterIndex = 0;

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0