About the Save a layer file in a MapControl application Sample
[C#]
RemoveLayerCmd.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 MapControlSaveLayerFile
{
/// <summary>
/// Summary description for RemoveLayerCmd.
/// </summary>
[Guid("d848a775-dc85-4ee3-88a6-a780572139a2")]
[ClassInterface(ClassInterfaceType.None)]
[ProgId("MapControlSaveLayerFile.RemoveLayerCmd")]
public sealed class RemoveLayerCmd : 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;
public RemoveLayerCmd()
{
base.m_category = ".NET Samples";
base.m_caption = "Remove Layer";
base.m_message = "Remove Layer";
base.m_toolTip = "Remove Layer";
base.m_name = "MapControlSaveLayerFile_RemoveLayerCmd";
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");
}
}
#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;
// TODO: Add other initialization code
}
/// <summary>
/// Occurs when this command is clicked
/// </summary>
public override void OnClick()
{
//need to get the layer from the custom-property of the map
if (null == m_hookHelper)
return;
//get the mapControl hook
object hook = null;
if (m_hookHelper.Hook is IToolbarControl2)
{
hook = ((IToolbarControl2)m_hookHelper.Hook).Buddy;
}
else
{
hook = m_hookHelper.Hook;
}
//get the custom property from which is supposed to be the layer to be saved
object customProperty = null;
IMapControl3 mapControl = null;
if (hook is IMapControl3)
{
mapControl = (IMapControl3)hook;
customProperty = mapControl.CustomProperty;
}
else
return;
if (null == customProperty || !(customProperty is ILayer))
return;
m_hookHelper.FocusMap.DeleteLayer((ILayer)customProperty);
}
#endregion
}
}
[Visual Basic .NET]
RemoveLayerCmd.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 RemoveLayerCmd.
''' </summary>
<Guid("d848a775-dc85-4ee3-88a6-a780572139a2"), ClassInterface(ClassInterfaceType.None), ProgId("MapControlSaveLayerFile.RemoveLayerCmd")> _
Public NotInheritable Class RemoveLayerCmd : 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
Public Sub New()
MyBase.m_category = ".NET Samples"
MyBase.m_caption = "Remove Layer"
MyBase.m_message = "Remove Layer"
MyBase.m_toolTip = "Remove Layer"
MyBase.m_name = "MapControlSaveLayerFile_RemoveLayerCmd"
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
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
' TODO: Add other initialization code
End Sub
''' <summary>
''' Occurs when this command is clicked
''' </summary>
Public Overrides Sub OnClick()
'need to get the layer from the custom-property of the map
If Nothing Is m_hookHelper Then
Return
End If
'get the mapControl hook
Dim hook As Object = Nothing
If TypeOf m_hookHelper.Hook Is IToolbarControl2 Then
hook = (CType(m_hookHelper.Hook, IToolbarControl2)).Buddy
Else
hook = m_hookHelper.Hook
End If
'get the custom property from which is supposed to be the layer to be saved
Dim customProperty As Object = Nothing
Dim mapControl As IMapControl3 = Nothing
If TypeOf hook Is IMapControl3 Then
mapControl = CType(hook, IMapControl3)
customProperty = mapControl.CustomProperty
Else
Return
End If
If Nothing Is customProperty OrElse Not (TypeOf customProperty Is ILayer) Then
Return
End If
m_hookHelper.FocusMap.DeleteLayer(CType(customProperty, ILayer))
End Sub
#End Region
End Class