[]
        
(Showing Draft Content)

McrContentItemLink

Class: McrContentItemLink

Represents a Marked-Content Sequence as a content item in a PDF structure tree (the MCR PDF object).

Extends

Constructors

Constructor

new McrContentItemLink(om): McrContentItemLink;

Creates a new McrContentItemLink.

Parameters

om

ObjectManager

Returns

McrContentItemLink

Overrides

RContentItemLink.constructor

Constructor

new McrContentItemLink(): McrContentItemLink;

Creates a new McrContentItemLink.

Returns

McrContentItemLink

Overrides

RContentItemLink.constructor

Accessors

contentStreamOwner

Get Signature

get contentStreamOwner(): ContentItem;

Gets the object owning the content stream identified by the McrContentItemLink#formXObject property, or null if there is none or the target type is not yet supported.

Returns

ContentItem

Set Signature

set contentStreamOwner(value): void;

Sets the object owning the content stream identified by the McrContentItemLink#formXObject property.

Parameters
value

ContentItem

Returns

void


formXObject

Get Signature

get formXObject(): FormXObject;

Gets the FormXObject containing the marked-content sequence. This entry should be present only if the marked-content sequence resides in a content stream other than the content stream of the page - for example, in a form XObject or an annotation's appearance stream.

Returns

FormXObject

Set Signature

set formXObject(value): void;

Sets the FormXObject containing the marked-content sequence. This entry should be present only if the marked-content sequence resides in a content stream other than the content stream of the page - for example, in a form XObject or an annotation's appearance stream.

Parameters
value

FormXObject

Returns

void


id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

RContentItemLink.id


mcid

Get Signature

get mcid(): number;

Gets the marked-content identifier of the marked-content sequence within its content stream.

Returns

number

Set Signature

set mcid(value): void;

Sets the marked-content identifier of the marked-content sequence within its content stream.

Parameters
value

number

Returns

void


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

RContentItemLink.om


page

Get Signature

get page(): PdfPage;

Gets the PdfPage object where this content item is located.

Returns

PdfPage

Set Signature

set page(value): void;

Sets the PdfPage object where this content item is located.

Parameters
value

PdfPage

Returns

void

Inherited from

RContentItemLink.page

Methods

free()

free(): void;

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

Returns

void

Inherited from

RContentItemLink.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

RContentItemLink.rebind