office package

类

Office.TableData	表示表或 Office.TableBinding 中的数据。
OfficeExtension.ClientObject	一个抽象代理对象，表示 Office 文档中的对象。 可以从上下文 (或其他代理对象) 创建代理对象，将命令添加到队列以对对象进行操作，然后通过调用 context.sync()将代理对象状态与文档同步。
OfficeExtension.ClientRequestContext	一个抽象的 RequestContext 对象，该对象有助于向 Office 应用程序发出请求。 Excel.run和 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 中 正在发送 的加载项在完成事件处理 ItemSend 时的行为。
Office.AddinCommands.Source	封装外接程序事件的源数据。
Office.AsyncContextOptions	提供一个选项，用于保留任何类型的上下文数据（不变），以便在回调中使用。
Office.AsyncResult	用于封装异步请求的结果的对象，包括状态和错误信息（如果请求失败）。 执行传递给 callback “Async”方法参数的函数时，它将接收一个 AsyncResult 对象，你可以从函数的唯一参数访问该 callback 对象。
Office.Auth	Office 身份验证命名空间 Office.auth提供一种方法，该方法允许 Office 客户端应用程序获取加载项 Web 应用程序的访问令牌。 这也使加载项能够间接访问已登录用户的 Microsoft Graph 数据，而不需要用户第二次登录。
Office.AuthOptions	为 Office 使用 getAccessToken 方法从 AAD v.2.0 获取加载项的访问令牌时提供用户体验选项。
Office.BeforeDocumentCloseNotification	表示可在用户尝试关闭文档时显示的模式通知对话框。 在用户响应之前，文档不会关闭。 通知对话框将允许用户确认关闭文档的请求或取消关闭文档的请求。 此 API 仅在 Excel 中受支持。
Office.Binding	表示对文档部分的绑定。 Binding 对象公开所有绑定所拥有的功能，而不管类型如何。 从不直接调用 Binding 对象。 它是对象的抽象父类，表示每种类型的绑定： Office.MatrixBinding、 Office.TableBinding 或 Office.TextBinding。 这三个对象都从 Binding 对象继承 getDataAsync 和 setDataAsync 方法，这些方法使你能够与绑定中的数据进行交互。 它们还继承用于查询这些属性值的 ID 和类型属性。 此外，MatrixBinding 和 TableBinding 对象揭示特定于矩阵和表的功能的其他方法，如对行和列计数。
Office.BindingDataChangedEventArgs	提供有关引发了 DataChanged 事件的绑定的信息。
Office.Bindings	表示外接程序在文档中所具有的绑定。
Office.BindingSelectionChangedEventArgs	提供有关引发了 SelectionChanged 事件的绑定的信息。
Office.Context	表示外接程序的运行时环境，并提供对 API 的关键对象的访问。 当前上下文作为 Office 的属性存在。 它使用 Office.context进行访问。
Office.ContextInformation	提供有关运行加载项的环境的信息。
Office.Control	表示单个控件或命令及其应具有的状态。
Office.CustomXmlNode	表示文档中的树中的 XML 节点。
Office.CustomXmlPart	表示 Office.CustomXmlParts 集合中的单个 CustomXMLPart。
Office.CustomXmlParts	表示 CustomXmlPart 对象的集合。
Office.CustomXmlPrefixMappings	表示 CustomXmlPart 对象的集合。
Office.Dialog	调用 时 UI.displayDialogAsync 返回的对象。 它公开用于注册事件处理程序和关闭对话框的方法。
Office.DialogMessageOptions	提供有关如何在对话与其父级之间以任一方向发送消息的选项。
Office.DialogOptions	提供对话框显示方式的选项。
Office.DialogParentMessageReceivedEventArgs	提供有关引发事件的父页中的 DialogParentMessageReceived 消息的信息。 若要为 DialogParentMessageReceived 事件添加事件处理程序，请使用 addHandlerAsyncOffice.UI 对象的 方法。
Office.Document	表示与外接程序交互的文档的抽象类。
Office.DocumentSelectionChangedEventArgs	提供有关引发了 SelectionChanged 事件的文档的信息。
Office.Error	提供有关异步数据操作期间发生的错误的具体信息。
Office.File	表示与 Office 外接程序关联的文档文件。
Office.FileProperties
Office.GetBindingDataOptions	提供有关如何获取绑定中的数据的选项。
Office.GetFileOptions	提供用于设置文档将划分到的切片大小的选项。
Office.GetSelectedDataOptions	提供用于自定义返回的数据及其格式设置方式的选项。
Office.GoToByIdOptions	提供用于是否选择导航到的位置的选项。
Office.Group	表示功能区选项卡上的一组控件。 要求集： RibbonAPI 1.1
Office.IPromiseConstructor
Office.MatrixBinding	表示两个维度的行和列的绑定。
Office.NodeDeletedEventArgs	提供有关引发 nodeDeleted 事件的已删除节点的信息。
Office.NodeInsertedEventArgs	提供有关引发 nodeInserted 事件的已插入节点的信息。
Office.NodeReplacedEventArgs	提供有关引发 nodeReplaced 事件的已替换节点的信息。
Office.OfficeTheme	提供了访问 Office 主题颜色的属性。 使用 Office 主题颜色，可以将加载项的配色方案与用户通过文件> Office帐户> Office主题 UI 选择的当前 Office 主题进行协调，该主题将应用于所有 Office 应用程序。 使用 Office 主题颜色适用于邮件和任务窗格外接程序。
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.Tab	表示单个选项卡及其应具有的状态。 有关代码示例，请参阅 启用和禁用外接程序命令 和 创建自定义上下文选项卡。
Office.TableBinding	表示两个维度的行和列的绑定，标题可选。
Office.TextBinding	表示文档中的绑定文本选择。 TextBinding 对象从 Office.Binding 对象继承id属性、type 属性、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	指定应加载对象的哪些属性。 执行 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.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 应用程序的 OS 或其他平台。
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.ValueFormat	指定由调用方法返回的值（如数字和日期）返回时应用了其格式设置。
Office.VisibilityMode	加载项的可见性模式。

函数

Office.initialize(reason)	加载运行时环境和外接程序准备好开始与应用和托管文档交互时发生。 initialize 事件侦听器函数的 reason 参数返回一个 InitializationReason 枚举值，该值指定初始化的发生方式。 任务窗格外接程序或内容外接程序可以通过下列两种方式进行初始化： 用户刚刚从 Office 应用程序中功能区的“插入”选项卡上的“加载项”下拉列表的“最近使用的加载项”部分或“插入加载项”对话框中插入它。 用户打开已包含外接程序的文档。 注意：initialize 事件侦听器函数的 reason 参数仅返回 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)

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

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

• 用户刚刚从 Office 应用程序中功能区的“插入”选项卡上的“加载项”下拉列表的“最近使用的加载项”部分或“插入加载项”对话框中插入它。

• 用户打开已包含外接程序的文档。

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

export function initialize(reason: InitializationReason): void;

参数

reason

Office.InitializationReason

指示应用的初始化方式。

返回

void

注解

支持详细信息

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

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

	Windows 版 Office	Web 浏览器中的 Office	iPad 版 Office	移动设备上的 Outlook	Mac 版 Office
Excel	支持	支持	支持		支持
前景	支持	支持		支持	支持
幻灯片	支持	支持	支持		支持
项目	支持				支持
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 == "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 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.select(expression, callback)

返回表达式中描述的 对象的承诺。 仅当函数失败时，才会调用回调。

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

参数

expression

string

要检索的对象。 示例“bindings#BindingName”检索名为“BindingName”的绑定的绑定承诺

callback

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

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。

返回

Office.Binding

注解

支持详细信息

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

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

	Windows 版 Office	Web 浏览器中的 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 外接程序的要求。

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

	Windows 版 Office	Web 浏览器中的 Office	iPad 版 Office	移动设备上的 Outlook	Mac 版 Office
Excel	支持	支持	支持
前景	支持	支持		支持	支持
幻灯片	支持	支持	支持
项目	支持
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; 
}