updateProfile.userCommands Parameter

updateProfile.userCommands parameter

Use the updateProfile.userCommands parameter to set or query the user commands that will be used by the updateProfile command. The user commands are a list of command/class name pairs that you wish to define when the updateProfile command is issued.

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

updateProfile.userCommands is scoped to the current view.
current.updateProfile.userCommands is scoped to the current view.
default.updateProfile.userCommands is globally scoped.
install.updateProfile.userCommands is globally scoped.

Syntax
query updateProfile.userCommands
set updateProfile.userCommands { default
                               | [ command className ] [...]
                               }
query current.updateProfile.userCommands
query default.updateProfile.userCommands
set default.updateProfile.userCommands { install
                                       | [ command className ] [...]
                                       }
query install.updateProfile.userCommands 
Parameters

default If you specify the default parameter for the set updateProfile.userCommands command, the current view will use the value of default.updateProfile.userCommands as the user commands for the updateProfile command.
[ command className ] [...] If you specify a list of command/class name pairs for the set updateProfile.userCommands command, the updateProfile command will use that list of user commands within the current view. If you specify a list of command/class name pairs for the set default.updateProfile.userCommands command, the updateProfile command will use that list of user commands within all document views that have the updateProfile.userCommands set to default.

The command parameter is the name of the user command that you want to define. The className parameter should be the name of a Java class that implements the com.ibm.lpex.core.LpexCommand interface.
install If you specify the install parameter for the set default.updateProfile.userCommands command, all views with updateProfile.userCommands set to default will use the value of install.updateProfile.userCommands to determine the user commands to be used by the updateProfile command.

Description

The query current.updateProfile.userCommands command returns the list of command/class name pairs that will be used in the current view by the updateProfile command.

Examples
query updateProfile.userCommands
set updateProfile.userCommands test com.ibm.lpex.samples.TestCommand
query current.updateProfile.userCommands
query default.updateProfile.userCommands
set default.updateProfile.userCommands install
query install.updateProfile.userCommands 
updateProfile command
query command
set command
commandClass parameter
commands parameter
current parameter
default parameter
install parameter
updateProfile.baseProfile parameter
updateProfile.parser parameter
updateProfile.userActions parameter
updateProfile.userKeyActions parameter
updateProfile.userMouseActions parameter
updateProfile.userProfile parameter

default	If you specify the default parameter for the set updateProfile.userCommands command, the current view will use the value of default.updateProfile.userCommands as the user commands for the updateProfile command.
[ command className ] [...]	If you specify a list of command/class name pairs for the set updateProfile.userCommands command, the updateProfile command will use that list of user commands within the current view. If you specify a list of command/class name pairs for the set default.updateProfile.userCommands command, the updateProfile command will use that list of user commands within all document views that have the updateProfile.userCommands set to default. The command parameter is the name of the user command that you want to define. The className parameter should be the name of a Java class that implements the com.ibm.lpex.core.LpexCommand interface.
install	If you specify the install parameter for the set default.updateProfile.userCommands command, all views with updateProfile.userCommands set to default will use the value of install.updateProfile.userCommands to determine the user commands to be used by the updateProfile command.