Class DocumentInfo

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

Hierarchy (View Summary)

ObjectBase
- DocumentInfo

Index

Constructors

constructor

new DocumentInfo(docInfoProperties?: DocumentInfoProperties): DocumentInfo
Creates a new DocumentInfo object with specified properties.
Parameters
- OptionaldocInfoProperties: DocumentInfoProperties
  The optional settings for creating DocumentInfo.
Returns DocumentInfo
Overrides ObjectBase.constructor
new DocumentInfo(
om: ObjectManager,
docInfoProperties?: DocumentInfoProperties,
): DocumentInfo
Creates a new DocumentInfo object with specified properties.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the DocumentInfo object.
- OptionaldocInfoProperties: DocumentInfoProperties
  The optional settings for creating DocumentInfo.
Returns DocumentInfo
Overrides ObjectBase.constructor

Accessors

author

get author(): string | null
Gets or sets the name of the person that created the document.

Returns string | null
set author(value: string | null): void
Gets or sets the name of the person that created the document.
Parameters
- value: string | null
Returns void

createDate

get createDate(): PdfDateTime | null
Gets or sets the creation date and time of the document.

Returns PdfDateTime | null
set createDate(date: PdfDateTime | null): void
Gets or sets the creation date and time of the document.
Parameters
- date: PdfDateTime | null
Returns void

creator

get creator(): string | null
Gets or sets the name of the application that created the original document.

Returns string | null
set creator(value: string | null): void
Gets or sets the name of the application that created the original document.
Parameters
- value: string | null
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

keywords

get keywords(): string | null
Gets or sets keywords (separated by comma) associated with the document.

Returns string | null
set keywords(value: string | null): void
Gets or sets keywords (separated by comma) associated with the document.
Parameters
- value: string | null
Returns void

modifyDate

get modifyDate(): PdfDateTime | null
Gets or sets the date and time the document was most recently modified.

Returns PdfDateTime | null
set modifyDate(date: PdfDateTime | null): void
Gets or sets the date and time the document was most recently modified.
Parameters
- date: PdfDateTime | null
Returns void

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

producer

get producer(): string | null
Gets or sets the name of the application that created the document.

Returns string | null
set producer(value: string | null): void
Gets or sets the name of the application that created the document.
Parameters
- value: string | null
Returns void

subject

get subject(): string | null
Gets or sets the subject of the document.

Returns string | null
set subject(value: string | null): void
Gets or sets the subject of the document.
Parameters
- value: string | null
Returns void

title

get title(): string | null
Gets or sets the title of the document.

Returns string | null
set title(value: string | null): void
Gets or sets the title of the document.
Parameters
- value: string | null
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: ObjectManager): 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

Class DocumentInfo

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DocumentInfo

Parameters

Returns DocumentInfo

Accessors

author

Returns string | null

Parameters

Returns void

createDate

Returns PdfDateTime | null

Parameters

Returns void

creator

Returns string | null

Parameters

Returns void

id

Returns number

keywords

Returns string | null

Parameters

Returns void

modifyDate

Returns PdfDateTime | null

Parameters

Returns void

om

Returns ObjectManager

producer

Returns string | null

Parameters

Returns void

subject

Returns string | null

Parameters

Returns void

title

Returns string | null

Parameters

Returns void

Methods

free

Returns void

rebind

Parameters

Returns void

reset

Returns void

Settings

On This Page