LinkBase.CreateReportHeaderArea Event

Occurs when a report header section of the document is being generated.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v19.2.Core.dll

Declaration

C#

public event CreateAreaEventHandler CreateReportHeaderArea

VB.NET

Public Event CreateReportHeaderArea As CreateAreaEventHandler

Event Data

The CreateReportHeaderArea event's data class is CreateAreaEventArgs. The following properties provide information specific to this event:

Property	Description
Graph	Gets a BrickGraphics object used to draw in the current report.

Remarks

Handle the CreateReportHeaderArea event to customize the report header section of a document.

The document creation events occur in the following order:

• LinkBase.CreateMarginalHeaderArea
• LinkBase.CreateMarginalFooterArea
• LinkBase.CreateInnerPageHeaderArea
• LinkBase.CreateInnerPageFooterArea
• CreateReportHeaderArea
• LinkBase.CreateDetailHeaderArea
• LinkBase.CreateDetailArea
• LinkBase.CreateDetailFooterArea
• LinkBase.CreateReportFooterArea

Note

This order may be different in descendants of the LinkBase class.

For more information on handling events, see Events and Delegates in MSDN.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateReportHeaderArea 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#

aspxtreelist-how-display-report-header-and-report-footer-in-an-exported-document-t106500/CS/!ASPxTreeList/Default.aspx.cs#L19

int height = 20;
link.CreateReportHeaderArea += (s, args) => {
    args.Graph.DrawString("Report Header Text", Color.Empty, new RectangleF(Point.Empty, new SizeF(args.Graph.ClientPageSize.Width, height)), BorderSide.Top);

VB.NET

aspxtreelist-how-display-report-header-and-report-footer-in-an-exported-document-t106500/VB/!ASPxTreeList/Default.aspx.vb#L21

Dim height As Integer = 20
AddHandler link.CreateReportHeaderArea, Function(s, args) AnonymousMethod1(s, args, height)
AddHandler link.CreateReportFooterArea, Function(s, args) AnonymousMethod2(s, args, height)