TsadriuUtilities.Excel 2.5.1

TsadriuUtilities.Excel

A small package that parses an Excel (XLSX only).

TsadriuUtilities.Excel is a library that helps on dealing with XLSX files, to make it easier and save a little bit of time.

> Features <

ExcelWorkbook:

→ To create a new instance, use IExcelWorkbook workbook = new ExcelWorkbook("fullFilePath", CultureInfo = null) + 2 overload;

• List<IExcelSheet> SheetList { get; set; }
  • Gets or sets the IExcelSheet list of the current IExcelWorkbook.
• GetSheet(int index) + 1 overload:
  • Gets the IExcelSheet based on the index. If the IExcelSheet is not found, it will return a new IExcelSheet with the name UNDEFINED.
  • Supports workbook[int index], workbook[string "sheetName"] variants.
• GetSheetIndex(string name) + 1 overload:
  • Returns the index of a sheet (if it is found, otherwire returns -1).
  • Not fully implemented, using this will launch a not implemented exception.

ExcelSheet:

→ To create a new instance, use IExcelSheet sheet = new ExcelSheet();

• string Name { get; set; }
  • Gets or sets the sheet name.
• int Id { get; set; }
  • Gets or sets the sheet id (this is based on the excel's sheet order).
• bool IsVisible { get; set; }
  • Gets or sets the visibility of a Sheet.
• List<IExcelCell> CellList { get; set; }
  • Gets or sets the cell list.
• int LastColumnIndex { get; set; }
  • Gets or sets the last column index. This index is 0-based.
• int LastRowIndex { get; set; }
  • Gets or sets the last row index. This index is 0-based.
• AddCell(IExcelCell cell):
  • Adds a IExcelCell to the sheet.
• GetCell(Coordinate coordinate) + 2 overload:
  • Returns the IExcelCell based on the coordinate.
  • Supports sheet[Coordinate coordinate], sheet[int columnIndex, int **rowIndex] and sheet[string excelCoordinate] variants.
• GetCellValue<T>(Coordinate coordinate):
  • Retrieves the cell's value based on the IExcelCell.Type (if the IExcelCell.Type is CellTypeEnum.Formula, it will use IExcelCell.SubType instead). Exception is thrown when the IExcelCell.Type is not the same as the T.
• GetCellType(Coordinate coordinate, bool avoidFormulaType = true):
  • Retrieves the ExcelCell type.
  • If avoidFormulaType is set to true and IExcelCell.Type is CellTypeEnum.Formula, it will return the IExcelCell.SubType.
  • If avoidFormulaType is set to false, it returns the IExcelCell.Type, no matter what it is.
• GetCellCoordinate(string cellValue, StringComparison comparison = StringComparison.OrdinalIgnoreCase) + 1 overload:
  • Retrieves the Coordinate of the IExcelCell from the CellList by comparing the IExcelCell.StringValue or IExcelCell.NumericValue with the cellValue.
• GetCellRange(Coordinate coordinateOne, Coordinate coordinateTwo) + 8 overload:
  • Returns a range of cells based on the coordinates.

ExcelCell:

→ To create a new instance, use IExcelCell cell = new ExcelCell() + 3 overload;

• Coordinate Coordinate { get; set; }
  • Gets or sets the cell's coordinate.
• string StringValue { get; set; }
  • Gets or sets the cell's string/text value.
• double NumericValue { get; set; }
  • Gets or sets the cell's numeric value. This is only available if the Type" is CellTypeEnum.Numeric.
• DateTime DateTimeValue { get; set; }
  • Gets the cell's DateTime value. If the Type is CellTypeEnum.Numeric, it will try to convert it into a DateTime.
• CellTypeEnum Type { get; set; }
  • Gets or sets the cell's type CellTypeEnum.String, CellTypeEnum.Numeric or CellTypeEnum.Formula).
• CellTypeEnum SubType { get; set; }
  • Gets or sets the cell's subtype CellTypeEnum.String or CellTypeEnum.Numeric). This is used when Type is a CellTypeEnum.Formula.
• bool IsFormula { get; set; }
  • Gets a value indicating whether the cell is a formula based on Type.
• string FormulaValue { get; set; }
  • Gets or sets the cell's formula's value. This is only available when the IsFormula is true.
• GetValueAsString(bool isDateTime = false, string dateFormat = "dd/MM/yyyy"):
  • Checks the cell's Type and SubType. If either is CellTypeEnum.String or CellTypeEnum.Numeric, it will return the content as a string.
  • If the cell is a DateTime, set isDateTime to true.
• GetCellContaining(StringComparison comparison, params string[] values):
  • Checks the CellList and tries to return the IExcelCell that contains the values.
  • If the IExcelCell is not found, it will return an empty IExcelCell.

Coordinate:

→ To create a new instance, use Coordinate coordinate = new Coordinate() + 1 overload;

• int ColumnIndex { get; set; }
  • Gets or sets the column index (0-based index).
• int RowIndex { get; set; }
  • Gets or sets the row index (0-based index).
• string ExcelIndex { get; set; }
  • Gets or sets the index of the column and row of the excel.