Office.Control interface

Paquete:
office

Representa un control o comando individual y el estado que debe tener.

Comentarios

Para obtener ejemplos de código que muestran cómo utilizar un Control objeto y sus propiedades, vea Cambiar la disponibilidad de los comandos de complemento y Crear pestañas contextuales personalizadas.

Conjunto de requisitos: RibbonApi 1.1

Usada por

Ejemplos

// This snippet enables a control (a button) in a custom ribbon tab.
// Note that "MyButton", "OfficeAddinTab1", and "CustomGroup111" are defined in the manifest.
const enableButton = async () => {
    const button: Control = { id: "MyButton", enabled: true };
    const parentGroup: Group = { id: "CustomGroup111", controls: [button] };
    const parentTab: Tab = { id: "OfficeAddinTab1", groups: [parentGroup] };
    const ribbonUpdater: RibbonUpdaterData = { tabs: [parentTab] };
    Office.ribbon.requestUpdate(ribbonUpdater);
}

Propiedades

enabled

Indica si el control debe habilitarse o deshabilitarse. El valor predeterminado es true.
id

Identificador del control tal y como se especifica en el manifiesto.
visible

Especifica si el control se muestra u oculta en una pestaña personalizada. El valor predeterminado es true.

Detalles de las propiedades

enabled

Indica si el control debe habilitarse o deshabilitarse. El valor predeterminado es true.

enabled?: boolean;

Valor de propiedad

boolean

id

Identificador del control tal y como se especifica en el manifiesto.

id: string;

Valor de propiedad

string

visible

Especifica si el control se muestra u oculta en una pestaña personalizada. El valor predeterminado es true.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de requisitos: RibbonApi 1.3

Importante: Se puede configurar la visibilidad de los botones y los controles del menú, pero no se puede configurar la visibilidad de los elementos individuales dentro de un menú.

Ejemplos

// Hide the Export Report button from the ribbon.
const button: Office.Control = {
    id: "Contoso.ExportReportButton",
    visible: false
};

// Specify the button's parent group and tab.
const group: Office.Group = {
    id: "Contoso.ReportingGroup",
    controls: [button]
};
const tab: Office.Tab = {
    id: "Contoso.UserToolsTab",
    groups: [group]
};

// Apply the change to the ribbon.
const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [tab] };
await Office.ribbon.requestUpdate(ribbonUpdater);