FormCommand Reference |
[This is preliminary documentation and is subject to change.]
The FormCommand element is used for adding extra buttons to the dynamic form that can execute custom made plugins that implement the IFormCommandHandler interface.
It is not currently possible to edit FormCommand elements from the editor, instead the xml file must be edited directly.
Attribute | Type | Description |
---|---|---|
ButtonId | String | The id of the button. |
Visible | String | A TOPICA basic statement that must evaluate to a boolean value that defines whether or not the button will be visible. |
Enabled | String | A TOPICA basic statement that must evaluate to a boolean value that defines whether or not the button will be enabled. |
AssemblyName | String | The name of the .Net assembly that contains the class the implements the IFormCommandHandler interface. |
TypeName | String | The name of the type in the referenced assembly that implementes the IFormCommandHandler interface. |
Tooltip | String | The tooltip for the button that executes the form command. Can contain embedded TOPICA basic. |
Text | String | The caption on the button that executes the form command. Can contain embedded TOPICA basic. |
ConfirmCommandMessage | String | When the button representing this form command is pressed the user is presented with this text in a dialog that must be confirmed before the command will be executed. If this property is left blank, the user will not be presented with a confirm dialog, the form command will be executed immediatly. |
ShortcutKey | String | The shotcut key combination for this form command consist of a static part, Ctrl+Shift, and a dynamic part which is the ShortKey. The ShortcutKey must be a single character. Fx. If the ShortcutKey is set to K then the shortcut for the form command will be Ctrl+Shift+K |