Click here to Skip to main content
15,879,239 members
Articles / Web Development / ASP.NET
Article

ASP.NET DropDownList with OptionGroup support

Rate me:
Please Sign up or sign in to vote.
4.81/5 (39 votes)
12 Sep 20061 min read 485.6K   8.7K   108   100
An implementation of a DropDownList Control Adapter which provides OptionGroup support.

Introduction

ASP.NET 2.0, for all its bells and whistles, lacks the odd bit of functionality for reasons completely unknown. One such notable omission is that of OptionGroup (<optgroup>) support in the DropDownList control. For those unfamiliar with the <optgroup> element, it is part of the XHTML standard, and has the effect of categorising items in a <select>, as the following image shows.

Option Groups

When I first began to look for a solution to implement this in ASP.NET, I found very few articles on the topic that offered any viable solution. Another CodeProject member came up with a nice clean solution, but it looked like a lot of code and I was convinced there was an easier way. After reading some comments, it became apparent a Control Adapter was the way to go. Control Adapters are new in ASP.NET 2.0, and allow the developer to override the rendering behaviour of any control, very powerful stuff! Furthermore, Control Adapters are used in conjunction with a browser file, so specific browsers may be targeted, if required. Armed with that knowledge, the solution became simple. The attached download contains the requisite files to implement this solution in your own projects, but for posterity, I paste it here also.

C#
public class DropDownListAdapter : 
       System.Web.UI.WebControls.Adapters.WebControlAdapter {
    protected override void RenderContents(HtmlTextWriter writer) {
        DropDownList list = this.Control as DropDownList;
        string currentOptionGroup;
        List<string> renderedOptionGroups = new List<string>();
        foreach(ListItem item in list.Items) {
            if(item.Attributes["OptionGroup"] == null) {
                RenderListItem(item, writer);
            } else {
                currentOptionGroup = item.Attributes["OptionGroup"];
                if(renderedOptionGroups.Contains(currentOptionGroup)) {
                    RenderListItem(item, writer);
                } else {
                    if(renderedOptionGroups.Count > 0) {
                        RenderOptionGroupEndTag(writer);
                    }
                    RenderOptionGroupBeginTag(currentOptionGroup, 
                                              writer);
                    renderedOptionGroups.Add(currentOptionGroup);
                    RenderListItem(item, writer);
                }
            }
        }
        if(renderedOptionGroups.Count > 0) {
            RenderOptionGroupEndTag(writer);
        }
    }
    private void RenderOptionGroupBeginTag(string name, 
                 HtmlTextWriter writer) {
        writer.WriteBeginTag("optgroup");
        writer.WriteAttribute("label", name);
        writer.Write(HtmlTextWriter.TagRightChar);
        writer.WriteLine();
    }
    private void RenderOptionGroupEndTag(HtmlTextWriter writer) {
        writer.WriteEndTag("optgroup");
        writer.WriteLine();
    }
    private void RenderListItem(ListItem item, 
                 HtmlTextWriter writer) {
        writer.WriteBeginTag("option");
        writer.WriteAttribute("value", item.Value, true);
        if(item.Selected) {
            writer.WriteAttribute("selected", "selected", false);
        }
        foreach(string key in item.Attributes.Keys) {
            writer.WriteAttribute(key, item.Attributes[key]);
        }
        writer.Write(HtmlTextWriter.TagRightChar);
        HttpUtility.HtmlEncode(item.Text, writer);
        writer.WriteEndTag("option");
        writer.WriteLine();
    }
}

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Web Developer
United Kingdom United Kingdom
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralRe: optgroup structure disappears after PostBack Pin
ridgie20-Jul-10 16:52
ridgie20-Jul-10 16:52 
GeneralRe: optgroup structure disappears after PostBack Pin
dingmg29-Apr-16 17:00
dingmg29-Apr-16 17:00 
GeneralDrop Down list bind to sql server Pin
bismillah131-Aug-08 20:27
bismillah131-Aug-08 20:27 
General"OnSelectedIndexChanged" is not working. Pin
kargoms4-Aug-08 22:32
kargoms4-Aug-08 22:32 
GeneralRe: "OnSelectedIndexChanged" is not working. Pin
SivaPrakasamDotNet16-Jul-09 22:34
SivaPrakasamDotNet16-Jul-09 22:34 
GeneralOnSelectedIndexChanged event not working Pin
RashuD5-Feb-08 4:30
RashuD5-Feb-08 4:30 
GeneralRe: OnSelectedIndexChanged event not working Pin
kargoms11-Aug-08 20:20
kargoms11-Aug-08 20:20 
GeneralRe: OnSelectedIndexChanged event not working Pin
SivaPrakasamDotNet16-Jul-09 23:33
SivaPrakasamDotNet16-Jul-09 23:33 
Hi If you got any solution for the event problem. Pls forward it to me.
siva@touchpointindia.com

Thanks
GeneralRe: OnSelectedIndexChanged event not working Pin
Member 979468529-Jan-13 23:28
Member 979468529-Jan-13 23:28 
QuestionMore than one level??? Pin
latiful8-Sep-07 0:33
latiful8-Sep-07 0:33 
Generalchange of Font Style optgroup element Pin
af_shamim23-Aug-07 13:01
af_shamim23-Aug-07 13:01 
AnswerRe: change of Font Style optgroup element Pin
lotuspro23-Aug-07 23:06
lotuspro23-Aug-07 23:06 
GeneralRe: change of Font Style optgroup element Pin
Nayeem Yahoo16-Jan-09 2:24
Nayeem Yahoo16-Jan-09 2:24 
GeneralRe: change of Font Style optgroup element Pin
GilesHinton2-Aug-10 5:46
GilesHinton2-Aug-10 5:46 
GeneralUpdate to RenderContents Pin
Pedro Maia Costa20-Jul-07 1:05
Pedro Maia Costa20-Jul-07 1:05 
QuestionList get added again after postback Pin
xsoftdev19-Jul-07 5:20
xsoftdev19-Jul-07 5:20 
AnswerRe: List get added again after postback Pin
Pedro Maia Costa20-Jul-07 1:07
Pedro Maia Costa20-Jul-07 1:07 
GeneralVB version anyone... Pin
jaywoncoder10-May-07 12:46
jaywoncoder10-May-07 12:46 
AnswerVB version with fixes below... Pin
WolfyUK20-Jun-07 5:38
WolfyUK20-Jun-07 5:38 
AnswerStandalone version [modified] Pin
Paul Appeldoorn4-Oct-07 3:53
Paul Appeldoorn4-Oct-07 3:53 
GeneralRe: Standalone version Pin
Member 437800431-Jul-08 20:18
Member 437800431-Jul-08 20:18 
QuestionRe: VB version with fixes below... [modified] Pin
CaptainRantflaps12-Nov-08 23:15
CaptainRantflaps12-Nov-08 23:15 
QuestionAjax [modified] Pin
davidprice3520-Mar-07 5:09
davidprice3520-Mar-07 5:09 
QuestionCould Not Load Type 'DropDownListAdapter' Pin
tinybag1615-Mar-07 17:09
tinybag1615-Mar-07 17:09 
AnswerRe: Could Not Load Type 'DropDownListAdapter' Pin
lotuspro16-Mar-07 1:50
lotuspro16-Mar-07 1:50 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.