ShowDynamicLogoCmd.cs
Dynamic logo layer
ShowDynamicLogoCmd.cs
// Copyright 2006 ESRI
// 
// All rights reserved under the copyright laws of the United States
// and applicable international laws, treaties, and conventions.
// 
// You may freely redistribute and use this sample code, with or
// without modification, provided you include the original copyright
// notice and use restrictions.
// 
// See the use restrictions.
// 

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;
using ESRI.ArcGIS.Geometry;

namespace DynamicLogoLayer
{
  /// <summary>
  /// Command that works in ArcMap/Map/PageLayout
  /// </summary>
  [Guid("5fc02e6a-c40d-4865-ab78-607cfd2cbb8e")]
  [ClassInterface(ClassInterfaceType.None)]
  [ProgId("DynamicLogoLayer.ShowDynamicLogoCmd")]
  public sealed class ShowDynamicLogoCmd : 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);
      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;
    private DynamicLogoLayerClass m_dynamicLayer = null;
    private bool m_bIsConnected = false;

    public ShowDynamicLogoCmd()
    {
      base.m_category = ".NET Samples";
      base.m_caption = "Show LogoLayer";
      base.m_message = "Show or hide the dynamic logo";
      base.m_toolTip = "Show or hide the dynamic logo";
      base.m_name = "DynamicLogoLayer_ShowDynamicLogoCmd";   

      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;

      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 command is clicked
    /// </summary>
    public override void OnClick()
    {
        try
        {
            //get the dynamic mode
            IDynamicMap dynamicMap = m_hookHelper.FocusMap as IDynamicMap;
            //make sure that the current Map supports the DynamicDisplay
            if (null == dynamicMap)
                return;

            if (!m_bIsConnected)
            {
              //initialize the dynamic layer
              m_dynamicLayer = new DynamicLogoLayerClass();
              m_dynamicLayer.Name = "Dynamic Logo Layer";

              //add the dynamic layer to the map
              m_hookHelper.FocusMap.AddLayer(m_dynamicLayer);
                
            }
            else
            {
                //delete the layer from the map
                m_hookHelper.FocusMap.DeleteLayer(m_dynamicLayer);
                m_dynamicLayer.Dispose();
                m_dynamicLayer = null;
            }

            //set the connected flag
            m_bIsConnected = !m_bIsConnected;
        }
        catch (Exception ex)
        {
            System.Diagnostics.Trace.WriteLine(ex.Message);
        }
    }

    /// <summary>
    /// set the state of the button of the command
    /// </summary>
    public override bool Checked
    {
      get
      {
        return m_bIsConnected;
      }
    }

    #endregion
  }
}