SpreadsheetPackage

SpreadsheetPackage class

Represents a native metadata package in a spreadsheet.

public class SpreadsheetPackage : DocumentPackage

Properties

Name Description
Author { get; set; } Gets or sets the document author.
Category { get; set; } Gets or sets the category.
Comments { get; set; } Gets or sets the comments.
Company { get; set; } Gets or sets the company.
ContentStatus { get; set; } Gets or sets the content status.
ContentType { get; set; } Gets or sets the content type.
ContentTypeProperties { get; } Gets the metadata package containing the content type properties.
Count { get; } Gets the number of metadata properties.
CreatedTime { get; set; } Gets or sets the document created date.
HyperlinkBase { get; set; } Gets or sets the hyperlink base.
Item { get; } Gets the MetadataProperty with the specified name.
Keys { get; } Gets a collection of the metadata property names.
Keywords { get; set; } Gets or sets the keywords.
Language { get; set; } Gets or sets the document language.
LastPrintedDate { get; set; } Gets or sets the last printed date in UTC.
LastSavedBy { get; set; } Gets or sets the name of the last author.
LastSavedTime { get; set; } Gets or sets the time of the last saving in UTC.
Manager { get; set; } Gets or sets the manager.
MetadataType { get; } Gets the metadata type.
NameOfApplication { get; set; } Gets or sets the name of application.
PropertyDescriptors { get; } Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
Revision { get; set; } Gets or sets the document revision number.
Subject { get; set; } Gets or sets the subject.
Template { get; set; } Gets or sets the document template name.
Title { get; set; } Gets or sets the title of the document.
TotalEditingTime { get; set; } Gets or sets the total editing time in minutes.
Version { get; set; } Gets or sets the version number of the application that created the document.

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.
Clear() Removes all writable metadata properties from the package.
ClearBuiltInProperties() Removes all built-in metadata properties.
ClearCustomProperties() Removes all custom metadata properties.
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.
Remove(string) Removes a writable metadata property by the specified name.
virtual RemoveProperties(Func<MetadataProperty, bool>) Removes metadata properties satisfying the specified predicate.
virtual Sanitize() Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
Set(string, bool) Adds or replaces the metadata property with the specified name.
Set(string, DateTime) Adds or replaces the metadata property with the specified name.
Set(string, double) Adds or replaces the metadata property with the specified name.
Set(string, int) Adds or replaces the metadata property with the specified name.
Set(string, string) Adds or replaces the metadata property with the specified name.
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 example shows how to update built-in metadata properties in a spreadsheet.

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

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedTime = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Category = "test category";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputXlsx);
}

See Also

SpreadsheetInspectionPackage SpreadsheetRootPackage