ArcFM Desktop Developer Guide
Command Class Members
Properties  Methods  Events


Version: 10.2.1b and 10.2.1b SP1

Resource Center Home

The following tables list the members exposed by Command.

Public Properties
 NameDescription
Public PropertyBoundsReturns the location and size of the command in screen coordinates.  
Public PropertyCaptionReturns/sets the caption to be displayed for this Command.  
Public PropertyCategoryReturns/sets the Category to which this Command belongs.  
Public PropertyCustomizerCaptionReturns/sets a string of text that appears in the run-time Customizer dialog's Commands list.  
Public PropertyCustomizerDescriptionReturns/sets a string of text that is a detailed description of this command in the customizer.  
Public PropertyDefaultSizeReturns the default size of this command.  
Public PropertyDescriptionReturns/sets the description (displayed in status bar) for this Command.  
Public PropertyDisplayStyleReturns/sets the display style (DisplayStyle) for this Command.  
Public PropertyEnabledReturns/sets whether the Command is enabled.  
Public PropertyFontBoldReturns/sets the font bold property of the root or instance tool.  
Public PropertyHeightReturns the height of this command.  
Public PropertyImageReturns/sets the image or image index (into the CommandManager's ImageListSmall bitmap strip) for this Command.  
Public PropertyImageLargeReturns/sets the large image or image index (into the CommandManager's ImageListLarge bitmap strip) for this Command.  
Public PropertyIndexReturns the index of this command in the command manager's Commands collection.  
Public PropertyIsActiveToolReturns/sets whether this command is the active command.  
Public PropertyIsControlContainerReturns whether this command is a container command that can contain other controls.  
Public PropertyIsFirstInGroupReturns/sets whether a separator bar is displayed preceeding this Command. The Command must be an "instance" Command (i.e., a command that appears on a menu or toolbar).  
Public PropertyIsRootToolReturns whether this command is a command in the command manager's Commands collection.  
Public PropertyKeyReturns the unique string identifier for this Command.  
Public PropertyPersistReturns/sets whether this command is to be persisted when the application closes (to prevent MDI window commands from being persisted).  
Public PropertyPriorityReturns/sets a value that determines which tools are shown on a toolbar when there is not enough room (lower priority commands are hidden first).  
Public PropertyRecentlyUsedReturns/sets whether the Command is a recently-used Command. The Command must be an "instance" Command (i.e., a command that appears on a menu or toolbar).  
Public PropertyShortcutReturns/sets the keyboard shortcut (accelerator key) for this Command.  
Public PropertyShowInCustomizerReturns/sets whether the Command can be shown in the customizer dialog.  
Public PropertyTooltipReturns/sets the tooltip to be displayed for this Command.  
Public PropertyVisibleReturns/sets whether the Command is visible.  
Public PropertyVisibleInstanceReturns whether any CommandBar instance of this tool is currently visible.  
Public PropertyWidthReturns/sets the width of the Command depending on whether it is a root Command or an "instance" (PopupMenuCommand or CommandBar item) Command.  
Top
Public Methods
 NameDescription
Public MethodExecuteRaises the Click event for this Command.  
Top
Protected Methods
 NameDescription
Protected MethodOnActivatingRaises the Activating event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnClickRaises the Click event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnContextMenuOpeningRaises the BeforeShowInContextMenu event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnDeactivatedRaises the Deactivated event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnDoubleClickRaises the DoubleClick event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnKeyDownRaises the KeyDown event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnKeyPressRaises the KeyPress event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnKeyUpRaises the KeyUp event and provides a method for derived classes to handle the event without attaching a delegate.  
Protected MethodOnValueChangedRaises the ValueChanged event and provides a method for derived classes to handle the event without attaching a delegate.  
Top
Public Events
 NameDescription
Public EventActivatingThe event that is raised before a control gains the focus.  
Public EventClickThe event that is raised when the control is clicked.  
Public EventContextMenuOpeningThe event that is raised before a command is shown in a context menu.  
Public EventDeactivatedThe event that is raised after a control has lost the focus.  
Public EventDoubleClickThe event that is raised when the control is double-clicked.  
Public EventKeyDownThe event that is raised when a key is pressed while the control has focus.  
Public EventKeyPressThe event that is raised when a key is pressed while the control has focus.  
Public EventKeyUpThe event that is raised when a key is released while the control has focus.  
Public EventValueChangedThe event that is raised when the value of a control changes.  
Top
See Also

Reference

Command Class
Miner.Windows.Commands Namespace

 

 


Send Comment