' 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.
' 

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

  ''' <summary>
  ''' Command that works in ArcMap/Map/PageLayout
  ''' </summary>
<Guid("5fc02e6a-c40d-4865-ab78-607cfd2cbb8e"), ClassInterface(ClassInterfaceType.None), ProgId("DynamicLogoLayer.ShowDynamicLogoCmd")> _
Public NotInheritable Class ShowDynamicLogoCmd
  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)
    MxCommands.Register(regKey)
    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)
    MxCommands.Unregister(regKey)
    ControlsCommands.Unregister(regKey)
  End Sub

#End Region
#End Region

  Private m_hookHelper As IHookHelper = Nothing
  Private m_dynamicLayer As DynamicLogoLayerClass = Nothing
  Private m_bIsConnected As Boolean = False
  Private m_bOnce As Boolean = True

  Public Sub New()
    MyBase.m_category = ".NET Samples"
    MyBase.m_caption = "Show LogoLayer"
    MyBase.m_message = "Show or hide the dynamic logo"
    MyBase.m_toolTip = "Show or hide the dynamic logo"
    MyBase.m_name = "DynamicLogoLayer_ShowDynamicLogoCmd"

    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 "Overriden 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

    Try
      m_hookHelper = New HookHelperClass()
      m_hookHelper.Hook = hook
      If m_hookHelper.ActiveView Is Nothing Then
        m_hookHelper = Nothing
      End If
    Catch
      m_hookHelper = Nothing
    End Try

    If m_hookHelper Is Nothing Then
      MyBase.m_enabled = False
    Else
      MyBase.m_enabled = True
    End If
  End Sub

  ''' <summary>
  ''' Occurs when this command is clicked
  ''' </summary>
  Public Overrides Sub OnClick()
    'get the dynamic mode
    Dim dynamicMap As IDynamicMap = TryCast(m_hookHelper.FocusMap, IDynamicMap)
    'make sure that the current Map supports the DynamicDisplay
    If Nothing Is dynamicMap Then
      Return
    End If

    If (Not m_bIsConnected) Then
      'do some initializations...
      If m_bOnce Then
        'initialize the dynamic layer
        m_dynamicLayer = New DynamicLogoLayerClass()
        m_dynamicLayer.Name = "Dynamic Logo Layer"

        m_bOnce = False
      End If

      'make sure that the layer did not get added to the map        
      Dim bLayerHasBeenAdded As Boolean = False
      If m_hookHelper.FocusMap.LayerCount > 0 Then
        Dim layers As IEnumLayer = m_hookHelper.FocusMap.Layers(Nothing, False)
        layers.Reset()
        Dim layer As ILayer = layers.Next()
        Do While Not layer Is Nothing
          If TypeOf layer Is DynamicLogoLayerClass Then
            bLayerHasBeenAdded = True
            Exit Do
          End If
          layer = layers.Next()
        Loop
      End If

      If (Not bLayerHasBeenAdded) Then
        'add the dynamic layer to the map
        m_hookHelper.FocusMap.AddLayer(m_dynamicLayer)
      End If
    Else
      'delete the layer from the map
      m_hookHelper.FocusMap.DeleteLayer(m_dynamicLayer)
    End If

    'set the connected flag
    m_bIsConnected = Not m_bIsConnected
  End Sub

  ''' <summary>
  ''' set the state of the button of the command
  ''' </summary>
  Public Overrides ReadOnly Property Checked() As Boolean
    Get
      Return m_bIsConnected
    End Get
  End Property

#End Region
End Class