API:Vcl.JumpList.TJumpList
Delphi
TJumpList = class(TCustomJumpList)
C++
class PASCALIMPLEMENTATION TJumpList : public TCustomJumpList
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
class | public | Vcl.JumpList.pas Vcl.JumpList.hpp |
Vcl.JumpList | Vcl.JumpList |
説明
Windows ジャンプ リストをサポートするためのコンポーネント(TJumpList など)の基底クラスです。
Vcl.JumpList.TJumpList は Vcl.JumpList.TCustomJumpList を継承しています。以下の内容はすべて Vcl.JumpList.TCustomJumpList を参照しています。
Windows ジャンプ リストをサポートするためのコンポーネント(TJumpList など)の基底クラスです。
Windows ジャンプ リストは Windows 7 で導入されました。TCustomJumpList のサブクラスを使用するには、アプリケーションが Windows 7 以降で動作している必要があります。ジャンプ リストがサポートされていないバージョンの Windows で TCustomJumpList を動作させると、TCustomJumpList.Enabled が False
になります。
- メモ: Enabled はデフォルトが
False
のため、ジャンプ リストを動作させるには、この値をTrue
に変更することを覚えておいてください。
TCustomJumpList のサブクラスを使用すると、アプリケーションの機能のショートカットとなるタスクのリストや、任意の数のカスタム カテゴリおよびカスタム項目を、設計時に定義することができます。タスクやカスタム カテゴリ/カスタム項目を定義したら、UpdateList を呼び出して、変更をアプリケーションのジャンプ リストに反映しなければなりません。または、ジャンプ リスト コンポーネントの AutoRefresh プロパティを有効にすると、アプリケーションが起動した直後や、実行時にジャンプ リストを変更した後に、変更を反映させることができます。
- メモ: Windows は、空のリストを表示しません。
ユーザーは、アプリケーションで定義されたタスクやカスタム項目のリストから、タスクやカスタム項目を削除することができます。UpdateList などのメソッドを呼び出すと、メソッドはユーザーがアプリケーションのジャンプ リストから削除した項目のリストを取得します。OnItemDeleted イベントを処理することで、それらのファイルを管理し、ジャンプ リスト コンポーネントから削除することができます。それらの項目を再びジャンプ リストに追加することももちろん可能ですが、Windows ではユーザーの選択を尊重するよう推奨しています。
アプリケーションのタスクやカスタム カテゴリは、実行時にも変更することができます。実行時に次のいずれかのメソッドを使用して、タスクやカスタム カテゴリを管理することができます:
ジャンプ リスト コンポーネントはイベント OnItemsLoaded を提供しており、これは、コンポーネントが読み込みを完了した際に発生します。すべてのタスクやカスタム カテゴリを、設計時に定義する代わりに、実行時に定義したい場合には、アプリケーションの実行フローにおいて、それらの初期値を定義できる、最も早いポイントになります。
また、ジャンプ リストにより、ユーザーが過去にアプリケーションで開いたファイルを表示させることができます。最近開いたファイル、よく開くファイル、もしくはその両方を表示させることができます。最近開いたファイルとよく開くファイルの両方を表示させることは可能ではありますが、Microsoft は、各アプリケーションにおいて、これらカテゴリのいずれかのみを使用することを推奨しています。
Windows は、これらファイルのリストを保持しており、GetRecentList または GetFrequentList を使用してクエリをかけることができます。最近開いたファイルやよく開くファイルのリストには、ユーザーが手動で開いたファイルと、TOpenDialog を使用してアプリケーションから開いたファイルが含まれています。これらのリストは、次のメソッドを使用して実行時に変更することができます: AddToRecent、RemoveFromRecent、RemoveAllFromRecent。これらのメソッドは両リストに効果があります。つまり、ファイル エントリを追加または削除すると、最近開いたファイルのリストと、よく開くファイルのリストの両方に対して、それを追加または削除することになります。これらのリストの一方のみに対して、ファイル エントリを追加または削除することはできません。
メモ: アプリケーションの最近開いたファイルのリストとよく開くファイルのリストは、デフォルトで無効になっています。最近開いたファイルやよく開くファイルをアプリケーションのジャンプ リストに表示できるようにするには、アプリケーションが次の要件のどちらか一方を満たす必要があります。
- アプリケーションのユーザーが、アプリケーションを使用して最低 1 つファイルを開いている。
- システム上の 1 つまたは複数のファイル タイプに対して、アプリケーションをそのファイルの処理アプリケーションとして登録してある。
アプリケーションが複数のプロセスから構成されている場合、ApplicationID プロパティを使用して、アプリケーションのすべてのプロセスに対する共通ジャンプ リストを保持することができます。アプリケーションがすでにアプリケーション ユーザー モデル ID を使用している場合、ApplicationID をアプリケーションの ID で設定します。
アプリケーションのインスタンスを同時に複数実行できる場合には、2 つのインスタンスが同時にアプリケーション ジャンプ リストを変更しないよう、なんらかのメカニズムを実装する必要があります。そうでなければ、アプリケーションのあるインスタンスによるジャンプ リストへの変更が、アプリケーションの別のインスタンスによるジャンプ リストへの変更で、上書きされてしまいます。
関連項目
- ジャンプ リスト(Windows ドキュメント)
- JumpListTest(Delphi)