PdfInspectionPackage class

PdfInspectionPackage class

Contains information about PDF document parts that can be considered as metadata in some cases.

Learn more

The PdfInspectionPackage type exposes the following members:

Methods

Method Description
clear_annotations Removes all detected annotations from the document.
clear_attachments Removes all detected attachments from the document.
clear_bookmarks Removes all detected bookmarks from the document.
clear_digital_signatures Removes all detected digital signatures from the document.
clear_fields Removes all detected form fields from the document.
remove_properties Removes metadata properties satisfying the specified predicate.
remove_properties_func
sanitize Removes writable metadata properties from the package, recursively affecting all nested packages.
add_properties Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. (inherited from MetadataPackage)
add_properties_func (inherited from MetadataPackage)
contains Returns True if the package contains a metadata property with the specified name; otherwise, False. (inherited from MetadataPackage)
contains_file (inherited from MetadataPackage)
contains_string (inherited from MetadataPackage)
find_properties Finds metadata properties that satisfy the specified predicate, searching recursively through all nested packages. (inherited from MetadataPackage)
find_properties_func (inherited from MetadataPackage)
get (inherited from MetadataPackage)
get_enumerator Returns an enumerator that iterates through the collection. (inherited from MetadataPackage)
get_file (inherited from MetadataPackage)
get_string (inherited from MetadataPackage)
set_properties Sets known metadata properties satisfying the specified predicate. (inherited from MetadataPackage)
set_properties_func (inherited from MetadataPackage)
update_properties Updates known metadata properties that satisfy the specified predicate, recursively affecting all nested packages. (inherited from MetadataPackage)
update_properties_func (inherited from MetadataPackage)

Properties

Property Description
annotations The annotations as a list.
attachments The attachments of the PDF inspection package as a list.
bookmarks The bookmarks as a list.
digital_signatures The digital signatures as a list.
fields The form fields as an array.
count The number of metadata properties. (inherited from MetadataPackage)
keys The collection of metadata property names. (inherited from MetadataPackage)
know_property_descriptors The collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. (inherited from MetadataPackage)
metadata_type The metadata type of the package. (inherited from MetadataPackage)
property_descriptors The collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. (inherited from MetadataPackage)

Example

from groupdocs.metadata import Metadata, PdfRootPackage, Constants

with Metadata(Constants.SignedPdf) as metadata:
    root = metadata.get_root_package(PdfRootPackage)

    root.inspection_package.clear_annotations()
    root.inspection_package.clear_attachments()
    root.inspection_package.clear_fields()
    root.inspection_package.clear_bookmarks()
    root.inspection_package.clear_digital_signatures()

    metadata.save(Constants.OutputPdf)

See Also