Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RadAutoCompleteTextView

RadAutoCompleteTextView provides means to perform easy filtering of data and completion suggestion's according to typed text by the user. Provides tokens, layouts, completion modes.

Hierarchy

  • any

Index

Properties

closeButtonImageSrc

closeButtonImageSrc: string

Sets the source of the Image for the 'close' button in the text area of the RadAutoCompleteTextView.

completionMode

Defines the criteria on which suggestions are being filtered.

displayMode

Defines how selected items are shown. Default value is Plain.

filteredItems

filteredItems: Array<TokenModel>

Gets a list of the items filtered by the RadAutoCompleteTextView's current input.

hint

hint: string

Sets a hint for the RadAutoCompleteTextView. That is the text that is displayed when no text is typed.

itemViewLoader

itemViewLoader: function

Gets or sets the item view loaded used by the @link RadListView} when creating its item views.

Type declaration

    • (viewType: any): View
    • Parameters

      • viewType: any

      Returns View

items

items: ObservableArray<TokenModel>

Items used to provide suggestions.

layoutMode

Defines the layout of the tokens.

loadSuggestionsAsync

loadSuggestionsAsync: any

Sets or gets a function that is used by the RadAutoCompleteTextView to retrieve its items.

minimumCharactersToSearch

minimumCharactersToSearch: number

Sets the minimal count of typed characters for the RadAutoCompleteTextView to start filtering.

noResultsText

noResultsText: string

Sets the text displayed when there are no matches for the current input.

readOnly

readOnly: boolean

Sets or gets if the RadAutoCompleteTextView will be enabled or disabled.

selectedTokens

selectedTokens: Array<TokenModel>

Gets a list of all currently selected tokens.

showCloseButton

showCloseButton: boolean

Sets if the 'close' button in the text area of the RadAutoCompleteTextView is shown.

suggestMode

Defines how suggestion are presented.

suggestionView

suggestionView: any

The suggestion view holding suggestion items in Suggest mode.

text

text: string

Gets/sets the current text for the RadAutoCompleteTextView.

Static didAutoCompleteEvent

didAutoCompleteEvent: string

The event fired when an item is chosen from the suggestions list.

Static itemLoadingEvent

itemLoadingEvent: string

The event fired when the suggestion view is being populated.

Static loadSuggestionsAsyncProperty

loadSuggestionsAsyncProperty: Property<RadAutoCompleteTextView, any>

Identifies the itemTemplate dependency property.

Static suggestionViewBecameVisibleEvent

suggestionViewBecameVisibleEvent: string

The event fired when suggestion view has become visible.

Static textChangedEvent

textChangedEvent: string

The event fired when the text of RadAutoCompleteTextView is changed.

Static tokenAddedEvent

tokenAddedEvent: string

The event fired when token is added.

Static tokenDeselectedEvent

tokenDeselectedEvent: string

The event fired when token is deselected.

Static tokenRemovedEvent

tokenRemovedEvent: string

The event fired when token is removed.

Static tokenSelectedEvent

tokenSelectedEvent: string

The event fired when token is selected.

Methods

addToken

  • Adds token.

    Parameters

    Returns any

insertTokenAtIndex

  • insertTokenAtIndex(token: TokenModel, index: number): any
  • Inserts token at specified index.

    Parameters

    Returns any

removeAllTokens

  • removeAllTokens(): any
  • Removes all tokens.

    Returns any

removeToken

  • Removes specified token.

    Parameters

    Returns any

removeTokenAtIndex

  • removeTokenAtIndex(index: number): any
  • Removes token at specified index.

    Parameters

    • index: number

    Returns any

resetAutoComplete

  • resetAutoComplete(): any
  • Resets the RadAutoCompleteTextView component.

    Returns any

tokenAtIndex

  • tokenAtIndex(index: number): any
  • Returns token at specified index.

    Parameters

    • index: number

    Returns any

tokens

  • tokens(): any
  • Returns all tokens.

    Returns any

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method