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

ArcGIS Pro 構成管理はアドインに似ていますが、アプリケーションを拡張するための追加の方法を提供します。これにより、組織のブランドやワークフローをより厳密に反映したバージョンの ArcGIS Pro を設計するのに役立ちます。

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

トピック

• 概要
• 構造
• コンパイル
• 実行時
• インストール
• DAML スキーマ
  • Configuration 要素
  • Configuration の子要素
    • ConfigurationManager 要素
    • Addins 要素
      • AddIns の子要素
• Configuration Manager
  • 構成管理のコールバック
    • 初期化前
      • OnShowSplashScreen
      • RuntimeDamlFile
    • 初期化
      • OnApplicationInitializing
      • OnCreateDaml
      • ApplicationName
      • OnUpdateDatabase
      • Icon
      • OnValidateLicense
      • OnShowStartPage
      • オプションのリセット
    • Ready
      • OnApplicationReady
      • OnCreateQuickAccessToolbar
      • OnShowAboutPage
      • OnCanExecuteCommand
      • OnExecuteCommand
  • アプリケーションイベント登録

構成管理ではアドインよりも高レベルでのカスタマイズが可能です。アドインのカスタマイズは、主に ArcGIS Pro の UI の拡張に限定されますが、構成管理のカスタマイズはより詳細に行うことができます。構成管理により、アドインのセキュリティレベルを上げ、管理者以外が指定した既知のフォルダーを追加することができます。構成管理は、アドインよりも広範囲なカスタマイズが可能であり、DAML 実行時の変更（ログインしたユーザーの役割に基づく）も提供します。

個々のマシンに複数の構成管理をインストールすることはできますが、ArcGIS Pro のセッションごとに実行できる構成管理 (つまりソリューション) は 1 つのみです。これは、セッションごとに複数のアドインをインストールおよびロードできるアドインとは異なります。

構成管理でできることには次のようなものがあります。

• カスタムスプラッシュスクリーンとカスタムスタートページの作成

• アプリケーション アイコン、名前、タイトルバーテキストの変更

• 使用頻度の低いコントロールの再配置や削除、新しいコントロールの挿入

• 起動時にロジックを挿入し、ユーザーの役割に応じてライセンスチェックやユーザーインターフェースの変更を行う

• アドインの読み込みを制御する

• フィルターコマンド (コマンドの通知とそれを無効にするオプション)

構成管理は、アドインと同様に、モジュール、ボタン、ドックペインなどの新しい機能を公開することもできます。

構成管理ファイルは zip アーカイブファイルで、拡張子は .proConfigX、内部構造はアドインと同じです。構成管理 (およびアドイン) は、次のようないくつかの部分で構成されます。

• 構成管理とそのカスタマイズ内容を記述した DAML (Desktop Architecture Markup Language) ファイル

• コンパイルされたコード (コンフィグレーション・マネージャーとその関連モジュール用)

• 画像

• リソース

• サードパーティのアセンブリ

ArcGIS Pro 構成管理プロジェクト テンプレートは、DAML、構成管理およびモジュール クラス ファイルを含む構成管理プロジェクトを生成します。プロジェクトをビルドして構成管理アーカイブファイル (例：ProConfiguration1.proConfigX) を生成し、デフォルトの既知のフォルダ (C:\Users<UserName>\Documents\ArcGIS\AddIns\ArcGISPro\Configurations) にインストールします。ほとんどの場合、構成管理の DAML は、アドインに使用される ArcGIS Pro SDK アイテム テンプレートと同じセットを使用して作成されます (たとえば、ボタン、マップ ツール、ドックパネルなどを構成管理に追加する場合など)。

構成管理はシングルトンです。1 つのシステムにはいくつでも構成管理をインストールすることができますが、アクティブにできる構成管理は1つだけです。構成管理は、ArcGISPro.exe のコマンド ラインで /config:{構成管理名} コマンド ライン オプションを使用して指定することでアクティブになります。例：C:\ArcGIS\bin\ArcGISPro.exe /config:Acme とすると Acme.proConfigX の設定を有効にして ArcGISPro を起動します。

通常、実行する構成管理ごとにデスクトップのショートカットを作成します。各ショートカットには、さまざまな構成管理の起動を簡単にするための関連する/config:{Configuration_name} 引数が含まれています。これにより、異なるデスクトップのショートカットで Pro を起動するだけで、異なる構成管理とデフォルトのアプリケーションを簡単に切り替えることができます。

構成管理は、レジストリで指定することもできます。レジストリを使用すると、Pro のすべてのセッションでレジストリに指定された構成管理が常に実行されます。レジストリは、コマンドラインで指定された構成管理を上書きします。詳細は、ArcGIS Pro Registry Keys, ConfigurationName および ArcGIS Pro Registry Keys, Configuration Folders を参照してください。

構成管理は、アドインと同じインストールパターンです。.proConfigX ファイルをダブルクリックして "RegisterAddin.exe" を実行します。"RegisterAddin.exe" は、構成管理を検証し、構成管理が保存されているフォルダにコピーします。C:\Users<UserName>\Documents\ArcGIS\AddIns\ArcGISPro\Configurations.ユーザーは、先に進める前に、構成管理の作成者、説明、バージョン、デジタル署名の情報を確認する機会が与えられます。同じフォルダー (デフォルトフォルダーまたは既存のフォルダー) にインストールされている既存の構成管理と同じ名前の構成管理がある場合、既存の構成管理が上書きされます。

構成管理は Config.daml の中で、ルートの<ArcGIS ...>要素の子として指定された<Configuration ...>セクションの中で宣言されます。

<ArcGIS defaultAssembly="ProConfiguration1.dll"
        defaultNamespace="ProConfiguration1"
        xmlns="http://schemas.esri.com/DADF/Registry"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://schemas.esri.com/DADF/Registry file:///C:/arcgis/bin/ArcGIS.Desktop.Framework.xsd">

  <AddInInfo ...>
    ...
  </AddInInfo>

  <Configuration blockAddInTab="true" blockCustomizeDialog="false" blockPerfMeter="true" 
                                   checkForUpdatesAtStartup="false">
    <ConfigurationManager className="ConfigurationManager1"/>
    <AddIns securityLevel="1">
      <AdditionalWellKnownFolder>\\NetworkShare\public\add-ins</AdditionalWellKnownFolder>
    </AddIns>
  </Configuration>
  <modules>
    <insertModule id="...." ... >

DAML ごとに存在できる構成管理の要素は1つしかありません。構成管理の要素は blockAddInTab,blockCustomizeDialog, blockPerfMeter, および checkForUpdatesAtStartup の 4 つのオプション属性があります。

blockAddInTab

デフォルト値：false

true に設定すると、blockAddInTab 属性はリボンの Add-In タブを非表示にします。 注: アドインはロードされますが、Add-In タブは表示されません。

blockCustomizeDialog

デフォルト値：false

blockCustomizeDialog 属性が true に設定されると、ArcGIS Pro の [オプション] から [リボンのカスタマイズ] オプションが削除されます。これにより、[オプション] の [リボンのカスタマイズ] ページから行ったユーザーレベルのカスタマイズがすべてブロックされます。

blockCustomizeDialog="true"の場合、"リボンのカスタマイズ"は削除されます。

blockPerfMeter

デフォルト値：false

blockPerfMeter 属性が true に設定されると、ユーザーがArcGIS Monitor を起動できないようにブロックします。

CheckForUpdatesAtStartup

デフォルト値：true

checkForUpdatesAtStartup 属性が false に設定されると、ArcGIS Pro のバックステージにある [バージョン情報] タブの [起動時に更新を確認] チェック ボックスのチェックを外します。

ConfigurationManger 要素は必須です。このクラスは、構成管理を作成するのに役立ついくつかの、オプションの拡張ポイントを提供します。拡張ポイントはコールバックとして実装され、派生したConfigurationManager クラスでオーバーライドされます。

ConfigurationManger 要素には、1つの必須属性 className があります。

className

デフォルト値：none

ConfigurationManager クラスを指定します。ConfigurationManager クラスは、ArcGIS.Desktop.Framework.Contracts.ConfigurationManager コントラクト クラスを継承する必要があります。

  <Configuration>
    <ConfigurationManager className="ConfigurationManager1"/>
  </Configuration>

Addins 要素を使って、アドインのセキュリティレベルを指定したり、既存のアドインのセキュリティレベル*を上げたり、管理者の既知のフォルダを追加したりすることができます。

securityLevel

デフォルト値：0

securityLevel 属性には、アドインのセキュリティレベルを示す 0～5 の整数値を設定できます。これらのレベルは、レジストリで設定できる BlockAddins アドインのセキュリティレベルと同じです。

*BlockAddins のセキュリティレベル (HKLM と HKCU の両方)は、設定によってのみ上げることができます。BlockAddin のセキュリティレベルよりも低い securityLevel の値は無視されます。

 <Configuration>
    <ConfigurationManager className="ConfigurationManager1"/>
    <AddIns securityLevel="1"/>
  </Configuration>

アドインのセキュリティレベルを 1 に設定します (署名付きアドインのみ)。

デフォルト値：none

管理者用アドインフォルダーとして扱われるローカルフォルダーまたはネットワーク共有のフルパスを指定します。0 個以上の AdditionalWellKnownFolder 子要素を指定できます。AdditionalWellKnownFolders は、他のフォルダ (レジストリで指定されているかどうかに関わらず) よりも先にアドインの有無を確認します。

<Configuration>
    <ConfigurationManager className="ConfigurationManager1"/>
    <AddIns>
      <AdditionalWellKnownFolder>\\AddInShare\Public\Add-Ins</AdditionalWellKnownFolder>
      <AdditionalWellKnownFolder>C:\Data\Common\Add-Ins</AdditionalWellKnownFolder>
   </AddIns>
</Configuration>

管理者用アドインフォルダーのリストに、\\AddInShare\Public\Add-Ins と C:\Data\Common\Add-Insを追加します。

すべての構成管理は、ArcGIS.Desktop.Framework.Contracts.ConfigurationManager から派生した設定マネージャクラスを実装する必要があります。ConfigurationManager コールバックはオプションです。ArcGIS Pro のアスペクトをオーバーライドしたいものだけをオーバーライドします。デフォルトでは、ArcGIS Pro 構成管理 テンプレートは、アプリケーション名、アイコン、スタートページ、スプラッシュ画面、およびページ コンテンツのコールバックについてデフォルトのオーバーライドを実装した ConfigurationManager クラスを生成します。

構成管理は、Pro の起動シーケンスの非常に早い段階でインスタンス化されます。アクティブな構成管理は、他のモジュール (Coreまたはその他) よりも先にロードされます。構成管理コールバックの多くは、ホスト WPF アプリケーションが構築され、ArcGIS Pro の基となるウィンドウとバックグラウンド スレッドが開始される前に実行されます。つまり、構成管理を実装すると、アプリケーションの状態に関連する Pro 起動時のコールバックでカスタムコードを実行する際に、開発者に厳しい制約が課せられることになります。

これらの制約に従わないと、Pro アプリケーションがクラッシュします。コールバックの正しい処理については、次のセクションで説明します。

 //The ConfigurationManager contract
 public class ArcGIS.Desktop.Framework.Contracts.ConfigurationManager {

    //Gets a replacement DAML file at run-time.
    protected internal virtual string RuntimeDamlFile { get; }

    //Gets the new application name
    protected internal virtual string ApplicationName { get; }

    //Gets the title bar text (New at 3.0)
    protected internal virtual string TitleBarText { get; }

    //Gets the new application icon
    protected internal virtual ImageSource Icon { get; }

    //Called when the application is initializing. Denotes it is now safe to 
    //communicate with Portal at this time. The DAML records have not been processed 
    //at this point.
    //
    //cancelEventArgs: false signals a problem has occurred. The application will shut down.
    protected internal virtual void OnApplicationInitializing(CancelEventArgs cancelEventArgs);

    //Called when the application has fully initialized.
    protected internal virtual void OnApplicationReady();

    //CommandFilter - gives a configuration the ability to disable commands.
    //
    //cmdID: The DAML ID of the command about to execute.
    //moduleID: The command's parent module DAML ID.
    protected internal virtual bool OnCanExecuteCommand(string cmdID, string moduleID);

    //Opportunity for the configuration to provide DAML at run-time.
    //
    // Returns: The DAML to process in the form on an XML string.
    protected internal virtual string OnCreateDaml();

    //Opportunity for the configuration to provide a list of commands to show in the 
    //quick access toolbar. It occurs after the start page has been closed and the first
    //project is opening.
    //
    // Returns: A list of commands to be used on the QAT
    protected internal virtual List<Tuple<string, bool>> OnCreateQuickAccessToolbar();

    //CommandFilter - gives a configuration the ability to reject a command's execution
    //cmdID: The DAML ID of the executing command.
    //moduleID: The command's parent module DAML ID.
    protected internal virtual bool OnExecuteCommand(string cmdID, string moduleID);

    // Allows the configuration to inject some custom user interface into the about page.
    //
    // Returns: The element to add to the about page.
    protected internal virtual FrameworkElement OnShowAboutPage();

    //The custom splash screen for the configuration.
    //
    // Returns: The custom window to show during startup.
    protected internal virtual Window OnShowSplashScreen();

    //The custom start page (landing page) to show once the application starts.
    //
    // Returns: The start page
    protected internal virtual FrameworkElement OnShowStartPage();

    //The last chance for the configuration to manipulate the DAML before it is processed.
    //
    //database: The entire merged DAML database.
    //
    //Remarks:
    //  A configuration may find it necessary to edit the raw database to achieve a desired
    //  look. For example, a configuration may want to delete all the tabs in the system
    //  except for its own. This is the raw DAML database in XML form, edit with extreme caution.
    protected internal virtual void OnUpdateDatabase(XDocument database);
        
    //License validation
    //
    //Remarks:
    //  Gives the configuration the chance to perform its own license checking. Returning
    //  false signals a licensing problem has occurred. The application will shut down.
    protected internal virtual bool OnValidateLicense();
}

構成管理コールバックは、ArcGIS Pro アプリケーションの状態に関連する、初期化前、初期化中、準備完了の 3 つのカテゴリに分類されます。初期化前の状態では、Pro API モジュールはロードされず、UI もありません。初期化中では、Pro WPF アプリケーションが作成され、ポータルやオンライン接続が初期化されます。最後に準備完了の状態で、アプリケーションが完全にロードされます。アプリケーションの状態は先に進むのみです。アプリケーションが準備完了状態に移行すると、セッションの間、準備完了状態が維持されます。

構成管理のコールバックは、以下のように呼び出される正確な順に記載されています。OnShowAboutPage、OnCanExecuteCommand、OnExecuteCommand を除いて、コールバックは 1 つのセッションにつき 1 回しか呼び出されません (例外もあります - オプションのリセットを参照してください)。

1. コールバックの事前初期化
   • OnShowSplashScreen
   • RuntimeDamlFile

2. コールバックの初期化
   • OnApplicationInitializing
   • OnCreateDaml
   • ApplicationName*
   • OnUpdateDatabase
   • Icon
   • OnValidateLicense
   • TitleBarText*
   • OnShowStartPage

  --- アプリケーションウィンドウがここに表示されます ---

3. コールバックの準備
   • OnApplicationReady

 --- スタートページが表示されます ---
* OnCreateQuickAccessToolbar()
* OnShowAboutPage (not ordered*)
* OnCanExecuteCommand (not ordered*)
* OnExecuteCommand (not ordered*)

*UIイベントに応答して発生します。特に TitleBarText は1回のセッションで複数回起動することができます。

3 つのアプリケーションの状態の遷移は、OnApplicationInitializing と OnApplicationReady の 2 つのコールバックによって区別されます。OnApplicationInitializing は初期化前から初期化への移行を示します。OnApplicationReady は初期化から準備完了への移行を示します。

初期化で実際に行うべきことは、スプラッシュ スクリーンを提供することだけです (デフォルトをオーバーライドする場合)。この段階では、Pro のライフサイクルの非常に早い段階にあります。Pro WPF アプリケーションはまだ起動していないため、機能している UI スレッドがあることを前提とした呼び出し (メッセージボックスの表示など) を行うと、アプリケーションがクラッシュします。Pro 拡張アセンブリがまだ 1 つもロードされていないため、初期化前の段階で Pro API を呼び出すとアプリケーションがクラッシュします。

初期化前は以下を行います。

• カスタムスプラッシュスクリーンの表示

初期化前は以下を行わないでください。

• QueuedTask.Run を含む任意の Pro API メソッドの呼び出し

• 任意の Pro WPF リソース (スタイル、ブラシ、カラー、アイコン、イメージ) へのアクセス

• Proのイベントを登録する (ConfigurationManager のコンストラクタも含む)

• UI スレッドに依存する WPF の呼び出しを行う (Dispatcher.Invoke など)

• 任意のカスタムUI (メッセージボックスなど) の表示

この関数をオーバーライドして、起動時にカスタムスプラッシュスクリーンを表示します。スプラッシュスクリーンは、ボーダーレスの WPF ウィンドウでなければなりません。ArcGIS Pro SDK 構成管理テンプレートは、カスタマイズ可能なスプラッシュ スクリーン ウィンドウを構成管理に追加します。null のウィンドウが返された場合は、Pro のデフォルトのスプラッシュスクリーンが表示されます。

構成管理の DAML を (デフォルトの Config.daml とは）異なるXML ファイルから生成したい場合は、この関数をオーバーライドします。RunTimeDamlFile から返された DAML は、デフォルトの Config.daml から読み込まれた DAML を上書きします (これは「結合」ではなく「置換」です)。Pro API を必要とするロジックに基づいて DAML コンテンツを提供したい場合は、代わりに OnCreateDAML を使用する必要があります。

初期化中では、構成管理には通常 2 つのタスクがあります。

• 構成管理ワークフロー、権限、ロールなどに基づいて Pro UI に変更を加えます。

• Pro のセッションを開始するためのスタートページを用意します。スタートページは一度だけ表示されます。

初期化は OnApplicationInitializing コールバックで始まります。初期化することで、初めて Pro API にアクセスできるようになりますが、まだ制限があります。API では、EsriHttpClient、ArcGISPortalManager、ArcGISPortalを安全に呼び出すことができますが、それだけのことです。ポータルやオンラインにアクセスするためのコードを集約する便利な場所として、OnApplicationInitializingコールバックを使うことができます。例えば、構成管理がポータルのコンテンツやポータルの設定、ロールなどにアクセスして、今後の Pro セッションの構成管理に影響を与える必要がある場合です。

Pro の他の機能は初期化中にはインスタンス化されず (この時点ではマップ、レイヤー、プロジェクトなどは存在しません)、親のWPF アプリケーションもまだありませんが、初期化中に作成され、OnShowStartPage コールバックの直後に表示されます。Pro のメインバックグラウンドスレッド"MCT" または QueuedTask は、サインイン/サインアウトに関連するポータル呼び出しをラップするために使用しないでください。このことは関連するメソッドの概要コメントに記載されています。例えば、portal.SignIn()のコメントに注目してください。

構成管理の OnApplicationInitializing コールバック内で、SignIn を QueuedTask ではなくMain Thread で呼び出すように指示していることに注目してください。これはスクリーンショットに示したのと同じコードスニペットです。このコードでは、現在のユーザーがサインインしておらず、資格情報がキャッシュされていない場合、OAuth ダイアログが "pop" されます。

protected override void OnApplicationInitializing(CancelEventArgs cancelEventArgs) {
  var portal = ArcGISPortalManager.Current.GetActivePortal();
  if (portal != null)
  {
     if (!portal.IsSignedOn())
        portal.SignIn();
  }
}

一般的に、アプリが停止する可能性があるため、Pro の初期化中にカスタム UI を表示しないでください。例えば、リソース (データベース、ウェブサイトなど) へのログインが必要で、ログインに失敗するとアプリを終了させるような設定が必要な場合です (同様に、基盤となる Pro ライセンスやポータルクラスは、認証が必要な場合はいつでも起動時に OAuth ポップアップをトリガーすることができます)。xaml の Pro WPF リソースを使用していない限り、初期化中にUIを表示することができます。xaml で Pro WPF リソースを使用していない限り、初期化中に UI を表示することができます。

OnShowStartPage は、初期化中の最後のコールバックです。スタートページコールバックが返された後、アプリケーションは引き続き読み込みを行い、WPF のメインウィンドウを表示し、API 拡張機能の読み込みを完了し、MCT を起動し、スタートページを提供していればそれを表示して終了します。スタートページは初期化中に要求された場合でも、実際には準備完了の状態で表示されています。スタートページは準備完了時に表示されるため、Pro WPF のスタイル、ブラシ、カラーを使用しても問題なく、スタートページのロジックで任意の Pro API のメソッドに安全にアクセスすることができます。しかし、UI スレッドが開始された場合、QueuedTask の通常の使用ルールが適用されます。スタートページから Pro API にアクセスする場合、通常のアドインロジックをコーディングする際にインスタンス化されることが期待される多くのクラスやプロパティは NULL のままであることに注意してください。

スタートページを提供する場合、スタートページが Pro セッションを開始する役割を担います。セッションを開始するには、新しいプロジェクトを作成するか、既存のプロジェクトを開きます。スタート ページを閉じる必要はありません。これは、セッションが開始されたときに自動的に行われます。スタート ページは、Pro セッションの開始時に一度だけ表示されます。

初期化時は以下を行います。

• Pro API を使用して (QueuedTask を使用せずに) ポータルまたはオンラインを呼び出す

• カスタム DAML の提供 (必要に応じて)

• DAML データベースの変更 (必要に応じて)

• Pro セッションを開始するためのロジックや UI をカスタマイズしたい場合は、カスタム スタート ページを提供します。

• スタート ページで Pro WPF のスタイルなどを使用する

• スタート ページのロジックで任意の Pro API アスペクトを呼び出す (必要に応じて QueuedTask を使用)。

初期化時は以下を行わないでください。

• ArcGIS.Desktop.Core 以外の Pro API メソッド (QueuedTask.Run を含む) の呼び出し

• プラグイン、ペイン、ドッキングペイン、または UI 要素、その他のモジュールへのアクセス

• すべての Pro イベントに登録

• スタート ページ以外の Pro WPF リソース (スタイル、ブラシ、カラー、アイコン、イメージ) へのアクセス

• UI スレッドに依存する WPF の呼び出し (例：Dispatcher.Invoke)。

• 任意のカスタム UI を表示

これらの制約に従わないと、アプリケーションがクラッシュします。

*アプリケーションの準備が整う前に構成管理内の Pro イベントを登録する方法については、アプリケーション イベントの登録 を参照してください。

*スタート ページは表示しても問題ありません。

*必要に応じて、カスタムログイン UI などが適切です。 Pro WPF リソースを使用しないでください。

この関数は、ConfigurationManager がアプリケーションのいくつかの部分を呼び出す最初の機会であり、その中で最も重要なのは、オンラインおよびポータル通信用の API です。このコールバックにも、CancelEventArgs が渡され、その Cancel プロパティが true に設定される場合、アプリケーションは直ちにシャットダウンします。

実行時に DAML を XML 文字列の形で提供するには、この関数をオーバーライドします。たとえば、OnApplicationInitializing で現在のユーザーが編集者と管理者の役割を持っていると判断した場合 (ポータルまたはオンラインへのクエリなど)、この役割には異なる DAML　を提供する必要があります。OnCreateDaml を介して提供された DAML は、以前に構成管理から読み込まれた DAML よりも優先されます (構成管理の DAML 要素自体は例外ですが、これは後から変更することはできません)。

このプロパティをオーバーライドして、アプリケーションのタイトルバーの名前を指定します。ApplicationName は複数回呼び出せます。 Note：3.0 では、タイトル文字列が存在する場合、アプリケーションのデフォルトはタイトルのみ表示されます。アプリケーション名は表示されません。

デフォルトでは、現在開いているプロジェクト名がタイトルとして表示されます。3.0 でのタイトルバーにApplicationName を表示する方法は、TitleBarTextを参照してください。

起動時に、Pro (bin\Extensions) からの DAML ファイル、検出されたアドイン、および設定のすべてが 1 つの DAML データベース (XML) にマージされます。その XML データベースは、この関数のパラメータとして渡されます。Pro の UI を定義するために処理される前に、OnUpdateDatabase で最終的にマージされたデータベースを修正することができます。例として、以下の OnUpdateDatabase の実装では、Pro のリボンから設定以外のすべてのタブが削除されます。

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");
       if (id == null || id.Value.StartsWith("MyConfiguration")) continue;//Skip our tabs - "MyConfiguration"
       elements.Add(tabElement);
   }
   // remove the elements
   foreach (var element in elements)
   {
       element.Remove();
   }
}

より詳細な例については、ProGuide Configurations を参照してください。

このプロパティをオーバーライドすると、アプリケーションのタイトルバーに表示されるアプリケーションのアイコンをカスタマイズすることができます。アイコンは複数回呼び出すことができます。

このコールバックは、構成管理が起動時に独自のライセンスチェックを行う機会を与えます。ライセンスの問題が発生した場合は、false を返します。false を返すと、アプリケーションの起動が終了し、アプリケーションがシャットダウンします。

このプロパティをオーバーライドして、アプリケーションのタイトルバーテキストを指定します。TitleBarTextは、アプリケーション タイトルバーのテキストを更新する必要があるたびに呼び出されます。TitleBarText は、スタートページが表示される前に (初めて) 呼び出されますが、プロジェクトが開かれるまで、アプリケーションのタイトルバーには実際にタイトルは表示されません。

2.x では、Name - Title - Subtitle といったタイトルの 3 つの構成要素がすべて表示されていました。しかし、3.0 では、デフォルトでタイトルだけが表示されます。アプリケーションのタイトル文字列がない場合、またはアプリケーションのタイトル文字列が NULLの場合、アプリケーションのデフォルトの動作は Name(設定の場合、ApplicationNameとなります) のみとなります。

3.0 で示したものと同じように、Name - Title - Subtitle の 3 つのタイトルの要素をまとめて表示するには、以下の TitleBarText の実装を使用します。

     protected override string ApplicationName
     {
       get { return "MyConfiguration"; }
     }
 
     protected override string TitleBarText
     {
       get 
       {
         string title = ApplicationName;
         if (!string.IsNullOrEmpty(FrameworkApplication.Title))
           title += " - " + FrameworkApplication.Title;
         if (!string.IsNullOrEmpty(FrameworkApplication.SubTitle))
           title += " - " + FrameworkApplication.SubTitle;
         return title; 
       }
     }

2.x style title:

アプリケーションの準備ができたときに表示するカスタムスタートアップページ (ランディングページ) です。null の FrameworkElement が返された場合は、Pro のデフォルトのスタートアップページが表示されます。スタートアップ ページは、その xaml で ArcGIS Pro リソースを安全に参照できます。

例については、ProGuide Configurations を参照してください。

注：初期化中にスタートページが要求され、Ready に表示されます。

ユーザーは、Pro Backstage からアクセスできる(プロジェクトの) オプション プロパティ ページを使って、アプリケーションの外観をカスタマイズすることができます (リボンをカスタマイズしないようにするには、<Configuration blockCustomizeDialog="false" ...> を使用します)。ユーザーがリボンやクイックアクセスツールバー (QAT) を変更したり、以前に行ったリボンや QAT のカスタマイズをリセットしたりすると(セッション中にオプションダイアログで)、アプリケーションはリボンや QAT を再初期化し、OnApplicationInitializing、OnCreateDaml、OnUpdateDatabase のコールバックが呼び出され、アプリケーション名とアイコンが表示されます。これにより、すでに稼働しているアプリケーションの UI を介して行われたカスタマイズの変更に対応し、修正を再適用するなどの構成が可能になります。

アプリケーションの状態

アプリケーションが完全に初期化され、スタートアップページ (カスタムでもデフォルトでも) が表示されると、アプリケーションの準備が整ったと言えます。準備が整った状態は、OnApplicationReady コールバックから始まります。これでシステム全体に安全にアクセスできるようになりました。

Ready 状態の間は、制限はありません。

注：Pro API のアスペクトを呼び出しても安全だからといって、必ずしも多くのプロパティやクラスが NULL にならないとは限りません。例えば、プロジェクトがまだ開かれていない場合、Project.Current と MapView.Active のプロパティは、安全にアクセスできるようになったとしても、NULL となります。

アプリケーションが完全に初期化された後に呼び出されます。これは、ArcGIS.Desktop.Framework.Events.ApplicationReadyEventが発行された直後と、ArcGIS.Desktop.Framework.Events.ApplicationStartupEventが発行される直前に呼び出されます。これらのイベントは、どこから見ても OnApplicationReady と同じことを表しています。

アプリケーションがスタートページを閉じて、セッションの最初のプロジェクトを開いているときに呼び出されます。OnCreateQuickAccessToolbar を使って、アプリケーション クイックアクセスツールバー のデフォルトの設定を上書きします。OnCreateQuickAccessToolbar の目的は、QAT の初期設定を行うことです。Configuration Manager がコールバックを介して提供する QAT の構成管理は、初回の構成管理実行後に、アプリケーションによって C:Users\\AppDataLocalESRI#{ApplicationName}Settings.xml ファイルに永続化されます。

構成管理が最初に実行された後、Pro アプリケーションは、構成管理マネージャーの下で実行される以降のセッションの QAT 構成管理に対して、永続化された {ApplicationName}Settings.xml ファイルを使用します(OnCreateQuickAccessToolbar コールバックは呼び出されますが、使用されません)。Pro のバックステージにあるオプションダイアログ (ユーザーによる) で QAT に加えられた変更は、その構成管理ファイルに保存されます (そのため、「Configuration Manager」で「Pro」アプリケーションを次回起動したときに、再度適用することができます)。

例えば、次のようなOnCreateQuickAccessToolbar の実装があるとします。

protected override List<Tuple<string, bool>> OnCreateQuickAccessToolbar()
    {
      List<Tuple<string, bool>> cmds = new List<Tuple<string, bool>>();
      //set the second argument "true" ("ischecked") to add to the QAT toolbar otherwise the
      //command will only show on the QAT pulldown menu. 
      Tuple<string, bool> item1 = new Tuple<string, bool>("esri_mapping_clearSelectionButton", true);
      Tuple<string, bool> item2 = new Tuple<string, bool>("esri_core_newProjectButton", true);
      Tuple<string, bool> item3 = new Tuple<string, bool>("esri_core_saveProjectButton", true);
      Tuple<string, bool> item4 = new Tuple<string, bool>("esri_core_undoSplitButton", true);

      cmds.Add(item1);
      cmds.Add(item2);
      cmds.Add(item3);
      cmds.Add(item4);
      return cmds;
    }

QAT は図のようになります。

アプリケーションは次の {ApplicationName}Settings.xml ファイルを永続化し、(与えられた 構成管理マネージャーを使用して) 後続のセッションで使用されます。

<?xml version="1.0" encoding="utf-8"?>
<ArcGIS>
  <QAT>
   <Commands>esri_mapping_clearSelectionButton;esri_core_newProjectButton;esri_core_saveProjectButton;esri_core_undoSplitButton;</Commands>
    <Position>1</Position>
    <IsRibbonCollapsed>False</IsRibbonCollapsed>
  </QAT>
</ArcGIS>

(プロジェクト) オプションで QAT 構成管理をリセットすると、QAT は指定された構成管理マネージャーの {ApplicationName}Settings.xml ファイルに保存されている QAT 構成管理にリセットされます。

アプリケーションのバージョン情報ページに"about" 情報を追加するユーザーコントロールを返します。このコールバックは、Pro バージョン情報タブがアクセスされるたびに呼び出されます。ArcGIS Pro SDK 構成管理テンプレートは、構成管理にユーザー コントロールを追加し、カスタマイズしてバージョン情報ページを提供することができます。

例については ProGuide Configurations を参照してください。

OnCanExecuteCommand と OnExecuteCommand コールバックは、コマンド フィルターとして動作します。コマンド フィルターを実装することで、関連するコマンドの実行を防ぐことができます。OnCanExecuteCommand コールバックは、ユーザーがリボン上の基礎となるコマンドボタンを "マウスオーバー" するたびに、コマンドの DAML ID とその親モジュールが渡されます。OnCanExecuteCommand は、指定されたコマンドを無効にするために false を返すことができます。false を設定すると、コマンドの基本的な有効状態が上書きされます。false を設定すると、コマンドの基本的な有効状態が上書きされます。true を返すことは、コマンドの基本的な有効/無効の状態を変更しないデフォルトの戻り値です。したがって、コマンドが有効である場合は、有効なままです。コマンドが無効の場合は、無効のままです。

このコールバックには、各 OnClick イベントの前に、コマンドとその親モジュールの DAML ID が渡されます。false を返すと、コマンドの実行が阻止されます (OnClick は実行されません)。

注：アドインは、コマンドフィルターパターンの限定的な形式を実装することができます。Command Filter のコミュニティサンプルを参照してください。

アプリケーションの準備が完了する前に、ConfigurationManager のコールバックやコンストラクタで ArcGIS Pro のイベントを登録しようとしないでください。ArcGIS.Desktop.Framework.Events.ApplicationReadyEvent や ArcGIS.Desktop.Framework.Events.ApplicationStartupEvent のような初期のイベントを登録する必要がある場合は、構成管理モジュール クラスのオーバーライドされたInitialize メソッドで登録し、DAML でautoLoad="true" を設定します。

internal class Module1 : Module {

   protected override bool Initialize() {
     
     //Immediately preceeds OnApplicationReady callback
      ArcGIS.Desktop.Framework.Events.ApplicationReadyEvent.Subscribe((a) => {
         Debug.WriteLine("ApplicationReadyEvent");
      });

     //Immediately follows OnApplicationReady callback
      ArcGIS.Desktop.Framework.Events.ApplicationStartupEvent.Subscribe((a) => {
         Debug.WriteLine("ApplicationStartupEvent");
      });
      return true;
   }

Config.daml 内:

  <modules>
    <insertModule id="..." className="Module1" autoLoad="true" ...>