Excel.DocumentProperties class
Represents workbook properties.
- Extends
Remarks
Properties
| author | The author of the workbook. |
| category | The category of the workbook. |
| comments | The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. |
| company | The company of the workbook. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| creation |
Gets the creation date of the workbook. |
| custom | Gets the collection of custom properties of the workbook. |
| keywords | The keywords of the workbook. |
| last |
Gets the last author of the workbook. |
| manager | The manager of the workbook. |
| revision |
Gets the revision number of the workbook. |
| subject | The subject of the workbook. |
| title | The title of the workbook. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
Property Details
author
category
The category of the workbook.
category: string;Property Value
string
Remarks
comments
The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
comments: string;Property Value
string
Remarks
company
The company of the workbook.
company: string;Property Value
string
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
creationDate
Gets the creation date of the workbook.
readonly creationDate: Date;Property Value
Date
Remarks
custom
Gets the collection of custom properties of the workbook.
readonly custom: Excel.CustomPropertyCollection;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Load the keys and values of all custom properties.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.load(["key", "value"]);
await context.sync();
// Log each custom property to the console.
// Note that your document may have more properties than those you have set using this snippet.
customDocProperties.items.forEach((property) => {
console.log(`${property.key}:${property.value}`);
});
});
keywords
The keywords of the workbook.
keywords: string;Property Value
string
Remarks
lastAuthor
Gets the last author of the workbook.
readonly lastAuthor: string;Property Value
string
Remarks
manager
The manager of the workbook.
manager: string;Property Value
string
Remarks
revisionNumber
Gets the revision number of the workbook.
revisionNumber: number;Property Value
number
Remarks
subject
The subject of the workbook.
subject: string;Property Value
string
Remarks
title
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.DocumentProperties;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentProperties;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.DocumentProperties): void;Parameters
- properties
- Excel.DocumentProperties
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.DocumentProperties object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DocumentPropertiesData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.DocumentPropertiesData;