Command Class

Defines a framework tool that can be used on a menu or a toolbar.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public MustInherit Class Command

'Usage
 
Dim instance As Command

public abstract class Command

Remarks

This class defines the basic object that allows the user to control the application via selecting a menu item or an item on a toolbar. A Command is an object that provides the information necessary to display the command to the user (via the main menu or a toolbar) and to execute or perform the action associated with the command when the user selects or clicks the displayed command. This class is an abstract class and contains the abstract method Execute which is invoked when the command is selected or clicked. Since the Execute method is abstract, a derived class is required to provide this method to perform the action specified to that command. The following is a list of the derived Commands provided by this framework.

This is the basic Command that allows the user to display a submenu of Commands when this item is selected. This item can be placed on a toolbar, another menu, or a context menu available anywhere on the desktop. The menu can be displayed with a SideStrip which is a vertical strip at the left edge of the menu that can contain vertically drawn text and/or an image. The SideStrip duplicates the look of the StartMenu in Windows 2000. The tool has a property called 'AllowTearaway' that allows the menu to be 'torn away' and floated in its own window.
This Command provides the standard toolbar button behavior and look. The command can display an image and/or text and can reside on toolbars or in menus. When on a toolbar it behaves like a normal button when pressed (i.e., it visually depresses, and when it returns to the up position, a click event is fired).
This Command is a toggle-type button which operates in groups much like a set of radio buttons. It has a Checked property which reflects its state and an OptionSet property which identifies it as part of a group of StateButtons. All StateButtons that have been assigned to the same OptionSet behave as a group - only one button in the OptionSet can be checked at any given time. In addition, OptionSets have an AllowAllUp property that determines whether all buttons in the group can be 'up' or unchecked at the same time.
This Command provides the functionality of a standard windows textbox in the form of a tool that can be placed on a toolbar or menu. Since the user can move focus to the textbox at any time and enter text, the question arises as to how the programmer is notified when user input has completed.
This Command provides the functionality of a standard windows combo box and can be placed on a toolbar or menu. Events are fired as the list drops down and closes when items are selected. Two styles are available - Dropdown and DropdownList.
This Command displays a list of strings on a menu. Each list item is displayed as a separate tool on the menu and can have a value associated with it that is independent of the entry's text. Each list item also has an Appearance object associated with it. The CommandList tool is great for creating file MRU lists.
This Command displays static text. It does not respond to mouse clicks.
This Command allows any .NET control to be embedded in the tool. Virtually any kind of user interface element can be placed on a toolbar or menu.
This Command allows any .NET control to be embedded in a popup window.
This Command displays a dropdown list of all the fonts available on the system using the actual font to display each entry.
This Command displays a popup group of colors from which the user can select a color.
This Command is designed to be used on a menu belonging to an MDI parent form, this command displays a list of the currently open MDI child windows belonging to the parent. It can also display one or more window manipulation commands related to the MDI child windows. No code is required to achieve this behavior - simply place a CommandMdiWindowList on a menu and it handles the rest.

Inheritance Hierarchy

System.Object
   Miner.Windows.Commands.Command
      Miner.Windows.Commands.ButtonCommand
      Miner.Windows.Commands.PopupCommandBase
      Miner.Windows.Commands.StateButtonCommand
      Miner.Windows.Commands.TextBoxCommand

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

Reference

Command Members
Miner.Windows.Commands Namespace