ESRI.ArcGIS.ADF.Local
BaseTool Class Members
See Also  Fields  Properties  Methods  Send Feedback
ESRI.ArcGIS.ADF.BaseClasses Namespace : BaseTool Class




The following tables list the members exposed by BaseTool.

Protected Fields

 NameDescription
Protected Fieldm_bitmap The bitmap that is used as the icon on this command, returned by the ICommand::Bitmap property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_caption The caption of this command, returned by the ICommand::Caption property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_category The name of the category with which the command is associated, returned by the ICommand::Category property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_checked The checked state of this command, returned from the ICommand::Checked property. False by default. (Inherited from BaseCommand)
Protected Fieldm_cursor A System.Windows.Forms.Cursor that is used for this tool, the handle of which is returned by the ITool::Cursor property. Null by default, indicating the default cursor will be used.  
Protected Fieldm_deactivate Indicates whether or not the Tool is deactivated, returned from the ITool::Deactivate method. True by default.  
Protected Fieldm_enabled The state of this command, returned from the ICommand::Enabled property. True by default. (Inherited from BaseCommand)
Protected Fieldm_helpFile The name of the helpfile associated with this command, returned by the ICommand::Helpfile property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_helpID The help context ID associated with this command, used to specify the mapped numeric value of the topic ID of the context sensitive help topic for the command. Null by default. (Inherited from BaseCommand)
Protected Fieldm_message The statusbar message for this command, returned by the ICommand::Message property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_name A string used for identification of this command, returned by the ICommand::Name property. Null by default. (Inherited from BaseCommand)
Protected Fieldm_toolTip The tooltip for this command, returned from the ICommand::Tooltip property. Null by default. (Inherited from BaseCommand)
Top

Public Properties

 NameDescription
Public PropertyBitmap Gets the bitmap that is used as the icon on this command, shown when the command is placed on a toolbar in Icon mode. (Inherited from BaseCommand)
Public PropertyCaption The caption of this command, shown when the command is placed on a toolbar in Caption mode. (Inherited from BaseCommand)
Public PropertyCategory The name of the category with which the command is associated, used by the Customize dialog box. (Inherited from BaseCommand)
Public PropertyChecked Indicates whether or not this command is checked. (Inherited from BaseCommand)
Public PropertyCursor Gets the Cursor handle that is used as the mouse pointer for this tool, shown when this tool is the active tool.  
Public PropertyEnabled The enabled state of this command, determines whether the command is usable. (Inherited from BaseCommand)
Public PropertyHelpContextID The help context ID associated with this command, used to specify the mapped numeric value of the topic ID of the context sensitive help topic for the command. Null by default. (Inherited from BaseCommand)
Public PropertyHelpFile The name of the helpfile associated with this command. Used to specify the name of the help file that contains the context sensitive help topic for the command. (Inherited from BaseCommand)
Public PropertyMessage The statusbar message for this command, appears in the application status bar when the mouse passes over the command. (Inherited from BaseCommand)
Public PropertyName A string used for programmatic identification of this command. (Inherited from BaseCommand)
Public PropertyTooltip The tooltip for this command, appears in the screen tip when the mouse hovers over the command. (Inherited from BaseCommand)
Top

Public Methods

 NameDescription
Public MethodDeactivate This method is called when the tool becomes inactive.  
Public MethodOnClick Called when the user clicks a command. (Inherited from BaseCommand)
Public MethodOnContextMenu This method is called when the context menu event is raised at the given location.  
Public MethodOnCreate Called when the command is created inside the application. (Inherited from BaseCommand)
Public MethodOnDblClick This method is called when the mouse is double-clicked when the tool is active.  
Public MethodOnKeyDown This method is called when a key is pressed down, when this tool is active.  
Public MethodOnKeyUp This method is called when a key is released, when this tool is active.  
Public MethodOnMouseDown This method is called when a mouse button is pressed down, when this tool is active.  
Public MethodOnMouseMove This method is called when the mouse is moved while a mouse button is pressed down, when this tool is active.  
Public MethodOnMouseUp This method is called when a mouse button is released, when this tool is active.  
Public MethodRefresh This method is called when a screen display in the application is refreshed, if the tool is active in that display.  
Public MethodUpdateBitmapChanges the Bitmap for the command. Call this method to update the icon used for the command at runtime, after the command has already been instantiated. (Inherited from BaseCommand)
Top

Protected Methods

 NameDescription
Protected MethodFinalize Destructor. Cleans up GDI resources used by the BaseCommand. (Inherited from BaseCommand)
Top

See Also

© 2010 All Rights Reserved.