PdfRootPackage class Leave feedback

On this page

PdfRootPackage class

Represents the root package allowing working with metadata in a PDF document.

Inheritance: PdfRootPackage → RootMetadataPackage → MetadataPackage

The PdfRootPackage 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.
file_type	Gets the file type metadata package.
inspection_package	Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.
document_statistics	Gets the document statistics package.
xmp_package	Gets or sets the XMP metadata package.
document_properties

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.

Remarks

Learn more | | | |

Example

This code sample shows how to extract built-in metadata properties from a PDF document.

See Also

module groupdocs.metadata.formats.document
class MetadataPackage
class PdfRootPackage
class RootMetadataPackage

We value your opinion. Your feedback will help us improve our documentation.