AppBarToggleButton.DynamicOverflowOrder プロパティ

定義

名前空間:

Microsoft.UI.Xaml.Controls

この項目を CommandBar オーバーフロー メニューに移動する順序を取得または設定します。

public:
 property int DynamicOverflowOrder { int get(); void set(int value); };

int DynamicOverflowOrder();

void DynamicOverflowOrder(int value);

public int DynamicOverflowOrder { get; set; }

var int32 = appBarToggleButton.dynamicOverflowOrder;
appBarToggleButton.dynamicOverflowOrder = int32;

Public Property DynamicOverflowOrder As Integer

<AppBarToggleButton DynamicOverflowOrder="int" .../>

プロパティ値

Int32

int

この項目を他の項目に対して相対的にオーバーフロー メニューに移動する順序。

実装

DynamicOverflowOrder

注釈

詳細とガイドラインについては、 コマンド バー の記事を参照してください。

Windows 10 バージョン 1607 以降、CommandBar には動的オーバーフロー機能が導入されています。 既定では、 PrimaryCommands は、ユーザーがアプリ ウィンドウのサイズを変更した場合など、コマンド バーの幅が変わるとオーバーフロー領域に自動的に移動します。 この動作を無効にするには、 IsDynamicOverflowEnabled プロパティを false に設定できます。

動的オーバーフローは、コマンドの UI プレゼンテーションにのみ影響します。 PrimaryCommands コレクションから SecondaryCommands にコマンドを移動しません。

このプロパティは、この要素が CommandBar.PrimaryCommands コレクション内にあり、 CommandBar.IsDynamicOverflowEnabled が true の場合にのみ有効です。

同じ DynamicOverflowOrder 値を複数の要素に割り当てることができます。 同じ値を持つ要素は、オーバーフロー領域内とオーバーフロー領域の間で同時に移動します。

バージョンの互換性

DynamicOverflowOrder プロパティは、Windows 10 バージョン 1607 より前は使用できません。 Microsoft Visual Studio のアプリの "最小プラットフォーム バージョン" 設定が、このページの後半の 「要件」 ブロックに示されている "導入されたバージョン" より小さい場合は、これを考慮してアプリを設計してテストする必要があります。 詳細については、「 バージョン アダプティブ コード」を参照してください。

注意

動的オーバーフローは、アプリがWindows 10バージョン 1607 用にコンパイルされ、バージョン 1607 (以降) で実行されている場合に使用できます。 動的オーバーフローは、アプリが以前のバージョン用にコンパイルされている場合、または以前のバージョンで実行されている場合は使用できません。

以前のバージョンのWindows 10でアプリを実行するときに例外を回避するには、XAML でこのプロパティを設定したり、ランタイム チェックを実行せずに使用したりしないでください。 この例では、ApiInformation クラスを使用して、このプロパティを設定する前に、このプロパティの存在をチェックする方法を示します。

<CommandBar x:Name="commandBar1" Loaded="CommandBar_Loaded">
    <AppBarToggleButton x:Name="appBarButtonShuffle" Icon="Shuffle" Label="Shuffle"/>
    <AppBarToggleButton x:Name="appBarButtonRepeat" Icon="RepeatAll" Label="Repeat"/>
</CommandBar>

private void CommandBar_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.AppBarToggleButton", "DynamicOverflowOrder"))
    {
        commandBar1.IsDynamicOverflowEnabled = true;
        appBarButtonShuffle.DynamicOverflowOrder = 1;
        appBarButtonRepeat.DynamicOverflowOrder = 2;
    }
}