Python アドインコンボボックスの作成—ヘルプ

アドインコンボボックスの作成

アドインコンボボックスの作成

コンボボックスには、編集可能なフィールドとドロップダウンリストが含まれます。ユーザは、ユーザがリクエストしたときに表示されるドロップダウンリストから値を選択できます。コンボボックスを編集可能にすると、コンボボックスに編集可能なフィールドが含まれ、ユーザが値を入力できるようになります。コンボボックスの例として、ArcMap の [縮尺] コンボボックスがあります。既知の座標系を持つデータを ArcMap に追加するとき、[縮尺] コンボボックスが有効になり、ユーザはあらかじめ定義された縮尺のいずれかを選択できます。リストにない新しい縮尺をユーザが入力することも可能で、追加された値に基づいてマップが表示されます。

このトピックでは、Python アドインウィザードを使用して新しいツールバーにコンボボックスを作成する方法を、手順に従って説明します。このワークフローを開始する前に、ArcMap のアドインプロジェクトを作成して、プロジェクト設定を指定していることを確認してください。詳細については、「アドインプロジェクトの作成」をご参照ください。このワークフローでは ArcMap のコンボボックスを作成する方法を説明しますが、他の ArcGIS for Desktop アプリケーションでも、同じ方法でコンボボックスを追加できます。このトピックでは、コンテンツウィンドウからレイヤのリストを表示するコンボボックスを作成する処理を検証します。レイヤが選択されると、レイヤの全範囲を対象としてフィッシュネットを作成します。その後、アドインウィザードで作成された Python クラスを詳しく検証して、コンボボックスに機能を提供するプロパティとメソッドを確認します。

アドインコンボボックスを作成する処理は、以下の手順で構成されます。

ツールバーを作成します。
必要なプロジェクト設定を入力したら、[アドインのコンテンツ] タブをクリックして、アドインのカスタマイズを宣言します。コンボボックスはツールバーに配置できますが、メニューには配置できません。ツールバーを作成する手順については、「アドインツールバーの作成」をご参照ください。

コンボボックスを作成します。

ツールバーのプロパティを入力したら、新しいコンボボックスを作成できます。新しいツールバーを右クリックし、ショートカットメニューの [新規コンボボックス] を選択します。

コンボボックスには多くのプロパティを設定できます。これらのプロパティは、プロジェクトの config.xml ファイルに格納されます。以下のリストに、すべてのプロパティとその説明を示します。

プロパティ	説明
キャプション（必須）	コンボボックスのキャプションを指定します。次の図は、ArcGIS アドインマネージャに表示されたキャプションを示しています。利用可能なカスタマイズのタイプを判断するのに役立ちます（アドインのタイプが括弧内に示されています）。
クラス（必須）	Python クラスは、コンボボックスのビジネスロジックを書き込む場所です。このクラスは、コンボボックスが編集されるごと、または選択が変更されるごとに実行されるため重要です。クラスを構築するときは、Python の命名規則を使用します。Python クラスでは、各単語の先頭を大文字にする表記法が使用されます。この例では、LayersComboBox というクラスを作成します。
ID（必須）	コンボボックスを識別するための一意の名前。1 つのプロジェクトに複数のコンボボックスを作成することができるため、この ID を使用して各コンボボックスを区別します。デフォルトの ID を、意味のある値に置き換えると理想的です。ID にスペースを含めることはできません。単語を区切る場合はアンダースコアを使用してください。Python のキーワードも使用しないでください。予約語については、Python のドキュメントをご参照ください。
ツールチップ（オプション）	デスクトップアプリケーションでマウスポインタをコンボボックスの上に置いたときに表示される簡単な説明。
メッセージ（オプション）	コンボボックスの動作の詳細な説明。メッセージは、マウスポインタをコンボボックスの上に置いたときにツールチップの下に表示されます。
ヒントテキスト（オプション）	コンボボックスがデスクトップアプリケーションでアクティブでないときに、コンボボックス上に表示されるテキスト。このテキストは、ユーザがコンボボックスで選択するアイテムのタイプ、またはユーザがコンボボックスから選択する必要があるアイテムの種類を説明するために使用できます。

コンボボックスの最後のセクションは、ヘルプの見出しとコンテンツについてです。これらのプロパティでは、ユーザがポップアップヘルプを呼び出したときに使用される情報を設定できます。これらはポップアップトピックとして表示され、ユーザが別の場所をクリックするまで画面上に表示されたままになります。

ポップアップヘルプのセクションは以下のプロパティで構成されます。

プロパティ	説明
見出し（オプション）	ヘルプコンテンツの要約を示します。
コンテンツ（オプション）	コンボボックスのヘルプコンテンツ。

プロパティの入力が完了したら、ウィザードの下部にある [保存] ボタンをクリックします。これにより、必要なすべてのファイルとフォルダが作業フォルダに作成されます。

Python スクリプトを編集します。
この段階で、アドインコンボボックスの定義に必要なプロパティに対して値の追加が完了しています。このワークフローの次の手順では、Python スクリプトを編集し、ポリゴンのフィッシュネットを作成する機能を含むように Python クラスを更新します。コンボボックスには、アクティブなデータフレームのレイヤのリストが設定されます。コンボボックスでレイヤを選択すると、選択したレイヤの範囲を使用して 10 行 x 10 列のフィッシュネットが作成されます。コンボボックスに機能を追加するには、以下の手順を実行します。
1. 作業フォルダ内の Install フォルダにある、ウィザードが作成した Python スクリプトを編集します。
  ウィザードで入力した名前と同じ名前のクラスが存在します。クラス名は config.xml で参照されているため、このクラス名は変更しないでください。クラスは、「コンボボックスクラス」で説明した複数の関数とプロパティで構成されています。
2. 関数を以下に示すように更新します。
  このコードにより、コンボボックスで選択したレイヤの範囲を使用して、ポリゴンのフィッシュネットを 10 行 x 10 列のサイズで作成する機能が追加されます。
```
# Business logic to implement the ComboBox
def __init__(self):
        self.editable = True
        self.enabled = True

def onSelChange(self, selection):

	# When a new layer is selected, create a new fishnet using the extent of layer.
	layer = arcpy.mapping.ListLayers(self.mxd, selection)[0]
	desc = arcpy.Describe(layer.dataSource)
	extent = desc.Extent
	fishnet = arcpy.CreateFishnet_management(r'in_memory\fishnet',
	                '%f %f' %(extent.XMin, extent.YMin),
	                '%f %f' %(extent.XMin, extent.YMax),
	                0, 0, 10, 10,
	                '%f %f' %(extent.XMax, extent.YMax),
	                'NO_LABELS',
	                '%f %f %f %f' %(extent.XMin, extent.YMin, extent.XMax, extent.YMax), 'POLYGON')
	arcpy.RefreshActiveView()

def onFocus(self, focused):

  # When the combo box has focus, update the combo box with the list of layer names.
	if focused:
		self.mxd = arcpy.mapping.MapDocument('current')
		layers = arcpy.mapping.ListLayers(self.mxd)
		self.items = []
		for layer in layers:
			self.items.append(layer.name)
```
3. スクリプトを保存します。
コンボボックスをテストします。
コンボボックスを作成してスクリプトコードを追加したら、アドインを共有する前に、アドインファイルを作成してテストすることが重要です。これらの手順については、「アドインのテスト」をご参照ください。
アドインを共有します。
コンボボックスをテストして正常に動作することを確認したら、アドインを配備および共有する準備は完了です。詳細については、「アドインの共有とインストール」をご参照ください。

アドイン コンボ ボックスの作成

関連トピック

アドインコンボボックスの作成