NX Ribbon-Customization and Transition

NX Ribbon – Customization and  Transi  T ransition tion Contents Overview............................... Overview................................................... ........................................ .............................................................. .......................................... ... 2 File Based Customization............ Customization................................ ........................................ ........................................ ........................................ .................... 2 Interactive Customization........... Customization.............................. ....................................... ........................................ ......................................... .....................2 2 Loadin a File....................................... ile........................................................... ......................................................... ..................................... ............. 2 Loadin an !TX File.................................... ile........................................................ ....................................... ............................................ ......................... " File T#$es................................... #$es....................................................... ....................................... ....................................... ......................................... ....................... % &e#words................. &e#words..................................... ....................................... ....................................... ........................................ .................................. .................... ...... ' Ribbon (t#les................................ (t#les.................................................... ........................................ ................................. ........................... ..................... ....... ' )rou$s............................... )rou$s................................................... ........................................ ....................................... .............................................. ........................... * )alleries................................ )alleries.................................................... ........................................ .............................................................. .......................................... + ,ro$downs....................... ,ro$downs........................................... ........................................ ....................................... ................................. ............................ .............. Oter...................................... Oter.......................................................... ....................................... ....................................... ...................................... ...................... .... /  Transition................  Transition.................................... ....................................... ....................................... ........................................ ....................................... ................... 01 Interactive Transition................... ransition...................................... ....................................... ........................................ ................................... ............... 01 File Based Transition..................................... ransition........................................................ ....................................... ...................................... .................. 01 O$tion 0................................................ 0................................................................... ...................................................... .......................................... ....... 01 O$tion 2................................................ 2................................................................... ...................................................... .......................................... ....... 01 O$tion "................................................ "................................................................... ...................................................... .......................................... ....... 01 3am$le................................. 3am$le..................................................... ........................................ ..................................................... .................................... ... 00

Overview  Te Ribbon inter4ace introduced in NX / is 4ull# customizable and su$$orts bot 5le based customizations and interactive customizations.  Tis $ur$ose o4 tis document is to6 0. 2. ". %.

,escribe wen to use eac t#$e o4 customization ,escribe ow to load and de$lo# eac t#$e o4 customization ,etail te new 5le t#$es and 7e#words introduced as $art o4 te Ribbon 8resent o$tions to el$ wit te transition o4 toolbar content to Ribbon content

File Based Customization File based customization is $re4erred 4or site administrators9 " rd $art# a$$lications9 and an# oters interested in $roducin or de$lo#in a consistent :I baseline. In te classic toolbars inter4ace9 tis is done b# creatin;modi4#in !N and TBR 5les in order to customize te menus and toolbars. In Ribbon mode9 tis $rocess is e3actl# te same e3ce$t te TBR 4ormat as been e3tended to su$$ort te st#les and containers introduced in te new inter4ace.

Interactive Customization Interactive customization is ideal 4or site administrators wo wis to de$lo# role 5les and 4or end user customization. In te classic toolbars inter4ace9 all interactive :I canes are stored in user.mt3 and can also be saved as a role. Tese interactive canes onl# a$$l# to te current a$$lication. In Ribbon mode9 tis $rocess is e3actl# te same.  Te !TX 4ormat stores delta canes made on to$ o4 te :I baseline establised b# 5le based customization. Tis means tat i4 e3. e3. Creatin a new tab@. ?ll o4 tese new 4orms o4 :I customization will be saved in use r.mt3 wen te session e3its. 

Loading a File  Te $rocess o4 loadin 5le based customizations into NX remains larel# uncaned 4rom $revious versions. Te one notable e3ce$tion is te new $ro5les structure.  Te $rimar# bene5t o4 te $ro5les structure is to allow TBR 4ormatted 5les >toolbars and Ribbon 5les@ to be manaed on an a$$lication level. In $revious versions9 onl# toolbars created interactivel# su$$orted te conce$t o4 a$$lication s$eci5c customization. !N 5les ave alwa#s su$$orted tis b# modi4#in an

?88LIC?TIONB:TTON de5nition and usin te !NFIL( 7e#word to s$eci4# new !N 5les to load 4or tat a$$lication. ere are te wa#s to load 5le based customizations6 0. 8lace 5le in NX O$en
•

Loading an MTX File  Te !TX 5le loadin $rocess is te same as in $revious versions. Te de4ault role is a$$lied 5rst 4ollowed b# an# user customizations 4rom user.mt3. ?ll oter role 5les are loaded and accessible via te Roles $alette in te Resource Bar. 0. ,e4ault Role is de5ned b#6 o :)II,F?:LTROLm#de4aultrole.mt3 2. :ser customizations are $ic7ed u$ 4rom6 o GNX :ser ,ataHDuser.mt3 ". Roles available 4rom te Roles $alette are $ic7ed u$ 4rom6 o startu$DRoles o GNX :ser ,ataHDRoles

File Types (everal new 5le t#$es ave been introduced in NX / and all are based on te same s#nta3 as e3istin TBR 5les. Te new e3tensions allow te containers to be easil# identi5ed. Extension

I o!"ect

.tbr .rb .l# .ddb .rtb .csb .abr

Toolbar )rou$ )aller# ,ro$down ribbon tab Cascade attacment

#eywords In addition to te new 5le t#$es9 man# new 7e#words are now used to su$$ort te new st#les available in te Ribbon containers.

$i!!on %tyles #eyword

&alue

'escription

$IBBO()%T*LE

?L?J(L?R)I!?) L?R)I!?) ?L?J((!?LLI!?)?N,T XT (!?LLI!?)?N,TXT (!?LLI!?)

($eci5es $re4erred ribbon st#le. ?vailable 4or buttons9 dro$downs9 and cascades. I4 no st#le is s$eci5ed9 ten te item will start as lare imae and will srin7 down accordin to te resize rules o4 te container.

+roups #eyword

&alue

)RO:8

Re4erenced Item I,

B)IN)RO:8 N,)RO:8 +$O,)%T*LE

New Item I, ,F?:LT FLOL?JO:T

'escription ($eci5es item tat re4erences group de5ned in a se$arate 5le.  To start a new rou$ in te current 5le9 use B)IN)RO:8. ($eci5es rou$ item and its content inside te current 5le. ($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 tat NX uses 4or toolbars in Classic mode.

+alleries #eyword

&alue

'escription

)?LLRJ

Re4erenced Item I,

($eci5es item

B)IN)?LLRJ N,)?LLRJ

New Item I,

+-LLE$*)%T*L E

%imple %tyles. (!?LLI!?) (!?LLI!?)?N,TXT !,I:!I!?) !,I:!I!?)?N,TXT L?R)I!?) L?R)I!?)?N,TXTBLO

tat re4erences gallery de5ned in a se$arate 5le. To start a new aller# in te current 5le9 use B)IN)?LLRJ. ($eci5es aller# item and its content inside te current 5le. ($eci5es te $re4erred aller# st#le.

Composite %tyles. (!?LLI!?)IN8L?C(!?LLI!?)?N,TXTIN8O 8:8 (!?LLI!?)IN8L?C!,I:!I!?)?N,TXTIN8 O8:8 (!?LLI!?)IN8L?CL?R)I!?)?N,TXTBLO IN8O8:8 !,I:!I!?)IN8L?C(!?LLI!?)?N,TXTIN8 O8:8 !,I:!I!?)IN8L?C!,I:!I!?)?N,TXTIN 8O8:8 !,I:!I!?)IN8L?CL?R)I!?)?N,TXTBL OIN8O8:8

COL:!NINRIB BON

Number o4 columns in Ribbon

COL:!NIN8O 8:8

Number o4 columns wen e3$anded

,e5nes te larest size tat te inA$lace aller# can e3$and to wen s$ace is available. ,e5nes te minimum size o4 te $o$u$ aller#.

'ropdowns #eyword

&alue

'escription

,RO8,ON

Re4erenced Item I,

B)IN,RO8,ON N,,RO8,ON ,RO8,ON(TJL

New Item I,

($eci5es item tat re4erences dropdown !utton de5ned in a se$arate 5le. ($eci5es cascade item and its content inside te current 5le. ($eci5es $re4erred dro$down st#le.

COL:!N,RO8,ON

Number o4 columns in dro$ down

?(8O8:8!N: 8?LTT

Ot/er #eyword

&alue

'escription

C?(C?,

Re4erenced Item I,

B)INC?(C?, N,C?(C?, ?TT?C!NTT?R) T

New Item I,

($eci5es item tat re4erences cascade de5ned in a se$arate 5le. ($eci5es cascade item and its content inside te current 5le. :sed to attac new content to a builtAin container or bar. Onl# to be used in .abr 5les and is declared at te beinnin o4 te 5le.

CONTXTTITL (TJL

 To$Bac7(tae)rou$ Le4tBac7(tae)rou$ RitBac7(tae)rou$ BottomBac7(tae)rou$ Kuic7?ccessBar Ribbon(#stemBar (electionBar  To$BorderBar BottomBorderBar Le4tBorderBar RitBorderBar ?lternate title ,F?:LT  TXTONLJ?L?J( I!?)?N,TXT  TXTONLJ!N:

:sed 4or dierentiatin between rou$s in Customize dialo ($eci5es item st#le 4or reular toolbars and menus

Transition NX develo$ment as created o$tions to el$ wit te transition o4 Classic Toolbar content to Ribbon content 4or bot interactive customizations and 5le based customizations.

Interactive Transition In NX / Ribbon mode9 eac e3istin toolbar >TBR@ 5le tat is loaded into NX will be converted on te M# to be available as a Ribbon rou$. ven i4 no action is ta7en $rior to launcin NX9 tese rou$s can be 4ound in te Customize dialo on te Commands tab under te ?s )rou$s@= node. Tis also a$$lies to custom toolbars tat were created interactivel# usin te Customize dialo.  Toolbars as rou$s can ten be used in Ribbon mode b# drain tem onto Ribbon tabs or border bars. Li7e all interactive customizations9 an# canes can be saved in a role 5le to be used later or distributed.

File Based Transition  Te new containers and 7e#words available in NX / ave alread# been described earlier in tis document. Tis section will re4erence tose new containers and 7e#words and $resent a 4ew alternate coices wen convertin a toolbar to te Ribbon. Te e3am$le below will start wit one !N 5le containin ' customerA created buttons and one TBR 5le tat re4erences tem. B# te end o4 te e3am$le9 one Ribbon tab will be created wit tese same ' buttons a$$earin in tree se$arate Ribbon rou$s. ac o4 tese rou$s will be created in a dierent wa#.  Te dierences will de$end on ow muc Ribbon s$eci5c la#out eac rou$ reuires. Option 0  Te 5rst rou$ in te e3am$le below re$resents a Ribbon rou$ tat re4erences an e3istin toolbar wit no Ribbon st#le canes.  Tis is te uic7est wa# to add e3istin toolbar content into Ribbon mode but $rovides no Ribbon s$eci5c la#out. Option 1  Te second rou$ in te e3am$le below re$resents a Ribbon rou$ tat re4erences an e3istin toolbar wit Ribbon s$eci5c st#le canes added to it. Tere is no dierence in ow tis toolbar is re4erenced in te .rtb 5le com$ared to te 5rst toolbar as a rou$. Te onl# dierences 4rom te 5rst rou$ e3ist witin te .tbr 5le itsel4.  Tis a$$roac as advantaes 4or customers tat will de$lo# bot Ribbon and Classic !ode customizations since all te content is de5ned in te .tbr 5le and it will sta# s#ncronized in bot modes. Onl# one set o4 customizations will need to be

maintained wile still ma7in use o4 RIBBON(TJL to control te $resentation o4 te buttons on te Ribbon. Option 2  Te tird rou$ in te e3am$le below re$resents a Ribbon rou$ tat as been created e3$licitl# as a Ribbon rou$ and will not e3ist in Classic Toolbar mode. Tis is te $re4erred o$tion since te user will be able to ta7e advantae o4 all te la#out st#les and containers oered b# te Ribbon. owever9 4or customers tat will de$lo# bot Ribbon and Classic !ode customizations9 tis a$$roac will result in two sets o4 customizations wit no s#ncronization between tem. Example

Classic Toolbar mode

Files used6 • •

customermen.men customertoolbar.tbr

(creensot6

Ribbon Mode

Files used6 • • • • •

customermen.men customertab.rtb customertoolbar.tbr customertoolbaralternate.tbr customerrou$.rb

(creensot6

customermen.men ! ! ! ! !

Customer menu file Contains button definitions to be used in toolbars and Ribbon files

VERSION 120 EDIT UGGTE"#$IN$ENU%R TO&$ENU CSCDE%UTTON CUSTO$ER$ENU '%E' Customer $enu ENDO(TO&$ENU $ENU CUSTO$ER$ENU %UTTON CUSTO$ER%UTTON1 '%E' $enu %utton1 %IT$& n)a** %UTTON CUSTO$ER%UTTON2 '%E' $enu %utton2 %IT$& filesa+e %UTTON CUSTO$ER%UTTON, '%E' $enu %utton, %IT$& -urrentfeature %UTTON CUSTO$ER%UTTON. '%E' $enu %utton. %IT$& blo-/ %UTTON CUSTO$ER%UTTON '%E' $enu %utton %IT$& -e-/reen ENDO($ENU

customerribbontab.rtb ! ! ! ! ! !

Customer Ribbon Tab Tis file 3ill -reate a ne3 -ustomer tab -ontainin tree rou*s and one to* le+el button4

TIT'E Customer Tab VERSION 150 ! Te first rou* re*resents a Ribbon rou* tat referen-es an e)istin ! toolbar 3it no Ribbon st6le -anes4 ! ! Tis is te 7ui-/est 3a6 to add e)istin toolbar -ontent into Ribbon mode4 ! GROU& -ustomertoolbar4tbr ! Te se-ond rou* re*resents a Ribbon rou* tat referen-es an e)istin ! toolbar 3it Ribbon s*e-ifi- st6le -anes added to it4 Tere is no differen-e ! in o3 tis toolbar is referen-ed in te 4rtb file -om*ared to te first ! toolbar as a rou*4 Te onl6 differen-es from te first rou* e)ist 3itin ! te 4tbr file itself4 ! ! Tis a**roa- as ad+antaes for -ustomers tat 3ill de*lo6 bot Ribbon and ! Classi- $ode -ustomi8ations sin-e all te -ontent is defined in te 4tbr ! file and it 3ill sta6 s6n-roni8ed in bot modes4 Onl6 one set of -ustomi8ations ! 3ill need to be maintained 3ile still ma/in use of RI%%ONST#'E to ! -ontrol te *resentation of te buttons on te Ribbon4 ! GROU& -ustomertoolbaralternate4tbr ! Te tird rou* re*resents a Ribbon rou* tat as been -reated e)*li-itl6 ! as a Ribbon rou* and 3ill not e)ist in Classi- Toolbar mode4 Tis is te ! *referred o*tion sin-e te user 3ill be able to ta/e ad+antae of all te ! la6out st6les and -ontainers offered b6 te Ribbon4 ! ! (or -ustomers tat 3ill de*lo6 bot Ribbon and Classi- $ode -ustomi8ations9 ! tis 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 te 4rtb file b6 usin te ! /e63ords %EGINGROU& and ENDGROU&4 ! GROU& -ustomerrou*4rb ! E)am*le of a button tat is *la-ed dire-tl6 on te Ribbon 3itout bein ! -ontained in a rou*4 Tis 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+antaes4 ! !  fe3 ad+antaes of rou*s: ! 14 Easier to mo+e man6 buttons around toeter in 7ui-/ -ustomi8ation4 ! (or e)am*le9 $%, on a rou* and -oose ;dd to 'eft %order %ar;4 ! Tis 3ill mo+e te 3ole rou* to a ne3 lo-ation4 If buttons are ! not in a rou*9 te6 need to be mo+ed one at a time4 ! ! 24 &ro+ide a label to des-ribe its -ontents4 ! %UTTON CUSTO$ER%UTTON1 '%E' %utton1 Dire-tl6 on Tab

customertoolbar.tbr ! ! ! ! ! ! ! ! ! ! ! ! !

Customer Toolbar (ile Tis is similar to an e)istin toolbar file -ontainin no Ribbon -anes4 In Classi- Toolbars mode < Tis toolbar 3ill still so3 u* in te toolbars list4 In Ribbon mode < Tis toolbar 3ill be automati-all6 -on+erted to a Ribbon rou* and 3ill a**ear in te ;Classi- Toolbars as Grou*s; se-tion in te Customi8e dialo4

TIT'E Toolbar VERSION 150 %UTTON CUSTO$ER%UTTON1 '%E' Toolbar %utton1 %UTTON CUSTO$ER%UTTON2 '%E' Toolbar %utton2 %UTTON CUSTO$ER%UTTON, '%E' Toolbar %utton, %UTTON CUSTO$ER%UTTON. '%E' Toolbar %utton. %UTTON CUSTO$ER%UTTON '%E' Toolbar %utton

customertoolbaralternate.tbr ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !

Customer Toolbar (ile =lternate> Tis is similar to an e)istin toolbar file 3it ne3 Ribbon st6les added4 Te RI%%ONST#'E 3ill be onored 3en te toolbar is loaded in Ribbon mode as a rou* but 3ill be inored 3en te toolbar is dis*la6ed in Classi- Toolbars mode4 In Classi- Toolbars mode < Tis toolbar 3ill still so3 u* in te toolbars list4 In Ribbon mode < Tis toolbar 3ill be automati-all6 -on+erted to a Ribbon rou* and 3ill a**ear in te ;Classi- Toolbars as Grou*s; se-tion in te Customi8e dialo4

TIT'E Toolbar =lternate> VERSION 150 %UTTON CUSTO$ER%UTTON1 '%E' Toolbar=lt> %utton1 RI%%ONST#'E 'RGEI$GE %UTTON CUSTO$ER%UTTON2 '%E' Toolbar=lt> %utton2 RI%%ONST#'E 'RGEI$GE %UTTON CUSTO$ER%UTTON, '%E' Toolbar=lt> %utton, RI%%ONST#'E S$''I$GENDTE?T %UTTON CUSTO$ER%UTTON. '%E' Toolbar=lt> %utton. RI%%ONST#'E S$''I$GENDTE?T %UTTON CUSTO$ER%UTTON '%E' Toolbar=lt> %utton RI%%ONST#'E S$''I$GENDTE?T

customerrou$.rb ! ! ! ! ! ! ! !

Customer Ribbon Grou* (ile In Classi- Toolbars mode < Tis rou* 3ill be una+ailable In Ribbon mode < Tis rou* 3ill so3 u* in te ;ll Grou*s; list in te Customi8e dialo4

TIT'E Grou* VERSION 150 %UTTON CUSTO$ER%UTTON1 '%E' Grou* %utton1 RI%%ONST#'E 'RGEI$GE ! E)am*le of a aller6 defined in a GR% file4 ! ! If tis aller6 is to be used in oter *la-es9 ten it -ould be ! defined in its o3n aller6 =G'#> file and referen-ed ere ! E)am*le: ! G''ER# -ustomeraller64l6 ! %EGING''ER# CUSTO$ERG''ER# CO'U$NINRI%%ON 2 CO'U$NIN&O&U& 2 '%E' Galler6 G''ER#ST#'E $EDIU$I$GENDTE?T %UTTON CUSTO$ER%UTTON2 '%E' Grou* %utton2 %UTTON CUSTO$ER%UTTON, '%E' Grou* %utton, %UTTON CUSTO$ER%UTTON. '%E' Grou* %utton. %UTTON CUSTO$ER%UTTON '%E' Grou* %utton ENDG''ER#