[]

FormXObject

Class: FormXObject

Represents a PDF Form XObject.

Extends

ObjectBase

Constructors

Constructor

new FormXObject(doc, bounds): FormXObject;

Initializes a new instance of the FormXObject class.

Parameters

doc

The PdfDocument in which the new FormXObject will be used.

bounds

The bounds of the FormXObject.

Returns

FormXObject

Overrides

ObjectBase.constructor

Constructor

new FormXObject(doc, page): FormXObject;

Initializes a new instance of the FormXObject class using a specified page as the source.

Note that the FormXObject.matrix and FormXObject.bounds properties are automatically adjusted to take into account the PdfPage user unit of the source page.

Parameters

doc

The target PdfDocument where the new FormXObject will be used.

page

The source PdfPage the content of which is copied to the FormXObject. The source page can belong to another document.

Returns

FormXObject

Overrides

ObjectBase.constructor

Constructor

new FormXObject(
   om, 
   doc, 
   bounds): FormXObject;

Initializes a new instance of the FormXObject class.

Parameters

om

ObjectManager

An object manager that controls the lifetime of the FormXObject object.

doc

The PdfDocument in which the new FormXObject will be used.

bounds

The bounds of the FormXObject.

Returns

FormXObject

Overrides

ObjectBase.constructor

Constructor

new FormXObject(
   om, 
   doc, 
   page): FormXObject;

Initializes a new instance of the FormXObject class using a specified page as the source.

Note that the FormXObject.matrix and FormXObject.bounds properties are automatically adjusted to take into account the PdfPage user unit of the source page.

Parameters

om

ObjectManager

An object manager that controls the lifetime of the FormXObject object.

doc

The target PdfDocument where the new FormXObject will be used.

page

The source PdfPage the content of which is copied to the FormXObject. The source page can belong to another document.

Returns

FormXObject

Overrides

ObjectBase.constructor

Accessors

associatedFiles

Get Signature

get associatedFiles(): AssociatedFiles;

Gets the list of embedded files associated with this FormXObject.

Returns

AssociatedFiles

bounds

Get Signature

get bounds(): Rect;

Gets the bounds of this FormXObject.

Returns

Set Signature

set bounds(value): void;

Sets the bounds of this FormXObject.

Parameters

value

Returns

void

context

Get Signature

get context(): PdfContext;

Gets an instance of PdfContext that can be used to generate content of this FormXObject.

Returns

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this object.

Returns

hasAssociatedFiles

Get Signature

get hasAssociatedFiles(): boolean;

Gets a value indicating whether the FormXObject.associatedFiles collection is not empty.

Returns

boolean

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

matrix

Get Signature

get matrix(): number[];

Gets the matrix that maps form space into user space. The matrix consists of six numbers (m11, m12, m21, m22, m31, m32).

Returns

number[]

Set Signature

set matrix(value): void;

Sets the matrix that maps form space into user space. The matrix consists of six numbers (m11, m12, m21, m22, m31, m32).

Parameters

value

number[]

Returns

void

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind