AutoCompleteBox Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Represents a control that provides a text box for user input and a drop-down that contains possible matches based on the input in the text box.
Inheritance Hierarchy
System.Object
System.Windows.DependencyObject
System.Windows.UIElement
System.Windows.FrameworkElement
System.Windows.Controls.Control
System.Windows.Controls.AutoCompleteBox
Namespace: System.Windows.Controls
Assembly: System.Windows.Controls.Input (in System.Windows.Controls.Input.dll)
Syntax
'Declaration
<TemplateVisualStateAttribute(Name := "Pressed", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "CommonStates")> _
<StyleTypedPropertyAttribute(Property := "TextBoxStyle", StyleTargetType := GetType(TextBox))> _
<StyleTypedPropertyAttribute(Property := "ItemContainerStyle", StyleTargetType := GetType(ListBox))> _
<TemplateVisualStateAttribute(Name := "InvalidFocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "Focused", GroupName := "FocusStates")> _
<ContentPropertyAttribute("ItemsSource")> _
<TemplatePartAttribute(Name := "Selector", Type := GetType(Selector))> _
<TemplatePartAttribute(Name := "Text", Type := GetType(TextBox))> _
<TemplatePartAttribute(Name := "Popup", Type := GetType(Popup))> _
<TemplateVisualStateAttribute(Name := "InvalidUnfocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "Unfocused", GroupName := "FocusStates")> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "MouseOver", GroupName := "CommonStates")> _
<TemplatePartAttribute(Name := "SelectionAdapter", Type := GetType(ISelectionAdapter))> _
<TemplateVisualStateAttribute(Name := "PopupClosed", GroupName := "PopupStates")> _
<TemplateVisualStateAttribute(Name := "PopupOpened", GroupName := "PopupStates")> _
<TemplateVisualStateAttribute(Name := "Valid", GroupName := "ValidationStates")> _
Public Class AutoCompleteBox _
Inherits Control
[TemplateVisualStateAttribute(Name = "Pressed", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[StyleTypedPropertyAttribute(Property = "TextBoxStyle", StyleTargetType = typeof(TextBox))]
[StyleTypedPropertyAttribute(Property = "ItemContainerStyle", StyleTargetType = typeof(ListBox))]
[TemplateVisualStateAttribute(Name = "InvalidFocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "Focused", GroupName = "FocusStates")]
[ContentPropertyAttribute("ItemsSource")]
[TemplatePartAttribute(Name = "Selector", Type = typeof(Selector))]
[TemplatePartAttribute(Name = "Text", Type = typeof(TextBox))]
[TemplatePartAttribute(Name = "Popup", Type = typeof(Popup))]
[TemplateVisualStateAttribute(Name = "InvalidUnfocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "MouseOver", GroupName = "CommonStates")]
[TemplatePartAttribute(Name = "SelectionAdapter", Type = typeof(ISelectionAdapter))]
[TemplateVisualStateAttribute(Name = "PopupClosed", GroupName = "PopupStates")]
[TemplateVisualStateAttribute(Name = "PopupOpened", GroupName = "PopupStates")]
[TemplateVisualStateAttribute(Name = "Valid", GroupName = "ValidationStates")]
public class AutoCompleteBox : Control
<sdk:AutoCompleteBox .../>
The AutoCompleteBox type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
AutoCompleteBox | Initializes a new instance of the AutoCompleteBox class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
|
AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.) |
|
Background | Gets or sets a brush that provides the background of the control. (Inherited from Control.) |
|
BorderBrush | Gets or sets a brush that describes the border background 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 when possible. (Inherited from UIElement.) |
|
CharacterSpacing | Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.) |
|
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
|
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
|
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
.gif "Protected property") |
DefaultStyleKey | Gets or sets the key that references the default style for the control. (Inherited from Control.) |
|
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
|
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) |
|
FilterMode | Gets or sets how the text in the text box is used to filter items specified by the ItemsSource property for display in the drop-down. |
|
FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (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.) |
|
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
IsDropDownOpen | Gets or sets a value that indicates whether the drop-down portion of the control is open. |
|
IsEnabled | Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.) |
|
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
|
IsTabStop | Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.) |
|
IsTextCompletionEnabled | Gets or sets a value that indicates whether the first possible match found during the filtering process will be displayed automatically in the text box. |
|
ItemContainerStyle | Gets or sets the Style that is applied to the selection adapter contained in the drop-down portion of the AutoCompleteBox control. |
|
ItemFilter | Gets or sets the custom method that uses the user-entered text to filter the items specified by the ItemsSource property for display in the drop-down. |
|
ItemsSource | Gets or sets a collection that is used to generate the items for the drop-down portion of the AutoCompleteBox control. |
|
ItemTemplate | Gets or sets the DataTemplate used to display each item in the drop-down portion of the control. |
|
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
|
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxDropDownHeight | Gets or sets the maximum height of the drop-down portion of the AutoCompleteBox control. |
|
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
MinimumPopulateDelay | Gets or sets the minimum delay, in milliseconds, after text is typed in the text box before the AutoCompleteBox control populates the list of possible matches in the drop-down. |
|
MinimumPrefixLength | Gets or sets the minimum number of characters required to be entered in the text box before the AutoCompleteBox displays possible matches. |
|
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.) |
|
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (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.) |
|
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
|
RenderSize | Gets the final render size of a UIElement. (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.) |
|
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.) |
|
SearchText | Gets the text that is used to filter items in the ItemsSource item collection. |
|
SelectedItem | Gets or sets the selected item in the drop-down. |
|
SelectionAdapter | Gets or sets the selection adapter used to populate the drop-down with a list of selectable items. |
|
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
|
TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.) |
|
TabNavigation | Gets or sets a value that modifies how tabbing and TabIndex work for this control. (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. (Inherited from Control.) |
|
Text | Gets or sets the text in the text box portion of the AutoCompleteBox control. |
|
TextBoxStyle | Gets or sets the Style applied to the text box portion of the AutoCompleteBox control. |
|
TextFilter | Gets or sets the custom method that uses the user-entered text to filter items specified by the ItemsSource property in a text-based way for display in the drop-down. |
|
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
ValueMemberBinding | Gets or sets the Binding that is used to get the value for display in the text box portion of the AutoCompleteBox control, and to filter items for display in the drop-down. |
|
ValueMemberPath | Gets or sets the property path that is used to get the value for display in the text box portion of the AutoCompleteBox control, and to filter items for display in the drop-down. |
|
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 does not render and does not communicate its desired size to layout. (Inherited from UIElement.) |
|
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddHandler | 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 for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) |
|
ApplyTemplate | Loads the relevant control template so that its parts can be referenced. (Inherited from Control.) |
|
Arrange | 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.) |
.gif "Protected method") |
ArrangeOverride | Arranges and sizes the AutoCompleteBox control and its contents. (Overrides FrameworkElement.ArrangeOverride(Size).) |
|
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) |
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
|
Focus | Attempts to set the focus on the control. (Inherited from Control.) |
|
FormatValue | Converts the specified object to a string by using the property values of the binding object specified by the ValueMemberBinding property. |
|
GetAnimationBaseValue | Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
|
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetSelectionAdapterPart | Returns the specified object as an ISelectionAdapter, if possible. |
|
GetTemplateChild | Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
HasFocus | Determines whether the text box or drop-down portion of the AutoCompleteBox control has focus. |
|
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.) |
|
Measure | 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 | Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnApplyTemplate | Builds the visual tree for the AutoCompleteBox control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().) |
|
OnCreateAutomationPeer | Returns a AutoCompleteBoxAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().) |
|
OnDragEnter | Called before the DragEnter event occurs. (Inherited from Control.) |
|
OnDragLeave | Called before the DragLeave event occurs. (Inherited from Control.) |
|
OnDragOver | Called before the DragOver event occurs. (Inherited from Control.) |
|
OnDrop | Called before the Drop event occurs. (Inherited from Control.) |
|
OnDropDownClosed | Raises the DropDownClosed event. |
|
OnDropDownClosing | Raises the DropDownClosing event. |
|
OnDropDownOpened | Raises the DropDownOpened event. |
|
OnDropDownOpening | Raises the DropDownOpening event. |
|
OnGotFocus | Provides handling for the GotFocus event. (Overrides Control.OnGotFocus(RoutedEventArgs).) |
|
OnKeyDown | Provides handling for the KeyDown event. (Overrides Control.OnKeyDown(KeyEventArgs).) |
|
OnKeyUp | Called before the KeyUp event occurs. (Inherited from Control.) |
|
OnLostFocus | Provides handling for the LostFocus event. (Overrides Control.OnLostFocus(RoutedEventArgs).) |
|
OnLostMouseCapture | Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) |
|
OnMouseEnter | Called before the MouseEnter event occurs. (Inherited from Control.) |
|
OnMouseLeave | Called before the MouseLeave event occurs. (Inherited from Control.) |
|
OnMouseLeftButtonDown | Called before the MouseLeftButtonDown event occurs. (Inherited from Control.) |
|
OnMouseLeftButtonUp | Called before the MouseLeftButtonUp event occurs. (Inherited from Control.) |
|
OnMouseMove | Called before the MouseMove event occurs. (Inherited from Control.) |
|
OnMouseRightButtonDown | Called before the MouseRightButtonDown event occurs. (Inherited from Control.) |
|
OnMouseRightButtonUp | Called before the MouseRightButtonUp event occurs. (Inherited from Control.) |
|
OnMouseWheel | Called before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) |
|
OnPopulated | Raises the Populated event |
|
OnPopulating | Raises the Populating event. |
|
OnSelectionChanged | Raises the SelectionChanged event. |
|
OnTextChanged | Raises the TextChanged event. |
|
OnTextInput | Called before the TextInput event occurs. (Inherited from Control.) |
|
OnTextInputStart | Called before the TextInputStart event occurs. (Inherited from Control.) |
|
OnTextInputUpdate | Called before the TextInputUpdate event occurs. (Inherited from Control.) |
|
PopulateComplete | Notifies the AutoCompleteBox that the ItemsSource property has been set and the data can be filtered to provide possible matches in the drop-down. |
|
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
|
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) |
|
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) |
|
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
|
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) |
|
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
|
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) |
|
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.) |
|
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) |
|
DropDownClosed | Occurs when the IsDropDownOpen property was changed from true to false and the drop-down is open. |
|
DropDownClosing | Occurs when the IsDropDownOpen property is changing from true to false. |
|
DropDownOpened | Occurs when the value of the IsDropDownOpen property has changed from false to true and the drop-down is open. |
|
DropDownOpening | Occurs when the value of the IsDropDownOpen property is changing from false to true. |
|
GotFocus | Occurs when a UIElement receives focus. (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 Silverlight visual tree changes. (Inherited from FrameworkElement.) |
|
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
|
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
|
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) |
|
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) |
|
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonDown | Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonUp | Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseMove | Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.) |
|
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) |
|
Populated | Occurs when the AutoCompleteBox has populated the drop-down with possible matches based on the Text property. |
|
Populating | Occurs when the AutoCompleteBox is populating the drop-down with possible matches based on the Text property. |
|
SelectionChanged | Occurs when the selected item in the drop-down portion of the AutoCompleteBox has changed. |
|
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
|
TextChanged | Occurs when the text in the text box portion of the AutoCompleteBox changes. |
|
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
|
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
FilterModeProperty | Gets the identifier for the FilterMode dependency property. |
|
IsDropDownOpenProperty | Identifies the IsDropDownOpen dependency property. |
|
IsTextCompletionEnabledProperty | Identifies the IsTextCompletionEnabled dependency property. |
|
ItemContainerStyleProperty | Identifies the ItemContainerStyle dependency property. |
|
ItemFilterProperty | Identifies the ItemFilter dependency property. |
|
ItemsSourceProperty | Identifies the ItemsSource dependency property. |
|
ItemTemplateProperty | Identifies the ItemTemplate dependency property. |
|
MaxDropDownHeightProperty | Identifies the MaxDropDownHeight dependency property. |
|
MinimumPopulateDelayProperty | Identifies the MinimumPopulateDelay dependency property. |
|
MinimumPrefixLengthProperty | Identifies the MinimumPrefixLength dependency property. |
|
SearchTextProperty | Identifies the SearchText dependency property. |
|
SelectedItemProperty | Identifies the SelectedItem dependency property. |
|
TextBoxStyleProperty | Identifies the TextBoxStyle dependency property. |
|
TextFilterProperty | Identifies the TextFilter dependency property. |
|
TextProperty | Identifies the Text dependency property. |
Top
Remarks
The AutoCompleteBox control allows users to select an item from the drop-down to complete their text box input rather than typing the entire entry. The drop-down of the AutoCompleteBox will populate with possible matches once the conditions established by the MinimumPopulateDelay and MinimumPrefixLength are met.
To provide items to be filtered and displayed in the drop-down list of the AutoCompleteBox, set the ItemsSource property.
The AutoCompleteBox includes several ways to specify what items in the ItemsSource list are displayed in the drop-down. The AutoCompleteBox can be configured to filter items by using predetermined text-based filtering methods or can be configured to use your own custom filtering methods. The default filter mode will match strings that start with the same characters the user enters in the textbox. To change how items are filtered, set the FilterMode property. You can optionally set the TextFilter or ItemFilter properties to change the filter methods.
The selection behavior of the drop-down is customizable and is determined by a selection adapter. A selection adapter is a control that typically implements the ISelectionAdapter interface. The default selection adapter is a ListBox control. You can display items in the default selection adapter with a data template by setting the ItemTemplate property. Alternatively, you can use a custom selection adapter in the drop-down portion of the control by creating a new template for the control that contains the custom selection adapter.
The following illustration shows an example of an AutoCompleteBox control and its parts.
.png "AutoCompleteBox control")
.gif "Note") Note: |
|---|
The AutoCompleteBox control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools. |
Customizing the AutoCompleteBox Control
The appearance of the AutoCompleteBox is customizable. You can change the style of the text box or the drop-down portion of the control by using the TextBoxStyle or ItemContainerStyle properties, respectively.
To apply the same property settings to multiple AutoCompleteBox controls, use the Style property. To change the visual structure and visual behavior of a AutoCompleteBox, copy and modify its default style and template. As mentioned previously, you can specify a new selection adapter when modifying the template for the control. For more information, see Control Customization.
Dependency properties for this control might be set by the default style of the control. If a dependency property for a AutoCompleteBox is set by its default style, the property might change from its default value when the AutoCompleteBox appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for AutoCompleteBox from AutoCompleteBox Styles and Templates.
| Note: |
|---|
Setting a visual property will only have an effect if that property is both present in AutoCompleteBox control's default template and is set by using a TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section of Customizing the Appearance of an Existing Control by Using a ControlTemplate. |
Examples
The following example shows an AutoCompleteBox that provides a list of cities to complete an entry in its text box. This code example requires a reference to the System.Windows.Controls.Input assembly.
public Page()
{
InitializeComponent();
List<string> cities = new List<string>();
cities.Add("London");
cities.Add("Seattle");
cities.Add("Tokyo");
cities.Add("Nairobi");
cities.Add("Lisbon");
cities.Add("New York");
cities.Add("Paris");
cities.Add("San Francisco");
citiesACB.ItemsSource = cities;
}
<Border BorderThickness="3" BorderBrush="Black">
<StackPanel Background="LightGray">
<TextBlock Text="AutoCompleteBox Control" Margin="5"/>
<StackPanel x:Name="LayoutRoot" Orientation="Horizontal">
<TextBlock Text="Destination: " Margin="5" VerticalAlignment="Center" />
<sdk:AutoCompleteBox x:Name="citiesACB" Width="200" />
</StackPanel>
</StackPanel>
</Border>
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also