HeaderAreaExporting Event

Occurs before header area is exported to Excel.

Syntax

Visual Basic

'Declaration
 
Public Event HeaderAreaExporting As EventHandler(Of HeaderAreaExportingEventArgs)

C#

public event EventHandler<HeaderAreaExportingEventArgs> HeaderAreaExporting

Event Data

The event handler receives an argument of type HeaderAreaExportingEventArgs containing data related to this event. The following HeaderAreaExportingEventArgs properties provide information specific to this event.

Property	Description
Cancel (Inherited from System.ComponentModel.CancelEventArgs)
CurrentColumnIndex (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Zero-based index of current exporting column in excel worksheet..
CurrentOutlineLevel (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Current outline level used for grouping.
CurrentRowIndex (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Zero-based index of current exporting row in excel worksheet.
CurrentWorksheet (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Current exporting worksheet.
FieldLayout	Returns the layout associated with the header being exported.
FormatSettings (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Gets or sets the settings that should be applied to exported label. Settings specified on individual labels take precedence.
Record	Returns the first record associated with the header.
Workbook (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)	Exporting workbook.

Remarks

The FieldLayout argument returns a reference the layout object associated with the headers.

The Record argument returns a reference to the first record associated with the headers.

Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from ExcelExportCancelEventArgs.

This event is fired before Excel row with header values is processed. Use Cancel argument to cancel row exporting. If headers span multiple Excel rows, this event is fired only for first header row.

This event is not fired when the labels are displayed with the cells instead of in a separate header area.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2