FlowDocument Class

Apitron PDF Kit help

Apitron.PDF.Kit library for .NET

Represents a document that can be composed using flow layout rules applied to various content elements or content containers and later saved as PDF document using Write(Stream, ResourceManager, PDFALevels, PageBoundary) method.

It can be also saved to XML using SaveToXml(Stream, ResourceManager) and loaded from it using LoadFromXml(Stream, ResourceManager) methods.

FlowDocument supports styling for its elements and itself using Style objects which can be added to its StyleManager along with the matching expressions.

Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FlowLayoutContentElement
    Apitron.PDF.Kit.FlowLayoutContainerElementContentElement
      Apitron.PDF.KitFlowDocument

Namespace: Apitron.PDF.Kit
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)

Syntax

Copy

public sealed class FlowDocument : ContainerElement<ContentElement>

Public NotInheritable Class FlowDocument
	Inherits ContainerElement(Of ContentElement)

The FlowDocument type exposes the following members.

Constructors

	Name	Description
	FlowDocument	Initializes a new instance of the FlowDocument class.

Top

Properties

	Name	Description
	Align	Gets or sets the text align. (Inherited from ContentElement.)
	Background	Gets or sets the background color. (Inherited from ContentElement.)
	BackgroundImage	Gets or sets the background image for the element. The background of an element is the total size of the element, including padding (but not the margin and border). By default, a background-image is placed at the top-left corner of an element, and repeated both vertically and horizontally. (Inherited from ContentElement.)
	BackgroundPosition	Gets or sets the background position value for the element. The background position property sets the starting position of a background image. (Inherited from ContentElement.)
	BackgroundRepeat	Gets or sets the background repeat value for the element. The background repeat property sets if/how a background image will be repeated. By default, a background image is repeated both vertically and horizontally. (Inherited from ContentElement.)
	Bookmark	Gets or sets the bookmark. (Inherited from ContentElement.)
	Border	Gets or sets the border around the element. (Inherited from ContentElement.)
	BorderBottom	Gets or sets the bottom border. (Inherited from ContentElement.)
	BorderColor	Gets or sets the color of the border. (Inherited from ContentElement.)
	BorderLeft	Gets or sets the left border. (Inherited from ContentElement.)
	BorderRadius	Gets or sets the border radius. Can be set using percentage value, in this case it's calculated using content width including padding as a base. (Inherited from ContentElement.)
	BorderRight	Gets or sets the right border. (Inherited from ContentElement.)
	BorderTop	Gets or sets the top border. (Inherited from ContentElement.)
	CellPadding	Gets or sets the cell padding, affects only Grid elements. (Inherited from ContentElement.)
	CharacterSpacing	Gets or sets the character spacing. (Inherited from ContentElement.)
	Class	Gets or sets classes list this element belongs to, so it will match selectors for this class. Use space to separate classes from each other. (Inherited from ContentElement.)
	Clear	Gets or sets the clear flag for the element indicating whether it should ignore floating elements (if any) and start a new line. (Inherited from ContentElement.)
	Color	Gets or sets the foreground color for the element. (Inherited from ContentElement.)
	ColSpan	Gets or sets the column span that this element takes. Affects element placed inside the Grid container. (Inherited from ContentElement.)
	Display	Gets or sets the display setting for the element. (Inherited from ContentElement.)
	Fields	Gets the fields collection for this document.
	Float	Gets or sets the value indicating that element can float. (Inherited from ContentElement.)
	Font	Gets or sets the font for the element. (Inherited from ContentElement.)
	Height	Gets or sets the height of the element. (Inherited from ContentElement.)
	Id	Gets or sets Id. (Inherited from ContentElement.)
	InnerBorder	Gets or sets the inner border, affects only Grid elements. (Inherited from ContentElement.)
	InnerBorderColor	Gets or sets the color of the inner border affects only Grid elements. (Inherited from ContentElement.)
	LineHeight	Gets or sets the height of the line. (Inherited from ContentElement.)
	Link	Gets or sets the link. (Inherited from ContentElement.)
	ListCounter	Gets or sets the list counter. (Inherited from ContentElement.)
	ListMarker	Gets or sets the list marker appearance. (Inherited from ContentElement.)
	ListMarkerPadding	Gets or sets the list marker padding. (Inherited from ContentElement.)
	ListStyle	Gets or sets the list style. (Inherited from ContentElement.)
	Margin	Gets or sets the margin around the element. (Inherited from ContentElement.)
	Padding	Gets or sets the padding. (Inherited from ContentElement.)
	PageFooter	Gets or sets the page footer for the document. It will be placed at the bottom of each page.
	PageHeader	Gets or the page header for the document. It will be placed at the top of each page.
	PageLayout	Gets or sets the page layout that shall be used when the document is opened:
	PageMode	Gets or sets the page mode specifying how the document shall be displayed when opened.
	RowSpan	Gets or sets the row span that this element takes. Affects element placed inside the Grid container. (Inherited from ContentElement.)
	ScriptLevel	Gets or sets the value used to create subscripting or superscripting effect. It defines the level of effect, zero can be used for normal scripting, positive values are for superscripting, negative for subscripting. Affects textual elements. (Inherited from ContentElement.)
	StructureType	Gets or sets the type of the logical structure. (Inherited from ContentElement.)
	StyleManager	Gets the style manager for this document. It contains all styles that define the appearance of containing elements.
	Tag	Gets or sets the tag for this element. It can be any object and can be used for any user-defined purpose. (Inherited from ContentElement.)
	TextDecoration	Gets or sets the text decoration. (Inherited from ContentElement.)
	TextIndent	Gets or sets the text indent. (Inherited from ContentElement.)
	TextRenderingMode	Gets or sets the text rendering mode used to draw textual elements. By default all text is being drawn using Fill setting. (Inherited from ContentElement.)
	VerticalAlign	Gets or sets the vertical align. (Inherited from ContentElement.)
	ViewerPreferences	Gets the viewer preferences. Can be used to define viewer's startup settings.
	Width	Gets or sets the width of the element. (Inherited from ContentElement.)
	WordSpacing	Gets or sets the word spacing. (Inherited from ContentElement.)

Top

Methods

	Name	Description
	Add	Adds the specified element to the container. (Inherited from ContainerElementT.)
	AddItems	Adds the specified elements to the container. (Inherited from ContainerElementT.)
	Clear	Removes all elements from container. (Inherited from ContainerElementT.)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from ContainerElementT.)
	CopyTo	Copies to. (Inherited from ContainerElementT.)
	LoadFromXml	Loads the document from XML.
	Remove	Removes the specified item. (Inherited from ContainerElementT.)
	SaveToXml	Saves document structure to XML.
	ToFixedDocument(ResourceManager, PageBoundary, PdfStandard)	Generates the FixedDocument from this instance.
	ToFixedDocument(ResourceManager, PDFALevels, PageBoundary)	Generates the FixedDocument from this instance. The resulting document will be saved in PDFA.
	Write(Stream, ResourceManager, PageBoundary, PdfStandard)	Processes document and writes PDF content to the output stream.
	Write(Stream, ResourceManager, PDFALevels, PageBoundary)	Processes document and writes PDF content to the output stream. The resulting document will be saved in PDFA.

Top

Events

	Name	Description
	NewPage	Event handler for the NewPage event.

Top

Reference

Apitron.PDF.Kit Namespace