ShareWindowCommandSource クラス

定義

ウィンドウ共有を開始および停止するための UI を表示するために、通信アプリが Window Shell との通信を設定するために使用できるオブジェクトを表します。

ShareWindowCommandSource のインスタンスを取得し、 を登録して、インスタンスの ShareWindowCommandSource.CommandRequested イベントと ShareWindowCommandSource.CommandInvoked イベントを処理します。 これらのイベントは、Windows シェルによって発生します。

重要

Windows.UI.Shell.ShareWindowCommandSource API は、制限付きアクセス機能の一部です (「LimitedAccessFeatures クラス」を参照してください)。 詳細またはロック解除トークンを要求するには、Microsoft サポートにお問い合わせください。

public ref class ShareWindowCommandSource sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 851968)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ShareWindowCommandSource final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 851968)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ShareWindowCommandSource
Public NotInheritable Class ShareWindowCommandSource
継承
Object Platform::Object IInspectable ShareWindowCommandSource
属性

Windows の要件

デバイス ファミリ
Windows 11 (10.0.22000.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v14.0 で導入)

注釈

この機能により、アプリケーションで既に実装されているウィンドウ共有機能が拡張され、ウィンドウを選択するための別の方法が提供されます。 この設計により、アプリで共有を開始し、共有を停止するコマンドを表示できます。と を使用して、1 つ以上のウィンドウを共有するアプリの機能に対応する方法で実装します。

通信アプリは、ウィンドウ (単一アプリ ウィンドウ、または通信セッション (呼び出し) をホストするウィンドウ) を共有する機能に対応するウィンドウを識別します。 Windows シェルでは、これを使用して次の処理を行います。

  • 共有コマンドと共に表示される、アイコンや名前などのアプリケーション識別情報を取得します。
  • 複数の共有コマンド ソースから選択します。 最近使用した共有アプリが選択されます。

イベントは、コマンドを要求し、それらを呼び出すために使用されます。これには、共有するウィンドウの WindowId が含まれます。

IShareWindowCommandSourceInterop は、 ShareWindowCommandSource オブジェクトを取得できるネイティブ相互運用インターフェイスです。

メソッド

GetForCurrentView()

ShareWindowCommandSource のインスタンスを取得するために使用できる静的メソッド。

重要

ShareWindowCommandSource.GetForCurrentView API は、制限付きアクセス機能の一部です (「LimitedAccessFeatures クラス」を参照してください)。 詳細またはロック解除トークンを要求するには、Microsoft サポートにお問い合わせください。

ReportCommandChanged()

通信アプリの共有状態が変更されたことを Windows シェルに示します。

通信アプリの共有状態が変更されるたびに、このメソッドを呼び出します。 通話または会議で新しいウィンドウを正常に共有した場合、または既に共有されているウィンドウを削除した場合 (独自の UI を使用するか、Windows タスク バー アクションによってトリガーされるかにかかわらず)、ReportCommandChanged を呼び出して、その変更を ShareWindowCommandSource インスタンスに通知する必要があります。

その後、シェルは ShareWindowCommandSource.CommandRequested イベントの一部として受信した情報をフラッシュし、表示されている共有コマンドをアプリの現在の状態に合わせて更新します。

Start()

呼び出し元のアプリが現在、ウィンドウ共有コマンドのソースであることを示します。 通話中または会議中にこのメソッドを呼び出して、通信アプリをウィンドウ共有コマンドのソースとして有効にします。

Stop()

呼び出し元のアプリがウィンドウ共有コマンドのソースではないことを示します。 通話または会議が終了すると、このメソッドを呼び出して、ウィンドウ共有コマンドのソースとして通信アプリを無効にします。

イベント

CommandInvoked

通信アプリが特定のウィンドウの共有を実際に開始または停止する機会を提供するために Windows シェルによって発生するイベント。

CommandRequested

特定のウィンドウの共有の開始または停止をサポートする機会を通信アプリに提供するために、Windows シェルによって発生するイベント。

適用対象

こちらもご覧ください