'Declaration Public Event HeaderCellExporting As EventHandler(Of HeaderCellExportingEventArgs)
public event EventHandler<HeaderCellExportingEventArgs> HeaderCellExporting
The event handler receives an argument of type HeaderCellExportingEventArgs containing data related to this event. The following HeaderCellExportingEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| BandHeaderContainer | Returns an Infragistics.Documents.Reports.Report.Table.ITableCell which will contain the band header being exported. If HeaderType is not a band header, this will be null. |
| Cancel (Inherited from System.ComponentModel.CancelEventArgs) | |
| ColumnHeaderContainer | Returns an Infragistics.Documents.Reports.Report.Grid.IGridCell which will contain the column header being exported. If HeaderType is not a column header, this will be null. |
| ExportText | The value which will be exported to the document. |
| GridHeader | Returns the Infragistics.Win.UltraWinGrid.HeaderBase being exported. |
| GroupHeaderContainer | Returns an Infragistics.Documents.Reports.Report.Table.ITableCell which will contain the group header being exported. If HeaderType is not a group header, this will be null. |
| HeaderType | Indicates what type of header is being exported: a band header, group, or column header. |
HeaderCellExportingEventArgs.GridHeader returns the Infragistics.Win.UltraWinGrid.HeaderBase being exported.
HeaderType indicates what type of header is being exported: a band header, group, or column header.
HeaderCellExportingEventArgs.ColumnHeaderContainer, HeaderCellExportingEventArgs.GroupHeaderContainer, and HeaderCellExportingEventArgs.BandHeaderContainer return a report object which will contain the header being exported. Only one of these three properties will contain an object, the other two will be null.
ColumnHeaderContainer returns an Infragistics.Documents.Reports.Report.Grid.IGridCell which will contain the column header being exported. If HeaderType is not a column header, this will be null.
GroupHeaderContainer returns an Infragistics.Documents.Reports.Report.Table.ITableCell which will contain the group header being exported. If HeaderType is not a group header, this will be null.
BandHeaderContainer returns an ITableCell which will contain the band header being exported. If HeaderType is not a band header, this will be null.
Use the System.ComponentModel.CancelEventArgs.Cancel argument to cancel the exporting of the header cell.
Using these event arguments, it is possible to override the exporting of a header cell and provide a custom export. Typically, this would be done by setting Cancel to True, and then adding content to the ColumnHeaderContainer, GroupHeaderContainer, or BandHeaderContainer (depending on the HeaderType).
Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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