PdfPackage class
PdfPackage class
Represents native metadata in a PDF document.
Inheritance: PdfPackage →
DocumentPackage →
CustomPackage →
MetadataPackage
The PdfPackage type exposes the following members:
Properties
| Property | Description |
|---|---|
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets or sets the document author. |
| created_date | Gets or sets the date of document creation. |
| creator | Gets the creator of the document. |
| keywords | Gets or sets the keywords. |
| modified_date | Gets or sets the date of the last modification. |
| producer | Gets the document producer. |
| subject | Gets or sets the subject of the document. |
| title | Gets or sets the title of the document. |
| trapped_flag | Gets or sets the trapped flag. |
Methods
| Method | Description |
|---|---|
contains(self, property_name) |
Determines whether the package contains a metadata property with the specified name. |
find_properties(self, specification) |
Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well. |
update_properties(self, specification, value) |
Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well. |
remove_properties(self, specification) |
Removes metadata properties satisfying a specification. |
add_properties(self, specification, value) |
Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. |
set_properties(self, specification, value) |
Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package. |
sanitize(self) |
Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well. |
remove(self, property_name) |
Removes a writable metadata property by the specified name. |
clear(self) |
Removes all writable metadata properties from the package. |
clear_built_in_properties(self) |
Removes all built-in metadata properties. |
clear_custom_properties(self) |
Removes all custom metadata properties. |
set(self, property_name, value) |
Adds or replaces the metadata property with the specified name. |
Remarks
Learn more | | |
Example
This code snippet demonstrates how to update built-in metadata properties in a PDF document.
See Also
- module
groupdocs.metadata.formats.document - class
CustomPackage - class
DocumentPackage - class
MetadataPackage - class
PdfPackage