How to custom the GUI interface of Designer

Autres langues :

English • ‎français

Onyx Designer 10.1 (Official release due end of June 2020) and behond gives the possibility to custom its interface bu hiding the button of the ruban bar.

In the following versions, it will also be possible to customize other tool bars and windows and also change the colours in order to fully customize the interface.

Sommaire

1 prerequisites
2 Limits
3 How to hide ribbon tool bar elements
4 Example 1 : How to hide the "Generate Project" button
5 Example 2 : How to hide the "Home" tab
6 Example 3 : How to hide the "Display" panel

prerequisites

Designer ONYX 10.1 or above
Having the global.xml file in the Styles folder in the Designer installation folder
Executing the initGlobalStyle.reg file included in the setup

Limits

This first version gives only the possibility to play with the buttons of the Ruban bar located at the top the screen. Other possibilities will come next.

How to hide ribbon tool bar elements

It is possible to hide certain buttons of the Home, Edit, Display, Shape or Mapping tab. It is also possible to hide the entire tab.

The global Style is to hide the categories, panels and buttons based on the global.xml file. This file must be located in the Styles folder of the Designer installation folder.

global.xml installation file

In order to customize the ribbon, we must first execute the initGlobalStyle.reg. It will add a registery key with the xml file containing the elements to hide. (by default : global.xml)

Setting up the XML file

The XML file contains the same nodes as the former style file with the <style> node. We added the <ui> node containing a list of <menu> nodes. This node corresponds to the categories, panels and buttons to be display or hidden.

<?xml version="1.0" encoding="utf-8"?>
<style>
       <ui>
             <menu ... />
             <menu ... />
                 ...
       </ui>
</style>

The <menu> node can have the following attributes :

category: Name of the element category
panel: Name of the element panel
id: name of the element button to hide or display
status: value indicating whether we display the element (“on”) or not (“off”)

<u<Note : If we want to hide a button, we will have to specify all four attributes of the menu node. However, if we want to hide a category, we will need only to specify the attribute category and status. Same if we want to hide the panel, we will then only need to specify the attribute category, panel et status. Note that the status must always be specified.

In the following example, the generate project button, the Insert pannel and the format category will not be displayed in the Designer interface.

<?xml version="1.0" encoding="utf-8"?>

<style>
        <ui>
               <menu category="home" panel="generate" id="generate_btn" status="off"/>
               <menu category="format" status="off"/>
               <menu category="shape" panel="insert" status="off"/>
        </ui>
</style>

The non specified elements has by default the value on.

List of names

The pannels and buttons located in multiple categories must be specified in the home category and will be hidden in all categories.

Pannels

The pannels represent in the interface the button blocs.

Panneaux	Attribut XML
Clipboard	clipboard
Data	data
Position according to grid	fit_to_grid
Shapes	form
Generate	generate
Generate (component)	generate_component
Insert	insert
Insert (Mapping)	insert_dynamic
Organize	organize
Preview	preview
Refresh	redraw
Styles	styles
Window	window

Buttons

The buttons represent in the interface the buttons or other lowest level objects.

Buttons	XML Attributes
Paste	paste
Cut	cut
Copy	copy
Copy Formatting	copy_format
Duplicate	dupplicate
font group	font_group
Text Style	txt_style
Text Alignment	txt_align
Colour Font	font_color
Generate Project	generate_btn
Project association	associate
Export Overlay	export_printer
Script	script
Send to mapping	send
Send multi to mapping	send_multi
Preview	preview_btn
Load Data Stream	open_spool
Multi-Preview	multi_preview
Save Preview	save_preview
XPS Watermark	xps_layer
Unlink the spool	unlink_spool
XML Preprocessing	process_xml
Bring to Front	layer_front
Bring to Back	layer_back
Alignment	ids-alignment
Size	ids_size
Rotate	ids_rotate
Snap to grid	magnet
Grid Setup	grid_setup
Text box	text_box
Image	image_box
Static table	table_box
Select	selection
Line	line
Arch	arc
Square	square
Rectangle	rectangle
Rounded rectangle	curved_rectangle
Ellipse	ellipse
Circle	circle
Shapes	figure
Pen color	outline_color
Fill	padding_color
Pen	weight
zone	mapzone
Anchor	anchor
Fix group	mapgroup
Variable group	mapgroup_var
Commands	commands
Select (mapping tab)	mapselection
Line (mapping tab)	mapline
Rectangle (mapping tab)	maprectangle
text box (mapping tab)	maptext
Logo (mapping tab)	maplogo
Graph	mapgraph
Component	mapcomponent
Variable element	maplabel

Example 1 : How to hide the "Generate Project" button

In order to hide the Generate Project, we must add the following line or change it if already existing to the following :

<menu category="home" panel="generate" id="generate_btn" status="off"/>

Example 2 : How to hide the "Home" tab

In order to hide the Home tab, we need to change the status to off in the global.xml file for the following line :

Example 3 : How to hide the "Display" panel

In order to hide the Display tab, we need to change the status to off in the global.xml file for the following line :

Categorie	Attribut XML
Edit	format
Home	home
Mapping	Mapping
Shape	shape
Display	view