DropDownList AppendDataBoundItems (first item to be blank and no duplicates)

There are good answers here but I felt the need to include more information because there are multiple options that work and we need to decide which to use.

First, we should understand AppendDataBoundItems. If AppendDataBoundItems = "true", ListItems are added to the DropDownList without clearing out the old ones. Otherwise, the DropDownList is cleared about before the next DataBind. MSDN AppendDataBoundItems doc

There are basically 2 options covered by most of the answers:

1. Define a blank option in html and add the ListItems from the database to the DropDownList only once.

Notice 3 things here:

  • Blank ListItem is defined in html
  • AppendDataBoundItems="true"
  • DataBind is NOT called on postbacks or when the DropDownList item count is > 1

Source:

<asp:DropDownList ID="MyList" runat="server" AppendDataBoundItems="true" DataValueField="Id" DataTextField="Name" >
    <asp:ListItem Text="- Select One -" Value="" />
</asp:DropDownList>

Code behind:

protected void Page_Load(object sender, System.EventArgs e)
{
    if (MyList.Items.Count <= 1 ) {
        MyList.DataSource = MyDataSource;
        MyList.DataBind();
    }
}

Note: I like the logic of checking the count vs checking IsPostBack. Though PostBacks are often the cause of duplicate databinding, it is possible to cause it other ways. Checking the item count is basically just checking to see if it's already been loaded.

OR (option to use IsPostBack instead)

protected void Page_Load(object sender, System.EventArgs e)
{
    if (!IsPostBack) {
        MyList.DataSource = MyDataSource;
        MyList.DataBind();
    }
}

2. Clear and reload the DropDownList on each page refresh.

Notice 3 differences from the first option:

  • AppendDataBoundItems="false" (if it is not defined then false is it's default value)
  • Blank ListItem is is added in code behind. We can't define it in html because with AppendDataBoundItems="false", it would be cleared out.
  • DataBind is called on every Page_Load

Source:

<asp:DropDownList ID="MyList" runat="server" DataValueField="Id"  DataTextField="Name" 
    OnDataBound="MyList_DataBound" >
</asp:DropDownList>

Code behind:

protected void Page_Load(object sender, System.EventArgs e)
{
    MyList.DataSource = MyDataSource;
    MyList.DataBind();
}

protected void MyList_DataBound(object sender, EventArgs e)
{
    MyList.Items.Insert(0, new ListItem("- Select One -", ""));
}

You probably bind that DropDownList in the code behind. So you should not do it after postback again:

// probably in Page_Load method
if (!Page.IsPostBack)
{
    // do data binding here
};

Instead of using AppendDataboundItems='true' (which will cause the problem you are talking about), respond to the DataBound event for the DropDownList and then add your "blank" item to the top of the list.

<asp:DropDownList runat="server" ID="MyList"
  ondatabound="MyListDataBound"></asp:DropDownList>

Then in your code behind:

protected void MyListDataBound(object sender, EventArgs e)
{
    MyList.Items.Insert(0, new ListItem("- Select -", ""));
}