Office.Ribbon interface

Paket:

office

Eine Schnittstelle, die alle Funktionen enthält, die zum Verwalten des Status des Office-Menübands bereitgestellt werden.

Hinweise

Anforderungssatz: RibbonAPI 1.1

Methoden

requestCreateControls(tabDefinition)	Registriert eine benutzerdefinierte kontextbezogene Registerkarte bei Office und definiert die Steuerelemente der Registerkarte.
requestUpdate(input)	Sendet eine Anforderung an Office, um das Menüband zu aktualisieren.

Details zur Methode

requestCreateControls(tabDefinition)

Registriert eine benutzerdefinierte kontextbezogene Registerkarte bei Office und definiert die Steuerelemente der Registerkarte.

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

Parameter

tabDefinition

Object

Gibt die Eigenschaften und untergeordneten Steuerelemente der Registerkarte und deren Eigenschaften an. Dieser Parameter ist nicht stark typisiert, da seine Form durch ein JSON-Schema definiert wird, das versioniert werden kann. Um das Parameterobjekt zu erstellen, übergeben Sie eine JSON-Zeichenfolge, die dem JSON-Schema des dynamischen Office-Menübands entspricht, an JSON.parse, und übergeben Sie dann das zurückgegebene Objekt an diese Methode. Informationen zum Abrufen von IntelliSense für den JSON-Code in Visual Studio Code finden Sie unter Bearbeiten von JSON mit Visual Studio Code – JSON-Schemas und -Einstellungen.

Gibt zurück

Promise<void>

Hinweise

Anforderungssatz: RibbonAPI 1.2

Diese Methode fordert nur an, dass die Registerkarte registriert wird. Die eigentliche Registrierung wird von der Office-Anwendung gesteuert und ist möglicherweise nicht abgeschlossen, wenn das zurückgegebene Promise Objekt aufgelöst wird. Weitere Informationen und Codebeispiele finden Sie unter Erstellen benutzerdefinierter kontextbezogener Registerkarten.

Beispiele

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

Sendet eine Anforderung an Office, um das Menüband zu aktualisieren.

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

Parameter

input

Office.RibbonUpdaterData

Stellt die Aktualisierungen dar, die am Menüband vorgenommen werden sollen. Beachten Sie, dass nur die im Eingabeparameter angegebenen Änderungen vorgenommen werden.

Gibt zurück

Promise<void>

Hinweise

Anforderungssatz: RibbonAPI 1.1

Beachten Sie, dass diese API nur zum Anfordern eines Updates dient. Die tatsächliche Aktualisierung der Benutzeroberfläche des Menübands wird von der Office-Anwendung gesteuert, und daher kann der genaue Zeitpunkt des Menübandupdates (oder der Aktualisierung) nicht durch den Abschluss dieser API bestimmt werden.

Codebeispiele finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen und Erstellen von benutzerdefinierten Kontextregisterkarten.

Beispiele

// 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);
}