WordProcessingRootPackage class

WordProcessingRootPackage class

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

Learn more

The WordProcessingRootPackage type exposes the following members:

Methods

Method Description
update_document_statistics Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata 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)
remove_properties Removes metadata properties satisfying the specified predicate. (inherited from MetadataPackage)
remove_properties_func (inherited from MetadataPackage)
sanitize Removes writable metadata properties from the package recursively, affecting all nested packages as well. (inherited from RootMetadataPackage)
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
document_statistics The document statistics package.
dublin_core_package The Dublin Core metadata package extracted from the document.
file_type The file type metadata package.
inspection_package The inspection package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.
count The number of metadata properties. (inherited from MetadataPackage)
document_properties (inherited from DocumentRootPackage)
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.InputDocx) as metadata:
    root = metadata.get_root_package(WordProcessingRootPackage)

    print(root.document_properties.author)
    print(root.document_properties.created_time)
    print(root.document_properties.company)
    print(root.document_properties.category)
    print(root.document_properties.keywords)
    # ...

See Also