ASPxSpreadsheet.EnableClientSideAPI Property

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

Namespace: DevExpress.Web.ASPxSpreadsheet

Assembly: DevExpress.Web.ASPxSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Web.Office

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 control’s client object model is fully available; false if no programmatic interface is available for the ASPxSpreadsheet on the client side.

Remarks

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

An ASPxSpreadsheet control implements a comprehensive JavaScript 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 ensure 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 ASPxSpreadsheet.ClientInstanceName property is defined or any client event is handled.