Headers and Footers in Blazor DocumentEditor Component

2 Aug 20231 minute to read

Blazor Document Editor supports headers and footers in its document. Each section in the document can have the following types of headers and footers:

  • First page: Used only on the first page of the section.
  • Even pages: Used on all even numbered pages in the section.
  • Default: Used on all pages of the section, where first or even pages are not applicable or not specified.

You can define this by setting format properties of the corresponding section using the following sample code.

//Defines whether different header footer is required for first page of the section
await container.DocumentEditor.Selection.SectionFormat.SetDifferentFirstPageAsync(true);
//Defines whether different header footer is required for odd and even pages in the section
await container.DocumentEditor.Selection.SectionFormat.SetDifferentOddAndEvenPagesAsync(true);

Double click in header or footer region to move the selection into it. You can also do this by using the following code.

await container.DocumentEditor.Selection.GoToHeaderAsync();

await container.DocumentEditor.Selection.GoToFooterAsync();

You can define the distance of header region content from the top of the page. Refer to the following sample code.

await container.DocumentEditor.Selection.SectionFormat.SetHeaderDistanceAsync(36);

Same way, you can define the distance of footer region content from the bottom of the page. Refer to the following sample code.

await container.DocumentEditor.Selection.SectionFormat.SetFooterDistanceAsync(36);

Move the selection to the document body from header or footer region by double clicking or tapping the document area. You can also perform this by using the following sample code.

await container.DocumentEditor.Selection.CloseHeaderFooterAsync();

You can also explore our Blazor Word Processor example to know how to render and configure the document editor.