pdftools_sdk.pdf.metadata_settings

Classes

MetadataSettings()

It allows you to set and update individual metadata properties.
class pdftools_sdk.pdf.metadata_settings.MetadataSettings[source]

Bases: _NativeObject

It allows you to set and update individual metadata properties. Any metadata properties that have been explicitly set are included in the output document.

__init__()[source]
property title: str | None

The title of the document or resource.

This property corresponds to the “dc:title” entry in the XMP metadata and to the “Title” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property author: str | None

The name of the person who created the document or resource.

This property corresponds to the “dc:creator” entry in the XMP metadata and to the “Author” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property subject: str | None

The subject of the document or resource.

This property corresponds to the “dc:description” entry in the XMP metadata and to the “Subject” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property keywords: str | None

Keywords associated with the document or resource.

Keywords can be separated by:

  • carriage return / line feed

  • comma

  • semicolon

  • tab

  • double space

This property corresponds to the “pdf:Keywords” entry in the XMP metadata and to the “Keywords” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property creator: str | None

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the “xmp:CreatorTool” entry in the XMP metadata and to the “Creator” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property producer: str | None

The application that created the PDF

If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

This property corresponds to the “pdf:Producer” entry in the XMP metadata and to the “Producer” entry in the document information dictionary.

Returns:

Optional[str]

Raises:

StateError – If the metadata settings have already been closed

property creation_date: datetime | None

The date and time the document or resource was originally created.

This property corresponds to the “xmp:CreateDate” entry in the XMP metadata and to the “CreationDate” entry in the document information dictionary.

Returns:

Optional[datetime]

Raises:

StateError – If the metadata settings have already been closed

property modification_date: datetime | None

The date and time the document or resource was most recently modified.

This property corresponds to the “xmp:ModifyDate” entry in the XMP metadata and to the “ModDate” entry in the document information dictionary.

Returns:

Optional[datetime]

Raises:

StateError – If the metadata settings have already been closed