'Declaration Public Event HeaderRowExporting As EventHandler(Of HeaderRowExportingEventArgs)
public event EventHandler<HeaderRowExportingEventArgs> HeaderRowExporting
The event handler receives an argument of type HeaderRowExportingEventArgs containing data related to this event. The following HeaderRowExportingEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Band | The Infragistics.Win.UltraWinGrid.UltraGridBand whose headers are being exported. |
| Cancel (Inherited from System.ComponentModel.CancelEventArgs) | |
| FixedHeaderContainer | Returns an INode into which the header will be exported. |
| HeaderContainer | Returns an ITableHeader into which the header will be exported. |
| IsFixedHeader | Returns whether the header being exported is a fixed header. |
HeaderRowExportingEventArgs.Band returns the Infragistics.Win.UltraWinGrid.UltraGridBand associated with the headers being exported.
IsFixedHeader returns a boolean indicating whether this set of headers is a fixed header or not. A fixed header will repeat at the top of every page of the report. Other headers will appear at the top of a particulr island of data and repeat on a page break.
FixedHeaderContainer returns a the report object which will contain the set of headers if the headers are fixed. If IsFixedHeader is false, this will return null.
HeaderContainer returns a report object which will contain the headers if they are not fixed. If IsFixedHeader is True, this will return null.
This event is fired before a set of headers is exported to the report. The header includes the band header (if any), the group headers (if groups and levels are used), and the column headers. Use the Cancel argument to cancel the exporting of the entire set of headers.
Using these event arguments, it is possible to override the exporting of a header and provide custom exported data. Typically, this would be done by setting Cancel to True, and adding conent to the appropriate header container. If IsFixedHeader is True, content should be added to the FixedHeaderContainer, otherwise, content should be added to the HeaderContainer.
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