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

ASPxClientRibbon.SetEnabled(enabled) Method

Specifies whether the ribbon control is enabled.

Declaration

SetEnabled(enabled: boolean): void

Parameters

Name Type Description
enabled boolean

true to enable the ribbon; false to disable it.

Remarks

Use the SetEnabled method on the client to dynamically switch the ribbon's capability to respond to end-user interactions (such as mouse hovering or clicks). The initial client availability state of a ribbon can be defined using its server ASPxRibbon.ClientEnabled property. In order to determine the availability of the ribbon, use the ASPxClientRibbon.GetEnabled method on the client side.

Note that the SetEnabled method result is not sent to the server side when a request is performed. This means that the disabled/enabled state is not synchronized with the server-side object. If you want to synchronize disabled/enabled states between the client and server sides, you can use the ASPxHiddenField control containing the disabled/enabled state, and restore it on the server side.

Note

The SetEnabled method is not in effect if a ribbon is initially disabled on the server by setting the Enabled property to false.

See Also