Click here to Skip to main content
14,386,097 members

ExcelApi_C-

Rate this:
5.00 (1 vote)
Please Sign up or sign in to vote.
5.00 (1 vote)
30 Nov 2019CPOL
A C# Api code to work with excel workbook

Excel API -Eli Arad

My intent was to work with strucure and list of structure in excel interop excel automatically. The functions should be simple and self explain to write fast structures to excel

For example:

Employee emp = new Employee
{
    Email_ID = "eeee",
    Employee_ID = "42323232",
    Name = "Eli Arad",
    Number = "e11999"
};

Employee emp1 = new Employee
{
    Email_ID = "Eli",
    Employee_ID = "027104918",
    Name = "El9999",
    Number = "050480277"
};

List<Employee> employees = new List<Employee>();
employees.Add(emp);
employees.Add(emp1);

Here we have a two structures and we want to write them with the header and the data using simple function. The function will use the Range capatabiliy to write the data fast:

ExcelApi.CloseExcel(); // this function close all running excel process ExcelApi t = new ExcelApi(); // initialize the API
string fileName = "c:\\MyExcelFile.xlsx";
if (t.NewFile(fileName) == true)
{

    if (t.WriteStruct<Employee>(1, 10, 2, employees, out outMessage) == false)
    {

    }
}

We see here that we have a WriteStruct function which is a template base struct. The function uses the C# reflection to get the name of the class fields for the header and the field values.

To read the structure i used the same tecnique.

List remp1 = new List(); t.ReadStruct(1 ,11, 2, ref remp1, 2, out outMessage);

The API let you read a structure which is a list and a list of strcture.

All indexes start from 1, as the C# excel API does.

The API can be expand to use more and more features and i intend to update it offten.

Functions:

ReadRowList will read an amount of values from a specific row( starting from a of course) it will use the Range to read from memory rather then read cell by cell which is very slow compare to range read.

public bool ReadRowList(int sheetIndex, int startRowIndex, int startColIndex, out List list, int colCount, out string outMessage) {
        outMessage = string.Empty;
        list = new List<object>();
        try
        {

            Range range = (Excel.Range)ws[sheetIndex].Range[ws[sheetIndex].Cells[startRowIndex, startColIndex], ws[sheetIndex].Cells[startRowIndex, startColIndex + colCount]];
            object[,] values = (object[,])range.Value2;


            for (int i = 1; i <= colCount; i++)
            {                    
                list.Add(values[1,i]);
            }
        }
        catch (Exception err)
        {
            outMessage = err.Message;
            return false;
        }
        return true;
    }
}


public int ExcelColumnNameToNumber(string col_name);
public string GetExcelColumnName(int columnNumber);
public bool ReadColumnList(int sheetIndex,
                         int startRowIndex,
                         int startColIndex,
                         out List<object> list,
                         int rowCount,
                         out string outMessage);
public bool ReadStruct<T>(int sheetIndex, int startRowIndex, int startColIndex, ref T s, out string outMessage) where T : class

public bool ReadStruct<T>(int sheetIndex, 
                              int startRowIndex, 
                              int startColIndex, 
                              ref List<T> s, 
                              int rowCount, 
                              out string outMessage) where T : class, new()


// Slow write 
public bool WriteCell(int sheetIndex,
							  int rowIndex,
							  int colIndex,
							  object value,
							  bool bold,
							  Color foreColor,
							  Color backColor,
							  out string outMessage)

public bool WriteStruct<T>(int sheetIndex, int startRowIndex, int startColIndex, List<T> s, out string outMessage)

public bool WriteStruct<T>(int sheetIndex, int startRowIndex, int startColIndex, T s, out string outMessage)
public bool UpdateLastSheetName(string newName, out string outMessage)        
public bool AddWorkSheetAtTheBegin(string name, out string outMessage)
public bool UpdateSheetName(int index, string newName, out string outMessage)
public bool AddWorkSheetAtTheEnd(string name, out string outMessage);
public bool UpdateFirstSheetName(string newName, out string outMessage)
public int SheetCount{get;}
public string SheetName(int index)
public void Save(string fileName = "")
public bool NewFile(string fileName)
public bool OpenFile(string fileName)
public static void CloseExcel()

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

eli.arad
United States United States
No Biography provided

Comments and Discussions

 
-- There are no messages in this forum --
Project
Posted 30 Nov 2019

Stats

1.9K views
74 downloads