OfficeExtension.ClientRequestContext class

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

Абстрактный объект RequestContext, упрощающий запросы к приложению Office. Методы Excel.run и Word.run предоставляют контекст запроса.

Конструкторы

(constructor)(url)

Создает новый экземпляр ClientRequestContext класса

Свойства

debugInfo

Данные отладки
requestHeaders

Заголовки запросов
trackedObjects

Коллекция объектов, отслеживаемых для автоматической корректировки на основе окружающих изменений в документе.

Методы

load(object, option)

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

Ставит в очередь команду для рекурсивной загрузки указанных свойств объекта и его свойств навигации.

Перед чтением свойств требуется вызвать метод context.sync().
sync(passThroughValue)

Синхронизирует состояние между прокси-объектами JavaScript и документом Office, выполняя инструкции, помещенные в очередь в контексте запроса, и извлекая свойства загруженных объектов Office для использования в коде. Этот метод возвращает обещание, которое разрешается после завершения синхронизации.
trace(message)

Добавляет сообщение трассировки в очередь. Если возвращенное обещание отклонено context.sync() из-за ошибки, то в объект OfficeExtension.Error добавляется массив traceMessages, содержащий все выполненные сообщения трассировки. Эти сообщения помогают отслеживать последовательность выполнения программы и определять причину ошибки.

Сведения о конструкторе

(constructor)(url)

Создает новый экземпляр ClientRequestContext класса

constructor(url?: string);

Параметры

url

string

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

debugInfo

Данные отладки

readonly debugInfo: RequestContextDebugInfo;

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

OfficeExtension.RequestContextDebugInfo

requestHeaders

Заголовки запросов

requestHeaders: { [name: string]: string };

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

{ [name: string]: string }

trackedObjects

Коллекция объектов, отслеживаемых для автоматической корректировки на основе окружающих изменений в документе.

trackedObjects: TrackedObjects;

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

OfficeExtension.TrackedObjects

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

load(object, option)

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

load(object: ClientObject, option?: string | string[] | LoadOption): void;

Параметры

object
OfficeExtension.ClientObject

Объект, свойства которого загружаются.

option

string | string[] | OfficeExtension.LoadOption

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

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

void

loadRecursive(object, options, maxDepth)

Ставит в очередь команду для рекурсивной загрузки указанных свойств объекта и его свойств навигации.

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

loadRecursive(object: ClientObject, options: { [typeName: string]: string | string[] | LoadOption }, maxDepth?: number): void;

Параметры

object
OfficeExtension.ClientObject

Загружаемый объект.

options

{ [typeName: string]: string | string[] | OfficeExtension.LoadOption }

Связывание "ключ-значение" параметров загрузки для типов, например { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }

maxDepth

number

Максимальная рекурсивная глубина.

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

void

sync(passThroughValue)

Синхронизирует состояние между прокси-объектами JavaScript и документом Office, выполняя инструкции, помещенные в очередь в контексте запроса, и извлекая свойства загруженных объектов Office для использования в коде. Этот метод возвращает обещание, которое разрешается после завершения синхронизации.

sync<T>(passThroughValue?: T): Promise<T>;

Параметры

passThroughValue

T

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

Promise<T>

trace(message)

Добавляет сообщение трассировки в очередь. Если возвращенное обещание отклонено context.sync() из-за ошибки, то в объект OfficeExtension.Error добавляется массив traceMessages, содержащий все выполненные сообщения трассировки. Эти сообщения помогают отслеживать последовательность выполнения программы и определять причину ошибки.

trace(message: string): void;

Параметры

message

string

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

void