WordProcessingInspectionPackage class

WordProcessingInspectionPackage class

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

Learn more

The WordProcessingInspectionPackage type exposes the following members:

Methods

Method Description
accept_all_revisions Accepts all detected revisions in the document.
clear_comments Removes all detected user comments from the document.
clear_fields Removes all detected fields from the document.
clear_hidden_text Removes all hidden text fragments from the document.
reject_all_revisions Rejects all detected revisions in 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 as well.
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
comments The user comments.
digital_signatures The digital signatures presented in the document.
fields The document fields as a list of document fields.
hidden_text The hidden text fragments extracted from the document as a list of strings.
revisions The digital signatures presented in the document.
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, WordProcessingRootPackage, Constants

with Metadata(Constants.InputDoc) as metadata:
    root = metadata.get_root_package(WordProcessingRootPackage)

    # Clear various inspection elements
    root.inspection_package.clear_comments()
    root.inspection_package.accept_all_revisions()
    root.inspection_package.clear_fields()
    root.inspection_package.clear_hidden_text()

    metadata.save(Constants.OutputDoc)

See Also