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


Excel.DocumentProperties class

Представляет свойства книги.

Extends

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

author

Автор книги.

category

Категория книги.

comments

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

company

Компания книги.

context

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

creationDate

Получает дату создания книги.

custom

Получает коллекцию настраиваемых свойств книги.

keywords

Ключевые слова книги.

lastAuthor

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

manager

Диспетчер книги.

revisionNumber

Получает номер редакции книги.

subject

Тема книги.

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 метод переданного ему объекта.) В то время как исходный Excel.DocumentProperties объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.DocumentPropertiesData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

author

Автор книги.

author: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

category

Категория книги.

category: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

comments

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

comments: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

company

Компания книги.

company: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

context

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

context: RequestContext;

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

creationDate

Получает дату создания книги.

readonly creationDate: Date;

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

Date

Комментарии

[ Набор API: ExcelApi 1.7 ]

custom

Получает коллекцию настраиваемых свойств книги.

readonly custom: Excel.CustomPropertyCollection;

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

lastAuthor

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

readonly lastAuthor: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

manager

Диспетчер книги.

manager: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

revisionNumber

Получает номер редакции книги.

revisionNumber: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

subject

Тема книги.

subject: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

title

Название книги.

title: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

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

load(options)

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

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

Параметры

options
Excel.Interfaces.DocumentPropertiesLoadOptions

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

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

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;

Параметры

properties
Excel.Interfaces.DocumentPropertiesUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.DocumentProperties): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.DocumentPropertiesData;

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