Version

HeaderLabelExporting Event

Occurs before a header label is exported to Excel.
Syntax
'Declaration
 
Public Event HeaderLabelExporting As EventHandler(Of HeaderLabelExportingEventArgs)
public event EventHandler<HeaderLabelExportingEventArgs> HeaderLabelExporting
Event Data

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

PropertyDescription
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.
Field Returns the Field associated with the header cell, or null if the header cell is not associated with a field.
FieldGroup Returns the FieldGroup associated with the header cell, or null if the header cell is not associated with a field group.
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.
Label Gets or sets the label value of the header cell.
Record Returns the first record associated with the headers.
Workbook (Inherited from Infragistics.Windows.DataPresenter.ExcelExporter.ExcelExportCancelEventArgs)Exporting workbook.
Remarks

The Field argument returns a reference to the associated field.

The Label argument allows control over what value should be shown in the header cell.

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.

Use the Cancel argument to cancel the exporting of this cell.

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

See Also