AutoSuggestBox Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Controls

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a text control that makes suggestions to users as they enter text using a keyboard or pen (using ink and handwriting recognition). The app is notified when text has been changed by the user and is responsible for providing relevant suggestions for this control to display.

public ref class AutoSuggestBox sealed : ItemsControl

/// [Microsoft.UI.Xaml.Controls.InputProperty(Name="Text")]
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AutoSuggestBox final : ItemsControl

[Microsoft.UI.Xaml.Controls.InputProperty(Name="Text")]
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutoSuggestBox : ItemsControl

Public NotInheritable Class AutoSuggestBox
Inherits ItemsControl

<AutoSuggestBox .../>

Inheritance: Object Platform::Object IInspectable DependencyObject UIElement FrameworkElement Control ItemsControl AutoSuggestBox

Attributes: InputPropertyAttribute ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

Tip

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

Open the WinUI 3 Gallery app and see the AutoSuggestBox in action.

The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub

The following code demonstrates a simple AutoSuggestBox with required event handlers.

<AutoSuggestBox PlaceholderText="Search" QueryIcon="Find" Width="200"
                TextChanged="AutoSuggestBox_TextChanged"
                QuerySubmitted="AutoSuggestBox_QuerySubmitted"
                SuggestionChosen="AutoSuggestBox_SuggestionChosen"/>

private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
{
    // Only get results when it was a user typing, 
    // otherwise assume the value got filled in by TextMemberPath 
    // or the handler for SuggestionChosen.
    if (args.Reason == AutoSuggestionBoxTextChangeReason.UserInput)
    {
        //Set the ItemsSource to be your filtered dataset
        //sender.ItemsSource = dataset;
    }
}


private void AutoSuggestBox_SuggestionChosen(AutoSuggestBox sender, AutoSuggestBoxSuggestionChosenEventArgs args)
{
    // Set sender.Text. You can use args.SelectedItem to build your text string.
}


private void AutoSuggestBox_QuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuerySubmittedEventArgs args)
{
    if (args.ChosenSuggestion != null)
    {
        // User selected an item from the suggestion list, take an action on it here.
    }
    else
    {
        // Use args.QueryText to determine what to do.
    }
}

Remarks

Tip

For more info, design guidance, and code examples, see Auto-suggest box.

Use an AutoSuggestBox to provide a list of suggestions for a user to select from as they type.

By default, the text entry box doesn't have a query button shown. You can set the QueryIcon property to add a button with the specified icon on the right side of the text box. For example, to make the AutoSuggestBox look like a typical search box, add a 'find' icon, like this.

<AutoSuggestBox QueryIcon="Find"/>

Here's an AutoSuggestBox with a 'find' icon. The suggestion list shows suggested results based on the user's entry.

An auto suggest box with an icon and suggestions

To use an AutoSuggestBox, you need to respond to 3 user actions.

Text changed - When the user enters text, update the suggestion list.
Suggestion chosen - When the user chooses a suggestion in the suggestion list, update the text box.
Query submitted - When the user submits a query, show the query results.

Text changed

The TextChanged event occurs whenever the content of the text box is updated. Use the event args Reason property to determine whether the change was due to user input. If the change reason is UserInput, filter your data based on the input. Then, set the filtered data as the ItemsSource of the AutoSuggestBox to update the suggestion list.

To control how items are displayed in the suggestion list, you can use DisplayMemberPath or ItemTemplate.

To display the text of a single property of your data item, set the DisplayMemberPath property to choose which property from your object to display in the suggestion list.
To define a custom look for each item in the list, use the ItemTemplate property .

Suggestion chosen

When a user navigates through the suggestion list using the keyboard, you need to update the text in the text box to match.

You can set the TextMemberPath property to choose which property from your data object to display in the text box. If you specify a TextMemberPath, the text box is updated automatically. You should typically specify the same value for DisplayMemberPath and TextMemberPath so the text is the same in the suggestion list and the text box.

If you need to show more than a simple property, handle the SuggestionChosen event to populate the text box with custom text based on the selected item.

Query submitted

Handle the QuerySubmitted event to perform a query action appropriate to your app and show result to the user.

The QuerySubmitted event occurs when a user commits a query string. The user can commit a query in one of these ways:

While focus is in the text box, press Enter or click the query icon. The event args ChosenSuggestion property is null.
While focus is in the suggestion list, press Enter, click, or tap an item. The event args ChosenSuggestion property contains the item that was selected from the list. In all cases, the event args QueryText property contains the text from the text box.

Accessibility

If you are using an assistive technology, such as Narrator, to interact with the AutoSuggestBox the accessibility experience has already been hooked up for you. A user will:

Know the list is present and when the list closes
Know how many suggestions are available
Be able to move Narrator focus to the list
Be able to Navigate through a suggestion with all other reading modes See Auto-suggest accessibility for more information.

Pen input

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.

You can configure the handwriting view of the AutoSuggestBox through its TextBox control, as we show here.

<AutoSuggestBox Name="NoHandwritingAutoSuggestBox"
        BorderThickness="0"  Width="680"
        FontSize="24" VerticalAlignment="Top"
        HorizontalAlignment="Center"
        PlaceholderText="Handwriting view is not supported">
    <AutoSuggestBox.TextBoxStyle>
        <Style TargetType="TextBox">
            <Setter Property="IsHandwritingViewEnabled" Value="False"/>
        </Style>
    </AutoSuggestBox.TextBoxStyle>
</AutoSuggestBox>

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

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 XAML styles. 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 installed with the Windows App SDK NuGet package. By default, this location is \Users\<username>\.nuget\packages\microsoft.windowsappsdk\<version>\lib\uap10.0\Microsoft.UI\Themes\generic.xaml. Styles and resources from different versions of the SDK might have different values.

XAML also includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. Modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the XAML styles article.

Resources that start with TextControl are shared by TextBox, PasswordBox, RichEditBox, and AutoSuggestBox. Changes to these resources will affect all four controls.

Constructors

AutoSuggestBox()

Initializes a new instance of the AutoSuggestBox class.

Properties

AccessKey	Gets or sets the access key (mnemonic) for this element. (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. (Inherited from UIElement)
ActualHeight	Gets the rendered height of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)
ActualOffset	Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process. (Inherited from UIElement)
ActualSize	Gets the size that this UIElement computed during the arrange pass of the layout process. (Inherited from UIElement)
ActualTheme	Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme. (Inherited from FrameworkElement)
ActualWidth	Gets the rendered width of a FrameworkElement. See Remarks. (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. (Inherited from UIElement)
AllowFocusOnInteraction	Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from FrameworkElement)
AllowFocusWhenDisabled	Gets or sets whether a disabled control can receive focus. (Inherited from FrameworkElement)
AutoMaximizeSuggestionArea	Indicates if the suggestion area should be automatically maximized.
AutoMaximizeSuggestionAreaProperty	Identifies the AutoMaximizeSuggestionArea dependency property.
Background	Gets or sets a brush that provides the background of the control. (Inherited from Control)
BackgroundSizing	Gets or sets a value that indicates how far the background extends in relation to this element's border. (Inherited from Control)
BaseUri	Gets a Uniform Resource Identifier (URI) that represents the base URI for an XAML-constructed object at XAML load time. This property is useful for URI resolution at run time. (Inherited from FrameworkElement)
BorderBrush	Gets or sets a brush that describes the border fill of a control. (Inherited from Control)
BorderThickness	Gets or sets the border thickness of a control. (Inherited from Control)
CacheMode	Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)
CanBeScrollAnchor	Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring. (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. (Inherited from UIElement)
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. (Inherited from UIElement)
CharacterSpacing	Gets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control)
Clip	Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (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. (Inherited from UIElement)
ContextFlyout	Gets or sets the flyout associated with this element. (Inherited from UIElement)
CornerRadius	Gets or sets the radius for the corners of the control's border. (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. (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. (Inherited from Control)
DefaultStyleResourceUri	Gets or sets the path to the resource file that contains the default style for the control. (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.
DescriptionProperty	Identifies the Description dependency property.
DesiredSize	Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)
Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
DisplayMemberPath	Gets or sets the name or path of the property that is displayed for each data item. (Inherited from ItemsControl)
ElementSoundMode	Get or sets a value that specifies a control's preference for whether sounds are played. (Inherited from Control)
ExitDisplayModeOnAccessKeyInvoked	Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked. (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. (Inherited from FrameworkElement)
FocusState	Gets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from UIElement)
FocusVisualMargin	Gets or sets the outer margin of the focus visual for a FrameworkElement. (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. (Inherited from FrameworkElement)
FocusVisualPrimaryThickness	Gets or sets the thickness of the outer border of a `HighVisibility` or `Reveal` focus visual for a FrameworkElement. (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. (Inherited from FrameworkElement)
FocusVisualSecondaryThickness	Gets or sets the thickness of the inner border of a `HighVisibility` or `Reveal` focus visual for a FrameworkElement. (Inherited from FrameworkElement)
FontFamily	Gets or sets the font used to display text in the control. (Inherited from Control)
FontSize	Gets or sets the size of the text in this control. (Inherited from Control)
FontStretch	Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control)
FontStyle	Gets or sets the style in which the text is rendered. (Inherited from Control)
FontWeight	Gets or sets the thickness of the specified font. (Inherited from Control)
Foreground	Gets or sets a brush that describes the foreground color. (Inherited from Control)
GroupStyle	Gets a collection of GroupStyle objects that define the appearance of each level of groups. (Inherited from ItemsControl)
GroupStyleSelector	Gets or sets a reference to a custom GroupStyleSelector logic class. The GroupStyleSelector returns different GroupStyle values to use for content based on the characteristics of that content. (Inherited from ItemsControl)
Header	Gets or sets the header object for the text box portion of this control.
HeaderProperty	Identifies the Header dependency property.
Height	Gets or sets the suggested height of a FrameworkElement. (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. (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. (Inherited from FrameworkElement)
HorizontalContentAlignment	Gets or sets the horizontal alignment of the control's content. (Inherited from Control)
IsAccessKeyScope	Gets or sets a value that indicates whether an element defines its own access key scope. (Inherited from UIElement)
IsDoubleTapEnabled	Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)
IsEnabled	Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control)
IsFocusEngaged	Get or sets a value that indicates whether focus is constrained to the control when the user presses the A/Select button on a game controller. (Inherited from Control)
IsFocusEngagementEnabled	Get or sets a value that indicates whether focus can be constrained to the control when the user presses the A/Select button on a game controller. (Inherited from Control)
IsGrouping	Gets a value that indicates whether the control is using grouping. (Inherited from ItemsControl)
IsHitTestVisible	Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)
IsHoldingEnabled	Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)
IsLoaded	Gets a value that indicates whether the element has been added to the element tree and is ready for interaction. (Inherited from FrameworkElement)
IsRightTapEnabled	Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)
IsSuggestionListOpen	Gets or sets a Boolean value indicating whether the drop-down portion of the AutoSuggestBox is open.
IsSuggestionListOpenProperty	Identifies the IsSuggestionListOpen dependency property.
IsTabStop	Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from UIElement)
IsTapEnabled	Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)
IsTextScaleFactorEnabled	Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from Control)
ItemContainerGenerator	Gets the ItemContainerGenerator associated with this ItemsControl. (Inherited from ItemsControl)
ItemContainerStyle	Gets or sets the style that is used when rendering the item containers for an ItemsControl. (Inherited from ItemsControl)
ItemContainerStyleSelector	Gets or sets a reference to a custom StyleSelector logic class. The StyleSelector returns different Style values to use for the item container based on characteristics of the object being displayed. (Inherited from ItemsControl)
ItemContainerTransitions	Gets or sets the collection of Transition style elements that apply to the item containers of an ItemsControl. (Inherited from ItemsControl)
Items	Gets the collection used to generate the content of the control. (Inherited from ItemsControl)
ItemsPanel	Gets or sets the template that defines the panel that controls the layout of items. (Inherited from ItemsControl)
ItemsPanelRoot	Gets the Panel specified by ItemsPanel. (Inherited from ItemsControl)
ItemsSource	Gets or sets an object source used to generate the content of the ItemsControl. (Inherited from ItemsControl)
ItemTemplate	Gets or sets the DataTemplate used to display each item. (Inherited from ItemsControl)
ItemTemplateSelector	Gets or sets a reference to a custom DataTemplateSelector logic class. The DataTemplateSelector referenced by this property returns a template to apply to items. (Inherited from ItemsControl)
KeyboardAcceleratorPlacementMode	Gets or sets a value that indicates whether the control tooltip displays the key combination for its associated keyboard accelerator. (Inherited from UIElement)
KeyboardAcceleratorPlacementTarget	Gets or sets a value that indicates the control tooltip that displays the accelerator key combination. (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 (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. (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. (Inherited from UIElement)
KeyTipTarget	Gets or sets a value that indicates the element targeted by the access key Key Tip. (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. (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. (Inherited from FrameworkElement)
LightDismissOverlayMode	Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened.
LightDismissOverlayModeProperty	Identifies the LightDismissOverlayMode dependency property.
Lights	Gets the collection of XamlLight objects attached to this element. (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. (Inherited from UIElement)
Margin	Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)
MaxHeight	Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MaxSuggestionListHeight	Gets or set the maximum height for the drop-down portion of the AutoSuggestBox control.
MaxSuggestionListHeightProperty	Identifies the MaxSuggestionListHeight dependency property.
MaxWidth	Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinHeight	Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinWidth	Gets or sets the minimum width constraint of a FrameworkElement. (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. (Inherited from FrameworkElement)
Opacity	Gets or sets the degree of the object's opacity. (Inherited from UIElement)
OpacityTransition	Gets or sets the ScalarTransition that animates changes to the Opacity property. (Inherited from UIElement)
Padding	Gets or sets the padding inside a control. (Inherited from Control)
Parent	Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)
PlaceholderText	Gets or sets the placeholder text to be displayed in the control.
PlaceholderTextProperty	Identifies the PlaceholderText dependency property.
PointerCaptures	Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)
Projection	Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)
ProtectedCursor	Gets or sets the cursor that displays when the pointer is over this element. Defaults to null, indicating no change to the cursor. (Inherited from UIElement)
QueryIcon	Gets or sets the graphic content of the button that is clicked to initiate a query.
QueryIconProperty	Identifies the QueryIcon dependency property.
RasterizationScale	Gets a value that represents the number of raw (physical) pixels for each view pixel. (Inherited from UIElement)
RenderSize	Gets the final render size of a UIElement. Use is not recommended, see Remarks. (Inherited from UIElement)
RenderTransform	Gets or sets transform information that affects the rendering position of a UIElement. (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. (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. (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 a keyboard or game controller. (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. (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. (Inherited from UIElement)
RotationAxis	Gets or sets the axis to rotate the element around. (Inherited from UIElement)
RotationTransition	Gets or sets the ScalarTransition that animates changes to the Rotation property. (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. (Inherited from UIElement)
ScaleTransition	Gets or sets the Vector3Transition that animates changes to the Scale property. (Inherited from UIElement)
Shadow	Gets or sets the shadow effect cast by the element. (Inherited from UIElement)
Style	Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)
TabFocusNavigation	Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from UIElement)
TabIndex	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls using the Tab key. (Inherited from UIElement)
TabNavigation	Gets or sets a value that modifies how tabbing and UIElement.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. (Inherited from Control)
Tag	Gets or sets an arbitrary object value that can be used to store custom information about this object. (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. (Inherited from Control)
Text	Gets or sets the text that is shown in the control.
TextBoxStyle	Gets or sets the style of the auto-suggest text box.
TextBoxStyleProperty	Identifies the TextBoxStyle dependency property.
TextMemberPath	Gets or sets the property path that is used to get the value for display in the text box portion of the AutoSuggestBox control, when an item is selected.
TextMemberPathProperty	Identifies the TextMemberPath dependency property.
TextProperty	Identifies the PlaceholderText dependency property.
Transform3D	Gets or sets the 3-D transform effect to apply when rendering this element. (Inherited from UIElement)
TransformMatrix	Gets or sets the transformation matrix to apply to the element. (Inherited from UIElement)
Transitions	Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)
Translation	Gets or sets the x, y, and z rendering position of the element. (Inherited from UIElement)
TranslationTransition	Gets or sets the Vector3Transition that animates changes to the Translation property. (Inherited from UIElement)
Triggers	Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks. (Inherited from FrameworkElement)
UpdateTextOnSelect	Used in conjunction with TextMemberPath, gets or sets a value indicating whether items in the view will trigger an update of the editable text part of the AutoSuggestBox when clicked.
UpdateTextOnSelectProperty	Identifies the UpdateTextOnSelect dependency property.
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. (Inherited from UIElement)
UseSystemFocusVisuals	Gets or sets a value that indicates whether the control uses focus visuals drawn by the system or focus visuals defined in the control template. (Inherited from UIElement)
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. (Inherited from FrameworkElement)
VerticalContentAlignment	Gets or sets the vertical alignment of the control's content. (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. (Inherited from UIElement)
Width	Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)
XamlRoot	Gets or sets the `XamlRoot` in which this element is being viewed. (Inherited from UIElement)
XYFocusDown	Gets or sets the object that gets focus when a user presses down on the Directional Pad (D-pad) of a game controller. (Inherited from UIElement)
XYFocusDownNavigationStrategy	Gets or sets a value that specifies the strategy used to determine the target element of a down navigation. (Inherited from UIElement)
XYFocusKeyboardNavigation	Gets or sets a value that enables or disables navigation using the keyboard directional arrows. (Inherited from UIElement)
XYFocusLeft	Gets or sets the object that gets focus when a user presses left on the Directional Pad (D-pad) of a game controller. (Inherited from UIElement)
XYFocusLeftNavigationStrategy	Gets or sets a value that specifies the strategy used to determine the target element of a left navigation. (Inherited from UIElement)
XYFocusRight	Gets or sets the object that gets focus when a user presses right on the Directional Pad (D-pad) of a game controller. (Inherited from UIElement)
XYFocusRightNavigationStrategy	Gets or sets a value that specifies the strategy used to determine the target element of a right navigation. (Inherited from UIElement)
XYFocusUp	Gets or sets the object that gets focus when a user presses up on the Directional Pad (D-pad) of a game controller. (Inherited from UIElement)
XYFocusUpNavigationStrategy	Gets or sets a value that specifies the strategy used to determine the target element of an up navigation. (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. (Inherited from UIElement)
ApplyTemplate()	Loads the relevant control template so that its parts can be referenced. (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. (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. (Inherited from FrameworkElement)
CancelDirectManipulations()	Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer(Pointer)	Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ClearContainerForItemOverride(DependencyObject, Object)	Undoes the effects of the PrepareContainerForItemOverride method. (Inherited from ItemsControl)
ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
ContainerFromIndex(Int32)	Returns the container for the item at the specified index within the ItemCollection. (Inherited from ItemsControl)
ContainerFromItem(Object)	Returns the container corresponding to the specified item. (Inherited from ItemsControl)
FindName(String)	Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)	Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
Focus(FocusState)	Attempts to set focus to this element. (Inherited from UIElement)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBindingExpression(DependencyProperty)	Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetChildrenInTabFocusOrder()	Enables a UIElement subclass to expose child elements that take part in Tab focus. (Inherited from UIElement)
GetContainerForItemOverride()	Creates or identifies the element that is used to display the given item. (Inherited from ItemsControl)
GetTemplateChild(String)	Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GetVisualInternal()	Retrieves the `Visual` that the element resolves to. (Inherited from UIElement)
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. (Inherited from FrameworkElement)
GroupHeaderContainerFromItemContainer(DependencyObject)	Returns the group header container that corresponds to the specified container element. (Inherited from ItemsControl)
IndexFromContainer(DependencyObject)	Returns the index to the item that has the specified, generated container. (Inherited from ItemsControl)
InvalidateArrange()	Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure()	Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
InvalidateViewport()	Invalidates the viewport state for a UIElement that is used to calculate the effective viewport. (Inherited from FrameworkElement)
IsItemItsOwnContainerOverride(Object)	Determines whether the specified item is (or is eligible to be) its own container. (Inherited from ItemsControl)
ItemFromContainer(DependencyObject)	Returns the item that corresponds to the specified, generated container. (Inherited from ItemsControl)
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. (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. (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. (Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)	Called before the BringIntoViewRequested event occurs. (Inherited from UIElement)
OnCharacterReceived(CharacterReceivedRoutedEventArgs)	Called before the CharacterReceived event occurs. (Inherited from Control)
OnCreateAutomationPeer()	When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (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. (Inherited from UIElement)
OnDoubleTapped(DoubleTappedRoutedEventArgs)	Called before the DoubleTapped event occurs. (Inherited from Control)
OnDragEnter(DragEventArgs)	Called before the DragEnter event occurs. (Inherited from Control)
OnDragLeave(DragEventArgs)	Called before the DragLeave event occurs. (Inherited from Control)
OnDragOver(DragEventArgs)	Called before the DragOver event occurs. (Inherited from Control)
OnDrop(DragEventArgs)	Called before the Drop event occurs. (Inherited from Control)
OnGotFocus(RoutedEventArgs)	Called before the GotFocus event occurs. (Inherited from Control)
OnGroupStyleSelectorChanged(GroupStyleSelector, GroupStyleSelector)	Invoked when the value of the GroupStyleSelector property changes. (Inherited from ItemsControl)
OnHolding(HoldingRoutedEventArgs)	Called before the Holding event occurs. (Inherited from Control)
OnItemContainerStyleChanged(Style, Style)	Invoked when the value of the ItemContainerStyle property changes. (Inherited from ItemsControl)
OnItemContainerStyleSelectorChanged(StyleSelector, StyleSelector)	Invoked when the value of the ItemContainerStyleSelector property changes. (Inherited from ItemsControl)
OnItemsChanged(Object)	Invoked when the value of the Items property changes. (Inherited from ItemsControl)
OnItemTemplateChanged(DataTemplate, DataTemplate)	Invoked when the value of the ItemTemplate property changes. (Inherited from ItemsControl)
OnItemTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)	Invoked when the value of the ItemTemplateSelector property changes. (Inherited from ItemsControl)
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. (Inherited from UIElement)
OnKeyDown(KeyRoutedEventArgs)	Called before the KeyDown event occurs. (Inherited from Control)
OnKeyUp(KeyRoutedEventArgs)	Called before the KeyUp event occurs. (Inherited from Control)
OnLostFocus(RoutedEventArgs)	Called before the LostFocus event occurs. (Inherited from Control)
OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)	Called before the ManipulationCompleted event occurs. (Inherited from Control)
OnManipulationDelta(ManipulationDeltaRoutedEventArgs)	Called before the ManipulationDelta event occurs. (Inherited from Control)
OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)	Called before the ManipulationInertiaStarting event occurs. (Inherited from Control)
OnManipulationStarted(ManipulationStartedRoutedEventArgs)	Called before the ManipulationStarted event occurs. (Inherited from Control)
OnManipulationStarting(ManipulationStartingRoutedEventArgs)	Called before the ManipulationStarting event occurs. (Inherited from Control)
OnPointerCanceled(PointerRoutedEventArgs)	Called before the PointerCanceled event occurs. (Inherited from Control)
OnPointerCaptureLost(PointerRoutedEventArgs)	Called before the PointerCaptureLost event occurs. (Inherited from Control)
OnPointerEntered(PointerRoutedEventArgs)	Called before the PointerEntered event occurs. (Inherited from Control)
OnPointerExited(PointerRoutedEventArgs)	Called before the PointerExited event occurs. (Inherited from Control)
OnPointerMoved(PointerRoutedEventArgs)	Called before the PointerMoved event occurs. (Inherited from Control)
OnPointerPressed(PointerRoutedEventArgs)	Called before the PointerPressed event occurs. (Inherited from Control)
OnPointerReleased(PointerRoutedEventArgs)	Called before the PointerReleased event occurs. (Inherited from Control)
OnPointerWheelChanged(PointerRoutedEventArgs)	Called before the PointerWheelChanged event occurs. (Inherited from Control)
OnPreviewKeyDown(KeyRoutedEventArgs)	Called before the PreviewKeyDown event occurs. (Inherited from Control)
OnPreviewKeyUp(KeyRoutedEventArgs)	Called before the PreviewKeyUp event occurs. (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. (Inherited from UIElement)
OnRightTapped(RightTappedRoutedEventArgs)	Called before the RightTapped event occurs. (Inherited from Control)
OnTapped(TappedRoutedEventArgs)	Called before the Tapped event occurs. (Inherited from Control)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)	When overridden in a derived class, defines a property that can be animated. (Inherited from UIElement)
PrepareContainerForItemOverride(DependencyObject, Object)	Prepares the specified element to display the specified item. (Inherited from ItemsControl)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
ReleasePointerCapture(Pointer)	Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures()	Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveFocusEngagement()	Releases the control from focus constraints that support game controller interactions (where IsFocusEngaged is true). (Inherited from Control)
RemoveHandler(RoutedEvent, Object)	Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
SetBinding(DependencyProperty, BindingBase)	Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase)	Begins the specified animation on the element. (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. (Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions)	Initiates a request to the XAML framework to bring the element into view using the specified options. (Inherited from UIElement)
StartDragAsync(ExpPointerPoint)	(Inherited from UIElement)
StartDragAsync(PointerPoint)	Initiates a drag-and-drop operation. Important Not supported if a user runs the app in elevated mode, as an administrator. (Inherited from UIElement)
StopAnimation(ICompositionAnimationBase)	Stops the specified animation on the element. (Inherited from UIElement)
TransformToVisual(UIElement)	Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (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. (Inherited from UIElement)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)
UpdateLayout()	Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

Events

AccessKeyDisplayDismissed	Occurs when access keys should no longer be displayed. (Inherited from UIElement)
AccessKeyDisplayRequested	Occurs when the user requests that access keys be displayed. (Inherited from UIElement)
AccessKeyInvoked	Occurs when a user completes an access key sequence. (Inherited from UIElement)
ActualThemeChanged	Occurs when the ActualTheme property value has changed. (Inherited from FrameworkElement)
BringIntoViewRequested	Occurs when StartBringIntoView is called on this element or one of its descendants. (Inherited from UIElement)
CharacterReceived	Occurs when a single, composed character is received by the input queue. (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. (Inherited from UIElement)
ContextRequested	Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from UIElement)
DataContextChanged	Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DoubleTapped	Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DragEnter	Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave	Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver	Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
DragStarting	Occurs when a drag operation is initiated. (Inherited from UIElement)
Drop	Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
DropCompleted	Occurs when a drag-and-drop operation with this element as the source is ended. (Inherited from UIElement)
EffectiveViewportChanged	Occurs when the FrameworkElement's effective viewport changes. (Inherited from FrameworkElement)
FocusDisengaged	Occurs as focus is released from the control when the user presses the B/Back button on a game controller. (Inherited from Control)
FocusEngaged	Occurs as focus is constrained to the control when the user presses the A/Select button on a game controller. (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. (Inherited from UIElement)
GotFocus	Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete. (Inherited from UIElement)
Holding	Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
IsEnabledChanged	Occurs when the IsEnabled property changes. (Inherited from Control)
KeyDown	Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp	Occurs when a keyboard key is released while the UIElement has focus. (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. (Inherited from FrameworkElement)
Loaded	Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
Loading	Occurs when a FrameworkElement begins to load. (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. (Inherited from UIElement)
LostFocus	Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete. (Inherited from UIElement)
ManipulationCompleted	Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta	Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting	Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted	Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting	Occurs when the manipulation processor is first created. (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. (Inherited from UIElement)
PointerCanceled	Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost	Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered	Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited	Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved	Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed	Occurs when the pointer device initiates a Press action within this element. (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. (Inherited from UIElement)
PointerWheelChanged	Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
PreviewKeyDown	Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
PreviewKeyUp	Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
ProcessKeyboardAccelerators	Occurs when a keyboard shortcut (or accelerator) is pressed. (Inherited from UIElement)
QuerySubmitted	Occurs when the user submits a search query.
RightTapped	Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SizeChanged	Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
SuggestionChosen	Raised before the text content of the editable control component is updated.
Tapped	Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
TextChanged	Raised after the text content of the editable control component is updated.
Unloaded	Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)

Applies to

Share via