Description

Manages all the commands in the application.

Type

Databound window.

Screenshot


Key

The key is the unique Command name, and is the record ID to the command's data record in FW_COMMANDS.

Category

The category is a means to organize commands into groups.  While not necessary, all commands must fall into at least one category.  Categories are used in the Security Policies window to define security policy records.

Caption

Caption is the text that appears next to (on the right-side), below, or in lieu of, a command's icon image.  This text is normally visible when the command is used on the ribbon control.

Tooltip

The tooltip is the text that "floats" over a button, when the mouse cursor hovers over the specific command on the ribbon control.  This is normally used to provide brief help text as to the command's functionality or purpose.

Small Icon

This is the path to a small icon image (normally 16x16), used as the image to be displayed on the ribbon control for the specific command.  If a Caption is provided, the icon will be displayed to the left of the text.

Large Icon

This is the path to a large icon image (normally 32x32), used as the image to be displayed on the ribbon control for the specific command.  If a Caption is provided, the icon will be displayed above the text.  By default, if the large icon is specified, it will be the icon that is used on the ribbon control.

The LargeIcon attribute sets up the icon to be used when the button is large. Omitting this attribute informs the ribbon that any button using this command should be small in size, if possible. If the ribbon renders the button as large anyway, then the small image is scaled to a larger size.

Keyboard Tip

The Keyboard Tip attribute establishes the sequence of keys that trigger this command when the user is holding down the Alt key. Consider the old menu system. If you want the user to open a file by pressing Alt+F to open the file menu followed by Alt+O, then you needed to set the menu text to "&Open". The ampersand tells OI what letter is to be used, and the letter is called the accelerator.  Keyboard tips are very much like accelerators except they can have more than one letter to avoid ambiguity among other controls on the same tab. If you omit this attribute, then the keyboard tip is generated from the caption.  If you set this to one or two letters, then that becomes the preferred keyboard tip. The ribbon will attempt to use that keyboard tip as long as it doesn't conflict elsewhere.

Shortcut

The Shortcut attribute establishes the keyboard shortcut that will execute this command. Unlike the keyboard tip, which is only used when the user presses the Alt key, this attribute defines a full shortcut. For example, you can set the Shortcut attribute of a command called "SAVE" to "Ctrl+S". You can use any of the three command keys in any combination: Ctrl, Shift, or Alt. You can also use any letter, number, or function key. Examples include "Shift+F3", "Alt+F1", or "Shift+Ctrl+F".

Enabled


Execute

  • No labels