EditPropertiesBase.EnableClientSideAPI Property

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

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(false)]
public bool EnableClientSideAPI { get; set; }

VB.NET

<DefaultValue(False)>
Public Property EnableClientSideAPI As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the editor’s client object model is fully available; false if no programmatic interface is available for the editor on the client side.

Remarks

The EnableClientSideAPI property controls the availability of the client-side API for an editor control.

An editor control implements a comprehensive JavaScript-written client-side object model (client API), allowing you to programmatically manipulate the control on the client.

If you want to use the control’s client-side API in your application, set the EnableClientSideAPI property to true, to make sure that the client API is available on the client side.

Note

Regardless of the EnableClientSideAPI property setting, the client-side API is automatically enabled if the EditPropertiesBase.ClientInstanceName (ASPxEditBase.ClientInstanceName) property is defined, or any client event exposed by the ClientSideEvents property is handled.

Note

The EnableClientSideAPI property synchronizes its value with the editor’s ASPxEditBase.EnableClientSideAPI property.