PDFFlowDocumentHeadersFooters¶

Namespace: O2S.Components.PDF4NET.FlowDocument

Defines the headers and footers for a flow document.

public class PDFFlowDocumentHeadersFooters

Inheritance Object → PDFFlowDocumentHeadersFooters

Constructors¶

PDFFlowDocumentHeadersFooters()¶

Initializes a new PDFFlowDocumentHeadersFooters object.

public PDFFlowDocumentHeadersFooters()

Properties¶

EvenPagesFooter¶

Gets or sets the footer for even pages in the document.

public PDFFlowDocumentFooter EvenPagesFooter { get; set; }

Property Value

PDFFlowDocumentFooter
A footer object to be displayed on document's even pages.

Remarks

If this property is set to null, no footer is displayed on even pages. When the PDFFlowDocumentHeadersFooters.MainFooter property is set, this property is also set to the same value. If you want a different footer for even pages, set this property after setting the PDFFlowDocumentHeadersFooters.MainFooter property.

EvenPagesHeader¶

Gets or sets the header for even pages in the document.

public PDFFlowDocumentHeader EvenPagesHeader { get; set; }

Property Value

PDFFlowDocumentHeader
A header object to be displayed on document's even pages.

Remarks

If this property is set to null, no header is displayed on even pages. When the PDFFlowDocumentHeadersFooters.MainHeader property is set, this property is also set to the same value. If you want a different header for even pages, set this property after setting the PDFFlowDocumentHeadersFooters.MainHeader property.

FirstPageFooter¶

Gets or sets the footer for the first page.

public PDFFlowDocumentFooter FirstPageFooter { get; set; }

Property Value

PDFFlowDocumentFooter
A footer object to be displayed on document's first page.

Remarks

If this property is set to null, no footer is displayed on the first page. When the PDFFlowDocumentHeadersFooters.MainFooter property is set, this property is also set to the same value. If you want a different footer for first page, set this property after setting the PDFFlowDocumentHeadersFooters.MainFooter property.

FirstPageHeader¶

Gets or sets the header for the first page.

public PDFFlowDocumentHeader FirstPageHeader { get; set; }

Property Value

PDFFlowDocumentHeader
A header object to be displayed on document's first page.

Remarks

If this property is set to null, no header is displayed on the first page. When the PDFFlowDocumentHeadersFooters.MainHeader property is set, this property is also set to the same value. If you want a different header for first page, set this property after setting the PDFFlowDocumentHeadersFooters.MainHeader property.

MainFooter¶

Gets or sets the document main footer.

public PDFFlowDocumentFooter MainFooter { get; set; }

Property Value

PDFFlowDocumentFooter
A footer object to be displayed on document's pages.

Remarks

The main footer is displayed on all document pages. When this property is set, the PDFFlowDocumentHeadersFooters.EvenPagesFooter and PDFFlowDocumentHeadersFooters.FirstPageFooter properties are also set to the same value.

MainHeader¶

Gets or sets the document main header.

public PDFFlowDocumentHeader MainHeader { get; set; }

Property Value

PDFFlowDocumentHeader
A header object to be displayed on document's pages.

Remarks

The main header is displayed on all document pages. When this property is set, the PDFFlowDocumentHeadersFooters.EvenPagesHeader and PDFFlowDocumentHeadersFooters.FirstPageHeader properties are also set to the same value.