Word.DocumentProperties class

Представляет свойства документа.

// 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));
});

Свойства

applicationName	Возвращает имя приложения для документа.
author	Уточняет автор документа.
category	Указывает категорию документа.
comments	Указывает поле "Комментарии" в метаданных документа. Они не имеют никакого отношения к комментариям пользователей, сделанным в документе.
company	Указывает компанию документа.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
creationDate	Возвращает дату создания документа.
customProperties	Возвращает коллекцию настраиваемых свойств документа.
format	Определяет формат документа.
keywords	Определяет ключевые слова документа.
lastAuthor	Получает последнего автора документа.
lastPrintDate	Возвращает дату последней печати документа.
lastSaveTime	Возвращает время последнего сохранения документа.
manager	Уточняет менеджер документа.
revisionNumber	Возвращает номер редакции документа.
security	Получает параметры безопасности документа. Некоторые из них — ограничения доступа к файлу на диске. Другие параметры — это параметры защиты документов. Некоторые возможные значения: 0 = файл на диске прочитан/записан; 1 = Защитить документ: файл зашифрован и требует пароля для открытия; 2 = Защитить документ: всегда открывать только для чтения; 3 = Защитить документ: #1 и #2; 4 = Файл на диске доступен только для чтения; 5 = оба #1 и #4; 6 = И #2, и #4; 7 = Все из #1, #2 и #4; 8 = Защитить документ: Ограничить редактирование только для чтения; 9 = И #1, и #8; 10 = И #2, и #8; 11 = Все из #1, #2 и #8; 12 = И #4, и #8; 13 = Все из #1, #4 и #8; 14 = Все из #2, #4 и #8; 15 = все из #1, #2, #4 и #8.
subject	Указывает тему документа.
template	Возвращает шаблон документа.
title	Указывает название документа.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.DocumentProperties` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.DocumentPropertiesData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

applicationName

Возвращает имя приложения для документа.

readonly applicationName: string;

Значение свойства

string

author

Уточняет автор документа.

author: string;

Значение свойства

string

comments

Указывает поле "Комментарии" в метаданных документа. Они не имеют никакого отношения к комментариям пользователей, сделанным в документе.

comments: string;

Значение свойства

string

company

Указывает компанию документа.

company: string;

Значение свойства

string

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

creationDate

Возвращает дату создания документа.

readonly creationDate: Date;

Значение свойства

Date

customProperties

Возвращает коллекцию настраиваемых свойств документа.

readonly customProperties: Word.CustomPropertyCollection;

Значение свойства

Word.CustomPropertyCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml

await Word.run(async (context) => {
    context.document.properties.customProperties.add("Numeric Property", 1234);

    await context.sync();
    console.log("Property added");
});

format

Определяет формат документа.

format: string;

Значение свойства

string

keywords

Определяет ключевые слова документа.

keywords: string;

Значение свойства

string

lastAuthor

Получает последнего автора документа.

readonly lastAuthor: string;

Значение свойства

string

lastPrintDate

Возвращает дату последней печати документа.

readonly lastPrintDate: Date;

Значение свойства

Date

lastSaveTime

Возвращает время последнего сохранения документа.

readonly lastSaveTime: Date;

Значение свойства

Date

manager

Уточняет менеджер документа.

manager: string;

Значение свойства

string

revisionNumber

Возвращает номер редакции документа.

readonly revisionNumber: string;

Значение свойства

string

security

Получает параметры безопасности документа. Некоторые из них — ограничения доступа к файлу на диске. Другие параметры — это параметры защиты документов. Некоторые возможные значения: 0 = файл на диске прочитан/записан; 1 = Защитить документ: файл зашифрован и требует пароля для открытия; 2 = Защитить документ: всегда открывать только для чтения; 3 = Защитить документ: #1 и #2; 4 = Файл на диске доступен только для чтения; 5 = оба #1 и #4; 6 = И #2, и #4; 7 = Все из #1, #2 и #4; 8 = Защитить документ: Ограничить редактирование только для чтения; 9 = И #1, и #8; 10 = И #2, и #8; 11 = Все из #1, #2 и #8; 12 = И #4, и #8; 13 = Все из #1, #4 и #8; 14 = Все из #2, #4 и #8; 15 = все из #1, #2, #4 и #8.

readonly security: number;

Значение свойства

number

subject

Указывает тему документа.

subject: string;

Значение свойства

string

template

Возвращает шаблон документа.

readonly template: string;

Значение свойства

string

title

Указывает название документа.

title: string;

Значение свойства

string

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties;

Параметры

options: Word.Interfaces.DocumentPropertiesLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.DocumentProperties

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.DocumentProperties;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.DocumentProperties

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.DocumentProperties;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.DocumentProperties

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.DocumentPropertiesUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.DocumentProperties): void;

Параметры

properties: Word.DocumentProperties

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.DocumentProperties объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.DocumentPropertiesData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.DocumentPropertiesData;

Возвращаемое значение

Word.Interfaces.DocumentPropertiesData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.DocumentProperties;

Возвращаемое значение

Word.DocumentProperties

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.DocumentProperties;

Возвращаемое значение

Word.DocumentProperties

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

applicationName

Значение свойства

Комментарии

author

Значение свойства

Комментарии

category

Значение свойства

Комментарии

comments

Значение свойства

Комментарии

company

Значение свойства

Комментарии

context

Значение свойства

creationDate

Значение свойства

Комментарии

customProperties

Значение свойства

Комментарии

Примеры

format

Значение свойства

Комментарии

keywords

Значение свойства

Комментарии

lastAuthor

Значение свойства

Комментарии

lastPrintDate

Значение свойства

Комментарии

lastSaveTime

Значение свойства

Комментарии

manager

Значение свойства

Комментарии

revisionNumber

Значение свойства

Комментарии

security

Значение свойства

Комментарии

subject

Значение свойства

Комментарии

template

Значение свойства

Комментарии

title

Значение свойства

Комментарии

Сведения о методе

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение