Edit

Share via

Word.Interfaces.DocumentPropertiesData interface

  • Reference
Package:
word

An interface describing the data returned by calling documentProperties.toJSON().

Properties

applicationName

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

Gets the creation date of the document.
customProperties

Gets the collection of custom properties of the document.
format

Specifies the format of the document.
keywords

Specifies the keywords of the document.
lastAuthor

Gets the last author of the document.
lastPrintDate

Gets the last print date of the document.
lastSaveTime

Gets the last save time of the document.
manager

Specifies the manager of the document.
revisionNumber

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.

Property Details

applicationName

Gets the application name of the document.

applicationName?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

author

Specifies the author of the document.

author?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

category

Specifies the category of the document.

category?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

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

[ API set: WordApi 1.3 ]

company

Specifies the company of the document.

company?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

creationDate

Gets the creation date of the document.

creationDate?: Date;

Property Value

Date

Remarks

[ API set: WordApi 1.3 ]

customProperties

Gets the collection of custom properties of the document.

customProperties?: Word.Interfaces.CustomPropertyData[];

Property Value

Word.Interfaces.CustomPropertyData[]

Remarks

[ API set: WordApi 1.3 ]

format

Specifies the format of the document.

format?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

keywords

Specifies the keywords of the document.

keywords?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

lastAuthor

Gets the last author of the document.

lastAuthor?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

lastPrintDate

Gets the last print date of the document.

lastPrintDate?: Date;

Property Value

Date

Remarks

[ API set: WordApi 1.3 ]

lastSaveTime

Gets the last save time of the document.

lastSaveTime?: Date;

Property Value

Date

Remarks

[ API set: WordApi 1.3 ]

manager

Specifies the manager of the document.

manager?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

revisionNumber

Gets the revision number of the document.

revisionNumber?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

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.

security?: number;

Property Value

number

Remarks

[ API set: WordApi 1.3 ]

subject

Specifies the subject of the document.

subject?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

template

Gets the template of the document.

template?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]

title

Specifies the title of the document.

title?: string;

Property Value

string

Remarks

[ API set: WordApi 1.3 ]