TreeListDocumentExportOptions.CustomizePageHeader Property
Allows you to add page headers to the exported document.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.v25.1.dll
NuGet Package: DevExpress.Blazor
Declaration
public Action<TreeListDocumentExportCustomizePageHeaderFooterEventArgs> CustomizePageHeader { get; set; }Property Value
| Type | Description |
|---|---|
| Action<TreeListDocumentExportCustomizePageHeaderFooterEventArgs> | A delegate method that adds page headers. |
Remarks
Call the ExportToPdf method to export TreeList data to PDF. An output document contains only a table with exported data. You can add the following elements to the document:
- Document Header
- Located on the first page before the data table. Handle the CustomizeDocumentHeader event to add and style this element.
- Document Footer
- Located on the last page after the data table. Handle the CustomizeDocumentFooter event to add and style this element.
- Page Header
- Located on each page within the top margin. Handle the
CustomizePageHeaderevent to add and style this element. - Page Footer
- Located on each page within the bottom margin. Handle the CustomizePageFooter event to add and style this element.
In the following image, page headers/footers are colored blue and the document header/footer is colored red:
Handle the CustomizeDocument event to configure page settings and default formatting for all elements in the exported document.
The following example exports TreeList data to PDF and customizes output document appearance:
@rendermode InteractiveServer
@using DevExpress.Drawing
@inject SpaceObjectDataProvider SpaceObjectDataProvider
<DxTreeList @ref="TreeList" Data="TreeListData" ChildrenFieldName="Satellites">
<Columns>
<DxTreeListDataColumn FieldName="Name" />
<DxTreeListDataColumn FieldName="TypeOfObject" Caption="Type" />
<DxTreeListDataColumn FieldName="Mass10pow21kg" Caption="Mass, kg" DisplayFormat="N2" />
<DxTreeListDataColumn FieldName="MeanRadiusInKM" Caption="Radius, km" DisplayFormat="N2"/>
</Columns>
<ToolbarTemplate>
<DxToolbar>
<DxToolbarItem Text="Export to PDF" Click="ExportPdf_Click" BeginGroup="true" />
</DxToolbar>
</ToolbarTemplate>
</DxTreeList>
@code {
ITreeList TreeList { get; set; }
object TreeListData { get; set; }
DXFont defaultFont = new DXFont("Times New Roman", 12, DXFontStyle.Regular);
protected override async Task OnInitializedAsync() {
TreeListData = SpaceObjectDataProvider.GenerateData();
}
async Task ExportPdf_Click() {
await TreeList.ExportToPdfAsync("ExportResult", new TreeListPdfExportOptions() {
CustomizeDocument = OnCustomizeDocument, // Customizes exported document appearance
CustomizeDocumentHeader = OnCustomizeDocumentHeader, // Adds a document header
CustomizeDocumentFooter = OnCustomizeDocumentFooter, // Adds a document footer
CustomizePageHeader = OnCustomizePageHeader, // Adds page headers
CustomizePageFooter = OnCustomizePageFooter, // Adds page footers
});
}
void OnCustomizeDocument(TreeListDocumentExportCustomizeDocumentEventArgs args) {
args.DefaultElementStyle.Font = defaultFont;
args.PaperKind = DevExpress.Drawing.Printing.DXPaperKind.B5;
}
void OnCustomizeDocumentHeader(TreeListDocumentExportCustomizeDocumentHeaderFooterEventArgs args) {
args.ElementStyle.Font = new DXFont("Arial", 16);
args.Text = "Space Objects";
}
void OnCustomizeDocumentFooter(TreeListDocumentExportCustomizeDocumentHeaderFooterEventArgs args) {
args.ElementStyle.Font = new DXFont(defaultFont.Name, defaultFont.Size, DXFontStyle.Bold);
args.ElementStyle.TextAlignment = DevExpress.XtraPrinting.TextAlignment.MiddleLeft;
args.Text = "The document data is intented for demonstration purposes only.";
}
void OnCustomizePageHeader(TreeListDocumentExportCustomizePageHeaderFooterEventArgs args) {
args.ElementStyle.Font = new DXFont(defaultFont.Name, defaultFont.Size, DXFontStyle.Italic);
args.Text = "Copyright © 1998-2025 Developer Express Inc.";
}
void OnCustomizePageFooter(TreeListDocumentExportCustomizePageHeaderFooterEventArgs args) {
args.ElementStyle.Font = new DXFont(defaultFont.Name, defaultFont.Size, DXFontStyle.Italic);
args.Text = "Page {0} of {1}";
}
}
Refer to the following topic for additional information: Export Blazor TreeList Data to PDF.