Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Collapse]DevExpress.Web.ASPxGauges
   [Collapse]ASPxGaugeControl Class
     ASPxGaugeControl Members
     ASPxGaugeControl Constructor
    [Collapse]ASPxGaugeControl Properties
      AlternateText Property
      AutoLayout Property
      BackgroundImage Property
      BinaryStorageMode Property
      Border Property
      BorderBottom Property
      BorderLeft Property
      BorderRight Property
      BorderTop Property
      ClientInstanceName Property
      ClientSideEvents Property
      ColorScheme Property
      CssClass Property
      CssFilePath Property
      CssPostfix Property
      Cursor Property
      DefaultValue Property
      DescriptionUrl Property
      DisabledStyle Property
      EnableCallbackAnimation Property
      EnableCallbackCompression Property
      EnableClientSideAPI Property
      EnableTheming Property
      EncodeHtml Property
      Font Property
      ForeColor Property
      Gauges Property
      GraphicsProperties Property
      Height Property
      ImageType Property
      IsPrintingAvailable Property
      Items Property
      JSProperties Property
      LayoutInterval Property
      LayoutPadding Property
      LoadingPanelDelay Property
      LoadingPanelImage Property
      LoadingPanelImagePosition Property
      LoadingPanelStyle Property
      LoadingPanelText Property
      SaveStateOnCallbacks Property
      SettingsLoadingPanel Property
      ShowLoadingPanel Property
      ShowLoadingPanelImage Property
      SizeEx Property
      SkinID Property
      TabIndex Property
      Value Property
      Width Property
    [Expand]ASPxGaugeControl Events
    [Expand]ASPxGaugeControl Methods
   [Expand]CustomCallbackClientSideEvents Class
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

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.v17.2.dll

Expanded Syntax

Property value

Type: Boolean
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.
The default is false.

Expanded 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 ClientSideEvents property).

Expanded See Also

How would you rate this topic?​​​​​​​