office package

Классы

Office.TableData

Представляет данные в таблице или Office.TableBinding.

OfficeExtension.ClientObject

Абстрактный прокси-объект, который представляет объект в документе Office. Вы создаете прокси-объекты из контекста (или из других прокси-объектов), добавляете команды в очередь, чтобы действовать на объекте, а затем синхронизируете состояние объекта прокси с документом путем вызова context.sync().

OfficeExtension.ClientRequestContext

Абстрактный объект RequestContext, который облегчает запросы в приложении host Office. Эти Excel.run методы и методы предоставляют контекст Word.run запроса.

OfficeExtension.ClientResult

Содержит результат для методов, возвращая примитивные типы. Свойство значения объекта извлекается из документа после context.sync() вызова.

OfficeExtension.EmbeddedSession
OfficeExtension.Error

Объект ошибки, возвращенный context.sync(), если обещание отклоняется из-за ошибки при обработке запроса.

OfficeExtension.ErrorCodes
OfficeExtension.EventHandlerResult
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects

Коллекция отслеживаемого объекта, содержалась в контексте запроса. Дополнительные сведения см. в "context.trackedObjects".

Интерфейсы

Office.Actions

Управление действиями и клавишами.

Office.AddBindingFromNamedItemOptions

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

Office.AddBindingFromPromptOptions

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

Office.AddBindingFromSelectionOptions

Предоставляет параметры для определения созданного привязки.

Office.Addin

Представляет функциональность уровня надстройки для работы или настройки различных аспектов надстройки.

Office.AddinCommands.Event

Объект Event передается как параметр для функций надстройки, вызванных кнопками в режиме без пользовательского интерфейса. Этот объект позволяет надстройке определить нажатую кнопку и уведомить узел о завершении обработки.

Office.AddinCommands.EventCompletedOptions

Указывает поведение по завершению события.

Office.AddinCommands.Source

Инкапсулирует исходные данные для событий надстройки.

Office.AsyncContextOptions

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

Office.AsyncResult

Объект, который инкапсулирует результат асинхронного запроса, включая сведения о состоянии и ошибке, если запрос завершился ошибкой.

При выполнении функции, передаваемой параметру метода Async, он получает объект AsyncResult, к который можно получить доступ только из параметра callback callback функции.

Office.Auth

Пространство имен Office Auth,Office.auth, предоставляет метод, который позволяет Office клиентского приложения для получения маркера доступа к веб-приложению надстройки. Косвенно это также дает возможность надстройке получать доступ к данным Microsoft Graph пользователя, вошедшего в систему, не требуя от пользователя еще раз выполнить вход в систему.

Office.AuthOptions

Предоставляет параметры для пользовательского интерфейса, когда Office получает маркер доступа к надстройки из AAD v. 2.0 с методом getAccessToken.

Office.BeforeDocumentCloseNotification

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

Office. Привязка

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

Объект Binding предоставляет функциональные возможности, которыми обладают все привязки независимо от типа.

Объект Binding никогда не называется напрямую. Это абстрактный родительский класс объектов, которые представляют каждый тип привязки: Office. MatrixBinding, Office. TableBindingили Office. TextBinding. Все три этих объекта наследуют методы getDataAsync и setDataAsync от объекта Binding, которые позволяют взаимодействовать с данными в привязке. Они также наследуют свойства id и type и позволяют запрашивать значения этих свойств. Кроме того, объекты MatrixBinding и TableBinding предоставляют дополнительные методы для работы с матрицами и таблицами, например, для подсчета количества строк и столбцов.

Office.BindingDataChangedEventArgs

Предоставляет сведения о привязке, вызвавшей событие DataChanged.

Office.Bindings

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

Office.BindingSelectionChangedEventArgs

Предоставляет сведения о привязке, вызвавшей событие SelectionChanged.

Office.Context

Представляет среду выполнения надстройки и открывает доступ к ключевым объектам API. Текущий контекст существует как свойство Office. К нему можно получить доступ с помощью Office.context.

Office.ContextInformation

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

Office.Control

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

Примеры кода, показывающие использование объекта и его свойств, см. в примере Control Enable and Disable Add-in Commands and Create custom contextual tabs.

Office.CustomXmlNode

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

Office.CustomXmlPart

Представляет один CustomXMLPart в коллекции Office.CustomXmlParts.

Office.CustomXmlParts

Представляет коллекцию объектов CustomXmlPart.

Office.CustomXmlPrefixMappings

Представляет коллекцию объектов CustomXmlPart.

Office.Dialog

Объект, возвращаемый при UI.displayDialogAsync призвании. Он предоставляет методы регистрации обработчиков событий и закрытия диалогов.

Office.DialogMessageOptions

Предоставляет варианты отправки сообщений в любом направлении между диалогом и его родителем.

Office.DialogOptions

Предоставляет параметры отображения диалогов.

Office.DialogParentMessageReceivedEventArgs

Предоставляет сведения о сообщении с родительской страницы, которая подняла DialogParentMessageReceived событие.

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

Office.Document

Абстрактный класс, представляющий документ, с которым взаимодействует надстройка.

Office.DocumentSelectionChangedEventArgs

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

Office.Error

Предоставляет конкретные сведения об ошибке, возникшей во время выполнения асинхронной операции с данными.

Office.File

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

Office.FileProperties
Office.GetBindingDataOptions

Предоставляет варианты получения данных в привязке.

Office.GetFileOptions

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

Office.GetSelectedDataOptions

Предоставляет параметры настройки возвращаемых данных и формата их формата.

Office.GoToByIdOptions

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

Office.Group

Представляет группу элементов управления на вкладке ленты.

Набор требований: Лента 1.1

Office.IPromiseConstructor
Office.MatrixBinding

Представляет привязку в двух измерениях строк и столбцов.

Office.NodeDeletedEventArgs

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

Office.NodeInsertedEventArgs

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

Office.NodeReplacedEventArgs

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

Office.OfficeTheme

Предоставляет доступ к свойствам цветов темы Office.

Использование цветов тем Office позволяет скоординировать цветовую схему надстройки с текущей темой Office, выбранной пользователем с пользовательским интерфейсом темы Office Account Office, который применяется во всех хост-приложениях > > Office. Using Office theme colors is appropriate for mail and task pane add-ins.

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

Представляет индивидуальную вкладку и состояние, на который она должна быть. Примеры кода см. в примере Enable and Disable Add-in Commands and Create custom contextual tabs.

Office.TableBinding

Представляет привязку в двух измерениях строк и столбцов, при желании с заголовками.

Office.TextBinding

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

Объект TextBinding наследует свойство id, свойство типа, метод getDataAsync и метод setDataAsync от объекта Office.Binding. Он не реализует дополнительные свойства или методы.

Office.UI

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

Посетите "Используйте API диалогов в Office надстройкиДополнительные сведения.

Office.VisibilityModeChangedMessage

Сообщение, используемое при onVisibilityModeChanged вызове.

OfficeExtension.DebugInfo

Предоставляет сведения об ошибке.

OfficeExtension.EmbeddedOptions
OfficeExtension.EventInfo
OfficeExtension.LoadOption

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

OfficeExtension.RequestContextDebugInfo

Содержит сведения о контексте запроса.

OfficeExtension.RequestUrlAndHeaderInfo

URL-адрес запроса и заголовки

OfficeExtension.RunOptions

Дополнительные параметры, переданные в {Host}.run(...).

OfficeExtension.UpdateOptions

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

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

Office.ActiveView

Указывает состояние активного представления документа, например возможность редактирования документа пользователем.

Office.AsyncResultStatus

Указывает результат асинхронного вызова.

Office.BindingType

Указывает тип объекта привязки, который нужно вернуть.

Office.CoercionType

Указывает способ приведения данных, возвращаемых или задаваемых вызванным методом.

Office.CustomXMLNodeType

Указывает тип узла XML.

Office.DocumentMode

Указывает атрибут документа в соответствующем приложении: только чтение или чтение и запись.

Office.EventType

Указывает тип вызванного события. Возвращается type свойством *EventArgs объекта.

Надстройки для Project поддерживаютOffice.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChangedи Office.EventType.ViewSelectionChanged типы событий.

Только надстройки области задач для Outlook поддерживают типы событий API почтовых ящиков.

Office.FileType

Указывает формат, в котором возвращается документ.

Office.FilterType

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

Office.GoToType

Указывает тип места или объекта, к которому нужно перейти.

Office.HostType

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

Office.Index

Задает относительный слайд PowerPoint.

Office.InitializationReason

Указывает, была ли надстройка вставлена в документ только что или ранее.

Office.PlatformType

Указывает ОС или другую платформу, на которой работает ведущее приложение Office.

Office.ProjectProjectFields

Указывает поля проекта, доступные в качестве параметра документаМетод .getProjectFieldAsync.

Office.ProjectResourceFields

Указывает поля ресурсов, доступные в качестве параметра документаМетод .getResourceFieldAsync.

Office.ProjectTaskFields

Указывает поля задач, доступные в качестве параметра документаМетод .getTaskFieldAsync.

Office.ProjectViewTypes

Указывает типы представлений, которые документМетод .getSelectedViewAsync может распознавать.

Office.SelectionMode

Указывает, следует ли выбрать (выделить) расположение для навигации (при использовании документа)Метод .goToByIdAsync).

Office.StartupBehavior

Предоставляет параметры для определения поведения при запуске надстройки при следующем запуске.

Office.Table

Указывает указанные значения свойства в cells параметре cellFormat методов форматирования таблицы.

Office.ValueFormat

Указывает, форматируются ли значения, такие как числа и даты, возвращаемые вызванным методом.

Office.VisibilityMode

Режим видимости надстройки.

Функции

Office.initialize(reason)

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

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

  • Пользователь только что вставил его из недавно используемого раздела надстройки списка надстройки на вкладке Вставка ленты в хост-приложении Office или из диалогового окна надстройки Insert.

  • пользователь может открыть документ, который уже содержит надстройку.

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

Office.isSetSupported(name, minVersion)

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

Office.onReady(callback)

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

Office.select(expression, callback)

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

Office.useShortNamespace(useShortNamespace)

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

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

Office.initialize(reason)

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

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

  • Пользователь только что вставил его из недавно используемого раздела надстройки списка надстройки на вкладке Вставка ленты в хост-приложении Office или из диалогового окна надстройки Insert.

  • пользователь может открыть документ, который уже содержит надстройку.

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

export function initialize(reason: InitializationReason): void;

Параметры

reason
Office.InitializationReason

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

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

void

Комментарии

Сведения о поддержке

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.

Дополнительные сведения о требованиях Office и сервере см. в Office надстройки.

Поддерживаемые ведущие приложения по платформе

Office для Windows Office в веб-браузере Office для iPad Outlook на мобильных устройствах Office для Mac
Excel Да Да Да Да
Outlook Да Да Да Да
PowerPoint Да Да Да Да
Project Да Да
Word Да Да Да Да

Примеры

// 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 function.
    $(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)

Гарантирует, что Office API JavaScript будут готовы быть вызваны надстройка. Если рамки еще не инициализированы, вызов или обещание будут ждать, пока 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<{ host: Office.HostType, platform: Office.PlatformType }>

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

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.

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

Комментарии

Сведения о поддержке

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.

Дополнительные сведения о требованиях Office и сервере см. в Office надстройки.

Поддерживаемые ведущие приложения по платформе

Office для Windows Office в веб-браузере Office для iPad
Excel Да Да Да
Word Да Да

Примеры

// The following code example uses the select method 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 для использования псевдонима ярлыка; в противном случае является ложным, чтобы отключить его. Значение по умолчанию: true.

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

void

Комментарии

Сведения о поддержке

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.

Дополнительные сведения о требованиях Office и сервере см. в Office надстройки.

Поддерживаемые ведущие приложения по платформе

Office для Windows Office в веб-браузере Office для iPad Outlook на мобильных устройствах Office для Mac
Excel Да Да Да
Outlook Да Да Да Да
PowerPoint Да Да Да
Project Да
Word Да Да Да

Примеры

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; 
}