Ein- oder Ausblenden von Add-In-Befehlen auf einer benutzerdefinierten Registerkarte

Die dynamische Sichtbarkeit des Menübands hilft, das Menüband aufzuräumen. Wenn nur die Add-In-Befehle angezeigt werden, die für die einzelnen Benutzer wichtig sind, sind diese Befehle leichter zu finden. Nachdem sich ein Benutzer angemeldet hat, kann Ihr Add-In beispielsweise nur die Funktionen anzeigen, die für diesen Benutzer gelten.

Unterstützte Office-Anwendungen und Anforderungssatz

Für das Festlegen der Sichtbarkeit von Add-In-Befehlen auf benutzerdefinierten Registerkarten ist RibbonApi 1.3-Unterstützung erforderlich. Dieses Feature wird in Excel, PowerPoint und Word unterstützt.

Unterstützte Steuerungen

In der folgenden Tabelle sind die Menübandsteuerelemente aufgeführt, deren Sichtbarkeit auf einer benutzerdefinierten Registerkarte geändert werden kann.

Testen eines vollständigen Add-In-Beispiels

Um die Sichtbarkeit von Steuerelementen auf einem Menüband zu testen, probieren Sie das Beispiel Steuerelemente auf einer benutzerdefinierten Registerkarte des Menübands ein- oder ausblenden aus.

Konfigurieren einer freigegebenen Laufzeit

Um die Sichtbarkeit eines Steuerelements oder einer Gruppe programmgesteuert zu ändern, muss Ihr Add-In eine freigegebene Laufzeit verwenden. Anleitungen finden Sie unter Konfigurieren Ihres Office-Add-Ins für die Verwendung einer freigegebenen Runtime.

Festlegen der anfänglichen Sichtbarkeit im Manifest

Standardmäßig sind Schaltflächen, Gruppen und Menüs auf einer benutzerdefinierten Registerkarte sichtbar, wenn die Office-Anwendung gestartet wird. Um ein Steuerelement anfänglich auszublenden, legen Sie seine "visible" Eigenschaft auf falsefest. Die Position der "visible" Eigenschaft im Manifest hängt vom Steuerelement ab.

• Schaltfläche oder Menü: Angegeben im entsprechenden Schaltflächen- oder Menüobjekt im Array "extensions.ribbons.tabs.groups.controls".
• Gruppe: Wird im entsprechenden Gruppenobjekt im Array "extensions.ribbons.tabs.groups" angegeben.

Im folgenden Beispiel wird eine Beispielberichtsgruppe und ihre Schaltfläche "Bericht anzeigen " so konfiguriert, dass sie beim Starten des Add-Ins sichtbar ist. Die Schaltfläche "Bericht exportieren " in derselben Gruppe ist zunächst ausgeblendet.

"extensions": [
    {
        "ribbons": [
            {
                "tabs": [
                    {
                        "id": "Contoso.UserToolsTab",
                        "label": "User tools",
                        "groups": [
                            {
                                "id": "Contoso.ReportingGroup",
                                "label": "Reporting",
                                "controls": [
                                    {
                                        "id": "Contoso.ViewReportButton",
                                        "type": "button",
                                        "label": "View report",
                                        "icons": [
                                          {
                                            "size": 16,
                                            "url": "icon_16.png"
                                          },
                                          {
                                            "size": 32,
                                            "url": "icon_32.png"
                                          },
                                          {
                                            "size": 80,
                                            "url": "icon_80.png"
                                          }
                                        ],
                                        "supertip": {
                                            "title": "View report",
                                            "description": "View report"
                                        },
                                        "actionId": "viewReport",
                                        "visible": true
                                    },
                                    {
                                        "id": "Contoso.ExportReportButton",
                                        "type": "button",
                                        "label": "Export report",
                                        "icons": [
                                          {
                                            "size": 16,
                                            "url": "icon_16.png"
                                          },
                                          {
                                            "size": 32,
                                            "url": "icon_32.png"
                                          },
                                          {
                                            "size": 80,
                                            "url": "icon_80.png"
                                          }
                                        ],
                                        "supertip": {
                                            "title": "Export report",
                                            "description": "Export report"
                                        },
                                        "actionId": "exportReport",
                                        "visible": false
                                    }
                                ],
                                "visible": true
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

Programmgesteuertes Ändern der Sichtbarkeit

Wenn Sie die Sichtbarkeit einer Schaltfläche, eines Menüs oder einer Gruppe zur Laufzeit ändern möchten, erstellen Sie ein RibbonUpdaterData-Objekt , das Folgendes angibt.

• Die IDs des Steuerelements und der übergeordneten Gruppe und Registerkarte, sofern zutreffend. Die IDs müssen mit denen übereinstimmen, die im Manifest deklariert sind.
• Die Sichtbarkeit des Steuerelements.

Übergeben Sie dann das RibbonUpdaterData-Objekt an die Office.ribbon.requestUpdate-Methode .

Ein- oder Ausblenden einer Schaltfläche oder eines Menüs

Um die Sichtbarkeit einer Schaltfläche oder eines Menüs festzulegen, konfigurieren Sie die Office.Control.visible Eigenschaft. Das folgende Beispiel zeigt eine Schaltfläche. Dasselbe Muster gilt für ein Menüsteuerelement.

async function setButtonVisibility(visible: boolean) {
    const button: Office.Control = {
        id: "Contoso.ExportReportButton",
        visible: visible
    };
    const group: Office.Group = {
        id: "Contoso.ReportingGroup",
        controls: [button]
    };
    const tab: Office.Tab = {
        id: "Contoso.UserToolsTab",
        groups: [group]
    };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [tab] };

    await Office.ribbon.requestUpdate(ribbonUpdater);
}

Ein- oder Ausblenden einer Gruppe

Verwenden Sie die Office.Group.visible Eigenschaft, um die Sichtbarkeit einer Gruppe festzulegen. Im folgenden Beispiel werden eine Gruppe und alle darin enthaltenen Steuerelemente ein- oder ausgeblendet.

async function setGroupVisibility(visible: boolean) {
    const group: Office.Group = {
        id: "Contoso.ReportingGroup",
        visible: visible
    };
    const tab: Office.Tab = { id: "Contoso.UserToolsTab", groups: [group] };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [tab] };

    await Office.ribbon.requestUpdate(ribbonUpdater);
}

Siehe auch

• Add-In-Befehle
• Ändern der Verfügbarkeit von Add-In-Befehlen
• Erstellen benutzerdefinierter kontextbezogener Registerkarten in Office-Add-Ins