Exportable is a component for .NET, 100% open source, with MIT license; builded on top of NPOI. In the future, are plans to handle other formats, like CSV, Json, and others.
- Version 2.0 has a shorter namespace, from
Infodinamica.Framework.ExportabletoExportable - Version 2.0 don't requieres set the
Keyparameter inAddContainermethod - Version 2.0 support ignore and rename columns on runtime
- Version 2.0 don't use Infodinamica.Framework.Core
- Version 2.0 use the latest stable NPOI release (2.3.0)
Install-Package Infodinamica.Framework.Exportable
The version 2.+, requires .NET Framework 4.5.0. Version 1.* requires .NET Framework 3.5.
These are the commonly namespace required's to export and import:
using Exportable.Engines;
using Exportable.Engines.Excel;IList<DummyPerson> dummyPeople = new List<DummyPerson>();
//Add data to dummyPeople...
IExportEngine engine = new ExcelExportEngine();
engine.AddData(dummyPeople);
MemoryStream memory = engine.Export();IList<DummyPerson> dummyPeople = new List<DummyPerson>();
//Add data to dummyPeople...
IExcelExportEngine engine = new ExcelExportEngine();
engine.SetFormat(ExcelVersion.XLS);
engine.AddData(dummyPeople);
MemoryStream memory = engine.Export();using Exportable.Attribute;public class DummyPerson
{
[Exportable(3, "Full Name", FieldValueType.Text)]
public string Name { get; set; }
[Exportable(1, "Birth Date", FieldValueType.Date, "MM-yyyy")]
public DateTime BirthDate { get; set; }
[Exportable(2, "How Many Years", FieldValueType.Numeric, "#0")]
public int Age { get; set; }
[Exportable(4, "Is Adult", FieldValueType.Bool)]
public bool IsAdult { get; set; }
[Exportable(IsIgnored = true)]
public string ThisColumnWillBeIgnored { get; set; }
}You can override the column name with AddColumnsNames method. You need a plain class (in this case DummyPersonWithAttributes) and specify the new column name. Please note that this configuration overrides the column name specified in the class attribute
IExportEngine engine = new ExcelExportEngine();
var key = engine.AddData(dummyPeople);
engine.AddColumnsNames<DummyPersonWithAttributes>(key, x => x.Name, "this is a new name LOL!");
var stream = engine.Export();You can ignore columns with AddIgnoreColumns method. You need a plain class (in this case DummyPersonWithAttributes) and specify the column that you want to ignore. Please note that this configuration overrides the column ignore specified in the class attribute
IExportEngine engine = new ExcelExportEngine();
var key = engine.AddData(dummyPeople);
engine.AddIgnoreColumns<DummyPersonWithAttributes>(key, x => x.Name);
var stream = engine.Export();You can handle internationalization column names, by using resources in attributes. Please note that ResouceType property, has a pointer to resource file, while HeaderName property has the key of the resource
class DummyPersonWithAttributesAndResource
{
[Exportable(Position = 0, HeaderName = "Header1", ResourceType = typeof(res), TypeValue = FieldValueType.Text)]
public string Name { get; set; }
[Exportable(1, "Header2", FieldValueType.Date, "MM-yyyy", ResourceType = typeof(res))]
public DateTime BirthDate { get; set; }
[Exportable(IsIgnored = true)]
public int Age { get; set; }
[Exportable(3, "Is Adult", FieldValueType.Bool)]
public bool IsAdult { get; set; }
}| Name | Value |
|---|---|
| Header1 | Column 1 |
| Header2 | Column 2 |
IImportEngine engine = new ExcelImportEngine();
var key = engine.AddContainer<DummyPersonWithAttributes>();
engine.SetDocument(pathToFile); //or MemoryStream instance
var data = engine.GetList<DummyPersonWithAttributes>(key);IImportEngine engine = new ExcelImportEngine();
engine.AsExcel().SetFormat(ExcelVersion.XLS);
var key = engine.AddContainer<DummyPersonWithAttributes>();
engine.SetDocument(pathToFile); //or MemoryStream instance
var data = engine.GetList<DummyPersonWithAttributes>(key);Please feel free to contact me if you have a problem, question o suggestion:
- email: vvenegasv@gmail.com
- phone: +56979962612
- issue tracker of this project