Поделиться через

Word.DocumentProperties class

  • Ссылка
Пакет:
word

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// 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

Комментарии

[ Набор API: WordApi 1.3 ]

author

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

author: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

category

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

category: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

comments

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

comments: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

company

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

company: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

context

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

context: RequestContext;

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

Word.RequestContext

creationDate

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

readonly creationDate: Date;

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

Date

Комментарии

[ Набор API: WordApi 1.3 ]

customProperties

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

readonly customProperties: Word.CustomPropertyCollection;

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

Word.CustomPropertyCollection

Комментарии

[ Набор API: WordApi 1.3 ]

format

Задает формат документа.

format: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

keywords

Указывает ключевые слова документа.

keywords: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

lastAuthor

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

readonly lastAuthor: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

lastPrintDate

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

readonly lastPrintDate: Date;

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

Date

Комментарии

[ Набор API: WordApi 1.3 ]

lastSaveTime

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

readonly lastSaveTime: Date;

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

Date

Комментарии

[ Набор API: WordApi 1.3 ]

manager

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

manager: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

revisionNumber

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

readonly revisionNumber: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

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

Комментарии

[ Набор API: WordApi 1.3 ]

subject

Задает тему документа.

subject: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

template

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

readonly template: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

title

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

title: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

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

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

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

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

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