DocumentList.FilterIndex Property

Article
12/12/2007

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
'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);
}

/** @property */
public int get_FilterIndex ()

/** @property */
public void set_FilterIndex (int value)

public function get FilterIndex () : int

public function set FilterIndex (value : int)

Not applicable.

Property Value

The current filter index. The default is zero.

Exceptions

Exception type	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.

Example

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;

Platforms

Windows Mobile for Pocket PC

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Compact Framework

Supported in: 2.0

Share via