WordProcessingInspectionPackage

WordProcessingInspectionPackage class

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

public sealed class WordProcessingInspectionPackage : CustomPackage

Properties

Name Description
Comments { get; } Gets an array of the user comments.
Count { get; } Gets the number of metadata properties.
DigitalSignatures { get; } Gets an array of digital signatures presented in the document.
Fields { get; } Gets an array of document fields.
HiddenText { get; } Gets an array of hidden text fragments extracted from the document.
Item { get; } Gets the MetadataProperty with the specified name.
Keys { get; } Gets a collection of the metadata property names.
MetadataType { get; } Gets the metadata type.
PropertyDescriptors { get; } Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
Revisions { get; } Gets an array of digital signatures presented in the document.

Methods

Name Description
AcceptAllRevisions() Accepts all detected revisions in the document.
virtual AddProperties(Func<MetadataProperty, bool>, PropertyValue) Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.
ClearComments() Removes all detected user comments from the document.
ClearFields() Removes all detected fields from the document.
ClearHiddenText() Removes all hidden text fragments from the document.
Contains(string) Determines whether the package contains a metadata property with the specified name.
virtual FindProperties(Func<MetadataProperty, bool>) Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well.
GetEnumerator() Returns an enumerator that iterates through the collection.
RejectAllRevisions() Rejects all detected revisions in the document.
override RemoveProperties(Func<MetadataProperty, bool>) Removes metadata properties satisfying the specified predicate.
override Sanitize() Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
virtual SetProperties(Func<MetadataProperty, bool>, PropertyValue) Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of AddProperties and UpdateProperties. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package.
virtual UpdateProperties(Func<MetadataProperty, bool>, PropertyValue) Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

Remarks

Learn more

Examples

This code sample shows how to update inspection properties in a WordProcessing document.

using (Metadata metadata = new Metadata(Constants.InputDoc))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    root.InspectionPackage.ClearComments();
    root.InspectionPackage.AcceptAllRevisions();
    root.InspectionPackage.ClearFields();
    root.InspectionPackage.ClearHiddenText();

    metadata.Save(Constants.OutputDoc);
}

See Also

WordProcessingFormat WordProcessingPackage