Konfiguration von Ribbon und Navigationbar

client
configuration
ribbon

#1

Der iNOW UI Client verwendet standardmäßig ein Ribbonmenü für die Bedienung.

Dieses ist über die Standarddatei “Navigation.xml” im Programmverzeichnis vordefiniert.
Diese Datei sollte nicht verändert werden, da sie bei jedem Update überschrieben wird.

Anpassen des Ribbonmenüs

Wenn Sie die Konfiguration anpassen möchten, kopieren Sie die Standarddatei in das Verzeichnis “Settings” Ihres Repositorys. Wenn der Client die Datei dort findet, dann wird diese anstatt der Standarddatei im Programmverzeichnis verwendet.

Einrichten einer Navigationbar

Falls nicht schon geschehen kopieren Sie die Standarddatei in das Verzeichnis “Settings” Ihres Repositorys.
Im Unterordner Samples finden Sie auch die Datei “Navigation.txt”.
Diese enthält Beispiele wie Sie zusätzlich einen Navigationsbereich auf der linken Seite des Clients einrichten können. Fügen Sie die Texte der Datei “Navigation.xml” so hinzu, dass die XML Struktur valide bleibt.

Konfiguration

Allgemeine Beschreibung der Eigenschaften

Eigenschaft Verwendung
Text angezeigter Text
Id Id, um auf ein Element innerhalb des Clients zuzugreifen
Command repräsentiert eine Aktion die ausgeführt wird, wenn ein Element ausgewählt wird
Params Parameter für Command
Image verwendetes Bild

Texte

Bei Texten können mehrere Sprachen angegeben werden.
Der erste Text ist der Standardtext. Weitere Text für spezifische Sprachen können durch @@SprachId: angegeben werden.

Beispiel: Text="New Session@@DE:Neue Sitzung"

Aktionen und Parameter

Aktionen werden mit Command definiert. Das Format ist hierbei “Modul.Routine”.
Das Modul ist in den meisten Fällen “Main”.
Parameter werden in Params übergeben. Das Format ist hierbei “ParameterName:ParameterWert

Beispiel: Command="MAIN.MAIL" Params="ADRESS:info@ml-software.com"

Bilder

Bilder werden mit Image definiert.
Die Standardverwendung ist Image="Dateiname.Format"
Hierbei wird dabei ausgegangen, dass die Datei im Ordner “Resources\Images” des Repositories liegt. Es kann aber auch ein absoluter Pfad verwendet werden.
Spezielle Fälle sind die Definitionen “RES:” und “SVG:”. Diese beziehen sich auf spezielle im iNow UI Client eingebettete Resourcen.

Beispiel: Image="Sessions.png"

Ribbon

Das Ribbonmenü ist das Hauptmenü der Applikation. Es steht auch nur in der Desktop Version des iNow UI Clients zur Verfügung.

Das Ribbonmenü ist hierarchisch aufgebaut. Es verfügt über einzelne Seiten (RibbonTab), welche wiederum aus Gruppen (RibbonGroup) bestehen. Eine einzelne Gruppe enthält dann einzelne Einträge (RibbonItem) welche dann die auswählbaren Optionen als Buttons darstellen.

RibbonTab

Eigenschaft Verwendung
Text angezeigte Überschrift der Seite
Id Id, um auf die Seite innerhalb des Client zuzugreifen

RibbonGroup

Eigenschaft Verwendung
Text angezeigte Überschrift der Gruppe
Id Id, um auf die Gruppe innerhalb des Client zuzugreifen

RibbonItem

Eigenschaft Verwendung
Text Beschriftung
Id Id, um auf das Element innerhalb des Client zuzugreifen
Image verwendetes Bild
Command repräsentiert eine Aktion die ausgeführt wird, wenn ein Element ausgewählt wird
Params Parameter für Command

Navigatonbar

Die Navigatonbar stellt einen besonderen, optionalen Navigationsbereich auf der linken Seite des iNow UI Clients zur Verfügung.

NavGroup

Eigenschaft Verwendung
Text angezeigte Überschrift der Gruppe
Id Id, um auf die Gruppe innerhalb des Client zuzugreifen
Switch Verwendung ähnlich Id, um auf die Gruppe innerhalb des Client zuzugreifen
Image verwendetes Bild
IsContainer auf True setzen, wenn die Gruppe als Container für Sitzungen dienen soll
IsFavorites auf True setzen, wenn die Gruppe als Container für die Favoriten dienen soll

NavItem

Eigenschaft Verwendung
Text Beschriftung
Id Id, um auf das Element innerhalb des Client zuzugreifen
Image verwendetes Bild
Command repräsentiert eine Aktion die ausgeführt wird, wenn ein Element ausgewählt wird
Params Parameter für Command
DockStyle bestimmt Docking-Verhalten wenn IsContainer in der übergeordneten Gruppe aktiviert ist

Beispiele

Commands für Anzeige eines ViewControls

Für die Anzeige eines ViewControls stehen zwei Commands zur Verfügung:

Command Verwendung
SHOWVIEWINTAB Anzeige des View Controls im Reiter
SHOWVIEWDIALOG Anzeige des View Controls im Dialog

In beiden Fällen muss die Id des View Controls als Parameter übergeben werden.
Für Eigenschaften wie Titel, Modale Anzeige etc. werden die den Eigenschaften des View Controls verwendet.

Beispiele für Einträge im Navigatonsbereich:

<NavItem Text="In Reiter" Command="MAIN.SHOWVIEWINTAB" Params="ID:SECONDVIEW"/>
<NavItem Text="In fenster" Command="MAIN.SHOWVIEWDIALOG" Params="ID:SECONDVIEW"/>

Komplettes Beispiel

Hier ist ein komplettes Beispiel mit angehängter Definitionsdatei.

Konfiguration für das obige Beispiel

Navigation.xml (2,2 KB)

<?xml version="1.0" encoding="utf-8"?>
<Definitions>
<Ribbon>    
    <RibbonTab Text="Application" Id="MLApplication">    
        <RibbonGroup Text="Skins" Id="MLSkins" />
        <RibbonGroup Text="Session@@DE:Sitzung" >
            <RibbonItem Text="New Session@@DE:Neue Sitzung" Command="SESSION.NEWSESSION" Image="Sessions.png" Id="MLSession" />
        </RibbonGroup>
        <RibbonGroup Text="Tools" >
            <RibbonItem Text="Spoolfiles@@DE:Spooldateien" Command="HOSTFUNCTIONS.WRKSPLF" Image="res:spoolfiles"/>
        </RibbonGroup>
        <RibbonGroup Text="Designer" Id="MLDesigner">
            <RibbonItem Text="Guided Tour" Command="MAIN.MLTOUR" Image="res:guidedtour" Id="MLGuidedTour"/>
            <RibbonItem Text="Video Tutorials" Command="MAIN.MLTUTORIALS" Image="res:videotutorials"/>
            <RibbonItem Text="You Tube Channel" Command="MAIN.MLYOUTUBE" Image="res:youtube"/>
            <RibbonItem Text="Support Pages" Command="MAIN.MLSUPPORT" Image="svg:support"/>
        </RibbonGroup>
    </RibbonTab>    
</Ribbon>    
<Navigator>           
    <NavGroup Text="ML Software" Image="ML22.png" Switch="MLTAB" Id="MLGROUP">
        <Items>
            <NavItem Text="iNEXT Website@@DE:iNEXT Webseite" Command="MAIN.URL" Params="URL:http://www.inextsuite.de" Image="ML32.png"/>
            <NavItem Text="Send Mail to ML@@DE:Mail an ML senden" Command="MAIN.MAIL" Params="ADRESS:info@ml-software.com" Image="mail_replay.png"/>
        </Items>
    </NavGroup>
    <NavGroup Text="Office Integration" Image="office.png" Switch="OFFICE" Id="OFFICEGROUP">
    <Items>
        <NavItem Text="Word" Image="TextEdit.png" Command="MAIN.WORD" />
        <NavItem Text="Excel" Image="Spreadsheet.png" Command="MAIN.EXCEL"/>
        <NavItem Text="EMail" Image="mail.png" Command="MAIN.MAIL"/>
    </Items>
    </NavGroup>
    <NavGroup Text="Windows / System" Image="windows_users.png" Switch="SYSTEM" Id="SYSGROUP">
    <Items>
        <NavItem Text="My Documents@@DE:Eigene|Dokumente" Image="MyDocs_48.png" Command="MAIN.MYDOCUMENTS" />
        <NavItem Text="Control|Panel@@DE:System|steuerung" Image="Settings_48.png" Command="MAIN.CONTROLPANEL"/>
        <NavItem Text="Pause|Lock@@DE:Pause|Sperren" Image="PauseLock.png" Command="MAIN.PAUSE"/>
    </Items>
    </NavGroup>
</Navigator>
</Definitions>

Commands für Ribbon und Navigationbar
View Controls