ASPxClientComboBox.AddItem(text) Method

The AddItem method allows you to specify the item鈥檚 text, value, and image. But you cannot use this method to set a value of a hidden column item. Also, if you specify an image for an item, define the editor鈥檚 ItemImage.Width and ItemImage.Height properties. Otherwise, the editor does not display this image.

Examples

• AddItem(String)

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
  </dx:ASPxComboBox>
  

  

• AddItem(String[])

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
      <Columns>
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
      </Columns>
  </dx:ASPxComboBox>
  

  

• ASPxClientComboBox.AddItem(String, Object)

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
  </dx:ASPxComboBox>
  

• ASPxClientComboBox.AddItem(String[], Object)

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
      <Columns>
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
      </Columns>
  </dx:ASPxComboBox>
  

• ASPxClientComboBox.AddItem(String, Object, String)

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
  </dx:ASPxComboBox>
  

• ASPxClientComboBox.AddItem(String[], Object, String)

  • ASPX
  • JS

  <dx:ASPxComboBox ID="ASPxComboBox1" ClientInstanceName="cb" runat="server">
      <Columns>
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
          <dx:ListBoxColumn />
      </Columns>
  </dx:ASPxComboBox>
  

Add a New Item to the Item Collection

You can populate the control鈥檚 Items collection with new items at run time.

Follow the steps below to add a new item to the ListEditItemCollection collection:

1. Specify initial items.

   • C#

   protected void Page_Init(object sender, EventArgs e) {
       ASPxComboBox.Items.Add(new DevExpress.Web.ListEditItem() { Text = "Academic", Value = 0 });
       ASPxComboBox.Items.Add(new DevExpress.Web.ListEditItem() { Text = "Administrative", Value = 1 });
       ASPxComboBox.Items.Add(new DevExpress.Web.ListEditItem() { Text = "Art/Entertainment", Value = 2 });
   }
   

2. Handle the client-side TextChanged event. If you enter a new item, the control calls the AddItem method that gets the entered text as a parameter.

   • JS

   function onTextChanged(s, e) {
       if (s.GetSelectedIndex() == -1) {
           TestComboBox.AddItem(s.GetText());
       }
   }
   

3. Specify the following properties:

   • Set the EnableSynchronization property to true to synchronize the add item actions between the server and the client.

   • Set the ASPxAutoCompleteBoxBase.EnableCallbackMode property to false because synchronization is not in effect in callback mode.

   • ASPX

   <dx:ASPxComboBox ID="ASPxComboBox" runat="server" IncrementalFilteringMode="StartsWith" 
       ClientInstanceName="TestComboBox" EnableCallbackMode="false" EnableSynchronization="True">
       <ClientSideEvents TextChanged="onTextChanged" />
   </dx:ASPxComboBox>
   

Online Example

View Example: How to add items to a multi-column ASPxComboBox on the client side