AutoCompleteBox Class

[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_Selector", Type = typeof(EmbeddedListBox))]
[TemplatePart(Name = "PART_TextBox", Type = typeof(EmbeddedTextBox))]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "PointerOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Focused", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
public class AutoCompleteBox : Control

public AutoCompleteBox()

public bool CanAutoSelectFirstItem { get; set; }

Property Value

bool:

true if the first item in the suggestion list can be selected under certain conditions, such as when typing is occurring; otherwise false. The default value is true.

public bool CanSelectAllOnUpdate { get; set; }

Property Value

bool:

true if the entire text should be selected following a text update, like a suggestion being chosen; otherwise false. The default value is true.

public CharacterCasing CharacterCasing { get; set; }

Property Value

CharacterCasing:

One of the CharacterCasing values that specifies how manually entered characters are cased. The default value is Normal.

public ICommand ClearCommand { get; }

Property Value

ICommand:

The ICommand that clears the text value.

public IDataFilter DataFilter { get; set; }

Property Value

IDataFilter:

The IDataFilter to use for matching suggested items.

public string DisplayMemberPath { get; set; }

Property Value

string:

The name of the property that provides each item's text within the suggestion list.

protected virtual string FilterText { get; }

Property Value

string:

The text against which suggested items should be filtered.

Remarks

The default implementation of this property returns the Text property value.

public IEnumerable FilteredItemsSource { get; }

Property Value

IEnumerable:

The filtered collection of suggested items to display in the suggestion list.

public bool HasClearButton { get; set; }

Property Value

bool:

true if the control has a clear button when there is text; otherwise false. The default value is false.

Remarks

When the InputMode is ComboBox, the clear button will only be displayed if the control is focused.

public bool HasItems { get; }

Property Value

bool:

true if there is at least one suggested item in the suggestion list; otherwise, false. The default value is false.

public bool HasPopupButton { get; set; }

Property Value

bool:

true if the control has a popup button; otherwise false. The default value is true.

public AutoCompleteBoxInputMode InputMode { get; set; }

Property Value

AutoCompleteBoxInputMode:

An AutoCompleteBoxInputMode that indicates the input mode. The default value is Search.

public bool IsClearButtonVisible { get; }

Property Value

bool:

true if the clear button is visible; otherwise false. The default value is false.

Remarks

The HasClearButton property and other state-related info determines whether the clear button is visible.

public bool IsNonDefaultUsageContext { get; }

Property Value

bool:

true if a non-default UsageContext is currently in effect; otherwise, false. The default value is false.

public bool IsPopupButtonVisible { get; }

Property Value

bool:

true if the toggle popup button is visible; otherwise false. The default value is false.

Remarks

The HasPopupButton property determines whether the toggle popup button is visible.

public bool IsPopupOpen { get; set; }

Property Value

bool:

true if the popup is open; otherwise, false. The default value is false.

public bool IsPopupOpenedOnFocus { get; set; }

Property Value

bool:

true if the popup automatically opens when the control gains focus; otherwise, false. The default value is false.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if the control is read-only; otherwise false. The default value is false.

public Style ItemContainerStyle { get; set; }

Property Value

Style:

The Style that is applied to the container generated for each item. The default value is null.

public StyleSelector ItemContainerStyleSelector { get; set; }

Property Value

StyleSelector:

A StyleSelector object that contains logic that chooses the style to use as the ItemContainerStyle. The default value is null.

public DataTemplate ItemTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate used to render items in the suggestion list.

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector used to render items in the suggestion list.

public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable:

The collection of suggested items that is filtered based on the user-entered text.

public double MaxPopupHeight { get; set; }

Property Value

double:

The maximum height of the popup. The default value is 500.

public int MinCharacterCountToOpenPopup { get; set; }

Property Value

int:

The minimum number of characters that need to be typed to open the popup. The default value is 1.

public object NoItemsContent { get; set; }

Property Value

object:

The content to display when the popup is open but there are no suggested items.

public DataTemplate NoItemsContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to display when the popup is open but there are no suggested items.

public string PlaceholderText { get; set; }

Property Value

string:

The placeholder text to be displayed in the control.

public object PopupHeader { get; set; }

Property Value

object:

The header content in the suggestion list popup.

public DataTemplate PopupHeaderTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate used to render the header in the suggestion list popup.

public DataTemplateSelector PopupHeaderTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector used to render the header in the suggestion list popup.

public object SelectedItem { get; set; }

Property Value

object:

The selected suggested item.

public string Text { get; set; }

Property Value

string:

The text being edited in the control.

public TextAlignment TextAlignment { get; set; }

Property Value

TextAlignment:

The text alignment of the text editing area. The default value is TextAlignment.Left.

public string TextMemberPath { get; set; }

Property Value

string:

The name of the property that provides each item's text.

public ControlUsageContext UsageContext { get; set; }

Property Value

ControlUsageContext:

The usage context of the control, which may alter its appearance. The default value is ControlUsageContext.Default.

protected virtual string ConvertToString(object itemToConvert)

Parameter	Type	Description
itemToConvert	object	The suggested item to convert.

Returns

string:

The string representation of the specified suggested item.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected override void OnGotFocus(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	A DependencyPropertyChangedEventArgs that contains the event data.

protected override void OnLostMouseCapture(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains the event data.

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameter	Type	Description
e	MouseWheelEventArgs	The MouseWheelEventArgs that contains the event data.

protected override void OnPreviewMouseDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs that contains the event data.

protected virtual void OnSelectedItemChanged(AutoCompleteBoxEventArgs e)

Parameter	Type	Description
e	AutoCompleteBoxEventArgs	The AutoCompleteBoxEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnSubmitted(AutoCompleteBoxEventArgs e)

Parameter	Type	Description
e	AutoCompleteBoxEventArgs	The AutoCompleteBoxEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnSuggestionChosen(AutoCompleteBoxEventArgs e)

Parameter	Type	Description
e	AutoCompleteBoxEventArgs	The AutoCompleteBoxEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnTextChanged(AutoCompleteBoxEventArgs e)

Parameter	Type	Description
e	AutoCompleteBoxEventArgs	The AutoCompleteBoxEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

public void SelectAll()

public event EventHandler<AutoCompleteBoxEventArgs> SelectedItemChanged

Event Type

EventHandler<AutoCompleteBoxEventArgs>

public event EventHandler<AutoCompleteBoxEventArgs> Submitted

Event Type

EventHandler<AutoCompleteBoxEventArgs>

public event EventHandler<AutoCompleteBoxEventArgs> SuggestionChosen

Event Type

EventHandler<AutoCompleteBoxEventArgs>

public event EventHandler<AutoCompleteBoxEventArgs> TextChanged

Event Type

EventHandler<AutoCompleteBoxEventArgs>

public static readonly DependencyProperty CanAutoSelectFirstItemProperty

public static readonly DependencyProperty CanSelectAllOnUpdateProperty

public static readonly DependencyProperty CharacterCasingProperty

public static readonly DependencyProperty DataFilterProperty

public static readonly DependencyProperty DisplayMemberPathProperty

public static readonly DependencyProperty HasClearButtonProperty

public static readonly DependencyProperty HasItemsProperty

public static readonly DependencyProperty HasPopupButtonProperty

public static readonly DependencyProperty InputModeProperty

public static readonly DependencyProperty IsClearButtonVisibleProperty

public static readonly DependencyProperty IsNonDefaultUsageContextProperty

public static readonly DependencyProperty IsPopupButtonVisibleProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsPopupOpenedOnFocusProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty ItemContainerStyleProperty

public static readonly DependencyProperty ItemContainerStyleSelectorProperty

public static readonly DependencyProperty ItemTemplateProperty

public static readonly DependencyProperty ItemTemplateSelectorProperty

public static readonly DependencyProperty ItemsSourceProperty

public static readonly DependencyProperty MaxPopupHeightProperty

public static readonly DependencyProperty MinCharacterCountToOpenPopupProperty

public static readonly DependencyProperty NoItemsContentProperty

public static readonly DependencyProperty NoItemsContentTemplateProperty

public static readonly DependencyProperty PlaceholderTextProperty

public static readonly DependencyProperty PopupHeaderProperty

public static readonly DependencyProperty PopupHeaderTemplateProperty

public static readonly DependencyProperty PopupHeaderTemplateSelectorProperty

public static readonly RoutedEvent SelectedItemChangedEvent

public static readonly DependencyProperty SelectedItemProperty

public static readonly RoutedEvent SubmittedEvent

public static readonly RoutedEvent SuggestionChosenEvent

public static readonly DependencyProperty TextAlignmentProperty

public static readonly RoutedEvent TextChangedEvent

public static readonly DependencyProperty TextMemberPathProperty

public static readonly DependencyProperty TextProperty

public static readonly DependencyProperty UsageContextProperty