Tab
A newer version of this page is available. Switch to the current version.

ASPxTitleIndex Class

Represents an ASPxTitleIndex server control.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

public class ASPxTitleIndex :
    ASPxDataWebControl,
    IRequiresLoadPostDataControl,
    IControlDesigner
Public Class ASPxTitleIndex
    Inherits ASPxDataWebControl
    Implements IRequiresLoadPostDataControl,
               IControlDesigner

The following members accept/return ASPxTitleIndex objects:

Remarks

The ASPxTitleIndex class represents a server control that displays its data as a sorted and grouped list of data items (titles or links).

The data that is displayed within the ASPxTitleIndex control can be either contained within the control itself (unbound mode) or obtained from a non-hierarchical data source (bound mode).

The ASPxTitleIndex control allows its data items to be indexed and easily navigated via a specific index panel. The index panel's settings can be customized via the ASPxTitleIndex.IndexPanel property. So, the index panel's visibility and position are specified via the IndexPanel.Visible and IndexPanel.Position properties. The IndexPanel.Behavior property controls how the ASPxTitleIndex control responds to clicks on items displayed within the index panel. By default, the index panel's items are represented by the first characters of the automatically parsed data item titles (caption texts). In order to add the custom index characters to the index panel, or organize the index panel items in the desired manner (for example insert line feeds at arbitrary positions), the IndexPanel.Characters property can be used. If grouping by specific values is applied within the ASPxTitleIndex control (via the ASPxTitleIndex.GroupingField or TitleIndexItem.GroupValue property), these grouping values are displayed as the index panel's items, and used to group the control's data.

The ASPxTitleIndex control can display a specific filter box element, which allows data items to be easily located by typing the initial part of the caption into the filter box's editor. Different settings of the filter box can be customized by using the ASPxTitleIndex.FilterBox property.