Como personalizar a interface do usuário do CODE e ocultar barras de ferramentas específicas

Resposta curta: No CODE, altere o estilo geral da barra de ferramentas com a configuração de visualização Compacta ou em Abas. Para ocultar uma aba do notebook ou um comando, o método recomendado é a API PostMessage do host WOPI; os menus normais do visualizador não removem permanentemente comandos individuais para todos. Os administradores podem definir o modo de interface padrão para um servidor, enquanto os hosts que incorporam o CODE podem enviar mensagens de ocultação ou exibição em nível de sessão.

Escolha o método que melhor se adapta ao seu nível de acesso. Se você deseja apenas mais espaço para o documento, recolha a barra de ferramentas ou alterne para a visualização Compacta. Se a sua integração WOPI deve omitir a guia Ajuda ou um comando de formatação, envie a mensagem PostMessage correspondente após o editor estar pronto. Se o seu objetivo é impedir uma ação como impressão, download ou edição, utilize também a funcionalidade ou permissão WOPI relevante; ocultar um botão altera a apresentação, não a autorização.

Escolha a personalização certa.

O que você quer mudar?Use este métodoO que isso afeta
Use o menu compacto ou a barra de notas com abas por padrão.Definido user_interface.modena configuração do servidorModo de interface padrão para essa implantação do CODE
Libere temporariamente mais espaço para o documento.Recolha a barra de tarefas na interface do usuário ou envieCollapse_NotebookbarOculta os botões de guia; o usuário pode expandi-los novamente.
Ocultar uma aba da barra de ferramentas, como a Ajuda.EnviarHide_NotebookTabUma aba em uma sessão de editor incorporado ao WOPI
Ocultar um comando em toda a interface do editor.EnviarHide_CommandAs entradas desse comando no menu, na barra de ferramentas e no menu contextual.
Ocultar apenas um botão específico da barra de ferramentasEnviar Hide_Buttoncom o ID do botãoUm botão na barra de ferramentas; o ID pode variar de acordo com a interface do usuário e a versão.

O manual do SDK relevante indica Hide_NotebookTabque a funcionalidade está disponível a partir da versão 24.04.11.1 e também Hide_Commanda partir da versão 24.04.11.2. Os pacotes de lançamento do CODE e as versões de integração podem ser diferentes, portanto, verifique a versão do servidor que você está executando antes de confiar em uma mensagem da API.

Alterar a visualização padrão entre Compacta e com Abas

A visualização compacta usa um menu e uma barra de ferramentas menor. A visualização com abas agrupa os controles nas abas da barra de ferramentas. A configuração do servidor é `<nome_do_servidor>` user_interface.mode, com os valores suportados `<valor_do_servidor>` compacte ` <valor_do_servidor> tabbed`. Rótulos antigos, como `<nome_do_servidor>` e `<valor_do_servidor>`, estão obsoletos classice notebookbarforam substituídos por estes nomes.

Um editor de documentos baseado em navegador exibe uma linha de menu compacta e uma barra de ferramentas de formatação estreita acima de uma página de exemplo.
Visão compacta ilustrativa: o editor utiliza uma linha de menu e uma barra de ferramentas de formatação estreita acima do documento.

Para definir um valor padrão controlado pelo administrador, edite a <mode>entrada existente na <user_interface>seção de coolwsd.xml:

<user_interface>
  <mode type="string" desc="Controls the user interface style. The 'default' means: Take the value from ui_defaults, or decide for one of compact or tabbed (default|compact|tabbed)" default="default">tabbed</mode>
</user_interface>

Use `<mode> compact` em vez de `<mode>` tabbedpara o menu compacto. Em um arquivo de configuração real, altere a entrada de modo existente em vez de adicionar uma segunda. O caminho de configuração exato e o procedimento de reinicialização dependem se o CODE foi instalado como um pacote, contêiner ou por meio de outra plataforma. Siga o método de configuração dessa implantação, reinicie ou recarregue o serviço conforme necessário e abra uma nova sessão de documento para confirmar o padrão.

Isso define um modo de interface padrão; não oculta nenhum comando específico. Um usuário ou integrador pode ter preferências de interface salvas que têm precedência, dependendo da configuração de estado da interface do usuário salva do servidor. Se um navegador continuar abrindo em uma visualização diferente, teste uma nova sessão e verifique o comportamento das preferências do usuário do integrador antes de alterar mais configurações do servidor.

Recolher a barra de ferramentas sem remover os comandos

Quando o objetivo é simplesmente aumentar o espaço disponível no documento, recolher a barra de abas geralmente é suficiente. A Collapse_Notebookbarmensagem do SDK oculta os botões da barra de abas; os nomes das abas permanecem visíveis para que os usuários possam expandir os controles novamente. A mesma mensagem também oculta a barra de botões na visualização Compacta. Essa é uma alteração de exibição reversível, não uma forma de desativar os recursos de edição.

Um editor de documentos exibe a barra de ferramentas com guias, contendo as guias Início, Inserir, Layout, Revisão, Exibir e Ajuda, acima dos controles de formatação agrupados.
Visualização ilustrativa com abas, mostrando as abas da barra de ferramentas e os controles de formatação agrupados.

Em uma interface compatível, o usuário também pode recolher ou expandir a barra de ferramentas interagindo com a sua faixa de abas. O comportamento exato do clique ou clique duplo pode variar de acordo com a visualização e o momento em que o usuário solta a aba. Se os usuários precisarem restaurar uma barra recolhida, mantenha os nomes das abas visíveis e teste a ação na mesma versão do CODE que eles utilizam.

Ocultar uma guia ou comando em uma integração WOPI

O recurso de ocultação por sessão requer um aplicativo host que incorpore o CODE em um iframe e possa enviar mensagens para ele. Não se trata de uma configuração de uso geral que possa ser simplesmente copiada e colada coolwsd.xml. A API PostMessage utiliza mensagens com um ID MessageId, um timestamp e um ID opcional Values. O host WOPI deve concluir a troca de informações de prontidão antes de enviar comandos do editor. Configure o WOPI PostMessageOriginpara a página host e utilize a origem exata do iframe do CODE como destino da mensagem no navegador; não utilize uma origem de destino curinga.

Após o host receber o App_LoadingStatusevento de prontidão apropriado e enviá-lo Host_PostmessageReady, ele pode enviar uma mensagem de ocultação. Por exemplo, as chamadas a seguir ocultam a guia Ajuda e o comando sublinhado da sessão do editor aberta:

const frame = document.getElementById("collaboraFrame");
const collaboraOrigin = "https://office.example.com";

function sendToCollabora(MessageId, Values = {}) {
  frame.contentWindow.postMessage({
    MessageId,
    SendTime: Date.now(),
    Values
  }, collaboraOrigin);
}

// Call after the WOPI PostMessage readiness exchange.
sendToCollabora("Hide_NotebookTab", { id: "Help" });
sendToCollabora("Hide_Command", { id: ".uno:Underline" });
O editor com abas exibe Início, Inserir, Layout, Revisão e Exibir, com a aba Ajuda oculta.
Exemplo ilustrativo de visualização em abas, com a aba Ajuda oculta e as demais abas da barra de ferramentas ainda visíveis.
A barra de ferramentas do editor omite o controle de sublinhado, enquanto outros controles de formatação permanecem; o painel de código do host exibe uma mensagem Hide_Command para .uno:Underline.
Exemplo ilustrativo de personalização do host WOPI: o comando sublinhado fica oculto, enquanto o restante da barra de ferramentas permanece visível.

Substitua office.example.compela origem do seu próprio iframe CODE. O exemplo ilustra o formato da mensagem; integre-a ao ciclo de vida real do iframe do host e valide a origem das mensagens recebidas antes de responder. A documentação do CODE observa que as mensagens do host enviadas anteriormente Host_PostmessageReadypodem ser ignoradas.

Qual mensagem você deve usar?

  • Hide_NotebookTabUse -o para uma aba inteira na visualização com abas. É ido ID da aba, como por exemplo , `tab1` Help. Show_NotebookTab`tab2` reverte a alteração. A aba permanece oculta durante a sessão até que uma mensagem de exibição seja exibida.
  • Hide_CommandUse este ID quando o comando precisar desaparecer do menu, da barra de ferramentas e dos menus contextuais. Um exemplo de ID é ` .uno:Underline.`. Show_CommandO comando `.` inverte o comportamento. Use este ID somente quando o resultado desejado for remover o comando de todas essas superfícies.
  • Hide_ButtonUse -o quando quiser ocultar um único botão em vez de todas as entradas da interface do usuário para o comando. Seu ID é o ID de um botão da barra de ferramentas, não necessariamente o nome do comando UNO. A documentação da Collabora indica que esses IDs geralmente permanecem estáveis, mas não há garantia; confirme-os com a fonte para sua versão específica e formato de dispositivo.
  • Hide_MenubarEsta opção oculta a barra de menus por completo. Não se trata de um controle individual de cada comando e não deve ser confundida com a ocultação de uma aba da barra de tarefas.

A API postMessage destina-se a um host de integração. Se você utiliza Nextcloud, ownCloud ou outra plataforma, verifique se o conector dela expõe uma configuração compatível antes de criar código personalizado para o host. Evite injetar CSS na página do editor: essa prática é instável entre versões e apenas oculta visualmente os controles.

Verifique se a alteração se adequa ao seu caso de uso.

Abra um documento de teste usando o mesmo navegador, tipo de documento, permissões e versão do CODE que seus usuários. Confirme o modo selecionado, verifique se apenas a guia ou o comando desejado está oculto e teste a mensagem de exibição ou a ação de expansão da barra de ferramentas correspondente. Repita o processo para o Writer, Calc e Impress, caso sua integração seja compatível com os três; os comandos disponíveis e os IDs da barra de ferramentas podem não ser idênticos entre os módulos.

Se um controle oculto ainda aparecer, verifique se o host enviou a mensagem Host_PostmessageReady, se a origem WOPI PostMessageOrigine o destino do iframe estão corretos e se a mensagem usou o ID e a grafia esperados. Verifique também a versão do servidor em relação à versão básica documentada do recurso. Uma ocultação visual bem-sucedida não remove o comando do mecanismo de documentos subjacente nem estabelece uma restrição de segurança. Use permissões WOPI e políticas de backend para controle de acesso.

Referências oficiais

Deixar um comentário

O que é o Microsoft Access? Como funcionam suas ferramentas de banco de dados?

O que é o Microsoft Access? Como funcionam suas ferramentas de banco de dados?

O Microsoft Access é um aplicativo de banco de dados para Windows que permite armazenar registros relacionados, criar consultas, elaborar formulários de entrada de dados e gerar relatórios. Saiba como ele funciona e quando é adequado para você.

Alterar a altura e a largura das linhas de grade no Word 2010

Alterar a altura e a largura das linhas de grade no Word 2010

Aprenda como ajustar a altura e a largura das linhas de grade no Word 2010, alterar a frequência das linhas visíveis e definir o espaçamento horizontal e vertical da grade de desenho subjacente.

Importação e exportação do Office Outlook 2010: Mova dados com um arquivo PST

Importação e exportação do Office Outlook 2010: Mova dados com um arquivo PST

Aprenda como importar um arquivo PST para o Outlook 2010 ou exportar emails, contatos, calendário e tarefas. Siga os menus corretos e evite pastas ausentes ou duplicadas.

Recupere a senha de um arquivo PST do Outlook com o Nucleus Kernel

Recupere a senha de um arquivo PST do Outlook com o Nucleus Kernel

Recupere uma senha esquecida de um arquivo PST do Outlook seguindo os passos atuais do Kernel, incluindo como identificar o arquivo correto, fazer um backup e verificar as limitações da ferramenta.

Como inserir uma página da web em um slide do PowerPoint

Como inserir uma página da web em um slide do PowerPoint

Use o suplemento LiveWeb para inserir um site em um slide do PowerPoint, definir seu tamanho e comportamento de atualização e verificar a compatibilidade antes da apresentação.

Contatos do Outlook 2010: Adicionar pessoas e usar a agenda de endereços

Contatos do Outlook 2010: Adicionar pessoas e usar a agenda de endereços

Aprenda como criar e organizar contatos no Outlook 2010, criar um grupo de contatos e selecionar pessoas salvas na Agenda de Endereços ao endereçar um e-mail.

Como criar um campo de hiperlink no Access 2010

Como criar um campo de hiperlink no Access 2010

Crie um campo de Hiperlink no Access 2010 no Modo de Exibição de Design e, em seguida, adicione e teste links para sites, e-mails ou arquivos compartilhados com os detalhes de destino corretos.

Como remover metadados e conteúdo ocultos de um documento do Word

Como remover metadados e conteúdo ocultos de um documento do Word

Use o Inspetor de Documentos do Word para revisar detalhes do autor, comentários, alterações controladas, texto oculto e outros dados antes de compartilhar, e descubra o que a verificação pode não detectar.

Exportar e importar configurações da Faixa de Opções e da Barra de Ferramentas de Acesso Rápido no Office 2010

Exportar e importar configurações da Faixa de Opções e da Barra de Ferramentas de Acesso Rápido no Office 2010

Mova guias personalizadas da Faixa de Opções e comandos da Barra de Ferramentas de Acesso Rápido no Office 2010 com um arquivo .exportedUI e proteja as configurações já existentes no seu computador de destino.

Converter uma planilha do Excel em papel quadriculado imprimível

Converter uma planilha do Excel em papel quadriculado imprimível

Crie papel quadriculado imprimível no Excel ajustando as dimensões das células, definindo uma área de impressão, escolhendo papel A4 e ativando a impressão de linhas de grade no Excel para desktop.