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

ESRI.ArcGIS.ADF.BaseClasses Namespace : BaseTool Class

Include Inherited Members

Include Protected Members

The following tables list the members exposed by BaseTool.

Protected Fields

	Name	Description
	m_bitmap	The bitmap that is used as the icon on this command, returned by the ICommand::Bitmap property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_caption	The caption of this command, returned by the ICommand::Caption property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_category	The name of the category with which the command is associated, returned by the ICommand::Category property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_checked	The checked state of this command, returned from the ICommand::Checked property. False by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_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.
	m_deactivate	Indicates whether or not the Tool is deactivated, returned from the ITool::Deactivate method. True by default.
	m_enabled	The state of this command, returned from the ICommand::Enabled property. True by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_helpFile	The name of the helpfile associated with this command, returned by the ICommand::Helpfile property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_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 ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_message	The statusbar message for this command, returned by the ICommand::Message property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_name	A string used for identification of this command, returned by the ICommand::Name property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	m_toolTip	The tooltip for this command, returned from the ICommand::Tooltip property. Null by default. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)

Public Properties

	Name	Description
	Bitmap	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 ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Caption	The caption of this command, shown when the command is placed on a toolbar in Caption mode. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Category	The name of the category with which the command is associated, used by the Customize dialog box. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Checked	Indicates whether or not this command is checked. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Cursor	Gets the Cursor handle that is used as the mouse pointer for this tool, shown when this tool is the active tool.
	Enabled	The enabled state of this command, determines whether the command is usable. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	HelpContextID	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 ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	HelpFile	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 ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Message	The statusbar message for this command, appears in the application status bar when the mouse passes over the command. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Name	A string used for programmatic identification of this command. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	Tooltip	The tooltip for this command, appears in the screen tip when the mouse hovers over the command. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)

Public Methods

	Name	Description
	Deactivate	This method is called when the tool becomes inactive.
	OnClick	Called when the user clicks a command. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	OnContextMenu	This method is called when the context menu event is raised at the given location.
	OnCreate	Called when the command is created inside the application. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)
	OnDblClick	This method is called when the mouse is double-clicked when the tool is active.
	OnKeyDown	This method is called when a key is pressed down, when this tool is active.
	OnKeyUp	This method is called when a key is released, when this tool is active.
	OnMouseDown	This method is called when a mouse button is pressed down, when this tool is active.
	OnMouseMove	This method is called when the mouse is moved while a mouse button is pressed down, when this tool is active.
	OnMouseUp	This method is called when a mouse button is released, when this tool is active.
	Refresh	This method is called when a screen display in the application is refreshed, if the tool is active in that display.
	UpdateBitmap	Changes 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 ESRI.ArcGIS.ADF.BaseClasses.BaseCommand)

See Also

Reference

BaseTool Class

ESRI.ArcGIS.ADF.BaseClasses Namespace

© 2011 All Rights Reserved.