Excel.DocumentProperties class

Represents workbook properties.

Extends

Remarks

[ API set: ExcelApi 1.7 ]

Properties

author

The author of the workbook.

category

The category of the workbook.

comments

The comments of 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.

creationDate

Gets the creation date of the workbook.

custom

Gets the collection of custom properties of the workbook.

keywords

The keywords of the workbook.

lastAuthor

Gets the last author of the workbook.

manager

The manager of the workbook.

revisionNumber

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 context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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 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 is 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.

Property Details

author

The author of the workbook.

author: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

category

The category of the workbook.

category: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

comments

The comments of the workbook.

comments: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

company

The company of the workbook.

company: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.7 ]

custom

Gets the collection of custom properties of the workbook.

readonly custom: Excel.CustomPropertyCollection;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.7 ]

lastAuthor

Gets the last author of the workbook.

readonly lastAuthor: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

manager

The manager of the workbook.

manager: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

revisionNumber

Gets the revision number of the workbook.

revisionNumber: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

subject

The subject of the workbook.

subject: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

title

The title of the workbook.

title: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

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

options
Excel.Interfaces.DocumentPropertiesLoadOptions

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

properties
Excel.Interfaces.DocumentPropertiesUpdateData

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

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 is 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;

Returns