AutoSuggestBox クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
キーボードまたはペン (インクと手書き認識を使用) を使用してテキストを入力する際にユーザーに提案を行うテキスト コントロールを表します。 ユーザーによってテキストが変更されると、アプリに通知され、このコントロールを表示するための関連する提案を提供する責任があります。
public ref class AutoSuggestBox sealed : ItemsControl/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AutoSuggestBox final : ItemsControl/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class AutoSuggestBox final : ItemsControl[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutoSuggestBox : ItemsControl[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class AutoSuggestBox : ItemsControlPublic NotInheritable Class AutoSuggestBox
Inherits ItemsControl<AutoSuggestBox .../>
- 継承
-
Object Platform::Object IInspectable DependencyObject UIElement FrameworkElement Control ItemsControl AutoSuggestBox
- 属性
Windows の要件
| デバイス ファミリ |
Windows 10 (10.0.10240.0 で導入)
|
| API contract |
Windows.Foundation.UniversalApiContract (v1.0 で導入)
|
例
ヒント
詳細、設計ガイダンス、およびコード例については、「 自動提案ボックス」を参照してください。
WinUI 2 ギャラリー アプリには、ほとんどの WinUI 2 コントロールと機能の対話型の例が含まれています。 Microsoft Store からアプリを入手するか、GitHub でソース コードを取得します。
必須のイベント ハンドラーを使った簡単な AutoSuggestBox を次に示します。
<AutoSuggestBox PlaceholderText="Search" QueryIcon="Find" Width="200"
TextChanged="AutoSuggestBox_TextChanged"
QuerySubmitted="AutoSuggestBox_QuerySubmitted"
SuggestionChosen="AutoSuggestBox_SuggestionChosen"/>
private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
{
// Only get results when it was a user typing,
// otherwise assume the value got filled in by TextMemberPath
// or the handler for SuggestionChosen.
if (args.Reason == AutoSuggestionBoxTextChangeReason.UserInput)
{
//Set the ItemsSource to be your filtered dataset
//sender.ItemsSource = dataset;
}
}
private void AutoSuggestBox_SuggestionChosen(AutoSuggestBox sender, AutoSuggestBoxSuggestionChosenEventArgs args)
{
// Set sender.Text. You can use args.SelectedItem to build your text string.
}
private void AutoSuggestBox_QuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuerySubmittedEventArgs args)
{
if (args.ChosenSuggestion != null)
{
// User selected an item from the suggestion list, take an action on it here.
}
else
{
// Use args.QueryText to determine what to do.
}
}
注釈
ヒント
詳細、設計ガイダンス、およびコード例については、「 自動提案ボックス」を参照してください。
AutoSuggestBox を使って、ユーザーが入力と同時に選べる候補リストを表示します。
既定では、テキスト入力ボックスにはクエリ ボタンが表示されません。 QueryIcon プロパティを設定し、テキスト ボックスの右側に指定したアイコンが表示されるボタンを追加することができます。 たとえば、AutoSuggestBox を一般的な検索ボックスと同様の外観にするには、次のような "検索" アイコンを追加します。
<AutoSuggestBox QueryIcon="Find"/>
ここでは、AutoSuggestBox に "検索" アイコンが付いています。 候補リストには、ユーザーのエントリに基づいて提案された結果が表示されます。
AutoSuggestBox を使用するには、3 つのユーザー アクションに応答する必要があります。
- テキストの変更 - ユーザーがテキストを入力したときに、候補リストを更新します。
- 候補の選択 - ユーザーが候補リストで候補を選んだときに、テキスト ボックスを更新します。
- クエリの送信 - ユーザーがクエリを送信したときに、クエリの結果を表示します。
テキストの変更
テキスト ボックスの内容が更新されるたびに、TextChanged イベントが発生します。 イベント引数 Reason プロパティを使って、変更がユーザー入力によって生じたものかどうかを調べます。 変更の理由が UserInput の場合、入力に基づいてデータをフィルター処理します。 次に、フィルター処理されたデータを AutoSuggestBox の ItemsSource に設定し、候補リストを更新します。
候補リストでの項目の表示方法を制御するには、DisplayMemberPath または ItemTemplate を使うことができます。
- データ項目の 1 つのプロパティのテキストを表示するには、 DisplayMemberPath プロパティを設定して、提案リストに表示するオブジェクトのプロパティを選択します。
- リスト内の各項目のカスタム外観を定義するには、 ItemTemplate プロパティ を使用します。
候補の選択
ユーザーがキーボードを使って候補リスト内を移動したときは、テキスト ボックス内のテキストを更新して合わせる必要があります。
TextMemberPath プロパティを設定し、テキスト ボックスに表示するデータ オブジェクトのプロパティを選択します。 TextMemberPath を指定すると、テキスト ボックスは自動的に更新されます。 通常、 DisplayMemberPath と TextMemberPath に同じ値を指定して、候補リストとテキスト ボックス内のテキストが同じになるようにする必要があります。
単純ではないプロパティを表示する必要がある場合、SuggestionChosen イベントを処理し、選択した項目に基づいてカスタム テキストをテキスト ボックスに入力します。
クエリの送信
QuerySubmitted イベントを処理して、アプリに適したクエリ アクションを実行し、結果をユーザーに表示します。
QuerySubmitted イベントは、ユーザーがクエリ文字列をコミットしたときに発生します。 ユーザーは次のいずれかの方法でクエリをコミットできます。
- テキスト ボックスにフォーカスがある状態で、Enter キーを押すか、クエリ アイコンをクリックします。 イベント引数の ChosenSuggestion プロパティは null です。
- フォーカスが候補リストに表示されている間は、Enter キーを押し、項目をクリックまたはタップします。 イベント args SelectedSuggestion プロパティには、リストから選択された項目が含まれています。 いずれの場合も、イベント引数の QueryText プロパティにはテキスト ボックスのテキストが含まれています。
ユーザー補助
ナレーターなどの支援技術を使用して AutoSuggestBox と対話している場合は、アクセシビリティ エクスペリエンスが既にフックされています。 ユーザーは次の操作を行います。
- 一覧が存在していることと一覧が閉じるタイミングを把握する
- 利用可能な入力候補の数を把握する
- ナレーターのフォーカスを一覧に移動できる
- 他のすべての読み取りモードで候補間を移動できるようにする 詳細については、「 アクセシビリティの自動提案 」を参照してください。
ペン入力
Windows 10 バージョン 1803 以降では、XAML テキスト入力ボックスは、Windows Ink を使用したペン入力の埋め込みをサポートしています。 ユーザーが Windows ペンを使用してテキスト入力ボックスでタップすると、テキスト ボックスは変換され、ユーザーは別の入力パネルを開かなくても、ペンを使用して直接書き込むことができます。
ここに示すように、AutoSuggestBox の手書きビューは、TextBox コントロールを使用して構成できます。
<AutoSuggestBox Name="NoHandwritingAutoSuggestBox"
BorderThickness="0" Width="680"
FontSize="24" VerticalAlignment="Top"
HorizontalAlignment="Center"
PlaceholderText="Handwriting view is not supported">
<AutoSuggestBox.TextBoxStyle>
<Style TargetType="TextBox">
<Setter Property="IsHandwritingViewEnabled" Value="False"/>
</Style>
</AutoSuggestBox.TextBoxStyle>
</AutoSuggestBox>
詳細については、「手書きビューでのテキスト入力」をご覧ください。
コントロール のスタイルとテンプレート
既定の Style と ControlTemplate を変更して、コントロールに一意の外観を与えることができます。 コントロールのスタイルとテンプレートの変更の詳細については、「コントロールの スタイル設定」を参照してください。 コントロールの外観を定義する既定のスタイル、テンプレート、およびリソースがファイルに generic.xaml 含まれます。 設計上の目的で、 generic.xaml は SDK または NuGet パッケージのインストールでローカルで使用できます。
-
WinUI スタイル (推奨): WinUI から更新されたスタイルについては、「」を参照してください
\Users\<username>\.nuget\packages\microsoft.ui.xaml\<version>\lib\uap10.0\Microsoft.UI.Xaml\Themes\generic.xaml。 -
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) 以降で使用できます。
でTextControl始まるリソースは、TextBox、PasswordBox、RichEditBox、および AutoSuggestBoxによって共有されます。 これらのリソースに対する変更は、4 つのコントロールすべてに影響します。
バージョン履歴
| Windows のバージョン | SDK バージョン | 追加された値 |
|---|---|---|
| 1607 | 14393 | LightDismissOverlayMode |
| 1809 | 17763 | 説明 |
コンストラクター
| AutoSuggestBox() |
AutoSuggestBox クラスの新しいインスタンスを初期化します。 |
プロパティ
| AccessKey |
この要素のアクセス キー (ニーモニック) を取得または設定します。 (継承元 UIElement) |
| AccessKeyScopeOwner |
ソース要素のビジュアル ツリーにない場合でも、この要素のアクセス キー スコープを提供するソース要素を取得または設定します。 (継承元 UIElement) |
| ActualHeight |
FrameworkElement のレンダリングされた高さを取得します。 「解説」を参照してください。 (継承元 FrameworkElement) |
| ActualOffset |
レイアウト プロセスの配置パス中に計算された、親を基準としたこの UIElement の位置を取得します。 (継承元 UIElement) |
| ActualSize |
レイアウト プロセスの配置パス中にこの UIElement が計算したサイズを取得します。 (継承元 UIElement) |
| ActualTheme |
要素で現在使用されている UI テーマを取得します。 これは RequestedTheme とは異なる場合があります。 (継承元 FrameworkElement) |
| ActualWidth |
FrameworkElement のレンダリングされた幅を取得します。 「解説」を参照してください。 (継承元 FrameworkElement) |
| AllowDrop |
この UIElement をドラッグ アンド ドロップ操作の目的でドロップ ターゲットにできるかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| AllowFocusOnInteraction |
ユーザーが操作するときに要素が自動的にフォーカスを取得するかどうかを示す値を取得または設定します。 (継承元 FrameworkElement) |
| AllowFocusWhenDisabled |
無効なコントロールがフォーカスを受け取ることができるかどうかを取得または設定します。 (継承元 FrameworkElement) |
| AutoMaximizeSuggestionArea |
提案領域を自動的に最大化するかどうかを示します。 |
| AutoMaximizeSuggestionAreaProperty |
AutoMaximizeSuggestionArea 依存関係プロパティを識別します。 |
| Background |
コントロールの背景を提供するブラシを取得または設定します。 (継承元 Control) |
| BackgroundSizing |
この要素の境界線に対する背景の延長距離を示す値を取得または設定します。 (継承元 Control) |
| BaseUri |
XAML 読み込み時に XAML で構築されたオブジェクトのベース URI (Uniform Resource Identifier) を表す Uniform Resource Identifier (URI) を取得します。 このプロパティは、実行時の URI (Uniform Resource Identifier) 解決に役立ちます。 (継承元 FrameworkElement) |
| BorderBrush |
コントロールの境界線の塗りつぶしを表すブラシを取得または設定します。 (継承元 Control) |
| BorderThickness |
コントロールの境界線の太さを取得または設定します。 (継承元 Control) |
| CacheMode |
レンダリングされたコンテンツを可能な限り複合ビットマップとしてキャッシュする必要があることを示す値を取得または設定します。 (継承元 UIElement) |
| CanBeScrollAnchor |
UIElement をスクロール アンカーの候補にできるかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| CanDrag |
要素をドラッグ アンド ドロップ操作でデータとしてドラッグできるかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| CenterPoint |
要素の中心点 (回転またはスケーリングが発生するポイント) を取得または設定します。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| CharacterSpacing |
em の 1/1000 単位の文字間の均一な間隔を取得または設定します。 (継承元 Control) |
| Clip |
UIElement の内容のアウトラインを定義するために使用する RectangleGeometry を取得または設定します。 (継承元 UIElement) |
| CompositeMode |
親レイアウトとウィンドウ内の要素の代替合成モードとブレンド モードを宣言するプロパティを取得または設定します。 これは、混合 XAML/Microsoft DirectX UI に関連する要素に関連します。 (継承元 UIElement) |
| ContextFlyout |
この要素に関連付けられているポップアップを取得または設定します。 (継承元 UIElement) |
| CornerRadius |
コントロールの境界線の角の半径を取得または設定します。 (継承元 Control) |
| DataContext |
FrameworkElement のデータ コンテキストを取得または設定します。 データ コンテキストの一般的な用途は、 FrameworkElement が {Binding} マークアップ拡張機能を使用し、データ バインディングに参加する場合です。 (継承元 FrameworkElement) |
| DefaultStyleKey |
コントロールの既定のスタイルを参照するキーを取得または設定します。 カスタム コントロールの作成者は、このプロパティを使用して、コントロールが使用するスタイルの既定値を変更します。 (継承元 Control) |
| DefaultStyleResourceUri |
コントロールの既定のスタイルを含むリソース ファイルへのパスを取得または設定します。 (継承元 Control) |
| Description |
コントロールの下に表示されるコンテンツを取得または設定します。 コンテンツは、コントロールによって期待される入力に関するガイダンスを提供する必要があります。 |
| DescriptionProperty |
Description 依存関係プロパティを識別します。 |
| DesiredSize |
レイアウト プロセスのメジャー パス中にこの UIElement が計算したサイズを取得します。 (継承元 UIElement) |
| Dispatcher |
このオブジェクトが関連付けられている CoreDispatcher を取得します。 CoreDispatcher は、コードが UI 以外のスレッドによって開始された場合でも、UI スレッド上の DependencyObject にアクセスできる機能を表します。 (継承元 DependencyObject) |
| DisplayMemberPath |
各データ項目に表示されるプロパティの名前またはパスを取得または設定します。 (継承元 ItemsControl) |
| ElementSoundMode |
サウンドを再生するかどうかのコントロールの設定を指定する値を取得または設定します。 (継承元 Control) |
| ExitDisplayModeOnAccessKeyInvoked |
アクセス キーが呼び出されたときにアクセス キーの表示を閉じるかどうかを指定する値を取得または設定します。 (継承元 UIElement) |
| FlowDirection |
レイアウトを制御する任意の親要素内でテキストやその他の UI 要素が流れる方向を取得または設定します。 このプロパティは、 LeftToRight または RightToLeft のいずれかに設定できます。 任意の要素で FlowDirection を RightToLeft に設定すると、配置が右に設定され、読み取り順序が右から左に設定され、コントロールのレイアウトが右から左にフローします。 (継承元 FrameworkElement) |
| FocusState |
このコントロールにフォーカスがあるかどうかを示す値と、フォーカスが取得されたモードを取得します。 (継承元 Control) |
| FocusVisualMargin |
FrameworkElement のフォーカス ビジュアルの外側の余白を取得または設定します。 (継承元 FrameworkElement) |
| FocusVisualPrimaryBrush |
FrameworkElement の または |
| FocusVisualPrimaryThickness |
FrameworkElement の または フォーカス ビジュアルの外側の境界線の |
| FocusVisualSecondaryBrush |
FrameworkElement の または |
| FocusVisualSecondaryThickness |
FrameworkElement の または フォーカス ビジュアルの内側の境界線の |
| FontFamily |
コントロール内にテキストを表示するために使用されるフォントを取得または設定します。 (継承元 Control) |
| FontSize |
このコントロール内のテキストのサイズを取得または設定します。 (継承元 Control) |
| FontStretch |
画面上でのフォントの縮小率または拡大率を取得または設定します。 (継承元 Control) |
| FontStyle |
テキストをレンダリングするスタイルを取得または設定します。 (継承元 Control) |
| FontWeight |
指定したフォントの太さを取得または設定します。 (継承元 Control) |
| Foreground |
前景色を表すブラシを取得または設定します。 (継承元 Control) |
| GroupStyle |
グループの各レベルの外観を定義する GroupStyle オブジェクトのコレクションを取得します。 (継承元 ItemsControl) |
| GroupStyleSelector |
カスタム GroupStyleSelector ロジック クラスへの参照を取得または設定します。 GroupStyleSelector は、そのコンテンツの特性に基づいて、コンテンツに使用するさまざまな GroupStyle 値を返します。 (継承元 ItemsControl) |
| Header |
このコントロールのテキスト ボックス部分のヘッダー オブジェクトを取得または設定します。 |
| HeaderProperty |
Header 依存関係プロパティを識別します。 |
| Height |
FrameworkElement の推奨される高さを取得または設定します。 (継承元 FrameworkElement) |
| HighContrastAdjustment |
ハイ コントラスト テーマが有効になっている場合に、フレームワークが要素のビジュアル プロパティを自動的に調整するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| HorizontalAlignment |
パネルや項目コントロールなど、レイアウトの親で構成されている場合に FrameworkElement に適用される水平方向の配置特性を取得または設定します。 (継承元 FrameworkElement) |
| HorizontalContentAlignment |
コントロールのコンテンツの水平方向の配置を取得または設定します。 (継承元 Control) |
| IsAccessKeyScope |
要素が独自のアクセス キー スコープを定義するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| IsDoubleTapEnabled |
DoubleTapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsEnabled |
ユーザーがコントロールを操作できるかどうかを示す値を取得または設定します。 (継承元 Control) |
| IsFocusEngaged |
コントロールの境界内でフォーカスが制限されているかどうかを示す値を取得または設定します (ゲーム パッド/リモート操作の場合)。 (継承元 Control) |
| IsFocusEngagementEnabled |
コントロール境界内でフォーカスを制限できるかどうかを示す値を取得または設定します (ゲーム パッド/リモート操作の場合)。 (継承元 Control) |
| IsGrouping |
コントロールがグループ化を使用しているかどうかを示す値を取得します。 (継承元 ItemsControl) |
| IsHitTestVisible |
この UIElement の包含領域がヒット テストの true 値を返すことができるかどうかを取得または設定します。 (継承元 UIElement) |
| IsHoldingEnabled |
Holding イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsLoaded |
要素が要素ツリーに追加され、操作の準備ができているかどうかを示す値を取得します。 (継承元 FrameworkElement) |
| IsRightTapEnabled |
RightTapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsSuggestionListOpen |
AutoSuggestBox のドロップダウン部分が開いているかどうかを示すブール値を取得または設定します。 |
| IsSuggestionListOpenProperty |
IsSuggestionListOpen 依存関係プロパティを識別します。 |
| IsTabStop |
コントロールがタブ ナビゲーションに含まれるかどうかを示す値を取得または設定します。 (継承元 Control) |
| IsTapEnabled |
Tapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsTextScaleFactorEnabled |
システム テキスト サイズの設定を反映するように、自動テキストの拡大を有効にするかどうかを取得または設定します。 (継承元 Control) |
| ItemContainerGenerator |
この ItemsControl に関連付けられている ItemContainerGenerator を取得します。 (継承元 ItemsControl) |
| ItemContainerStyle |
ItemsControl の項目コンテナーをレンダリングするときに使用するスタイルを取得または設定します。 (継承元 ItemsControl) |
| ItemContainerStyleSelector |
カスタム StyleSelector ロジック クラスへの参照を取得または設定します。 StyleSelector は、表示されるオブジェクトの特性に基づいて、項目コンテナーに使用するさまざまな Style 値を返します。 (継承元 ItemsControl) |
| ItemContainerTransitions |
ItemsControl の項目コンテナーに適用される Transition スタイル要素のコレクションを取得または設定します。 (継承元 ItemsControl) |
| Items |
コントロールの内容を生成するために使用されるコレクションを取得します。 (継承元 ItemsControl) |
| ItemsPanel |
項目のレイアウトを制御するパネルを定義するテンプレートを取得または設定します。 (継承元 ItemsControl) |
| ItemsPanelRoot |
ItemsPanel で指定されたパネルを取得します。 (継承元 ItemsControl) |
| ItemsSource |
ItemsControl のコンテンツの生成に使用するオブジェクト ソースを取得または設定します。 (継承元 ItemsControl) |
| ItemTemplate |
各項目の表示に使用する DataTemplate を取得または設定します。 (継承元 ItemsControl) |
| ItemTemplateSelector |
カスタム DataTemplateSelector ロジック クラスへの参照を取得または設定します。 このプロパティによって参照される DataTemplateSelector は、アイテムに適用するテンプレートを返します。 (継承元 ItemsControl) |
| KeyboardAcceleratorPlacementMode |
コントロール のヒント に、関連付けられているキーボード アクセラレータのキーの組み合わせを表示するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| KeyboardAcceleratorPlacementTarget |
アクセラレータ キーの組み合わせを表示 するコントロールヒント を示す値を取得または設定します。 (継承元 UIElement) |
| KeyboardAccelerators |
キーボードを使用してアクションを呼び出すキーの組み合わせのコレクションを取得します。 アクセラレータは通常、ボタンまたはメニュー項目に割り当てられます。
|
| KeyTipHorizontalOffset |
UIElement に関連してキー ヒントを左右に配置する距離を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipPlacementMode |
アクセス キーのキー ヒントが UIElement の境界に対して配置される場所を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipTarget |
アクセス キーのキー ヒントの対象となる要素を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipVerticalOffset |
UI 要素に関連してキー ヒントを配置する距離を示す値を取得または設定します。 (継承元 UIElement) |
| Language |
FrameworkElement に適用されるローカライズ/グローバリゼーション言語情報と、オブジェクト表現と UI の現在の FrameworkElement のすべての子要素を取得または設定します。 (継承元 FrameworkElement) |
| LightDismissOverlayMode |
ライト無視 UI の外側の領域を暗くするかどうかを指定する値を取得または設定します。 |
| LightDismissOverlayModeProperty |
LightDismissOverlayMode 依存関係プロパティを識別します。 |
| Lights |
この要素にアタッチされている XamlLight オブジェクトのコレクションを取得します。 (継承元 UIElement) |
| ManipulationMode |
UIElement の動作とジェスチャとの対話に使用される ManipulationModes 値を取得または設定します。 この値を設定すると、アプリ コードでこの要素から操作イベントを処理できます。 (継承元 UIElement) |
| Margin |
FrameworkElement の外側の余白を取得または設定します。 (継承元 FrameworkElement) |
| MaxHeight |
FrameworkElement の最大高さ制約を取得または設定します。 (継承元 FrameworkElement) |
| MaxSuggestionListHeight |
AutoSuggestBox コントロールのドロップダウン部分の最大高さを取得または設定します。 |
| MaxSuggestionListHeightProperty |
MaxSuggestionListHeight 依存関係プロパティを識別します。 |
| MaxWidth |
FrameworkElement の最大幅制約を取得または設定します。 (継承元 FrameworkElement) |
| MinHeight |
FrameworkElement の最小高さ制約を取得または設定します。 (継承元 FrameworkElement) |
| MinWidth |
FrameworkElement の最小幅制約を取得または設定します。 (継承元 FrameworkElement) |
| Name |
オブジェクトの識別名を取得または設定します。 XAML プロセッサが XAML マークアップからオブジェクト ツリーを作成する場合、ランタイム コードはこの名前で XAML で宣言されたオブジェクトを参照できます。 (継承元 FrameworkElement) |
| Opacity |
オブジェクトの不透明度の程度を取得または設定します。 (継承元 UIElement) |
| OpacityTransition |
Opacity プロパティへの変更をアニメーション化する ScalarTransition を取得または設定します。 (継承元 UIElement) |
| Padding |
コントロールのパディングを取得または設定します。 (継承元 Control) |
| Parent |
オブジェクト ツリー内のこの FrameworkElement の親オブジェクトを取得します。 (継承元 FrameworkElement) |
| PlaceholderText |
コントロールに表示するプレースホルダー テキストを取得または設定します。 |
| PlaceholderTextProperty |
PlaceholderText 依存関係プロパティを識別します。 |
| PointerCaptures |
Pointer 値として表されるすべてのキャプチャされたポインターのセット を取得します 。 (継承元 UIElement) |
| Projection |
この要素をレンダリングするときに適用するパースペクティブ プロジェクション (3-D 効果) を取得または設定します。 (継承元 UIElement) |
| QueryIcon |
クエリを開始するためにクリックされるボタンのグラフィック コンテンツを取得または設定します。 |
| QueryIconProperty |
QueryIcon 依存関係プロパティを識別します。 |
| RenderSize |
UIElement の最終的なレンダリング サイズを取得します。 使用は推奨されません。「解説」を参照してください。 (継承元 UIElement) |
| RenderTransform |
UIElement のレンダリング位置に影響する変換情報を取得または設定します。 (継承元 UIElement) |
| RenderTransformOrigin |
UIElement の境界を基準にして、RenderTransform によって宣言された可能なレンダー変換の原点を取得または設定します。 (継承元 UIElement) |
| RequestedTheme |
リソースを決定するために UIElement (およびその子要素) によって使用される UI テーマを取得または設定します。 RequestedTheme で指定した UI テーマは、アプリ レベルの RequestedTheme をオーバーライドできます。 (継承元 FrameworkElement) |
| RequiresPointer |
UI 要素がマウス モードをサポートするかどうかを取得または設定します。これは、ゲーム パッドやリモート コントロールなどの非ポインター入力デバイスでのポインター操作エクスペリエンスをエミュレートします。 (継承元 Control) |
| Resources |
ローカルで定義されたリソース ディクショナリを取得します。 XAML では、XAML の暗黙的なコレクション構文を使用して、プロパティ要素の |
| Rotation |
時計回りの回転角度を度単位で取得または設定します。 RotationAxis と CenterPoint を基準にして回転します。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| RotationAxis |
要素を回転させる軸を取得または設定します。 (継承元 UIElement) |
| RotationTransition |
Rotation プロパティの変更をアニメーション化する ScalarTransition を取得または設定します。 (継承元 UIElement) |
| Scale |
要素のスケールを取得または設定します。 要素の CenterPoint を基準にスケールします。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| ScaleTransition |
Scale プロパティの変更をアニメーション化する Vector3Transition を取得または設定します。 (継承元 UIElement) |
| Shadow |
要素によってキャストされる影の効果を取得または設定します。 (継承元 UIElement) |
| Style |
レイアウトとレンダリング中にこのオブジェクトに適用されるインスタンス Style を取得または設定します。 (継承元 FrameworkElement) |
| TabFocusNavigation |
このコントロールのタブと TabIndex の動作方法を変更する値を取得または設定します。 (継承元 UIElement) |
| TabIndex |
ユーザーが Tab キーを使用してアプリ UI を移動したときに要素がフォーカスを受け取る順序を示す値を取得または設定します。 (継承元 Control) |
| TabNavigation |
このコントロールのタブと TabIndex の動作方法を変更する値を取得または設定します。 注意 Windows 10 Creators Update (ビルド 10.0.15063) 以降では、UiElement 基本クラスで TabFocusNavigation プロパティを使用して、ControlTemplate を使用しないオブジェクトをタブ シーケンスに含めることができます。 |
| Tag |
このオブジェクトに関するカスタム情報を格納するために使用できる任意のオブジェクト値を取得または設定します。 (継承元 FrameworkElement) |
| Template |
コントロール テンプレートを取得または設定します。 コントロール テンプレートは、UI でのコントロールの視覚的な外観を定義し、XAML マークアップで定義されています。 (継承元 Control) |
| Text |
コントロールに表示されるテキストを取得または設定します。 |
| TextBoxStyle |
自動提案テキスト ボックスのスタイルを取得または設定します。 |
| TextBoxStyleProperty |
TextBoxStyle 依存関係プロパティを識別します。 |
| TextMemberPath |
項目が選択されている場合に AutoSuggestBox コントロールのテキスト ボックス部分に表示する値を取得するために使用されるプロパティ パスを取得または設定します。 |
| TextMemberPathProperty |
TextMemberPath 依存関係プロパティを識別します。 |
| TextProperty |
PlaceholderText 依存関係プロパティを識別します。 |
| Transform3D |
この要素をレンダリングするときに適用する 3-D 変換効果を取得または設定します。 (継承元 UIElement) |
| TransformMatrix |
要素に適用する変換マトリックスを取得または設定します。 (継承元 UIElement) |
| Transitions |
UIElement に適用される Transition スタイル要素のコレクションを取得または設定します。 (継承元 UIElement) |
| Translation |
要素の x、y、z のレンダリング位置を取得または設定します。 (継承元 UIElement) |
| TranslationTransition |
Translation プロパティの変更をアニメーション化する Vector3Transition を取得または設定します。 (継承元 UIElement) |
| Triggers |
FrameworkElement に対して定義されているアニメーションのトリガーのコレクションを取得します。 一般的に使用されません。 「解説」を参照してください。 (継承元 FrameworkElement) |
| UIContext |
要素のコンテキスト識別子を取得します。 (継承元 UIElement) |
| UpdateTextOnSelect |
TextMemberPath と組み合わせて使用され、ビュー内の項目がクリックされたときに AutoSuggestBox の編集可能なテキスト部分の更新をトリガーするかどうかを示す値を取得または設定します。 |
| UpdateTextOnSelectProperty |
UpdateTextOnSelect 依存関係プロパティを識別します。 |
| UseLayoutRounding |
オブジェクトとそのビジュアル サブツリーのレンダリングで、レンダリングをピクセル全体に合わせた丸め動作を使用するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| UseSystemFocusVisuals |
システムによって描画されるフォーカス ビジュアルをコントロールで使用するか、コントロール テンプレートで定義されたビジュアルを使用するかを示す値を取得または設定します。 (継承元 Control) |
| VerticalAlignment |
パネルや項目コントロールなどの親オブジェクトで構成されている場合に FrameworkElement に適用される垂直方向の配置特性を取得または設定します。 (継承元 FrameworkElement) |
| VerticalContentAlignment |
コントロールのコンテンツの垂直方向の配置を取得または設定します。 (継承元 Control) |
| Visibility |
UIElement の可視性を取得または設定します。 表示されない UIElement はレンダリングされず、目的のサイズをレイアウトに伝達しません。 (継承元 UIElement) |
| Width |
FrameworkElement の幅を取得または設定します。 (継承元 FrameworkElement) |
| XamlRoot |
この要素が表示される を |
| XYFocusDown |
ユーザーが方向パッド (D パッド) を押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 Control) |
| XYFocusDownNavigationStrategy |
ダウン ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusKeyboardNavigation |
キーボード方向矢印を使用してナビゲーションを有効または無効にする値を取得または設定します。 (継承元 UIElement) |
| XYFocusLeft |
ユーザーが方向パッド (D パッド) を左に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 Control) |
| XYFocusLeftNavigationStrategy |
左側のナビゲーションのターゲット要素を決定するために使用される戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusRight |
ユーザーが方向パッド (D パッド) を右に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 Control) |
| XYFocusRightNavigationStrategy |
右ナビゲーションのターゲット要素を決定するために使用される戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusUp |
ユーザーが方向パッド (D パッド) を上に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 Control) |
| XYFocusUpNavigationStrategy |
アップ ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
メソッド
イベント
| AccessKeyDisplayDismissed |
アクセス キーが表示されなくなったときに発生します。 (継承元 UIElement) |
| AccessKeyDisplayRequested |
ユーザーがアクセス キーの表示を要求したときに発生します。 (継承元 UIElement) |
| AccessKeyInvoked |
ユーザーがアクセス キー シーケンスを完了したときに発生します。 (継承元 UIElement) |
| ActualThemeChanged |
ActualTheme プロパティの値が変更されたときに発生します。 (継承元 FrameworkElement) |
| BringIntoViewRequested |
この要素またはその子孫のいずれかで StartBringIntoView が呼び出されたときに発生します。 (継承元 UIElement) |
| CharacterReceived |
1 つの構成済み文字が入力キューによって受信されたときに発生します。 (継承元 UIElement) |
| ContextCanceled |
コンテキスト入力ジェスチャが操作ジェスチャに続き、コンテキスト ポップアップを開くべきではないことを要素に通知するときに発生します。 (継承元 UIElement) |
| ContextRequested |
ユーザーが右クリックなどのコンテキスト入力ジェスチャを完了したときに発生します。 (継承元 UIElement) |
| DataContextChanged |
FrameworkElement.DataContext プロパティの値が変更されたときに発生します。 (継承元 FrameworkElement) |
| DoubleTapped |
この要素のヒット テスト領域で、それ以外の方法でハンドルされない DoubleTap 相互作用が発生したときに発生します。 (継承元 UIElement) |
| DragEnter |
入力システムが、この要素をターゲットとして使用して基になるドラッグ イベントを報告するときに発生します。 (継承元 UIElement) |
| DragLeave |
入力システムが、この要素を原点として基になるドラッグ イベントを報告するときに発生します。 (継承元 UIElement) |
| DragOver |
この要素がドロップ先となる可能性のある、基になるドラッグ イベントを入力システムが報告したときに発生します。 (継承元 UIElement) |
| DragStarting |
ドラッグ操作が開始されたときに発生します。 (継承元 UIElement) |
| Drop |
入力システムがこの要素をドロップ先とするドロップ イベントを報告したときに発生します。 (継承元 UIElement) |
| DropCompleted |
ソースとしてこの要素を使用したドラッグ アンド ドロップ操作が終了したときに発生します。 (継承元 UIElement) |
| EffectiveViewportChanged |
FrameworkElement の有効なビューポートが変更されたときに発生します。 (継承元 FrameworkElement) |
| FocusDisengaged |
コントロールの境界からフォーカスが離されると発生します (ゲーム パッド/リモート操作の場合)。 (継承元 Control) |
| FocusEngaged |
コントロールの境界内でフォーカスが制限されている場合に発生します (ゲーム パッド/リモート操作の場合)。 (継承元 Control) |
| GettingFocus |
UIElement がフォーカスを受け取る前に発生します。 このイベントは、イベントがバブルしている間にフォーカスが移動されないように同期的に発生します。 (継承元 UIElement) |
| GotFocus |
UIElement がフォーカスを受け取ったときに発生します。 このイベントは非同期的に発生するため、バブルが完了する前にフォーカスを再び移動できます。 (継承元 UIElement) |
| Holding |
この要素のヒット テスト領域で、それ以外の場合はハンドルされない 保留 操作が発生したときに発生します。 (継承元 UIElement) |
| IsEnabledChanged |
IsEnabled プロパティが変更されたときに発生します。 (継承元 Control) |
| KeyDown |
UIElement にフォーカスがあるときにキーボード キーが押されたときに発生します。 (継承元 UIElement) |
| KeyUp |
UIElement にフォーカスがあるときにキーボード キーが解放されたときに発生します。 (継承元 UIElement) |
| LayoutUpdated |
レイアウト関連のプロパティが値を変更したり、レイアウトを更新するその他のアクションが原因で、ビジュアル ツリーのレイアウトが変更されたときに発生します。 (継承元 FrameworkElement) |
| Loaded |
FrameworkElement が構築され、オブジェクト ツリーに追加され、操作の準備ができたときに発生します。 (継承元 FrameworkElement) |
| Loading |
FrameworkElement の読み込みが開始されたときに発生します。 (継承元 FrameworkElement) |
| LosingFocus |
UIElement がフォーカスを失う前に発生します。 このイベントは、イベントがバブルしている間にフォーカスが移動されないように同期的に発生します。 (継承元 UIElement) |
| LostFocus |
UIElement がフォーカスを失ったときに発生します。 このイベントは非同期的に発生するため、バブルが完了する前にフォーカスを再び移動できます。 (継承元 UIElement) |
| ManipulationCompleted |
UIElement の操作が完了したときに発生します。 (継承元 UIElement) |
| ManipulationDelta |
操作中に入力デバイスが位置を変更したときに発生します。 (継承元 UIElement) |
| ManipulationInertiaStarting |
操作中に入力デバイスが UIElement オブジェクトとのコンタクトを失ったときと慣性が開始したときに発生します。 (継承元 UIElement) |
| ManipulationStarted |
入力デバイスが UIElement に対する操作を開始すると発生します。 (継承元 UIElement) |
| ManipulationStarting |
操作プロセッサを初めて作成するときに発生します。 (継承元 UIElement) |
| NoFocusCandidateFound |
ユーザーが (タブまたは方向矢印を使用して) フォーカスを移動しようとしたときに、フォーカス候補が移動方向に見つからないため、フォーカスが移動しない場合に発生します。 (継承元 UIElement) |
| PointerCanceled |
接触したポインターが異常に接触を失ったときに発生します。 (継承元 UIElement) |
| PointerCaptureLost |
この要素によって以前に保持されていたポインター キャプチャが別の要素または別の場所に移動したときに発生します。 (継承元 UIElement) |
| PointerEntered |
ポインターがこの要素のヒット テスト領域に入ったときに発生します。 (継承元 UIElement) |
| PointerExited |
ポインターがこの要素のヒット テスト領域から離れると発生します。 (継承元 UIElement) |
| PointerMoved |
ポインターがこの要素のヒット テスト領域内に残っている間にポインターが移動したときに発生します。 (継承元 UIElement) |
| PointerPressed |
ポインター デバイスがこの要素内で Press アクションを開始したときに発生します。 (継承元 UIElement) |
| PointerReleased |
この要素内で、以前に Press アクションを開始したポインター デバイスが解放されたときに発生します。 Press アクションの終了が PointerReleased イベントを発生させる保証はされないことに注意してください。他のイベントが発生する可能性があります。 詳細については、「解説」を参照してください。 (継承元 UIElement) |
| PointerWheelChanged |
ポインター ホイールのデルタ値が変更されたときに発生します。 (継承元 UIElement) |
| PreviewKeyDown |
UIElement にフォーカスがあるときにキーボード キーが押されたときに発生します。 (継承元 UIElement) |
| PreviewKeyUp |
UIElement にフォーカスがあるときにキーボード キーが解放されたときに発生します。 (継承元 UIElement) |
| ProcessKeyboardAccelerators |
キーボード ショートカット (またはアクセラレータ) が押されたときに発生します。 (継承元 UIElement) |
| QuerySubmitted |
ユーザーが検索クエリを送信するときに発生します。 |
| RightTapped |
ポインターが 要素の上にある間に右タップ入力刺激が発生したときに発生します。 (継承元 UIElement) |
| SizeChanged |
ActualHeight または ActualWidth プロパティが FrameworkElement の値を変更したときに発生します。 (継承元 FrameworkElement) |
| SuggestionChosen |
編集可能なコントロール コンポーネントのテキスト コンテンツが更新される前に発生します。 |
| Tapped |
この要素のヒット テスト領域で、それ以外の場合はハンドルされない Tap 操作が発生したときに発生します。 (継承元 UIElement) |
| TextChanged |
編集可能なコントロール コンポーネントのテキスト コンテンツが更新された後に発生します。 |
| Unloaded |
このオブジェクトがメイン オブジェクト ツリーに接続されなくなったときに発生します。 (継承元 FrameworkElement) |