PDFFlowFormXObjectContent¶

Namespace: O2S.Components.PDF4NET.FlowDocument

Defines a form XObject content that can be added to a flow document.

public class PDFFlowFormXObjectContent : PDFFlowContent

Inheritance Object → PDFFlowContent → PDFFlowFormXObjectContent

Constructors¶

PDFFlowFormXObjectContent(PDFFormXObject)¶

Initializes a new PDFFlowFormXObjectContent object.

public PDFFlowFormXObjectContent(PDFFormXObject formXObject)

Parameters

formXObject PDFFormXObject
Form XObject to draw in the document.

PDFFlowFormXObjectContent(PDFFormXObject, Double, Double)¶

Initializes a new PDFFlowFormXObjectContent object.

public PDFFlowFormXObjectContent(PDFFormXObject formXObject, double width, double height)

Parameters

formXObject PDFFormXObject
Form XObject to draw in the document.

width Double
Width of displayed form XObject.

height Double
Height of displayed form XObject.

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.

FormXObjectHeight¶

Gets or sets the formXObject height.

public double FormXObjectHeight { get; set; }

Property Value

Double
The height of the formXObject drawn on the page.

Exceptions

ArgumentOutOfRangeException
Thrown when Height is set to a value less than 0.

Remarks

The value of this property represents either a percentage (0 to 100) or an absolute value based on the value of PDFFlowFormXObjectContent.SizeIsRelativeToAvailableSpace property.

FormXObjectWidth¶

Gets or sets the formXObject width.

public double FormXObjectWidth { get; set; }

Property Value

Double
The width of the formXObject drawn on the page.

Exceptions

ArgumentOutOfRangeException
Thrown when Width is set to a value less than 0.

Remarks

The value of this property represents either a percentage (0 to 100) or an absolute value based on the value of PDFFlowFormXObjectContent.SizeIsRelativeToAvailableSpace property.

HorizontalAlign¶

Gets or sets the horizontal align.

public PDFGraphicAlign HorizontalAlign { get; set; }

Property Value

PDFGraphicAlign
The formXObject alignment on horizontal relative to available space.

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.

SizeIsRelativeToAvailableSpace¶

Gets or sets a value indicating how the formXObject size is interpreted.

public bool SizeIsRelativeToAvailableSpace { get; set; }

Property Value

Boolean
True if the form XObject size (PDFFlowFormXObjectContent.FormXObjectWidth, PDFFlowFormXObjectContent.FormXObjectHeight properties) is a percentage of the available space, false is the formXObject size is given in absolute values.

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.

VerticalAlign¶

Gets or sets the vertical align.

public PDFGraphicAlign VerticalAlign { get; set; }

Property Value

PDFGraphicAlign
The formXObject alignment on vertical relative to available space.

Methods¶

GetContentHeight(Double)¶

Gets the content height.

public double GetContentHeight(double width)

Parameters

width Double
The width for which the content height is computed.

Returns

Double
The height of the content for the specified width.

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;