office package

类

Office.TableData	表示表或 Office.TableBinding 中的数据。
OfficeExtension.ClientObject	表示 Office 文档中的对象的抽象代理对象。从上下文 (或其他代理对象) 创建代理对象，向队列中添加命令以对对象进行操作，然后通过调用 `context.sync()`将代理对象状态与文档同步。
OfficeExtension.ClientRequestContext	有助于请求 Office 应用程序的抽象 RequestContext 对象。 `Excel.run` and `Word.run` 方法提供请求上下文。
OfficeExtension.ClientResult	包含返回基元类型的方法的结果。调用后 `context.sync()` 从文档中检索对象的 value 属性。
OfficeExtension.EmbeddedSession	表示嵌入在 SharePoint 页面中的 Visio 图表的会话。有关详细信息，请参阅 Visio JavaScript API 概述。
OfficeExtension.Error	如果承诺在处理请求时因错误而被拒绝，则返回的 `context.sync()`错误对象。
OfficeExtension.ErrorCodes	表示 OfficeExtension.Error.code 可以返回的错误代码。若要了解有关错误代码的详细信息，请参阅 Office 常见 API 错误代码。
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` 给 “Async” 方法参数的函数执行时，它会收到一个 AsyncResult 对象，您可以从该函数的唯一参数访问 `callback` 该对象。
Office.Auth	Office 身份验证命名空间为 `Office.auth`Office 客户端应用程序提供获取加载项 Web 应用程序访问令牌的方法。这也使加载项能够间接访问已登录用户的 Microsoft Graph 数据，而不需要用户第二次登录。
Office.AuthContext	表示可传递到适用于 JavaScript 的 Microsoft 身份验证库 (MSAL.js) 的用户信息。
Office.AuthOptions	当 Office 使用该 `getAccessToken` 方法从 AAD v.2.0 获取加载项的访问令牌时，提供用户体验选项。
Office.BeforeDocumentCloseNotification	表示当用户尝试关闭文档时可能出现的模式通知对话框。在用户响应前，文档不会关闭。通知对话框将允许用户确认关闭文档的请求或取消关闭文档的请求。此 API 仅在 Excel 中受支持。
Office.Binding	表示与文档某一部分的绑定。 Binding 对象公开所有绑定所拥有的功能，而不管类型如何。绝不会直接调用绑定对象。它是表示每种绑定类型的对象的抽象父类： Office.MatrixBinding、 Office.TableBinding 或 Office.TextBinding。这三个对象都从绑定对象继承了 getDataAsync 和 setDataAsync 方法，使你能够与绑定中的数据进行交互。它们还继承用于查询这些属性值的 ID 和类型属性。此外，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	表示 Office.CustomXmlParts 集合中的单个 CustomXMLPart。
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 应用程序中设置主题。然后，将在所有 Office 应用程序中应用所选主题。使用 Office 主题颜色适用于邮件和任务窗格外接程序。有关 Office 主题的详细信息，请参阅更改 Microsoft 365 的外观。
Office.OnReadyOptions	提供与事件相关的 `onReady` 选项。
Office.RangeCoordinates	按从零开始的行号和/或列号指定单元格、行或列。示例： `{row: 3, column: 4}` 指定第 4 个“ (从零开始的) ”列中第 3 个 (从零开始) 行中的单元格。
Office.RangeFormatConfiguration	指定范围及其格式。
Office.RemoveHandlerOptions	提供用于确定删除哪些事件处理程序或处理程序的选项。
Office.RequirementSetSupport	提供有关当前环境中支持哪些要求集的信息。
Office.Ribbon	一个界面，其中包含提供用于管理 Office 功能区状态的所有功能。
Office.RibbonUpdaterData	指定对功能区的更改，例如按钮的已启用或禁用状态。
Office.SaveSettingsOptions	提供保存设置的选项。
Office.SetBindingDataOptions	提供有关如何在绑定中设置数据的选项。
Office.SetSelectedDataOptions	提供有关如何向所选内容插入数据的选项。
Office.Settings	表示作为名称/值对存储在主机文档中的任务窗格或内容外接程序的自定义设置。
Office.SettingsChangedEventArgs	提供有关引发了 settingsChanged 事件的设置的信息。若要为 settingsChanged 事件添加事件处理程序，请使用 Office.Settings 对象的 addHandlerAsync 方法。仅当加载项的脚本调用 Settings.saveAsync 方法以将设置的内存内副本保存到文档文件中时，才会触发 settingsChanged 事件。调用 Settings.set 或 Settings.remove 方法时，不会触发 settingsChanged 事件。 settingsChanged 事件旨在当在共享 (共同创作的) 文档中使用你的加载项时，当两个或更多用户尝试同时保存设置时，你能够处理潜在的冲突。重要提示：当加载项使用任何 Excel 客户端运行时，加载项的代码可以为 settingsChanged 事件注册处理程序，但是仅当加载项包含以 Excel web 版打开的电子表格，并且多个用户正在编辑电子表格 (共同创作) 时，才会触发此事件。因此，实际上，只有共同创作方案中的 Excel web 版才支持 settingsChanged 事件。
Office.Slice	表示文档文件的切片。使用该 `File.getSliceAsync` 方法访问 Slice 对象。
Office.Slide	表示 PowerPoint 演示文稿中的一张幻灯片。当使用 Office.CoercionType.SlideRange 调用时，此接口用作 Office.Document.getSelectedDataAsync 返回的 Office.SlideRange 对象的一部分。
Office.SlideRange	表示 PowerPoint 演示文稿中的所选幻灯片。在 PowerPoint 中使用 Office.CoercionType.SlideRange 调用 Office.Document.getSelectedDataAsync 时返回此对象。
Office.Tab	表示单个选项卡及其应具有的状态。有关代码示例，请参阅更改加载项命令的可用性和创建自定义上下文选项卡。
Office.TableBinding	表示两个维度的行和列的绑定，标题可选。
Office.TaskPane	提供管理加载项任务窗格的方法。
Office.TextBinding	表示文档中的绑定文本选择。 TextBinding 对象从 Office.Binding 对象继承`id`属性、类型属性、getDataAsync 方法和 setDataAsync 方法。它不实现其自身的任何其他属性或方法。
Office.UI	提供对象和方法，用于在 Office 加载项中创建和操作 UI 组件（如对话框）。有关如何配置对话框的指南，请参阅在 Office 加载项中使用对话框 API。
Office.Urls	提供加载项使用的运行时环境的 URL。
Office.VisibilityModeChangedMessage	调用中使用的 `onVisibilityModeChanged` 消息。
OfficeExtension.DebugInfo	提供有关错误的信息。
OfficeExtension.EmbeddedOptions	指定嵌入在 SharePoint 页面中的 Visio 图表的会话的选项。由的构造函数 `EmbeddedSession`调用。有关详细信息，请参阅 Visio JavaScript API 概述。
OfficeExtension.EventInfo	由 Office 用于构造事件处理程序。请勿调用代码。
OfficeExtension.LoadOption	指定应加载对象的哪些属性。执行同步 () 方法时会发生此加载。这将同步 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.ViewSelectionChangedOffice.EventType.TaskSelectionChanged`事件类型。只有 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	指定表格式方法的 cellFormat 参数中属性的枚举值`cells`。
Office.ThemeId	指定当前选择的 Office 主题。有关 Office 主题的信息，请参阅更改 Microsoft 365 的外观。
Office.ValueFormat	指定由调用方法返回的值（如数字和日期）返回时应用了其格式设置。
Office.VisibilityMode	加载项的可见性模式。

函数

Office.initialize(reason)	加载运行时环境和外接程序准备好开始与应用和托管文档交互时发生。初始化事件侦听器函数的 reason 参数返回一个 `InitializationReason` 枚举值，该枚举值指定初始化是如何发生的。任务窗格外接程序或内容外接程序可以通过下列两种方式进行初始化：用户刚刚从 Office 应用程序功能区的“插入”选项卡上“加载项”下拉列表的“最近使用的加载项”部分或从“插入加载项”对话框插入了它。用户打开已包含外接程序的文档。注意：“初始化事件侦听器函数的原因参数仅返回 `InitializationReason` 任务窗格和内容加载项的枚举值。它不返回 Outlook 加载项的值。
Office.isSetSupported(name, minVersion)	检查 Office 应用程序是否支持指定的要求集。
Office.onReady(callback)	确保 Office JavaScript API 已可供加载项调用。如果框架尚未初始化，回调或承诺将等到 Office 应用程序准备好接受 API 调用。请注意，尽管此 API 旨在在 Office 加载项内使用，但它也可以在外接程序外部使用。在这种情况下，一旦 Office.js 确定它在 Office 应用程序外部运行，它将调用回调，并使用“null”解析应用程序和平台的承诺。
Office.select(expression, callback)	返回表达式中描述的对象的承诺。仅当函数失败时才调用回调。
Office.useShortNamespace(useShortNamespace)	打开和关闭 `Office` 完整 `Microsoft.Office.WebExtension` 命名空间的别名。

Office.initialize(reason)

加载运行时环境和外接程序准备好开始与应用和托管文档交互时发生。

初始化事件侦听器函数的 reason 参数返回一个 InitializationReason 枚举值，该枚举值指定初始化是如何发生的。任务窗格外接程序或内容外接程序可以通过下列两种方式进行初始化：

用户刚刚从 Office 应用程序功能区的“插入”选项卡上“加载项”下拉列表的“最近使用的加载项”部分或从“插入加载项”对话框插入了它。
用户打开已包含外接程序的文档。

注意：“初始化事件侦听器函数的原因参数仅返回 InitializationReason 任务窗格和内容加载项的枚举值。它不返回 Outlook 加载项的值。

export function initialize(reason: InitializationReason): void;

参数

reason: Office.InitializationReason

指示应用的初始化方式。

返回

void

注解

支持详细信息

有关 Office 应用程序和服务器要求的详细信息，请参阅运行 Office 加载项的要求。

支持的应用程序（按平台）

	Office 网页版	Windows 版 Office	Mac 版 Office	iPad 版 Office	移动设备上的 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

设置名称;例如，“MatrixBindings”。

minVersion: string

所需的最低版本;例如，“1.4”。

返回

boolean

Office.onReady(callback)

确保 Office JavaScript API 已可供加载项调用。如果框架尚未初始化，回调或承诺将等到 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.Binding

注解

支持详细信息

有关 Office 应用程序和服务器要求的详细信息，请参阅运行 Office 加载项的要求。

支持的应用程序（按平台）

	Office 网页版	Windows 版 Office	iPad 版 Office
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 网页版	Windows 版 Office	Mac 版 Office	iPad 版 Office	移动设备上的 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;
}

类

接口

类型别名

枚举

函数

函数详细信息

Office.initialize(reason)

参数

返回

注解

示例

Office.isSetSupported(name, minVersion)

参数

返回

Office.onReady(callback)

参数

返回

示例

Office.select(expression, callback)

参数

返回

注解

示例

Office.useShortNamespace(useShortNamespace)

参数

返回

注解

示例

反馈