サポート

FAQ
アドインを使用したエディターエクステンションの構築

ナレッジ番号：2615 | 登録日：2023/05/29 | 更新日：2024/11/21

サマリ

このウォークスルーでは新規のフィーチャ、または編集したフィーチャの有効性を確認するエディターエクステンションの構築方法を説明します。このエクステンションは、編集セッションの間に OnChangeFeature や OnCreateFeature の編集イベントを受信して実現します。このトピックではアドインをどのようにインストールするか、ArcMapでカスタムエディターエクステンションをどのようにテストするかについても説明しています。

このウォークスルーで説明されているカスタムエディターエクステンションは簡単なカスタマイズです。その他の可能なカスタマイズついての詳しい説明はエディターエクステンションのトピックをご参照ください。

このウォークスルーに関連するサンプルを取得するにはここをクリックしてください。

エディターエクステンション

エディターエクステンションを使用すると ArcMap における編集環境をさらにカスタマイズできます。アドインを使用してカスタムエディターエクステンションを作成することができます。エディターエクステンションについての理解がまだ十分でない場合は、エディターエクステンションのトピックをご参照ください。

Visual Studio プロジェクトの作成

Visual Studio プロジェクトを作成するには、以下のステップを実行します。

Visual Studio を起動します。
ファイルメニューをクリックし、[新規作成] → [プロジェクト] をクリックします。新規のプロジェクトダイアログボックスが開きます。
[インストール済み] から、[Visual Basic] または [Visual C#] プロジェクトノードを開き、そして [ArcGIS] ノードを開いて [Desktop Add-Ins] をクリックします。
ArcMap Add-in テンプレートをテンプレートペインから選択します。アドインによるカスタマイズは ArcGIS Desktop アプリケ－ションに固有のものであり、ArcCatalog、ArcScene そして ArcGlobe に対しても作成できます。
"AddInEditorExtension" と名前を付けて、プロジェクトを保存したい場所を指定します。
[OK] をクリックして、ArcGIS Add-Ins Wizard を開きます。

Desktop Add-Ins ノードに関連するテンプレートがテンプレートペインに表示されていない場合、新規プロジェクトダイアログボックスのドロップダウンメニューにおいてターゲットとなる .NET フレームワークが 4.5 に設定されていることを確認します。

ArcGIS Add-Ins Wizard の使用

ArcGIS Add-In Wizard はユーザーの入力内容に基づいて、アドインに必要な適切な拡張マークアップ言語（XML）エレメントとマネージクラスを作成します。アドインに含めるカスタマイズ内容を定義するには、以下のステップを実行します。

Welcome ページで、名前、会社／発行者、説明そして画像などのアドインに関する基本的な情報を入力します。Welcome ページで、アドインについて与えたメタデータ情報は、アドインマネージャダイアログボックスに表示されます。適当なヘルプアイコンの上にマウスを停止させると、ダイアログボックスの各入力事項についてのヘルプチップが表示されます。

以下のスクリーンショットのように、情報を入力してください。
[Next] をクリックします。利用可能なアドインコンポーネントページが開きます。左側の [Add-in Types] セクションではアドインに追加可能なカスタマイズの型がリスト表示されています。
[Add-In Types] の下で、[Editor Extension] チェックボックスを選択し、クラス名として "ValidateFeaturesExtension" と入力します。ValidateFeaturesExtension クラスは、エディターエクステンションの実行時の振舞いを実装したマネージクラスで、ウィザードによって適切なテンプレートコードと共に作成されます。
[Finish] をクリックします。アドインプロジェクトが作成されます。以下のスクリーンショットは、ウィザードによって作成されたファイルをソリューションエクスプローラーで表示しています。

XML ファイルは "Config.esriaddinx" と名前が付けられています。プロジェクトをビルドして、アドインをインストールした後には config.xml と名前が変わります。

XML についての理解

このセクションの数字はステップではなく、参照しているスクリーンショットの中の数字に対応します。

ArcGIS Add-In Wizard の Welcome ページで与えた基本的なアドイン情報（名前、会社/発行者、説明、イメージ）は XML に含まれます。
Target タグはアドインがインストールされる先の ArcGIS 製品とバージョンを指定することができます。現在、アドインは ArcGIS Desktop のみでサポートされています。
ArcMap 要素は、カスタムエディターエクステンションが ArcMap アプリケーションのみにインストールされなければならないことを示しています。ArcCatalog、ArcScene そして ArcGlobe に対しても（ボタンやツールのような）アドインコンポーネントを作成することができますが、カスタムエディターエクステンションは ArcMap アプリケーションにのみ適用可能です。
Extension タグの class 属性は、エディターエクステンションの実行時の振舞いを与える C# または VB .NET マネージクラスを示します。id 属性はエクステンション固有の ProgID を示します。

アドイン内では複数のエディターエクステンションを作成できます。

実行時の振舞いの実装

ウィザードがテンプレートコードを作成すると、以下の内容が確認できます。

ValidateFeatureExtension クラスは ESRI.ArcGIS.Desktop.AddIns.Extension クラスを継承している。
テンプレートコードを確認すると、編集イベントとどのようにつなげるのかが理解できる。ArcMap のような静的クラスは config.Designer.cs で事前に定義されている。静的な ArcMap クラスにはいくつかの静的メンバがある。Application、document、editor、events などで、これらは実行時の振舞いを実装するために使用可能。以下のスクリーンショットは ArcMap クラスとその静的メンバを示します。

以下のコード例は、実行時の振舞いの実装を示しています。ArcMap で編集セッションを開始すると、カスタムエディターエクステンションが読み込まれ、ArcMap は OnStartup イベントを発行します。OnStart() メソッドの中で OnStartEditing とOnStopEditing の編集イベントを関連付けします。OnStartEditing イベントは編集セッションが開始された時に発行され、OnStopEditing イベントは編集セッションが終了した時に発行されます。OnStartEditing イベントの実装によって、フィーチャが作成されるかまたは変更された時に発行される OnChangeFeature と OnCreateFeature の編集イベントを関連付けします。OnChangeFeature とOnCreateFeature のイベントハンドラの実装で、作成または変更されたフィーチャの有効性を検証します。

[C#] 
//エディター エクテンションが読み込まれた時に呼ばれる
protected override void OnStartup()
{
    Events.OnStartEditing += new IEditEvents_OnStartEditingEventHandler
        (Events_OnStartEditing);
    Events.OnStopEditing += new IEditEvents_OnStopEditingEventHandler
        (Events_OnStopEditing);
}

//編集セッションが開始した時に呼ばれる
void Events_OnStartEditing()
{
   //シェープファイルやカバレッジなどのフィーチャは有効性の検証が行われないので、
   //それらのデータに対してはイベントの記述はしない 
    if (ArcMap.Editor.EditWorkspace.Type !=
        esriWorkspaceType.esriFileSystemWorkspace)
    {
        //OnCreateFeature 編集イベントと関連付ける
        Events.OnCreateFeature += new IEditEvents_OnCreateFeatureEventHandler
            (Events_OnCreateChangeFeature);
        //onChangeFeature 編集イベントと関連付ける
        Events.OnChangeFeature += new IEditEvents_OnChangeFeatureEventHandler
            (Events_OnCreateChangeFeature);
    }
}

//編集セッションが終了する時に呼ばれる (エディター->編集の終了)
void Events_OnStopEditing(bool Save)
{
   //シェープファイルやカバレッジなどのフィーチャは有効性の検証が行われないので、
   //それらのデータに対してはイベントの記述はしない 
    if (ArcMap.Editor.EditWorkspace.Type !=
        esriWorkspaceType.esriFileSystemWorkspace)
    {
        //OnCreateFeature 編集イベントとの関連を削除する
        Events.OnCreateFeature -= new IEditEvents_OnCreateFeatureEventHandler
            (Events_OnCreateChangeFeature);
        //onChangeFeature 編集イベントとの関連を削除する
        Events.OnChangeFeature -= new IEditEvents_OnChangeFeatureEventHandler
            (Events_OnCreateChangeFeature);
    }
}

//フィーチャが作成される、または変更される時に呼ばれる
void Events_OnCreateChangeFeature(ESRI.ArcGIS.Geodatabase.IObject obj)
{
    IFeature inFeature = (IFeature)obj;
    if (inFeature.Class is IValidation)
    {
        IValidate validate = (IValidate)inFeature;
        string errorMessage;
        //接続ルール、リレーションシップ ルール、トポロジ ルールなどを検証する
        bool bIsvalid = validate.Validate(out errorMessage);
        //検証結果をレポートする
        if (!bIsvalid)
        {
            System.Windows.Forms.MessageBox.Show("Invalid Feature\n\n" +
                errorMessage);
        }
        else
        {
            System.Windows.Forms.MessageBox.Show("Valid Feature");
        }
    }
}

[VB.NET] 
'エディター エクテンションが読み込まれた時に呼ばれる
Protected Overrides Sub OnStartup()
AddHandler Events.OnStartEditing, AddressOf Events_OnStartEditing
AddHandler Events.OnStopEditing, AddressOf Events_OnStopEditing
End Sub

'編集セッションが開始した時に呼ばれる

Private Sub Events_OnStartEditing()
   'シェープファイルやカバレッジなどのフィーチャは有効性の検証が行われないので、
   'それらのデータに対してはイベントの記述はしない 
    If ArcMap.Editor.EditWorkspace.Type <> esriWorkspaceType.esriFileSystemWorkspace Then
        'OnCreateFeature 編集イベントと関連付ける
        AddHandler Events.OnCreateFeature, AddressOf Events_OnCreateChangeFeature
        'onChangeFeature 編集イベントと関連付ける
        AddHandler Events.OnChangeFeature, AddressOf Events_OnCreateChangeFeature
    End If
End Sub

'編集セッションが終了する時に呼ばれる

Private Sub Events_OnStopEditing(ByVal Save As Boolean)
   'シェープファイルやカバレッジなどのフィーチャは有効性の検証が行われないので、
   'それらのデータに対してはイベントの記述はしない 
    If ArcMap.Editor.EditWorkspace.Type <> esriWorkspaceType.esriFileSystemWorkspace Then
        'OnCreateFeature 編集イベントとの関連を削除する
        RemoveHandler Events.OnCreateFeature, AddressOf Events_OnCreateChangeFeature
        'onChangeFeature  編集イベントとの関連を削除する
        RemoveHandler Events.OnChangeFeature, AddressOf Events_OnCreateChangeFeature
    End If
End Sub

'フィーチャが作成される、または変更される時に呼ばれる

Private Sub Events_OnCreateChangeFeature(ByVal obj As ESRI.ArcGIS.Geodatabase.IObject)
    Dim inFeature As IFeature = CType(obj, IFeature)
    If TypeOf inFeature.Class Is IValidation Then
        Dim validate As IValidate = CType(inFeature, IValidate)
        Dim errorMessage As String
        Dim bIsvalid As Boolean = validate.Validate(errorMessage)
        If (Not bIsvalid) Then
            System.Windows.Forms.MessageBox.Show("Invalid Feature" & Constants.vbLf + Constants.vbLf & errorMessage)
        Else
            System.Windows.Forms.MessageBox.Show("Valid Feature")
        End If
    End If
End Sub

アドインのインストール

アドインをインストールするには以下のステップを行います。

プロジェクトを保存します。
Visual Studio で [ビルド] メニューをクリックし、[ソリューションのビルド] をクリックします。
Visual Studio .NET 統合開発環境の出力ウィンドウを表示します。プロジェクトが正しくビルドされると、ビルドが成功したことが出力ウィンドウに表示されます。そしてアドインは現在のユーザの場所にインストールされます。

エディターエクステンションのテスト

カスタムエディターエクステンションをテストするには、以下のステップを実行します。

ArcMap を起動してマップドキュメントを開きます。接続ルール、リレーションシップルール、トポロジルールを有しているデータを追加します。
[カスタマイズ] メニューから [アドインマネージャ] をクリックします。アドインマネージャダイアログボックスが開きます。アドインマネージャダイアログボックスは現在アプリケーションにインストールされているアドインを一覧表示します。名前、イメージ、説明などのアドイン情報がアドインマネージャダイアログボックスにリスト表示されます。
[閉じる] をクリックします。
[カスタマイズ] メニューから [ツールバー] をクリックし、そして [エディター] をクリックします。
編集ツールバーをドッキングしてから、[エディター] メニューをクリックし、[編集の開始] をクリックします。
フィーチャデータを選択し、移動します。これにより、OnChangeFeature イベントが起きて、フィーチャは新しい場所に対する有効性が検証されます。以下のスクリーンショットで示されているように、メッセージボックスが検証結果を表示します。

アドインのアンインストール

作成したアドインをアンインストールするには、以下のステップを実行します。

ArcMapで [カスタマイズ] メニューから [アドインマネージャ] をクリックします。アドインマネージャダイアログボックスが開きます。
AddInEditorExtension を選択して、[アドインの削除] をクリックします。対象となるアドインファイルは、インストールされていたユーザの場所から削除されます。

参照：

エディターエクステンション

開発ライセンス	配布ライセンス
ArcGIS Desktop Basic	ArcGIS Desktop Basic
ArcGIS Desktop Standard	ArcGIS Desktop Standard
ArcGIS Desktop Adanced	ArcGIS Desktop Adanced

この文書は、ArcObjects Help for .NET Developers 内のトピック Walkthrough: Building editor extensions using add-ins を元に翻訳したものです。

メタデータ

種類

サンプルコード

製品

バージョン

このナレッジはお役に立ちましたか？

役に立った
役に立たなかった

サポート

FAQ アドインを使用したエディター エクステンションの構築

サマリ

内容

Visual Studio プロジェクトを作成するには、以下のステップを実行します。

参照：

メタデータ

種類

製品

バージョン

FAQ
アドインを使用したエディターエクステンションの構築