About the Building a MapViewer application using the ArcGIS Engine controls Sample
[C#]
AddDateTool.cs
using System;
using System.Drawing;
using System.Runtime.InteropServices;
using ESRI.ArcGIS.ADF.BaseClasses;
using ESRI.ArcGIS.ADF.CATIDs;
using ESRI.ArcGIS.Controls;
using System.Windows.Forms;
using ESRI.ArcGIS.Carto;
using ESRI.ArcGIS.Display;
using ESRI.ArcGIS.Geometry;
namespace Commands
{
/// <summary>
/// Summary description for AddDateTool.
/// </summary>
[Guid("bdc34bd5-3040-4141-b16b-ea8c1d7b4d46")]
[ClassInterface(ClassInterfaceType.None)]
[ProgId("Commands.AddDateTool")]
public sealed class AddDateTool : BaseTool
{
#region COM Registration Function(s)
[ComRegisterFunction()]
[ComVisible(false)]
static void RegisterFunction(Type registerType)
{
// Required for ArcGIS Component Category Registrar support
ArcGISCategoryRegistration(registerType);
//
// TODO: Add any COM registration code here
//
}
[ComUnregisterFunction()]
[ComVisible(false)]
static void UnregisterFunction(Type registerType)
{
// Required for ArcGIS Component Category Registrar support
ArcGISCategoryUnregistration(registerType);
//
// TODO: Add any COM unregistration code here
//
}
#region ArcGIS Component Category Registrar generated code
/// <summary>
/// Required method for ArcGIS Component Category registration -
/// Do not modify the contents of this method with the code editor.
/// </summary>
private static void ArcGISCategoryRegistration(Type registerType)
{
string regKey = string.Format("HKEY_CLASSES_ROOT\\CLSID\\{{{0}}}", registerType.GUID);
MxCommands.Register(regKey);
ControlsCommands.Register(regKey);
}
/// <summary>
/// Required method for ArcGIS Component Category unregistration -
/// Do not modify the contents of this method with the code editor.
/// </summary>
private static void ArcGISCategoryUnregistration(Type registerType)
{
string regKey = string.Format("HKEY_CLASSES_ROOT\\CLSID\\{{{0}}}", registerType.GUID);
MxCommands.Unregister(regKey);
ControlsCommands.Unregister(regKey);
}
#endregion
#endregion
private IHookHelper m_hookHelper = null;
public AddDateTool()
{
base.m_category = "CustomMapViewer";
base.m_caption = "Add Date";
base.m_message = "Adds a date element to the active view";
base.m_toolTip = "Add Date";
base.m_name = "CustomMapViewer_AddDateTool"; try
{
string bitmapResourceName = GetType().Name + ".bmp";
base.m_bitmap = new Bitmap(GetType(), bitmapResourceName);
base.m_cursor = new Cursor(GetType(), GetType().Name + ".cur");
}
catch (Exception ex)
{
System.Diagnostics.Trace.WriteLine(ex.Message, "Invalid Bitmap");
}
}
#region Overriden Class Methods
/// <summary>
/// Occurs when this tool is created
/// </summary>
/// <param name="hook">Instance of the application</param>
public override void OnCreate(object hook)
{
try
{
m_hookHelper = new HookHelperClass();
m_hookHelper.Hook = hook;
if (m_hookHelper.ActiveView == null)
{
m_hookHelper = null;
}
}
catch
{
m_hookHelper = null;
}
if (m_hookHelper == null)
base.m_enabled = false;
else
base.m_enabled = true;
}
/// <summary>
/// Occurs when this tool is clicked
/// </summary>
public override void OnClick()
{
// TODO: Add AddDateTool.OnClick implementation
}
public override void OnMouseDown(int Button, int Shift, int X, int Y)
{
//Get the active view
IActiveView activeView = m_hookHelper.ActiveView;
//Create a new text element
ITextElement textElement = new TextElementClass();
//Create a text symbol
ITextSymbol textSymbol = new TextSymbolClass();
textSymbol.Size = 25;
//Set the text element properties
textElement.Symbol = textSymbol;
textElement.Text = DateTime.Now.ToShortDateString();
//QI for IElement
IElement element = (IElement) textElement;
//Create a point
IPoint point = new PointClass();
point = activeView.ScreenDisplay.DisplayTransformation.ToMapPoint(X,Y);
//Set the elements geometry
element.Geometry = point;
//Add the element to the graphics container
activeView.GraphicsContainer.AddElement(element, 0);
//Refresh the graphics
activeView.PartialRefresh(esriViewDrawPhase.esriViewGraphics, null, null);
}
public override void OnMouseMove(int Button, int Shift, int X, int Y)
{
// TODO: Add AddDateTool.OnMouseMove implementation
}
public override void OnMouseUp(int Button, int Shift, int X, int Y)
{
// TODO: Add AddDateTool.OnMouseUp implementation
}
#endregion
}
}
[Visual Basic .NET]
AddDateTool.vb
Imports System.Runtime.InteropServices
Imports System.Drawing
Imports ESRI.ArcGIS.ADF.BaseClasses
Imports ESRI.ArcGIS.ADF.CATIDs
Imports ESRI.ArcGIS.Controls
Imports System.Windows.Forms
Imports ESRI.ArcGIS.Carto
Imports ESRI.ArcGIS.Display
Imports ESRI.ArcGIS.Geometry
<ComClass(AddDateTool.ClassId, AddDateTool.InterfaceId, AddDateTool.EventsId)> _
Public NotInheritable Class AddDateTool
Inherits BaseTool
#Region "COM GUIDs"
' These GUIDs provide the COM identity for this class
' and its COM interfaces. If you change them, existing
' clients will no longer be able to access the class.
Public Const ClassId As String = "35c6e12a-b09c-4673-8ab8-85491f31cd16"
Public Const InterfaceId As String = "9b0c240f-ddf2-4d47-95ca-97239447d765"
Public Const EventsId As String = "837eac70-8f4a-4d7c-8d3c-64e605be9980"
#End Region
#Region "COM Registration Function(s)"
<ComRegisterFunction(), ComVisibleAttribute(False)> _
Public Shared Sub RegisterFunction(ByVal registerType As Type)
' Required for ArcGIS Component Category Registrar support
ArcGISCategoryRegistration(registerType)
'Add any COM registration code after the ArcGISCategoryRegistration() call
End Sub
<ComUnregisterFunction(), ComVisibleAttribute(False)> _
Public Shared Sub UnregisterFunction(ByVal registerType As Type)
' Required for ArcGIS Component Category Registrar support
ArcGISCategoryUnregistration(registerType)
'Add any COM unregistration code after the ArcGISCategoryUnregistration() call
End Sub
#Region "ArcGIS Component Category Registrar generated code"
Private Shared Sub ArcGISCategoryRegistration(ByVal registerType As Type)
Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
ControlsCommands.Register(regKey)
MxCommands.Register(regKey)
End Sub
Private Shared Sub ArcGISCategoryUnregistration(ByVal registerType As Type)
Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
ControlsCommands.Unregister(regKey)
MxCommands.Unregister(regKey)
End Sub
#End Region
#End Region
Private m_hookHelper As IHookHelper
' A creatable COM class must have a Public Sub New()
' with no parameters, otherwise, the class will not be
' registered in the COM registry and cannot be created
' via CreateObject.
Public Sub New()
MyBase.New()
MyBase.m_category = "CustomMapViewer"
MyBase.m_caption = "Add Date"
MyBase.m_message = "Adds a date element to the active view"
MyBase.m_toolTip = "Add Date"
MyBase.m_name = "CustomMapViewer_AddDateTool"
Try
Dim bitmapResourceName As String = Me.GetType().Name + ".bmp"
MyBase.m_bitmap = New Bitmap(Me.GetType(), bitmapResourceName)
MyBase.m_cursor = New Cursor(Me.GetType(), Me.GetType().Name + ".cur")
Catch ex As Exception
System.Diagnostics.Trace.WriteLine(ex.Message, "Invalid Bitmap")
End Try
End Sub
Public Overrides Sub OnCreate(ByVal hook As Object)
If m_hookHelper Is Nothing Then m_hookHelper = New HookHelperClass
If Not hook Is Nothing Then
Try
m_hookHelper.Hook = hook
If m_hookHelper.ActiveView Is Nothing Then m_hookHelper = Nothing
Catch
m_hookHelper = Nothing
End Try
'Disable if hook fails
If m_hookHelper Is Nothing Then
MyBase.m_enabled = False
Else
MyBase.m_enabled = True
End If
End If
End Sub
Public Overrides Sub OnClick()
'TODO: Add AddDateTool.OnClick implementation
End Sub
Public Overrides Sub OnMouseDown(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Integer, ByVal Y As Integer)
'Get the active view
Dim pActiveView As IActiveView = m_hookHelper.ActiveView
'Create a new text element
Dim pTextElement As ITextElement = New TextElementClass
'Create a text symbol
Dim pTextSymbol As ITextSymbol = New TextSymbolClass
pTextSymbol.Size = 25
'Set the text element properties
pTextElement.Symbol = pTextSymbol
pTextElement.Text = Date.Now.ToShortDateString
'QI for IElement
Dim pElement As IElement
pElement = pTextElement
'Create a point
Dim pPoint As IPoint
pPoint = pActiveView.ScreenDisplay.DisplayTransformation.ToMapPoint(X, Y)
'Set the elements geometry
pElement.Geometry = pPoint
'Add the element to the graphics container
pActiveView.GraphicsContainer.AddElement(pTextElement, 0)
'Refresh the graphics
pActiveView.PartialRefresh(esriViewDrawPhase.esriViewGraphics, Nothing, Nothing)
End Sub
Public Overrides Sub OnMouseMove(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Integer, ByVal Y As Integer)
'TODO: Add AddDateTool.OnMouseMove implementation
End Sub
Public Overrides Sub OnMouseUp(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Integer, ByVal Y As Integer)
'TODO: Add AddDateTool.OnMouseUp implementation
End Sub
End Class