Class RadAutoSuggestBox
Represents a text control that makes suggestions to users as they enter text using a keyboard. The app is notified when text has been changed by the user and is responsible for providing relevant suggestions for this control to display.
Inheritance
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll
Syntax
[TelerikToolboxCategory("Input")]
public class RadAutoSuggestBox : Control, IPopupWrapperOwner, IThemableConstructors
RadAutoSuggestBox()
Fields
ClearButtonCommandProperty
Identifies the Clear
Declaration
public static readonly DependencyProperty ClearButtonCommandPropertyField Value
|
System.
|
ClearButtonContentProperty
Identifies the Clear
Declaration
public static readonly DependencyProperty ClearButtonContentPropertyField Value
|
System.
|
ClearButtonContentTemplateProperty
Identifies the Clear
Declaration
public static readonly DependencyProperty ClearButtonContentTemplatePropertyField Value
|
System.
|
ClearButtonVisibilityProperty
Identifies the Clear
Declaration
public static readonly DependencyProperty ClearButtonVisibilityPropertyField Value
|
System.
|
DisplayMemberPathProperty
Identifies the Display
Declaration
public static readonly DependencyProperty DisplayMemberPathPropertyField Value
|
System.
|
GroupStyleSelectorProperty
Identifies the Group
Declaration
public static readonly DependencyProperty GroupStyleSelectorPropertyField Value
|
System.
|
IsDropDownOpenProperty
Identifies the Is
Declaration
public static readonly DependencyProperty IsDropDownOpenPropertyField Value
|
System.
|
ItemContainerStyleProperty
Identifies the Item
Declaration
public static readonly DependencyProperty ItemContainerStylePropertyField Value
|
System.
|
ItemContainerStyleSelectorProperty
Identifies the Item
Declaration
public static readonly DependencyProperty ItemContainerStyleSelectorPropertyField Value
|
System.
|
ItemsPanelProperty
Identifies the Items
Declaration
public static readonly DependencyProperty ItemsPanelPropertyField Value
|
System.
|
ItemsSourceProperty
Identifies the Items
Declaration
public static readonly DependencyProperty ItemsSourcePropertyField Value
|
System.
|
ItemTemplateProperty
Identifies the Item
Declaration
public static readonly DependencyProperty ItemTemplatePropertyField Value
|
System.
|
ItemTemplateSelectorProperty
Identifies the Item
Declaration
public static readonly DependencyProperty ItemTemplateSelectorPropertyField Value
|
System.
|
MaxDropDownHeightProperty
Identifies the Max
Declaration
public static readonly DependencyProperty MaxDropDownHeightPropertyField Value
|
System.
|
MaxDropDownWidthProperty
Identifies the Max
Declaration
public static readonly DependencyProperty MaxDropDownWidthPropertyField Value
|
System.
|
MinDropDownWidthProperty
Identifies the Min
Declaration
public static readonly DependencyProperty MinDropDownWidthPropertyField Value
|
System.
|
NoResultsContentProperty
Identifies the No
Declaration
public static readonly DependencyProperty NoResultsContentPropertyField Value
|
System.
|
NoResultsContentTemplateProperty
Identifies the No
Declaration
public static readonly DependencyProperty NoResultsContentTemplatePropertyField Value
|
System.
|
QueryButtonCommandProperty
Identifies the Query
Declaration
public static readonly DependencyProperty QueryButtonCommandPropertyField Value
|
System.
|
QueryButtonContentProperty
Identifies the Query
Declaration
public static readonly DependencyProperty QueryButtonContentPropertyField Value
|
System.
|
QueryButtonContentTemplateProperty
Identifies the Query
Declaration
public static readonly DependencyProperty QueryButtonContentTemplatePropertyField Value
|
System.
|
QueryButtonVisibilityProperty
Identifies the Query
Declaration
public static readonly DependencyProperty QueryButtonVisibilityPropertyField Value
|
System.
|
TextBoxStyleProperty
Identifies the Text
Declaration
public static readonly DependencyProperty TextBoxStylePropertyField Value
|
System.
|
TextMemberPathProperty
Identifies the Text
Declaration
public static readonly DependencyProperty TextMemberPathPropertyField Value
|
System.
|
TextProperty
Identifies the Text dependency property.
Declaration
public static readonly DependencyProperty TextPropertyField Value
|
System.
|
UpdateTextOnSuggestionChosenProperty
Identifies the Update
Declaration
public static readonly DependencyProperty UpdateTextOnSuggestionChosenPropertyField Value
|
System.
|
WatermarkBehaviorProperty
Identifies the Watermark
Declaration
public static readonly DependencyProperty WatermarkBehaviorPropertyField Value
|
System.
|
WatermarkContentProperty
Identifies the Watermark
Declaration
public static readonly DependencyProperty WatermarkContentPropertyField Value
|
System.
|
WatermarkTemplateProperty
Identifies the Watermark
Declaration
public static readonly DependencyProperty WatermarkTemplatePropertyField Value
|
System.
|
Properties
ClearButtonCommand
Gets or sets the command of the clear button.
Declaration
public ICommand ClearButtonCommand { get; set; }Property Value
|
System.
|
ClearButtonContent
Gets or sets content of the clear button.
Declaration
public object ClearButtonContent { get; set; }Property Value
|
System.
|
ClearButtonContentTemplate
Gets or sets the content template of the clear button.
Declaration
public DataTemplate ClearButtonContentTemplate { get; set; }Property Value
|
System.
|
ClearButtonVisibility
Gets or sets the visibility mode of the clear button.
Declaration
public ClearButtonVisibility ClearButtonVisibility { get; set; }Property Value
DisplayMemberPath
Gets or sets the property path that is used to get the value that is displayed for each data item in the drop-down of the control. The default is an empty string (""). This is a dependency property.
Declaration
public string DisplayMemberPath { get; set; }Property Value
|
System.
|
GroupStyle
Gets the GroupStyle of the drop-down ListBox.
Declaration
public ObservableCollection<GroupStyle> GroupStyle { get; }Property Value
|
System.
|
GroupStyleSelector
Gets or sets the group style selector of the drop-down ListBox.
Declaration
public GroupStyleSelector GroupStyleSelector { get; set; }Property Value
|
System.
|
IsDropDownOpen
Gets or sets the value that indicates whether the RadAutoSuggestBox dropdown is currently open. This is a dependency property.
Declaration
public bool IsDropDownOpen { get; set; }Property Value
|
System.
|
ItemContainerStyle
Gets or sets the ItemContainerStyle of the drop-down ListBox.
Declaration
public Style ItemContainerStyle { get; set; }Property Value
|
System.
|
ItemContainerStyleSelector
Gets or sets the ItemContainerStyleSelector of the drop-down ListBox.
Declaration
public StyleSelector ItemContainerStyleSelector { get; set; }Property Value
|
System.
|
ItemsPanel
Gets or sets the ItemsPanel of the drop-down ListBox.
Declaration
public ItemsPanelTemplate ItemsPanel { get; set; }Property Value
|
System.
|
ItemsSource
Gets or sets a collection that is shown in the drop-down. This is a dependency property.
Declaration
public IEnumerable ItemsSource { get; set; }Property Value
|
System.
|
ItemTemplate
Gets or sets the ItemTemplate of the drop-down ListBox.
Declaration
public DataTemplate ItemTemplate { get; set; }Property Value
|
System.
|
ItemTemplateSelector
Gets or sets the ItemTemplateSelector of the drop-down ListBox.
Declaration
public DataTemplateSelector ItemTemplateSelector { get; set; }Property Value
|
System.
|
MaxDropDownHeight
Gets or sets the maximum height for the drop-down. This is a dependency property.
Declaration
public double MaxDropDownHeight { get; set; }Property Value
|
System.
|
MaxDropDownWidth
Gets or sets the maximum width of the drop-down. This is a dependency property.
Declaration
public double MaxDropDownWidth { get; set; }Property Value
|
System.
|
MinDropDownWidth
Gets or sets the minimum width of the drop-down. This is a dependency property.
Declaration
public double MinDropDownWidth { get; set; }Property Value
|
System.
|
NoResultsContent
Gets or sets the content displayed in the drop-down if the ItemsSource is empty.
Declaration
public object NoResultsContent { get; set; }Property Value
|
System.
|
NoResultsContentTemplate
Gets or sets the DataTemplate used to display the content in the dropdown if the ItemsSource is empty.
Declaration
public DataTemplate NoResultsContentTemplate { get; set; }Property Value
|
System.
|
QueryButtonCommand
Gets or sets the command of the query button.
Declaration
public ICommand QueryButtonCommand { get; set; }Property Value
|
System.
|
QueryButtonContent
Gets or sets the content of the query button.
Declaration
public object QueryButtonContent { get; set; }Property Value
|
System.
|
QueryButtonContentTemplate
Gets or sets the content template of the query button.
Declaration
public DataTemplate QueryButtonContentTemplate { get; set; }Property Value
|
System.
|
QueryButtonVisibility
Gets or sets the visibility of the query button.
Declaration
public Visibility QueryButtonVisibility { get; set; }Property Value
|
System.
|
Text
Gets or sets the search text.
Declaration
public string Text { get; set; }Property Value
|
System.
|
TextBoxStyle
Gets or sets the style of the RadWatermarkTextBox into the RadAutoSuggestBox. This is a dependency property.
Declaration
public Style TextBoxStyle { get; set; }Property Value
|
System.
|
TextMemberPath
Gets or sets the property path that is used to get the value for display in the text box part of the control, when an item is chosen. This is a dependency property.
Declaration
public string TextMemberPath { get; set; }Property Value
|
System.
|
UpdateTextOnSuggestionChosen
Gets or sets a value indicating whether the chosen suggestion will trigger an update of the editable text part of Rad
Declaration
public bool UpdateTextOnSuggestionChosen { get; set; }Property Value
|
System.
|
WatermarkBehavior
Gets or sets a value that specifies when the watermark content of control will be hidden.
Declaration
public WatermarkBehavior WatermarkBehavior { get; set; }Property Value
WatermarkContent
Gets or sets the content to be shown when the TextBox is empty. This is a dependency property.
Declaration
public object WatermarkContent { get; set; }Property Value
|
System.
|
WatermarkTemplate
Gets or sets the template for presenting the content, shown when the TextBox is empty. This is a dependency property.
Declaration
public DataTemplate WatermarkTemplate { get; set; }Property Value
|
System.
|
Methods
HandleKeyDown(Key)
Contains the keyboard navigation logic of Rad
Declaration
protected virtual bool HandleKeyDown(Key key)Parameters
|
System. The key that has been pressed. |
Returns
|
System. True if the KeyDown event should be handled, otherwise false. |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.
Declaration
public override void OnApplyTemplate()OnCreateAutomationPeer()
Returns class-specific System.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
|
System. The type-specific System. |
OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)
Called before the System.Windows.UIElement.GotKeyboardFocus event occurs.
Declaration
protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)Parameters
|
System.
|
OnInitialized(EventArgs)
Raises the System.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
|
System. The System. |
OnIsDropDownOpenChanged()
Called when the Is
Declaration
protected virtual void OnIsDropDownOpenChanged()OnQuerySubmitted(String, Object)
Called when the user submits a search query.
Declaration
protected virtual void OnQuerySubmitted(string query, object suggestion)Parameters
|
System.
|
|
System.
|
OnSuggestionChosen(Object)
Called when suggestion is chosen from the drop-down.
Declaration
protected virtual void OnSuggestionChosen(object suggestion)Parameters
|
System.
|
OnTextBoxStyleChanged()
Called when the Text
Declaration
protected virtual void OnTextBoxStyleChanged()OnTextChanged(TextChangeReason)
Called when the text is changed - by user input, programmatically or via choosing a suggestion.
Declaration
protected virtual void OnTextChanged(TextChangeReason reason)Parameters
|
Text The reason for changing the text. |
ResetTheme()
Resets the theme.
Declaration
public void ResetTheme()Events
QuerySubmitted
Occurs when the user submits a search query.
Declaration
public event EventHandler<QuerySubmittedEventArgs> QuerySubmittedEvent Type
|
System.
|
SuggestionChosen
Occurs when a suggestion is chosen from the drop-down of the control.
Declaration
public event EventHandler<SuggestionChosenEventArgs> SuggestionChosenEvent Type
|
System.
|
TextChanged
Gets or sets the property path that is used to get the value for display in the text box part of the control, when an item is chosen. This is a dependency property. Occurs when the text is changed.
Declaration
public event EventHandler<TextChangedEventArgs> TextChangedEvent Type
|
System.
|