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

ASPxClientRibbon.SetActiveTabIndex(index) Method

Makes a tab active within the ribbon control, specifying the tab's index.

Declaration

SetActiveTabIndex(index: number): void

Parameters

Name Type Description
index number

An integer value specifying the index of the tab to select.

Remarks

End users are allowed to select tabs via mouse clicks. The ribbon control also provides the capability to select tabs on the client side via code. You can use the SetActiveTabIndex method to activate a tab by its index.

Note that a ribbon control always has the active tab, and only one tab can be active within the control at the same time. So, the SetActiveTabIndex method is in effect if it's passed a correct tab index between 0 and theASPxClientRibbon.GetTabCount value, decremented by one.

To get the active tab on the client side, use the ASPxClientRibbon.GetActiveTab method.

See Also