Extender that provides suggestions to fill input in a textbox.
| Name | Description |
|---|
| CompletionInterval | Time in milliseconds when the timer will kick in to get suggestions using the web service. |
| CompletionListCssClass | Css Class that will be used to style the completion list flyout. |
| CompletionListElementID | ID of element that will serve as the completion list. |
| CompletionListHighlightedItemCssClass | Css Class that will be used to style a highlighted item in the autocomplete list. |
| CompletionListItemCssClass | Css Class that will be used to style an item in the autocomplete list. |
| CompletionSetCount | Number of suggestions to be provided. |
| ContextKey | User/page specific context provided to an optional overload of the web method described by ServiceMethod/ServicePath. If the context key is used, it should have the same signature with an additional parameter named contextKey of type string. |
| DelimiterCharacters | Gets or sets the character(s) used to separate words for autocomplete. |
| EnableCaching | Flag to denote whether client side caching is enabled. |
| FirstRowSelected | Determines if the First Row of the Search Results be selected by default |
| MinimumPrefixLength | Minimum length of text before the webservice provides suggestions. |
| OnClientHidden | Handler to attach to the client-side hidden event |
| OnClientHiding | Handler to attach to the client-side hiding event |
| OnClientItemOut | Handler to attach to the client-side itemOut event |
| OnClientItemOver | Handler to attach to the client-side itemOver event |
| OnClientItemSelected | Handler to attach to the client-side itemSelected event |
| OnClientPopulated | Handler to attach to the client-side populated event |
| OnClientPopulating | Handler to attach to the client-side populating event |
| OnClientShowing | Handler to attach to the client-side showing event |
| OnClientShown | Handler to attach to the client-side shown event |
| OnHide | OnHide animation |
| OnShow | OnShow animation |
| ServiceMethod | The web service method to be called. |
| ServicePath | The path to the web service that the extender will pull the word\sentence completions from. If this is not provided, the service method should be a page method. |
| ShowOnlyCurrentWordInCompletionListItem | If Delimiter characters are specified and ShowOnlyCurrentWordInCompletionListItem is set to true, then the completion list displays suggestions just for the current word, otherwise, it displays the whole string that will show up in the TextBox if that item is selected, which is the current default. |
| UseContextKey | Whether or not the ContextKey property should be used. This will be automatically enabled if the ContextKey property is ever set (on either the client or the server). If the context key is used, it should have the same signature with an additional parameter named contextKey of type string. |
This behavior can be attached to a textbox to enable auto-complete/auto-suggest scenarios.
| Name | Description |
|---|
| completionInterval | Auto completion timer interval in milliseconds. |
| completionList | List dom element. |
| completionListCssClass | Css class name that will be used to style the completion list element. |
| completionListElementID | ID of the completion div element. |
| completionListItemCssClass | Css class name that will be used to style an item in the completion list. |
| completionSetCount | Maximum completion set size. |
| contextKey | User/page specific context provided to an optional overload of the web method described by ServiceMethod/ServicePath. If the context key is used, it should have the same signature with an additional parameter named contextKey of type string. |
| delimiterCharacters | Gets or sets the character(s) used to seperate words for autocomplete. |
| enableCaching | Get or sets whether suggestions retrieved from the webservice should be cached. |
| firstRowSelected | Flag to determine if the first option in the flyout is selected or not. |
| highlightedItemCssClass | Css class name that will be used to style a highlighted item in the list. |
| isMultiWord | Whether the behavior is currently in multi-word mode |
| minimumPrefixLength | Minimum text prefix length required to call the webservice. |
| onHide | Generic OnHide Animation's JSON definition |
| onHideBehavior | Generic OnHide Animation's behavior |
| onShow | Generic OnShow Animation's JSON definition |
| onShowBehavior | Generic OnShow Animation's behavior |
| serviceMethod | Web service method. |
| servicePath | Web service url. |
| showOnlyCurrentWordInCompletionListItem | If Delimiter characters are specified and showOnlyCurrentWordInCompletionListItem is set to true, then the completion list displays suggestions just for the current word, otherwise, it displays the whole string that will show up in the TextBox if that item is selected, which is the current default. |
| useContextKey | Whether or not the ContextKey property should be used. This will be automatically enabled if the ContextKey property is ever set (on either the client or the server). If the context key is used, it should have the same signature with an additional parameter named contextKey of type string. |
| Name | Description |
|---|
| dispose | Disposes the autocomplete behavior |
| hidePopup | Hide the completion list popup |
| initialize | Initializes the autocomplete behavior. |
| initializeCompletionList | Initializes the autocomplete list element |
| initializeTextBox | Initializes the textbox |
| initializeTimer | Initializes the timer |
| onHide | Play the OnHide animation |
| onShow | Play the OnShow animation |
| raiseHidden | Raise the hidden event |
| raiseHiding | Raise the hiding event |
| raiseItemOut | Raise the itemOut event |
| raiseItemOver | Raise the itemOver event |
| raiseItemSelected | Raise the itemSelected event |
| raisePopulated | Raise the populated event |
| raisePopulating | Raise the populating event |
| raiseShowing | Raise the showing event |
| raiseShown | Raise the shown event |
| showPopup | Show the completion list popup |
| Name | Description |
|---|
| hidden | Add an event handler for the hidden event |
| hiding | Add an event handler for the hiding event |
| itemOut | Add an event handler for the itemOut event |
| itemOver | Add an event handler for the itemOver event |
| itemSelected | Add an event handler for the itemSelected event |
| populated | Add an event handler for the populated event |
| populating | Add an event handler for the populating event |
| showing | Add an event handler for the showing event |
| shown | Add an event handler for the shown event |