aoData extra parameters added to the model binder for fnServerParams support

Author: cfeduke

Datatables.Mvc/DataTable.cs

@@ -16,7 +16,8 @@ public DataTable() {
             sSearchs = new List<string>();
             bEscapeRegexs = new List<bool>();
             iSortCols = new List<int>();
-            sSortDirs = new List<DataTableSortDirection>();
+            sSortDirs = new List<DataTableSortDirection>();
+        	aoData = new Dictionary<string,string>();
         }
 
         /// <summary>
@@ -70,7 +71,12 @@ public DataTable() {
         /// <summary>
         /// Direction to be sorted - "desc" or "asc". Note that the prefix for this variable is wrong in 1.5.x where iSortDir_(int) was used)
         /// </summary>
-        public IList<DataTableSortDirection> sSortDirs { get; set; }
+        public IList<DataTableSortDirection> sSortDirs { get; set; }
+		/// <summary>
+		/// Gets or sets the array of object data (in string representation) as passed to the server in the request excluding any well known datatables.net keys.
+		/// </summary>
+		/// <remarks>Any custom keys added through fnServerParams can be found in this dictionary.</remarks>
+		public IDictionary<string, string> aoData { get; set; }
     }
 
     /// <summary>

Datatables.Mvc/DataTableModelBinder.cs

@@ -1,4 +1,5 @@
-using System;
+using System;
+using System.Collections.Generic;
 using System.Web.Mvc;
 
 namespace Datatables.Mvc {
@@ -9,14 +10,35 @@ namespace Datatables.Mvc {
     /// requests to <see cref="DataTable"/>
     /// </summary>
     public class DataTableModelBinder : IModelBinder {
-        #region IModelBinder Members
+        #region IModelBinder Members
+
+		private static readonly IDictionary<string,bool> KnownFormParameters = new Dictionary<string,bool> { 
+			{ "sEcho", true },
+			{ "iDisplayStart", true },
+			{ "iDisplayLength", true },
+			{ "iColumns", true },
+			{ "sColumns", true },
+			{ "sSearch", true },
+			{ "bEscapeRegex", true },
+			{ "bSortable_", true },
+			{ "bSearchable_", true },
+			{ "sSearch_", true },
+			{ "bEscapeRegex_", true },
+			{ "iSortingCols", true },
+			{ "iSortCol", true },
+			{ "iSortCol_", true },
+			{ "sSortDir_", true },
+			// not used in BindModel
+			{ "mDataProp_", true },
+			{ "bRegex", true },
+			{ "bRegex_", true }
+		};
 
         public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext) {
             if (controllerContext == null) {
                 throw new ArgumentNullException("controllerContext");
             }
 
-
             if (bindingContext == null) {
                 throw new ArgumentNullException("bindingContext");
             }
@@ -110,6 +132,24 @@ public object BindModel(ControllerContext controllerContext, ModelBindingContext
                 }
             }
 
+			// get all the other not well known parameters - these can be defined by the programmer
+			// http://datatables.net/release-datatables/examples/server_side/custom_vars.html
+			foreach (var key in controllerContext.HttpContext.Request.Form.AllKeys)
+			{
+				var shortKey = key;
+				var underscorePos = shortKey.IndexOf('_');
+				if (underscorePos > 0) // -1 is for existance but starting with an _ is also not a shortened key
+				{
+					shortKey = shortKey.Substring(0, underscorePos + 1);
+				}
+				if (KnownFormParameters.ContainsKey(shortKey))
+				{
+					continue;
+				}
+				dataTable.aoData.Add(key, controllerContext.HttpContext.Request.Form[key]);
+			}
+
+
             return dataTable;
         }
 

README.md

@@ -1,6 +1,8 @@
 ##This Fork##
 Uses json.net for serialization so DT_RowId and DT_RowClass can be used (a dictionary was required).
 
+Adds a property getter/setter and binds DataTable.aoData.  This dictionary contains all other key value pairs that are not specially handled; meaning you can retreive any key value pairs added to aoData via the fnServerParams (see [http://datatables.net/release-datatables/examples/server_side/custom_vars.html])
+
 ##How to Use (Properly)##
 
 In Global.asax.cs during Application_Start: