Office.Ribbon interface

包:

office

一个界面，其中包含为管理 Office 功能区状态而提供的所有功能。

注解

要求集： RibbonAPI 1.1

方法

requestCreateControls(tabDefinition)	向 Office 注册自定义上下文选项卡并定义选项卡的控件。
requestUpdate(input)	向 Office 发送更新功能区的请求。

方法详细信息

requestCreateControls(tabDefinition)

向 Office 注册自定义上下文选项卡并定义选项卡的控件。

requestCreateControls(tabDefinition: Object): Promise<void>;

参数

tabDefinition

Object

指定选项卡的属性和子控件及其属性。 此参数不是强类型，因为其形状由可进行版本控制的 JSON 架构定义。 若要创建参数对象，请将符合 Office 动态功能区 JSON 架构的 JSON 字符串传递给 JSON.parse，然后将返回的对象传递给此方法。 若要在 Visual Studio Code 中获取 JSON 的 IntelliSense，请参阅使用 Visual Studio Code 编辑 JSON - JSON 架构和设置。

返回

Promise<void>

注解

要求集： RibbonAPI 1.2

此方法仅请求注册选项卡。 实际注册由 Office 应用程序控制，在解析返回 Promise 的对象时可能无法完成。 有关详细信息和代码示例，请参阅 创建自定义上下文选项卡。

示例

// Registers a custom contextual tab with Office.
Office.onReady(async () => {
    const contextualTabJSON = ` ... `; // Assign the JSON string.
    const contextualTab = JSON.parse(contextualTabJSON);
    await Office.ribbon.requestCreateControls(contextualTab);
});

requestUpdate(input)

向 Office 发送更新功能区的请求。

requestUpdate(input: RibbonUpdaterData): Promise<void>;

参数

input

Office.RibbonUpdaterData

表示要对功能区进行的更新。 请注意，只会进行输入参数中指定的更改。

返回

Promise<void>

注解

要求集： RibbonAPI 1.1

请注意，此 API 仅用于请求更新。 功能区的实际 UI 更新由 Office 应用程序控制，因此无法通过完成此 API 来确定功能区更新 (或刷新) 的确切时间。

有关代码示例，请参阅 启用和禁用外接程序命令 和 创建自定义上下文选项卡。

示例

// Office.Tab objects are properties of ribbon updater objects that are passed to the 
// Office.ribbon.requestUpdate method. The following shows how to set the visibility of 
// a custom contextual tab.

async function showDataTab() {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "CtxTab1",
                visible: true
            }
        ]});
}

// The following does the same thing in TypeScript.

const showDataTab = async () => {
    const myContextualTab: Office.Tab = { id: "CtxTab1", visible: true };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}