The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientRibbon.GetTab(index) Method

Returns a tab specified by its index.

Declaration

GetTab(index: number): ASPxClientRibbonTab

Parameters

Name Type Description
index number

An integer value specifying the zero-based index of the tab object to retrieve.

Returns

Type Description
ASPxClientRibbonTab

An ASPxClientRibbonTab object that is the tab located at the specified index within the control's ASPxRibbon.Tabs collection.

Remarks

The ribbon control's client-side functionality allows its tabs to be accessed programmatically on the client side. This method gets the client tab object specified by the its index within the ASPxRibbon.Tabs collection.

Note that the index parameter is zero-based and its largest available value is specified by the ASPxClientRibbon.GetTabCount value decremented by one. If an invalid index is passed via the parameter, the method returns null.

This method can be used together with the ASPxClientRibbon.GetTabCount method when iterating through the ribbon control's tab list.

See Also