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

RichEditSettings.EnableClientSideAPI Property

Gets or sets a value that specifies whether the RichEdit can be manipulated on the client side in code.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v18.2.dll


public bool EnableClientSideAPI { get; set; }
Public Property EnableClientSideAPI As Boolean

Property Value

Type Description

true, if the control's client object model is fully available; false, if no programmatic interface is available for the RichEdit on the client side.


The EnableClientSideAPI property controls the availability of the client-side API for a RichEdit extension.

The RichEdit implements a comprehensive JavaScript client-side object model (client API), allowing you to programmatically manipulate the extension on the client.

If you want to use the RichEdit's client-side API in your application, set the EnableClientSideAPI property to true to ensure that the client API is available on the client side.


Regardless of the EnableClientSideAPI property setting, the client-side API is automatically enabled if any client event (RichEditSettings.ClientSideEvents) is handled.

See Also