PDFFlowPageContent¶

Namespace: O2S.Components.PDF4NET.FlowDocument

Defines a special type of flow content that allows to insert existing PDF pages into a flow document.

public class PDFFlowPageContent : PDFFlowContent

Inheritance Object → PDFFlowContent → PDFFlowPageContent

Remarks

The existing PDF page content is kept as it is, it is not reflown on flow document's page.

Constructors¶

PDFFlowPageContent(PDFPage)¶

Initializes a new PDFFlowPageContent with the specified page.

public PDFFlowPageContent(PDFPage page)

Parameters

page PDFPage
The existing PDF page to insert in the flow document.

PDFFlowPageContent(PDFPage, Boolean)¶

Initializes a new PDFFlowPageContent with the specified page.

public PDFFlowPageContent(PDFPage page, bool writeable)

Parameters

page PDFPage
The existing PDF page to insert in the flow document.

writeable Boolean
True if the page is writeable.

Properties¶

Background¶

Gets or sets the content background.

public PDFBrush Background { get; set; }

Property Value

PDFBrush
The background of the flow content.

Remarks

The background that fills the flow content bounding rectangle.

DestinationName¶

Gets or sets the destination name.

public string DestinationName { get; set; }

Property Value

String
The name of the destination created at the location of the flow content.

Remarks

A named destination is created at the top of flow content when this property is not null or an empty string.

EnableFlowDocumentFooter¶

Gets or sets a value indicating whether the footer defined in the flow document is added to this page.

public bool EnableFlowDocumentFooter { get; set; }

Property Value

Boolean
True if the footer defined in the flow document is added to this page.

EnableFlowDocumentHeader¶

Gets or sets a value indicating whether the header defined in the flow document is added to this page.

public bool EnableFlowDocumentHeader { get; set; }

Property Value

Boolean
True if the header defined in the flow document is added to this page.

InnerMargins¶

Gets or sets the content inner margins.

public PDFFlowContentMargins InnerMargins { get; set; }

Property Value

PDFFlowContentMargins
A PDFFlowContentMargins object specifying the content inner margins.

Remarks

The inner margins are located inside the content's bounding rectangle. The margins are applied to content as a whole and not to parts of content when content is split across pages.

OuterMargins¶

Gets or sets the content outer margins.

public PDFFlowContentMargins OuterMargins { get; set; }

Property Value

PDFFlowContentMargins
A PDFFlowContentMargins object specifying the content outer margins.

Remarks

The outer margins are located outside the content's bounding rectangle. The margins are applied to content as a whole and not to parts of content when content is split across pages.

Page¶

Gets the existing PDF page to be inserted in the flow document.

public PDFPage Page { get; }

Property Value

PDFPage
A PDFPage object representing an existing PDF page.

StructureElement¶

Gets or sets the structure element.

public PDFStructureElement StructureElement { get; set; }

Property Value

PDFStructureElement
The PDFStructureElement object associated with this flow content object.

Tag¶

Gets or sets an arbitrary object value that can be used to store custom information about this element.

public object Tag { get; set; }

Property Value

Object
The intended value.

Remarks

This property is analogous to Tag properties in other Microsoft programming models. Tag is intended to provide a pre-existing property location where you can store some basic custom information about any PDFFlowContent without requiring you to subclass a content object.

Writeable¶

Gets or sets a value indicating whether this page is writeable.

public bool Writeable { get; set; }

Property Value

Boolean
True if the page is writeable. Default is false.

Remarks

A writeable page allows the flow content of the document to be written on top of existing page content. When the page is not writeable, the page is skipped and the flow content is added to the next page.

Events¶

AfterContentDraw¶

Gets or sets the event that is fired after the flow content object is drawn on the page.

public event EventHandler<PDFFlowContentDrawEventArgs> AfterContentDraw;

BeforeContentDraw¶

Gets or sets the event that is fired before the flow content object is drawn on the page.

public event EventHandler<PDFFlowContentDrawEventArgs> BeforeContentDraw;