Refactor IsExportOnly to RenderMode

Author: programcsharp

Griddly.Mvc/GriddlyColumn.cs

@@ -15,6 +15,8 @@ public abstract class GriddlyColumn
         public GriddlyColumn()
         {
             HeaderHtmlAttributes = new RouteValueDictionary();
+
+            RenderMode = ColumnRenderMode.Both;
         }
 
         public string Caption { get; set; }
@@ -24,7 +26,7 @@ public GriddlyColumn()
         public int DefaultSortOrder { get; set; }
         public string ClassName { get; set; }
         public string Width { get; set; }
-        public bool IsExportOnly { get; set; }
+        public ColumnRenderMode RenderMode { get; set; }
         public SummaryAggregateFunction? SummaryFunction { get; set; }
         public object SummaryValue { get; set; }
         public IDictionary<string, object> HeaderHtmlAttributes { get; set; }
@@ -228,4 +230,11 @@ public enum SummaryAggregateFunction
         Min = 3,
         Max = 4
     }
+
+    public enum ColumnRenderMode
+    {
+        View = 1 << 0,
+        Export = 1 << 1,
+        Both = View | Export
+    }
 }

Griddly.Mvc/GriddlyCsvResult.cs

@@ -34,8 +34,11 @@ public override void ExecuteResult(ControllerContext context)
             {
                 var export = _settings.Exports.FirstOrDefault(x => x.Name == _exportName);
                 var columns = export == null ? _settings.Columns : export.Columns;
-                if (export != null && export.UseGridColumns) columns.InsertRange(0, _settings.Columns);
 
+                if (export != null && export.UseGridColumns)
+                    columns.InsertRange(0, _settings.Columns);
+
+                columns.RemoveAll(x => !x.RenderMode.HasFlag(ColumnRenderMode.Export));
 
                 for (int i = 0; i < columns.Count; i++)
                     w.WriteField(columns[i].Caption);

Griddly.Mvc/GriddlyExcelResult.cs

@@ -32,7 +32,11 @@ public override void ExecuteResult(ControllerContext context)
 
                 var export = _settings.Exports.FirstOrDefault(x => x.Name == _exportName);
                 var columns = export == null ? _settings.Columns : export.Columns;
-                if (export != null && export.UseGridColumns) columns.InsertRange(0, _settings.Columns);
+
+                if (export != null && export.UseGridColumns)
+                    columns.InsertRange(0, _settings.Columns);
+
+                columns.RemoveAll(x => !x.RenderMode.HasFlag(ColumnRenderMode.Export));
 
                 for (int i = 0; i < columns.Count; i++)
                 {

Griddly.Mvc/GriddlyExport.cs

@@ -29,7 +29,7 @@ public GriddlyExport(string name, bool useGridColumns = false)
             : base(name, useGridColumns)
         {
         }
-        public GriddlyExport<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<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
+        public GriddlyExport<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>> expression, string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, ColumnRenderMode renderMode = ColumnRenderMode.Both, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
         {
             ModelMetadata metadata = null;
 
@@ -93,7 +93,7 @@ public GriddlyExport<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>> e
                 DefaultSort = defaultSort,
                 DefaultSortOrder = defaultSortOrder,
                 ClassName = className,
-                IsExportOnly = isExportOnly,
+                RenderMode = renderMode,
                 Width = width,
                 HtmlAttributesTemplate = htmlAttributes,
                 HeaderHtmlAttributes = (IDictionary<string, object>)headerHtmlAttributes,
@@ -103,9 +103,9 @@ public GriddlyExport<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>> e
             return this;
         }
 
-        public GriddlyExport<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<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
+        public GriddlyExport<TRow> Column(string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, ColumnRenderMode renderMode = ColumnRenderMode.Both, string width = null, SummaryAggregateFunction? summaryFunction = null, object summaryValue = null, Func<TRow, object> template = null, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
         {
-            return Column<object>(null, caption, format, expressionString, defaultSort, className, isExportOnly, width, summaryFunction, summaryValue, template, htmlAttributes, headerHtmlAttributes, defaultSortOrder, value);
+            return Column<object>(null, caption, format, expressionString, defaultSort, className, renderMode, width, summaryFunction, summaryValue, template, htmlAttributes, headerHtmlAttributes, defaultSortOrder, value);
         }
     }
 }

Griddly.Mvc/GriddlySettings.cs

@@ -403,7 +403,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, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
+        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, ColumnRenderMode renderMode = ColumnRenderMode.Both, 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, Expression<Func<TRow, object>> value = null)
         {
             ModelMetadata metadata = null;
 
@@ -467,7 +467,7 @@ public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>>
                 DefaultSort = defaultSort,
                 DefaultSortOrder = defaultSortOrder,
                 ClassName = className,
-                IsExportOnly = isExportOnly,
+                RenderMode = renderMode,
                 Width = width,
                 HtmlAttributesTemplate = htmlAttributes,
                 HeaderHtmlAttributes = (IDictionary<string, object>)headerHtmlAttributes,
@@ -477,9 +477,9 @@ public GriddlySettings<TRow> Column<TProperty>(Expression<Func<TRow, TProperty>>
             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, Func<TRow, object> htmlAttributes = null, object headerHtmlAttributes = null, int defaultSortOrder = 0, Expression<Func<TRow, object>> value = null)
+        public GriddlySettings<TRow> Column(string caption = null, string format = null, string expressionString = null, SortDirection? defaultSort = null, string className = null, ColumnRenderMode renderMode = ColumnRenderMode.Both, 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, Expression<Func<TRow, object>> value = null)
         {
-            return Column<object>(null, caption, format, expressionString, defaultSort, className, isExportOnly, width, summaryFunction, summaryValue, template, filter, htmlAttributes, headerHtmlAttributes, defaultSortOrder, value);
+            return Column<object>(null, caption, format, expressionString, defaultSort, className, renderMode, width, summaryFunction, summaryValue, template, filter, htmlAttributes, headerHtmlAttributes, defaultSortOrder, value);
         }
 
         public GriddlySettings<TRow> SelectColumn(Expression<Func<TRow, object>> id, object summaryValue = null, Func<TRow, object> inputHtmlAttributesTemplate = null)

Griddly/Views/Shared/Griddly/Griddly.cshtml

@@ -14,7 +14,7 @@
 @{
     GriddlySettings settings = (GriddlySettings)ViewBag.settings;
 
-    settings.Columns.RemoveAll(x => x.IsExportOnly);
+    settings.Columns.RemoveAll(x => !x.RenderMode.HasFlag(ColumnRenderMode.View));
 
     bool simple = ViewBag.isSimpleGriddly == true;
     bool isFirstRender = ViewContext.Controller.ControllerContext.IsChildAction || simple;