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.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public event CustomizeSheetSettingsEventHandler CustomizeSheetSettings

VB.NET

Public Event CustomizeSheetSettings As CustomizeSheetSettingsEventHandler

Remarks

The CustomizeSheetSettings event allows you to do the following:

• Add the AutoFilter button to cells in a specified range.
• Anchor the document header to the top and specify its fixed height.
• Display a page number in the header or footer section.

Note

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

Examples

Specify Export Settings

This example handles the XlsxExportOptionsEx.CustomizeSheetSettings event to specify export settings for an XLSX document that originates from a Grid Control. The ExportContext.SetFixedHeader method is used to anchor the output document’s header to the top, and to set the fixed header height. The ExportContext.AddAutoFilter method adds the AutoFilter button to the column header cells.

View Example: How to: Customize the GridControl's Data-Aware Export Output

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

Display Page Number in a Header

The following code snippet displays the current page number in the right header section:

C#

private void Options_CustomizeSheetSettings(DevExpress.Export.CustomizeSheetEventArgs e)
{
    e.Sheet.HeaderFooter.OddHeader = XlHeaderFooter.FromLCR(null, null, XlHeaderFooter.PageNumber);
}

VB.NET

Private Sub options_CustomizeSheetSettings(ByVal e As CustomizeSheetEventArgs)
  e.Sheet.HeaderFooter.OddHeader = XlHeaderFooter.FromLCR(null, null, XlHeaderFooter.PageNumber)
End Sub

For more information, review the following help topic: Use the Excel Export API to Add Headers and Footers to a Worksheet Printout.

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#

winforms-grid-customize-data-aware-export-output/CS/GridDataAwareExportCustomization/Form1.cs#L47

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

VB.NET

winforms-grid-customize-data-aware-export-output/VB/GridDataAwareExportCustomization/Form1.vb#L50

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