office package

Классы

Office.TableData

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

OfficeExtension.ClientObject

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

OfficeExtension.ClientRequestContext

Абстрактный объект RequestContext, облегчающий отправку запросов приложению Office. Методы Excel.run and 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.

Office.AddinCommands.Source

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

Office.AsyncContextOptions

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

Office.AsyncResult

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

Когда функция, которую вы передаете callback в параметр «асинхронного» метода, выполняется, она получает объект AsyncResult, доступ к которому можно получить из единственного параметра callback функции.

Office.Auth

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

Office.AuthContext

Представляет сведения о пользователе, которые могут быть переданы в библиотеку проверки подлинности Майкрософт для JavaScript (MSAL.js).

Office.AuthOptions

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

Office.BeforeDocumentCloseNotification

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

Office.Binding

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

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

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

Office.BindingDataChangedEventArgs

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

Office.Bindings

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

Office.BindingSelectionChangedEventArgs

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

Office.Context

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

Office.ContextInformation

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

Office.ContextMenu

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

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

Office.ContextMenuControl

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

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

Office.ContextMenuUpdaterData

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

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

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.ExtensionLifeCycle

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

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. Using Office theme colors is appropriate for mail and task pane add-ins.

Дополнительные сведения о темах Office см. в статье "Изменение внешнего вида Microsoft 365".

Office.OnReadyOptions

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

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.Slide

Представляет один слайд в презентации PowerPoint. Этот интерфейс используется как часть объекта Office.SlideRange , возвращаемого Office.Document.getSelectedDataAsync при вызове с Office.CoercionType.SlideRange.

Office.SlideRange

Представляет выбранные слайды в презентации PowerPoint. Этот объект возвращается при вызове Office.Document.getSelectedDataAsync с Office.CoercionType.SlideRange в PowerPoint.

Office.Tab

Представляет отдельную вкладку и состояние, которое она должна иметь. Примеры кода см. в статьях "Изменение доступности команд надстроек " и "Создание настраиваемых контекстных вкладок".

Office.TableBinding

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

Office.TaskPane

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

Office.TextBinding

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

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

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 события.

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

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 функции прослушивателя событий инициализации возвращает значение перечисления только 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 функции прослушивателя событий инициализации возвращает значение перечисления только InitializationReason для области задач и надстроек содержимого. Она не возвращает значение для надстроек Outlook.

export function initialize(reason: InitializationReason): void;

Параметры

reason
Office.InitializationReason

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

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

void

Комментарии

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

Дополнительные сведения о требованиях к приложению и серверу Office см. в статье Требования к запуску надстроек Office.

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

Office в Интернете Office для Windows Office для Mac Office для iPad Outlook на мобильных устройствах
Excel Поддерживается Поддерживается Поддерживается Поддерживается Неприменимо
Outlook Поддерживается Поддерживается Поддерживается Поддерживается Поддерживается
PowerPoint Поддерживается Поддерживается Поддерживается Поддерживается Неприменимо
Проект Не поддерживается Поддерживается Поддерживается Не поддерживается Неприменимо
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 method.
    $(document).ready(function () {
        // After the DOM is loaded, code specific to the add-in can run.
        // Display initialization reason.
        if (reason === Office.InitializationReason.Inserted) {
            write("The add-in was just inserted.");
        }

        if (reason === Office.InitializationReason.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)

Предупреждение

Теперь этот API является нерекомендуемым.

This API returns inaccurate values when used on desktop applications. Use Office.context.requirements.isSetSupported instead.

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

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

Параметры

name

string

Set name; например, "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 }>

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

Примеры

Office.onReady(function(info) {
    if (info.host === Office.HostType.Excel) {
        // Do Excel-specific initialization (for example, make add-in task pane's
        // appearance compatible with Excel "green").
    }
    if (info.platform === Office.PlatformType.PC) {
        // Make minor layout changes in the task pane.
    }
    console.log(`Office.js is now ready in ${info.host} on ${info.platform}`);
});

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 см. в статье Требования к запуску надстроек Office.

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

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

Примеры

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

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

Office в Интернете Office для Windows Office для Mac Office для iPad Outlook на мобильных устройствах
Excel Поддерживается Поддерживается Не поддерживается Поддерживается Неприменимо
Outlook Поддерживается Поддерживается Поддерживается Поддерживается Поддерживается
PowerPoint Поддерживается Поддерживается Не поддерживается Поддерживается Неприменимо
Проект Не поддерживается Поддерживается Не поддерживается Не поддерживается Неприменимо
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;
}