Office.Control interface

Pacote:
office

Representa um controle ou comando individual e o estado que ele deve ter.

Comentários

Para obter exemplos de código que mostram como usar um Control objeto e suas propriedades, consulte Alterar a disponibilidade de comandos de suplemento e Criar guias contextuais personalizadas.

Conjunto de requisitos: RibbonApi 1.1

Usada por

Exemplos

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

Propriedades

enabled

Indica se o controle deve ser habilitado ou desabilitado. O padrão é true.
id

Identificador do controle, conforme especificado no manifesto.
visible

Especifica se o controle é mostrado ou oculto em uma guia personalizada. O padrão é true.

Detalhes da propriedade

enabled

Indica se o controle deve ser habilitado ou desabilitado. O padrão é true.

enabled?: boolean;

Valor da propriedade

boolean

id

Identificador do controle, conforme especificado no manifesto.

id: string;

Valor da propriedade

string

visible

Especifica se o controle é mostrado ou oculto em uma guia personalizada. O padrão é true.

visible?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de requisitos: RibbonApi 1.3

Importante: a visibilidade dos botões e controles do menu pode ser configurada, mas a visibilidade de itens individuais dentro de um menu não pode ser configurada.

Exemplos

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