So passen Sie die CODE-Benutzeroberfläche an und blenden bestimmte Symbolleisten aus

Kurz gesagt: In CODE ändern Sie das allgemeine Symbolleistendesign mit den Einstellungen „Kompakt“ oder „Registerkartenansicht“. Um eine Notebook-Registerkarte oder einen Befehl auszublenden, verwenden Sie die PostMessage-API des WOPI-Hosts. Die normalen Menüs des Viewers blenden einzelne Befehle nicht dauerhaft für alle Benutzer aus. Administratoren können den Standard-Oberflächenmodus für einen Server festlegen, während Hosts, die CODE einbetten, Sitzungsnachrichten zum Ein- oder Ausblenden senden können.

Wählen Sie die Methode, die Ihren Zugriffsrechten entspricht. Benötigen Sie lediglich mehr Platz im Dokument, blenden Sie die Symbolleiste aus oder wechseln Sie zur Kompaktansicht. Soll Ihre WOPI-Integration die Registerkarte „Hilfe“ oder einen Formatierungsbefehl ausblenden, senden Sie die entsprechende PostMessage, nachdem der Editor bereit ist. Um Aktionen wie Drucken, Herunterladen oder Bearbeiten zu verhindern, verwenden Sie die entsprechende WOPI-Funktion oder -Berechtigung. Das Ausblenden einer Schaltfläche ändert die Darstellung, nicht die Autorisierung.

Wählen Sie die passende Anpassung

Das entsprechende SDK-Handbuch gibt Hide_NotebookTabdie Verfügbarkeit ab Version 24.04.11.1 und Hide_Commandab Version 24.04.11.2 an. CODE-Release-Pakete und Integrator-Builds können sich unterscheiden. Überprüfen Sie daher die Version des Servers, den Sie tatsächlich verwenden, bevor Sie sich auf eine API-Meldung verlassen.

Ändern Sie die Standardeinstellung zwischen Kompakt- und Registerkartenansicht.

Die Kompaktansicht verwendet ein Menü und eine kleinere Symbolleiste. Die Registerkartenansicht gruppiert Steuerelemente in Registerkarten der Notebook-Leiste. Die Servereinstellung ist „“ user_interface.mode, mit den unterstützten Werten „“ compactund tabbed„“. Ältere Bezeichnungen wie „“ classicund „“ notebookbarsind zugunsten dieser Namen veraltet.

Um eine vom Administrator festgelegte Standardeinstellung festzulegen, bearbeiten Sie den vorhandenen <mode>Eintrag im <user_interface>Abschnitt 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>

Verwenden Sie compactstattdessen tabbeddas kompakte Menü. Ändern Sie in einer Konfigurationsdatei den vorhandenen Moduseintrag, anstatt einen zweiten hinzuzufügen. Der genaue Konfigurationspfad und die Neustartprozedur hängen davon ab, ob CODE als Paket, Container oder über eine andere Plattform installiert wurde. Befolgen Sie die Konfigurationsmethode dieser Bereitstellung, starten Sie den Dienst bei Bedarf neu oder laden Sie ihn neu und öffnen Sie eine neue Dokumentsitzung, um die Standardeinstellungen zu bestätigen.

Dies legt einen Standard-Oberflächenmodus fest; ein bestimmter Befehl wird dadurch nicht ausgeblendet. Benutzer oder Integratoren können gespeicherte Oberflächeneinstellungen haben, die je nach Konfiguration des gespeicherten UI-Zustands des Servers Vorrang haben. Falls sich ein Browser immer wieder in einer anderen Ansicht öffnet, testen Sie eine neue Sitzung und überprüfen Sie das Verhalten der Benutzereinstellungen des Integrators, bevor Sie weitere Servereinstellungen ändern.

Die Symbolleiste ausblenden, ohne die Befehle zu entfernen

Wenn es lediglich darum geht, mehr Platz im Dokument zu schaffen, genügt es in der Regel, die Registerkartenleiste auszublenden. Die entsprechende Collapse_NotebookbarMeldung des SDKs blendet die Schaltflächen der Registerkartenleiste aus; die Registerkartennamen bleiben jedoch sichtbar, sodass Benutzer die Steuerelemente wieder einblenden können. Dieselbe Meldung blendet auch die Schaltflächenleiste in der Kompaktansicht aus. Dies ist eine reversible Anzeigeänderung und dient nicht dazu, Bearbeitungsfunktionen zu deaktivieren.

In einer unterstützten Benutzeroberfläche kann der Benutzer die Notebook-Leiste durch Interaktion mit der Registerkartenleiste ein- und ausblenden. Das genaue Verhalten beim Klicken oder Doppelklicken kann je nach Ansicht und Loslassen variieren. Wenn Benutzer eine ausgeblendete Leiste wiederherstellen müssen, sollten die Registerkartennamen sichtbar bleiben und die Aktion in derselben CODE-Version getestet werden, die sie verwenden.

Blenden Sie eine Registerkarte oder einen Befehl in einer WOPI-Integration aus.

Die sitzungsbasierte Ausblendung erfordert eine Hostanwendung, die CODE in einem iFrame einbettet und Nachrichten an diesen senden kann. Es handelt sich nicht um eine allgemeine Einstellung, die einfach in die Konfigurationsdatei eingefügt werden kann coolwsd.xml. Die PostMessage-API verwendet Nachrichten mit einem Parameter MessageId, einem Zeitstempel und optional einem Parameter Values. Der WOPI-Host muss den Bereitschaftsaustausch abschließen, bevor er Editorbefehle sendet. Konfigurieren Sie WOPI PostMessageOriginfür die Hostseite und verwenden Sie den exakten Ursprung des CODE-iFrames als Ziel für die Browsernachricht; verwenden Sie keinen Platzhalterursprung.

App_LoadingStatusNachdem der Host das entsprechende Bereitschaftsereignis empfangen und gesendet hat Host_PostmessageReady, kann er eine Ausblendnachricht senden. Beispielsweise blenden die folgenden Aufrufe die Registerkarte „Hilfe“ und den Befehl „Unterstreichen“ für die geöffnete Editor-Sitzung aus:

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

Ersetzen Sie dies office.example.comdurch den Ursprung Ihres eigenen CODE-iFrames. Das Beispiel veranschaulicht die Nachrichtenstruktur; integrieren Sie diese in den Lebenszyklus des Host-iFrames und überprüfen Sie den Ursprung eingehender Nachrichten, bevor Sie antworten. Die CODE-Dokumentation weist darauf hin, dass zuvor gesendete Host-Nachrichten Host_PostmessageReadyignoriert werden können.

Welche Nachricht sollten Sie verwenden?

• Hide_NotebookTabVerwenden Sie diese Funktion für einen gesamten Tab in der Tab-Ansicht. Es idhandelt sich um die Tab-ID, z. B. „Tab 1“ Help. Show_NotebookTabDadurch wird die Änderung rückgängig gemacht. Der Tab bleibt für die Sitzung ausgeblendet, bis eine entsprechende Meldung eintrifft.
• Hide_CommandVerwenden Sie diese ID, wenn der Befehl aus dem Menü, der Symbolleiste und den Kontextmenüs entfernt werden soll. Ein Beispiel für eine ID ist .uno:Underline. Show_CommandDie ID kehrt dies um. Verwenden Sie diese ID nur, wenn das Entfernen des Befehls von all diesen Oberflächen das gewünschte Ergebnis ist.
• Hide_ButtonVerwenden Sie diese Funktion, wenn Sie nur eine einzelne Schaltfläche anstatt aller UI-Einträge für den Befehl ausblenden möchten. Die ID ist die ID einer Symbolleistenschaltfläche und nicht unbedingt der Name des UNO-Befehls. Laut Collabora bleiben diese IDs in der Regel stabil, eine Garantie dafür gibt es jedoch nicht. Überprüfen Sie sie daher anhand des Quellcodes für Ihre spezifische Version und Ihr Gerät.
• Hide_MenubarDadurch wird die gesamte Menüleiste ausgeblendet. Es handelt sich nicht um eine Steuerung pro Befehl und sie sollte nicht mit dem Ausblenden eines Notebookbar-Tabs verwechselt werden.

Die postMessage-API ist für Integrationshosts vorgesehen. Wenn Sie Nextcloud, ownCloud oder eine andere Plattform verwenden, prüfen Sie, ob deren Konnektor eine unterstützte Einstellung bereitstellt, bevor Sie benutzerdefinierten Host-Code erstellen. Vermeiden Sie das Einfügen von CSS in die Editorseite: Dies ist instabil und verdeckt Steuerelemente nur optisch.

Prüfen Sie, ob die Änderung zu Ihrem Anwendungsfall passt.

Öffnen Sie ein Testdokument mit demselben Browser, Dokumenttyp, denselben Berechtigungen und derselben CODE-Version wie Ihre Benutzer. Bestätigen Sie den ausgewählten Modus, prüfen Sie, ob nur die gewünschte Registerkarte oder der gewünschte Befehl ausgeblendet ist, und testen Sie die entsprechende Meldung oder die Aktion zum Erweitern der Symbolleiste. Wiederholen Sie diesen Vorgang für Writer, Calc und Impress, falls Ihre Integration alle drei Programme unterstützt; die verfügbaren Befehle und Symbolleisten-IDs sind nicht unbedingt zwischen den Modulen identisch.

Wenn ein ausgeblendetes Steuerelement weiterhin angezeigt wird, überprüfen Sie, ob der Host die entsprechende Nachricht gesendet hat Host_PostmessageReady, ob WOPI PostMessageOriginund der Ursprung des iFrames korrekt sind und ob die Nachricht die erwartete ID und Schreibweise verwendet hat. Vergleichen Sie außerdem die Serverversion mit der dokumentierten Funktionsbasislinie. Ein erfolgreiches visuelles Ausblenden entfernt den Befehl nicht aus der zugrunde liegenden Dokumenten-Engine und führt keine Sicherheitsbeschränkung ein. Verwenden Sie WOPI-Berechtigungen und Backend-Richtlinien zur Zugriffskontrolle.

Offizielle Referenzen

• Collabora Online SDK-Handbuch, 24.04: Konfiguration und PostMessage-API
• Collabora Online SDK PostMessage API-Dokumentation
• Versionshinweise zu CODE 26.04
• Versionshinweise zu CODE 21.11: Umschalten zwischen Kompakt- und Registerkartenansicht