XlsxExportOptionsEx.CustomizeSheetSettings Event

Allows you to customize the output document’s settings. Only available in data-aware export mode.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v19.2.Core.dll

Declaration

C#

public event CustomizeSheetSettingsEventHandler CustomizeSheetSettings

VB.NET

Public Event CustomizeSheetSettings As CustomizeSheetSettingsEventHandler

Remarks

To learn more about the functionality provided by this event, see XlsExportOptionsEx.CustomizeSheetSettings.

Note

The CustomizeSheetSettings event is not currently supported when exporting data from Advanced Banded Grid Views.

Example

This example uses the XlsxExportOptionsEx.CustomizeSheetSettings event to specify export settings for an XLSX document (a result of data exporting from a Grid Control). The ExportContext.SetFixedHeader event method is used to anchor the output document’s header to the top, and to set the fixed header height. The ExportContext.SetFixedHeader method is called to add the AutoFilter button to the document’s cells corresponding to the grid column headers.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-gridcontrols-data-aware-export-output-t247610

Form1.cs

void options_CustomizeSheetSettings(CustomizeSheetEventArgs e) {
    // Anchor the output document's header to the top and set its fixed height. 
    const int lastHeaderRowIndex = 15;
    e.ExportContext.SetFixedHeader(lastHeaderRowIndex);
    // Add the AutoFilter button to the document's cells corresponding to the grid column headers.
    e.ExportContext.AddAutoFilter(new XlCellRange(new XlCellPosition(0, lastHeaderRowIndex), new XlCellPosition(5, 100)));
}

Form1.vb

Private Sub options_CustomizeSheetSettings(ByVal e As CustomizeSheetEventArgs)
    ' Anchor the output document's header to the top and set its fixed height. 
    Const lastHeaderRowIndex As Integer = 15
    e.ExportContext.SetFixedHeader(lastHeaderRowIndex)
    ' Add the AutoFilter button to the document's cells corresponding to the grid column headers.
    e.ExportContext.AddAutoFilter(New XlCellRange(New XlCellPosition(0, lastHeaderRowIndex), New XlCellPosition(5, 100)))
End Sub

Related GitHub Examples

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

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#

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/CS/GridDataAwareExportCustomization/Form1.cs#L47

// Subscribe to export customization events.
options.CustomizeSheetSettings += options_CustomizeSheetSettings;
options.CustomizeSheetHeader += options_CustomizeSheetHeader;

VB.NET

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/VB/GridDataAwareExportCustomization/Form1.vb#L50

' Subscribe to export customization events.
AddHandler options.CustomizeSheetSettings, AddressOf options_CustomizeSheetSettings
AddHandler options.CustomizeSheetHeader, AddressOf options_CustomizeSheetHeader