Category / Section
How to export dynamic list using TypeBuilder in .NET WebForms Grid?
1 min read
In some cases, there is a need for the user to export list of objects. It is possible by using the TypeBuilder Concept.
Solution
In this concept, type for each column will be collected from the Grid Model and generated the Virtual Class. Later, using the Virtual Class instance the given data will be deserialized and then assigned as dataSource to the Export method.
Razor
@(Html.EJ().Grid<object>("FlatGrid")
.Datasource((IEnumerable<object>)ViewBag.datasource)
.ToolbarSettings(toolBar => toolBar.ShowToolbar().ToolbarItems(items =>
{
items.AddTool(ToolBarItems.ExcelExport);
items.AddTool(ToolBarItems.WordExport);
items.AddTool(ToolBarItems.PdfExport);
}))
.AllowPaging()
.AllowScrolling()
.ScrollSettings(scroll => { scroll.Height(300).Width(886); })
.Columns(col =>
{
col.Field("Column0").HeaderText("Column0").Add();
col.Field("Column1").HeaderText("Column1").Add();
col.Field("Column2").HeaderText("Column0").Add();
})
)
Controller
public ActionResult TypeBuilder()
{
Dictionary<string, object> row;
for (int i = 0; i < 50; i++)
{
row = new Dictionary<string, object>();
for (int j = 0; j < 50; j++)
{
row.Add("Column" + j, "DS" + i + j);
}
rows.Add(row);
}
ViewBag.datasource = rows;
return View();
}
public void ExportToExcel(string GridModel)
{
GridProperties obj = ConvertGridObject(GridModel);
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
ExcelExport exp = new ExcelExport();
exp.Export(obj, data, "Export.xlsx", ExcelVersion.Excel2010, false, false, "flat-saffron");
}
public void ExportToWord(string GridModel)
{
GridProperties obj = ConvertGridObject(GridModel);
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
WordExport exp = new WordExport();
exp.Export(obj, data, "Export.docx", false, false, "flat-saffron");
}
public void ExportToPdf(string GridModel)
{
GridProperties obj = ConvertGridObject(GridModel);
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
PdfExport exp = new PdfExport();
exp.Export(obj, data, "Export.pdf", false, false, "flat-saffron");
}
private GridProperties ConvertGridObject(string gridProperty)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
IEnumerable div = (IEnumerable)serializer.Deserialize(gridProperty, typeof(IEnumerable));
GridProperties gridProp = new GridProperties();
foreach (KeyValuePair<string, object> ds in div)
{
var property = gridProp.GetType().GetProperty(ds.Key, BindingFlags.Instance | BindingFlags.Public | BindingFlags.IgnoreCase);
if (property != null)
{
Type type = property.PropertyType;
string serialize = serializer.Serialize(ds.Value);
object value = serializer.Deserialize(serialize, type);
property.SetValue(gridProp, value, null);
}
}
return gridProp;
}
public static Type GetTableType(GridProperties gridProperty)
{
// Create needed TypeBuilder helpers
AppDomain myDomain = Thread.GetDomain();
AssemblyName myAsmName = new AssemblyName("Anonymous");
AssemblyBuilder myAsmBuilder = myDomain.DefineDynamicAssembly(myAsmName, AssemblyBuilderAccess.Run);
ModuleBuilder myModBuilder = myAsmBuilder.DefineDynamicModule(myAsmName.Name);
TypeBuilder myTypeBuilder = myModBuilder.DefineType("TestClass", TypeAttributes.Public);
foreach (var col in gridProperty.Columns)
{
Type PropertyType;
var PropertyName = col.Field;
switch (col.Type)
{
case "number": PropertyType = Type.GetType("System.Decimal");
break;
case "string": PropertyType = Type.GetType("System.String");
break;
case "boolean": PropertyType = Type.GetType("System.Boolean");
break;
default: PropertyType = Type.GetType("System.String");
break;
}
FieldBuilder PropertyFieldBuilder = myTypeBuilder.DefineField(PropertyName.ToLower(), PropertyType, FieldAttributes.Private);
PropertyBuilder PBuilder = myTypeBuilder.DefineProperty(PropertyName, System.Reflection.PropertyAttributes.HasDefault, PropertyType, null);
MethodAttributes getSetAttr = MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.HideBySig;
MethodBuilder getPropertyBuilder = myTypeBuilder.DefineMethod("get" + PropertyName, getSetAttr, PropertyType, Type.EmptyTypes);
// Constructing IL Code for get and set Methods.
ILGenerator GetPropGenerator = getPropertyBuilder.GetILGenerator();
GetPropGenerator.Emit(OpCodes.Ldarg_0);
GetPropGenerator.Emit(OpCodes.Ldfld, PropertyFieldBuilder);
GetPropGenerator.Emit(OpCodes.Ret);
MethodBuilder setPropertyBuulder = myTypeBuilder.DefineMethod("set_" + PropertyName, getSetAttr, null, new Type[] { PropertyType });
ILGenerator SetPropGenerator = setPropertyBuulder.GetILGenerator();
SetPropGenerator.Emit(OpCodes.Ldarg_0);
SetPropGenerator.Emit(OpCodes.Ldarg_1);
SetPropGenerator.Emit(OpCodes.Stfld, PropertyFieldBuilder);
SetPropGenerator.Emit(OpCodes.Ret);
PBuilder.SetGetMethod(getPropertyBuilder);
PBuilder.SetSetMethod(setPropertyBuulder);
}
ConstructorInfo objCtor = typeof(object).GetConstructor(new Type[-1 + 1]);
ConstructorBuilder pointCtor = myTypeBuilder.DefineConstructor(MethodAttributes.Public, CallingConventions.Standard, Type.EmptyTypes);
ILGenerator ctorIL = pointCtor.GetILGenerator();
// Constructing IL Code for the Type Constructor.
ctorIL.Emit(OpCodes.Ldarg_0);
ctorIL.Emit(OpCodes.Call, objCtor);
ctorIL.Emit(OpCodes.Ret);
return myTypeBuilder.CreateType();
}
Aspx
<ej:Grid ID="FlatGrid" runat="server" AllowPaging="True" OnServerWordExporting="ExportToWord1" OnServerPdfExporting="ExportToPdf1" OnServerExcelExporting="ExportToExcel1"> <ToolbarSettings ShowToolbar="true" ToolbarItems="excelExport,wordExport,pdfExport"></ToolbarSettings> <ScrollSettings Height="300" Width="880" ></ScrollSettings> <Columns> <ej:Column Field="Column0" HeaderText="Column0" /> <ej:Column Field="Column1" HeaderText="Column1" /> <ej:Column Field="Column2" HeaderText="Column2" /> </Columns> </ej:Grid>
C#
public void TypeBuilder()
{
Dictionary<string, object> row;
for (int i = 0; i < 50; i++)
{
row = new Dictionary<string, object>();
for (int j = 0; j < 50; j++)
{
row.Add("Column" + j, "DS" + i + j);
}
rows.Add(row);
}
this.FlatGrid.DataSource= rows;
this.FlatGrid.DataBind();
}
public void ExportToExcel1(object sender, Syncfusion.JavaScript.Web.GridEventArgs e)
{
GridProperties obj = ConvertGridObject(e.Arguments["model"].ToString());
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
ExcelExport exp = new ExcelExport();
exp.Export(obj, data, "Export.xlsx", ExcelVersion.Excel2010, false, false, "flat-saffron");
}
public void ExportToWord1(object sender, Syncfusion.JavaScript.Web.GridEventArgs e)
{
GridProperties obj = ConvertGridObject(e.Arguments["model"].ToString());
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
WordExport exp = new WordExport();
exp.Export(obj, data, "Export.docx", false, false, "flat-saffron");
}
public void ExportToPdf1(object sender, Syncfusion.JavaScript.Web.GridEventArgs e)
{
GridProperties obj = ConvertGridObject(e.Arguments["model"].ToString());
// Get the dynamic table type
Type test = GetTableType(obj);
// Create instance of Array to the dynamic table type
var inst = Array.CreateInstance(test, 1);
string griddata = serializer.Serialize(rows);
var data = serializer.Deserialize(griddata, inst.GetType()) as object[];
PdfExport exp = new PdfExport();
exp.Export(obj, data, "Export.pdf", false, false, "flat-saffron");
}
private GridProperties ConvertGridObject(string gridProperty)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
IEnumerable div = (IEnumerable)serializer.Deserialize(gridProperty, typeof(IEnumerable));
GridProperties gridProp = new GridProperties();
foreach (KeyValuePair<string, object> ds in div)
{
var property = gridProp.GetType().GetProperty(ds.Key, BindingFlags.Instance | BindingFlags.Public | BindingFlags.IgnoreCase);
if (property != null)
{
Type type = property.PropertyType;
string serialize = serializer.Serialize(ds.Value);
object value = serializer.Deserialize(serialize, type);
property.SetValue(gridProp, value, null);
}
}
public static Type GetTableType(GridProperties gridProperty)
{
// Create needed TypeBuilder helpers
AppDomain myDomain = Thread.GetDomain();
AssemblyName myAsmName = new AssemblyName("Anonymous");
AssemblyBuilder myAsmBuilder = myDomain.DefineDynamicAssembly(myAsmName, AssemblyBuilderAccess.Run);
ModuleBuilder myModBuilder = myAsmBuilder.DefineDynamicModule(myAsmName.Name);
TypeBuilder myTypeBuilder = myModBuilder.DefineType("TestClass", TypeAttributes.Public);
foreach (var col in gridProperty.Columns)
{
Type PropertyType;
var PropertyName = col.Field;
switch (col.Type)
{
case "number": PropertyType = Type.GetType("System.Decimal");
break;
case "string": PropertyType = Type.GetType("System.String");
break;
case "boolean": PropertyType = Type.GetType("System.Boolean");
break;
default: PropertyType = Type.GetType("System.String");
break;
}
FieldBuilder PropertyFieldBuilder = myTypeBuilder.DefineField(PropertyName.ToLower(), PropertyType, FieldAttributes.Private);
PropertyBuilder PBuilder = myTypeBuilder.DefineProperty(PropertyName, System.Reflection.PropertyAttributes.HasDefault, PropertyType, null);
MethodAttributes getSetAttr = MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.HideBySig;
MethodBuilder getPropertyBuilder = myTypeBuilder.DefineMethod("get" + PropertyName, getSetAttr, PropertyType, Type.EmptyTypes);
// Constructing IL Code for get and set Methods.
ILGenerator GetPropGenerator = getPropertyBuilder.GetILGenerator();
GetPropGenerator.Emit(OpCodes.Ldarg_0);
GetPropGenerator.Emit(OpCodes.Ldfld, PropertyFieldBuilder);
GetPropGenerator.Emit(OpCodes.Ret);
MethodBuilder setPropertyBuulder = myTypeBuilder.DefineMethod("set_" + PropertyName, getSetAttr, null, new Type[] { PropertyType });
ILGenerator SetPropGenerator = setPropertyBuulder.GetILGenerator();
SetPropGenerator.Emit(OpCodes.Ldarg_0);
SetPropGenerator.Emit(OpCodes.Ldarg_1);
SetPropGenerator.Emit(OpCodes.Stfld, PropertyFieldBuilder);
SetPropGenerator.Emit(OpCodes.Ret);
PBuilder.SetGetMethod(getPropertyBuilder);
PBuilder.SetSetMethod(setPropertyBuulder);
}
ConstructorInfo objCtor = typeof(object).GetConstructor(new Type[-1 + 1]);
ConstructorBuilder pointCtor = myTypeBuilder.DefineConstructor(MethodAttributes.Public, CallingConventions.Standard, Type.EmptyTypes);
ILGenerator ctorIL = pointCtor.GetILGenerator();
// Constructing IL Code for the Type Constructor.
ctorIL.Emit(OpCodes.Ldarg_0);
ctorIL.Emit(OpCodes.Call, objCtor);
ctorIL.Emit(OpCodes.Ret);
return myTypeBuilder.CreateType();
}
Result
The following screenshot shows exporting the List of plain objects using the TypeBuilder Concept.
Figure: Export the List of plain objects using the TypeBuilder Concept.
Note:
A new version of Essential Studio for ASP.NET is available. Versions prior to the release of Essential Studio 2014, Volume 2 will now be referred to as a classic versions.The new ASP.NET suite is powered by Essential Studio for JavaScript providing client-side rendering of HTML 5-JavaScript controls, offering better performance, and better support for touch interactivity. The new version includes all the features of the old version, so migration is easy.
The Classic controls can be used in existing projects; however, if you are starting a new project, we recommend using the latest version of Essential Studio for ASP.NET. Although Syncfusion will continue to support all Classic Versions, we are happy to assist you in migrating to the newest edition.
For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion, you can try our 30-day free trial to check out our other controls. If you have any queries or require clarifications, please let us know in the comments section below.
You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!
