SpreadsheetPackage class

SpreadsheetPackage class

Represents a native metadata package in a spreadsheet.

Inheritance: SpreadsheetPackage → DocumentPackage → CustomPackage → MetadataPackage

The SpreadsheetPackage type exposes the following members:

Properties

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.
language Gets or sets the document language.
author Gets or sets the document author.
category Gets or sets the category.
comments Gets or sets the comments.
company Gets or sets the company.
content_status Gets or sets the content status.
content_type Gets or sets the content type.
created_time Gets or sets the document created date.
total_editing_time Gets or sets the total editing time in minutes.
hyperlink_base Gets or sets the hyperlink base.
keywords Gets or sets the keywords.
last_saved_time Gets or sets the time of the last saving in UTC.
last_printed_date Gets or sets the last printed date in UTC.
last_saved_by Gets or sets the name of the last author.
manager Gets or sets the manager.
name_of_application Gets or sets the name of application.
revision Gets or sets the document revision number.
subject Gets or sets the subject.
template Gets or sets the document template name.
title Gets or sets the title of the document.
version Gets or sets the version number of the application that created the document.
content_type_properties Gets the metadata package containing the content type properties.

Methods

Method Description
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
contains Determines whether the package contains a metadata property with the specified name.
find_properties Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties Removes metadata properties satisfying a specification.
add_properties Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties 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 Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.
remove Removes a writable metadata property by the specified name.
clear Removes all writable metadata properties from the package.
clear_built_in_properties Removes all built-in metadata properties.
clear_custom_properties Removes all custom metadata properties.

Remarks

Learn more | | |

Example

This example shows how to update built-in metadata properties in a spreadsheet.

See Also

SpreadsheetInspectionPackage class SpreadsheetRootPackage class