ArcFM Engine Developer Guide
BaseGasTraceTool Class Members
| Miner.FrameworkUI Assembly > Miner.FrameworkUI.Trace Namespace : BaseGasTraceTool Class |
The following tables list the members exposed by BaseGasTraceTool.
| 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. (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. (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. (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. (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. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| m_deactivate | Indicates whether or not the Tool is deactivated, returned from the ITool::Deactivate method. True by default. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| m_enabled | The state of this command, returned from the ICommand::Enabled property. True by default. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseCommand. (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. (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. (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. (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. (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. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| 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. (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. (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. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| Checked | Indicates whether or not this command is checked. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseCommand. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| CurrentStartElementType | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| Cursor | Gets the Cursor handle that is used as the mouse pointer for this tool, shown when this tool is the active tool. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| Enabled | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| HelpContextID | 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. (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. (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. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| Name | A string used for programmatic identification of this command. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseCommand. (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. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| Name | Description | |
|---|---|---|
 | CurrentFeatureSnap | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentGeometricNetwork | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentHook | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentSearchConfig | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentSnappedFeature | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentStartEID | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| CurrentTraceStrategy | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| SnapToAllNetworkFeatures | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| TraceResultsDisplay | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| XCoordinate | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| YCoordinate | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| Name | Description | |
|---|---|---|
 | Deactivate | This method returns a boolean value indicating whether the trace tool has been deactivated. (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| OnClick | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| OnContextMenu | This method is called when the context menu event is raised at the given location. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| OnCreate | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| OnDblClick | This method is called when the mouse is double-clicked when the tool is active. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| OnKeyDown | This method is called when a key is pressed down, when this tool is active. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| OnKeyUp | This method is called when a key is released, when this tool is active. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| OnMouseDown | This method is called when a mouse button is pressed down, when this tool is active. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseTool. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseTool) |
| OnMouseMove | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| OnMouseUp | Overloaded. (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| Refresh | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| 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. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| Name | Description | |
|---|---|---|
 | DisplayResults | (Inherited from Miner.FrameworkUI.Trace.BaseTraceTool) |
| Finalize | Overridden. Destructor. Cleans up GDI resources used by the BaseCommand. Inherited from Esri.ArcGIS.ADF.BaseClasses.BaseCommand. (Inherited from ESRI.ArcGIS.ADF.BaseClasses.BaseCommand) |
| GetTraceConfig | Overridden. This method retrieves the gas trace configuration information. |
