WordProcessingInspectionPackage class
Leave feedback
On this page
Contains information about document parts that can be considered as metadata in some cases.
Inheritance: WordProcessingInspectionPackage →
CustomPackage →
MetadataPackage
The WordProcessingInspectionPackage type exposes the following members:
| 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. |
| comments | Gets an array of the user comments. |
| fields | Gets an array of document fields. |
| hidden_text | Gets an array of hidden text fragments extracted from the document. |
| digital_signatures | Gets an array of digital signatures presented in the document. |
| revisions | Gets an array of digital signatures presented in the document. |
| 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. |
clear_comments(self) |
Removes all detected user comments from the document. |
clear_fields(self) |
Removes all detected fields from the document. |
clear_hidden_text(self) |
Removes all hidden text fragments from the document. |
accept_all_revisions(self) |
Accepts all detected revisions in the document. |
reject_all_revisions(self) |
Rejects all detected revisions in the document. |
Learn more | | |
This code sample shows how to update inspection properties in a WordProcessing document.
- module
groupdocs.metadata.formats.document - class
CustomPackage - class
MetadataPackage - class
WordProcessingInspectionPackage
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.