Skip to main content

ASPxButton.EnableClientSideAPI Property

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

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web


public bool EnableClientSideAPI { get; set; }

Property Value

Type Default Description
Boolean false

true if the button’s client object model is fully available; false if no programmatic interface is available for the button on the client side.


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

The ASPxButton 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.


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

The following code snippets (auto-collected from DevExpress Examples) contain references to the EnableClientSideAPI property.


The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also