PDFFlowDocumentHeader¶

Namespace: O2S.Components.PDF4NET.FlowDocument

Defines the header for a flow document.

public class PDFFlowDocumentHeader

Inheritance Object → PDFFlowDocumentHeader

Constructors¶

PDFFlowDocumentHeader()¶

Initializes a new PDFFlowDocumentHeader object.

public PDFFlowDocumentHeader()

Properties¶

Content¶

Gets or sets the header content.

public PDFFlowContentCollection Content { get; }

Property Value

PDFFlowContentCollection

ExtendLeft¶

Gets or sets the left margin extension.

public double ExtendLeft { get; set; }

Property Value

Double
The distance the header should go on the left over the page left margin.

Remarks

By default the header is drawn within the page left/right margins. You can increase the available width for the header by specifying a positive value for this property. For example if you want the header to spread from the left edge of the page to the right edge you can set the PDFFlowDocumentHeader.ExtendLeft and PDFFlowDocumentHeader.ExtendRight properties to values that match the page's left and right margins.

ExtendRight¶

Gets or sets the right margin extension.

public double ExtendRight { get; set; }

Property Value

Double
The distance the header should go on the right over the page right margin.

Remarks

By default the header is drawn within the page left/right margins. You can increase the available width for the footer by specifying a positive value for this property. For example if you want the header to spread from the left edge of the page to the right edge you can set the PDFFlowDocumentHeader.ExtendLeft and PDFFlowDocumentHeader.ExtendRight properties to values that match the page's left and right margins.

TopMargin¶

Gets or sets the top margin.

public double TopMargin { get; set; }

Property Value

Double
Margin from top page border where the header starts.

Remarks

If the header top margin plus header height are greater than page top margin, the page top margin is increased (content is moved down) in order to accomodate the header.