ASPxGaugeControl.EnableClientSideAPI Property

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

Namespace: DevExpress.Web.ASPxGauges

Assembly: DevExpress.Web.ASPxGauges.v24.2.dll

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 control on the client side.

Remarks

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

The ASPxGaugeControl can be programmatically manipulated on the client-side (via JavaScript code). The implementation of the public client object model that can be used programmatically is contained in a specific separate file (ASPxGaugeControl.js). The availability of this file on the client side is specified by the EnableClientSideAPI property. If the EnableClientSideAPI property is set to true, this file is sent to the client and so the public client-side API can be used to manipulate the control via JavaScript code on the client-side. Setting the EnableClientSideAPI property to false disables using the public client API but decreases the amount of data sent to the client improving the web application’s performance.

Note

Regardless of the EnableClientSideAPI property setting the service ASPxGaugeControl.js file will automatically be sent to the client to enable using the client-side API if any client-side event is handled within the ASPxGaugeControl (a handling JavaScript code or function name is assigned to the corresponding property available via the ASPxGaugeControl.ClientSideEvents property).