PdfInspectionPackage

PdfInspectionPackage class

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

public sealed class PdfInspectionPackage : CustomPackage

Properties

Name Description
Annotations { get; } Gets an array of the annotations.
Attachments { get; } Gets an array of the attachments.
Bookmarks { get; } Gets an array of the bookmarks.
Count { get; } Gets the number of metadata properties.
DigitalSignatures { get; } Gets an array of the digital signatures.
Fields { get; } Gets an array of the form fields.
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.

Methods

Name Description
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.
ClearAnnotations() Removes all detected annotations from the document.
ClearAttachments() Removes all detected attachments from the document.
ClearBookmarks() Removes all detected bookmarks from the document.
ClearDigitalSignatures() Removes all detected digital signatures from the document.
ClearFields() Removes all detected form fields 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.
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 demonstrates how to remove the inspection properties in a PDF document.

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

    root.InspectionPackage.ClearAnnotations();
    root.InspectionPackage.ClearAttachments();
    root.InspectionPackage.ClearFields();
    root.InspectionPackage.ClearBookmarks();
    root.InspectionPackage.ClearDigitalSignatures();

    metadata.Save(Constants.OutputPdf);
}

See Also

PdfFormField PdfPackage