IntNovAction.Utils.ExcelExporter 0.3.1

Excel Exporter

Permite exportar un IEnumerable a una o varias hoja excel. Aplicando formato a las filas en base a valores de cada uno de los elementos del IEnumerable.

Puede generar las columnas del excel leyendo los valores del atributo Display (Name, Order...)

Podemos generar una clase con los datos que vamos a mostrar

    public class TestListItem
    {
        [Display(Name = "PropA Disp Name", Order = 2)]
        public string PropA { get; set; }

        [Display(Order = 3)]
        public string PropB { get; set; }

        public int PropC { get; set; }
    }

Creamos un IEnumerable con items de esa clase...

    var dataToExport = new List<TestListItem>();
    for (int i = 0; i < 5; i++)
    {
        dataToExport.Add(new TestListItem()
        {
            PropA = $"PropA - {i}",
            PropB = $"PropB - {i}",
            PropC = i,
        });
    }

Configuramos el excel, creando una hoja, con un nombre e indicando los datos a pintar. La librería leerá los metadatos de la clase, creando las columnas con el nombre indicado en los atributos.

    var exporter = new Exporter()
		.AddSheet<TestListItem>(c => c.Name("Sheet Name").SetData(dataToExport));

Por ultimo exportamos el excel

var result = exporter.Export();

Crear múltiples hojas

Para crear múltiples hojas con múltiples sets de datos llamamos varias veces a AddSheet:

    var exporter = new Exporter()
		.AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name"))
        .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet 2 Name"));

No pintar la cabecera con los nombres de columnas de la tabla

Para no pintar en la tabla los nombres de las columnas y que empiecen los datos en la coordenadas iniciales.

    var exporter = new Exporter()
		.AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name").HideColumnHeaders());
        

Establecer coordenadas para pintar la tabla

Podemos especificar que no se empiecen a pintar las filas en A1, sino donde queramos

var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport)
        .Name("Sheet Name")
        .SetCoordinates(3, 2)
     );
        

Formatear las filas en base a los valores

Podemos establecer condiciones (reglas de formato a nivel de fila) en forma de expresiones, que apliquen formatos:

• Bold
• Italic
• Underline
• Color
• FontSize
• BottomBorder

Si el valor de PropC es 3, entonces haz la fila en negrita y cursiva:

    var exporter = new Exporter()
		.AddSheet<TestListItem>(c => c.SetData(dataToExport)
		  .Name("Sheet Name")
		  .AddFormatRule(p => p.PropC == 3, format => format.Bold().Italic())
		);

Establecer un título en la hoja

Podemos establecer un título por defecto en la parte superior

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
            .Title()
    );

O personalizarlo con un texto, formato, etc.

    var exporter = new Exporter()
	.AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
            .Title(t => t.Text("Title Text").Format(f => f.Bold()))
    );

Especificar las columnas a mostrar

Mediante la colección columns podemos añadir, ocultar o quitar columnas. Los metadatos del atributo Display de la propiedad (si se utiliza) se tendrán en cuenta.

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
		.Columns(cols =>
	    {
            cols.Clear(); // Limpiamos todas las columnas autogeneradas
            cols.AddColumn(prop => prop.PropA);
            cols.AddColumn(prop => prop.PropA).Header("Prop A (2)");
        })
    );

También podemos dar formato a las cabeceras de las columnas

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
		.Columns(cols =>
	    {
            cols.Clear(); // Limpiamos todas las columnas autogeneradas
            cols.AddColumn(prop => prop.PropA)
			    .Header(h => h.Text("PropC Inc").Format(f => f.Italic()))
			;
        })
    );

Con HideColumn podemos quitar alguna de las columnas autogeneradas. Muy util cuando pasamos un DTO que tiene IDs que no queremos mostrar.

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
		.Columns(cols =>
	    {
            cols.HideColumn(prop => prop.PropA);
        })
    );

Podemos dar formato a una columna, si entra en conflicto con un formato condicional de fila, el de fila tiene preferencia. Además de los formatos de fila, se puede establecer el ancho de la columna.

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
		.Columns(cols =>
	    {
            cols.Clear(); // Limpiamos todas las columnas autogeneradas
            cols.AddColumn(prop => prop.PropA);            
            cols.AddColumn(prop => prop.PropB).DataFormat(f => f.Bold().Width(50));           
        })
    );

Modificar los datos a mostrar mediante expresiones

Podemos especificar en lugar del nombre de la columna, una expresión para realizar transformaciones a los datos. Hay que especificar el título de la columna.

    var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport).Name("Sheet Name")
		.Columns(cols =>
	    {
            cols.Clear(); // Limpiamos todas las columnas autogeneradas
            cols.AddColumn(prop => prop.PropA); // Mostramos la columna PropA
            cols.AddColumnExpr(prop => prop.PropC + 1, "PropC plus 1"); // Mostramos el contenido de PropC sumándole 1 y lo llamamos PropC plus 1
        })
    );

Formato por defecto

Si no queremos dar formato a la hoja a mano podemos indicar que se haga un formato por defecto (título y cabecera)

var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport)
        .Name("Sheet Name")
        .ApplyDefaultStyles()
     );
        

Imprimir todo en una hoja

Podemos indicar que se impriman todos los datos en una sola hoja:

var exporter = new Exporter()
    .AddSheet<TestListItem>(c => c.SetData(dataToExport)
        .Name("Sheet Name")
        .PrintInOnePage()
     );