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
  [Expand]DevExpress.Web.ASPxGauges
  [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
  [Collapse]DevExpress.Web.ASPxSpreadsheet
   [Collapse]ASPxSpreadsheet Class
     ASPxSpreadsheet Members
     ASPxSpreadsheet Constructor
    [Collapse]ASPxSpreadsheet Properties
      ActiveTabIndex Property
      AssociatedRibbonID Property
      AutoSaveMode Property
      AutoSaveTimeout Property
      ClientInstanceName Property
      ClientSideEvents Property
      ConfirmOnLosingChanges Property
      Document Property
      DocumentId Property
      EnableClientSideAPI Property
      Enabled Property
      FullscreenMode Property
      Images Property
      ImagesFileManager Property
      RaiseEventsOnModificationsViaAPI Property
      ReadOnly Property
      RibbonContextTabCategories Property
      RibbonKeyboardSupport Property
      RibbonMode Property
      RibbonTabs Property
      SettingsDialogForm Property
      SettingsDialogs Property
      SettingsDocumentSelector Property
      SettingsForms Property
      SettingsLoadingPanel Property
      ShowConfirmOnLosingChanges Property
      ShowFormulaBar Property
      ShowSheetTabs Property
      Styles Property
      StylesButton Property
      StylesEditors Property
      StylesFileManager Property
      StylesFormulaAutoCompete Property
      StylesFormulaBar Property
      StylesPopupMenu Property
      StylesRibbon Property
      StylesTabControl Property
      TemporaryFolder Property
      WorkDirectory Property
      WorksheetDisplayArea Property
    [Expand]ASPxSpreadsheet Events
    [Expand]ASPxSpreadsheet Methods
   [Expand]ASPxSpreadsheetLoadingPanelSettings Class
   [Expand]ASPxSpreadsheetSettingsBase Class
    InitializeDocumentEventHandler Delegate
    SaveFileDialogDisplaySectionMode Enumeration
   [Expand]SpreadsheetClientSideEvents Class
   [Expand]SpreadsheetDialogFormSettings Class
   [Expand]SpreadsheetDialogSettings Class
   [Expand]SpreadsheetDocumentSelectorCommonSettings Class
   [Expand]SpreadsheetDocumentSelectorSettings Class
   [Expand]SpreadsheetFileManagerCommonSettings Class
   [Expand]SpreadsheetFileManagerEditingSettings Class
   [Expand]SpreadsheetFileManagerFoldersSettings Class
   [Expand]SpreadsheetFileManagerUploadSettings Class
   [Expand]SpreadsheetFileManagerValidationSettings Class
   [Expand]SpreadsheetFormsSettings Class
   [Expand]SpreadsheetFormulaAutoCompeteStyles Class
   [Expand]SpreadsheetFormulaBarButtonImageProperties Class
   [Expand]SpreadsheetFormulaBarButtonSectionStyles Class
   [Expand]SpreadsheetFormulaBarStyles Class
   [Expand]SpreadsheetImages Class
   [Expand]SpreadsheetInitializeDocumentEventArgs Class
   [Expand]SpreadsheetInsertLinkDialogSettings Class
   [Expand]SpreadsheetInsertPictureDialogSettings Class
   [Expand]SpreadsheetRibbonContextTabCategoryCollection Class
    SpreadsheetRibbonMode Enumeration
   [Expand]SpreadsheetRibbonTabCollection Class
   [Expand]SpreadsheetSaveFileDialogSettings Class
   [Expand]WorksheetDisplayArea Class
  [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

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.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 ASPxSpreadsheet on the client side.
The default is false.

Expanded 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 ClientInstanceName property is defined or any client event is handled.

Expanded See Also

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