TextBox Class

Definition

Represents a control that can be used to display and edit plain text (single or multi-line).

Equivalent WinUI class: Microsoft.UI.Xaml.Controls.TextBox.

/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class TextBox : Control
/// [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.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class TextBox : Control
/// [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.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics5, 262144, "Windows.Foundation.UniversalApiContract")]
class TextBox : Control
/// [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.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics5, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics6, 327680, "Windows.Foundation.UniversalApiContract")]
class TextBox : Control
/// [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.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics5, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics6, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics7, 393216, "Windows.Foundation.UniversalApiContract")]
class TextBox : Control
/// [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.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ITextBoxFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics5, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics6, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics7, 393216, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ITextBoxStatics8, 458752, "Windows.Foundation.UniversalApiContract")]
class TextBox : Control
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 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.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class TextBox : Control
[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.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public class TextBox : Control
[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.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics5), 262144, "Windows.Foundation.UniversalApiContract")]
public class TextBox : Control
[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.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics5), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics6), 327680, "Windows.Foundation.UniversalApiContract")]
public class TextBox : Control
[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.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics5), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics6), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics7), 393216, "Windows.Foundation.UniversalApiContract")]
public class TextBox : Control
[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.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ITextBoxFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics5), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics6), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics7), 393216, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ITextBoxStatics8), 458752, "Windows.Foundation.UniversalApiContract")]
public class TextBox : Control
Public Class TextBox
Inherits Control
<TextBox .../>
Inheritance
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

Tip

For more info, design guidance, and code examples, see Text box.

If you have the XAML Controls Gallery app installed, click here to open the app and see the TextBox in action.

This example shows a TextBox with a header and placeholder text. The Text from the TextBox is used to show a greeting to the user.

<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 + "!";
}

Remarks

Tip

For more info, design guidance, and code examples, see Text box.

Text box control

The TextBox control enables a user to enter text into an app. It's typically used to capture a single line of text, but can be configured to capture multiple lines of text. The text displays on the screen in a simple uniform plaintext format.

TextBox has a number of features that can simplify text entry:

  • It supports text input from a keyboard or a pen (using ink and handwriting recognition).
  • It comes with a familiar, built-in context menu with support for copying and pasting text.
  • A "clear all" button lets a user quickly delete all text that has been entered.
  • It also has spell checking capabilities built in and enabled by default.

Here's how to create a TextBox in XAML and in code.

<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);

The resulting TextBox looks like this. The blue border indicates that the TextBox has focus.

A simple text box

Is TextBox the right control to use?

You can use a TextBox control to display and edit unformatted text. If you need an editable text box that accepts passwords or other sensitive input, see PasswordBox. If you need a text box to enter search terms, see AutoSuggestBox. If you need to enter or edit formatted text, see RichEditBox.

Use TextBox for data input in a form

It’s common to use a TextBox to accept data input on a form, and use the Text property to get the complete text string from the TextBox. You typically use an event like a submit button Click to access the Text property, but you can handle the TextChanged or TextChanging event if you need to do something when the text changes. You can add a Header (or label) and PlaceholderText (or watermark) to the TextBox to give the user an indication of what the TextBox is for. To customize the look of the header, you can set the HeaderTemplate property instead of Header. For design info, see Guidelines for labels.

You can restrict the number of characters the user can type by setting the MaxLength property. However, MaxLength does not restrict the length of pasted text. Use the Paste event to modify pasted text if this is important for your app.

TextBox includes a clear all button ("x") that appears when text is entered in the box. When a user clicks the "x", the text in the TextBox is cleared. It looks like this.

A text box with a clear all button

The clear all button is shown only for editable, single-line text boxes that contain text and have focus. The clear all button is not shown in any of these cases:

Make a TextBox read-only

You can make a TextBox read-only by setting the IsReadOnly property to true. For example, you might have a TextBox for a user to enter comments that is enabled only under certain conditions. You can make the TextBox read-only until the conditions are met. If you need only to display text, consider using a TextBlock or RichTextBlock instead.

Enable multi-line input

There are two properties that control whether the TextBox displays text on more than one line.

  • To let the text box allow and display the newline or return characters, set the AcceptsReturn property to true.
  • To enable text wrapping, set the TextWrapping property to Wrap. (TextBox doesn't support the TextWrapping.WrapWholeWords enumeration value.) A multi-line TextBox will continue to grow vertically as text is entered unless it’s constrained by its Height or MaxHeight property, or by a parent container. You should test that a multi-line TextBox doesn’t grow beyond its visible area, and constrain its growth if it does. Scrolling using a scroll-wheel or touch is automatically enabled when needed. However, vertical scrollbars are not shown by default. You can show the vertical scrollbars by setting the ScrollViewer.VerticalScrollBarVisibility to Auto on the embedded ScrollViewer, as shown here.
<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);

Here's what the TextBox looks like after text is added.

A mullti line text box

Format the text display

Use the TextAlignment property to align text within a TextBox. To align the TextBox within the layout of the page, use the HorizontalAlignment and VerticalAlignment properties.

While the TextBox supports only unformatted text, you can customize how the text is displayed in the TextBox to match your branding. You can set standard Control properties like FontFamily, FontSize, FontStyle, Background, Foreground, and CharacterSpacing to change the look of the text. These properties affect only how the TextBox displays the text locally, so if you were to copy and paste the text into a rich text control, for example, no formatting would be applied.

This example shows a read-only TextBox with several properties set to customize the appearance of the text.

<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);

The resulting TextBox looks like this.

A simple text box

Pen input

Starting with Windows 10, version 1803, XAML text input boxes feature embedded support for pen input using Windows Ink. When a user taps into a text input box using a Windows pen, the text box transforms to let the user write directly into it with a pen, rather than opening a separate input panel.

Text box with ink and suggestions

For more info, see Text input with the handwriting view.

Modify the context menu

By default, the commands shown in the TextBox context menu depend on the state of the TextBox. For example, the following commands can be shown when the TextBox is editable.

CommandShown when...
Copytext is selected.
Cuttext is selected.
Pastethe clipboard contains text.
Select allthe TextBox contains text.
Undotext has been changed.

To modify the commands shown in the context menu, handle the ContextMenuOpening event. For an example of this, see the Customizing RichEditBox's CommandBarFlyout - adding 'Share' example in the XAML Controls Gallery. For design info, see Guidelines for context menus.

Selection, copy, and paste

You can get or set the selected text in a TextBox using the SelectedText property. Use the SelectionStart and SelectionLength properties, and the Select and SelectAll methods, to manipulate the text selection. Handle the SelectionChanged event to do something when the user selects or de-selects text. You can change the color used to highlight the selected text by setting the SelectionHighlightColor property.

TextBox supports copy and paste by default. You can provide custom handling of the Paste event on editable text controls in your app. For example, you might remove the line breaks from a multi-line address when pasting it into a single-line search box. Or, you might check the length of the pasted text and warn the user if it exceeds the maximum length that can be saved to a database. For more info and examples, see the Paste event.

Use a text box with the touch keyboard

The touch keyboard can be used for text entry when your app runs on a device with a touch screen. TextBox provides properties you can set to make it much faster and easier for users to enter data in your app using the touch keyboard. Set the InputScope property to match the kind of data the user is expected to enter. For example, if a TextBox is used only to enter a 4-digit PIN, set the InputScope property to Number. This tells the system to show the number keypad layout, which makes it easier for the user to enter the PIN.

Other properties that affect the touch keyboard are IsSpellCheckEnabled, IsTextPredictionEnabled, and PreventKeyboardDisplayOnProgrammaticFocus. (IsSpellCheckEnabled also affects the TextBox when a hardware keyboard is used.) For more info and examples, see Use input scope to change the touch keyboard, and the property documentation.

Control style and template

You can modify the default Style and ControlTemplate to give the control a unique appearance. For information about modifying a control's style and template, see Styling controls. The default style, template, and resources that define the look of the control are included in the generic.xaml file. For design purposes, generic.xaml is available in the (Program Files)\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP\ <SDK version>\Generic folder from a Windows Software Development Kit (SDK) installation. Styles and resources from different versions of the SDK might have different values.

Starting in Windows 10, version 1607 (SDK 14393), generic.xaml includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. In apps that target this software development kit (SDK) or later, modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the Styling controls article.

This table shows the resources used by the TextBox control. Resources that start with "TextControl" are shared by TextBox, PasswordBox, RichEditBox, and AutoSuggestBox.

Resource keyDescription
TextControlForegroundText color at rest and not focused
TextControlForegroundPointerOverText color on hover
TextControlForegroundFocusedText color when focused
TextControlForegroundDisabledText color when disabled
TextControlBackgroundBackground color at rest and not focused
TextControlBackgroundPointerOverBackground color on hover
TextControlBackgroundFocusedBackground color when focused
TextControlBackgroundDisabledBackground color when disabled
TextControlBorderBrushBorder color at rest and not focused
TextControlBorderBrushPointerOverBorder color on hover
TextControlBorderBrushFocusedBorder color when focused
TextControlBorderBrushDisabledBorder color when disabled
TextControlPlaceholderForegroundPlaceholder text color at rest and not focused
TextControlPlaceholderForegroundPointerOverPlaceholder text color on hover
TextControlPlaceholderForegroundFocusedPlaceholder text color when focused
TextControlPlaceholderForegroundDisabledPlaceholder text color when disabled
TextControlHeaderForegroundHeader text color
TextControlHeaderForegroundDisabledHeader text color when disabled
TextControlSelectionHighlightColorHighlight color of selected text
TextControlButtonBackgroundBackground color of delete button at rest
TextControlButtonBackgroundPointerOverBackground color of delete button on hover
TextControlButtonBackgroundPressedBackground color of delete button when pressed
TextControlButtonBorderBrushBorder color of delete button at rest
TextControlButtonBorderBrushPointerOverBorder color of delete button on hover
TextControlButtonBorderBrushPressedBorder color of delete button when pressed
TextControlButtonForegroundForeground color of delete button at rest
TextControlButtonForegroundPointerOverForeground color of delete button on hover
TextControlButtonForegroundPressedForeground color of delete button when pressed

Version history

Windows version SDK version Value added
1511 10586 GetLinguisticAlternativesAsync
1703 15063 SelectionHighlightColorWhenNotFocused
1709 16299 BeforeTextChanging
1709 16299 CharacterCasing
1709 16299 CopyingToClipboard
1709 16299 CuttingToClipboard
1709 16299 HorizontalTextAlignment
1709 16299 PlaceholderForeground
1803 17134 HandwritingView
1803 17134 IsHandwritingViewEnabled
1809 17763 CanPasteClipboardContent
1809 17763 CanRedo
1809 17763 CanUndo
1809 17763 ClearUndoRedoHistory
1809 17763 CopySelectionToClipboard
1809 17763 CutSelectionToClipboard
1809 17763 Description
1809 17763 PasteFromClipboard
1809 17763 ProofingMenuFlyout
1809 17763 Redo
1809 17763 SelectionChanging
1809 17763 SelectionFlyout
1809 17763 Undo

Constructors

TextBox()

Initializes a new instance of the TextBox class.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Controls.TextBox.TextBox.

Properties

AcceptsReturn

Gets or sets the value that determines whether the text box allows and displays the newline or return characters.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.AcceptsReturn.

AcceptsReturnProperty

Identifies the AcceptsReturn dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.AcceptsReturnProperty.

AccessKey

Gets or sets the access key (mnemonic) for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKey.

(Inherited from UIElement)
AccessKeyScopeOwner

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKeyScopeOwner.

(Inherited from UIElement)
ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualHeight.

(Inherited from FrameworkElement)
ActualOffset

Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualOffset.

(Inherited from UIElement)
ActualSize

Gets the size that this UIElement computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualSize.

(Inherited from UIElement)
ActualTheme

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualTheme.

(Inherited from FrameworkElement)
ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualWidth.

(Inherited from FrameworkElement)
AllowDrop

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AllowDrop.

(Inherited from UIElement)
AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusOnInteraction.

(Inherited from FrameworkElement)
AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusWhenDisabled.

(Inherited from FrameworkElement)
Background

Gets or sets a brush that provides the background of the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Background.

(Inherited from Control)
BackgroundSizing

Gets or sets a value that indicates how far the background extends in relation to this element's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BackgroundSizing.

(Inherited from Control)
BaseUri

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.BaseUri.

(Inherited from FrameworkElement)
BorderBrush

Gets or sets a brush that describes the border fill of a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BorderBrush.

(Inherited from Control)
BorderThickness

Gets or sets the border thickness of a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.BorderThickness.

(Inherited from Control)
CacheMode

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CacheMode.

(Inherited from UIElement)
CanBeScrollAnchor

Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanBeScrollAnchor.

(Inherited from UIElement)
CanDrag

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanDrag.

(Inherited from UIElement)
CanPasteClipboardContent

Gets a value that indicates whether clipboard content can be pasted into the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanPasteClipboardContent.

CanPasteClipboardContentProperty

Identifies the CanPasteClipboardContent dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanPasteClipboardContentProperty.

CanRedo

Gets a value that indicates whether the redo buffer contains an action that can be redone.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanRedo.

CanRedoProperty

Identifies the CanRedo dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanRedoProperty.

CanUndo

Gets a value that indicates whether the undo buffer contains an action that can be undone.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanUndo.

CanUndoProperty

Identifies the CanUndo dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CanUndoProperty.

CenterPoint

Gets or sets the center point of the element, which is the point about which rotation or scaling occurs. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CenterPoint.

(Inherited from UIElement)
CharacterCasing

Gets or sets a value that indicates how the control modifies the case of characters as they are typed.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CharacterCasing.

CharacterCasingProperty

Identifies the CharacterCasing dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.CharacterCasingProperty.

CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.CharacterSpacing.

(Inherited from Control)
Clip

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Clip.

(Inherited from UIElement)
CompositeMode

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CompositeMode.

(Inherited from UIElement)
ContextFlyout

Gets or sets the flyout associated with this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ContextFlyout.

(Inherited from UIElement)
CornerRadius

Gets or sets the radius for the corners of the control's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.CornerRadius.

(Inherited from Control)
DataContext

Gets or sets the data context for a FrameworkElement. A common use of a data context is when a FrameworkElement uses the {Binding} markup extension and participates in data binding.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.DataContext.

(Inherited from FrameworkElement)
DefaultStyleKey

Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.DefaultStyleKey.

(Inherited from Control)
DefaultStyleResourceUri

Gets or sets the path to the resource file that contains the default style for the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.DefaultStyleResourceUri.

(Inherited from Control)
Description

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.Description.

DescriptionProperty

Identifies the Description dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.DescriptionProperty.

DesiredCandidateWindowAlignment

Gets or sets a value that indicates the preferred alignment of the Input Method Editor (IME).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.DesiredCandidateWindowAlignment.

DesiredCandidateWindowAlignmentProperty

Identifies the DesiredCandidateWindowAlignment dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.DesiredCandidateWindowAlignmentProperty.

DesiredSize

Gets the size that this UIElement computed during the measure pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.DesiredSize.

(Inherited from UIElement)
Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
ElementSoundMode

Get or sets a value that specifies a control's preference for whether sounds are played.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.ElementSoundMode.

(Inherited from Control)
ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ExitDisplayModeOnAccessKeyInvoked.

(Inherited from UIElement)
FlowDirection

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FlowDirection.

(Inherited from FrameworkElement)
FocusState

Gets a value that specifies whether this control has focus, and the mode by which focus was obtained.

(Inherited from Control)
FocusVisualMargin

Gets or sets the outer margin of the focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualMargin.

(Inherited from FrameworkElement)
FocusVisualPrimaryBrush

Gets or sets the brush used to draw the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryBrush.

(Inherited from FrameworkElement)
FocusVisualPrimaryThickness

Gets or sets the thickness of the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryThickness.

(Inherited from FrameworkElement)
FocusVisualSecondaryBrush

Gets or sets the brush used to draw the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryBrush.

(Inherited from FrameworkElement)
FocusVisualSecondaryThickness

Gets or sets the thickness of the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryThickness.

(Inherited from FrameworkElement)
FontFamily

Gets or sets the font used to display text in the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontFamily.

(Inherited from Control)
FontSize

Gets or sets the size of the text in this control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontSize.

(Inherited from Control)
FontStretch

Gets or sets the degree to which a font is condensed or expanded on the screen.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontStretch.

(Inherited from Control)
FontStyle

Gets or sets the style in which the text is rendered.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontStyle.

(Inherited from Control)
FontWeight

Gets or sets the thickness of the specified font.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.FontWeight.

(Inherited from Control)
Foreground

Gets or sets a brush that describes the foreground color.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Foreground.

(Inherited from Control)
HandwritingView

Gets or sets the HandwritingView associated with this text control.

HandwritingViewProperty

Identifies the HandwritingView dependency property.

Header

Gets or sets the content for the control's header.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.Header.

HeaderProperty

Identifies the Header dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.HeaderProperty.

HeaderTemplate

Gets or sets the DataTemplate used to display the content of the control's header.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.HeaderTemplate.

HeaderTemplateProperty

Identifies the HeaderTemplate dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.HeaderTemplateProperty.

Height

Gets or sets the suggested height of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Height.

(Inherited from FrameworkElement)
HighContrastAdjustment

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.HighContrastAdjustment.

(Inherited from UIElement)
HorizontalAlignment

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.HorizontalAlignment.

(Inherited from FrameworkElement)
HorizontalContentAlignment

Gets or sets the horizontal alignment of the control's content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.HorizontalContentAlignment.

(Inherited from Control)
HorizontalTextAlignment

Gets or sets a value that indicates how text is aligned in the TextBox.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.HorizontalTextAlignment.

HorizontalTextAlignmentProperty

Identifies the HorizontalTextAlignment dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.HorizontalTextAlignmentProperty.

InputScope

Gets or sets the context for input used by this TextBox.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.InputScope.

InputScopeProperty

Identifies the InputScope dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.InputScopeProperty.

IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsAccessKeyScope.

(Inherited from UIElement)
IsColorFontEnabled

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsColorFontEnabled.

IsColorFontEnabledProperty

Identifies the IsColorFontEnabled dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsColorFontEnabledProperty.

IsDoubleTapEnabled

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsDoubleTapEnabled.

(Inherited from UIElement)
IsEnabled

Gets or sets a value indicating whether the user can interact with the control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsEnabled.

(Inherited from Control)
IsFocusEngaged

Get or sets a value that indicates whether focus is constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsFocusEngaged.

(Inherited from Control)
IsFocusEngagementEnabled

Get or sets a value that indicates whether focus can be constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsFocusEngagementEnabled.

(Inherited from Control)
IsHandwritingViewEnabled

Gets or sets a value that indicates whether a user can enter text in the handwriting view.

IsHandwritingViewEnabledProperty

Identifies the IsHandwritingViewEnabled dependency property.

IsHitTestVisible

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHitTestVisible.

(Inherited from UIElement)
IsHoldingEnabled

Gets or sets a value that determines whether the Holding event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHoldingEnabled.

(Inherited from UIElement)
IsLoaded

Gets a value that indicates whether the element has been added to the element tree and is ready for interaction.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.IsLoaded.

(Inherited from FrameworkElement)
IsReadOnly

Gets or sets the value that determines if the user can change the text in the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsReadOnly.

IsReadOnlyProperty

Identifies the IsReadOnly dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsReadOnlyProperty.

IsRightTapEnabled

Gets or sets a value that determines whether the RightTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsRightTapEnabled.

(Inherited from UIElement)
IsSpellCheckEnabled

Gets or sets a value that specifies whether the TextBox input interacts with a spell check engine.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsSpellCheckEnabled.

IsSpellCheckEnabledProperty

Identifies the IsSpellCheckEnabled dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsSpellCheckEnabledProperty.

IsTabStop

Gets or sets a value that indicates whether a control is included in tab navigation.

(Inherited from Control)
IsTapEnabled

Gets or sets a value that determines whether the Tapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsTapEnabled.

(Inherited from UIElement)
IsTextPredictionEnabled

Gets or sets a value that determines whether text prediction features ("autocomplete") should be enabled for this TextBox.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsTextPredictionEnabled.

IsTextPredictionEnabledProperty

Identifies the IsTextPredictionEnabled dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.IsTextPredictionEnabledProperty.

IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.IsTextScaleFactorEnabled.

(Inherited from Control)
KeyboardAcceleratorPlacementMode

Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementMode.

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementTarget.

(Inherited from UIElement)
KeyboardAccelerators

Gets the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items
Example of a menu showing keyboard accelerators for various menu items

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAccelerators.

(Inherited from UIElement)
KeyTipHorizontalOffset

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipHorizontalOffset.

(Inherited from UIElement)
KeyTipPlacementMode

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipPlacementMode.

(Inherited from UIElement)
KeyTipTarget

Gets or sets a value that indicates the element targeted by the access key Key Tip.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipTarget.

(Inherited from UIElement)
KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipVerticalOffset.

(Inherited from UIElement)
Language

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Language.

(Inherited from FrameworkElement)
Lights

Gets the collection of XamlLight objects attached to this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Lights.

(Inherited from UIElement)
ManipulationMode

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ManipulationMode.

(Inherited from UIElement)
Margin

Gets or sets the outer margin of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Margin.

(Inherited from FrameworkElement)
MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxHeight.

(Inherited from FrameworkElement)
MaxLength

Gets or sets the value that specifies the maximum number of characters allowed for user input.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.MaxLength.

MaxLengthProperty

Identifies the MaxLength dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.MaxLengthProperty.

MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxWidth.

(Inherited from FrameworkElement)
MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinHeight.

(Inherited from FrameworkElement)
MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinWidth.

(Inherited from FrameworkElement)
Name

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Name.

(Inherited from FrameworkElement)
Opacity

Gets or sets the degree of the object's opacity.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Opacity.

(Inherited from UIElement)
OpacityTransition

Gets or sets the ScalarTransition that animates changes to the Opacity property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.OpacityTransition.

(Inherited from UIElement)
Padding

Gets or sets the padding inside a control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Padding.

(Inherited from Control)
Parent

Gets the parent object of this FrameworkElement in the object tree.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Parent.

(Inherited from FrameworkElement)
PlaceholderForeground

Gets or sets a brush that describes the color of placeholder text.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PlaceholderForeground.

PlaceholderForegroundProperty

Identifies the PlaceholderForeground dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PlaceholderForegroundProperty.

PlaceholderText

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PlaceholderText.

PlaceholderTextProperty

Identifies the PlaceholderText dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PlaceholderTextProperty.

PointerCaptures

Gets the set of all captured pointers, represented as Pointer values.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.PointerCaptures.

(Inherited from UIElement)
PreventKeyboardDisplayOnProgrammaticFocus

Gets or sets a value that indicates whether the on-screen keyboard is shown when the control receives focus programmatically.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PreventKeyboardDisplayOnProgrammaticFocus.

PreventKeyboardDisplayOnProgrammaticFocusProperty

Identifies the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.PreventKeyboardDisplayOnProgrammaticFocusProperty.

Projection

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Projection.

(Inherited from UIElement)
ProofingMenuFlyout

Gets the flyout that shows proofing commands.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.ProofingMenuFlyout.

ProofingMenuFlyoutProperty

Identifies the ProofingMenuFlyout dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.ProofingMenuFlyoutProperty.

RenderSize

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderSize.

(Inherited from UIElement)
RenderTransform

Gets or sets transform information that affects the rendering position of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransform.

(Inherited from UIElement)
RenderTransformOrigin

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransformOrigin.

(Inherited from UIElement)
RequestedTheme

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.RequestedTheme.

(Inherited from FrameworkElement)
RequiresPointer

Gets or sets whether a UI element supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as an Xbox gamepad or remote control.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.RequiresPointer.

(Inherited from Control)
Resources

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Resources.

(Inherited from FrameworkElement)
Rotation

Gets or sets the angle of clockwise rotation, in degrees. Rotates relative to the RotationAxis and the CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Rotation.

(Inherited from UIElement)
RotationAxis

Gets or sets the axis to rotate the element around.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationAxis.

(Inherited from UIElement)
RotationTransition

Gets or sets the ScalarTransition that animates changes to the Rotation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationTransition.

(Inherited from UIElement)
Scale

Gets or sets the scale of the element. Scales relative to the element's CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Scale.

(Inherited from UIElement)
ScaleTransition

Gets or sets the Vector3Transition that animates changes to the Scale property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ScaleTransition.

(Inherited from UIElement)
SelectedText

Gets or sets the content of the current selection in the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectedText.

SelectionFlyout

Gets or sets the flyout that is shown when text is selected using touch or pen, or null if no flyout is shown.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionFlyout.

SelectionFlyoutProperty

Identifies the SelectionFlyout dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionFlyoutProperty.

SelectionHighlightColor

Gets or sets the brush used to highlight the selected text.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionHighlightColor.

SelectionHighlightColorProperty

Identifies the SelectionHighlightColor dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionHighlightColorProperty.

SelectionHighlightColorWhenNotFocused

Gets or sets the brush used to highlight the selected text when the TextBox does not have focus.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionHighlightColorWhenNotFocused.

SelectionHighlightColorWhenNotFocusedProperty

Identifies the SelectionHighlightColorWhenNotFocused dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionHighlightColorWhenNotFocusedProperty.

SelectionLength

Gets or sets the number of characters in the current selection in the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionLength.

SelectionStart

Gets or sets the starting position of the text selected in the text box. When the SelectionLength is 0 (there is no selected text), the SelectionStart property corresponds to the cursor position.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.SelectionStart.

Shadow

Gets or sets the shadow effect cast by the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Shadow.

(Inherited from UIElement)
Style

Gets or sets an instance Style that is applied for this object during layout and rendering.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Style.

(Inherited from FrameworkElement)
TabFocusNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TabFocusNavigation.

(Inherited from UIElement)
TabIndex

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.

(Inherited from Control)
TabNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Note

For Windows 10 Creators Update (build 10.0.15063) and newer, the TabFocusNavigation property is available on the UIElement base class to include objects in the tab sequence that do not use a ControlTemplate.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.TabNavigation.

(Inherited from Control)
Tag

Gets or sets an arbitrary object value that can be used to store custom information about this object.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Tag.

(Inherited from FrameworkElement)
Template

Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.Template.

(Inherited from Control)
Text

Gets or sets the text contents of the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.Text.

TextAlignment

Gets or sets how the text should be horizontally aligned in the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextAlignment.

TextAlignmentProperty

Identifies the TextAlignment dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextAlignmentProperty.

TextProperty

Identifies the Text dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextProperty.

TextReadingOrder

Gets or sets a value that indicates how the reading order is determined for the TextBox.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextReadingOrder.

TextReadingOrderProperty

Identifies the TextReadingOrder dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextReadingOrderProperty.

TextWrapping

Gets or sets how line breaking occurs if a line of text extends beyond the available width of the text box.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextWrapping.

TextWrappingProperty

Identifies the TextWrapping dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.TextWrappingProperty.

Transform3D

Gets or sets the 3-D transform effect to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transform3D.

(Inherited from UIElement)
TransformMatrix

Gets or sets the transformation matrix to apply to the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TransformMatrix.

(Inherited from UIElement)
Transitions

Gets or sets the collection of Transition style elements that apply to a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transitions.

(Inherited from UIElement)
Translation

Gets or sets the x, y, and z rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Translation.

(Inherited from UIElement)
TranslationTransition

Gets or sets the Vector3Transition that animates changes to the Translation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TranslationTransition.

(Inherited from UIElement)
Triggers

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Triggers.

(Inherited from FrameworkElement)
UIContext

Gets the context identifier for the element.

(Inherited from UIElement)
UseLayoutRounding

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.UseLayoutRounding.

(Inherited from UIElement)
UseSystemFocusVisuals

Gets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template.

(Inherited from Control)
VerticalAlignment

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.VerticalAlignment.

(Inherited from FrameworkElement)
VerticalContentAlignment

Gets or sets the vertical alignment of the control's content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Control.VerticalContentAlignment.

(Inherited from Control)
Visibility

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Visibility.

(Inherited from UIElement)
Width

Gets or sets the width of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Width.

(Inherited from FrameworkElement)
XamlRoot

Gets or sets the XamlRoot in which this element is being viewed.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XamlRoot.

(Inherited from UIElement)
XYFocusDown

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

(Inherited from Control)
XYFocusDownNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusDownNavigationStrategy.

(Inherited from UIElement)
XYFocusKeyboardNavigation

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusKeyboardNavigation.

(Inherited from UIElement)
XYFocusLeft

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

(Inherited from Control)
XYFocusLeftNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusLeftNavigationStrategy.

(Inherited from UIElement)
XYFocusRight

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

(Inherited from Control)
XYFocusRightNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusRightNavigationStrategy.

(Inherited from UIElement)
XYFocusUp

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

(Inherited from Control)
XYFocusUpNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusUpNavigationStrategy.

(Inherited from UIElement)

Methods

AddHandler(RoutedEvent, Object, Boolean)

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.AddHandler.

(Inherited from UIElement)
ApplyTemplate()

Loads the relevant control template so that its parts can be referenced.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.ApplyTemplate.

(Inherited from Control)
Arrange(Rect)

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Arrange.

(Inherited from UIElement)
ArrangeOverride(Size)

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.ArrangeOverride.

(Inherited from FrameworkElement)
CancelDirectManipulations()

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CancelDirectManipulations.

(Inherited from UIElement)
CapturePointer(Pointer)

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CapturePointer.

(Inherited from UIElement)
ClearUndoRedoHistory()

Empties the undo and redo buffers.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.ClearUndoRedoHistory.

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
CopySelectionToClipboard()

Copies the selected content to the Windows clipboard.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.CopySelectionToClipboard.

CutSelectionToClipboard()

Moves the selected content to the Windows clipboard and removes it from the text control.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.CutSelectionToClipboard.

FindName(String)

Retrieves an object that has the specified identifier name.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.FindName.

(Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.FindSubElementsForTouchTargeting.

(Inherited from UIElement)
Focus(FocusState)

Attempts to set the focus on the control.

(Inherited from Control)
GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GetBindingExpression.

(Inherited from FrameworkElement)
GetChildrenInTabFocusOrder()

Enables a UIElement subclass to expose child elements that take part in Tab focus.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.GetChildrenInTabFocusOrder.

(Inherited from UIElement)
GetLinguisticAlternativesAsync()

Asynchronously gets a list of candidate words based on the provided phonetic characters in an Input Method Editor (IME).

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.GetLinguisticAlternativesAsync.

GetRectFromCharacterIndex(Int32, Boolean)

Returns a rectangular region for the leading or trailing edge of a character at a specific character index.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.GetRectFromCharacterIndex.

GetTemplateChild(String)

Retrieves the named element in the instantiated ControlTemplate visual tree.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.GetTemplateChild.

(Inherited from Control)
GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
GoToElementStateCore(String, Boolean)

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GoToElementStateCore.

(Inherited from FrameworkElement)
InvalidateArrange()

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateArrange.

(Inherited from UIElement)
InvalidateMeasure()

Invalidates the measurement state (layout) for a UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateMeasure.

(Inherited from UIElement)
InvalidateViewport()

Invalidates the viewport state for a UIElement that is used to calculate the effective viewport.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.InvalidateViewport.

(Inherited from FrameworkElement)
Measure(Size)

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Measure.

(Inherited from UIElement)
MeasureOverride(Size)

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.MeasureOverride.

(Inherited from FrameworkElement)
OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.OnApplyTemplate.

(Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs. Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnBringIntoViewRequested.

(Inherited from UIElement)
OnCharacterReceived(CharacterReceivedRoutedEventArgs)

Called before the CharacterReceived event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnCharacterReceived.

(Inherited from Control)
OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnCreateAutomationPeer.

(Inherited from UIElement)
OnDisconnectVisualChildren()

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnDisconnectVisualChildren.

(Inherited from UIElement)
OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDoubleTapped.

(Inherited from Control)
OnDragEnter(DragEventArgs)

Called before the DragEnter event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragEnter.

(Inherited from Control)
OnDragLeave(DragEventArgs)

Called before the DragLeave event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragLeave.

(Inherited from Control)
OnDragOver(DragEventArgs)

Called before the DragOver event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDragOver.

(Inherited from Control)
OnDrop(DragEventArgs)

Called before the Drop event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnDrop.

(Inherited from Control)
OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnGotFocus.

(Inherited from Control)
OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnHolding.

(Inherited from Control)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnKeyboardAcceleratorInvoked.

(Inherited from UIElement)
OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnKeyDown.

(Inherited from Control)
OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnKeyUp.

(Inherited from Control)
OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnLostFocus.

(Inherited from Control)
OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Called before the ManipulationCompleted event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationCompleted.

(Inherited from Control)
OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationDelta.

(Inherited from Control)
OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

Called before the ManipulationInertiaStarting event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationInertiaStarting.

(Inherited from Control)
OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Called before the ManipulationStarted event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationStarted.

(Inherited from Control)
OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnManipulationStarting.

(Inherited from Control)
OnPointerCanceled(PointerRoutedEventArgs)

Called before the PointerCanceled event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerCanceled.

(Inherited from Control)
OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerCaptureLost.

(Inherited from Control)
OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerEntered.

(Inherited from Control)
OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerExited.

(Inherited from Control)
OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerMoved.

(Inherited from Control)
OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerPressed.

(Inherited from Control)
OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerReleased.

(Inherited from Control)
OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPointerWheelChanged.

(Inherited from Control)
OnPreviewKeyDown(KeyRoutedEventArgs)

Called before the PreviewKeyDown event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPreviewKeyDown.

(Inherited from Control)
OnPreviewKeyUp(KeyRoutedEventArgs)

Called before the PreviewKeyUp event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnPreviewKeyUp.

(Inherited from Control)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnProcessKeyboardAccelerators.

(Inherited from UIElement)
OnRightTapped(RightTappedRoutedEventArgs)

Called before the RightTapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnRightTapped.

(Inherited from Control)
OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.OnTapped.

(Inherited from Control)
PasteFromClipboard()

Copies content from the Windows clipboard into the text control.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.PasteFromClipboard.

PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfo.

(Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

When overridden in a derived class, defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfoOverride.

(Inherited from UIElement)
ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
Redo()

Reapplies the first action in the redo buffer.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.Redo.

RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
ReleasePointerCapture(Pointer)

Releases pointer captures for capture of one specific pointer by this UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCapture.

(Inherited from UIElement)
ReleasePointerCaptures()

Releases all pointer captures held by this element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCaptures.

(Inherited from UIElement)
RemoveFocusEngagement()

Releases focus from the control boundaries for a control that has focus engagement (for game pad/remote interaction).

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Control.RemoveFocusEngagement.

(Inherited from Control)
RemoveHandler(RoutedEvent, Object)

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.RemoveHandler.

(Inherited from UIElement)
Select(Int32, Int32)

Selects a range of text in the text box.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.Select.

SelectAll()

Selects the entire contents of the text box.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.SelectAll.

SetBinding(DependencyProperty, BindingBase)

Attaches a binding to a FrameworkElement, using the provided binding object.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.SetBinding.

(Inherited from FrameworkElement)
SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase)

Begins the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartAnimation.

(Inherited from UIElement)
StartBringIntoView()

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions)

Initiates a request to the XAML framework to bring the element into view using the specified options.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
StopAnimation(ICompositionAnimationBase)

Stops the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StopAnimation.

(Inherited from UIElement)
TransformToVisual(UIElement)

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TransformToVisual.

(Inherited from UIElement)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TryInvokeKeyboardAccelerator.

(Inherited from UIElement)
Undo()

Undoes the first action in the undo buffer.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.TextBox.Undo.

UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)
UpdateLayout()

Ensures that all positions of child objects of a UIElement are properly updated for layout.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.UpdateLayout.

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed

Occurs when access keys should no longer be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayDismissed.

(Inherited from UIElement)
AccessKeyDisplayRequested

Occurs when the user requests that access keys be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayRequested.

(Inherited from UIElement)
AccessKeyInvoked

Occurs when a user completes an access key sequence.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyInvoked.

(Inherited from UIElement)
ActualThemeChanged

Occurs when the ActualTheme property value has changed.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.ActualThemeChanged.

(Inherited from FrameworkElement)
BeforeTextChanging

Occurs synchronously when the text in the text box starts to change, but before the Text property is updated.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.BeforeTextChanging.

BringIntoViewRequested

Occurs when StartBringIntoView is called on this element or one of its descendants.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.BringIntoViewRequested.

(Inherited from UIElement)
CandidateWindowBoundsChanged

Occurs when the Input Method Editor (IME) window open, updates, or closes.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.CandidateWindowBoundsChanged.

CharacterReceived

Occurs when a single, composed character is received by the input queue.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.CharacterReceived.

(Inherited from UIElement)
ContextCanceled

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextCanceled.

(Inherited from UIElement)
ContextMenuOpening

Occurs when the system processes an interaction that displays a context menu.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.ContextMenuOpening.

ContextRequested

Occurs when the user has completed a context input gesture, such as a right-click.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextRequested.

(Inherited from UIElement)
CopyingToClipboard

Occurs before copied text is moved to the clipboard.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.CopyingToClipboard.

CuttingToClipboard

Occurs before cut text is moved to the clipboard.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.CuttingToClipboard.

DataContextChanged

Occurs when the value of the FrameworkElement.DataContext property changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.DataContextChanged.

(Inherited from FrameworkElement)
DoubleTapped

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DoubleTapped.

(Inherited from UIElement)
DragEnter

Occurs when the input system reports an underlying drag event with this element as the target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragEnter.

(Inherited from UIElement)
DragLeave

Occurs when the input system reports an underlying drag event with this element as the origin.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragLeave.

(Inherited from UIElement)
DragOver

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragOver.

(Inherited from UIElement)
DragStarting

Occurs when a drag operation is initiated.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragStarting.

(Inherited from UIElement)
Drop

Occurs when the input system reports an underlying drop event with this element as the drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Drop.

(Inherited from UIElement)
DropCompleted

Occurs when a drag-and-drop operation with this element as the source is ended.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DropCompleted.

(Inherited from UIElement)
EffectiveViewportChanged

Occurs when the FrameworkElement 's effective viewport changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.EffectiveViewportChanged.

(Inherited from FrameworkElement)
FocusDisengaged

Occurs when focus is released from the control boundaries (for game pad/remote interaction).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.FocusDisengaged.

(Inherited from Control)
FocusEngaged

Occurs when focus is constrained within the control boundaries (for game pad/remote interaction).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.FocusEngaged.

(Inherited from Control)
GettingFocus

Occurs before a UIElement receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GettingFocus.

(Inherited from UIElement)
GotFocus

Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GotFocus.

(Inherited from UIElement)
Holding

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Holding.

(Inherited from UIElement)
IsEnabledChanged

Occurs when the IsEnabled property changes.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Control.IsEnabledChanged.

(Inherited from Control)
KeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyDown.

(Inherited from UIElement)
KeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyUp.

(Inherited from UIElement)
LayoutUpdated

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.LayoutUpdated.

(Inherited from FrameworkElement)
Loaded

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loaded.

(Inherited from FrameworkElement)
Loading

Occurs when a FrameworkElement begins to load.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loading.

(Inherited from FrameworkElement)
LosingFocus

Occurs before a UIElement loses focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LosingFocus.

(Inherited from UIElement)
LostFocus

Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LostFocus.

(Inherited from UIElement)
ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationCompleted.

(Inherited from UIElement)
ManipulationDelta

Occurs when the input device changes position during a manipulation.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationDelta.

(Inherited from UIElement)
ManipulationInertiaStarting

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationInertiaStarting.

(Inherited from UIElement)
ManipulationStarted

Occurs when an input device begins a manipulation on the UIElement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarted.

(Inherited from UIElement)
ManipulationStarting

Occurs when the manipulation processor is first created.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarting.

(Inherited from UIElement)
NoFocusCandidateFound

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.NoFocusCandidateFound.

(Inherited from UIElement)
Paste

Occurs when text is pasted into the control.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.Paste.

PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCanceled.

(Inherited from UIElement)
PointerCaptureLost

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCaptureLost.

(Inherited from UIElement)
PointerEntered

Occurs when a pointer enters the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerEntered.

(Inherited from UIElement)
PointerExited

Occurs when a pointer leaves the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerExited.

(Inherited from UIElement)
PointerMoved

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerMoved.

(Inherited from UIElement)
PointerPressed

Occurs when the pointer device initiates a Press action within this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerPressed.

(Inherited from UIElement)
PointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerReleased.

(Inherited from UIElement)
PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerWheelChanged.

(Inherited from UIElement)
PreviewKeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyDown.

(Inherited from UIElement)
PreviewKeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyUp.

(Inherited from UIElement)
ProcessKeyboardAccelerators

Occurs when a keyboard shortcut (or accelerator) is pressed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ProcessKeyboardAccelerators.

(Inherited from UIElement)
RightTapped

Occurs when a right-tap input stimulus happens while the pointer is over the element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.RightTapped.

(Inherited from UIElement)
SelectionChanged

Occurs when the text selection has changed.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.SelectionChanged.

SelectionChanging

Occurs when the text selection starts to change.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.SelectionChanging.

SizeChanged

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.SizeChanged.

(Inherited from FrameworkElement)
Tapped

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Tapped.

(Inherited from UIElement)
TextChanged

Occurs when content changes in the text box.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.TextChanged.

TextChanging

Occurs synchronously when the text in the text box starts to change, but before it is rendered.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.TextChanging.

TextCompositionChanged

Occurs when text being composed through an Input Method Editor (IME) changes.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.TextCompositionChanged.

TextCompositionEnded

Occurs when a user stops composing text through an Input Method Editor (IME).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.TextCompositionEnded.

TextCompositionStarted

Occurs when a user starts composing text through an Input Method Editor (IME).

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.TextBox.TextCompositionStarted.

Unloaded

Occurs when this object is no longer connected to the main object tree.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Unloaded.

(Inherited from FrameworkElement)

Applies to

See also