SpreadsheetInspectionPackage

SpreadsheetInspectionPackage class

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

public sealed class SpreadsheetInspectionPackage : 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.
HiddenSheets { get; } Gets an array of the hidden sheets.
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.
ClearComments() Removes all detected user comments from the spreadsheet.
ClearDigitalSignatures() Removes all detected digital signatures from the spreadsheet.
ClearHiddenSheets() Removes all detected hidden sheets from the spreadsheet.
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 shows hot to remove inspection properties from a spreadsheet.

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

    root.InspectionPackage.ClearComments();
    root.InspectionPackage.ClearDigitalSignatures();
    root.InspectionPackage.ClearHiddenSheets();

    metadata.Save(Constants.OutputXlsx);
}

See Also

SpreadsheetFormat SpreadsheetPackage