[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
 [Collapse]ASP.NET MVC Extensions
  [Expand]Product Information
  [Expand]Getting Started
  [Collapse]Common Concepts
    Web Application Project Templates
    Insert Extension Wizard
    Data Binding
   [Expand]Applying Themes
    Client-Side API
    Declaring Server-Side Event Handlers
    Templates
    Using Callbacks
    Passing Values to a Controller Action through Callbacks
    Using Extensions in Razor Views
  [Expand]Grid View
  [Expand]Tree List
  [Expand]Card View
   Reporting
  [Expand]Charting
  [Expand]Pivot Grid
   Spreadsheet
   Rich Text Editor
  [Expand]Scheduler
  [Expand]Site Navigation and Layout
  [Expand]HTML Editor
  [Expand]Vertical Grid
  [Expand]Data Editors Extensions
  [Expand]Docking and Popups
  [Expand]File Management
  [Expand]Data and Image Navigation
  [Expand]Multi-Use Site Extensions
  [Expand]SpellChecker
  [Expand]Query Builder
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Client-Side API

DevExpress ASP.NET MVC extensions provide an advanced client-side API that enables you to combine server-side and client-side functionality.

The DevExpress MVC extensions provide client-side APIs that are implemented using JavaScript. Extension-relative assemblies (DLLs) include JavaScript files that implement an extension's client-side APIs as embedded resources.

Expanded Attach Scripts

You should attach script files that implement extensions’ client-side APIs to an application.

The DevExpress ASP.NET Project Wizard automatically attaches the JavaScript files to the application's Site.Master page if you use a DevExpress Project Template to create an MVC application. If you do not use a DevExpress project template, you need to manually attach necessary DevExpress client script files using the ExtensionsFactory.RenderScripts extension method within a view page's HEAD or BODY tag.

View (or Master Page) Code (ASPX):

View (or layout View) Code (Razor):

Expanded Extension's Available Client API

Set an extension's EnableClientSideAPI (or Properties.EnableClientSideAPI) property to true to make the extension's client-side API available for developers. If a DevExpress MVC Extension does not provide the EnableClientSideAPI property, its client-side API is always available for this extension on the client side.

Note that an extension's client-side API is automatically available if you handle any of its client-side events.

Expanded Access an Extension on the Client Side

Use the SettingsBase.Name property to specify an extension's name to access its client object.

View code (ASPX):

View code (Razor):

Note

Refer to the KA18687 KB article for information on how to access an extension's client object if the SettingsBase.Name property contains special characters (for example, the "." dot).

Expanded Client-Side Events

Each DevExpress ASP.NET MVC Extension provides a set of client-side events. Use the ClientSideEvents property at the level of the extension's settings (Settings.ClientSideEvents) or properties (Properties.ClientSideEvents) to access the available client-side events.

Note

Register JavaScript functions at the top of the page. In this case, the browser executes these scripts before it renders the DevExpress ASP.NET MVC extensions.

The following code demonstrates how to handle an extension's client-side events:

View code (ASPX):

View code (Razor):

See Also: DevExpress ASP.NET Controls Client-Side Events

Expanded Client-Side API

Tables below list DevExpress MVC Extensions and their client-side objects:

Grid Extensions

Extension Client Object
GridView MVCxClientGridView
PivotGrid MVCxClientPivotGrid
TreeList MVCxClientTreeList

Navigation Extensions

Extension Client Object
Menu ASPxClientMenu
NavBar MVCxClientNavBar
PageControl MVCxClientPageControl
PopupControl ASPxClientPopupControl
Splitter ASPxClientSplitter
TabControl ASPxClientTabControl
TreeView MVCxClientTreeView

Data Editors Extensions

Extension Client Object
BinaryImage ASPxClientBinaryImage
Button ASPxClientButton
ButtonEdit ASPxClientButtonEdit
Calendar MVCxClientCalendar
CheckBox ASPxClientCheckBox
CheckBoxList ASPxClientCheckBoxList
ColorEdit ASPxClientColorEdit
ComboBox MVCxClientComboBox
DateEdit ASPxClientDateEdit
DropDownEdit ASPxClientDropDownEdit
HyperLink ASPxClientHyperLink
Image ASPxClientImage
Label ASPxClientLabel
ListBox MVCxClientListBox
Memo ASPxClientMemo
ProgressBar ASPxClientProgressBar
RadioButton ASPxClientRadioButton
RadioButtonList ASPxClientRadioButtonList
SpinEdit ASPxClientSpinEdit
TextBox ASPxClientTextBox
TimeEdit ASPxClientTimeEdit
TokenBox MVCxClientTokenBox
TrackBar ASPxClientTrackBar

HTML Editor Extension

Extension Client Object
HtmlEditor MVCxClientHtmlEditor

Utilities Extensions

Extension Client Object
CallbackPanel MVCxClientCallbackPanel
RoundPanel ASPxClientRoundPanel
UploadControl MVCxClientUploadControl

Chart Extension

Extension Client Object
Chart MVCxClientChart

Scheduler Extension

Extension Client Object
SchedulerControl MVCxClientScheduler

Is this topic helpful?​​​​​​​