[]
        
(Showing Draft Content)

DocumentInfo

Class: DocumentInfo

Contains information about the document. This information includes the document author, title, keywords, etc.

Extends

Constructors

Constructor

new DocumentInfo(docInfoProperties?): DocumentInfo;

Creates a new DocumentInfo object with specified properties.

Parameters

docInfoProperties?

DocumentInfoProperties

The optional settings for creating DocumentInfo.

Returns

DocumentInfo

Overrides

ObjectBase.constructor

Constructor

new DocumentInfo(om, docInfoProperties?): DocumentInfo;

Creates a new DocumentInfo object with specified properties.

Parameters

om

ObjectManager

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

docInfoProperties?

DocumentInfoProperties

The optional settings for creating DocumentInfo.

Returns

DocumentInfo

Overrides

ObjectBase.constructor

Accessors

author

Get Signature

get author(): string;

Gets or sets the name of the person that created the document.

Returns

string

Set Signature

set author(value): void;

Gets or sets the name of the person that created the document.

Parameters
value

string

Returns

void


createDate

Get Signature

get createDate(): PdfDateTime;

Gets or sets the creation date and time of the document.

Returns

PdfDateTime

Set Signature

set createDate(date): void;

Gets or sets the creation date and time of the document.

Parameters
date

PdfDateTime

Returns

void


creator

Get Signature

get creator(): string;

Gets or sets the name of the application that created the original document.

Returns

string

Set Signature

set creator(value): void;

Gets or sets the name of the application that created the original document.

Parameters
value

string

Returns

void


id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id


keywords

Get Signature

get keywords(): string;

Gets or sets keywords (separated by comma) associated with the document.

Returns

string

Set Signature

set keywords(value): void;

Gets or sets keywords (separated by comma) associated with the document.

Parameters
value

string

Returns

void


modifyDate

Get Signature

get modifyDate(): PdfDateTime;

Gets or sets the date and time the document was most recently modified.

Returns

PdfDateTime

Set Signature

set modifyDate(date): void;

Gets or sets the date and time the document was most recently modified.

Parameters
date

PdfDateTime

Returns

void


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om


producer

Get Signature

get producer(): string;

Gets or sets the name of the application that created the document.

Returns

string

Set Signature

set producer(value): void;

Gets or sets the name of the application that created the document.

Parameters
value

string

Returns

void


subject

Get Signature

get subject(): string;

Gets or sets the subject of the document.

Returns

string

Set Signature

set subject(value): void;

Gets or sets the subject of the document.

Parameters
value

string

Returns

void


title

Get Signature

get title(): string;

Gets or sets the title of the document.

Returns

string

Set Signature

set title(value): void;

Gets or sets the title of the document.

Parameters
value

string

Returns

void

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


reset()

reset(): void;

Resets properties of this DocumentInfo object to default values.

Returns

void