AutoCompleteBoxPropertiesBase.EnableSynchronization Property

Gets or sets a value that specifies whether client manipulations with the editor’s list items (adding, deleting) should be synchronized with the editor’s server Items collection.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean EnableSynchronization { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property EnableSynchronization As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	One of the enumeration values.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Remarks

If the ASPxEditBase.EnableClientSideAPI property is set to true, you are allowed to manipulate the editor’s list items on the client side by using specific client methods (such as ASPxClientComboBox.AddItem, ASPxClientComboBox.RemoveItem, etc). The EnableSynchronization property controls whether such client item manipulations should be synchronized with the server ASPxAutoCompleteBoxBase.Items collection of the editor.

Note

An ASPxComboBox must have its ASPxAutoCompleteBoxBase.Items collection bound by the time synchronization occurs. So, you should provide the ASPxComboBox with items using its Init or Page_Init event handler.

Note that the synchronization does not modify a data source, so you should do it manually to prevent losing your data.

If the EnableSynchronization property is set to DefaultBoolean.Default, the item synchronization availability depends upon the ASPxAutoCompleteBoxBase.EnableCallbackMode property setting. If ASPxAutoCompleteBoxBase.EnableCallbackMode is set to DefaultBoolean.False, the item synchronization is available; otherwise, it is disabled.

If the EnableSynchronization property is enabled and the ASPxAutoCompleteBoxBase.DataSecurityMode property is set to the Default value, a list editor allows adding new list items via client code and synchronizes modifications to this list with the server ASPxAutoCompleteBoxBase.Items collection. In this scenario, it is recommended to HTML encode the editor item’s content using the following:

• enable the EditPropertiesBase.EncodeHtml property if items aren’t created using templates.

• encode HTML using the HttpUtility.HtmlEncode method if items are created using templates (ASPxAutoCompleteBoxBase.ItemTemplate).

  ASPX

  <dx:ASPxComboBox ID="cb1" runat="server">
      <ItemTemplate>
          <asp:Label ID="Label1" runat="server" Text='<%# HttpUtility.HtmlEncode(Eval("Text")) %>'></asp:Label>
      </ItemTemplate>
  </dx:ASPxComboBox>
  

Note that the item synchronization is disabled if the ASPxAutoCompleteBoxBase.EnableCallbackMode property is set to true.

Note

The EnableSynchronization property synchronizes its value with the editor’s ASPxAutoCompleteBoxBase.EnableSynchronization property.