ArcObjects Library Reference  

ToggleDynamicDisplayCmd

About the Simple dynamic display application Sample

[C#]

ToggleDynamicDisplayCmd.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 ESRI.ArcGIS.Carto;

namespace MyDynamicDisplayApp
{
  /// <summary>
  /// Summary description for ToggleDynamicDisplayCmd.
  /// </summary>
  [Guid("290c4325-84b9-49fd-9436-b27c4a4f1de5")]
  [ClassInterface(ClassInterfaceType.None)]
  [ProgId("MyDynamicDisplayApp.ToggleDynamicDisplayCmd")]
  public sealed class ToggleDynamicDisplayCmd : BaseCommand
  {
    #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);
      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);
      ControlsCommands.Unregister(regKey);

    }

    #endregion
    #endregion

    private IHookHelper m_hookHelper;
    private IDynamicMap m_dynamicMap;

    public ToggleDynamicDisplayCmd()
    {
      base.m_category = "Toggle dynamic display"; 
      base.m_caption = "Toggle dynamic mode";  
      base.m_message = "Toggle dynamic mode on and off";   
      base.m_toolTip = "Toggle dynamic mode";
      base.m_name = "MyDynamicDisplayApp_ToggleDynamicDisplayCmd";   

      try
      {
        string bitmapResourceName = GetType().Name + ".bmp";
        base.m_bitmap = new Bitmap(GetType(), bitmapResourceName);
      }
      catch (Exception ex)
      {
        System.Diagnostics.Trace.WriteLine(ex.Message, "Invalid Bitmap");
      }
    }

    #region Overriden Class Methods

    /// <summary>
    /// Occurs when this command is created
    /// </summary>
    /// <param name="hook">Instance of the application</param>
    public override void OnCreate(object hook)
    {
      if (hook == null)
        return;

      if (m_hookHelper == null)
        m_hookHelper = new HookHelperClass();

      m_hookHelper.Hook = hook;
    }

    /// <summary>
    /// Occurs when this command is clicked
    /// </summary>
    public override void OnClick()
    {
      m_dynamicMap = m_hookHelper.FocusMap as IDynamicMap;
      if (m_dynamicMap == null)
        return;

      m_dynamicMap.DynamicDrawRate = 15;
      m_dynamicMap.DynamicMapEnabled = !m_dynamicMap.DynamicMapEnabled;
    }

    public override bool Checked
    {
      get
      {
        if (m_dynamicMap == null)
          return false;

        return m_dynamicMap.DynamicMapEnabled;
      }
    }

    #endregion
  }
}

[Visual Basic .NET]

ToggleDynamicDisplayCmd.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Drawing
Imports System.Runtime.InteropServices
Imports ESRI.ArcGIS.ADF.BaseClasses
Imports ESRI.ArcGIS.ADF.CATIDs
Imports ESRI.ArcGIS.Controls
Imports ESRI.ArcGIS.Carto

  ''' <summary>
  ''' Summary description for ToggleDynamicDisplayCmd.
  ''' </summary>
  <Guid("290c4325-84b9-49fd-9436-b27c4a4f1de5"), ClassInterface(ClassInterfaceType.None), ProgId("ToggleDynamicDisplayCmd")> _
  Public NotInheritable Class ToggleDynamicDisplayCmd : Inherits BaseCommand
	#Region "COM Registration Function(s)"
	<ComRegisterFunction(), ComVisible(False)> _
	Private Shared Sub RegisterFunction(ByVal registerType As Type)
	  ' Required for ArcGIS Component Category Registrar support
	  ArcGISCategoryRegistration(registerType)

	  '
	  ' TODO: Add any COM registration code here
	  '
	End Sub

	<ComUnregisterFunction(), ComVisible(False)> _
	Private Shared Sub UnregisterFunction(ByVal registerType As Type)
	  ' Required for ArcGIS Component Category Registrar support
	  ArcGISCategoryUnregistration(registerType)

	  '
	  ' TODO: Add any COM unregistration code here
	  '
	End Sub

	#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 Shared Sub ArcGISCategoryRegistration(ByVal registerType As Type)
	  Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
	  ControlsCommands.Register(regKey)

	End Sub
	''' <summary>
	''' Required method for ArcGIS Component Category unregistration -
	''' Do not modify the contents of this method with the code editor.
	''' </summary>
	Private Shared Sub ArcGISCategoryUnregistration(ByVal registerType As Type)
	  Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
	  ControlsCommands.Unregister(regKey)

	End Sub

	#End Region
	#End Region

	Private m_hookHelper As IHookHelper
	Private m_dynamicMap As IDynamicMap

	Public Sub New()
	  MyBase.m_category = "Toggle dynamic display"
	  MyBase.m_caption = "Toggle dynamic mode"
	  MyBase.m_message = "Toggle dynamic mode on and off"
	  MyBase.m_toolTip = "Toggle dynamic mode"
	  MyBase.m_name = "ToggleDynamicDisplayCmd"

	  Try
			Dim bitmapResourceName As String = Me.GetType().Name & ".bmp"
			MyBase.m_bitmap = New Bitmap(Me.GetType(), bitmapResourceName)
	  Catch ex As Exception
			System.Diagnostics.Trace.WriteLine(ex.Message, "Invalid Bitmap")
	  End Try
	End Sub

#Region "Overridden Class Methods"

	''' <summary>
	''' Occurs when this command is created
	''' </summary>
	''' <param name="hook">Instance of the application</param>
	Public Overrides Sub OnCreate(ByVal hook As Object)
	  If hook Is Nothing Then
			Return
	  End If

	  If m_hookHelper Is Nothing Then
			m_hookHelper = New HookHelperClass()
	  End If

	  m_hookHelper.Hook = hook
	End Sub

	''' <summary>
	''' Occurs when this command is clicked
	''' </summary>
	Public Overrides Sub OnClick()
	  m_dynamicMap = TryCast(m_hookHelper.FocusMap, IDynamicMap)
	  If m_dynamicMap Is Nothing Then
			Return
	  End If

	  m_dynamicMap.DynamicDrawRate = 15
	  m_dynamicMap.DynamicMapEnabled = Not m_dynamicMap.DynamicMapEnabled
	End Sub

	Public Overrides ReadOnly Property Checked() As Boolean
	  Get
		If m_dynamicMap Is Nothing Then
		  Return False
		End If

		Return m_dynamicMap.DynamicMapEnabled
	  End Get
	End Property

	#End Region
  End Class