ArcGIS Addin开发随手笔记

  Add-in是ArcGIS 10.0更新后ESRI主推的ArcGIS Desktop产品插件开发方式。Add-in给开发者提供了一个简易的开发框架，使得开发者可以十分方便地自定义插件并全部包装到单一dll中。由于Addin插件不需要通过安装包安装，而且也不要注册COM组件，开发者和用户可以非常自由的共享插件。仅仅通过在特定文件夹中加入或移除相关的dll即可完成对应的插件安装和卸载。机构用户甚至可以通过局域网统一安装插件。

  基于上述原因，Addin迅速成为ArcGIS插件开发的主流，ESRI论坛的ArcObject SDK板块首页近一半都是的Addin求助和讨论帖。当然ArcObject的惯例依然是产品强大复杂，但除了资料较少且非常分散，而且插件在调试时报错是居然不包含任何有效信息，开发新功能或遇到错误都会花费不少时间去各处找答案。现在正在写一个栅格数据编辑工具条，正好把其中一些值得注意的的地方和错误分享出来，随时更新。

 

1. ComboBox的GetItem（）方法和Items[]属性

  注意ComboBox.Add()方法返回的整数结果叫cookie，而GetItem（）方法传入的参数也是这个cookie。和一般的index不同，这个cookie不是一般从0开始的索引，也不会加1递增，可能是某个更大集合的索引数或内存索引。而Items[]使用的索引是一般的集合index，从0开始，加1递增。两者并不相同。

 

2. COM组件错误

  错误信息： Error HRESULT E_FAIL has been returned from a call to a COM component。该错误很可能是由于某个传入参数错误导致。

 

3. COM组件未注册

  COM组件未注册的错误（代码80040154、80040111之类）会以一定几率发生，提前注册license可以解决。

ESRI.ArcGIS.RuntimeManager.BindLicense(ESRI.ArcGIS.ProductCode.EngineOrDesktop);

 

4. 获取同一插件中的其他控件

  如果插件中的不同控件需要互动，可用ESRI.ArcGIS.Desktop.AddIns.AddIn.FromID<ControlClass>(ID)来获取。ControlClass是需要调用的控件类名，控件ID保存在Config.addinx，可以用ThisAddIn.IDs来调用。

using ESRI.ArcGIS.Desktop.AddIns;

// While editing, the active layer cannot be changed
LayerComboBox layerComboBox = AddIn.FromID<LayerComboBox>(ThisAddIn.IDs.LayerComboBox);
layerComboBox.IsEnabled = false;

 

5. 获取DockableWindow

  实际上ArcGIS向导创建的是一个自定义UserControl控件，在加载时再把这个控件放在ArcMap生成的窗体上。因此调用该控件与一般控件稍有不同，需要在系统自动创建的AddinImpl类（即窗体本身）中自行添加属性将自定义控件暴露出来：

// this property is to provide access to the IdentifyForm （The UserControl Class）
internal EditForm UI
{
    get { return m_windowUI; }
}

  然后就可以用与获取一般控件一样的方法来获取DockableWindow上的控件：

IdentifyForm identifyForm = AddIn.FromID<IdentifyForm.AddinImpl>(ThisAddIn.IDs.RasterEditor_Form_IdentifyForm).UI;
identifyForm.SetValues(tlCorner, brCorner, values);

  如果需要对窗体本身而不是上面的控件进行操作（显示/隐藏），则需要调用ArcMap.DockableWindowManager.GetDockableWindwo()方法：

UID dockWinID = new UIDClass();
dockWinID.Value = ThisAddIn.IDs.RasterEditor_Form_IdentifyForm;

// Use GetDockableWindow directly as we want the client IDockableWindow not the internal class
IDockableWindow dockWindow = ArcMap.DockableWindowManager.GetDockableWindow(dockWinID);

if (!dockWindow.IsVisible())
    dockWindow.Show(true);

 

随时补充。。。