Create PML Commands

PML Customisation User Guide

PML Add-ins : Example: Create a PML Add-in : Create PML Commands

Create PML Commands

Functionality is available to fully control various aspects of the User Interface. This example includes:

•

Simple commands

•

•

•

Context tab commands

To create a simple command, in your customised PMLLIB folder:

1.

Create a new folder \PMLLIB\Commands

2.

Create a new PMLCMD file. You may want to copy an existing PMLCMD file and rename it as appropriate.

3.

Modify the file as per the following example:

The full list of properties of a command is:

4.

You can create a similar command named !!gencmdB

Options to execute these commands will be added to the ribbon later.

However, the command can be controlled by PML commands, for example:

!!gencmdA.enabled(FALSE)

!!gencmdA.visible(TRUE)

The full list of command methods is:

Note:

The native AVEVA commands can also be controlled (for example, deactivated or hidden) using these methods.

To create a state command, in your customised PMLLIB\Commands folder:

1.

Create a new PMLCMD file. You may want to copy an existing PMLCMD file and rename it as appropriate.

2.

Modify the file as per the following example:

Options to control the state for this command will be added to the ribbon later.

However, the command can be controlled by PML commands, for example:

To create a list command, in your customised PMLLIB\Commands folder:

1.

Create a new PMLCMD file. You may want to copy an existing PMLCMD file and rename it as appropriate.

2.

Modify the file as per the following example:

The command can be controlled by PML commands, for example:

Context Tab Command

To create a context tab command, in your customised PMLLIB\Commands folder:

1.

Create a new PMLCMD file. You may want to copy an existing PMLCMD file and rename it as appropriate.

2.

Modify the file as per the following example:

Note:

The key attribute must be associated with the correct tab in the application. Refer to Create a Tab on the Ribbon for further information.

Note:

The context tab command must be associated with the correct discipline within the application.

The context tab command can be modified to define the way in which it is displayed, for example:

•

The tab can be displayed when your PML add-in is activated.

•

The tab can be displayed jointly with another PML add-in tab.

1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.