PdfFlowDocument Class
Definition
Namespace: Xfinium.Pdf.FlowDocument
Defines a PDF document that formats flow content.
Inheritance: Object → PdfDocument → PdfFlowDocument
Constructors
| Name | Description |
|---|---|
| PdfFlowDocument() | Initializes a new PdfFlowDocument object. |
| PdfFlowDocument(PdfFlowDocumentDefaults) | Initializes a new PdfFlowDocument object. |
Properties
| Name | Description |
|---|---|
| AfterPrintAction | Gets or sets the javascript action to execute after the document is printed. |
| AfterSaveAction | Gets or sets the javascript action to execute after the document is saved. |
| BeforeCloseAction | Gets or sets the javascript action to execute before the document is closed. |
| BeforePrintAction | Gets or sets the javascript action to execute before the document is printed. |
| BeforeSaveAction | Gets or sets the javascript action to execute before the document is saved. |
| CosDictionary | Gets the COS dictionary asssociated with this object. (inherited from PdfDocument) |
| DisplayMode | Gets or sets how the document should be displayed when opened in the viewer. |
| DocumentInformation | Gets or sets the document information. |
| DocumentSecurityStore | Gets or sets the document security store. (inherited from PdfDocument) |
| FileAttachments | Gets the list of file attachments embedded in this document. |
| HeadersFooters | Gets the document headers and footers. |
| ID | Gets or sets the document ID. (inherited from PdfDocument) |
| JavaScriptBlocks | Gets the JavaScript source code blocks. |
| Language | Gets or sets the document language. |
| MarkInformation | Gets or sets the document mark information. |
| OpenAction | Gets or sets the action to execute when the document is opened. |
| Outline | Gets the document outline. |
| OutputIntents | Gets or sets the collection of output intents. |
| PageLabelingRanges | Gets the list of page labeling ranges in the Pdf document. |
| PageLayout | Gets or sets the document's page layout specifying how the pages should be displayed when opened. |
| ParentStructureElementForContent | Gets or sets the structure element that serves as parent for the structure elements in the flow content objects. |
| PdfVersion | Gets or sets the Pdf version of this PdfDocument object. |
| SecurityHandler | Gets the document security handler. (inherited from PdfDocument) |
| StructureTree | Gets or sets the document structure tree. |
| VersionExtension | Gets or sets the version extension. |
| ViewerPreferences | Gets or sets the document's viewer preferences. |
| XmpMetadata | Gets or sets the XMP document metadata. |
Methods
| Name | Description |
|---|---|
| AddContent | Adds new content to the document. |
| AddSpace | Adds a space after the last flow content. |
| CloseCurrentPage | Closes the current page no matter how much content has been added to it. Next content added to document will start on a new page. |
| GenerateTableOfContents | Generates the document's table of contents. |
| GetAvailableSpace | Gets the available space on current page. |
| GetFixedDocument | Converts the flow document to a fixed document and returns it. |
| Save | Saves the document to the specified stream. |
| StartNewPage | Starts a new page no matter how much content has been added to current page. |
Events
| Name | Description |
|---|---|
| PageCreated | Gets or sets the event that is fired when a new page has been created. |
| PageCompleted | Gets or sets the event that is fired when a page has been completed and it can be closed for adding content. |
| BeforeContentDraw | Gets or sets the event that is fired before a flow content object is drawn on the page. |
| AfterContentDraw | Gets or sets the event that is fired after a flow content object is drawn on the page. |