About the Save a layer file in a MapControl application Sample
[C#]
SaveLayerFileCmd.cs
using System;
using System.Drawing;
using System.Windows.Forms;
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>
/// This command demonstrates saving of a layer file in an ArcGIS Engine application
/// </summary>
[Guid("294563e7-b475-43db-a2d1-a6b5f95c7113")]
[ClassInterface(ClassInterfaceType.None)]
[ProgId("MapControlSaveLayerFile.SaveLayerFileCmd")]
public sealed class SaveLayerFileCmd : 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;
public SaveLayerFileCmd()
{
base.m_category = ".NET Samples";
base.m_caption = "Create Layer File";
base.m_message = "Save the current layer as a layer file";
base.m_toolTip = "Create As Layer File";
base.m_name = "MapControlSaveLayerFile_SaveLayerFileCmd";
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()
{
//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;
//ask the user to set a name for the new layer file
SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.Filter = "Layer File|*.lyr|All Files|*.*";
saveFileDialog.Title = "Create Layer File";
saveFileDialog.RestoreDirectory = true;
saveFileDialog.FileName = System.IO.Path.Combine(saveFileDialog.InitialDirectory, ((ILayer)customProperty).Name + ".lyr");
//get the layer name from the user
DialogResult dr = saveFileDialog.ShowDialog();
if (saveFileDialog.FileName != "" && dr == DialogResult.OK)
{
if (System.IO.File.Exists(saveFileDialog.FileName))
{
//try to delete the existing file
System.IO.File.Delete(saveFileDialog.FileName);
}
//create a new LayerFile instance
ILayerFile layerFile = new LayerFileClass();
//create a new layer file
layerFile.New(saveFileDialog.FileName);
//attach the layer file with the actual layer
layerFile.ReplaceContents((ILayer)customProperty);
//save the layer file
layerFile.Save();
//ask the user whether he'd like to add the layer to the map
if (DialogResult.Yes == MessageBox.Show("Would you like to add the layer to the map?", "Message", MessageBoxButtons.YesNo, MessageBoxIcon.Question))
{
mapControl.AddLayerFromFile(saveFileDialog.FileName, 0);
}
}
}
#endregion
}
}
[Visual Basic .NET]
SaveLayerFileCmd.vb
Imports Microsoft.VisualBasic
Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports System.Runtime.InteropServices
Imports ESRI.ArcGIS.ADF.BaseClasses
Imports ESRI.ArcGIS.ADF.CATIDs
Imports ESRI.ArcGIS.Controls
Imports ESRI.ArcGIS.Carto
''' <summary>
''' This command demonstrates saving of a layer file in an ArcGIS Engine application
''' </summary>
<Guid("294563e7-b475-43db-a2d1-a6b5f95c7113"), ClassInterface(ClassInterfaceType.None), ProgId("MapControlSaveLayerFile.SaveLayerFileCmd")> _
Public NotInheritable Class SaveLayerFileCmd : 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
Public Sub New()
MyBase.m_category = ".NET Samples"
MyBase.m_caption = "Create Layer File"
MyBase.m_message = "Save the current layer as a layer file"
MyBase.m_toolTip = "Create As Layer File"
MyBase.m_name = "MapControlSaveLayerFile_SaveLayerFileCmd"
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
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()
'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
'ask the user to set a name for the new layer file
Dim saveFileDialog As SaveFileDialog = New SaveFileDialog()
saveFileDialog.Filter = "Layer File|*.lyr|All Files|*.*"
saveFileDialog.Title = "Create Layer File"
saveFileDialog.RestoreDirectory = True
saveFileDialog.FileName = System.IO.Path.Combine(saveFileDialog.InitialDirectory, (CType(customProperty, ILayer)).Name & ".lyr")
'get the layer name from the user
Dim dr As DialogResult = saveFileDialog.ShowDialog()
If saveFileDialog.FileName <> "" AndAlso dr = System.Windows.Forms.DialogResult.OK Then
If System.IO.File.Exists(saveFileDialog.FileName) Then
'try to delete the existing file
System.IO.File.Delete(saveFileDialog.FileName)
End If
'create a new LayerFile instance
Dim layerFile As ILayerFile = New LayerFileClass()
'create a new layer file
layerFile.New(saveFileDialog.FileName)
'attach the layer file with the actual layer
layerFile.ReplaceContents(CType(customProperty, ILayer))
'save the layer file
layerFile.Save()
'ask the user whether he'd like to add the layer to the map
If DialogResult.Yes = MessageBox.Show("Would you like to add the layer to the map?", "Message", MessageBoxButtons.YesNo, MessageBoxIcon.Question) Then
mapControl.AddLayerFromFile(saveFileDialog.FileName, 0)
End If
End If
End Sub
#End Region
End Class