IDataAwareExportable Interface

Implemented by List Editors that support data-aware export to Excel formats.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public interface IDataAwareExportable

VB.NET

Public Interface IDataAwareExportable

Remarks

Built-in List Editors that implement this interface are GridListEditor and ASPxGridListEditor. For these classes, the DataAware ExportType is used by default when exporting to Excel formats. For other List Editors that do not implement IDataAwareExportable, the WYSIWYG export type is used.

The IDataAwareExportable interface declares no members itself. However, it is implemented by the following interfaces that declare the format-specific Export method.

• IDataAwareExportableCsv
• IDataAwareExportableXls
• IDataAwareExportableXlsx

You can use the static ExportSettings.DefaultExportType property to switch from data-aware to the WYSIWYG mode of data export. Alternatively, you can handle the ExportController.CustomExport event as demonstrated in the How to: Customize the Export Action Behavior topic and customize the CustomExportEventArgs.ExportOptions parameter as follows:

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.SystemModule;
using DevExpress.Export;
// ...
public class CustomizeExportTypeController : ViewController {
    private ExportController exportController;
    protected override void OnActivated()
    {
        base.OnActivated();
        exportController = Frame.GetController<ExportController>();
        if (exportController != null) {
            exportController.CustomExport += CustomExport;
        }
    }
    protected virtual void CustomExport(object sender, CustomExportEventArgs e) {
        ((IDataAwareExportOptions)e.ExportOptions).ExportType = ExportType.WYSIWYG;
    }
    protected override void OnDeactivated() {
        if (exportController != null) {
             exportController.CustomExport -= new EventHandler<CustomExportEventArgs>(CustomExport);
        }
        base.OnDeactivated();
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.SystemModule
Imports DevExpress.Export
' ...
Public Class CustomizeExportTypeController
    Inherits ViewController
    Private exportController As ExportController
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        exportController = Frame.GetController(Of ExportController)()
        If exportController IsNot Nothing Then
            AddHandler exportController.CustomExport, AddressOf CustomExport
        End If
    End Sub
    Protected Overridable Sub CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs)
        CType(e.ExportOptions, IDataAwareExportOptions).ExportType = ExportType.WYSIWYG
    End Sub
    Protected Overrides Sub OnDeactivated()
        If exportController IsNot Nothing Then
             RemoveHandler exportController.CustomExport, AddressOf CustomExport
        End If
        MyBase.OnDeactivated()
    End Sub
End Class