Configuration of ribbon and navigation bar

By default, the iNOW UI Client uses a ribbon menu for operation.

This is predefined via the default file “Navigation.xml” in the program directory.
This file should not be changed, because it is overwritten with every update.

Customize the Ribbon Menu

If you want to customize the configuration, copy the default file to the Settings directory of your repository. If the client finds the file there, it will be used instead of the default file in the program directory.

Setting up a navigation bar

If not already done, copy the default file into the “Settings” directory of your repository.
You will also find the file “Navigation.txt” in the Samples subfolder.
This file contains examples of how you can additionally set up a navigation area on the left side of the client. Add the texts to the Navigation.xml file so that the XML structure remains valid.

Configuration

General description of the properties

Property Usage
Text Displayed text
Id Id to access an element inside the client
Command represents an action executed when an item is selected
Params Parameter for Command
Image used image

Texts

Several languages can be specified for texts.
The first text is the standard text. Additional text for specific languages can be specified by @@SprachId:.

Example: Text="New Session@@EN:New Session".

Actions and parameters

Actions are defined with Command. The format is “module.routine”.
In most cases the module is Main.
Parameters are passed in Params. The format here is “ParameterName:ParameterValue”.

Example: Command MAIN MAIL.

Pictures

Images are defined with Image.
The default usage is Image="Filename.Format".
This assumes that the file is located in the “Resources\Images” folder of the repository. However, an absolute path can also be used.
Special cases are the definitions “RES:” and “SVG:”. These refer to special resources embedded in the iNow UI client.

example:_ Image="Sessions.png"

Ribbon

The ribbon menu is the main menu of the application. It is also only available in the desktop version of the iNow UI Client.

The ribbon menu is hierarchical. It has single pages (RibbonTab), which in turn consist of groups (RibbonGroup). A single group then contains individual entries (RibbonItem) which then display the selectable options as buttons.

RibbonTab

Property Usage
Text displayed heading of the page
Id Id to access the page inside the client

RibbonGroup

Property Usage
Text displayed heading of the group
Id Id, to access the group inside the client.

RibbonItem

Property Usage
Text Labeling
Id Id to access the item inside the client
Image used image
Command represents an action executed when an item is selected
Params Parameter for Command

Navigation bar

The navigation bar provides a special, optional navigation area on the left side of the iNow UI client.

NavGroup

Property Usage
Text displayed heading of the group
Id Id, to access the group inside the client.
Switch use similar to Id to access the group inside the client
Image used image
IsContainer to True if the group is to serve as a container for sessions.
IsFavorites to True if the group is to serve as a container for the favorites.

NavItem

Property Usage
Text Labeling
Id Id to access the item inside the client
Image used image
Command represents an action executed when an item is selected
Params Parameter for Command
DockStyle determines docking behavior when IsContainer is enabled in the parent group

Examples

Commands for displaying a ViewControl

Two commands are available for displaying a ViewControl:

Command Usage
SHOWVIEWTAB Display of the view control in the tab
SHOWVIEWDIALOG Display of the View Control in the Dialog

In both cases, the ID of the view control must be passed as a parameter.
For properties such as title, modal display, and so on, the properties of the view control are used.

Examples of entries in the navigation area:

<NavItem Text="In tab" Command="MAIN.SHOWVIEWTAB" Params="ID:SECONDVIEW"/>
<NavItem Text="In window" Command="MAIN.SHOWVIEWDIALOG" Params="ID:SECONDVIEW"/>

Complete example

Here is a complete example with attached definition file.

Configuration for the example above

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>