office package

Классы

Office.TableData

Представляет данные в таблице или в Office. TableBindingRepresents the data in a table or an Office.TableBinding.

OfficeExtension.ClientObject

Абстрактный прокси-объект, представляющий объект в документе Office.An abstract proxy object that represents an object in an Office document. Прокси-объекты создаются из контекста (или из других объектов прокси-сервера), добавляют команды в очередь для работы с объектом, а затем синхронизируют состояние прокси-объекта с документом, вызываяcontext.sync()You create proxy objects from the context (or from other proxy objects), add commands to a queue to act on the object, and then synchronize the proxy object state with the document by calling context.sync().

OfficeExtension.ClientRequestContext

Абстрактный объект RequestContext, упрощающий запросы к ведущему приложению Office.An abstract RequestContext object that facilitates requests to the host Office application. Методы Excel.run и Word.run предоставляют контекст запроса.The Excel.run and Word.run methods provide a request context.

OfficeExtension.ClientResult

Содержит результат для методов, которые возвращают простые типы.Contains the result for methods that return primitive types. Свойство Value объекта извлекается из документа после context.sync() вызова.The object's value property is retrieved from the document after context.sync() is invoked.

OfficeExtension.EmbeddedSession

Представляет данные в таблице или в Office. TableBindingRepresents the data in a table or an Office.TableBinding.

OfficeExtension.Error

Объект Error, возвращенныйcontext.sync()The error object returned by context.sync(), если обещание отклонено из-за ошибки при обработке запроса., if a promise is rejected due to an error while processing the request.

OfficeExtension.ErrorCodes

Представляет данные в таблице или в Office. TableBindingRepresents the data in a table or an Office.TableBinding.

OfficeExtension.EventHandlerResult

Представляет данные в таблице или в Office. TableBindingRepresents the data in a table or an Office.TableBinding.

OfficeExtension.EventHandlers

Представляет данные в таблице или в Office. TableBindingRepresents the data in a table or an Office.TableBinding.

OfficeExtension.TrackedObjects

Коллекция отслеживаемых объектов, которая находится в контексте запроса.Collection of tracked objects, contained within a request context. Дополнительные сведения см. в разделе "Context. Траккедобжектс".See "context.trackedObjects" for more information.

Интерфейсы

Office.AddBindingFromNamedItemOptions

Предоставляет параметры для настройки создаваемой привязки.Provides options for configuring the binding that is created.

Office.AddBindingFromPromptOptions

Предоставляет параметры для настройки подсказки и идентификации создаваемой привязки.Provides options for configuring the prompt and identifying the binding that is created.

Office.AddBindingFromSelectionOptions

Предоставляет параметры для настройки подсказки и идентификации создаваемой привязки.Provides options for configuring the prompt and identifying the binding that is created.

Office.AddinCommands.Event

Объект Event передается в качестве параметра функциям надстроек, вызываемым кнопками команд без пользовательского интерфейса.The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. Этот объект позволяет надстройке определить нажатую кнопку и уведомить узел о завершении обработки.The object allows the add-in to identify which button was clicked and to signal the host that it has completed its processing.

Office.AddinCommands.EventCompletedOptions

Указывает поведение при завершении события.Specifies the behavior for when the event is completed.

Office.AddinCommands.Source

Инкапсулирует исходные данные для событий надстройки.Encapsulates source data for add-in events.

Office.AsyncContextOptions

Предоставляет параметр для сохранения данных контекста любого типа без изменений для использования при обратном вызове.Provides an option for preserving context data of any type, unchanged, for use in a callback.

Office.AsyncResult

Объект, который инкапсулирует результат асинхронного запроса, включая сведения о состоянии и ошибке, если запрос завершился ошибкой.An object which encapsulates the result of an asynchronous request, including status and error information if the request failed.

При выполнении функции, передаваемой в callback параметр асинхронного метода, он получает объект AsyncResult, к которому можно получить доступ только из параметра callback функции.When the function you pass to the callback parameter of an "Async" method executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

Office.Auth

Пространство имен Office AUTH, Office. Context. auth предоставляет метод, позволяющий ведущему приложению Office получать маркер доступа к веб-приложению надстройки.The Office Auth namespace, Office.context.auth, provides a method that allows the Office host to obtain an access token to the add-in's web application. Косвенно это также дает возможность надстройке получать доступ к данным Microsoft Graph пользователя, вошедшего в систему, не требуя от пользователя еще раз выполнить вход в систему.Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.

Office.AuthOptions

Предоставляет варианты взаимодействия с пользователем при получении Office маркером доступа к надстройке из AAD v.Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2,0 с методом getAccessTokenAsync.2.0 with the getAccessTokenAsync method.

Office.Binding

Представляет привязку к разделу документа.Represents a binding to a section of the document.

Объект Binding предоставляет функциональные возможности, которыми обладают все привязки, независимо от типа.The Binding object exposes the functionality possessed by all bindings regardless of type.

Объект Binding никогда не вызывается напрямую.The Binding object is never called directly. Это абстрактный родительский класс объектов, представляющих каждый тип привязки: Office. MatrixBindingIt is the abstract parent class of the objects that represent each type of binding: Office.MatrixBinding, Office. TableBinding, Office.TableBindingили Office. TextBinding, or Office.TextBinding. Все три из этих объектов наследуют методы getDataAsync и setDataAsync из объекта Binding, которые позволяют взаимодействовать с данными в привязке.All three of these objects inherit the getDataAsync and setDataAsync methods from the Binding object that enable to you interact with the data in the binding. Они также наследуют свойства id и type и позволяют запрашивать значения этих свойств.They also inherit the id and type properties for querying those property values. Кроме того, объекты MatrixBinding и TableBinding предоставляют дополнительные методы для работы с матрицами и таблицами, например, для подсчета количества строк и столбцов.Additionally, the MatrixBinding and TableBinding objects expose additional methods for matrix- and table-specific features, such as counting the number of rows and columns.

Office.BindingDataChangedEventArgs

Предоставляет сведения о привязке, вызвавшей событие DataChanged.Provides information about the binding that raised the DataChanged event.

Office.Bindings

Представляет привязки, которые есть у надстройки в документе.Represents the bindings the add-in has within the document.

Office.BindingSelectionChangedEventArgs

Предоставляет сведения о привязке, вызвавшей событие SelectionChanged.Provides information about the binding that raised the SelectionChanged event.

Office.Context

Представляет среду выполнения надстройки и открывает доступ к ключевым объектам API.Represents the runtime environment of the add-in and provides access to key objects of the API. Текущий контекст существует как свойство Office.The current context exists as a property of Office. Доступ к нему осуществляется с помощьюOffice.contextIt is accessed using Office.context.

Office.ContextInformation

Предоставляет сведения о среде, в которой выполняется надстройка.Provides information about the environment in which the add-in is running.

Office.CustomXmlNode

Представляет XML-узел в дереве документа.Represents an XML node in a tree in a document.

Office.CustomXmlPart

Представляет один объект CustomXMLPart в семействе Office. CustomXmlParts .Represents a single CustomXMLPart in an Office.CustomXmlParts collection.

Office.CustomXmlParts

Представляет коллекцию объектов CustomXmlPart.Represents a collection of CustomXmlPart objects.

Office.CustomXmlPrefixMappings

Представляет коллекцию объектов CustomXmlPart.Represents a collection of CustomXmlPart objects.

Office.Dialog

Объект, который возвращается при UI.displayDialogAsync вызове.The object that is returned when UI.displayDialogAsync is called. Он предоставляет методы для регистрации обработчиков событий и закрытия диалогового окна.It exposes methods for registering event handlers and closing the dialog.

Office.DialogOptions

Предоставляет параметры для отображения диалогового окна.Provides options for how a dialog is displayed.

Office.Document

Абстрактный класс, представляющий документ, с которым взаимодействует надстройка.An abstract class that represents the document the add-in is interacting with.

Office.DocumentSelectionChangedEventArgs

Предоставляет сведения о документе, который вызвал событие SelectionChanged.Provides information about the document that raised the SelectionChanged event.

Office.Error

Предоставляет конкретные сведения об ошибке, возникшей во время выполнения асинхронной операции с данными.Provides specific information about an error that occurred during an asynchronous data operation.

Office.File

Представляет файл документа, сопоставленный с надстройкой Office.Represents the document file associated with an Office Add-in.

Office.FileProperties

Предоставляет параметры для настройки создаваемой привязки.Provides options for configuring the binding that is created.

Office.GetBindingDataOptions

Предоставляет параметры для получения данных в привязке.Provides options for how to get the data in a binding.

Office.GetFileOptions

Предоставляет параметры для задания размера срезов, на которые будет разбит документ.Provides options for setting the size of slices that the document will be divided into.

Office.GetSelectedDataOptions

Предоставляет параметры для настройки возвращаемых данных и их форматирования.Provides options for customizing what data is returned and how it is formatted.

Office.GoToByIdOptions

Предоставляет параметры для выбора расположения, к которому выполняется переход.Provides options for whether to select the location that is navigated to.

Office.IPromiseConstructor

Предоставляет параметры для настройки создаваемой привязки.Provides options for configuring the binding that is created.

Office.MatrixBinding

Представляет привязку в двух измерениях строк и столбцов.Represents a binding in two dimensions of rows and columns.

Office.NodeDeletedEventArgs

Предоставляет сведения об удаленном узле, который вызвал событие nodeDeleted.Provides information about the deleted node that raised the nodeDeleted event.

Office.NodeInsertedEventArgs

Предоставляет сведения о вставленном узле, который вызвал событие nodeInserted.Provides information about the inserted node that raised the nodeInserted event.

Office.NodeReplacedEventArgs

Предоставляет сведения о замененном узле, который вызвал событие nodeReplaced.Provides information about the replaced node that raised the nodeReplaced event.

Office.OfficeTheme

Предоставляет доступ к свойствам цветов темы Office.Provides access to the properties for Office theme colors.

С помощью цветов тем Office вы можете согласовать цветовую схему надстройки с текущей темой Office, выбранной пользователем с помощью ПОЛЬЗОВАТЕЛЬСКОГО интерфейса темы Office > для файлов > Office, которые применяются ко всем ведущим приложениям Office.Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with File > Office Account > Office Theme UI, which is applied across all Office host applications. Using Office theme colors is appropriate for mail and task pane add-ins.Using Office theme colors is appropriate for mail and task pane add-ins.

Office.RangeCoordinates

Задает ячейку, строку или столбец, отменив их номер строки и столбца (от нуля).Specifies a cell, or row, or column, by its zero-based row and/or column number. Пример: {row: 3, column: 4} указывает ячейку в строке "третья" (с отсчетом от нуля) в столбце 4-го (с отсчетом от нуля).Example: {row: 3, column: 4} specifies the cell in the 3rd (zero-based) row in the 4th (zero-based) column.

Office.RangeFormatConfiguration

Задает диапазон и его форматирование.Specifies a range and its formatting.

Office.RemoveHandlerOptions

Предоставляет параметры для определения обработчика событий или обработчиков, которые удаляются.Provides options to determine which event handler or handlers are removed.

Office.RequirementSetSupport

Предоставляет сведения о том, какие наборы требований поддерживаются в текущей среде.Provides information about what Requirement Sets are supported in current environment.

Office.SaveSettingsOptions

Предоставляет параметры для сохранения параметров.Provides options for saving settings.

Office.SetBindingDataOptions

Предоставляет параметры для настройки данных в привязке.Provides options for how to set the data in a binding.

Office.SetSelectedDataOptions

Предоставляет варианты вставки данных в выделенный фрагмент.Provides options for how to insert data to the selection.

Office.Settings

Представляет пользовательские параметры для надстройки области задач или контентной надстройки, которые хранятся в документе ведущего приложения как пары "имя-значение".Represents custom settings for a task pane or content add-in that are stored in the host document as name/value pairs.

Office.SettingsChangedEventArgs

Предоставляет сведения о параметрах, вызвавших событие settingsChanged.Provides information about the settings that raised the settingsChanged event.

Чтобы добавить обработчик событий для события settingsChanged, используйте метод addHandlerAsync объекта Office. Settings .To add an event handler for the settingsChanged event, use the addHandlerAsync method of the Office.Settings object.

Событие settingsChanged запускается только в том случае, если скрипт надстройки вызывает метод Settings. saveAsync для сохранения копии параметров в памяти в файле документа.The settingsChanged event fires only when your add-in's script calls the Settings.saveAsync method to persist the in-memory copy of the settings into the document file. Событие settingsChanged не вызывается при вызове методов Settings.set и Settings.remove.The settingsChanged event is not triggered when the Settings.set or Settings.remove methods are called.

Событие settingsChanged было предназначено для обработки потенциальных конфликтов, когда два или более пользователей пытаются сохранить параметры одновременно с использованием надстройки в общем (совместно редактируемом) документе.The settingsChanged event was designed to let you to handle potential conflicts when two or more users are attempting to save settings at the same time when your add-in is used in a shared (co-authored) document.

Важно! код надстройки может зарегистрировать обработчик для события settingsChanged при запуске надстройки в любом клиенте Excel, но событие будет срабатывать только при загрузке надстройки с помощью электронной таблицы, открытой в Excel Online, и нескольких пользователей. редактирует электронную таблицу (совместное редактирование).Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.

Office.Slice

Представляет собой порцию файла документа.Represents a slice of a document file. Доступ к объекту Slice осуществляется с помощью File.getSliceAsync метода.The Slice object is accessed with the File.getSliceAsync method.

Office.TableBinding

Представляет привязку в двух измерениях строк и столбцов, при желании с заголовками.Represents a binding in two dimensions of rows and columns, optionally with headers.

Office.TextBinding

Представляет выбор привязанного текста в документе.Represents a bound text selection in the document.

Объект TextBinding наследует свойство ID, свойство Type, метод getDataAsync и метод setDataAsync из объекта Office. Binding .The TextBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Office.Binding object. Он не реализует дополнительные свойства или методы.It does not implement any additional properties or methods of its own.

Office.UI

Предоставляет объекты и методы, которые можно использовать для создания компонентов ПОЛЬЗОВАТЕЛЬСКОГО интерфейса, например диалоговых окон, в надстройках Office и управления ими.Provides objects and methods that you can use to create and manipulate UI components, such as dialog boxes, in your Office Add-ins.

Посетите страницу "Использование API диалогОвых окон в надстройках OfficeVisit "Use the Dialog API in your Office Add-ins"для получения дополнительных сведений." for more information.

OfficeExtension.DebugInfo

Предоставляет сведения об ошибке.Provides information about an error.

OfficeExtension.EmbeddedOptions

Предоставляет параметры для настройки создаваемой привязки.Provides options for configuring the binding that is created.

OfficeExtension.EventInfo

Предоставляет параметры для настройки создаваемой привязки.Provides options for configuring the binding that is created.

OfficeExtension.LoadOption

Указывает, какие свойства объекта должны загружаться.Specifies which properties of an object should be loaded. Эта загрузка происходит при выполнении метода Sync ().This load happens when the sync() method is executed. Это синхронизирует состояния между объектами Office и соответствующими прокси-объектами JavaScript.This synchronizes the states between Office objects and corresponding JavaScript proxy objects.

OfficeExtension.RequestContextDebugInfo

Содержит отладочные сведения о контексте запроса.Contains debug information about the request context.

OfficeExtension.RequestUrlAndHeaderInfo

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

OfficeExtension.RunOptions

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

OfficeExtension.UpdateOptions

Предоставляет возможность отключать сообщение об ошибке, когда объект, используемый для задания нескольких свойств, пытается задать свойства, предназначенные только для чтения.Provides an option for suppressing an error when the object that is used to set multiple properties tries to set read-only properties.

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

Office.ActiveView

Указывает состояние активного представления документа, например возможность редактирования документа пользователем.Specifies the state of the active view of the document, for example, whether the user can edit the document.

Office.AsyncResultStatus

Указывает результат асинхронного вызова.Specifies the result of an asynchronous call.

Office.BindingType

Указывает тип объекта привязки, который нужно вернуть.Specifies the type of the binding object that should be returned.

Office.CoercionType

Указывает способ приведения данных, возвращаемых или задаваемых вызванным методом.Specifies how to coerce data returned or set by the invoked method.

Office.CustomXMLNodeType

Указывает тип узла XML.Specifies the type of the XML node.

Office.DocumentMode

Указывает атрибут документа в соответствующем приложении: только чтение или чтение и запись.Specifies whether the document in the associated application is read-only or read-write.

Office.EventType

Указывает тип вызванного события.Specifies the kind of event that was raised. Возвращается type свойством объекта EventArgs *.Returned by the type property of an *EventArgs object.

Надстройки для поддержки ProjectOffice.EventType.ResourceSelectionChangedAdd-ins for Project support the Office.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChangedи Office.EventType.ViewSelectionChanged типы событий., and Office.EventType.ViewSelectionChanged event types.

Office.FileType

Указывает формат, в котором возвращается документ.Specifies the format in which to return the document.

Office.FilterType

Указывает, применяется ли фильтрация из ведущего приложения при извлечении данных.Specifies whether filtering from the host application is applied when the data is retrieved.

Office.GoToType

Указывает тип места или объекта, к которому нужно перейти.Specifies the type of place or object to navigate to.

Office.HostType

Указывает ведущее приложение Office, в котором работает надстройка.Specifies the host Office application in which the add-in is running.

Office.Index

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

Office.InitializationReason

Указывает, была ли надстройка вставлена в документ только что или ранее.Specifies whether the add-in was just inserted or was already contained in the document.

Office.PlatformType

Указывает ОС или другую платформу, на которой работает ведущее приложение Office.Specifies the OS or other platform on which the Office host application is running.

Office.ProjectProjectFields

Указывает поля проекта, доступные в качестве параметра для документа .Specifies the project fields that are available as a parameter for the Documentметод. getProjectFieldAsync..getProjectFieldAsync method.

Office.ProjectResourceFields

Указывает поля ресурса, доступные в качестве параметра для документа .Specifies the resource fields that are available as a parameter for the Documentметод. getResourceFieldAsync..getResourceFieldAsync method.

Office.ProjectTaskFields

Указывает поля задачи, доступные в качестве параметра для документаSpecifies the task fields that are available as a parameter for the Documentметод. getTaskFieldAsync..getTaskFieldAsync method.

Office.ProjectViewTypes

Задает типы представлений, которые документSpecifies the types of views that the Documentметод. getSelectedViewAsync может распознать..getSelectedViewAsync method can recognize.

Office.SelectionMode

Указывает, следует ли выделять расположение для перехода (при использовании документаSpecifies whether to select (highlight) the location to navigate to (when using the Documentметод. goToByIdAsync)..goToByIdAsync method).

Office.Table

Указывает перечисляемые значения для cells свойства в параметре cellFormat методов форматирования таблицыSpecifies enumerated values for the cells property in the cellFormat parameter of table formatting methods.

Office.ValueFormat

Указывает, форматируются ли значения, такие как числа и даты, возвращаемые вызванным методом.Specifies whether values, such as numbers and dates, returned by the invoked method are returned with their formatting applied.

Функции

Office.initialize

Происходит, когда среда выполнения загружена и надстройка готова начать взаимодействие с приложением и размещенным документом.Occurs when the runtime environment is loaded and the add-in is ready to start interacting with the application and hosted document.

Параметр Reason функции listener события Initialize возвращает значение InitializationReason перечисления, задающее способ инициализации.The reason parameter of the initialize event listener function returns an InitializationReason enumeration value that specifies how initialization occurred. Надстройку области задач или контентную надстройку можно инициализировать двумя способами:A task pane or content add-in can be initialized in two ways:

  • Пользователь только что вставил раздел "недавно использовавшиеся надстройки" в раскрывающемся списке надстройки на вкладке "Вставка" ленты в ведущем приложении Office или в диалоговом окне "Вставка надстройки".The user just inserted it from Recently Used Add-ins section of the Add-in drop-down list on the Insert tab of the ribbon in the Office host application, or from Insert add-in dialog box.

  • пользователь может открыть документ, который уже содержит надстройку.The user opened a document that already contains the add-in.

Note: параметр Reason функции listener события Initialize возвращает только значение InitializationReason перечисления для надстроек области задач и контентных надстроек. Он не возвращает значения для надстроек Outlook.Note: The reason parameter of the initialize event listener function only returns an InitializationReason enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins.

Office.onReady

Гарантирует, что API JavaScript для Office будут готовы вызываться надстройкой.Ensures that the Office JavaScript APIs are ready to be called by the add-in. Если платформа еще не инициализирована, обратный вызов или обещание ждет, пока ведущее приложение Office не будет готово к приему вызовов API.If the framework hasn't initialized yet, the callback or promise will wait until the Office host is ready to accept API calls. Обратите внимание, что хотя этот API предназначен для использования в надстройке Office, его также можно использовать за пределами надстройки.Note that though this API is intended to be used inside an Office add-in, it can also be used outside the add-in. В этом случае, когда файл Office. js определяет, что он выполняется за пределами ведущего приложения Office, он будет вызывать обратный вызов и разрешать обещание с нулевым значением для узла и платформы.In that case, once Office.js determines that it is running outside of an Office host application, it will call the callback and resolve the promise with "null" for both the host and platform.

Office.select

Возвращает обещание объекта, описанного в выражении.Returns a promise of an object described in the expression. Функция обратного вызова вызывается только в случае сбоя метода.Callback is invoked only if method fails.

Office.useShortNamespace

Включает и выключает Office псевдоним для полного Microsoft.Office.WebExtension пространства имен.Toggles on and off the Office alias for the full Microsoft.Office.WebExtension namespace.

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

Office.initialize

Происходит, когда среда выполнения загружена и надстройка готова начать взаимодействие с приложением и размещенным документом.Occurs when the runtime environment is loaded and the add-in is ready to start interacting with the application and hosted document.

Параметр Reason функции listener события Initialize возвращает значение InitializationReason перечисления, задающее способ инициализации.The reason parameter of the initialize event listener function returns an InitializationReason enumeration value that specifies how initialization occurred. Надстройку области задач или контентную надстройку можно инициализировать двумя способами:A task pane or content add-in can be initialized in two ways:

  • Пользователь только что вставил раздел "недавно использовавшиеся надстройки" в раскрывающемся списке надстройки на вкладке "Вставка" ленты в ведущем приложении Office или в диалоговом окне "Вставка надстройки".The user just inserted it from Recently Used Add-ins section of the Add-in drop-down list on the Insert tab of the ribbon in the Office host application, or from Insert add-in dialog box.

  • пользователь может открыть документ, который уже содержит надстройку.The user opened a document that already contains the add-in.

Note: параметр Reason функции listener события Initialize возвращает только значение InitializationReason перечисления для надстроек области задач и контентных надстроек. Он не возвращает значения для надстроек Outlook.Note: The reason parameter of the initialize event listener function only returns an InitializationReason enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins.

export function initialize(reason: InitializationReason): void;

Параметры

reason
Office.InitializationReason

Указывает способ инициализации приложения.Indicates how the app was initialized.

Возвраты

void

Комментарии

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

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Дополнительные сведения о требованиях к ведущему приложению и серверу Office приведены в статье требования к запуску надстроек OfficeFor more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Поддерживаемые ведущие приложения на разных платформахSupported hosts, by platform

Office для компьютера с WindowsOffice for Windows desktop Office Online (в браузере)Office Online (in browser) Office для iPadOffice for iPad Outlook Web App для устройствOWA for Devices Office для MacOffice for Mac
Обращения Access ДаY
Невозможно Excel ДаY ДаY ДаY
Приложению Outlook ДаY ДаY ДаY ДаY
PowerPoint PowerPoint ДаY ДаY ДаY
Project Project ДаY
Текстовых Word ДаY ДаY ДаY

ПримерыExamples

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

Гарантирует, что API JavaScript для Office будут готовы вызываться надстройкой.Ensures that the Office JavaScript APIs are ready to be called by the add-in. Если платформа еще не инициализирована, обратный вызов или обещание ждет, пока ведущее приложение Office не будет готово к приему вызовов API.If the framework hasn't initialized yet, the callback or promise will wait until the Office host is ready to accept API calls. Обратите внимание, что хотя этот API предназначен для использования в надстройке Office, его также можно использовать за пределами надстройки.Note that though this API is intended to be used inside an Office add-in, it can also be used outside the add-in. В этом случае, когда файл Office. js определяет, что он выполняется за пределами ведущего приложения Office, он будет вызывать обратный вызов и разрешать обещание с нулевым значением для узла и платформы.In that case, once Office.js determines that it is running outside of an Office host application, it will call the callback and resolve the promise with "null" for both the host and platform.

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

Параметры

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

Необязательный метод обратного вызова, который получит сведения об узле и платформе.An optional callback method, that will receive the host and platform info. Кроме того, вместо обратного вызова надстройка может просто подождать, пока она не будет возвращена функцией для разрешения.Alternatively, rather than use a callback, an add-in may simply wait for the Promise returned by the function to resolve.

Возвраты

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

Обещание, содержащее сведения об узле и платформе после завершения инициализации.A Promise that contains the host and platform info, once initialization is completed.

Office.select

Возвращает обещание объекта, описанного в выражении.Returns a promise of an object described in the expression. Функция обратного вызова вызывается только в случае сбоя метода.Callback is invoked only if method fails.

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

Параметры

expression
string

Объект, который требуется получить.The object to be retrieved. Пример "Bindings#биндингнаме", получающий обещание привязки для привязки с именем "биндингнаме"Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'

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

Необязательно.Optional. Функция, вызываемая при возвращении обратного вызова, единственный параметр которой имеет тип Office. AsyncResultA function that is invoked when the callback returns, whose only parameter is of type Office.AsyncResult.

Возвраты

Binding

Комментарии

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

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Дополнительные сведения о требованиях к ведущему приложению и серверу Office приведены в статье требования к запуску надстроек OfficeFor more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Поддерживаемые ведущие приложения на разных платформахSupported hosts, by platform

Office для компьютера с WindowsOffice for Windows desktop Office Online (в браузере)Office Online (in browser) Office для iPadOffice for iPad
Обращения Access ДаY
Невозможно Excel ДаY ДаY ДаY
Текстовых Word ДаY ДаY

ПримерыExamples

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

Включает и выключает Office псевдоним для полного Microsoft.Office.WebExtension пространства имен.Toggles on and off the Office alias for the full Microsoft.Office.WebExtension namespace.

export function useShortNamespace(useShortNamespace: boolean): void;

Параметры

useShortNamespace
boolean

Значение true, чтобы использовать псевдоним ярлыка; в противном случае — false.True to use the shortcut alias; otherwise false to disable it. Значение по умолчанию: true.The default is true.

Возвраты

void

Комментарии

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

Заглавная буква Y в следующей матрице указывает на то, что этот метод поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает этот метод.A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Дополнительные сведения о требованиях к ведущему приложению и серверу Office приведены в статье требования к запуску надстроек OfficeFor more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Поддерживаемые ведущие приложения на разных платформахSupported hosts, by platform

Office для компьютера с WindowsOffice for Windows desktop Office Online (в браузере)Office Online (in browser) Office для iPadOffice for iPad Outlook Web App для устройствOWA for Devices Office для MacOffice for Mac
Обращения Access ДаY
Невозможно Excel ДаY ДаY ДаY
Приложению Outlook ДаY ДаY ДаY ДаY
PowerPoint PowerPoint ДаY ДаY ДаY
Project Project ДаY
Текстовых Word ДаY ДаY ДаY

ПримерыExamples

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