Class Metadata

Represents XMP metadata associated with a PDF document.

Hierarchy (View Summary)

ObjectBase
- Metadata

Index

Constructors

constructor

Methods

addProperty free rebind

Constructors

constructor

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

Accessors

contributors

get contributors(): string[]
Gets or sets the list of document contributors. Maps to Dublin Core 'contributor' property.

Returns string[]
set contributors(value: string[]): void
Gets or sets the list of document contributors. Maps to Dublin Core 'contributor' property.
Parameters
- value: string[]
Returns void

copyright

get copyright(): string
Gets or sets the document copyright. Maps to Dublin Core 'rights' property.

Returns string
set copyright(value: string): void
Gets or sets the document copyright. Maps to Dublin Core 'rights' property.
Parameters
- value: string
Returns void

coverage

get coverage(): string
Gets or sets the document coverage. Maps to Dublin Core 'coverage' property.

Returns string
set coverage(value: string): void
Gets or sets the document coverage. Maps to Dublin Core 'coverage' property.
Parameters
- value: string
Returns void

createDate

get createDate(): Date | null
Gets or sets the creation date. Maps to XMP 'CreateDate' property. If null, the current date/time is used.

Returns Date | null
set createDate(value: Date | null): void
Gets or sets the creation date. Maps to XMP 'CreateDate' property. If null, the current date/time is used.
Parameters
- value: Date | null
Returns void

creators

get creators(): string[]
Gets or sets the list of document creators. Maps to Dublin Core 'creator' property.

Returns string[]
set creators(value: string[]): void
Gets or sets the list of document creators. Maps to Dublin Core 'creator' property.
Parameters
- value: string[]
Returns void

creatorTool

get creatorTool(): string
Gets or sets the creator tool. In PDF/A compatible documents this value should be the same as DocumentInfo.creator.

Returns string
set creatorTool(value: string): void
Gets or sets the creator tool. In PDF/A compatible documents this value should be the same as DocumentInfo.creator.
Parameters
- value: string
Returns void

dates

get dates(): string[]
Gets or sets the list of document dates. Maps to Dublin Core 'date' property.

Returns string[]
set dates(value: string[]): void
Gets or sets the list of document dates. Maps to Dublin Core 'date' property.
Parameters
- value: string[]
Returns void

description

get description(): string
Gets or sets the document description. Maps to Dublin Core 'description' property.

Returns string
set description(value: string): void
Gets or sets the document description. Maps to Dublin Core 'description' property.
Parameters
- value: string
Returns void

id

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

Returns number
Inherited from ObjectBase.id

identifier

get identifier(): string
Gets or sets the document identifier. Maps to Dublin Core 'identifier' property.

Returns string
set identifier(value: string): void
Gets or sets the document identifier. Maps to Dublin Core 'identifier' property.
Parameters
- value: string
Returns void

keywords

get keywords(): string[]
Gets or sets the list of document keywords, or subjects. Maps to Dublin Core 'subject' property.

Returns string[]
set keywords(value: string[]): void
Gets or sets the list of document keywords, or subjects. Maps to Dublin Core 'subject' property.
Parameters
- value: string[]
Returns void

languages

get languages(): string[]
Gets or sets the list of document languages. Maps to Dublin Core 'language' property.

Returns string[]
set languages(value: string[]): void
Gets or sets the list of document languages. Maps to Dublin Core 'language' property.
Parameters
- value: string[]
Returns void

metadataDate

get metadataDate(): Date | null
Gets or sets the metadata date. Maps to XMP 'MetadataDate' property. If null, the current date/time is used.

Returns Date | null
set metadataDate(value: Date | null): void
Gets or sets the metadata date. Maps to XMP 'MetadataDate' property. If null, the current date/time is used.
Parameters
- value: Date | null
Returns void

modifyDate

get modifyDate(): Date | null
Gets or sets the modification date. Maps to XMP 'ModifyDate' property. If null, the current date/time is used.

Returns Date | null
set modifyDate(value: Date | null): void
Gets or sets the modification date. Maps to XMP 'ModifyDate' property. If null, the current date/time is used.
Parameters
- value: Date | null
Returns void

om

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

Returns ObjectManager
Inherited from ObjectBase.om

pdfA

get pdfA(): PdfAConformanceLevel
Gets or sets the PDF/A conformance version.

Returns PdfAConformanceLevel
set pdfA(value: PdfAConformanceLevel): void
Gets or sets the PDF/A conformance version.
Parameters
- value: PdfAConformanceLevel
Returns void

pdfUa

get pdfUa(): number | null
Gets or sets the PDF/UA conformance version. Null indicates that the document is not PDF/UA compliant.

Returns number | null
set pdfUa(value: number | null): void
Gets or sets the PDF/UA conformance version. Null indicates that the document is not PDF/UA compliant.
Parameters
- value: number | null
Returns void

producer

get producer(): string
Gets or sets the document's producer. Maps to PDF 'Producer' property.

Returns string
set producer(value: string): void
Gets or sets the document's producer. Maps to PDF 'Producer' property.
Parameters
- value: string
Returns void

publishers

get publishers(): string[]
Gets or sets the list of document publishers. Maps to Dublin Core 'publisher' property.

Returns string[]
set publishers(value: string[]): void
Gets or sets the list of document publishers. Maps to Dublin Core 'publisher' property.
Parameters
- value: string[]
Returns void

readOnly

get readOnly(): boolean
Gets or sets a value indicating whether the metadata is marked as read-only.

Returns boolean
set readOnly(value: boolean): void
Gets or sets a value indicating whether the metadata is marked as read-only.
Parameters
- value: boolean
Returns void

relations

get relations(): string[]
Gets or sets the list of document relations. Maps to Dublin Core 'relation' property.

Returns string[]
set relations(value: string[]): void
Gets or sets the list of document relations. Maps to Dublin Core 'relation' property.
Parameters
- value: string[]
Returns void

source

get source(): string
Gets or sets the document source. Maps to Dublin Core 'source' property.

Returns string
set source(value: string): void
Gets or sets the document source. Maps to Dublin Core 'source' property.
Parameters
- value: string
Returns void

title

get title(): string
Gets or sets the document's title. Maps to Dublin Core 'title' property.

Returns string
set title(value: string): void
Gets or sets the document's title. Maps to Dublin Core 'title' property.
Parameters
- value: string
Returns void

types

get types(): string[]
Gets or sets the list of document types. Maps to Dublin Core 'type' property.

Returns string[]
set types(value: string[]): void
Gets or sets the list of document types. Maps to Dublin Core 'type' property.
Parameters
- value: string[]
Returns void

userProps

get userProps(): MetadataUserProp[]
Gets or sets the list of document custom properties.

Returns MetadataUserProp[]
set userProps(props: MetadataUserProp[]): void
Gets or sets the list of document custom properties.
Parameters
- props: MetadataUserProp[]
Returns void

Methods

addProperty

addProperty(namespace: UserPropNamespace, name: string, value: string): void
Adds a property to metadata.
Parameters
- namespace: UserPropNamespace
  The XML namespace.
- name: string
  The property name.
- value: string
  The property value.
Returns void

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

Class Metadata

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Metadata

Parameters

Returns Metadata

Accessors

contributors

Returns string[]

Parameters

Returns void

copyright

Returns string

Parameters

Returns void

coverage

Returns string

Parameters

Returns void

createDate

Returns Date | null

Parameters

Returns void

creators

Returns string[]

Parameters

Returns void

creatorTool

Returns string

Parameters

Returns void

dates

Returns string[]

Parameters

Returns void

description

Returns string

Parameters

Returns void

id

Returns number

identifier

Returns string

Parameters

Returns void

keywords

Returns string[]

Parameters

Returns void

languages

Returns string[]

Parameters

Returns void

metadataDate

Returns Date | null

Parameters

Returns void

modifyDate

Returns Date | null

Parameters

Returns void

om

Returns ObjectManager

pdfA

Returns PdfAConformanceLevel

Parameters

Returns void

pdfUa

Returns number | null

Parameters

Returns void

producer

Returns string

Parameters