Donate

ASP.NET MVC ListBoxFor() With Optgroup Tag Support

-
Here's a simple ListBoxFor helper that supports optgroup tag. See versions for C# and VB.NET.
C# Code 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
public static class HtmlExtensions
{
    public static IHtmlString ListBoxFor<TModel, TProperty>(this HtmlHelper<TModel> htmlHelper, 
        Expression<Func<TModel, TProperty>> expression, Dictionary<string, IEnumerable<SelectListItem>> selectList, 
        object htmlAttributes = null)
    {
        var select = new TagBuilder("select");
        select.Attributes.Add("name", ExpressionHelper.GetExpressionText(expression));
 
        if (htmlAttributes != null)
        {
            RouteValueDictionary routeValues = new RouteValueDictionary(htmlAttributes);
            if(!routeValues.ContainsKey(("size").ToLower()))
            {
                select.Attributes.Add("size", selectList.Sum(x=> x.Value.Count()).ToString());
            }
 
            foreach (var item in routeValues)
            {
                select.Attributes.Add(item.Key, item.Value.ToString());
            }
        }
        else
            select.Attributes.Add("size", selectList.Sum(x => x.Value.Count()).ToString());
 
        var optgroups = new StringBuilder();
 
        foreach (var kvp in selectList)
        {
            var optgroup = new TagBuilder("optgroup");
            optgroup.Attributes.Add("label", kvp.Key);
 
            var options = new StringBuilder();
 
            foreach (var item in kvp.Value)
            {
                var option = new TagBuilder("option");
 
                option.Attributes.Add("value", item.Value);
                option.SetInnerText(item.Text);
 
                if (item.Selected)
                {
                    option.Attributes.Add("selected", "selected");
                }
 
                options.Append(option.ToString(TagRenderMode.Normal));
            }
 
            optgroup.InnerHtml = options.ToString();
 
            optgroups.Append(optgroup.ToString(TagRenderMode.Normal));
        }
 
        select.InnerHtml = optgroups.ToString();
 
        return MvcHtmlString.Create(select.ToString(TagRenderMode.Normal));
    }
}

VB.NET Code 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
Public Module HtmlExtensions
 
    <Extension()>
    Public Function ListBoxFor(Of TModel, TProperty)(htmlHelper As HtmlHelper(Of TModel), expression As Expression(Of Func(Of TModel, TProperty)), _
        selectList As Dictionary(Of String, IEnumerable(Of SelectListItem)), Optional htmlAttributes As Object = Nothing) As IHtmlString
 
        Dim selectTag = New TagBuilder("select")
        selectTag.Attributes.Add("name", ExpressionHelper.GetExpressionText(expression))
 
        If htmlAttributes IsNot Nothing Then
            Dim routeValues As New RouteValueDictionary(htmlAttributes)
            If Not routeValues.ContainsKey(("size").ToLower()) Then
                selectTag.Attributes.Add("size", selectList.Sum(Function(x) x.Value.Count()).ToString())
            End If
 
            For Each item In routeValues
                selectTag.Attributes.Add(item.Key, item.Value.ToString())
            Next
        Else
            selectTag.Attributes.Add("size", selectList.Sum(Function(x) x.Value.Count()).ToString())
        End If
 
        Dim optgroups = New StringBuilder()
 
        For Each kvp In selectList
            Dim optgroup = New TagBuilder("optgroup")
            optgroup.Attributes.Add("label", kvp.Key)
 
            Dim options = New StringBuilder()
 
            For Each item In kvp.Value
                Dim optionTag = New TagBuilder("option")
 
                optionTag.Attributes.Add("value", item.Value)
                optionTag.SetInnerText(item.Text)
 
                If item.Selected Then
                    optionTag.Attributes.Add("selected", "selected")
                End If
 
                options.Append(optionTag.ToString(TagRenderMode.Normal))
            Next
 
            optgroup.InnerHtml = options.ToString()
 
            optgroups.Append(optgroup.ToString(TagRenderMode.Normal))
        Next
 
        selectTag.InnerHtml = optgroups.ToString()
 
        Return MvcHtmlString.Create(selectTag.ToString(TagRenderMode.Normal))
 
    End Function
End Module
Screenshot
ASP.NET MVC ListBoxFor() With Optgroup Tag Support
Detailed usage of the custom helper: ASP.NET MVC ListBoxFor() with optgroup Tag support
Source codes:
C# Version
VB.NET Version

Comments

Post a Comment

Donate

Popular Posts From This Blog

WPF CRUD Application Using DataGrid, MVVM Pattern, Entity Framework, And C#.NET

-
Image
Good day to all! Here's an example of a WPF CRUD (Create,Update and Delete) project using the DataGrid control, ADO.NET Entity Framework 6.x, C#.NET and Model–View–Viewmodel(MVVM) architectural pattern. This post was based from this tutorial WPF CRUD With DataGrid, Entity Framework And C#.NET except that we are now using the MVVM framework. The steps below are pretty straightforward and easy to follow. I. Project Setup 1. Add a table called Students in you database. The complete script is found in this post WPF CRUD With DataGrid, Entity Framework And C#.NET 2. Create a WPF Project and add four folders called DataAccess, Model, View and ViewModel. 3. Your project structure may look similar with the screenshot provided below. II. Coding The Model and Repository Class 1. Inside the Model folder, add an ADO.NET Entity Data Model that connects to the Students table in your database. On my part, I named it StudentModel . 2. For the connectionstring name in App.config file, I ...
Read more

TypeScript Error Or Bug: The term 'tsc' is not recognized as the name of a cmdlet, function, script file, or operable program.

-
Image
Good Day Gents! During this free-time I started setting up Node.js on my machine as part of my career goals which is learning new frameworks in preparation for new projects. So the first thing I did was to install TypeScript language to get myself familiar with Angular 2+. After I finished setting up TypeScript, I then created a simple HelloWorld program and ran the application through Visual Studio Code using the "tsc: build - tsconfig.json" command. I encountered an error which says "The term 'tsc' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again." Below are the details on my machine and packages installed:   - Operating System: Windows 10 Pro   - Node.js: 14.16.0   - npm version: 6.14.11   - Typescript: 4.2.3 (using command: "npm install -g typescript") After doing some research and reading th...
Read more

Invalid nested tag div found, expected closing tag input

-
Hello all, I've been experimenting on how to print html document using the said 3rd party software called iTextSharp . iTextSharp is a popular tool and has several examples on the internet regarding integration to the project and occurring issues. One of the issue I encountered is Invalid nested div tag and is expecting a closing tag input . As I trace back my html source, the tags are well-formed except that they are self closing tags such as <input>, <hr>, <img>, <br> or the like. These tags when passed to an action method as string are not properly closed and thus an issue is thrown by iTextSharp's XMLWorkerHelper's ParseXHtml() method. <img src= "~/Images/success.png" /> <input type= "hidden" name= "OrderStatusHTML" /> <input type= "submit" id= "btnSubmit" value= "Export to PDF" class= "btn btn-success" /> The solution I came up with is to fi...
Read more