Ribbon-Makros

Im Detailbereich einer Ribbonmakroübersicht definiert der Reiter Ribbon-Makros die "Kopfdaten" der Ribbon-Makro-Konfiguration, während der Reiter Makros die Verbindung zwischen Buttons und Befehlen (s. Verfügbare Befehle) herstellt.

Die beiden folgenden Abschnitte erklären die Einstellmöglichkeiten für beide Ebenen der Konfiguration.

Einstellungen im Reiter "Ribbon-Makros"

images/download/attachments/78260270/image2019-6-5_16-28-1-version-1-modificationdate-1630578883321-api-v2.png

Für jedes Ribbon-Makro muss ein Name (1) angegeben werden, der nur im Kontext der Konfiguration erscheint und nicht lokalisierbar ist. Die Eindeutigkeit von Namen wird nicht erzwungen ist aber zwecks Transparenz zumindest unter Ribbon-Makros für denselben Kontext (2) ebenso empfehlenswert wie die optionale Formulierung einer Beschreibung.

Der Kontext (2) wird automatisch befüllt, wenn die Ribbon-Makro-Konfiguration über das Einstellungen-Menü einer Ansicht geöffnet wurde. Das Feld erscheint dann schreibgeschützt, wie im Screenshot zu sehen. Erfolgt der Zugriff über den Menüpunkt Ribbonmakroübersicht kann auch der Kontext editiert werden, etwa um eine Kopie eines Ribbon-Makros einem anderen Kontext zuzuordnen.

Für die Priorität (3) wird der Wert 0 vorbelegt. Dieser Prioritätswert regelt den Vorrang zwischen konkurrierenden Festlegungen durch unterschiedliche Ribbon-Makros in den folgenden Fällen:

  • Mehrere Ribbon-Makros enthalten Definitionen zum Überschreiben (4)/(5) von Merkmalen derselben Hauptkategorie oder Unterkategorie.

  • Mehrere Ribbon-Makros enthalten Definitionen für Makros (s. nächster Abschnitt), die sich auf denselben Button (bzw. Makro-Namen) beziehen.

In beiden Fällen wirkt nur die jeweilige Definition aus dem Ribbon-Makro mit dem höchsten Prioritätswert. Allerdings beschränkt sich dieser Vorrang nur auf direkte Überschneidungen bezüglich eines bestimmten Elements (Kategorie, Makro). Soweit es keine Überschneidungen gibt, wirken die anhand der Zuordnungskriterien anwendbaren Ribbon-Makros dagegen "additiv".

Über die zweistufige Zuordnung über Hauptkategorie (4) und Unterkategorie (5) muss jedes Ribbon-Makro "verortet", also auf einen bestimmten Abschnitt innerhalb des Ribbon-Menüs bezogen, werden. Die als Pflichtfeld klassifizierten Comboboxen bieten dabei alle vordefinierten Kategorien zur Auswahl an, lassen aber auch die Eingabe von Freitext zu. Die Eingabe von Freitext führt dabei zur Erweiterung der bestehenden Strukturebene um einen neuen Tab-Reiter (Hauptkategorie) oder einen neuen Abschnitt im Ribbon-Menü (Unterkategorie).

Für die ausgewählten Kategorien kann jedes Ribbon-Makro optional eigene Definitionen für die Beschriftung (Hauptkategorie Label bzw. Unterkategorie Label) und die Reihenfolgepostion innerhalb der Strukturebene (Hauptkategorie Priorität bzw. Unterkategorie Priorität) beinhalten. Soweit für eine vordefinierte oder durch andere Ribbon-Makros erzeugte benutzerdefinierte Kategorien bereits Festlegungen bestehen, muss die Option Hauptkategorie überschreiben bzw. Unterkategorie überschreiben ausgewählt sein, damit der Wert für das bestehende Merkmal überschrieben werden kann. Sind unterschiedliche Ribbon-Makros anwendbar, die dasselbe Merkmal mit der Option "Überscheiben" adressieren, entscheidet - wie oben bereits erwähnt - deren Priorität (3).

Definitionen für die Beschriftung (Hauptkategorie Label bzw. Unterkategorie Label) können entweder als Freitext angegeben oder per Klick auf das Menüsymbol rechts vom Eingabefeld per Sprachverwaltung bzw. Firmenspezifische Sprachanpassungen zugewiesen werden. Falls das jeweilige Feld keinen Eintrag (oder nur Leerzeichen o. ä.) enthält, bezieht sich das Setzen der Option "Überschreiben" nur auf die Priorität (also die Reihenfolgeposition) der Kategorie, während deren Label unverändert bleibt.

Die folgenden Hauptkategorien sind (teilweise abhängig von Berechtigungen) in Ansichten für alle Datenobjekte vorhanden:

Hauptkategorie (Tab-Reiter)

Standard-Priorität

Allgemein

1000

Export

-50

Einstellungen

-100

Verwaltung

-500

Die Auswahlmöglichkeiten für die Unterkategorie sind weitgehend spezifisch für den jeweiligen Kontext. Entsprechend wechseln die Optionen im Dropdown für die Unterkategorie, passend zur Auswahl für die Hauptkategorie. Auf eine explizite Auflistung aller Unterkategorien wird hier daher verzichtet.

Die Option Automatisches Verstecken der Ribbonleiste verbieten (6) betrifft das dynamische Verhalten des Ribbon-Menüs bei begrenztem Platzangebot für eine Ansicht. Im Allgemeinen wird das Ribbon-Menü in einer Ansicht automatisch "versteckt", sobald in der Vertikalen eines View Slots Platzmangel droht (s. Arbeiten in der Benutzeroberfläche). Sobald in einem Kontext mindestens ein Ribbon-Makro anwendbar ist, das ein "Automatisches Verstecken" per Option verbietet, bleibt das gesamte Ribbon-Menü immer eingeblendet. Das Ribbon Makro muss dazu keine eigenen Makros beinhalten. Zuweisungen für Haupt- und Unterkategorie sind ebenfalls nur aus rein formalen Gründen erforderlich. Das Verbot greift auch, wenn die referenzierte Kategorie nicht im Ribbon-Menü erscheint, weil sie keine Makros beinhaltet.

►ACHTUNG◄ Eine bestehende Auswahl für eine vordefinierte Unterkategorie, ist nur gültig solange die zugehörige vordefinierte Hauptkategorie ausgewählt ist. Die Hauptkategorie kann nachträglich geändert werden. Allerdings wird dabei der interne Name der Unterkategorie als Freitexteingabe interpretiert, so dass im Tab-Reiter für die ausgewählte Hauptkategorie ggf. eine neue benutzerdefinierte Unterkategorie erscheint, die - sofern vorhanden - die als Unterkategorie Label spezifizierte Beschriftung verwendet. Umgekehrt kann ein Wechsel von einer benutzerdefinierten Hauptkategorie zu einer vordefinierten Hauptkategorie dazu führen, dass eine ursprünglich als Freitext interpretierte Eingabe für den Namen einer Unterkategorie zufällig dem internen Namen einer der vordefinierten Unterkategorien in der ausgewählten Hauptkategorie entspricht. In diesem Fall beziehen sich Definitionen des Ribbon-Makros plötzlich auf das Erscheinungsbild der vordefinierten Unterkategorie.

Einstellungen im Reiter "Makros"

Der Tab-Reiter "Makros" enthält Definitionen, die die Ebene einzelner Buttons im Ribbon-Menü betreffen. Als "Makro" wird dabei die Verknüpfung zwischen einem Button und den damit verknüpften Befehlen bezeichnet.

Häufig definiert ein Ribbon-Makro genau ein Makro, etwa wenn ein bestimmter Button abhängig von Zuordnungskriterien kontextabhängig zusätzlich in einer bestimmten Unterkategorie erscheinen soll. Allerdings können durchaus auch mehrere Makros durch dasselbe Ribbon-Makro definiert werden, sofern diese in derselben Unterkategorie enthalten sind. Auch Ribbon-Makros ohne Makros können sinnvoll sein, etwa um nur Überschreibungen für Kategorien (s. voriger Abschnitt) zu regeln.

images/download/attachments/78260270/image2021-9-2_12-39-9-version-1-modificationdate-1630579151318-api-v2.png

Der Tab-Reiter zeigt bereits konfigurierte Makros in der Auswahlzeile (1) an. Jedes Makro wird dabei wie im Ribbon-Menü durch einen Button repräsentiert, der hier rechts oben das Mülltonnen-Symbol zum Entfernen des Makros anbietet.

Die Makros werden links neben dem Platzhalter mit dem images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg Symbol zum Hinzufügen von Makros von rechts nach links aufgereiht. Die Anordnung spiegelt dabei nicht unbedingt das Erscheinungsbild im Ribbon-Makro, das ja auch noch weitere Buttons enthalten kann.

Ein Mausklick auf einen der Buttons zeigt die Details für das Makro im Bereich (2) unterhalb an, wo sie auch bearbeitet werden können.

Die Priorität (3) des Makros bestimmt die Reihenfolgeposition des Buttons im Ribbon-Menü. Die Buttons derselben Unterkategorie werden nach absteigender Priorität von links nach rechts aufgereiht.

Der Name (4) des Makros dient zur eindeutigen Identifikation des Makros innerhalb der im Reiter "Ribbon-Makro" definierten Unterkategorie. Wird innerhalb einer vordefinierten Unterkategorie ein Standardbefehl ausgewählt (s. Abschnitt "Überschreiben, Deaktivieren und Ausblenden von Buttons" unten), erscheint der interne Name für den Standard-Button. Für neu hinzugefügte Makros in einer benutzerdefinierten Unterkategorie wird ein automatisch generierter Wert (z. B. new_1559822118620) vorbelegt. Zwecks Transparenz ist es ratsam diesen durch einen inhaltlich bedeutsamen Text (im Bild: "Save and print") zu ersetzen. Verwenden weitere anwendbare Ribbon-Makros denselben Namen für ein Makro in derselben Unterkategorie, wird nur die Definition aus dem Ribbon-Makro mit der höchsten Priorität berücksichtigt.

Die Icon uri (5) definiert das optionale Icon für den Button im Ribbon. Auch wenn der per Auswählen geöffnete Browser nur Zugriff auf die Standardressourcen für Icons anbietet, könne hier auch andere Pfade relativ zum Web-Ordner angegeben werden, etwa zu Bildern, die per Dateimanager hochgeladen wurden. Farbige Bilder oder Icons erscheinen im Button per Standard in Graustufen, zeigt aber beim "Hovern" (Mauszeigerberührung) die Originalfarbe. Auch erweiterte Gestaltungsmöglichkeiten stehen, wie unter Arbeiten mit Bildressourcen (Icons) beschrieben, können genutzt werden.

Der Beschriftungstext für den Button kann als Label (6) kann direkt eingegeben oder per Klick auf das Menüsymbol rechts daneben über die Sprachverwaltung bzw. Firmenspezifische Sprachanpassungen zugeordnet werden.

Zusätzlich kann dem Benutzer noch ein Tooltip (7) angezeigt werden, wenn er mit dem Mauszeiger über dem Ribbon Button schwebt.

Die Liste Befehle (8) definiert die beim Klick auf den Button auszuführenden Befehle (s. Verfügbare Befehle), also das eigentliche "Makro".

  • Das images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg Symbol öffnet ein gegliederte Kontextmenü aus dem Befehle hinzugefügt werden können.

  • Ausgewählte Befehle können über das 'X' Symbol rechts oben wieder entfernt werden.

  • Die Sequenz "von oben nach unten" abgearbeiteten Befehle kann per Drag & Drop angepasst werden.

  • Innerhalb der Liste kann durch Anklicken ein Befehl ausgewählt werden, für den dann rechts von der Liste Parameter (9) erscheinen, sofern für den Befehl relevant.

►HINWEIS◄ Sind einem Makro keine Befehle zugeordnet, dann erscheint auch der Button nicht im Ribbon-Menü.

Im Bild erscheint für den durch die Rahmenfarbe hervorgehobenen ausgewählten Befehl Details > Speichern das Kennzeichen Erforderlich (9), das als Parameter für alle Befehle unterstützt wird.

  • Wenn das Kennzeichen für einen Befehl in der Kette gesetzt ist, erscheint der Button im Ribbon-Menü nur dann aktiv, wenn im Kontext die Voraussetzungen für die Ausführung des Befehls, etwa eine bestimmte Selektion in einer Übersicht (einfach/mehrfach, s. Verfügbare Befehle), erfüllt sind. Sonst erscheint der Button inaktiv, was die Ausführung des Makros insgesamt verhindert. Im Beispiel setzt der Befehl Details > Speichern eine Einfachauswahl voraus. In einer Übersicht muss also genau ein Element ausgewählt sein, damit der Button aktiv wird.

  • Sind mehrere Befehle der Kette als Erforderlich gekennzeichnet, müssen die entsprechenden Kriterien (vor der Ausführung der Kette) erfüllt sein, damit der Button aktiv erscheint. Würde man im Beispiel oben das Kennzeichen Erforderlich auch noch für den Befehl Befehl Druck > Pdf setzen, der erst mit dem Erstellen eines Datenobjekts anwendbar wird, wäre der Button Speichern und Drucken erst dann aktiv, wenn das Objekt bereits mindestens einmal gespeichert wurde, während er in einer Detailsicht für ein neues Objekt inaktiv angezeigt würde.

►ACHTUNG◄ Das Kennzeichen Erforderlich (9) wird nur ausgewertet, sofern der ausgewählte Befehl im aktuellen Kontext grundsätzlich anwendbar ist. Das ist nicht immer für alle Befehle gewährleistet, die zur Auswahl angeboten werden. Enthält eine Kette einen Befehl, der im Kontext des Ribbon-Makros grundsätzlich nicht anwendbar ist, erscheint der Button auch dann nicht im Menü, wenn die Option "Erforderlich" für diesen Befehl abgewählt ist.

Mit der Option Wiederholungsintervall (10) kann die Funktionalität eines Ribbon Buttons auch in einem Zeitlichen Intervall wiederholt ausgeführt werden.

images/download/attachments/78260270/image2021-9-2_12-44-30-version-1-modificationdate-1630579472541-api-v2.png

Die Option Automatisch starten (A) gibt an, ob das Wiederholungsintervall automatisch gestartet werden soll, sobald der Knopf angezeigt wird.
Zum manuellen Stoppen des Wiederholungsintervalls kann ein anderes Icon (B) und eine andere Beschriftung (C) hinterlegt werden.
Im Beispiel oben werden sämtliche konfigurierte Kommandos alle 30 Sekunden ausgeführt, sobald der Benutzer auf den Ribbon Button drückt.

Überschreiben, Deaktivieren und Ausblenden von Buttons

Wie unter "Details zum Hinzufügen von Makros" (oben) per Beispiel demonstriert, werden die Befehle und das Erscheinungsbild von Standard-Buttons aus vordefinierten Unterkategorien überschrieben, indem ein Makro eingerichtet wird, das den betreffenden internen Namen verwendet. Abhängig von den Prioritäten der Ribbon Makros können sich auch Konfigurationen für benutzerdefinierte Makros gegenseitig überschreiben.

Daneben ist es auch möglich, Buttons per Makro-Konfiguration gezielt zu deaktivieren oder auszublenden. Dazu stehen in der Befehlskategorie Allgemein folgende Befehle bereit:

  • Allgemein > Immer ausgeblendet

  • Allgemein > Immer deaktiviert

Sobald einer dieser beiden Befehle einem Makro hinzugefügt wird, sind alle anderen Befehle irrelevant, da der Button insgesamt ausgeblendet bzw. deaktiviert wird, sofern das Makro anwendbar ist. Enthält ein Makro (unsinnigerweise) beide Befehle, wird der Button ausgeblendet.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg WICHTIG images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg Aus technischen Gründen muss die Option Erforderlich (wie voreingestellt) ausgewählt sein, damit der Befehl Immer deaktiviert wie beschrieben funktioniert.

Konfigurationsbeispiele

Im folgenden Beispiel soll jeweils ein Ribbon-Makro Änderungen für die Unterkategorie "Details" der Hauptkategorie "Allgemein" definieren:


Beispiel 1: Der Button Abbrechen soll grundsätzlich ausgeblendet werden, wenn das Ribbon-Makro anwendbar ist.

Schritte zur Konfiguration

Effekt / Ergebnis

  • Klick auf images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg und Auswählen des Standard-Makros für "Abbrechen":

images/download/attachments/78260270/image2019-6-11_11-45-4-version-1-modificationdate-1630578883151-api-v2.png

  • Das hinzugefügte Makro ist mit den Standardparametern für "Abbrechen" vorbelegt:

images/download/attachments/78260270/image2019-6-11_11-23-50-version-1-modificationdate-1630578883161-api-v2.png

  • Hinzufügen des Befehls Immer ausgeblendet unter Befehle:

images/download/attachments/78260270/image2019-6-11_11-25-2-version-1-modificationdate-1630578883157-api-v2.png

  • Der Befehl erscheint unterhalb des Standard-Befehls "Details > Abbrechen":

images/download/attachments/78260270/image2019-6-11_11-26-40-version-1-modificationdate-1630578883154-api-v2.png
►HINWEIS◄ Der Standard-Befehl "Details > Abbrechen" kann zwecks Transparenz gelöscht werden. Technisch ist das allerdings nicht erforderlich, da der Befehl "Immer ausgeblendet" das Erscheinen des Buttons grundsätzlich verhindert.


Beispiel 2: Der Standard für den Button Kopieren im Kontext einer Detailansicht soll so überschrieben werden, dass vor dem Kopieren der Befehl "Speichern" ausgeführt wird. Damit ist sichergestellt, dass der aktuelle Bearbeitungsstand für Original und Kopie gilt:

Schritte zur Konfiguration

Effekt / Ergebnis

  • Klick auf images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg und Auswahl des Standard-Makros für "Kopieren":

images/download/attachments/78260270/image2019-6-11_11-53-21-version-1-modificationdate-1630578883147-api-v2.png

  • Das hinzugefügte Makro ist mit den Standardparametern für "Kopieren" vorbelegt:

images/download/attachments/78260270/image2019-6-11_11-54-17-version-1-modificationdate-1630578883144-api-v2.png

  • Die Vorschau zeigt bereits das zukünftige Erscheinungsbild des Buttons:

images/download/attachments/78260270/image2019-6-11_12-4-12-version-1-modificationdate-1630578883135-api-v2.png

Die Button-Beschriftung wird durch Verketten zweier Parameter ({0}, {1}) im Standardwert zusammengebaut. Dabei werden die Texte für die Beschriftung der Standard-Buttons ("Speichern" und "Kopieren") aus der Sprachverwaltung zugeordnet, so dass die Kombination im Button ohne weitere Vorkehrungen abhängig von der Sprachauswahl ausgeprägt wird:

  • Der Text "Speichern" wird hier über die Resource "$ribbon.save" im Bundle "common" definiert.

  • Der Text "Kopieren" wird hier über die Resource "$ribbon.copy" im Bundle "common" definiert.

  • Befehl "Speichern" hinzufügen und per Drag & Drop an die erste Position verschieben:

images/download/attachments/78260270/image2019-6-11_14-0-11-version-1-modificationdate-1630578883127-api-v2.png

  • Das Makro verkettet jetzt die Befehle "Speichern" und "Kopieren":

images/download/attachments/78260270/image2019-6-11_14-1-42-version-1-modificationdate-1630578883124-api-v2.png

►HINWEIS◄ Per Standard ist die Option Erforderlich für beide Befehle ausgewählt. Mit dieser Einstellung erscheint der Button "Speichern & Kopieren" nur im Ribbon Menü, wenn beide Befehle ausführbar sind. Ein "neues" Objekt, das noch nicht "Erstellt" (bzw. gespeichert) wurde, kann auch nicht kopiert werden. Demnach muss zunächst mindestens einmal "Speichern" gedrückt werden, damit der kombinierte Button aktiv erscheint. Soll der Button auch schon für Objekte aktiv sein, die noch nie gespeichert wurden, muss die Option Erforderlich für den Befehl "Kopieren" abgewählt werden.


Beispiel 3: Im Kontext einer Übersicht soll der Standard-Button Löschen nur noch für einzelne Objekt aktiv erscheinen.

Schritte zur Konfiguration

Effekt / Ergebnisse

Das DUMMY-Aktionsevent kann in der nachfolgend beschriebenen Makro-Konfiguration als "Befehl ohne Funktion" ausgelöst werden.

  • Klick auf images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg und Auswahl des Standard-Makros für "Löschen":

images/download/attachments/78260270/image2019-6-11_16-18-22-version-1-modificationdate-1630578883121-api-v2.png

  • Das hinzugefügte Makro ist mit den Standardparametern für "Löschen" vorbelegt:

images/download/attachments/78260270/image2019-6-11_16-19-37-version-1-modificationdate-1630578883118-api-v2.png

  • Befehl "Eigenes Aktionsevent > Dispatch: DUMMY" per images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg Symbol hinzufügen.

  • Option Erforderlich ist beim Hinzufügen automatisch ausgewählt.

  • Option Unterstützt einzelne Selektion? als einzige weitere Option auswählen.

images/download/attachments/78260270/image2019-6-11_16-27-43-version-1-modificationdate-1630578883114-api-v2.png

  • Der Aufruf des eigenen Aktionsevents "DUMMY" stellt in Verbindung mit der Option Erforderlich sicher, dass das Makro "Löschen" insgesamt nur anwendbar ist, sofern eine "einzelne Selektion" vorliegt, also wenn genau ein Objekt in der Liste ausgewählt wurde. Wie im Bild unten zu sehen, erscheint der Button "Löschen" dadurch inaktiv, sobald mehrere Listeneinträge selektiert sind.

images/download/attachments/78260270/image2019-6-11_16-33-12-version-1-modificationdate-1630578883107-api-v2.png