ClassRadAutoCompleteBoxElement
Represents a auto-complete tokenized text box element
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadAutoCompleteBoxElement : RadTextBoxControlElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementScrollViewElement<TextBoxViewElement>RadTextBoxControlElementRadAutoCompleteBoxElement
Derived Classes:
Implements:
Inherited Members
Constructors
RadAutoCompleteBoxElement()
Initializes a new instance of the RadAutoCompleteBoxElement class.
Declaration
public RadAutoCompleteBoxElement()Properties
AllowDuplicates
Gets or sets whether already selected items can be suggested.
AutoCompleteDropDownLocation
Gets or sets the auto complete drop down location.
Declaration
protected Point AutoCompleteDropDownLocation { get; set; }Property Value
The auto complete popup location.
AutoCompleteValueMember
Gets or sets a property name which will be used to extract a value from the data items
Declaration
public string AutoCompleteValueMember { get; set; }Property Value
AutoCompleteViewElement
Gets the auto complete view element.
Declaration
protected AutoCompleteBoxViewElement AutoCompleteViewElement { get; }Property Value
CanPerformAutoComplete
Gets a value indicating whether this text box can perform auto complete operation.
Declaration
protected override bool CanPerformAutoComplete { get; }Property Value
true if auto-completion is enabled and the text box is single-line; otherwise, false.
Overrides
Delimiter
Gets or sets the delimiter used to tokenize the text
Declaration
public char Delimiter { get; set; }Property Value
The delimiter.
Items
Gets the tokenized items.
Declaration
public RadTokenizedTextItemCollection Items { get; }Property Value
ShowRemoveButton
Gets or sets a value indicating whether the remove button of TokenizedTextBlockElement should appear. Notice that the text box should not be in read only mode
Declaration
public bool ShowRemoveButton { get; set; }Property Value
true if [show remove button]; otherwise, false.
Methods
CloseDropDown(RadPopupCloseReason)
Closes the drop down.
Declaration
public override void CloseDropDown(RadPopupCloseReason reason)Parameters
reason
The reason for closing the dropdown.
Overrides
CreateChildElements()
Creates the child elements that comprise the text box control, including the view element, scrollbars, caret, and supporting components.
Declaration
protected override void CreateChildElements()Overrides
CreateListElement()
Creates the auto-complete list element.
Declaration
protected override RadTextBoxListElement CreateListElement()Returns
A new instance of RadTextBoxListElement for displaying auto-completion suggestions.
Overrides
CreateTokenizedItemCollection()
Creates the tokenized item collection.
Declaration
protected virtual RadTokenizedTextItemCollection CreateTokenizedItemCollection()Returns
CreateViewElement()
Creates the view element.
Declaration
protected override TextBoxViewElement CreateViewElement()Returns
Overrides
GetAutoCompleteDropDownLocation()
Gets the auto-complete drop down location.
Declaration
protected override Point GetAutoCompleteDropDownLocation()Returns
The screen coordinates where the auto-complete dropdown should be positioned.
Overrides
GetFirstAutoCompletePosition()
Gets the first position for auto-completion text within the view element.
Declaration
protected override TextPosition GetFirstAutoCompletePosition()Returns
The text position representing the start of auto-completion.
Overrides
GetLastAutoCompletePosition()
Gets the last position for auto-completion text within the view element.
Declaration
protected override TextPosition GetLastAutoCompletePosition()Returns
The text position representing the end of auto-completion.
Overrides
HideDuplicates()
Declaration
protected virtual void HideDuplicates()InitializeFields()
Initializes the default field values for the text box control element.
Declaration
protected override void InitializeFields()Overrides
IsValidAutoCompletePosition()
Determines whether the current position is valid for the auto-complete operation
Declaration
protected override bool IsValidAutoCompletePosition()Returns
true if [is valid auto complete position]; otherwise, false.
Overrides
OnAutoCompleteDropDownClosed(RadAutoCompleteDropDownClosedEventArgs)
Called when the auto-complete dropdown is closed.
Declaration
protected override void OnAutoCompleteDropDownClosed(RadAutoCompleteDropDownClosedEventArgs e)Parameters
e
RadAutoCompleteDropDownClosedEventArgs
The auto-complete dropdown closed event arguments.
Overrides
OnAutoCompleteDropDownKeyDown(KeyEventArgs)
Declaration
protected virtual void OnAutoCompleteDropDownKeyDown(KeyEventArgs e)Parameters
e
PerformAutoCompleteOverride(EditOperation)
Performs the auto complete override.
Declaration
protected override void PerformAutoCompleteOverride(EditOperation context)Parameters
context
The context.
Overrides
Events
TokenValidating
Occurs when text is validating as token
Declaration
public event TokenValidatingEventHandler TokenValidatingEvent Value