ArcObjects Library Reference  

TAUpdateControlCommand

About the Using the ITAControlUpdate interface Sample

[C#]

TAUpdateControlCommand.cs

using System;
using System.Drawing;
using System.Runtime.InteropServices;
using ESRI.ArcGIS.ADF.BaseClasses;
using ESRI.ArcGIS.ADF.CATIDs;
using ESRI.ArcGIS.Controls;

namespace TAUpdateControlSample
{
	/// <summary>
	/// Command that works in ArcMap/Map/PageLayout
	/// </summary>
	[Guid("943e3b92-a090-485f-9a5d-2d0dddc35409")]
	[ClassInterface(ClassInterfaceType.None)]
	[ProgId("TAUpdateControlSample.TAUpdateControlCommand")]
	public sealed class TAUpdateControlCommand : 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 TAUpdateControlForm m_TAUpdateControlForm = null;
		private IHookHelper m_hookHelper = null;
		public TAUpdateControlCommand()
		{
			//
			// TODO: Define values for the public properties
			//
			base.m_category = ".NET Samples"; //localizable text
			base.m_caption = "Demonstrates the use of the TAUpdateControl.";  //localizable text 
			base.m_message = "Demonstrates the use of the TAUpdateControl.";  //localizable text
			base.m_toolTip = "Demonstrates the use of the TAUpdateControl.";  //localizable text
			base.m_name = "TAUpdateControlSample_TAUpdateControlCommand";   //unique id, non-localizable (e.g. "MyCategory_MyCommand")

			try
			{
				//
				// TODO: change bitmap name if necessary
				//
				string bitmapResourceName = GetType().Name + ".bmp";
				base.m_bitmap = new Bitmap(GetType(), bitmapResourceName);
			}
			catch (Exception ex)
			{
				System.Diagnostics.Trace.WriteLine(ex.Message, "Invalid Bitmap");
			}

			m_TAUpdateControlForm = new TAUpdateControlForm();
		}

		#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;

			// TODO:  Add other initialization code
		}

		/// <summary>
		/// Occurs when this command is clicked
		/// </summary>
		public override void OnClick()
		{
			if (!m_TAUpdateControlForm.Visible)
			{
				m_TAUpdateControlForm.Show();
				m_TAUpdateControlForm.PopulateDialog();
			}
			else
			{
				m_TAUpdateControlForm.Hide();
			}
		}

		public override bool Checked
		{
			get
			{
				return m_TAUpdateControlForm.Visible;
			}
		}
		#endregion
	}
}

[Visual Basic .NET]

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

Namespace TAUpdateControlSample
	''' <summary>
	''' Command that works in ArcMap/Map/PageLayout
	''' </summary>
	<Guid("943e3b92-a090-485f-9a5d-2d0dddc35409"), ClassInterface(ClassInterfaceType.None), ProgId("TAUpdateControlSample.TAUpdateControlCommand")> _
	Public NotInheritable Class TAUpdateControlCommand : 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_TAUpdateControlForm As TAUpdateControlForm = Nothing
		Private m_hookHelper As IHookHelper = Nothing
		Public Sub New()
			'
			' TODO: Define values for the public properties
			'
			MyBase.m_category = ".NET Samples" 'localizable text
			MyBase.m_caption = "Demonstrates the use of the TAUpdateControl." 'localizable text
			MyBase.m_message = "Demonstrates the use of the TAUpdateControl." 'localizable text
			MyBase.m_toolTip = "Demonstrates the use of the TAUpdateControl." 'localizable text
			MyBase.m_name = "TAUpdateControlSample_TAUpdateControlCommand" 'unique id, non-localizable (e.g. "MyCategory_MyCommand")

			Try
				'
				' TODO: change bitmap name if necessary
				'
				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

			m_TAUpdateControlForm = New TAUpdateControlForm()
		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

			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

			' TODO:  Add other initialization code
		End Sub

		''' <summary>
		''' Occurs when this command is clicked
		''' </summary>
		Public Overrides Sub OnClick()
			If (Not m_TAUpdateControlForm.Visible) Then
				m_TAUpdateControlForm.Show()
				m_TAUpdateControlForm.PopulateDialog()
			Else
				m_TAUpdateControlForm.Hide()
			End If
		End Sub

		Public Overrides ReadOnly Property Checked() As Boolean
			Get
				Return m_TAUpdateControlForm.Visible
			End Get
		End Property
		#End Region
	End Class
End Namespace