Extension point for defining kit commands.(c) SAP AG 2003-2006. All rights reserved.
Defines a new command object.The new command object.The newly defined command.<h2>Xml definition of a command in a configuration file</h2>
<pre>
<CONFIGURE type="COMMANDS">
? <HEADER>
? <PRAGMA># Pragmas section</PRAGMA>
? <SCRIPT># Code section. Place here functions\variables
which you want to address from within the command tags
</SCRIPT>
</HEADER>
<COMMANDS>
+ <COMMAND id="com.sap.mypackage:commandId">
# For complete description of command
definition see <q ref="core.env:KitCommands!COMMAND_DEF">COMMAND_DEF</q>
? <PROPERTIES>
* <propertyName type="[function | ]"/>
# Represents a property of the command
You can assign the 'type' attribute for
evaluating the value of the property
as a function
</PROPERTIES>
</COMMAND>
</COMMANDS>
</CONFIGURE>
</pre>
<h2>Example</h2>
<pre>
<CONFIGURE type="COMMANDS">
<COMMANDS>
<COMMAND id="FILE_CLOSE">
<PROPERTIES>
<signal>closeStudio</signal>
<text>#TEXT[XMIT_CMD_FILE_CLOSE]</text>
<icon>#URL[<code>skin:icons.close.gif]</icon></code>
<category>STANDARD</category>
</PROPERTIES>
</COMMAND>
</COMMANDS>
</CONFIGURE>
</pre>
Returns a specified command object.Command Id.The requested command object.
Returns the complete commands table.Table of command objects, indexed by command id.Command id's are stored in uppercase. Use <q ref="core.lib:Basic!UPPER">UPPER</q> macro to convert the command id to uppercase
before using it as the index in this table.
Parses the given command node and returns a string which represents its details.Command node to parse.
Removes a specified command definition.The id of the command to remove.
Represents a Storyboard command definition.The COMMAND_DEF structure is made of:
<table class="BOTH"><tr><td class="H V">Name </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName </td><td>Command Id - must be prefixed with namespace e.g. com.sap.mypackage:id </td></tr><tr><td class=V>signal </td><td><q ref="core.lib:Global!SIGNAL_DEF">SIGNAL_DEF</q> </td><td>Signal to raise when the command is invoked </td></tr><tr><td class=V>text </td><td>String </td><td>Command text label </td></tr><tr><td class=V>icon </td><td>String </td><td>Command icon's relative url </td></tr><tr><td class=V>key </td><td>String </td><td>Shortcut key mnemonic (e.g, Ctrl+S) </td></tr><tr><td class=V>category </td><td>String </td><td>The command category (can also be a regular expression) </td></tr></table>