NX Ribbon-Customization and Transition

7/17/2019 NX Ribbon-Customization and Transition

http://slidepdf.com/reader/full/nx-ribbon-customization-and-transition 1/19

NX Ribbon – Customization and Transition

ContentsOverview.................................................................................................................... 2

File Based Customization............................................................................................2

Interactive Customization...........................................................................................2

Loadin a File............................................................................................................. 2

Loadin an !TX File...................................................................................................."

File T#$es....................................................................................................................%

&e#words.................................................................................................................... 'Ribbon (t#les.......................................................................................................... '

)rou$s.....................................................................................................................*

)alleries.................................................................................................................. +

,ro$downs.............................................................................................................. -

Oter....................................................................................................................... /

Transition.................................................................................................................. 01

Interactive Transition............................................................................................. 01

File Based Transition.............................................................................................. 01

O$tion 0............................................................................................................. 01

O$tion 2............................................................................................................. 01

O$tion "............................................................................................................. 01

3am$le.............................................................................................................00



Overview Te Ribbon inter4ace introduced in NX / is 4ull# customizable and su$$orts bot 5le

based customizations and interactive customizations.

Tis $ur$ose o4 tis document is to6

0. ,escribe wen to use eac t#$e o4 customization2. ,escribe ow to load and de$lo# eac t#$e o4 customization". ,etail te new 5le t#$es and 7e#words introduced as $art o4 te Ribbon%. 8resent o$tions to el$ wit te transition o4 toolbar content to Ribbon

content

File Based CustomizationFile based customization is $re4erred 4or site administrators9 "rd $art# a$$lications9

and an# oters interested in $roducin or de$lo#in a consistent :I baseline. In te

classic toolbars inter4ace9 tis is done b# creatin;modi4#in !N and TBR 5les in

order to customize te menus and toolbars. In Ribbon mode9 tis $rocess is e3actl#

te same e3ce$t te TBR 4ormat as been e3tended to su$$ort te st#les and

containers introduced in te new inter4ace.

Interactive CustomizationInteractive customization is ideal 4or site administrators wo wis to de$lo# role 5les

and 4or end user customization. In te classic toolbars inter4ace9 all interactive :I

canes are stored in user.mt3 and can also be saved as a role. Tese interactivecanes onl# a$$l# to te current a$$lication. In Ribbon mode9 tis $rocess is

e3actl# te same.

Te !TX 4ormat stores delta canes made on to$ o4 te :I baseline establised b#

5le based customization. Tis means tat i4 <Reset= is cosen on an# :I element9

te !TX content will be removed and te baseline will be restored. Te Ribbon as

introduced new interactive customization scenarios trou item !B" menus >e3.

<?dd to Rit Border Bar=@ as well as enancin te Tools Customize dialo to

su$$ort more inAde$t Ribbon customizations >e3. Creatin a new tab@. ?ll o4 tese

new 4orms o4 :I customization will be saved in user.mt3 wen te session e3its.

Loading a File Te $rocess o4 loadin 5le based customizations into NX remains larel# uncaned

4rom $revious versions. Te one notable e3ce$tion is te new $ro5les structure.

Te $rimar# bene5t o4 te $ro5les structure is to allow TBR 4ormatted 5les >toolbars

and Ribbon 5les@ to be manaed on an a$$lication level. In $revious versions9 onl#

toolbars created interactivel# su$$orted te conce$t o4 a$$lication s$eci5c

customization. !N 5les ave alwa#s su$$orted tis b# modi4#in an



?88LIC?TIONB:TTON de5nition and usin te !NFIL( 7e#word to s$eci4# new

!N 5les to load 4or tat a$$lication.

ere are te wa#s to load 5le based customizations6

0. 8lace 5le in NX O$en <startu$= director#o ac 5le in te startu$ director# will be loaded automaticall# at te

beinnin o4 te session and will be available in all a$$lications.2. 8lace 5le in NX O$en <a$$lication= director#

o Te 5les in te a$$lication director# will not be loaded automaticall#

but will be available to be loaded trou NX O$en ?8I.o 3. :F:Icreatetoolbar9 :F:Icreateribbon

". 8lace 5le in s$eci5c director# under NX O$en <a$$licationD$ro5les=. Tere are

tree t#$es o4 directories under a$$licationD$ro5les6o ?$$lication name. ?n# 5le in one o4 te a$$lication s$eci5c directories

will be automaticall# loaded wen tat a$$lication is entered and

automaticall# unloaded wen e3itin te a$$lication.

• 3. a$$licationD$ro5lesD:)?88!O,LIN)Dm#modelintab.rtb

will be available in !odelin onl#.o <?ll=. Tis is similar to $lacin a 5le in te startu$ director#. It will be

automaticall# loaded at te beinnin o4 te session and available in

all a$$lications.o <Re4erence=. Tis is used wen a subset o4 a$$lications want to load

te same 5le. In order 4or an a$$lication to $ic7 u$ a 5le in te

Re4erence director#9 it must be s$eci5ed in tat a$$licationEs ,TX 5le.

• 3. a$$licationD$ro5lesDRe4erenceDm#saredtab.rtb can be

$ic7ed u$ in !odelin and ,ra4tin b# modi4#in

a$$licationD$ro5lesD:)?88!O,LIN)D:)?88!O,LIN).dt3and

a$$licationD$ro5lesD:)?88,R?FTIN)D:)?88,R?FTIN).dt3 to

include6



Loading an MTX File Te !TX 5le loadin $rocess is te same as in $revious versions. Te de4ault role is

a$$lied 5rst 4ollowed b# an# user customizations 4rom user.mt3. ?ll oter role 5les

are loaded and accessible via te Roles $alette in te Resource Bar.

0. ,e4ault Role is de5ned b#6o :)II,F?:LTROLm#de4aultrole.mt3

2. :ser customizations are $ic7ed u$ 4rom6o GNX :ser ,ataHDuser.mt3

". Roles available 4rom te Roles $alette are $ic7ed u$ 4rom6o startu$DRoleso GNX :ser ,ataHDRoles

File Types(everal new 5le t#$es ave been introduced in NX / and all are based on te same

s#nta3 as e3istin TBR 5les. Te new e3tensions allow te containers to be easil#

identi5ed.

Extension I o!"ect

.tbr Toolbar

.rb )rou$

.l# )aller#

.ddb ,ro$down

.rtb ribbon tab

.csb Cascade

.abr attacment



#eywordsIn addition to te new 5le t#$es9 man# new 7e#words are now used to su$$ort te

new st#les available in te Ribbon containers.

$i!!on %tyles#eyword &alue 'escription

$IBBO()%T*LE ?L?J(L?R)I!?)L?R)I!?)

?L?J((!?LLI!?)?N,T

XT

(!?LLI!?)?N,TXT

(!?LLI!?)

($eci5es $re4erred ribbon st#le.

?vailable 4or buttons9 dro$downs9

and cascades. I4 no st#le is

s$eci5ed9 ten te item will start

as lare imae and will srin7

down accordin to te resize rules

o4 te container.



+roups#eyword &alue 'escription

)RO:8 Re4erenced Item I, ($eci5es item tat re4erences

group de5ned in a se$arate 5le.

To start a new rou$ in tecurrent 5le9 use B)IN)RO:8.

B)IN)RO:8

N,)RO:8

New Item I, ($eci5es rou$ item and its

content inside te current 5le.+$O,)%T*LE ,F?:LT

FLOL?JO:T

($eci5es $re4erred rou$ st#le.

,e4ault will onor all Ribbon

st#les determined b# eac

button. Flow La#out will dis$la#

two rows o4 small buttons and

will onor item st#le tat NX

uses 4or toolbars in Classic

mode.

+alleries#eyword &alue 'escription

)?LLRJ Re4erenced Item I, ($eci5es item



tat re4erences

gallery de5ned

in a se$arate

5le. To start a

new aller# in

te current 5le9

use

B)IN)?LLRJ.B)IN)?LLRJ

N,)?LLRJ

New Item I, ($eci5es aller#

item and its

content inside

te current 5le.+-LLE$*)%T*L

E

%imple %tyles.

(!?LLI!?)

(!?LLI!?)?N,TXT

!,I:!I!?)

!,I:!I!?)?N,TXT

L?R)I!?)

L?R)I!?)?N,TXTBLO

Composite %tyles.

(!?LLI!?)IN8L?C(!?LLI!?)?N,TXTIN8O

8:8

(!?LLI!?)IN8L?C!,I:!I!?)?N,TXTIN8

O8:8

(!?LLI!?)IN8L?CL?R)I!?)?N,TXTBLO

IN8O8:8

!,I:!I!?)IN8L?C(!?LLI!?)?N,TXTIN8

O8:8

!,I:!I!?)IN8L?C!,I:!I!?)?N,TXTIN

8O8:8

!,I:!I!?)IN8L?CL?R)I!?)?N,TXTBL

OIN8O8:8

($eci5es te

$re4erred

aller# st#le.

COL:!NINRIB

BON

Number o4 columns in Ribbon ,e5nes te

larest size tat

te inA$lace

aller# can

e3$and to wen

s$ace is

available.COL:!NIN8O

8:8

Number o4 columns wen e3$anded ,e5nes te

minimum size

o4 te $o$u$aller#.





'ropdowns#eyword &alue 'escription

,RO8,ON Re4erenced Item I, ($eci5es item tat re4erences

dropdown !utton de5ned in a

se$arate 5le.B)IN,RO8,ON

N,,RO8,ON

New Item I, ($eci5es cascade item and its content

inside te current 5le.,RO8,ON(TJL

?(8O8:8!N:

8?LTT

($eci5es $re4erred dro$down st#le.

COL:!N,RO8,ON Number o4 columns in

dro$ down



Ot/er#eyword &alue 'escription

C?(C?, Re4erenced Item I, ($eci5es item tat re4erences cascade

de5ned in a se$arate 5le.

B)INC?(C?,N,C?(C?,

New Item I, ($eci5es cascade item and its contentinside te current 5le.

?TT?C!NTT?R)

T

To$Bac7(tae)rou$

Le4tBac7(tae)rou$

RitBac7(tae)rou$

BottomBac7(tae)rou$

Kuic7?ccessBar

Ribbon(#stemBar

(electionBar

To$BorderBar

BottomBorderBar

Le4tBorderBar

RitBorderBar

:sed to attac new content to a builtAin

container or bar. Onl# to be used in .abr

5les and is declared at te beinnin o4

te 5le.

CONTXTTITL ?lternate title :sed 4or dierentiatin between rou$s

in Customize dialo(TJL ,F?:LT

TXTONLJ?L?J(

I!?)?N,TXT

TXTONLJ!N:

($eci5es item st#le 4or reular toolbars

and menus



TransitionNX develo$ment as created o$tions to el$ wit te transition o4 Classic Toolbar

content to Ribbon content 4or bot interactive customizations and 5le based

customizations.

Interactive TransitionIn NX / Ribbon mode9 eac e3istin toolbar >TBR@ 5le tat is loaded into NX will be

converted on te M# to be available as a Ribbon rou$. ven i4 no action is ta7en

$rior to launcin NX9 tese rou$s can be 4ound in te Customize dialo on te

Commands tab under te <Classic Toolbars >?s )rou$s@= node. Tis also a$$lies to

custom toolbars tat were created interactivel# usin te Customize dialo.

Toolbars as rou$s can ten be used in Ribbon mode b# drain tem onto Ribbon

tabs or border bars. Li7e all interactive customizations9 an# canes can be saved

in a role 5le to be used later or distributed.

File Based Transition Te new containers and 7e#words available in NX / ave alread# been described

earlier in tis document. Tis section will re4erence tose new containers and

7e#words and $resent a 4ew alternate coices wen convertin a toolbar to te

Ribbon. Te e3am$le below will start wit one !N 5le containin ' customerA

created buttons and one TBR 5le tat re4erences tem. B# te end o4 te e3am$le9

one Ribbon tab will be created wit tese same ' buttons a$$earin in tree

se$arate Ribbon rou$s. ac o4 tese rou$s will be created in a dierent wa#.

Te dierences will de$end on ow muc Ribbon s$eci5c la#out eac rou$

reuires.

Option 0

Te 5rst rou$ in te e3am$le below re$resents a Ribbon rou$ tat re4erences an

e3istin toolbar wit no Ribbon st#le canes.

Tis is te uic7est wa# to add e3istin toolbar content into Ribbon mode but

$rovides no Ribbon s$eci5c la#out.

Option 1

Te second rou$ in te e3am$le below re$resents a Ribbon rou$ tat re4erences

an e3istin toolbar wit Ribbon s$eci5c st#le canes added to it. Tere is nodierence in ow tis toolbar is re4erenced in te .rtb 5le com$ared to te 5rst

toolbar as a rou$. Te onl# dierences 4rom te 5rst rou$ e3ist witin te .tbr 5le

itsel4.

Tis a$$roac as advantaes 4or customers tat will de$lo# bot Ribbon and

Classic !ode customizations since all te content is de5ned in te .tbr 5le and it will

sta# s#ncronized in bot modes. Onl# one set o4 customizations will need to be



maintained wile still ma7in use o4 RIBBON(TJL to control te $resentation o4

te buttons on te Ribbon.

Option 2

Te tird rou$ in te e3am$le below re$resents a Ribbon rou$ tat as been

created e3$licitl# as a Ribbon rou$ and will not e3ist in Classic Toolbar mode. Tisis te $re4erred o$tion since te user will be able to ta7e advantae o4 all te la#out

st#les and containers oered b# te Ribbon.

owever9 4or customers tat will de$lo# bot Ribbon and Classic !ode

customizations9 tis a$$roac will result in two sets o4 customizations wit no

s#ncronization between tem.

Example

Classic Toolbar mode

Files used6

• customermen.men

• customertoolbar.tbr

(creensot6

Ribbon Mode

Files used6

• customermen.men

• customertab.rtb

• customertoolbar.tbr

• customertoolbaralternate.tbr

• customerrou$.rb

(creensot6





customermen.men

! Customer menu file

!

! Contains button definitions to be used in

! toolbars and Ribbon files

!

VERSION 120

EDIT UGGTE"#$IN$ENU%R

TO&$ENU

CSCDE%UTTON CUSTO$ER$ENU

'%E' Customer $enu

ENDO(TO&$ENU

$ENU CUSTO$ER$ENU

%UTTON CUSTO$ER%UTTON1

'%E' $enu %utton1

%IT$& n)a**


'%E' $enu %utton2

%IT$& filesa+e

%UTTON CUSTO$ER%UTTON,

'%E' $enu %utton,

%IT$& -urrentfeature

%UTTON CUSTO$ER%UTTON.

'%E' $enu %utton.

%IT$& blo-/

%UTTON CUSTO$ER%UTTON

'%E' $enu %utton

%IT$& -e-/reen

ENDO($ENU



customerribbontab.rtb

!

! Customer Ribbon Tab

!

! Tis file 3ill -reate a ne3 -ustomer tab -ontainin tree rou*s and

! one to* le+el button4!

TIT'E Customer Tab

VERSION 150

! Te first rou* re*resents a Ribbon rou* tat referen-es an e)istin

! toolbar 3it no Ribbon st6le -anes4

!

! Tis is te 7ui-/est 3a6 to add e)istin toolbar -ontent into Ribbon mode4

!

GROU& -ustomertoolbar4tbr

! Te se-ond rou* re*resents a Ribbon rou* tat referen-es an e)istin

! toolbar 3it Ribbon s*e-ifi- st6le -anes added to it4 Tere is no differen-e

! in o3 tis toolbar is referen-ed in te 4rtb file -om*ared to te first

! toolbar as a rou*4 Te onl6 differen-es from te first rou* e)ist 3itin

! te 4tbr file itself4

!

! Tis a**roa- as ad+antaes for -ustomers tat 3ill de*lo6 bot Ribbon and

! Classi- $ode -ustomi8ations sin-e all te -ontent is defined in te 4tbr

! file and it 3ill sta6 s6n-roni8ed in bot modes4 Onl6 one set of -ustomi8ations

! 3ill need to be maintained 3ile still ma/in use of RI%%ONST#'E to

! -ontrol te *resentation of te buttons on te Ribbon4

!

GROU& -ustomertoolbaralternate4tbr

! Te tird rou* re*resents a Ribbon rou* tat as been -reated e)*li-itl6

! as a Ribbon rou* and 3ill not e)ist in Classi- Toolbar mode4 Tis is te

! *referred o*tion sin-e te user 3ill be able to ta/e ad+antae of all te

! la6out st6les and -ontainers offered b6 te Ribbon4

!

! (or -ustomers tat 3ill de*lo6 bot Ribbon and Classi- $ode -ustomi8ations9

! tis a**roa- 3ill result in no s6n-roni8ation and t3o sets of -ustomi8ations

! 3ill need to be maintained4

!

! rou* -an alternati+el6 be defined dire-tl6 inside te 4rtb file b6 usin te

! /e63ords %EGINGROU& and ENDGROU&4

!

GROU& -ustomerrou*4rb

! E)am*le of a button tat is *la-ed dire-tl6 on te Ribbon 3itout bein

! -ontained in a rou*4 Tis is a sim*le 3a6 to add a button to a tab

! but is not re-ommended for man6 buttons sin-e rou*s a+e ad+antaes4!

! fe3 ad+antaes of rou*s:

! 14 Easier to mo+e man6 buttons around toeter in 7ui-/ -ustomi8ation4

! (or e)am*le9 $%, on a rou* and -oose ;dd to 'eft %order %ar;4

! Tis 3ill mo+e te 3ole rou* to a ne3 lo-ation4 If buttons are

! not in a rou*9 te6 need to be mo+ed one at a time4

!

! 24 &ro+ide a label to des-ribe its -ontents4

!


'%E' %utton1 Dire-tl6 on Tab





customertoolbar.tbr

!

! Customer Toolbar (ile

!

! Tis is similar to an e)istin toolbar file -ontainin

! no Ribbon -anes4!

! In Classi- Toolbars mode < Tis toolbar 3ill still so3 u* in te

! toolbars list4

!

! In Ribbon mode < Tis toolbar 3ill be automati-all6 -on+erted to a

! Ribbon rou* and 3ill a**ear in te ;Classi- Toolbars as Grou*s;

! se-tion in te Customi8e dialo4

!

TIT'E Toolbar

VERSION 150


'%E' Toolbar %utton1


'%E' Toolbar %utton2


'%E' Toolbar %utton,


'%E' Toolbar %utton.


'%E' Toolbar %utton



customertoolbaralternate.tbr

!

! Customer Toolbar (ile =lternate>

!

! Tis is similar to an e)istin toolbar file 3it ne3

! Ribbon st6les added4!

! Te RI%%ONST#'E 3ill be onored 3en te toolbar is loaded

! in Ribbon mode as a rou* but 3ill be inored 3en te toolbar

! is dis*la6ed in Classi- Toolbars mode4

!

! In Classi- Toolbars mode < Tis toolbar 3ill still so3 u* in te

! toolbars list4

!

! In Ribbon mode < Tis toolbar 3ill be automati-all6 -on+erted to a

! Ribbon rou* and 3ill a**ear in te ;Classi- Toolbars as Grou*s;

! se-tion in te Customi8e dialo4

!

TIT'E Toolbar =lternate>

VERSION 150


'%E' Toolbar=lt> %utton1

RI%%ONST#'E 'RGEI$GE


'%E' Toolbar=lt> %utton2



'%E' Toolbar=lt> %utton,

RI%%ONST#'E S$''I$GENDTE?T

%UTTON CUSTO$ER%UTTON.'%E' Toolbar=lt> %utton.



'%E' Toolbar=lt> %utton




customerrou$.rb

!

! Customer Ribbon Grou* (ile

!

! In Classi- Toolbars mode < Tis rou* 3ill be una+ailable

!! In Ribbon mode < Tis rou* 3ill so3 u* in te ;ll Grou*s; list

! in te Customi8e dialo4

!

TIT'E Grou*

VERSION 150


'%E' Grou* %utton1


! E)am*le of a aller6 defined in a GR% file4

!

! If tis aller6 is to be used in oter *la-es9 ten it -ould be

! defined in its o3n aller6 =G'#> file and referen-ed ere

! E)am*le:

! G''ER# -ustomeraller64l6

!

%EGING''ER# CUSTO$ERG''ER#

CO'U$NINRI%%ON 2

CO'U$NIN&O&U& 2

'%E' Galler6

G''ER#ST#'E $EDIU$I$GENDTE?T


'%E' Grou* %utton2


'%E' Grou* %utton,


'%E' Grou* %utton.


'%E' Grou* %utton

ENDG''ER#

Documents

NX Ribbon-Customization and Transition