CustomExportEventArgs.ExportOptions Property

Specifies the export options to be applied when data is exported.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

public ExportOptionsBase ExportOptions { get; set; }

VB.NET

Public Property ExportOptions As ExportOptionsBase

Property Value

Type	Description
ExportOptionsBase	An ExportOptionsBase object which specifies the export options to be applied when data is exported.

Remarks

When handling the ExportController.CustomExport event, use the ExportOptions parameter to customize the options that will be applied when the data is exported. Cast the object returned by this property to one of the following types in dependence on the value returned by the CustomExportEventArgs.ExportTarget parameter:

ExportTarget	Export Options
ExportTarget.Xls	XlsExportOptions
ExportTarget.Xlsx	XlsxExportOptions
ExportTarget.Html	HtmlExportOptions
ExportTarget.Mht	MhtExportOptions
ExportTarget.Pdf	PdfExportOptions
ExportTarget.Text	TextExportOptions
ExportTarget.Rtf	RtfExportOptions
ExportTarget.Csv	CsvExportOptions
ExportTarget.Image	ImageExportOptions

You can also cast ExportOptions to IDataAwareExportOptions to switch from DataAware to WYSIWYG export type (see ExportType). For details, refer to the IDataAwareExportable topic.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportOptions property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-customize-the-export-action-behavior-e2335/CS/CustomizeExportAction.Module/Controllers/CustomizeExportController.cs#L33

if (e.ExportTarget == ExportTarget.Xls) {
   XlsExportOptions options = (XlsExportOptions)e.ExportOptions;
   if (options == null) {

VB.NET

XAF_how-to-customize-the-export-action-behavior-e2335/VB/CustomizeExportAction.Module/Controllers/CustomizeExportController.vb#L35

If e.ExportTarget = ExportTarget.Xls Then
   Dim options As XlsExportOptions = CType(e.ExportOptions, XlsExportOptions)
   If options Is Nothing Then