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

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

Remarks

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.

Note

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.

Related GitHub Examples

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

Note

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.

C#

xaf-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/CS/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.cs#L207

_button.Click += button_Click;
_button.EnableClientSideAPI = true;
_button.ID = "B";

XAF_how-to-add-a-button-to-a-form-using-custom-view-item-t137443/CS/MySolution.Module.Web/ButtonDetailViewItemWeb.cs#L16

button.Text = "Click me!";
button.EnableClientSideAPI = true;
button.Click += new EventHandler(button_Click);

VB.NET

xaf-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/VB/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.vb#L222

AddHandler _button.Click, AddressOf button_Click
_button.EnableClientSideAPI = True
_button.ID = "B"

XAF_how-to-add-a-button-to-a-form-using-custom-view-item-t137443/VB/MySolution.Module.Web/ButtonDetailViewItemWeb.vb#L23

button.Text = "Click me!"
button.EnableClientSideAPI = True
AddHandler button.Click, AddressOf button_Click