Office.Tab interface

Paket:

office

Stellt eine einzelne Registerkarte und den Zustand dar, den sie haben soll. Codebeispiele finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen und Erstellen von benutzerdefinierten Kontextregisterkarten.

Hinweise

Anforderungssatz: RibbonAPI 1.1

Beispiele

// Create an Office.Tab object (a contextual tab), set its visibility
// and add it to the ribbon.
async function showDataTab() {
    // Create the Office.Tab object.
    const myContextualTab = { id: "CtxTab1", visible: true };
    const ribbonUpdater = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}

Eigenschaften

controls	Gibt mindestens ein Steuerelement auf der Registerkarte an, z. B. Menüelemente, Schaltflächen usw.
groups	Gibt mindestens eine der Steuerelementgruppen auf der Registerkarte an.
id	Bezeichner der Registerkarte, wie im Manifest angegeben.
visible	Gibt an, ob die Registerkarte im Menüband angezeigt wird. Wird nur mit kontextbezogenen Registerkarten verwendet.

Details zur Eigenschaft

controls

Gibt mindestens ein Steuerelement auf der Registerkarte an, z. B. Menüelemente, Schaltflächen usw.

controls?: Control[];

Eigenschaftswert

Office.Control[]

Hinweise

Wenn das Tab Objekt Teil eines Office.RibbonUpdaterData-Objekts ist, das an die requestUpdateOffice.Ribbon-Methode übergeben wird, gibt diese Eigenschaft die IDs der Steuerelemente an, deren aktivierte status geändert werden soll. Wenn jedoch eine groups Eigenschaft auf der Registerkarte vorhanden ist, wird diese Eigenschaft ignoriert, und die controls Eigenschaften der angegebenen Gruppen müssen verwendet werden, um aktivierte status zu ändern.

groups

Gibt mindestens eine der Steuerelementgruppen auf der Registerkarte an.

groups?: Group[];

Eigenschaftswert

Office.Group[]

Hinweise

Wenn das Tab Objekt Teil eines Office.RibbonUpdaterData-Objekts ist, das an die requestUpdate Methode von Office.Ribbon übergeben wird, geben die controls Eigenschaften der verschiedenen Office.Group-Objekte an, welche Steuerelemente ihre aktivierten status geändert haben. Die controls -Eigenschaft des Tab Objekts wird ignoriert.

Anforderungssatz: RibbonAPI 1.1

id

Bezeichner der Registerkarte, wie im Manifest angegeben.

id: string;

Eigenschaftswert

string

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

visible

Gibt an, ob die Registerkarte im Menüband angezeigt wird. Wird nur mit kontextbezogenen Registerkarten verwendet.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

Anforderungssatz: RibbonAPI 1.2

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