office package

Ссылка

Классы

Office.TableData	Представляет данные в таблице или Office.TableBinding.
OfficeExtension.ClientObject	Абстрактный прокси-объект, представляющий объект в документе Office. Прокси-объекты создаются из контекста (или из других прокси-объектов), добавляются команды в очередь для действий с объектом, а затем синхронизируются состояние объекта прокси-сервера с документом путем вызова `context.sync()`.
OfficeExtension.ClientRequestContext	Абстрактный объект RequestContext, упрощающий запросы к приложению Office. Методы `Excel.run` и `Word.run` предоставляют контекст запроса.
OfficeExtension.ClientResult	Содержит результат для методов, возвращающих примитивные типы. Свойство value объекта извлекается из документа после `context.sync()` вызова.
OfficeExtension.EmbeddedSession	Представляет сеанс схемы Visio, внедренной на страницу SharePoint. Дополнительные сведения см. в статье Обзор API JavaScript для Visio.
OfficeExtension.Error	Объект ошибки, возвращаемый `context.sync()`, если обещание отклоняется из-за ошибки при обработке запроса.
OfficeExtension.ErrorCodes	Представляет код ошибки, который может быть возвращен OfficeExtension.Error.code. Дополнительные сведения о кодах ошибок см. в статье Общие коды ошибок API Office.
OfficeExtension.EventHandlerResult	Включает удаление обработчика событий. Возвращается методом `EventHandlers.add` . Примечание. При удалении обработчика необходимо использовать тот же объект RequestContext , в который был добавлен обработчик. Дополнительные сведения см. в статье Удаление обработчика событий.
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	Коллекция отслеживаемых объектов, содержащихся в контексте запроса. Дополнительные сведения см. в разделе context.trackedObjects .

Интерфейсы

Office.Actions	Управляет действиями и сочетаниями клавиш.
Office.AddBindingFromNamedItemOptions	Предоставляет параметры для настройки созданной привязки.
Office.AddBindingFromPromptOptions	Предоставляет параметры для настройки запроса и определения созданной привязки.
Office.AddBindingFromSelectionOptions	Предоставляет параметры для идентификации созданной привязки.
Office.Addin	Представляет функциональные возможности уровня надстройки для работы или настройки различных аспектов надстройки.
Office.AddinCommands.Event	Объект `Event` передается в качестве параметра в функции надстройки, вызываемые кнопками команд функции. Объект позволяет надстройке определить, какая кнопка была нажата, и сообщить приложению Office о завершении обработки.
Office.AddinCommands.EventCompletedOptions	Указывает поведение надстройки при отправке в Outlook после завершения обработки `ItemSend` события.
Office.AddinCommands.Source	Инкапсулирует исходные данные для событий надстройки.
Office.AsyncContextOptions	Предоставляет возможность сохранения данных контекста любого типа без изменений для использования в обратном вызове.
Office.AsyncResult	Объект, который инкапсулирует результат асинхронного запроса, включая сведения о состоянии и ошибке, если запрос завершился ошибкой. Когда функция, передаваемая в `callback` параметр метода Async, выполняется, она получает объект AsyncResult, к которому можно получить доступ из единственного `callback` параметра функции.
Office.Auth	Пространство `Office.auth`имен проверки подлинности Office предоставляет методы для клиентского приложения Office для получения маркеров доступа к веб-приложению надстройки. Косвенно это также дает возможность надстройке получать доступ к данным Microsoft Graph пользователя, вошедшего в систему, не требуя от пользователя еще раз выполнить вход в систему.
Office.AuthContext	Представляет сведения о пользователе, которые могут быть переданы msal.js.
Office.AuthOptions	Предоставляет параметры для взаимодействия с пользователем, когда Office получает маркер доступа к надстройке из AAD версии 2.0 с `getAccessToken` помощью метода .
Office.BeforeDocumentCloseNotification	Представляет модальное диалоговое окно уведомлений, которое может отображаться при попытке пользователя закрыть документ. Документ не закрывается, пока пользователь не ответит. Диалоговое окно уведомлений позволит пользователю подтвердить запрос на закрытие документа или отменить запрос на закрытие документа. Этот API поддерживается только в Excel.
Office.Binding	Представляет привязку к разделу документа. Объект Binding предоставляет функциональные возможности, которыми обладают все привязки независимо от типа. Объект Binding никогда не вызывается напрямую. Это абстрактный родительский класс объектов, представляющих каждый тип привязки: Office.MatrixBinding, Office.TableBinding или Office.TextBinding. Все три этих объекта наследуют методы getDataAsync и setDataAsync от объекта Binding, которые позволяют взаимодействовать с данными в привязке. Они также наследуют свойства идентификатора и типа для запроса этих значений свойств. Кроме того, объекты MatrixBinding и TableBinding предоставляют дополнительные методы для работы с матрицами и таблицами, например, для подсчета количества строк и столбцов.
Office.BindingDataChangedEventArgs	Предоставляет сведения о привязке, вызвавшей событие DataChanged.
Office.Bindings	Представляет привязки, которые есть у надстройки в документе.
Office.BindingSelectionChangedEventArgs	Предоставляет сведения о привязке, вызвавшей событие SelectionChanged.
Office.Context	Представляет среду выполнения надстройки и открывает доступ к ключевым объектам API. Текущий контекст существует как свойство Office. Доступ к нему можно получить с помощью `Office.context`.
Office.ContextInformation	Предоставляет сведения о среде, в которой выполняется надстройка.
Office.Control	Представляет отдельный элемент управления или команду и состояние, которое он должен иметь.
Office.CustomXmlNode	Представляет XML-узел в дереве документа.
Office.CustomXmlPart	Представляет один объект CustomXMLPart в коллекции Office.CustomXmlParts .
Office.CustomXmlParts	Представляет коллекцию объектов CustomXmlPart.
Office.CustomXmlPrefixMappings	Представляет коллекцию объектов CustomXmlPart.
Office.DevicePermission	Предоставляет методы для надстройки, чтобы запросить у пользователя разрешение на доступ к возможностям устройства. К возможностям устройства пользователя относятся камера, географическое расположение и микрофон.
Office.Dialog	Объект , возвращаемый при `UI.displayDialogAsync` вызове. Он предоставляет методы для регистрации обработчиков событий и закрытия диалогового окна.
Office.DialogMessageOptions	Предоставляет варианты отправки сообщений в любом направлении между диалогом и его родительским элементом.
Office.DialogOptions	Предоставляет параметры отображения диалогового окна.
Office.DialogParentMessageReceivedEventArgs	Предоставляет сведения о сообщении с родительской страницы, на которую возникло `DialogParentMessageReceived` событие. Чтобы добавить обработчик событий для `DialogParentMessageReceived` события, используйте `addHandlerAsync` метод объекта Office.UI .
Office.Document	Абстрактный класс, представляющий документ, с которым взаимодействует надстройка.
Office.DocumentSelectionChangedEventArgs	Предоставляет сведения о документе, который вызвал событие SelectionChanged.
Office.Error	Предоставляет конкретные сведения об ошибке, возникшей во время выполнения асинхронной операции с данными.
Office.File	Представляет файл документа, сопоставленный с надстройкой Office.
Office.FileProperties
Office.GetBindingDataOptions	Предоставляет варианты получения данных в привязке.
Office.GetFileOptions	Предоставляет параметры для настройки размера срезов, на которые будет разделен документ.
Office.GetSelectedDataOptions	Предоставляет параметры для настройки возвращаемых данных и способа их форматирования.
Office.GoToByIdOptions	Предоставляет параметры выбора расположения, к которому выполняется переход.
Office.Group	Представляет группу элементов управления на вкладке ленты. Набор обязательных элементов: RibbonAPI 1.1
Office.IPromiseConstructor
Office.MatrixBinding	Представляет привязку в двух измерениях строк и столбцов.
Office.NodeDeletedEventArgs	Предоставляет сведения об удаленном узле, который вызвал событие nodeDeleted.
Office.NodeInsertedEventArgs	Предоставляет сведения о вставленном узле, который вызвал событие nodeInserted.
Office.NodeReplacedEventArgs	Предоставляет сведения о замененном узле, который вызвал событие nodeReplaced.
Office.OfficeTheme	Предоставляет доступ к свойствам цветов темы Office. С помощью цветов темы Office можно согласовать цветовую схему надстройки с текущей темой Office, выбранной пользователем. Пользователь задает тему в приложении Office с помощью файловой>учетной записи илитемы officeучетной записи> Office. Затем выбранная тема применяется во всех приложениях Office. Using Office theme colors is appropriate for mail and task pane add-ins. Дополнительные сведения о темах Office см. в статье Изменение внешнего вида Microsoft 365.
Office.RangeCoordinates	Указывает ячейку, строку или столбец по отсчитываемой от нуля строке и (или) номеру столбца. Пример: `{row: 3, column: 4}` указывает ячейку во 3-й строке (от нуля) в 4-м столбце (от нуля).
Office.RangeFormatConfiguration	Задает диапазон и его форматирование.
Office.RemoveHandlerOptions	Предоставляет параметры для определения того, какие обработчики событий будут удалены.
Office.RequirementSetSupport	Содержит сведения о том, какие наборы требований поддерживаются в текущей среде.
Office.Ribbon	Интерфейс, содержащий все функции, предоставляемые для управления состоянием ленты Office.
Office.RibbonUpdaterData	Указывает изменения на ленте, например состояние включения или отключения кнопки.
Office.SaveSettingsOptions	Предоставляет параметры для сохранения параметров.
Office.SetBindingDataOptions	Предоставляет параметры настройки данных в привязке.
Office.SetSelectedDataOptions	Предоставляет варианты вставки данных в выделенный фрагмент.
Office.Settings	Представляет пользовательские параметры для надстройки области задач или контентной надстройки, которые хранятся в документе ведущего приложения как пары "имя-значение".
Office.SettingsChangedEventArgs	Предоставляет сведения о параметрах, вызвавших событие settingsChanged. Чтобы добавить обработчик событий для события settingsChanged, используйте метод addHandlerAsync объекта Office.Settings . Событие settingsChanged срабатывает, только если скрипт надстройки вызывает метод Settings.saveAsync для сохранения копии параметров в памяти в файле документа. Событие settingsChanged не вызывается при вызове методов Settings.set и Settings.remove. Событие settingsChanged предназначено для обработки потенциальных конфликтов, когда два или более пользователей пытаются сохранить параметры одновременно, когда надстройка используется в общем (совместном) документе. Важно! Код надстройки может зарегистрировать обработчик события settingsChanged, когда надстройка запущена с любым клиентом Excel, но событие сработает только в том случае, если надстройка загружена электронной таблицей, открытой в Excel в Интернете, и несколько пользователей редактируют электронную таблицу (совместное редактирование). Таким образом, событие settingsChanged поддерживается только в Excel в Интернете в сценариях совместного редактирования.
Office.Slice	Представляет срез файла документа. Доступ к объекту Slice осуществляется с помощью `File.getSliceAsync` метода .
Office.Tab	Представляет отдельную вкладку и состояние, которое она должна иметь. Примеры кода см. в разделах Включение и отключение команд надстроек и Создание пользовательских контекстных вкладок.
Office.TableBinding	Представляет привязку в двух измерениях строк и столбцов, куда при желании можно добавить заголовки.
Office.TextBinding	Представляет выбор привязанного текста в документе. Объект TextBinding наследует `id` свойство, свойство type, метод getDataAsync и метод setDataAsync от объекта Office.Binding . Он не реализует дополнительные свойства или методы.
Office.UI	Предоставляет объекты и методы, которые можно использовать для создания компонентов пользовательского интерфейса, таких как диалоговые окна, и управления ими в надстройках Office. Дополнительные сведения см. в разделе Использование API диалогового окна в надстройках Office.
Office.Urls	Предоставляет URL-адреса сред выполнения, используемых надстройкой.
Office.VisibilityModeChangedMessage	Сообщение, используемое в вызове `onVisibilityModeChanged` .
OfficeExtension.DebugInfo	Предоставляет сведения об ошибке.
OfficeExtension.EmbeddedOptions	Задает параметры для сеанса схемы Visio, внедренной на страницу SharePoint. Вызывается конструктором `EmbeddedSession`. Дополнительные сведения см. в статье Обзор API JavaScript для Visio.
OfficeExtension.EventInfo	Используется Office для создания обработчиков событий. Не вызывайте в коде.
OfficeExtension.LoadOption	Указывает, какие свойства объекта следует загрузить. Эта нагрузка происходит при выполнении метода sync(). Это синхронизирует состояния между объектами Office и соответствующими прокси-объектами JavaScript.
OfficeExtension.RequestContextDebugInfo	Содержит отладочные сведения о контексте запроса.
OfficeExtension.RequestUrlAndHeaderInfo	URL-адрес и заголовки запроса
OfficeExtension.RunOptions	Дополнительные параметры передаются в `{Host}.run(...)`.
OfficeExtension.UpdateOptions	Предоставляет возможность подавления ошибки, когда объект, используемый для задания нескольких свойств, пытается задать свойства только для чтения.

Псевдонимы типа

OfficeExtension.IPromise

Перечисления

Office.ActiveView	Указывает состояние активного представления документа, например возможность редактирования документа пользователем.
Office.AsyncResultStatus	Указывает результат асинхронного вызова.
Office.BindingType	Указывает тип объекта привязки, который нужно вернуть.
Office.CoercionType	Указывает способ приведения данных, возвращаемых или задаваемых вызванным методом.
Office.CustomXMLNodeType	Указывает тип XML-узла.
Office.DevicePermissionType	Указывает возможность устройства, доступ к которому запрашивает надстройка.
Office.DocumentMode	Указывает режим работы с документом в соответствующем приложении: только чтение или чтение и запись.
Office.EventType	Указывает тип вызванного события. Возвращается свойством `type*EventArgs` объекта . Надстройки для Project поддерживают `Office.EventType.ResourceSelectionChanged`типы событий , `Office.EventType.TaskSelectionChanged`и `Office.EventType.ViewSelectionChanged` . Типы событий API почтовых ящиков поддерживают только надстройки области задач для Outlook.
Office.FileType	Указывает формат, в котором возвращается документ.
Office.FilterType	Указывает, применяется ли фильтрация из приложения Office при получении данных.
Office.GoToType	Указывает тип места или объекта, к которому нужно перейти.
Office.HostType	Указывает приложение Office, в котором выполняется надстройка.
Office.Index	Указывает относительный слайд PowerPoint.
Office.InitializationReason	Указывает, была ли надстройка вставлена в документ только что или ранее.
Office.PlatformType	Указывает ОС или другую платформу, на которой выполняется приложение Office.
Office.ProjectProjectFields	Указывает поля проекта, доступные в качестве параметра для метода Document.getProjectFieldAsync.
Office.ProjectResourceFields	Указывает поля ресурсов, доступные в качестве параметра для метода Document.getResourceFieldAsync.
Office.ProjectTaskFields	Указывает поля задачи, доступные в качестве параметра для метода Document.getTaskFieldAsync.
Office.ProjectViewTypes	Указывает типы представлений, которые может распознать метод Document.getSelectedViewAsync.
Office.SelectionMode	Указывает, следует ли выбрать (выделить) расположение для перехода (при использовании метода Document.goToByIdAsync).
Office.StartupBehavior	Предоставляет параметры для определения поведения при запуске надстройки при следующем запуске.
Office.Table	Задает перечисляемые значения для `cells` свойства в параметре cellFormat методов форматирования таблиц.
Office.ThemeId	Указывает выбранную тему Office. Сведения о темах Office см. в статье Изменение внешнего вида Microsoft 365.
Office.ValueFormat	Указывает, форматируются ли значения, такие как числа и даты, возвращаемые вызванным методом.
Office.VisibilityMode	Режим видимости надстройки.

Функции

Office.initialize(reason)	Происходит, когда среда выполнения загружена и надстройка готова начать взаимодействие с приложением и размещенным документом. Параметр reason функции прослушивателя событий initialize возвращает `InitializationReason` значение перечисления, указывающее, как произошла инициализация. Надстройку области задач или контентную надстройку можно инициализировать двумя способами: Пользователь только что вставил его из раздела Недавно использовавшихся надстроек раскрывающегося списка Надстройка на вкладке Вставка ленты в приложении Office или в диалоговом окне Вставка надстройки. пользователь может открыть документ, который уже содержит надстройку. Примечание. Параметр reason функции прослушивателя событий initialize возвращает `InitializationReason` значение перечисления только для надстроек области задач и содержимого. Он не возвращает значение для надстроек Outlook.
Office.isSetSupported(name, minVersion)	Проверяет, поддерживается ли приложением Office указанный набор требований.
Office.onReady(callback)	Гарантирует, что API JavaScript для Office готовы к вызову надстройкой. Если платформа еще не инициализирована, обратный вызов или обещание будут ожидать, пока приложение Office не будет готово принимать вызовы API. Обратите внимание, что хотя этот API предназначен для использования в надстройке Office, его также можно использовать за пределами надстройки. В этом случае, когда Office.js определит, что оно выполняется за пределами приложения Office, он вызовет обратный вызов и выполнит обещание со значением NULL как для приложения, так и для платформы.
Office.select(expression, callback)	Возвращает обещание объекта, описанного в выражении. Обратный вызов вызывается только в случае сбоя функции.
Office.useShortNamespace(useShortNamespace)	Включение и отключение псевдонима `Office` для полного `Microsoft.Office.WebExtension` пространства имен.

Сведения о функции

Office.initialize(reason)

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

Параметр reason функции прослушивателя событий initialize возвращает InitializationReason значение перечисления, указывающее, как произошла инициализация. Надстройку области задач или контентную надстройку можно инициализировать двумя способами:

Пользователь только что вставил его из раздела Недавно использовавшихся надстроек раскрывающегося списка Надстройка на вкладке Вставка ленты в приложении Office или в диалоговом окне Вставка надстройки.
пользователь может открыть документ, который уже содержит надстройку.

Примечание. Параметр reason функции прослушивателя событий initialize возвращает InitializationReason значение перечисления только для надстроек области задач и содержимого. Он не возвращает значение для надстроек Outlook.

export function initialize(reason: InitializationReason): void;

Параметры

reason: Office.InitializationReason

Указывает, как было инициализировано приложение.

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

void

	Office в Интернете	Office для Windows	Office для Mac	Office для iPad	Outlook на мобильных устройствах
Превосходить	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Неприменимо
Вид	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Поддерживается
PowerPoint	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Неприменимо
Проект	Не поддерживается	Поддерживается	Поддерживается	Не поддерживается	Неприменимо
Слово	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Неприменимо

Примеры

// You can use the value of the InitializationEnumeration to implement different logic for
// when the add-in is first inserted versus when it is already part of the document.
// The following example shows some simple logic that uses the value of the reason parameter
// to display how the task pane or content add-in was initialized.
Office.initialize = function (reason) {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
    // After the DOM is loaded, code specific to the add-in can run.
    // Display initialization reason.
    if (reason == "inserted")
    write("The add-in was just inserted.");

    if (reason == "documentOpened")
    write("The add-in is already part of the document.");
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Office.isSetSupported(name, minVersion)

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

export function isSetSupported(name: string, minVersion?: string): boolean;

Параметры

name: string

Задать имя; Например, MatrixBindings.

minVersion: string

Минимальная требуемая версия; Например, "1.4".

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

boolean

Office.onReady(callback)

Гарантирует, что API JavaScript для Office готовы к вызову надстройкой. Если платформа еще не инициализирована, обратный вызов или обещание будут ожидать, пока приложение Office не будет готово принимать вызовы API. Обратите внимание, что хотя этот API предназначен для использования в надстройке Office, его также можно использовать за пределами надстройки. В этом случае, когда Office.js определит, что оно выполняется за пределами приложения Office, он вызовет обратный вызов и выполнит обещание со значением NULL как для приложения, так и для платформы.

export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;

Параметры

callback: (info: { host: Office.HostType, platform: Office.PlatformType }) => any

Необязательная функция обратного вызова, которая будет получать сведения о приложении и платформе. Кроме того, вместо обратного вызова надстройка может просто дождаться разрешения функции Promise.

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

Promise<{ host: Office.HostType, platform: Office.PlatformType }>

Объект Promise, содержащий сведения о приложении и платформе после завершения инициализации.

Office.select(expression, callback)

Возвращает обещание объекта, описанного в выражении. Обратный вызов вызывается только в случае сбоя функции.

export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;

Параметры

expression: string

Извлекаемый объект. Пример bindings#BindingName извлекает обещание привязки для привязки с именем BindingName.

callback: (result: Office.AsyncResult<any>) => void

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

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

Office.Binding

	Office в Интернете	Office для Windows	Office для iPad
Превосходить	Поддерживается	Поддерживается	Поддерживается
Слово	Не поддерживается	Поддерживается	Поддерживается

Примеры

// The following code example uses the select function to retrieve a binding with the id "cities" from
// the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the
// dataChanged event of the binding.
function addBindingDataChangedEventHandler() {
    Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
    function (eventArgs) {
        doSomethingWithBinding(eventArgs.binding);
    });
}

Office.useShortNamespace(useShortNamespace)

Включение и отключение псевдонима Office для полного Microsoft.Office.WebExtension пространства имен.

export function useShortNamespace(useShortNamespace: boolean): void;

Параметры

useShortNamespace: boolean

Значение True, чтобы использовать псевдоним ярлыка; в противном случае значение false, чтобы отключить его. Значение по умолчанию: true.

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

void

	Office в Интернете	Office для Windows	Office для Mac	Office для iPad	Outlook на мобильных устройствах
Превосходить	Поддерживается	Поддерживается	Не поддерживается	Поддерживается	Неприменимо
Вид	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Поддерживается
PowerPoint	Поддерживается	Поддерживается	Не поддерживается	Поддерживается	Неприменимо
Проект	Не поддерживается	Поддерживается	Не поддерживается	Не поддерживается	Неприменимо
Слово	Поддерживается	Поддерживается	Не поддерживается	Поддерживается	Неприменимо

Примеры

function startUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(true);
    }
    else {
        Office.useShortNamespace(true);
    }
    write('Office alias is now ' + typeof Office);
}

function stopUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(false);
    }
    else {
        Office.useShortNamespace(false);
    }
    write('Office alias is now ' + typeof Office);
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

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

office package

Классы

Интерфейсы

Псевдонимы типа

Перечисления

Функции

Сведения о функции

Office.initialize(reason)

Параметры

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

Комментарии

Примеры

Office.isSetSupported(name, minVersion)

Параметры

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

Office.onReady(callback)

Параметры

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

Office.select(expression, callback)

Параметры

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

Комментарии

Примеры

Office.useShortNamespace(useShortNamespace)

Параметры

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

Комментарии

Примеры

Дополнительные ресурсы