Excel.DocumentProperties class
Представляет свойства книги.
- Extends
Комментарии
Свойства
| author | Автор книги. |
| category | Категория книги. |
| comments | Поле комментария в метаданных книги. Они не имеют связи с комментариями пользователей, сделанными в workbork. |
| company | Компания книги. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| creation |
Получает дату создания книги. |
| custom | Получает коллекцию настраиваемых свойств книги. |
| keywords | Ключевые слова книги. |
| last |
Получает последнего автора книги. |
| manager | Диспетчер книги. |
| revision |
Получает номер редакции книги. |
| subject | Тема книги. |
| title | Название книги. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
author
category
comments
Поле комментария в метаданных книги. Они не имеют связи с комментариями пользователей, сделанными в workbork.
comments: string;Значение свойства
string
Комментарии
company
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
creationDate
Получает дату создания книги.
readonly creationDate: Date;Значение свойства
Date
Комментарии
custom
Получает коллекцию настраиваемых свойств книги.
readonly custom: Excel.CustomPropertyCollection;Значение свойства
Комментарии
Примеры
// 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
Ключевые слова книги.
keywords: string;Значение свойства
string
Комментарии
lastAuthor
Получает последнего автора книги.
readonly lastAuthor: string;Значение свойства
string
Комментарии
manager
revisionNumber
Получает номер редакции книги.
revisionNumber: number;Значение свойства
number
Комментарии
subject
title
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.DocumentProperties;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentProperties;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.DocumentProperties): void;Параметры
- properties
- Excel.DocumentProperties
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentProperties объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.DocumentPropertiesData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.DocumentPropertiesData;Возвращаемое значение
Office Add-ins