ASPxGridExportSettings.EnableClientSideExportAPI Property

Gets or sets a value specifying whether the client exporting API is enabled.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

[DefaultValue(false)]
public bool EnableClientSideExportAPI { get; set; }

VB.NET

<DefaultValue(False)>
Public Property EnableClientSideExportAPI As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, to enable client exporting API; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to EnableClientSideExportAPI
ASP.NET Bootstrap Controls	BootstrapCardView	.SettingsExport.EnableClientSideExportAPI
	BootstrapGridView	.SettingsExport.EnableClientSideExportAPI
ASP.NET Web Forms Controls	ASPxCardView	.SettingsExport.EnableClientSideExportAPI
	ASPxGridView	.SettingsExport.EnableClientSideExportAPI
	ASPxVerticalGrid	.SettingsExport.EnableClientSideExportAPI
	MVCxCardView	.SettingsExport.EnableClientSideExportAPI
	MVCxGridView	.SettingsExport.EnableClientSideExportAPI
	MVCxVerticalGrid	.SettingsExport.EnableClientSideExportAPI

Remarks

Exporting grid data using built-in toolbar/context menu commands and client-side API is disabled by default due to possible security issues. To enable such grid exporting functionality, set the EnableClientSideExportAPI property to true.

The following examples illustrate how to use the EnableClientSideExportAPI property.

ASPxGridView

Examples

• Export using built-in toolbar commands

  ASPX

  
  <dx:ASPxGridView ID="Grid" runat="server" KeyFieldName="ProductID" DataSourceID="ProductsDataSource" Width="100%"> 
  <SettingsExport EnableClientSideExportAPI="true"></SettingsExport>
      <Toolbars> 
      <dx:GridViewToolbar EnableAdaptivity="true"> 
              <Items> 
                  <dx:GridViewToolbarItem Command="ExportToXls" /> 
                  <dx:GridViewToolbarItem Command="ExportToXlsx" /> 
                  <dx:GridViewToolbarItem Command="ExportToCsv" /> 
              </Items> 
          </dx:GridViewToolbar> 
      </Toolbars> 
      <Columns> 
      ...
      </Columns> 
  </dx:ASPxGridView> 
  

• Export using context menu commands

  ASPX

  
  <dx:ASPxGridView runat="server" ID="Grid" ClientInstanceName="Grid" Width="100%" EnableRowsCache="false" DataSourceID="DemoDataSource1" KeyFieldName="ProductID"
      OnFillContextMenuItems="Grid_FillContextMenuItems">
      <Columns>
      ...
      </Columns>
      <SettingsExport EnableClientSideExportAPI="true" ExcelExportMode="DataAware" />
      <SettingsContextMenu Enabled="true" />
      ...
  </dx:ASPxGridView>
  

  C#

  
  protected void Grid_FillContextMenuItems(object sender, ASPxGridViewContextMenuEventArgs e) {
      if(e.MenuType == GridViewContextMenuType.Rows) {
          var item = e.CreateItem("Export", "Export");
          item.BeginGroup = true;
          item.Image.IconID = "export_export_16x16";
          e.Items.Insert(e.Items.IndexOfCommand(GridViewContextMenuCommand.Refresh), item);
          item.Items.Add(new GridViewContextMenuItem(GridViewContextMenuCommand.ExportToPdf) { Text = "Export to PDF" });
          item.Items.Add(GridViewContextMenuCommand.ExportToRtf).Text = "Export to RTF";
          item.Items.Add(e.CreateItem(GridViewContextMenuCommand.ExportToXls));
      }
  }
  

• Export using client-side export API

  ASPX

  
  <dx:ASPxGridView ClientInstanceName="grid" ID="ASPxGridView1" runat="server" AutoGenerateColumns="False" DataSourceID="SqlDataSource1" KeyFieldName="ProductID"> 
  <SettingsExport EnableClientSideExportAPI="true" /> 
          <Columns> 
          ...
          </Columns> 
  </dx:ASPxGridView> 
  <br /> 
  <dx:ASPxButton ID="ASPxButton1" runat="server" AutoPostBack="False" Text="Export"> 
      <ClientSideEvents Click="function(s, e) {
          grid.ExportTo(ASPxClientGridViewExportFormat.Xls);
      }" /> 
  </dx:ASPxButton>
  

Concept

• ASPxGridView Exporting

Online Demos

• Exporting to Different Formats
• Excel Data Aware Export
• Export Selected Records
• Export Master-Detail Records
• Export with Format Conditions
• Export with Data Cell Bands
• Context Menu

ASPxCardView

Examples

• Export using built-in toolbar commands

  ASPX

  
  <dx:ASPxCardView ID="cardView" runat="server" DataSourceID="ProductsDataSource" KeyFieldName="ProductID" AutoGenerateColumns="False">
      <Toolbars>
          <dx:CardViewToolbar EnableAdaptivity="true">
              <Items>
                  <dx:CardViewToolbarItem Command="ExportToPdf" />
                  <dx:CardViewToolbarItem Command="ExportToXls" />
                  <dx:CardViewToolbarItem Command="ExportToXlsx" />
                  <dx:CardViewToolbarItem Command="ExportToDocx" />
                  <dx:CardViewToolbarItem Command="ExportToRtf" />
              </Items>
          </dx:CardViewToolbar>
      </Toolbars>
      <Columns>
      ...
      </Columns>
      <SettingsExport EnableClientSideExportAPI="true" CardWidth="300" />
  </dx:ASPxCardView>
  

• Export using client-side export API

  ASPX

  
  <dx:ASPxCardView ID="ASPxCardView1" ClientInstanceName="cardView" runat="server" AutoGenerateColumns="False" DataSourceID="SqlDataSource2" KeyFieldName="ProductID"> 
  <SettingsExport ExportSelectedCardsOnly="True" EnableClientSideExportAPI="true"></SettingsExport> 
      <Columns> 
      ...
      </Columns> 
  </dx:ASPxCardView> 
  <br /> 
  <dx:ASPxButton ID="ASPxButton1" runat="server" AutoPostBack="False" Text="Export"> 
      <ClientSideEvents Click="function(s, e) {
          cardView.ExportTo(ASPxClientCardViewExportFormat.Xls);
      }" /> 
  </dx:ASPxButton>
  

Concept

• ASPxCardView Exporting

Online Demos

• Exporting to Different Formats
• Export Selected Records
• Export with Format Conditions

ASPxVerticalGrid

Examples

• Export using built-in toolbar commands

  ASPX

  
  <dx:ASPxVerticalGrid ID="VerticalGrid" runat="server" DataSourceID="ProductsDataSource" EnableRecordsCache="false" Width="100%">
      <Toolbars>
          <dx:VerticalGridToolbar EnableAdaptivity="true">
              <Items>
                  <dx:VerticalGridToolbarItem Command="ExportToPdf" />
                  <dx:VerticalGridToolbarItem Command="ExportToXls" />
                  <dx:VerticalGridToolbarItem Command="ExportToXlsx" />
                  <dx:VerticalGridToolbarItem Command="ExportToDocx" />
                  <dx:VerticalGridToolbarItem Command="ExportToRtf" />
              </Items>
          </dx:VerticalGridToolbar>
      </Toolbars>
      ...
      <SettingsExport EnableClientSideExportAPI="true" />
  </dx:ASPxVerticalGrid>
  

• Export using client-side export API

  ASPX

  
  <dx:ASPxVerticalGrid ClientInstanceName="verticalGrid" ID="ASPxVerticalGrid1" runat="server" Width="700px" AutoGenerateRows="False" DataSourceID="SqlDataSource3" KeyFieldName="ProductID"> 
  <SettingsExport EnableClientSideExportAPI="true"></SettingsExport> 
      <Rows> 
      ...
      </Rows> 
  </dx:ASPxVerticalGrid> 
  <br /> 
  <dx:ASPxButton ID="ASPxButton1" runat="server" AutoPostBack="False" Text="Export"> 
      <ClientSideEvents Click="function(s, e) {
          verticalGrid.ExportTo(ASPxClientVerticalGridExportFormat.Xls);
      }" /> 
  </dx:ASPxButton> 
  

Concept

ASPxVerticalGrid - Export

Online Demo

• Exporting to Different Formats.