Trabajar con archivos Excel desde WindowsForms (SpreadSheetLight)

 

Hola a todos:

En este articulo les compartiré como de una forma sencilla podemos trabajar con archivos Excel desde un proyecto de Visual Studio sin necesidad de recurrir a los tan tediosos objetos Com de Microsoft Office que muchas veces provocan mas dolores de cabeza que soluciones.

Buscando por la red la manera de como operar con archivos Excel de una forma sencilla me encontré con una pequeña librería de uso libre, la cual ofrece diferentes funcionalidades para trabajar con estos archivos sin romperse tanto la cabeza y sin la necesidad de referencias ningún objeto COM, hablo de:

SpreadSheetLight

“SpreadsheetLight is an open source Open XML spreadsheet library for .NET Framework written in C#, and is released under the MIT License. You can create new Open XML spreadsheets, or work with existing Open XML spreadsheets that are compatible with Microsoft Excel 2007/2010/2013 and LibreOffice Calc.”

Esta pequeña librería explota la  característica de los Xml que conforman la mayoría de los archivos del paquete de Microsoft Office a través del uso de:

SDK de Open XML 2.5 para Office

Con el Open Xml tenemos todo el acceso disponible a los XMl de los archivos de Microsoft Office pudiendo explotar los datos y estilos contenidos en ellos de una manera muy sencilla, pero SpreadSheetLinght hace este camino aun mas fácil al exponer funcionalidad convertidos en metodos y funciones parametrizables y muy intuitivos y por debajo se encarga de explotar los XML’s por medio del Open Xml.

En este articulo les mostrare como:

1. Crear un archivo de Microsoft Office Excel desde Visual Studio en un proyecto WindowsForms y como poblarlo con datos desde un control DataGridView.

2. Como abrir, leer y cargar a un control DataGridView los datos de un archivo de Microsoft Office Excel

Como siempre…

Antes de entrar de lleno en el tema del manejo de archivos de Microsoft Office Excel recuerde que: “El objetivo no es otro mas que el de orientar a los Parvulos .Net sobre como usando una pequeña librería podemos trabajar con archivo de Microsoft Office Excel, todo lo escrito en este articulo no es ensayado y no es revisado por nadie mas por lo cual, podría contener errores gramaticales y sintácticos, el articulo y sus conceptos no pretenden ser la verdad absoluta del tema por lo tanto siéntase con la confianza de dejar sus comentarios y opiniones en la sección de comentarios al final del mismo y si lo considera prudente envíeme un correo electrónico por medio del formulario de contacto con sus ideas, opiniones y experiencias sobre el tema, y por ultimo si el articulo le es de utilidad por favor considere dejar un comentario de agradecimiento, apoyar al mismo recomendando los artículos y unirse como miembro del blog. Si se siente agradecido puede ver los anuncios que están en este articulo haciendo Click en ellos.”

Requisitos: Visual Studio 2013, Framework 4.0, descargar la librería SpreadSheetLigh pero sobre todo muchas ganas de aprender.

También como siempre recomiendo encarecidamente que antes de descargar los proyectos de ejemplo (que les pondré al final de articulo), traten de hacerlo ustedes mismos siguiendo paso a paso todo lo que se mencionara aquí, si tienen dudas en uno en especifico no duden en contactarme.

Creación de un Archivo EXCEL usando SpreadSheetLingth

1. Inicie Visual Studio 2013 y cree un proyecto del tipo WindowsForms

2. Agregue un nuevo elemento del tipo WindowsForms

3. Agregue controles TextBox, label, button y un control DataGridView y cree el siguiente diseño

Recuerde nombrar a los controles acorde los datos que representen, ejemplo: lblIdEmpleado, txtEmpleado, txtApellidoPaterno, btnCargar, etc,

Instalar SpreadSheetLigth

Para instalar SpreadSheetLigth en nuestro proyecto, tenemos dos opciones:

1. Usar el paquete de Nuget para descargar en línea la librería e instalarla en nuestro proyecto, para esto:

Localice el Explorador de soluciones –> Seleccione el proyecto que acaba de crear –> Click derecho –> Administrar paquetes Nuget.

Del panel izquierdo seleccione “En línea” –> en el panel izquierdo escriba SpreadsheetLight –> Presione la tecla “Enter” –> Del panel  Central ubique SpreadsheetLight –> Click sobre el botón Instalar

Después de instalado usted podrá ver la referencia de la librería dentro de las referencias del proyecto:

2. La segunda opción que tiene para instalar SpreadsheetLight es mediante la creación de la referencia a la librería directamente desde las referencias del proyecto, para ello:

• Descargue la librería desde esta dirección: SpreadSheetLight
• En el explorador de soluciones ubique el proyecto que acaba de crear
• Posicionese en Reference –> Click derecho –> Agregar referencia

• En el panel izquierdo elija “Examinar” –> presione el botón “Examinar” –> diríjase a la ubicación de descarga –> Seleccione la librería –> Click en “Agregar” –> Click en “Aceptar” –> Después usted podrá ver la referencia a la librería en la carpeta de referencias, tal cual como se muestra en la pantalla relacionado a Nuget.

Sea cual la opción que haya escogido para instalar SpreaSheetLigth, le comento que SpreadSheetLigth tiene una dependencia hacia el OpenXml v2.0 por lo que usted tiene que descargar y referenciar esta librería, por favor descargue la librería y haga la referencia.

Bien, teniendo ambas librerías referenciadas procedamos a crear algunas líneas de código…

Crear un documento Excel usando SpreadSheetLigth:

Entiendo que usted conoce la manera de poblar un control DataGridView, de no ser así por favor antes de continuar analice lo platicado en este articulo.

Llenar DataGridView con datos de TextBox’s usando Datasource o el método Add()

Crearemos un método que mediante la librería cree un objeto del tipo SLDocument el cual nos servirá para ir seteando valores a lo que dentro del archivo Excel serán las celdas:

        /// <summary>
        /// Metodo encargado de crear un archivo Excel y poblarlos con los datos de un control DataGridView
        /// </summary>
        private void CreateExcelFile()
        {
            //Creamos un objeto SqlDocument
            SLDocument sl = new SLDocument();
            //usamos la función SetCellValue para poblar la celda
            //sl.SetCellValue(indicedefila, indicedecolumna, "valor a establecer");
            sl.SetCellValue(1, 1, "Id Empleado");
            sl.SetCellValue(1, 2, "Empleado");
            sl.SetCellValue(1, 3, "Apellido Paterno");
            sl.SetCellValue(1, 4, "Apellido Materno");

            //definimos el indice de la fila donde comenzaremos a vaciar los datos del DataGridView
            int rowIndex = 2;
            //
            //definimos el indice de la columna donde comenzaremos a vaciar los datos
            int columnIndex = 1;
            //
            //Recorremos las filas del control
            foreach (DataGridViewRow row in dgvDatos.Rows)
            {
                //Recorremos la lista de columnas del control
                for(int i = 0; i < dgvDatos.Columns.Count; i++)
                {
                    //comenzamos a enviar los valores al objeto SLDocument, usando el valor de la fila y columna
                    sl.SetCellValue(rowIndex, columnIndex, Convert.ToString(row.Cells[i].Value));
                    columnIndex += 1;
                }
                rowIndex += 1;
                columnIndex = 1;
            }
            //
            //Guardamos el documento
            //como no definimos ningun directorio el archivo se creara automaticamente en la carpeta bin/debug
            sl.SaveAs("TestExcel.xlsx");
        }

Cargar un documento Excel usando SpreadSheetLigth:

        private void Import()
        {
            //usamos el objeto FileSteam para recuperar el archivo
            FileStream fs = new FileStream("TestExcel.xlsx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
            //
            //Creamos el obejto SLDocument para cargar el archivo Excel
            SLDocument sl = new SLDocument(fs);

            //refinimos el indice de la fila de donde comenzaremos a leer
            int rowIndex = 2;

            //recorremos el objeto SLDocument mediante un ciclo While
            //este ciclo recorre el documento miestras no se encuentre una celda vacia
            while (!string.IsNullOrEmpty(sl.GetCellValueAsString(rowIndex, 1)))
            {
                //tomamos los valores de las celdas y lo pasamos a las respectivas columnas del control DataGridView
                dgvDatos.Rows.Add(sl.GetCellValueAsString(rowIndex, 1), sl.GetCellValueAsString(rowIndex, 2),
                    sl.GetCellValueAsString(rowIndex, 3), sl.GetCellValueAsString(rowIndex, 4));

                //incrementeamos una unidad al indice de la fila para continuar con el recorrido
                rowIndex += 1;
            }
        }

Bien hasta aqui tenemos la codificacion necesaria para Crear y Leer un archivo de Microsoft Excel usando SpreadSheetligth, solo nos queda probarlo:

Primero les mostrare que dentro de mi directorio de trabajo no tengo ningún archivo Excel:

Ejecute la aplicación:

Presione el botón Generar Excel y diríjase a su directorio de trabajo para que observe que se acaba de crear un archivo Excel y que este tiene un peso en kb lo cual significa que no esta vacío.

Abra el archivo y observe que los datos tal cual como los cargamos al control se encuentran en el archivo Excel.

Realice algunos cambios en la información cargada en el archivo, esto a fin de comprobar que la carga del archivo se realiza correctamente y que no depende solo de los datos que se crearon con la librería.

Ahora, probemos la carga:

Para eso asegúrese que el formulario este totalmente limpio:

Presione el botón “Cargar Excel” y observe como los datos se cargan correctamente:

Existe demasiada funcionalidad que podemos explotar de esta librería, como por ejemplo:

Definir un estilo y formato a las celdas, colores, imágenes, filtros, formulas, comentarios, copiar estilo por celda, rangos, renombrar libros, crear libros, etc.

Para mas ejemplos por favor diríjase a: http://spreadsheetlight.com/sample-code/

Para mas información y documentación sobre Open Xml, por favor dirijase a: Welcome to the Open XML SDK 2.5 for Office

Escribir este articulo me llevo mas de 1 hora, dejar un comentario de agradecimiento le tomara 5 minutos.

Saludos desde Monterrey, Nuevo León México!
Ejemplo C#
Ejemplo Vb.Net