ASPxClientRibbon Members

Represents the client-side equivalent of the ASPxRibbon control.

Properties

Name Description
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

Name Description
AdjustControl Modifies the control's size against the control's container. Inherited from ASPxClientControl.
AdjustControls static Modifies the controls size within the specified container. Inherited from ASPxClientControl.
Cast(obj) static Converts the specified object to the ASPxClientRibbon type.
GetActiveTab Returns the active tab within the ribbon control.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection static Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetEnabled Returns a value indicating whether the ribbon is enabled.
GetHeight Returns the control's height. Inherited from ASPxClientControl.
GetItemByName(name) Returns a ribbon item specified by its name.
GetItemValueByName(name) Returns a value of item with the specified name.
GetMainElement Returns an HTML element that is the root of the control's hierarchy. Inherited from ASPxClientControlBase.
GetMinimized Gets a value specifying whether the ribbon is minimized.
GetParentControl Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetTab(index) Returns a tab specified by its index.
GetTabByName(name) Returns a tab specified by its name.
GetTabCount Returns the number of tabs in the ribbon ASPxRibbon.Tabs collection.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth Returns the control's width. Inherited from ASPxClientControl.
InCallback Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetActiveTab(tab) Makes the specified tab active in the ribbon control on the client side.
SetActiveTabIndex(index) Makes a tab active within the ribbon control, specifying the tab's index.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetContextTabCategoryVisible(categoryName, visible) Specifies the visibility of a context tab category specified by its name.
SetEnabled(enabled) Specifies whether the ribbon control is enabled.
SetHeight(height) Specifies the control's height. Note that this method is not in effect for some controls. Inherited from ASPxClientControl.
SetItemValueByName(name, value) Sets the value of the item with the specified name.
SetMinimized(minimized) Specifies whether the ribbon is minimized.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control's width in pixels. Inherited from ASPxClientControl.
ShowKeyTips Shows ribbon key tips.

Events

Name Description
ActiveTabChanged Fires on the client side after the active tab has been changed within a ribbon control.
CommandExecuted Occurs after an end-user executes an action on a ribbon item.
DialogBoxLauncherClicked Fires on the client side after a dialog box launcher has been clicked.
FileTabClicked Occurs when the file tab is clicked.
Init Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
KeyTipsClosedOnEscape Fires after key tips are closed by pressing Esc.
MinimizationStateChanged Occurs on the client side when the ribbon minimization state is changed by end-user actions.
See Also