Add HtmlAttributes configuration settings for root, table, column header, row, cell

Author: programcsharp

Build/CommonAssemblyInfo.cs

@@ -15,5 +15,5 @@
 //
 // You can specify all the values or you can default the Revision and Build Numbers
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("1.2.5")]
-[assembly: AssemblyFileVersion("1.2.5")]
+[assembly: AssemblyVersion("1.3.0")]
+[assembly: AssemblyFileVersion("1.3.0")]

Griddly.Mvc/GriddlyColumn.cs

@@ -4,12 +4,19 @@
 using System.Text.RegularExpressions;
 using System.Web;
 using System.Web.Helpers;
+using System.Web.Mvc;
+using System.Web.Routing;
 using System.Web.WebPages;
 
 namespace Griddly.Mvc
 {
     public abstract class GriddlyColumn
     {
+        public GriddlyColumn()
+        {
+            HeaderHtmlAttributes = new RouteValueDictionary();
+        }
+
         public string Caption { get; set; }
         public string ExpressionString { get; set; }
         public string Format { get; set; }
@@ -20,12 +27,22 @@ public abstract class GriddlyColumn
         public bool IsExportOnly { get; set; }
         public SummaryAggregateFunction? SummaryFunction { get; set; }
         public object SummaryValue { get; set; }
+        public IDictionary<string, object> HeaderHtmlAttributes { get; set; }
 
         public GriddlyFilter Filter { get; set; }
 
         public abstract HtmlString RenderCell(object row, GriddlySettings settings, bool encode = true);
         public abstract object RenderCellValue(object row, bool stripHtml = false);
-        public abstract string RenderClassName(object row, GriddlyResultPage page);
+
+        public virtual string RenderClassName(object row, GriddlyResultPage page)
+        {
+            return ClassName;
+        }
+
+        public virtual IDictionary<string, object> GenerateHtmlAttributes(object row, GriddlyResultPage page)
+        {
+            return null;
+        }
 
         public virtual HtmlString RenderValue(object value, bool encode = true)
         {
@@ -60,6 +77,7 @@ public class GriddlyColumn<TRow> : GriddlyColumn
     {
         public Func<TRow, object> Template { get; set; }
         public Func<TRow, string> ClassNameTemplate { get; set; }
+        public Func<TRow, object> HtmlAttributesTemplate { get; set; }
 
         static readonly Regex _htmlMatch = new Regex(@"<[^>]*>", RegexOptions.Compiled);
 
@@ -89,6 +107,27 @@ public override string RenderClassName(object row, GriddlyResultPage page)
                 return null;
         }
 
+        public override IDictionary<string, object> GenerateHtmlAttributes(object row, GriddlyResultPage page)
+        {
+            if (HtmlAttributesTemplate == null)
+                return null;
+
+            RouteValueDictionary attributes = new RouteValueDictionary();
+
+            object value = HtmlAttributesTemplate((TRow)row);
+
+            if (value != null)
+            {
+                if (!(value is IDictionary<string, object>))
+                    value = HtmlHelper.AnonymousObjectToHtmlAttributes(value);
+
+                foreach (KeyValuePair<string, object> entry in (IDictionary<string, object>)value)
+                    attributes.Add(entry.Key, entry.Value);
+            }
+
+            return attributes;
+        }
+
         public override HtmlString RenderCell(object row, GriddlySettings settings, bool encode = true)
         {
             object value = null;

Griddly.Mvc/GriddlyExtensions.cs

@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Text;
 using System.Web;
 using System.Web.Mvc;
 using System.Web.Mvc.Html;
@@ -104,6 +105,22 @@ public static HtmlString AttributeIf(this HtmlHelper helper, string name, bool s
                 return null;
         }
 
+        // http://stackoverflow.com/a/18618808/8037
+        public static IHtmlString ToHtmlAttributes(this IDictionary<string, object> dictionary)
+        {
+            if (dictionary == null || dictionary.Count == 0)
+                return null;
+
+            var sb = new StringBuilder();
+
+            foreach (var kvp in dictionary)
+            {
+                sb.Append(string.Format("{0}=\"{1}\" ", HttpUtility.HtmlEncode(kvp.Key), HttpUtility.HtmlAttributeEncode(kvp.Value != null ? kvp.Value.ToString() : null)));
+            }
+
+            return new HtmlString(sb.ToString());
+        }
+
         public static void SetGriddlyDefault<T>(this Controller controller, ref T parameter, string field, T value)
         {
             if (controller.ControllerContext.IsChildAction)

Griddly.Mvc/GriddlySelectColumn.cs

@@ -52,10 +52,5 @@ public override object RenderCellValue(object row, bool stripHtml = false)
         {
             return null;
         }
-
-        public override string RenderClassName(object row, GriddlyResultPage page)
-        {
-            return ClassName;
-        }
     }
 }

Griddly.Mvc/GriddlySettings.cs

@@ -7,6 +7,7 @@
 using System.Web;
 using System.Web.Helpers;
 using System.Web.Mvc;
+using System.Web.Routing;
 
 namespace Griddly.Mvc
 {
@@ -45,6 +46,8 @@ public GriddlySettings()
             Filters = new List<GriddlyFilter>();
             Buttons = new List<GriddlyButton>();
             RowIds = new Dictionary<string, Func<object, object>>();
+            HtmlAttributes = new RouteValueDictionary();
+            TableHtmlAttributes = new RouteValueDictionary();
 
             ClassName = DefaultClassName;
             TableClassName = DefaultTableClassName;
@@ -64,6 +67,8 @@ public GriddlySettings()
         public FilterMode? AllowedFilterModes { get; set; }
         public FilterMode? InitialFilterMode { get; set; }
         public bool ShowRowSelectCount { get; set; }
+        public IDictionary<string, object> HtmlAttributes { get; set; }
+        public IDictionary<string, object> TableHtmlAttributes { get; set; }
 
         public int? PageSize { get; set; }
         public int? MaxPageSize { get; set; }
@@ -80,6 +85,7 @@ public GriddlySettings()
         public Func<object, object> RowClickUrl { get; set; }
         public string RowClickModal { get; set; }
         public Func<object, object> RowClass { get; set; }
+        public Func<object, object> RowHtmlAttributes { get; set; }
 
         public Func<GriddlyResultPage, object> FooterTemplate { get; set; }
         public Func<GriddlyResultPage, object> HeaderTemplate { get; set; }
@@ -106,6 +112,29 @@ public virtual object RenderRowClass(object o)
             return RowClass(o);
         }
 
+        public virtual IDictionary<string, object> GenerateRowHtmlAttributes(object o)
+        {
+            if (RowHtmlAttributes != null)
+            {
+                object value = RowHtmlAttributes(o);
+
+                if (value != null)
+                {
+                    RouteValueDictionary attributes = new RouteValueDictionary();
+
+                    if (!(value is IDictionary<string, object>))
+                        value = HtmlHelper.AnonymousObjectToHtmlAttributes(value);
+
+                    foreach (KeyValuePair<string, object> entry in (IDictionary<string, object>)value)
+                        attributes.Add(entry.Key, entry.Value);
+
+                    return attributes;
+                }
+            }
+
+            return null;
+        }
+
         public GriddlySettings RowId(Expression<Func<object, object>> expression, string name = null)
         {
             if (name == null)
@@ -339,6 +368,17 @@ public class GriddlySettings<TRow> : GriddlySettings
             }
         }
 
+        public new Func<TRow, object> RowHtmlAttributes
+        {
+            set
+            {
+                if (value != null)
+                    base.RowHtmlAttributes = (x) => value((TRow)x);
+                else
+                    base.RowHtmlAttributes = null;
+            }
+        }
+
         public GriddlySettings<TRow> RowId(Expression<Func<TRow, object>> expression, string name = null)
         {
             if (name == null)
@@ -352,7 +392,7 @@ public GriddlySettings<TRow> RowId(Expression<Func<TRow, object>> expression, st
             return this;
         }
 
-        public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>> expression, string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, bool isExportOnly = false, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<GriddlyColumn, GriddlyFilter> filter = null, int defaultSortOrder = 0)
+        public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>> expression, string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, bool isExportOnly = false, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<GriddlyColumn, GriddlyFilter> filter = null, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0)
         {
             ModelMetadata metadata = null;
 
@@ -401,6 +441,9 @@ public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>>
             if (string.IsNullOrWhiteSpace(expressionString) && summaryFunction != null)
                 throw new InvalidOperationException("Must specify an expression to use a summary function.");
 
+            if (headerHtmlAttributes != null && !(headerHtmlAttributes is IDictionary<string, object>))
+                headerHtmlAttributes = HtmlHelper.AnonymousObjectToHtmlAttributes(headerHtmlAttributes);
+
             Add(new GriddlyColumn<TRow>()
             {
                 Template = template,
@@ -413,15 +456,17 @@ public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>>
                 DefaultSortOrder = defaultSortOrder,
                 ClassName = className,
                 IsExportOnly = isExportOnly,
-                Width = width
+                Width = width,
+                HtmlAttributesTemplate = htmlAttributes,
+                HeaderHtmlAttributes = (IDictionary<string, object>)headerHtmlAttributes
             }, filter);
 
             return this;
         }
 
-        public GriddlySettings<TRow> Column(string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, bool isExportOnly = false, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<GriddlyColumn, GriddlyFilter> filter = null, int defaultSortOrder = 0)
+        public GriddlySettings<TRow> Column(string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, bool isExportOnly = false, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<GriddlyColumn, GriddlyFilter> filter = null, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0)
         {
-            return Column<object>(null, caption, format, expressionString, defaultSort, className, isExportOnly, width, summaryFunction, summaryValue, template, filter, defaultSortOrder);
+            return Column<object>(null, caption, format, expressionString, defaultSort, className, isExportOnly, width, summaryFunction, summaryValue, template, filter, htmlAttributes, headerHtmlAttributes, defaultSortOrder);
         }
 
         public GriddlySettings<TRow> SelectColumn(Expression<Func<TRow, object>> id, object summaryValue = null)

Griddly.Mvc/InternalExtensions.cs

@@ -191,6 +191,5 @@ internal static string GetFormattedValue(object value, FilterDataType dataType)
 
             return output;
         }
-
     }
 }

Griddly/Views/Shared/Griddly/Griddly.cshtml

@@ -97,7 +97,8 @@
         @: @Html.AttributeNullable("data-griddly-rowclickmodal", settings.RowClickModal)
         @: data-griddly-defaultrowids="@Json.Encode(settings.DefaultRowIds != null ? settings.DefaultRowIds.Select(x => x.ToLower()).ToArray() : new[] { "value" })"
         @: data-griddly-filter-defaults="@Newtonsoft.Json.JsonConvert.SerializeObject(this.GetGriddlyDefaults())"
-        @: @Html.AttributeIf("data-griddly-defaultsort", defaultSort != null && defaultSort.Any(), Html.AttributeEncode(Json.Encode(defaultSort.Select(x => new { Field = x.Field, Direction = x.Direction.ToString() }))))>
+        @: @Html.AttributeIf("data-griddly-defaultsort", defaultSort != null && defaultSort.Any(), Html.AttributeEncode(Json.Encode(defaultSort.Select(x => new { Field = x.Field, Direction = x.Direction.ToString() }))))
+        @: @settings.HtmlAttributes.ToHtmlAttributes()>
     if (settings.Buttons.Any())
     {
         <div class="buttons">
@@ -112,7 +113,7 @@
         @settings.BeforeTemplate(null)
     }
     @:<div class="griddly-scrollable-container">
-        @:<table class="@settings.TableClassName">
+        @:<table class="@settings.TableClassName" @settings.TableHtmlAttributes.ToHtmlAttributes()>
             <colgroup>
                 @foreach (GriddlyColumn column in settings.Columns)
                 {
@@ -150,7 +151,7 @@
             @foreach (GriddlyColumn column in settings.Columns)
             {
                 bool isSortable = !simple && !string.IsNullOrWhiteSpace(column.ExpressionString);
-                <th class="@column.ClassName @(isSortable ? "sortable" : null) @(column is GriddlySelectColumn ? "select" : null) @(column.DefaultSort != null ? (column.DefaultSort == SortDirection.Descending ? "sorted_d" : "sorted_a") : null)" @Html.AttributeNullable("data-griddly-sortfield", simple ? null : column.ExpressionString)>
+                <th class="@column.ClassName @(isSortable ? "sortable" : null) @(column is GriddlySelectColumn ? "select" : null) @(column.DefaultSort != null ? (column.DefaultSort == SortDirection.Descending ? "sorted_d" : "sorted_a") : null)" @Html.AttributeNullable("data-griddly-sortfield", simple ? null : column.ExpressionString) @column.HeaderHtmlAttributes.ToHtmlAttributes()>
                     @if (isSortable)
                     {
                         <text>@column.Caption<span class="icon">&nbsp;</span></text>
@@ -190,10 +191,11 @@
             {
                 @: data-rowid-@(x.Key)="@(x.Value(row))"
             }
-            data-rowkey="@("_" + string.Join("_", settings.RowIds.Select(x => { var val = x.Value(row); return val == null ? "" : val.ToString(); }).ToArray()))">
+            data-rowkey="@("_" + string.Join("_", settings.RowIds.Select(x => { var val = x.Value(row); return val == null ? "" : val.ToString(); }).ToArray()))"
+            @settings.GenerateRowHtmlAttributes(row).ToHtmlAttributes()>
             @foreach (GriddlyColumn column in settings.Columns)
             {
-                <td class="@column.RenderClassName(row, Model)">@column.RenderCell(row, settings)</td>
+                <td class="@column.RenderClassName(row, Model)" @column.GenerateHtmlAttributes(row, Model).ToHtmlAttributes()>@column.RenderCell(row, settings)</td>
             }
         </tr>
     }