CommandBarFlyout クラス

定義

AppBarButton と関連するコマンド要素のレイアウトを提供する特殊なポップアップを表します。

UWP 用の同等の WinUI 2 API: Microsoft.UI.Xaml.Controls.CommandBarFlyout (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="PrimaryCommands")]
class CommandBarFlyout : FlyoutBase
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.UI.Xaml.Markup.ContentProperty(Name="PrimaryCommands")]
public class CommandBarFlyout : FlyoutBase
Public Class CommandBarFlyout
Inherits FlyoutBase
<CommandBarFlyout .../>
-or-
<CommandBarFlyout>
  commandBarElements
</CommandBarFlyout>
継承
Object IInspectable DependencyObject FlyoutBase CommandBarFlyout
派生
属性

Windows の要件

デバイス ファミリ
Windows 10, version 1809 (10.0.17763.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v7.0 で導入)

ヒント

詳細、設計ガイダンス、およびコード例については、「 コマンド バーのポップアップ」を参照してください。

WinUI 2 ギャラリー アプリがインストールされている場合は、ここをクリックしてアプリを開き、CommandBarFlyout の動作を確認します

注釈

コントロール のスタイルとテンプレート

既定の StyleControlTemplate を変更して、コントロールに一意の外観を与えることができます。 コントロールのスタイルとテンプレートの変更の詳細については、「コントロールの スタイル設定」を参照してください。 コントロールの外観を定義する既定のスタイル、テンプレート、およびリソースがファイルに generic.xaml 含まれます。 設計上の目的で、 generic.xaml は SDK または NuGet パッケージのインストールでローカルで使用できます。

  • *WinUI スタイル (推奨):Microsoft.UI.Xaml.Controls.CommandBarFlyout を使用します。
  • WinUI 以外のスタイル: 組み込みのスタイルについては、「」を参照してください %ProgramFiles(x86)%\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP\<SDK version>\Generic\generic.xaml

インストールをカスタマイズした場合、場所が異なる場合があります。 SDK の異なるバージョンのスタイルとリソースの値が異なる場合があります。

XAML には、コントロール テンプレートを変更せずに、さまざまなビジュアル状態でコントロールの色を変更するために使用できるリソースも含まれています。 これらのリソースの変更は、 Background や Foreground などのプロパティを設定する場合に推奨 されます。 詳細については、XAML スタイルに関する記事の「軽量のスタイル設定」セクションを参照してください。 軽量のスタイル設定リソースは、Windows 10 バージョン 1607 (SDK 14393) 以降で使用できます。

コンストラクター

CommandBarFlyout()

CommandBarFlyout クラスの新しいインスタンスを初期化します。

UWP 用の同等の WinUI 2 API: Microsoft.UI.Xaml.Controls.CommandBarFlyout.-ctor (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

プロパティ

AllowFocusOnInteraction

ユーザーが操作するときに要素が自動的にフォーカスを取得するかどうかを示す値を取得または設定します。

(継承元 FlyoutBase)
AllowFocusWhenDisabled

コントロールが無効になっているときにフォーカスを受け取ることができるかどうかを示す値を取得または設定します。

(継承元 FlyoutBase)
AreOpenCloseAnimationsEnabled

ポップアップを開くか閉じたときにアニメーションを再生するかを示す値を取得または設定します。

(継承元 FlyoutBase)
Dispatcher

このオブジェクトが関連付けられている CoreDispatcher を取得します。 CoreDispatcher は、コードが UI 以外のスレッドによって開始された場合でも、UI スレッド上の DependencyObject にアクセスできる機能を表します。

(継承元 DependencyObject)
ElementSoundMode

サウンドを再生するかどうかのコントロールの設定を指定する値を取得または設定します。

(継承元 FlyoutBase)
InputDevicePrefersPrimaryCommands

ポップアップを開くために使用される入力デバイスがセカンダリ コマンドを簡単に開かないかどうかを示す値を取得します。

(継承元 FlyoutBase)
IsConstrainedToRootBounds

ポップアップが XAML ルートの境界内に表示されるかどうかを示す値を取得します。

(継承元 FlyoutBase)
IsOpen

ポップアップが開いているかどうかを示す値を取得します。

(継承元 FlyoutBase)
LightDismissOverlayMode

ライトを閉じる UI の外側の領域を暗くするかどうかを指定する値を取得または設定します。

(継承元 FlyoutBase)
OverlayInputPassThroughElement

ポップアップのオーバーレイの下にある場合でも、ポインター入力イベントを受け取る要素を取得または設定します。

(継承元 FlyoutBase)
Placement

ポップアップの配置ターゲットに対して使用される既定の配置を取得または設定します。

(継承元 FlyoutBase)
PrimaryCommands

CommandBarFlyout のプライマリ コマンド要素のコレクションを取得します。

UWP 用の同等の WinUI 2 API: Microsoft.UI.Xaml.Controls.CommandBarFlyout.PrimaryCommands (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

SecondaryCommands

CommandBarFlyout のセカンダリ コマンド要素のコレクションを取得します。

UWP 用の同等の WinUI 2 API: Microsoft.UI.Xaml.Controls.CommandBarFlyout.SecondaryCommands (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

ShouldConstrainToRootBounds

ポップアップを XAML ルートの境界内に表示するかどうかを示す値を取得または設定します。

(継承元 FlyoutBase)
ShowMode

表示時のポップアップの動作を示す値を取得または設定します。

(継承元 FlyoutBase)
Target

ポップアップの配置ターゲットとして使用する要素を取得します。

(継承元 FlyoutBase)
XamlRoot

このポップアップを表示する XamlRoot を取得または設定します。

(継承元 FlyoutBase)

メソッド

ClearValue(DependencyProperty)

依存関係プロパティのローカル値をクリアします。

(継承元 DependencyObject)
CreatePresenter()

派生クラスでオーバーライドされると、派生コントロールに適したポップアップ コンテンツを表示するようにコントロールを初期化します。 注: このメソッドには基底クラスの実装がなく、派生クラスでオーバーライドする必要があります。

(継承元 FlyoutBase)
GetAnimationBaseValue(DependencyProperty)

依存関係プロパティに対して確立された基本値を返します。これは、アニメーションがアクティブでない場合に適用されます。

(継承元 DependencyObject)
GetValue(DependencyProperty)

DependencyObject から依存関係プロパティの現在の有効な値を返します。

(継承元 DependencyObject)
Hide()

ポップアップを閉じます。

(継承元 FlyoutBase)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

アプリでキーボード ショートカット (アクセラレータ) が処理される直前に呼び出されます。 アプリケーション コードまたは内部プロセスが ProcessKeyboardAccelerators を呼び出すたびに呼び出されます。 このメソッドをオーバーライドして、既定のアクセラレータ処理に影響を与えます。

(継承元 FlyoutBase)
ReadLocalValue(DependencyProperty)

ローカル値が設定されている場合は、依存関係プロパティのローカル値を返します。

(継承元 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

この DependencyObject インスタンスの特定の DependencyProperty に対する変更をリッスンするための通知関数を登録します。

(継承元 DependencyObject)
SetValue(DependencyProperty, Object)

DependencyObject の依存関係プロパティのローカル値を設定します。

(継承元 DependencyObject)
ShowAt(DependencyObject, FlyoutShowOptions)

指定したオプションを使用して、指定した要素に対して配置されたポップアップを表示します。

(継承元 FlyoutBase)
ShowAt(FrameworkElement)

指定した要素に対して配置されたポップアップを表示します。

(継承元 FlyoutBase)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

キーボード ショートカット (アクセラレータ) を呼び出そうとします。

(継承元 FlyoutBase)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

RegisterPropertyChangedCallback を呼び出して以前に登録した変更通知を取り消します。

(継承元 DependencyObject)

イベント

Closed

ポップアップが非表示のときに発生します。

(継承元 FlyoutBase)
Closing

ポップアップが非表示になり始めると発生します。

(継承元 FlyoutBase)
Opened

ポップアップが表示されるときに発生します。

(継承元 FlyoutBase)
Opening

ポップアップが表示される前に発生します。

(継承元 FlyoutBase)

適用対象