Office.Ribbon interface
Uma interface que contém toda a funcionalidade fornecida para gerenciar o estado da faixa de opções do Office.
Comentários
Conjunto de requisitos: RibbonAPI 1.1
Métodos
request |
Registra uma guia contextual personalizada com o Office e define os controles da guia. |
request |
Envia uma solicitação ao Office para atualizar a faixa de opções. |
Detalhes do método
requestCreateControls(tabDefinition)
Registra uma guia contextual personalizada com o Office e define os controles da guia.
requestCreateControls(tabDefinition: Object): Promise<void>;
Parâmetros
- tabDefinition
-
Object
Especifica as propriedades da guia e os controles filho e suas propriedades. Esse parâmetro não é fortemente tipado porque sua forma é definida por um esquema JSON que pode ser versão. Para criar o objeto parâmetro, passe uma cadeia de caracteres JSON que esteja em conformidade com o esquema JSON de faixa de opções dinâmicas do Office para JSON.parse
, e, em seguida, passe o objeto retornado para esse método. Para obter o IntelliSense para o JSON em Visual Studio Code, consulte Editando JSON com Visual Studio Code - esquemas JSON e configurações.
Retornos
Promise<void>
Comentários
Conjunto de requisitos: RibbonAPI 1.2
Esse método solicita apenas que a guia seja registrada. O registro real é controlado pelo aplicativo do Office e pode não ser concluído quando o objeto retornado Promise
for resolvido. Para obter mais informações e exemplos de código, consulte Criar guias contextuais personalizadas.
requestUpdate(input)
Envia uma solicitação ao Office para atualizar a faixa de opções.
requestUpdate(input: RibbonUpdaterData): Promise<void>;
Parâmetros
- input
- Office.RibbonUpdaterData
Representa as atualizações a serem feitas na faixa de opções. Observe que somente as alterações especificadas no parâmetro de entrada são feitas.
Retornos
Promise<void>
Comentários
Conjunto de requisitos: RibbonAPI 1.1
Observe que essa API é apenas para solicitar uma atualização. A atualização real da interface do usuário para a faixa de opções é controlada pelo aplicativo do Office e, portanto, o tempo exato da atualização da faixa de opções (ou atualização) não pode ser determinado pela conclusão desta API.
Para obter exemplos de código, consulte Habilitar e desabilitar comandos de suplemento e criar guias contextuais personalizadas.
Exemplos
// 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);
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de