FilterBox Class

Represents a Filter Box.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.dll

Declaration

C#

public class FilterBox :
    PropertiesBase,
    IPropertiesOwner

VB.NET

Public Class FilterBox
    Inherits PropertiesBase
    Implements IPropertiesOwner

Related API Members

The following members return FilterBox objects:

• ASPxTitleIndex.FilterBox

Remarks

The ASPxTitleIndex control allows its data to be quickly filtered on the client side, based upon initial characters entered, which serve as a filter criterion. The filtering functionality is implemented via the FilterBox.

The Filter Box contains an editor that allows the desired filter string to be entered, and a label that displays specific explanatory information regarding the available wildcard symbols. Filtering is performed dynamically on the client side, after the text is changed within the Filter Box’s editor (incremental filtering). The FilterBox.Delay property specifies a delay (in milliseconds) between the time the user starts typing within the editor and filtering being applied. Information about wildcard symbols is displayed below the editor, and can be changed by using the FilterBox.InfoText property. The filter box’s caption, displayed to the editor’s left, can be specified using the FilterBox.Caption property.

The filter box’s visibility is specified by the FilterBox.Visible property. Its horizontal and vertical position within the ASPxTitleIndex control is specified by the FilterBox.HorizontalPosition and FilterBox.VerticalPosition properties, respectively.

To access the filter box’s settings, use the ASPxTitleIndex.FilterBox property.

Implements

IStateManager

IPropertiesOwner

Inheritance

Object

StateManager

PropertiesBase

FilterBox