AutoCompleteBoxPropertiesBase.EnableCallbackMode Property
Gets or sets a value that specifies whether the editor's list items can be loaded to the client side on demand via callbacks.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v18.2.dll
Declaration
[DefaultValue(false)]
public virtual bool EnableCallbackMode { get; set; }<DefaultValue(False)>
Public Overridable Property EnableCallbackMode As BooleanProperty Value
| Type | Default | Description |
|---|---|---|
| Boolean | false |
true, if on demand item loading is available; otherwise, false. |
Remarks
By default, the EnableCallbackMode property is set to false. This causes all list items of the editor to be sent to the client side, and presented in the editor's dropdown list.
If the EnableCallbackMode property is set to true, the editor loads its items from the server on demand via callbacks (for instance, list items which are not currently displayed within the editor's dropdown window can be dynamically loaded when an end-user scrolls the list). The number of items to be obtained from the server each time it's required is specified via the ASPxAutoCompleteBoxBase.CallbackPageSize property. This mode allows the first page to load much faster, since only a few items need to be loaded initially.
Note that the setting the EnableCallbackMode property affects the ASPxAutoCompleteBoxBase.EnableSynchronization property's default value. See the AutoCompleteBoxPropertiesBase.EnableSynchronization property's description for more details.
NOTE
The EnableCallbackMode property is not used in an MVC Extension. Specify the AutoCompleteBoxBaseSettings.CallbackRouteValues settings to define the callback routing logic in ASP.NET MVC.
NOTE
- In callback mode (the EnableCallbackMode property is set to True), the AutoCompleteBoxPropertiesBase.DropDownRows property value should not be greater than the value of the AutoCompleteBoxPropertiesBase.CallbackPageSize property.
- It is recommended that you disable the view state in callback mode. A control whose ViewState is enabled gets all items on a load regardless of the EnableCallbackMode property value (excluding the multicolumn mode).
- The EnableCallbackMode property synchronizes its value with the editor's ASPxAutoCompleteBoxBase.EnableCallbackMode property.
Examples
The following example illustrates how to use the ASPxAutoCompleteBoxBase.EnableCallbackMode property.
NOTE
For a full example, see the ASPxComboBox - Callback Mode demo.