PML Customisation User Guide
PML Add-ins : Example: Create a PML Add-in : Create a UIC File
Create a UIC File
A UIC file is an XML file used to store organisation information for your ribbon.
It is recommended to separate your UIC files from those supplied by AVEVA. You can create as many UIC files as you want.
1.
Modify the CAF_UIC PATH in your evars files to append to your chosen folder. For example, \Menus\ADDIN
2.
Copy an existing <Module>Customization.xml to your chosen folder.
3.
Modify the file as per the following example:
Note:
Commands for several add-ins can be grouped in the same UIC file. It is still possible to separate the commands by tab and display a tab according to an add-in context.
4.
To make your custom tabs appear after the native AVEVA tabs, define your environment variables as per the following example (otherwise the tabs will appear first, on the left-hand side of the ribbon):
set caf_uic_path=%aveva_design_exe%;C:\MyPML\E3D\Menus\ADDIN
set caf_addins_path=%aveva_design_exe%;C:\MyPML\E3D\Menus\ADDIN
Link a Command Button to a PML Command
Functionality is available to link a command button to a PML command from within the application.
1.
Start the application, right-click on the ribbon and select Customize to display the Customize window.
2.
On the left-hand side of the Customize window, select the required file from the Active Customization File drop-down list.
3.
Click Active Customization File, the selected UIC file is displayed on the right-hand side of the window.
4.
Right-click on the main list and select New > Button from the drop-down list.
5.
Create a command named MycommandA as per the following example:
Note:
The image resource cannot be browsed at this stage, paste the filename into the Icon row.
Select the Command row and click adjacent to the command name to display the Command window.
The Command window displays the defined PML commands in the commands browser. Refer to Create PML Commands for further information.
Link the command button to the PML command
6.
Repeat as necessary for all required PML commands.
Create a Tab on the Ribbon
Functionality is available to create a tab on the ribbon, you can then display your existing PML commands on the created tab.
1.
Start the application, right-click on the ribbon and select Customize to display the Customize window.
2.
On the left-hand side of the Customize window, right-click on Tabs and select New Tab from the drop-down list to create a new tab.
3.
Create a tab as per the following example:
Note:
Make sure the Name is identical to the defined context tab command. Refer to Context Tab Command for further information.
4.
Create a group below the tab, you can then drag and drop the existing commands on the ribbon tab.
Note:
The tab is managed by the PMLCMD but can have a command of its own.
5.
Apply the modifications to the Customize window and do a Save Work.
1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Logo