TextBox 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
表示可用于显示和编辑纯文本(单行或多行)的控件。
/// [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 .../>
- 继承
- 属性
示例
小窍门
有关详细信息、设计指南和代码示例,请参阅 文本框。
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 + "!";
}
注解
小窍门
有关详细信息、设计指南和代码示例,请参阅 文本框。
TextBox 控件允许用户将文本输入到应用中。 它通常用于捕获单行文本,但可配置为捕获多行文本。 文本以简单的统一纯文本格式在屏幕上显示。
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 添加 标题 (或标签)和 占位符文本 (或水印),以便向用户指示 TextBox 的用途。 若要自定义标头的外观,可以设置 HeaderTemplate 属性而不是 Header。 有关设计信息,请参阅 标签指南。
可以通过设置 MaxLength 属性来限制用户可键入的字符数。 但是, MaxLength 不会限制粘贴文本的长度。 使用 Paste 事件修改粘贴文本(如果这对你的应用很重要)。
TextBox 包括一个 清除所有 按钮(“x”),该按钮在文本框中输入文本时显示。 当用户单击“x”时,将清除 TextBox 中的文本。 它的外观如下所示。
“ 清除所有 ”按钮仅针对包含文本且具有焦点的可编辑单行文本框显示。 以下任一情况下都未显示 “清除所有 ”按钮:
- IsReadOnly 是 true
- 属性AcceptsReturn的值为true。
- TextWrapping 为 Wrap
使 TextBox 只读
通过将 IsReadOnly 属性设置为 true,可以将 TextBox 设置为只读。 例如,你可以提供一个供用户输入评论的 TextBox,该文本框仅在特定条件下启用。 你可以让 TextBox 设为只读状态,直到满足特定条件为止。 如果只需要显示文本,请考虑改用 TextBlock 或 RichTextBlock 。
启用多行输入
有两个属性控制 TextBox 是否在多行上显示文本。
- 若要使文本框允许和显示新行或返回字符,请将 AcceptsReturn 属性设置为“true”。
- 若要启用文本换行,请将 TextWrapping 属性设置为“Wrap”。 (TextBox 不支持 TextWrapping.WrapWholeWords 枚举值。)多行 TextBox 将继续垂直增长,因为输入文本时,除非它受 其 Height 或 MaxHeight 属性或父容器的约束。 你应该测试多行 TextBox 不会超出其可见区域,并限制其增长(如果这样做)。 在需要时自动启用使用滚轮或触摸的滚动。 但是,默认情况下不显示垂直滚动条。 可以通过将 ScrollViewer.VerticalScrollBarVisibility 设置为嵌入 ScrollViewer 上的“自动”来显示垂直滚动条,如下所示。
<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 的外观。
设置文本显示的格式
使用 TextAlignment 属性在 TextBox 中对齐文本。 若要在页面布局中对齐 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 事件的自定义处理。 例如,在将多行地址粘贴到单行搜索框中时,你可以从该地址中删除换行符。 或者,你可以检查粘贴文本的长度,如果它超出可保存到数据库的最大长度,则警告用户。 有关详细信息和示例,请参阅 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 还包括可用于在不修改控件模板的情况下在不同视觉状态中修改控件颜色的资源。 修改这些资源是设置 背景 和 前台等属性的首选。 有关详细信息,请参阅 XAML 样式文章的“轻量级样式”部分。
开头TextControl的资源由 TextBoxPasswordBox、RichEditBox 和 AutoSuggestBox 共享。 对这些资源的更改将影响所有四个控件。
构造函数
| 名称 | 说明 |
|---|---|
| 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 |
获取一个统一资源标识符(URI),该标识符表示 XAML 加载时 XAML 构造对象的基 URI。 此属性适用于运行时的 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 |
获取或设置字符之间的统一间距,单位为 1/1000 em。 (继承自 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 应用 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 |
标识 标头 依赖项属性。 |
| 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 的包含区域是否可以返回命中测试的真实值。 (继承自 UIElement) |
| IsHoldingEnabled |
获取或设置一个值,该值确定 Holding 事件是否可以源自该元素。 (继承自 UIElement) |
| IsLoaded |
获取一个值,该值指示是否已将元素添加到元素树中并已准备好进行交互。 (继承自 FrameworkElement) |
| IsReadOnly |
获取或设置一个值,该值确定用户是否可以更改文本框中的文本。 |
| IsReadOnlyProperty |
标识 IsReadOnly 依赖项属性。 |
| IsRightTapEnabled |
获取或设置一个值,该值确定 RightTapped 事件是否可以源自该元素。 (继承自 UIElement) |
| IsSpellCheckEnabled |
获取或设置一个值,该值指定 TextBox 输入是否与拼写检查引擎交互。 |
| IsSpellCheckEnabledProperty |
标识 IsSpellCheckEnabled 依赖属性。 |
| IsTabStop |
获取或设置一个值,该值指示控件是否包含在选项卡导航中。 (继承自 UIElement) |
| IsTapEnabled |
获取或设置一个值,该值确定 点击 事件是否可以源自该元素。 (继承自 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 | |
| Projection |
获取或设置呈现此元素时要应用的透视投影(三维效果)。 (继承自 UIElement) |
| ProofingMenuFlyout |
获取显示校对命令的浮出控件。 |
| ProofingMenuFlyoutProperty |
标识 ProofingMenuFlyout 依赖项属性。 |
| ProtectedCursor |
获取或设置指针位于此元素上时显示的游标。 默认值为 null,表示游标没有更改。 (继承自 UIElement) |
| RasterizationScale |
获取一个值,该值表示在呈现形状、图像、文本或媒体时要使用的额外比例因子,通常以比正常分辨率更高的分辨率呈现。 (继承自 UIElement) |
| RenderSize |
获取 UIElement 的最终呈现大小。 不建议使用,请参阅“备注”。 (继承自 UIElement) |
| RenderTransform |
获取或设置影响 UIElement 呈现位置的转换信息。 (继承自 UIElement) |
| RenderTransformOrigin |
获取或设置 RenderTransform 声明的任何可能的呈现转换的原点,相对于 UIElement 的边界。 (继承自 UIElement) |
| RequestedTheme |
获取或设置 UIElement (及其子元素)用于资源确定的 UI 主题。 你指定的 |
| RequiresPointer |
获取或设置 UI 元素是否支持鼠标模式,该模式模拟与非指针输入设备(如键盘或游戏控制器)的指针交互体验。 (继承自 Control) |
| Resources |
获取本地定义的资源字典。 在 XAML 中,可以通过 XAML 隐式集合语法将资源项作为属性元素的 |
| Rotation |
获取或设置顺时针旋转的角度(以度为单位)。 相对于 RotationAxis 和 CenterPoint 旋转。 影响元素的呈现位置。 (继承自 UIElement) |
| RotationAxis |
获取或设置要围绕元素旋转的轴。 (继承自 UIElement) |
| RotationTransition |
获取或设置对 Rotation 属性的更改进行动画处理的 ScalarTransition。 (继承自 UIElement) |
| Scale |
获取或设置元素的规模。 相对于元素的 CenterPoint 进行缩放。 影响元素的呈现位置。 (继承自 UIElement) |
| ScaleTransition |
获取或设置 Vector3Transition,该 Vector3Transition 对 Scale 属性的更改进行动画处理。 (继承自 UIElement) |
| SelectedText |
获取或设置文本框中当前所选内容。 |
| SelectionFlyout |
获取或设置使用触摸或笔输入选择文本时显示的浮出控件。 |
| SelectionFlyoutProperty |
标识 SelectionFlyout 依赖项属性。 |
| SelectionHighlightColor |
获取或设置用于突出显示所选文本的画笔。 |
| SelectionHighlightColorProperty |
标识 SelectionHighlightColor 依赖项属性。 |
| SelectionHighlightColorWhenNotFocused |
获取或设置在 TextBox 没有焦点时用于突出显示所选文本的画笔。 |
| SelectionHighlightColorWhenNotFocusedProperty |
标识 SelectionHighlightColorWhenNotFocused 依赖项属性。 |
| SelectionLength |
获取或设置文本框中当前选定内容中的字符数。 |
| SelectionStart |
获取或设置文本框中所选文本的起始位置。 当 SelectionLength 为 0(没有选定的文本),SelectionStart 属性对应于光标位置。 |
| Shadow |
获取或设置元素强制转换的阴影效果。 (继承自 UIElement) |
| Style |
获取或设置在布局和呈现期间应用于此对象的实例 样式 。 (继承自 FrameworkElement) |
| TabFocusNavigation |
获取或设置一个值,该值修改 Tabbing 和 TabIndex 对此控件的工作方式。 (继承自 UIElement) |
| TabIndex |
获取或设置一个值,该值确定当用户使用 Tab 键浏览控件时元素接收焦点的顺序。 (继承自 UIElement) |
| TabNavigation |
获取或设置一个值,该值修改 Tabbing 和 UIElement.TabIndex 对此控件的工作方式。 Note 对于Windows 10创意者更新(内部版本 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 |
获取或设置呈现此元素时要应用的三维转换效果。 (继承自 UIElement) |
| TransformMatrix |
获取或设置要应用于元素的转换矩阵。 (继承自 UIElement) |
| Transitions |
获取或设置应用于 UIElement 的 Transition 样式元素的集合。 (继承自 UIElement) |
| Translation |
获取或设置元素的 x、y 和 z 呈现位置。 (继承自 UIElement) |
| TranslationTransition |
获取或设置 Vector3Transition,该 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 |
在此元素或其子代之一上调用 StartBringIntoView 时发生。 (继承自 UIElement) |
| CandidateWindowBoundsChanged |
当输入法编辑器(IME)窗口打开、更新或关闭时发生。 |
| CharacterReceived |
当输入队列接收单个组合字符时发生。 (继承自 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/选择按钮时,当焦点限制为控件时发生。 (继承自 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) |
| Paste |
当文本粘贴到控件中时发生。 |
| PointerCanceled |
当使联系人异常失去联系人的指针时发生。 (继承自 UIElement) |
| PointerCaptureLost |
当此元素以前持有的指针捕获移动到另一个元素或其他地方时发生。 (继承自 UIElement) |
| PointerEntered |
当指针进入此元素的命中测试区域时发生。 (继承自 UIElement) |
| PointerExited |
当指针离开此元素的命中测试区域时发生。 (继承自 UIElement) |
| PointerMoved |
当指针在指针保留在此元素的命中测试区域中时发生。 (继承自 UIElement) |
| PointerPressed |
当指针设备在此元素中启动 Press 操作时发生。 (继承自 UIElement) |
| PointerReleased |
在此元素中释放之前启动 Press 操作的指针设备时发生。 请注意, 无法保证按下 操作的结束触发事件 |
| PointerWheelChanged |
当指针滚轮的增量值更改时发生。 (继承自 UIElement) |
| PreviewKeyDown |
当 UIElement 具有焦点时按下键盘键时发生。 (继承自 UIElement) |
| PreviewKeyUp |
当 UIElement 具有焦点时释放键盘键时发生。 (继承自 UIElement) |
| ProcessKeyboardAccelerators |
按下 键盘快捷方式(或快捷键) 时发生。 (继承自 UIElement) |
| RightTapped |
当指针位于元素上时发生右键输入刺激时发生。 (继承自 UIElement) |
| SelectionChanged |
当文本选择已更改时发生。 |
| SelectionChanging |
当文本选择开始更改时发生。 |
| SizeChanged |
在 FrameworkElement 上的 ActualHeight 或 ActualWidth 属性值更改时发生。 (继承自 FrameworkElement) |
| Tapped |
在此元素的命中测试区域发生其他未经处理的 Tap 交互时发生。 (继承自 UIElement) |
| TextChanged |
在文本框中的内容更改时发生。 |
| TextChanging |
当文本框中的文本开始更改但在呈现之前同步发生。 |
| TextCompositionChanged |
当通过输入法编辑器(IME)更改撰写的文本时发生。 |
| TextCompositionEnded |
当用户通过输入法编辑器(IME)停止撰写文本时发生。 |
| TextCompositionStarted |
当用户通过输入法编辑器(IME)开始撰写文本时发生。 |
| Unloaded |
当此对象不再连接到主对象树时发生。 (继承自 FrameworkElement) |