Word.DocumentProperties class
Represents document properties.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml
await Word.run(async (context) => {
const builtInProperties: Word.DocumentProperties = context.document.properties;
builtInProperties.load("*"); // Let's get all!
await context.sync();
console.log(JSON.stringify(builtInProperties, null, 4));
});
Properties
| application |
Gets the application name of the document. |
| author | Specifies the author of the document. |
| category | Specifies the category of the document. |
| comments | Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. |
| company | Specifies the company of the document. |
| 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 document. |
| custom |
Gets the collection of custom properties of the document. |
| format | Specifies the format of the document. |
| keywords | Specifies the keywords of the document. |
| last |
Gets the last author of the document. |
| last |
Gets the last print date of the document. |
| last |
Gets the last save time of the document. |
| manager | Specifies the manager of the document. |
| revision |
Gets the revision number of the document. |
| security | Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. |
| subject | Specifies the subject of the document. |
| template | Gets the template of the document. |
| title | Specifies the title of the document. |
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 |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
applicationName
Gets the application name of the document.
readonly applicationName: string;Property Value
string
Remarks
author
Specifies the author of the document.
author: string;Property Value
string
Remarks
category
Specifies the category of the document.
category: string;Property Value
string
Remarks
comments
Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document.
comments: string;Property Value
string
Remarks
company
Specifies the company of the document.
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 document.
readonly creationDate: Date;Property Value
Date
Remarks
customProperties
Gets the collection of custom properties of the document.
readonly customProperties: Word.CustomPropertyCollection;Property Value
Remarks
format
Specifies the format of the document.
format: string;Property Value
string
Remarks
keywords
Specifies the keywords of the document.
keywords: string;Property Value
string
Remarks
lastAuthor
Gets the last author of the document.
readonly lastAuthor: string;Property Value
string
Remarks
lastPrintDate
Gets the last print date of the document.
readonly lastPrintDate: Date;Property Value
Date
Remarks
lastSaveTime
Gets the last save time of the document.
readonly lastSaveTime: Date;Property Value
Date
Remarks
manager
Specifies the manager of the document.
manager: string;Property Value
string
Remarks
revisionNumber
Gets the revision number of the document.
readonly revisionNumber: string;Property Value
string
Remarks
security
Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8.
readonly security: number;Property Value
number
Remarks
subject
Specifies the subject of the document.
subject: string;Property Value
string
Remarks
template
Gets the template of the document.
readonly template: string;Property Value
string
Remarks
title
Specifies the title of the document.
title: string;Property Value
string
Remarks
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?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.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[]): Word.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;
}): Word.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
- Word.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: Word.DocumentProperties): void;Parameters
- properties
- Word.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 Word.DocumentProperties object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DocumentPropertiesData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.DocumentPropertiesData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.DocumentProperties;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.DocumentProperties;Returns
Office Add-ins