TextBox クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
プレーン テキスト (1 行または複数行) の表示と編集に使用できるコントロールを表します。
/// [Microsoft.UI.Xaml.Controls.InputProperty(Name="Text")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextBox : Control
[Microsoft.UI.Xaml.Controls.InputProperty(Name="Text")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class TextBox : Control
Public Class TextBox
Inherits Control
<TextBox .../>
- 継承
- 属性
例
Tip
詳細、設計ガイダンス、およびコード例については、「 テキスト ボックス」を参照してください。
WinUI 3 ギャラリー アプリには、ほとんどの WinUI 3 コントロールと機能の対話型の例が含まれています。 Microsoft Store からアプリを入手するか、GitHub でソース コードを取得します。
この例では、ヘッダーとプレースホルダー テキストを含む TextBox を示します。 TextBox の テキスト は、ユーザーにあいさつ文を表示するために使用されます。
<StackPanel>
<TextBlock Text="What's your name?"/>
<StackPanel Orientation="Horizontal" Margin="0,20,0,20">
<TextBox x:Name="nameInput"
Header="Enter your name:" PlaceholderText="Name"
Width="300" HorizontalAlignment="Left"/>
<Button Content="Hello button" Click="Button_Click"/>
</StackPanel>
<TextBlock x:Name="greetingOutput"/>
</StackPanel>
private void Button_Click(object sender, RoutedEventArgs e)
{
greetingOutput.Text = "Hello, " + nameInput.Text + "!";
}
注釈
Tip
詳細、設計ガイダンス、およびコード例については、「 テキスト ボックス」を参照してください。
TextBox コントロールを使用すると、ユーザーはアプリにテキストを入力できます。 通常、1 行のテキストを取得するために使用されますが、複数行のテキストを取得するように構成できます。 テキストは、単純な均一なプレーンテキスト形式で画面に表示されます。
TextBox には、テキスト入力を簡略化できるさまざまな機能があります。
- キーボードまたはペンからのテキスト入力をサポートします (インクと手書き認識を使用)。
- テキストのコピーと貼り付けをサポートする、使い慣れた組み込みのコンテキスト メニューが付属しています。
- [すべてクリア] ボタンを使用すると、入力されたすべてのテキストをすばやく削除できます。
- スペル チェック機能も組み込まれており、既定で有効になっています。
XAML とコードで TextBox を作成する方法を次に示します。
<TextBox Width="500" Header="Notes" PlaceholderText="Type your notes here"/>
TextBox textBox = new TextBox();
textBox.Width = 500;
textBox.Header = "Notes";
textBox.PlaceholderText = "Type your notes here";
// Add the TextBox to the visual tree.
rootGrid.Children.Add(textBox);
結果の TextBox は次のようになります。 青い境界線は、TextBox にフォーカスがあることを示します。
TextBox は使用する適切なコントロールですか?
TextBox コントロールを使用すると、書式設定されていないテキストを表示および編集できます。 パスワードやその他の機密情報の入力を受け付ける編集可能なテキスト ボックスが必要な場合は、PasswordBox を参照してください。 検索語句を入力するためのテキスト ボックスが必要な場合は、AutoSuggestBox を参照してください。 書式を適用したテキストを入力または編集する必要がある場合は、RichEditBox を参照してください。
フォームのデータ入力に TextBox を使用する
TextBox を使用してフォームのデータ入力を受け入れ、 Text プロパティを使用して TextBox から完全なテキスト文字列を取得するのが一般的です。 通常、送信ボタン Click などのイベントを使用して Text プロパティにアクセスしますが、テキストが変更されたときに何かを行う必要がある場合 は、TextChanged イベントまたは TextChanging イベントを 処理できます。 TextBox にヘッダー (またはラベル) と PlaceholderText (または透かし) を追加して、ユーザーに TextBox の目的を示すことができます。 ヘッダーの外観をカスタマイズするには、Header ではなく HeaderTemplate プロパティを設定します。 デザイン情報については、「 ラベルのガイドライン」を参照してください。
MaxLength プロパティを設定することによって、ユーザーが入力する文字数を制限できます。 ただし、 MaxLength は貼り付けたテキストの長さを制限しません。 アプリでこれが重要である場合は、Paste イベントを使用して、貼り付けられたテキストを変更します。
TextBox には、ボックスにテキストが入力されたときに表示されるすべての クリア ボタン ("x") が含まれています。 ユーザーが "x" をクリックすると、TextBox 内のテキストがクリアされます。 次のようになります。
[ すべてクリア] ボタンは、テキストを含み、フォーカスがある編集可能な 1 行のテキスト ボックスに対してのみ表示されます。 [ すべてクリア] ボタンは、次のどの場合にも表示されません。
- IsReadOnly が true である
- AcceptsReturn が true である
- TextWrapping がラップされる
TextBox を読み取り専用にする
IsReadOnly プロパティを true に設定すると、TextBox を読み取り専用にすることができます。 たとえば、ユーザーがコメントを入力するための TextBox が特定の条件下でのみ有効になるとします。 条件が満たされるまでは、TextBox を読み取り専用にすることができます。 テキストのみを表示する必要がある場合は、代わりに TextBlock または RichTextBlock を使用することを検討してください。
複数行入力の有効化
TextBox が複数の行にテキストを表示するかどうかを制御する 2 つのプロパティがあります。
- テキスト ボックスで改行文字の入力を受け付けて表示するには、AcceptsReturn プロパティを true に設定します。
- テキストの折り返しを有効にするには、TextWrapping プロパティを Wrap に設定します。 (TextBox は TextWrapping.WrapWholeWords 列挙値をサポートしていません)。)複数行の TextBox は、 Height プロパティまたは MaxHeight プロパティまたは親コンテナーによって制約されない限り、テキストが入力されると垂直方向に拡大し続けます。 複数行の TextBox が表示領域を超えて拡大しないことをテストし、表示される場合は拡大を制限する必要があります。 スクロール ホイールまたはタッチを使用したスクロールは、必要に応じて自動的に有効になります。 ただし、垂直スクロール バーは既定では表示されません。 次に示すように、埋め込まれた ScrollViewer で ScrollViewer.VerticalScrollBarVisibility を Auto に設定することで、垂直 スクロール バーを表示できます。
<TextBox AcceptsReturn="True" TextWrapping="Wrap"
MaxHeight="172" Width="300" Header="Description"
ScrollViewer.VerticalScrollBarVisibility="Auto"/>
TextBox textBox = new TextBox();
textBox.AcceptsReturn = true;
textBox.TextWrapping = TextWrapping.Wrap;
textBox.MaxHeight = 172;
textBox.Width = 300;
textBox.Header = "Description";
ScrollViewer.SetVerticalScrollBarVisibility(textBox, ScrollBarVisibility.Auto);
テキストが追加された後の TextBox の外観を次に示します。
テキストの表示形式の設定
TextBox 内のテキストを配置するには、 TextAlignment プロパティを使用します。 ページのレイアウト内で TextBox を配置するには、 HorizontalAlignment プロパティと VerticalAlignment プロパティ を 使用します。
TextBox は書式設定されていないテキストのみをサポートしますが、TextBox でのテキストの表示方法をカスタマイズして、ブランド化に合わせることができます。 標準的な Control プロパティ (FontFamily、FontSize、FontStyle、Background、Foreground、CharacterSpacing など) を設定して、テキストの外観を変更できます。 これらのプロパティは TextBox がテキストをローカルに表示する方法にのみ影響するため、テキストをコピーしてリッチ テキスト コントロールに貼り付ける場合 (たとえば、書式設定は適用されません)。
この例では、テキストの外観をカスタマイズするためにいくつかのプロパティが設定された読み取り専用の TextBox を示します。
<TextBox Text="Sample Text" IsReadOnly="True"
FontFamily="Verdana" FontSize="24"
FontWeight="Bold" FontStyle="Italic"
CharacterSpacing="200" Width="300"
Foreground="Blue" Background="Beige"/>
TextBox textBox = new TextBox();
textBox.Text = "Sample Text";
textBox.IsReadOnly = true;
textBox.FontFamily = new FontFamily("Verdana");
textBox.FontSize = 24;
textBox.FontWeight = Windows.UI.Text.FontWeights.Bold;
textBox.FontStyle = Windows.UI.Text.FontStyle.Italic;
textBox.CharacterSpacing = 200;
textBox.Width = 300;
textBox.Background = new SolidColorBrush(Windows.UI.Colors.Beige);
textBox.Foreground = new SolidColorBrush(Windows.UI.Colors.Blue);
// Add the TextBox to the visual tree.
rootGrid.Children.Add(textBox);
結果の TextBox は次のようになります。
ペン入力
XAML テキスト入力ボックスには、Windows Ink を使用したペン入力の埋め込みサポートが用意されています。 ユーザーが Windows ペンを使用してテキスト入力ボックスをタップすると、テキスト ボックスが変換され、ユーザーは別の入力パネルを開くのではなく、ペンで直接入力できます。
詳細については、「 手書きビューを使用したテキスト入力」を参照してください。
コンテキスト メニューの変更
既定では、TextBox コンテキスト メニューに表示されるコマンドは、TextBox の状態によって異なります。 たとえば、TextBox が編集可能な場合は、次のコマンドを表示できます。
| 命令 | 表示される状況 |
|---|---|
| Copy | テキストが選択されている。 |
| 切る | テキストが選択されている。 |
| 貼り付け | クリップボードにテキストが含まれている。 |
| すべて選択する | TextBox にテキストが含まれている。 |
| 元に戻す | テキストが変更されている。 |
コンテキスト メニューに表示されるコマンドを変更するには、ContextMenuOpening イベントを処理します。 詳細については、 コンテキスト メニューのガイドラインを参照してください。
選択、コピー、貼り付け
SelectedText プロパティを使用して、TextBox で選択したテキストを取得または設定できます。 SelectionStart プロパティと SelectionLength プロパティ、Select メソッドと SelectAll メソッドを使用して、テキストの選択を操作します。 ユーザーがテキストを選択または選択を解除したときに何かを行うために、SelectionChanged イベントを処理します。 選択したテキストを強調表示するために使用する色を変更するには、SelectionHighlightColor プロパティを設定します。
TextBox では、既定でコピーと貼り付けをサポートしています。 アプリの編集可能なテキスト コントロールで、Paste イベントのカスタム処理を行うことができます。 たとえば、複数行からなる 1 つの住所の改行を単一行の検索ボックスに貼り付けるときに削除できます。 または、貼り付けられたテキストの長さをチェックし、データベースに保存できる最大の長さを超えている場合はユーザーに警告することができます。 詳しい説明と例については、Paste イベントに関するトピックをご覧ください。
タッチ キーボードでテキスト ボックスを使用する
タッチ キーボードは、タッチ スクリーンを備えたデバイスでアプリを実行するときにテキスト入力に使用できます。 TextBox には、ユーザーがタッチ キーボードを使用してアプリにデータを簡単に入力できるように設定できるプロパティが用意されています。 ユーザーが入力する必要があるデータの種類と一致するように InputScope プロパティを設定します。 たとえば、TextBox を使用して 4 桁の PIN を入力する場合は、 InputScope プロパティを Number に設定します。 これにより、システムにキーパッドのレイアウトが表示されます。これにより、ユーザーが PIN を簡単に入力できるようになります。
タッチ キーボードに影響するその他のプロパティとして、IsSpellCheckEnabled、IsTextPredictionEnabled、PreventKeyboardDisplayOnProgrammaticFocus があります (IsSpellCheckEnabled は、ハードウェア キーボードを使用する場合も TextBox に影響します)。詳しい情報と例については、「 入力範囲を使用してタッチ キーボードを変更する」およびプロパティのドキュメントを参照してください。
コントロール のスタイルとテンプレート
既定の スタイル と ControlTemplate を変更して、コントロールに一意の外観を与えることができます。 コントロールのスタイルとテンプレートの変更については、「 XAML スタイル」を参照してください。 コントロールの外観を定義する既定のスタイル、テンプレート、およびリソースは、 generic.xaml ファイルに含まれます。 設計上、generic.xaml は、Windows App SDK NuGet パッケージと共にインストールされます。 既定では、この場所は \Users\<username>\.nuget\packages\microsoft.windowsappsdk\<version>\lib\uap10.0\Microsoft.UI\Themes\generic.xaml です。 SDK のバージョンによってスタイルとリソースの値が異なる場合があります。
XAML には、コントロール テンプレートを変更せずに、さまざまな表示状態のコントロールの色を変更するために使用できるリソースも含まれています。 これらのリソースの変更は、 Background や Foreground などのプロパティを設定する場合に推奨されます。 詳細については、XAML スタイルに関する記事の軽量スタイルのセクションを参照してください。
TextControlで始まるリソースは、TextBox、PasswordBox、RichEditBox、AutoSuggestBox で共有されます。 これらのリソースに対する変更は、4 つのコントロールすべてに影響します。
コンストラクター
| 名前 | 説明 |
|---|---|
| TextBox() |
TextBox クラスの新しいインスタンスを初期化します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| AcceptsReturn |
テキスト ボックスで改行文字または戻り文字を許可して表示するかどうかを決定する値を取得または設定します。 |
| AcceptsReturnProperty |
AcceptsReturn 依存関係プロパティを識別します。 |
| 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) |
| Background |
コントロールの背景を提供するブラシを取得または設定します。 (継承元 Control) |
| BackgroundSizing |
この要素の境界線に対する背景の延長距離を示す値を取得または設定します。 (継承元 Control) |
| BaseUri |
XAML の読み込み時に XAML で構築されたオブジェクトのベース URI を表す URI (Uniform Resource Identifier) を取得します。 このプロパティは、実行時の URI 解決に役立ちます。 (継承元 FrameworkElement) |
| BorderBrush |
コントロールの境界線の塗りつぶしを記述するブラシを取得または設定します。 (継承元 Control) |
| BorderThickness |
コントロールの境界線の太さを取得または設定します。 (継承元 Control) |
| CacheMode |
レンダリングされたコンテンツを可能な限り複合ビットマップとしてキャッシュする必要があることを示す値を取得または設定します。 (継承元 UIElement) |
| CanBeScrollAnchor |
UIElement をスクロール アンカーの候補にできるかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| CanDrag |
ドラッグ アンド ドロップ操作で要素をデータとしてドラッグできるかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| CanPasteClipboardContent |
クリップボードのコンテンツをコントロールに貼り付けることができるかどうかを示す値を取得します。 |
| CanPasteClipboardContentProperty |
CanPasteClipboardContent 依存関係プロパティを識別します。 |
| CanRedo |
再実行可能なアクションが再実行バッファーに含まれているかどうかを示す値を取得します。 |
| CanRedoProperty |
CanRedo 依存関係プロパティを識別します。 |
| CanUndo |
元に戻すことができる操作が元に戻すバッファーに含まれているかどうかを示す値を取得します。 |
| CanUndoProperty |
CanUndo 依存関係プロパティを識別します。 |
| CenterPoint |
要素の中心点 (回転またはスケーリングが行われる点) を取得または設定します。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| CharacterCasing |
入力時にコントロールが文字の大文字と小文字を変更する方法を示す値を取得または設定します。 |
| CharacterCasingProperty |
CharacterCasing 依存関係プロパティを識別します。 |
| CharacterSpacing |
em の 1/1000 単位で文字間の均一な間隔を取得または設定します。 (継承元 Control) |
| Clip |
UIElement の内容のアウトラインを定義するために使用する RectangleGeometry を取得または設定します。 (継承元 UIElement) |
| CompositeMode |
親レイアウトとウィンドウ内の要素の代替コンポジションモードとブレンド モードを宣言するプロパティを取得または設定します。 これは、混合 XAML/Microsoft DirectX UI に関係する要素に関連します。 (継承元 UIElement) |
| ContextFlyout |
この要素に関連付けられているポップアップを取得または設定します。 (継承元 UIElement) |
| CornerRadius |
コントロールの境界線の角の半径を取得または設定します。 (継承元 Control) |
| DataContext |
FrameworkElement のデータ コンテキストを取得または設定します。 データ コンテキストの一般的な用途は、 |
| DefaultStyleKey |
コントロールの既定のスタイルを参照するキーを取得または設定します。 カスタム コントロールの作成者は、このプロパティを使用して、コントロールが使用するスタイルの既定値を変更します。 (継承元 Control) |
| DefaultStyleResourceUri |
コントロールの既定のスタイルを含むリソース ファイルへのパスを取得または設定します。 (継承元 Control) |
| Description |
コントロールの下に表示されるコンテンツを取得または設定します。 コンテンツは、コントロールによって期待される入力に関するガイダンスを提供する必要があります。 |
| DescriptionProperty |
Description 依存関係プロパティを識別します。 |
| DesiredCandidateWindowAlignment |
入力メソッド エディター (IME) の優先配置を示す値を取得または設定します。 |
| DesiredCandidateWindowAlignmentProperty |
DesiredCandidateWindowAlignment 依存関係プロパティを識別します。 |
| DesiredSize |
レイアウト プロセスのメジャー パス中にこの UIElement が計算したサイズを取得します。 (継承元 UIElement) |
| Dispatcher |
Windows App SDK アプリで常に |
| DispatcherQueue |
このオブジェクトが関連付けられている |
| ElementSoundMode |
サウンドを再生するかどうかのコントロールの設定を指定する値を取得または設定します。 (継承元 Control) |
| ExitDisplayModeOnAccessKeyInvoked |
アクセス キーの呼び出し時にアクセス キーの表示を閉じるかどうかを指定する値を取得または設定します。 (継承元 UIElement) |
| FlowDirection |
レイアウトを制御する任意の親要素内でテキストやその他の UI 要素が流れる方向を取得または設定します。 このプロパティは、 |
| FocusState |
このコントロールにフォーカスがあるかどうかを示す値と、フォーカスが取得されたモードを取得します。 (継承元 UIElement) |
| FocusVisualMargin |
FrameworkElement のフォーカス ビジュアルの外側の余白を取得または設定します。 (継承元 FrameworkElement) |
| FocusVisualPrimaryBrush |
FrameworkElement の |
| FocusVisualPrimaryThickness |
FrameworkElement の |
| FocusVisualSecondaryBrush |
FrameworkElement の |
| FocusVisualSecondaryThickness |
FrameworkElement の |
| FontFamily |
コントロール内のテキストを表示するために使用するフォントを取得または設定します。 (継承元 Control) |
| FontSize |
このコントロール内のテキストのサイズを取得または設定します。 (継承元 Control) |
| FontStretch |
画面でフォントを縮小または展開する度合いを取得または設定します。 (継承元 Control) |
| FontStyle |
テキストをレンダリングするスタイルを取得または設定します。 (継承元 Control) |
| FontWeight |
指定したフォントの太さを取得または設定します。 (継承元 Control) |
| Foreground |
前景色を表すブラシを取得または設定します。 (継承元 Control) |
| Header |
コントロールのヘッダーの内容を取得または設定します。 |
| HeaderProperty |
Header 依存関係プロパティを識別します。 |
| HeaderTemplate |
コントロールのヘッダーの内容を表示するために使用する DataTemplate を取得または設定します。 |
| HeaderTemplateProperty |
HeaderTemplate 依存関係プロパティを識別します。 |
| Height |
FrameworkElement の推奨される高さを取得または設定します。 (継承元 FrameworkElement) |
| HighContrastAdjustment |
ハイ コントラスト テーマが有効な場合に、フレームワークが要素のビジュアル プロパティを自動的に調整するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| HorizontalAlignment |
パネルや項目コントロールなど、レイアウトの親で構成されている場合に FrameworkElement に適用される水平方向の配置特性を取得または設定します。 (継承元 FrameworkElement) |
| HorizontalContentAlignment |
コントロールのコンテンツの水平方向の配置を取得または設定します。 (継承元 Control) |
| HorizontalTextAlignment |
TextBox でのテキストの配置方法を示す値を取得または設定します。 |
| HorizontalTextAlignmentProperty |
HorizontalTextAlignment 依存関係プロパティを識別します。 |
| InputScope |
この TextBox で使用される入力のコンテキストを取得または設定します。 |
| InputScopeProperty |
InputScope 依存関係プロパティを識別します。 |
| IsAccessKeyScope |
要素が独自のアクセス キー スコープを定義するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| IsColorFontEnabled |
Segoe UI 絵文字などのカラー レイヤーを含むフォント グリフを色でレンダリングするかどうかを決定する値を取得または設定します。 |
| IsColorFontEnabledProperty |
IsColorFontEnabled 依存関係プロパティを識別します。 |
| IsDoubleTapEnabled |
DoubleTapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsEnabled |
ユーザーがコントロールを操作できるかどうかを示す値を取得または設定します。 (継承元 Control) |
| IsFocusEngaged |
ユーザーがゲーム コントローラーの A/Select ボタンを押したときにフォーカスがコントロールに制限されているかどうかを示す値を取得または設定します。 (継承元 Control) |
| IsFocusEngagementEnabled |
ユーザーがゲーム コントローラーの A/Select ボタンを押したときに、コントロールにフォーカスを制限できるかどうかを示す値を取得または設定します。 (継承元 Control) |
| IsHitTestVisible |
この UIElement の包含領域がヒット テストの true 値を返すことができるかどうかを取得または設定します。 (継承元 UIElement) |
| IsHoldingEnabled |
Holding イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsLoaded |
要素が要素ツリーに追加され、操作の準備ができているかどうかを示す値を取得します。 (継承元 FrameworkElement) |
| IsReadOnly |
ユーザーがテキスト ボックス内のテキストを変更できるかどうかを決定する値を取得または設定します。 |
| IsReadOnlyProperty |
IsReadOnly 依存関係プロパティを識別します。 |
| IsRightTapEnabled |
RightTapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsSpellCheckEnabled |
TextBox 入力がスペル チェック エンジンと対話するかどうかを指定する値を取得または設定します。 |
| IsSpellCheckEnabledProperty |
IsSpellCheckEnabled 依存関係プロパティを識別します。 |
| IsTabStop |
コントロールがタブ ナビゲーションに含まれるかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| IsTapEnabled |
Tapped イベントがその要素から発生するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| IsTextPredictionEnabled |
この TextBox に対してテキスト予測機能 ("オートコンプリート") を有効にするかどうかを決定する値を取得または設定します。 |
| IsTextPredictionEnabledProperty |
IsTextPredictionEnabled 依存関係プロパティを識別します。 |
| IsTextScaleFactorEnabled |
システム テキスト サイズの設定を反映するために、自動テキスト拡大を有効にするかどうかを取得または設定します。 (継承元 Control) |
| KeyboardAcceleratorPlacementMode |
コントロール ヒント に、関連付けられているキーボード アクセラレータのキーの組み合わせを表示するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| KeyboardAcceleratorPlacementTarget |
アクセラレータ キーの組み合わせを表示 するコントロールヒント を示す値を取得または設定します。 (継承元 UIElement) |
| KeyboardAccelerators |
キーボードを使用してアクションを呼び出すキーの組み合わせのコレクションを取得します。 アクセラレータは通常、ボタンまたはメニュー項目に割り当てられます。
|
| KeyTipHorizontalOffset |
UIElement に関連してキー ヒントを配置する距離を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipPlacementMode |
UIElement の境界に対してアクセス キーキーヒントが配置される場所を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipTarget |
アクセス キーキーヒントの対象となる要素を示す値を取得または設定します。 (継承元 UIElement) |
| KeyTipVerticalOffset |
UI 要素に対するキーヒントの配置距離を示す値を取得または設定します。 (継承元 UIElement) |
| Language |
FrameworkElement に適用されるローカライズ/グローバリゼーション言語情報と、オブジェクト表現および UI の現在の FrameworkElement のすべての子要素に適用される言語情報を取得または設定します。 (継承元 FrameworkElement) |
| Lights |
この要素にアタッチされている XamlLight オブジェクトのコレクションを取得します。 (継承元 UIElement) |
| ManipulationMode |
UIElement の動作とジェスチャとの対話に使用される ManipulationModes 値を取得または設定します。 この値を設定すると、アプリ コードでこの要素からの操作イベントを処理できます。 (継承元 UIElement) |
| Margin |
FrameworkElement の外側の余白を取得または設定します。 (継承元 FrameworkElement) |
| MaxHeight |
FrameworkElement の最大高さの制約を取得または設定します。 (継承元 FrameworkElement) |
| MaxLength |
ユーザー入力に使用できる最大文字数を指定する値を取得または設定します。 |
| MaxLengthProperty |
MaxLength 依存関係プロパティを識別します。 |
| 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) |
| PlaceholderForeground |
プレースホルダー テキストの色を表すブラシを取得または設定します。 |
| PlaceholderForegroundProperty |
PlaceholderForeground 依存関係プロパティを識別します。 |
| PlaceholderText |
ユーザー アクションまたはその他の操作によって値が変更されるまでコントロールに表示されるテキストを取得または設定します。 |
| PlaceholderTextProperty |
PlaceholderText 依存関係プロパティを識別します。 |
| PointerCaptures |
ポインター値として表される、キャプチャされたすべてのポインターのセット を 取得します。 (継承元 UIElement) |
| PreventKeyboardDisplayOnProgrammaticFocus |
コントロールがプログラムでフォーカスを受け取ったときにスクリーン キーボードを表示するかどうかを示す値を取得または設定します。 |
| PreventKeyboardDisplayOnProgrammaticFocusProperty |
PreventKeyboardDisplayOnProgrammaticFocus 依存関係プロパティを識別します。 |
| Projection |
この要素をレンダリングするときに適用するパースペクティブ プロジェクション (3-D 効果) を取得または設定します。 (継承元 UIElement) |
| ProofingMenuFlyout |
校正コマンドを示すポップアップを取得します。 |
| ProofingMenuFlyoutProperty |
ProofingMenuFlyout 依存関係プロパティを識別します。 |
| ProtectedCursor |
ポインターがこの要素の上にあるときに表示されるカーソルを取得または設定します。 既定値は null で、カーソルへの変更がないことを示します。 (継承元 UIElement) |
| RasterizationScale |
図形、画像、テキスト、またはメディアをレンダリングするときに使用する追加のスケール ファクターを表す値を取得します。通常は通常よりも高い解像度でレンダリングします。 (継承元 UIElement) |
| RenderSize |
UIElement の最終的なレンダリング サイズを取得します。 使用は推奨されません。「解説」を参照してください。 (継承元 UIElement) |
| RenderTransform |
UIElement のレンダリング位置に影響する変換情報を取得または設定します。 (継承元 UIElement) |
| RenderTransformOrigin |
UIElement の境界を基準にして RenderTransform によって宣言された、可能なレンダー変換の原点を取得または設定します。 (継承元 UIElement) |
| RequestedTheme |
リソースの決定に UIElement (およびその子要素) によって使用される UI テーマを取得または設定します。
|
| RequiresPointer |
UI 要素がマウス モードをサポートするかどうかを取得または設定します。これは、キーボードやゲーム コントローラーなどのポインター以外の入力デバイスでポインター操作エクスペリエンスをエミュレートします。 (継承元 Control) |
| Resources |
ローカルで定義されたリソース ディクショナリを取得します。 XAML では、XAML の暗黙的なコレクション構文を使用して、 |
| Rotation |
時計回りの回転角度を度単位で取得または設定します。 RotationAxis と CenterPoint を基準に回転します。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| RotationAxis |
要素を回転させる軸を取得または設定します。 (継承元 UIElement) |
| RotationTransition |
Rotation プロパティへの変更をアニメーション化する ScalarTransition を取得または設定します。 (継承元 UIElement) |
| Scale |
要素のスケールを取得または設定します。 要素の CenterPoint を基準にして拡大縮小します。 要素のレンダリング位置に影響します。 (継承元 UIElement) |
| ScaleTransition |
Scale プロパティへの変更をアニメーション化する Vector3Transition を取得または設定します。 (継承元 UIElement) |
| SelectedText |
テキスト ボックス内の現在の選択範囲の内容を取得または設定します。 |
| SelectionFlyout |
タッチ入力またはペン入力でテキストを選択したときに表示されるポップアップを取得または設定します。 |
| SelectionFlyoutProperty |
SelectionFlyout 依存関係プロパティを識別します。 |
| SelectionHighlightColor |
選択したテキストを強調表示するために使用するブラシを取得または設定します。 |
| SelectionHighlightColorProperty |
SelectionHighlightColor 依存関係プロパティを識別します。 |
| SelectionHighlightColorWhenNotFocused |
TextBox にフォーカスがない場合に選択したテキストを強調表示するために使用するブラシを取得または設定します。 |
| SelectionHighlightColorWhenNotFocusedProperty |
SelectionHighlightColorWhenNotFocused 依存関係プロパティを識別します。 |
| SelectionLength |
テキスト ボックスの現在の選択範囲の文字数を取得または設定します。 |
| SelectionStart |
テキスト ボックスで選択したテキストの開始位置を取得または設定します。 SelectionLength が 0 (選択したテキストがない) の場合、SelectionStart プロパティはカーソル位置に対応します。 |
| Shadow |
要素によってキャストされるシャドウ効果を取得または設定します。 (継承元 UIElement) |
| Style |
レイアウトおよびレンダリング中にこのオブジェクトに適用されるインスタンス Style を取得または設定します。 (継承元 FrameworkElement) |
| TabFocusNavigation |
このコントロールのタブと TabIndex の動作方法を変更する値を取得または設定します。 (継承元 UIElement) |
| TabIndex |
ユーザーが Tab キーを使用してコントロール内を移動するときに要素がフォーカスを受け取る順序を決定する値を取得または設定します。 (継承元 UIElement) |
| TabNavigation |
このコントロールのタブと UIElement.TabIndex の動作方法を変更する値を取得または設定します。 Note Windows 10 Creators Update (ビルド 10.0.15063) 以降の場合、 TabFocusNavigation プロパティは、UIElement 基底クラスで使用でき、ControlTemplate を使用しないオブジェクトをタブ シーケンスに含めることができます。 |
| Tag |
このオブジェクトに関するカスタム情報を格納するために使用できる任意のオブジェクト値を取得または設定します。 (継承元 FrameworkElement) |
| Template |
コントロール テンプレートを取得または設定します。 コントロール テンプレートは、UI でコントロールの外観を定義し、XAML マークアップで定義します。 (継承元 Control) |
| Text |
テキスト ボックスのテキストの内容を取得または設定します。 |
| TextAlignment |
テキスト ボックス内でテキストを水平方向に配置する方法を取得または設定します。 |
| TextAlignmentProperty |
TextAlignment 依存関係プロパティを識別します。 |
| TextProperty |
Text 依存関係プロパティを識別します。 |
| TextReadingOrder |
TextBox の読み取り順序を決定する方法を示す値を取得または設定します。 |
| TextReadingOrderProperty |
TextReadingOrder 依存関係プロパティを識別します。 |
| TextWrapping |
テキスト の行がテキスト ボックスの使用可能な幅を超えた場合に改行が発生する方法を取得または設定します。 |
| TextWrappingProperty |
TextWrapping 依存関係プロパティを識別します。 |
| Transform3D |
この要素をレンダリングするときに適用する 3-D 変換効果を取得または設定します。 (継承元 UIElement) |
| TransformMatrix |
要素に適用する変換行列を取得または設定します。 (継承元 UIElement) |
| Transitions |
UIElement に適用される Transition スタイル要素のコレクションを取得または設定します。 (継承元 UIElement) |
| Translation |
要素の x、y、z のレンダリング位置を取得または設定します。 (継承元 UIElement) |
| TranslationTransition |
Translation プロパティへの変更をアニメーション化する Vector3Transition を取得または設定します。 (継承元 UIElement) |
| Triggers |
FrameworkElement に対して定義されているアニメーションのトリガーのコレクションを取得します。 一般的に使用されません。 「解説」を参照してください。 (継承元 FrameworkElement) |
| UseLayoutRounding |
オブジェクトとそのビジュアル サブツリーのレンダリングで、レンダリングをピクセル全体に合わせた丸め動作を使用するかどうかを決定する値を取得または設定します。 (継承元 UIElement) |
| UseSystemFocusVisuals |
コントロール テンプレートで定義されているシステムまたはフォーカス ビジュアルによって描画されたフォーカス ビジュアルをコントロールが使用するかどうかを示す値を取得または設定します。 (継承元 UIElement) |
| VerticalAlignment |
パネルや項目コントロールなどの親オブジェクトで構成されている 場合に FrameworkElement に適用される垂直方向の配置特性を取得または設定します。 (継承元 FrameworkElement) |
| VerticalContentAlignment |
コントロールのコンテンツの垂直方向の配置を取得または設定します。 (継承元 Control) |
| Visibility |
UIElement の可視性を取得または設定します。 表示されない |
| Width |
FrameworkElement の幅を取得または設定します。 (継承元 FrameworkElement) |
| XamlRoot |
この要素が表示される |
| XYFocusDown |
ユーザーがゲーム コントローラーの方向パッド (D パッド) を押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 UIElement) |
| XYFocusDownNavigationStrategy |
ダウン ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusKeyboardNavigation |
キーボード方向矢印を使用してナビゲーションを有効または無効にする値を取得または設定します。 (継承元 UIElement) |
| XYFocusLeft |
ユーザーがゲーム コントローラーの方向パッド (D パッド) を左に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 UIElement) |
| XYFocusLeftNavigationStrategy |
左ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusRight |
ユーザーがゲーム コントローラーの方向パッド (D パッド) を右に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 UIElement) |
| XYFocusRightNavigationStrategy |
右ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
| XYFocusUp |
ユーザーがゲーム コントローラーの方向パッド (D パッド) を上に押したときにフォーカスを取得するオブジェクトを取得または設定します。 (継承元 UIElement) |
| XYFocusUpNavigationStrategy |
アップ ナビゲーションのターゲット要素を決定するために使用する戦略を指定する値を取得または設定します。 (継承元 UIElement) |
メソッド
イベント
| 名前 | 説明 |
|---|---|
| AccessKeyDisplayDismissed |
アクセス キーを表示しなくなったときに発生します。 (継承元 UIElement) |
| AccessKeyDisplayRequested |
ユーザーがアクセス キーの表示を要求したときに発生します。 (継承元 UIElement) |
| AccessKeyInvoked |
ユーザーがアクセス キー シーケンスを完了したときに発生します。 (継承元 UIElement) |
| ActualThemeChanged |
ActualTheme プロパティの値が変更されたときに発生します。 (継承元 FrameworkElement) |
| BeforeTextChanging |
テキスト ボックス内のテキストが変更を開始し、 Text プロパティが更新される前に同期的に発生します。 |
| BringIntoViewRequested |
この要素またはその子孫の 1 つで StartBringIntoView が呼び出されたときに発生します。 (継承元 UIElement) |
| CandidateWindowBoundsChanged |
入力メソッド エディター (IME) ウィンドウを開いたり、更新したり、閉じたりすると発生します。 |
| CharacterReceived |
1 つの構成済み文字が入力キューで受信されたときに発生します。 (継承元 UIElement) |
| ContextCanceled |
コンテキスト入力ジェスチャが操作ジェスチャに続き、コンテキスト ポップアップを開くべきではないことを要素に通知するときに発生します。 (継承元 UIElement) |
| ContextMenuOpening |
システムがコンテキスト メニューを表示する相互作用を処理するときに発生します。 |
| ContextRequested |
ユーザーが右クリックなどのコンテキスト入力ジェスチャを完了したときに発生します。 (継承元 UIElement) |
| CopyingToClipboard |
コピーしたテキストがクリップボードに移動する前に発生します。 |
| CuttingToClipboard |
切り取りテキストがクリップボードに移動する前に発生します。 |
| DataContextChanged |
FrameworkElement.DataContext プロパティの値が変更されたときに発生します。 (継承元 FrameworkElement) |
| DoubleTapped |
この要素のヒット テスト領域で、それ以外の場合にハンドルされない DoubleTap 操作が発生したときに発生します。 (継承元 UIElement) |
| DragEnter |
入力システムが、この要素をターゲットとして基になるドラッグ イベントを報告するときに発生します。 (継承元 UIElement) |
| DragLeave |
この要素を原点として基になるドラッグ イベントを入力システムが報告するときに発生します。 (継承元 UIElement) |
| DragOver |
この要素を潜在的なドロップ ターゲットとして使用して、基になるドラッグ イベントを入力システムが報告するときに発生します。 (継承元 UIElement) |
| DragStarting |
ドラッグ操作が開始されたときに発生します。 (継承元 UIElement) |
| Drop |
入力システムが、この要素をドロップ ターゲットとして持つ基になるドロップ イベントを報告するときに発生します。 (継承元 UIElement) |
| DropCompleted |
ソースが終了したときに、この要素を使用したドラッグ アンド ドロップ操作が発生します。 (継承元 UIElement) |
| EffectiveViewportChanged |
FrameworkElement の有効なビューポートが変更されたときに発生します。 (継承元 FrameworkElement) |
| FocusDisengaged |
ユーザーがゲーム コントローラーの B/Back ボタンを押すと、コントロールからフォーカスが離されたときに発生します。 (継承元 Control) |
| FocusEngaged |
ユーザーがゲーム コントローラーの A/Select ボタンを押すと、フォーカスがコントロールに制限されたときに発生します。 (継承元 Control) |
| GettingFocus |
UIElement がフォーカスを受け取る前に発生します。 このイベントは、イベントのバブル中にフォーカスが移動されないように同期的に発生します。 (継承元 UIElement) |
| GotFocus |
UIElement がフォーカスを受け取ったときに発生します。 このイベントは非同期的に発生するため、バブルが完了する前にフォーカスを再び移動できます。 (継承元 UIElement) |
| Holding |
この要素のヒット テスト領域で、それ以外のハンドルされない Hold 操作が発生したときに発生します。 (継承元 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) |
| Paste |
テキストをコントロールに貼り付けると発生します。 |
| PointerCanceled |
接触したポインターが異常に接触を失ったときに発生します。 (継承元 UIElement) |
| PointerCaptureLost |
この要素によって以前に保持されていたポインター キャプチャが別の要素または別の場所に移動したときに発生します。 (継承元 UIElement) |
| PointerEntered |
ポインターがこの要素のヒット テスト領域に入ったときに発生します。 (継承元 UIElement) |
| PointerExited |
ポインターがこの要素のヒット テスト領域から離れると発生します。 (継承元 UIElement) |
| PointerMoved |
ポインターがこの要素のヒット テスト領域内に残っている間にポインターが移動したときに発生します。 (継承元 UIElement) |
| PointerPressed |
ポインター デバイスがこの要素内で Press アクションを開始したときに発生します。 (継承元 UIElement) |
| PointerReleased |
この要素内で、以前に Press アクションを開始したポインター デバイスが解放されたときに発生します。
Press アクションの終了は、 |
| PointerWheelChanged |
ポインター ホイールのデルタ値が変更されたときに発生します。 (継承元 UIElement) |
| PreviewKeyDown |
UIElement にフォーカスがあるときにキーボード キーが押されたときに発生します。 (継承元 UIElement) |
| PreviewKeyUp |
UIElement にフォーカスがあるときにキーボード キーが離されたときに発生します。 (継承元 UIElement) |
| ProcessKeyboardAccelerators |
キーボード ショートカット (またはアクセラレータ) が押されたときに発生します。 (継承元 UIElement) |
| RightTapped |
ポインターが要素の上にある間に右タップ入力刺激が発生したときに発生します。 (継承元 UIElement) |
| SelectionChanged |
テキストの選択が変更されたときに発生します。 |
| SelectionChanging |
テキストの選択が変更され始めると発生します。 |
| SizeChanged |
ActualHeight プロパティまたは ActualWidth プロパティが FrameworkElement の値を変更したときに発生します。 (継承元 FrameworkElement) |
| Tapped |
この要素のヒット テスト領域で、それ以外のハンドルされない Tap 操作が発生したときに発生します。 (継承元 UIElement) |
| TextChanged |
テキスト ボックス内のコンテンツが変更されたときに発生します。 |
| TextChanging |
テキスト ボックス内のテキストが変更され始めたが、レンダリングされる前に同期的に発生します。 |
| TextCompositionChanged |
入力メソッド エディター (IME) を使用してテキストが構成されている場合に発生します。 |
| TextCompositionEnded |
ユーザーが入力メソッド エディター (IME) を使用してテキストの作成を停止したときに発生します。 |
| TextCompositionStarted |
ユーザーが入力メソッド エディター (IME) を使用してテキストの作成を開始したときに発生します。 |
| Unloaded |
このオブジェクトがメイン オブジェクト ツリーに接続されなくなったときに発生します。 (継承元 FrameworkElement) |