ProGuide Configurations - EsriJapan/arcgis-pro-sdk GitHub Wiki

Language:      C#
Subject:       Framework
Contributor:   ArcGIS Pro SDK Team <[email protected]>
Organization:  Esri, http://www.esri.com
Date:          10/06/2024
ArcGIS Pro:    3.4
Visual Studio: 2022

ArcGIS Pro 構成管理は、アプリケーションの高度なカスタマイズパターンです。構成は、アプリケーションを構成および拡張するためのいくつかの追加の機会があることを除いて、アドインに似ています。このProGuideは、次の2つの部分に分かれています。

1. 組織のブランディングのための管理された構成の使用
2. 構成を使用してユーザーインターフェイスと機能をカスタマイズする

詳細については、ProConcepts: Configurations を参照してください。

• 組織のブランディングのための構成の使用
• 構成を使用してユーザーインターフェイスと機能をカスタマイズする

組織のブランディングを示すために、Pro SDKの構成管理テンプレートを使用して新しい構成を作成します。構成管理のコンテキストでの 組織のブランディング とは、アプリケーションアイコン、スプラッシュ画面、起動画面、「ArcGIS Pro について」ページなどのユーザーインターフェイス要素をカスタマイズして、組織のブランドを反映できることを意味します。このセクションでは、これらのUI要素をカスタマイズする方法を示します。

Visual Studio を開き、ファイル | 新規作成 | プロジェクト、インストール済みを展開 | テンプレート | Visual C# | ArcGIS | ArcGIS Pro アドイン | ArcGIS Pro 構成管理を選択します。ソリューション名を"MyConfiguration"とします。

Visual Studioでプロジェクトをビルドし、MyConfigurationプロジェクトのプロパティページを開いて、デバッグ タブを選択します。ArcGISPro.exeは、 /config:{configuration name} コマンドライン パラメーターを使用して実行されることに注意してください

構成管理テンプレートは、正しいコマンドライン パラメーターをプロジェクトに自動的に追加します。プロジェクトがビルドされると、.ProConfigX ファイル拡張子を持つ構成パッケージが構成のデフォルトの場所（C:\Users\<ユーザー名>\Documents\ArcGIS\AddIns\ArcGISPro\Configurations）にインストールされます。

注：プロジェクトで構成の名前を変更する場合は、 デバッグ タブのコマンドラインスイッチでも構成の名前を変更する　必要があります。

デバッグするには、ブレークポイントを通常どおりに設定し、「開始」をクリックして構成を実行します（アクティブなVisual Studio構成が アクティブな (Debug) であることを確認してください）。

「ConfigurationManager1.cs」を開きます。OnShowSplashScreenオーバーライドメソッドまでスクロールします。構成管理テンプレートには、カスタマイズ可能なスプラッシュ画面ウィンドウのデフォルトの実装が「SplashScreen.xaml」に追加されます（または、コールバックを削除するか、nullを返して元のスプラッシュ画面を保持します）。

「ConfigurationManager1.cs」を開きます。OnShowStartPageオーバーライドメソッドまでスクロールします。構成管理テンプレートは、カスタマイズ可能なスタートアップページのデフォルト実装を「StartPage.xaml」に追加します（または、コールバックを削除するか、nullを返して元のスタートアップページを保持します）。構成ではModel-View-ViewModel、MVVM、パターンを使用するため、スタートアップページ ビューにもコンパニオン ビューモデル「StartPageViewModel.cs」があります。次に示すように、バインドの目的で、スタートアップページのデータコンテキストをビューモデルで初期化するのはユーザーの責任です。

	if (_vm == null)
	{
	  _vm = new StartPageViewModel();
	}
	var page = new StartPage();
	page.DataContext = _vm;//Initialize the datacontext
	return page;

ArcGIS Pro プロジェクトファイルを開くと、スタートアップページは自動的に閉じられます。あなたはそれを閉じる必要はありません：

	if (dlg.ShowDialog() ?? false)
	{
	  var item = dlg.Items.FirstOrDefault();
	  if (item != null)
	  {
	    Project.OpenAsync(item.Path);//Automatically closes the startup page
	  }
	}

さまざまなスタートアップページの実装を確認するには、次のコミュニティサンプルを参照してください。

ConfigWithStartWizard コミュニティ サンプル コード

標準の Pro スタートページと同様のルック＆フィールを提供するカスタム スタートページを作成するのに役立つ多くのUIコントロールがAPIで提供されています。詳しくは、SignOn コントロール、Recent Projects コントロール、Recent Templates コントロールを参照してください。

*一貫したユーザーエクスペリエンスを確保するために、プロジェクトを開くと新しいプロジェクトのバックステージタブも置き換える必要があります。これらは、スタートアップページとは別のビューです。標準のDAML（つまり<deleteTab .... />）を使用して既存のバックステージタブを削除し、「ArcGIS Pro のバックステージタブ」テンプレートを使用して、 カスタム の開くと新しいプロジェクトタブを構成に追加します。

「ConfigurationManager1.cs」を開きます。Icon のところまでスクロールして、上書きしてください。デフォルトでは、"new Configuration" テンプレートに付属している "favico.ico" が表示されます。タイトルバーのアイコンは変更されますが（構成が実行されていない場合はProのアイコンに戻ります）、Windowsタスクバーのアイコンは変更されません。タスクバーには常にProのアイコンが表示されます。アイコンの変更は任意です。Proアプリケーションのデフォルト アイコンを使用するには、このプロパティを削除してください。

起動時のアプリケーション アイコン

プロジェクトを開いた状態でのアプリケーション アイコン

注：以下に示すように、完全なパックURI形式を使用してください。Visual 　Studioプロジェクトで、アイコンファイルのビルドアクションを「Resource」に設定します。

protected override ImageSource Icon
{
    get
    {
        return new BitmapImage(
             new Uri(
               @"pack://application:,,,/MyConfiguration;component/Images/favicon.ico"));
    }
}

「ConfigurationManager1.cs」を開きます。OnShowAboutPageオーバーライドメソッドまでスクロールします。オプションで、このメソッドをオーバーライドして、「Pro について」タブ内でホストされているSystem.Windows.FrameworkElement（通常はユーザーコントロール）を返します。構成管理テンプレートは、カスタマイズ可能な「AboutPage.xaml」にアバウトページ コンテンツのデフォルト実装を追加します（またはコールバックを削除して、元のアバウトページを変更しないでください）。

組織のブランディングのために前のステップで作成したMyConfigurationソリューションを使用します。リファレンス実装は、次のコミュニティサンプルでも提供されています。

ConfigWithMap コミュニティ サンプル コード

前のセクションで作成したMyConfigurationソリューションを開きます。Visual Studioのスタート ボタンをクリックして、デバッグセッションを開始します。デフォルトのArcGIS Pro リボンは変更されていないことに注意してください（他のアドインがシステムにインストールされていないことを前提としています）。

ArcGIS Proを閉じて、デバッグを停止します。

注：ArcGIS Proの各セッションの完全なDAMLを調べるには、次のコマンドラインオプション /dumpcombineddaml をArcGISPro.exeに追加します。

ArcGISPro.exe /config:MyConfiguration /dumpcombineddaml

「ConfigurationManager1.cs」を開きます。ConfigurationManager1内で、OnUpdateDatabase メソッドのオーバーライドを追加します。

#region Override DAML Database

protected override void OnUpdateDatabase(XDocument database)
{
}

#endregion

OnUpdateDatabaseオーバーライドメソッドは単一のパラメーター XDocument databaseを取ることに注意してください。起動時に、Pro（bin\Extensions）からのすべてのDAMLファイル、検出されたアドイン、および構成が単一のDAMLデータベース（つまりXML）にマージされます（このデータベースは、前述の/dumpcombineddamlコマンドラインオプションを使用して調べることができます）。OnUpdateDatabaseコールバックにコードを追加して、リボンのすべてのタブ要素を削除します。構成でこのXMLを編集するときは、細心の注意を払ってください。アプリケーションUI全体を定義します。

以下のコードスニペットは、XMLデータベースからすべてのタブ要素をHashSetに収集してから、それらを削除します。このスニペットをOnUpdateDatabaseオーバーライドメソッドに挿入します。

using System.Xml.Linq;
...
...
protected override void OnUpdateDatabase(XDocument database) {

   var nsp = database.Root.Name.Namespace;
   // select all elements that are tabs
   var tabElements = from seg in database.Root.Descendants(nsp + "tab") select seg;
   // collect all elements that need to be removed
   var elements = new HashSet<XElement>();
   foreach (var tabElement in tabElements)
   {
     // skip root and backstage elements
     if (tabElement.Parent == null
             || tabElement.Parent.Name.LocalName.StartsWith("backstage"))
       continue;
     var id = tabElement.Attribute("id");
     //Add your own id prefix here to skip deleting your own tabs
     if (id == null) continue;
     elements.Add(tabElement);
   }
   // remove the elements
   foreach (var element in elements)
   {
     element.Remove();
   }
}

Pro UIにいくつかのカスタムコントロールとタブを追加します。 MyConfigurationプロジェクトを右クリックし、プロジェクトのコンテキストメニューから 追加 | 新しい項目 を選択します。 構成にArcGIS Proボタンを追加します（Visual C# 項目 | ArcGIS | ArcGIS Pro アドイン | ArcGIS Pro ボタン の順に選択します）。ボタンに「TestUserInterface」という名前を付けます。

新しく追加された「TestUserInterface.cs」ファイルを開きます。OnClickメソッドにMessageBox.Show("test");行を追加します。

プロジェクトの「Config.daml」ファイルを編集します。Config.damlに新しいタブを追加します。MyConfiguration_Group1グループへの参照が含まれていることを確認します。

<tabs>
  <tab id="MyConfiguration_Tab1" caption="Test UI Tab" keytip="Z0">
    <group refID="MyConfiguration_Group1"/>
  </tab>
</tabs>

<group ...>要素でappearsOnAddInTab="true"をappearsOnAddInTab="false"に変更します。リボンにアドイン タブを表示しないようにします。

<groups>
  <group id="MyConfiguration_Group1" caption="Group 1" appearsOnAddInTab="false">
    <button refID="MyConfiguration_TestUserInterface" size="large" />
  </group>
</groups>

次に、新しく追加したタブを OnUpdateDatabase のオーバーライドの削除コードから除外したいと思います。OnUpdateDatabase オーバーライドの //Add your own id prefix here to skip deleting your own tabs コメントに注目してください。既存の if (id == null) continue; 式を if (id == null || id.Value.StartsWith("MyConfiguration")) continue; に置き換え、独自のタブ要素をスキップするようにします。ノート: ...StartsWith("MyConfiguration") を、自分のタブ ID のプレフィックスが異なる場合は、その値に変更します。

protected override void OnUpdateDatabase(XDocument database)
{
   ...
   foreach (var tabElement in tabElements)
   {
      ...
      //Add your own id prefix here to skip deleting your own tabs
      if (id == null || id.Value.StartsWith("MyConfiguration")) continue;//Skip our tabs

変更を保存してプロジェクトをビルドします。Visual Studioからアプリケーションを実行します。プロジェクトを開きます。リボンに「Test UI Tab」が表示されていることを確認します。Proの他の標準タブがすべてリボンから削除されていることを確認します。カスタムTestUserInterfaceボタンをクリックします。メッセージボックスが表示されます。

構成管理を使用して、ArcGIS Proのユーザーインターフェイスと機能を変更しました。ConfigWithMap コミュニティ サンプル コードから完全なサンプルをダウンロードできます。