/// <summary>
/// Builds a model of the rows within this entity.
/// </summary>
internal override RowOrColumnsModel BuildRowsModel()
{
var rowsModel = new RowOrColumnsModel(true);
rowsModel.Add(this);
if (this.RowSpan > 1)
{
for (int count = 2; count <= this.RowSpan; count++)
{
rowsModel.Add(this);
}
}
return(rowsModel);
}
/// <summary>
/// Builds a model of the columns within this entity.
/// </summary>
internal override RowOrColumnsModel BuildColumnsModel()
{
var columnsModel = new RowOrColumnsModel(false);
columnsModel.Add(this);
if (this.ColumnSpan > 1)
{
for (int count = 2; count <= this.ColumnSpan; count++)
{
columnsModel.Add(this);
}
}
return(columnsModel);
}
/// <summary>
/// Appends the <see cref="RowOrColumnInfo"/>s within a <see cref="RowOrColumnsModel"/> to the end of this <see cref="RowOrColumnsModel"/>.
/// </summary>
/// <param name="model"><see cref="RowOrColumnsModel"/> to be appended</param>
internal void AppendModel(RowOrColumnsModel model)
{
if (this.first == null)
{
// Model currently not populated, so set
this.first = model.First;
this.last = model.Last;
}
else
{
// Chain to the end
RowOrColumnInfo nextFirstInfo = model.First;
this.last.Next = nextFirstInfo;
if (nextFirstInfo != null)
{
this.last = model.Last;
}
}
}
/// <summary>
/// Builds a model of the rows within this entity.
/// </summary>
internal override RowOrColumnsModel BuildRowsModel()
{
var rowsModel = new RowOrColumnsModel(true);
// Consider all elements in the container on a column-by-column basis.
for (uint colIdx = 1; colIdx <= this.mapColumnCount; colIdx++)
{
// Create a RowsModel for the column
var columnRowsModel = new RowOrColumnsModel(true);
for (uint rowIdx = 1; rowIdx <= this.mapRowCount; rowIdx++)
{
// Use System.Drawing.Point as key as it has a very efficient hashing algorithm
var cellListKey = new System.Drawing.Point((int)colIdx, (int)rowIdx);
if (this.cells.ContainsKey(cellListKey))
{
ExcelMapCoOrdinate element = this.cells[cellListKey];
RowOrColumnsModel elementRowsModel = element.BuildRowsModel();
columnRowsModel.AppendModel(elementRowsModel);
}
}
// Merge the columns model generated for the row with the model for the container.
rowsModel.MergeModel(columnRowsModel);
// Add this container into the column (if not already there)
RowOrColumnInfo rowInfo = rowsModel.First;
while (rowInfo != null)
{
rowInfo.AddMap(this);
rowInfo = rowInfo.Next;
}
}
return(rowsModel);
}
/// <summary>
/// Merge the supplied <see cref="RowOrColumnsModel"/> into this <see cref="RowOrColumnsModel"/>.
/// </summary>
/// <param name="modelToBeMerged">The <see cref="RowOrColumnsModel" /> to be merged into this <see cref="RowOrColumnsModel"/></param>
internal void MergeModel(RowOrColumnsModel modelToBeMerged)
{
if (this.first == null)
{
// Model currently not populated, so set
this.first = modelToBeMerged.First;
this.last = modelToBeMerged.Last;
}
else
{
// Traverse this linked list.
RowOrColumnInfo sourceRowOrColInfo = modelToBeMerged.First;
RowOrColumnInfo previousTargetRowOrColInfo = null;
RowOrColumnInfo currentTargetRowOrColInfo = this.first;
while (sourceRowOrColInfo != null)
{
if (!sourceRowOrColInfo.Hidden && !currentTargetRowOrColInfo.Hidden)
{
// Allocate the visible source column to the visible target columns
currentTargetRowOrColInfo = AllocateVisibleSourceToVisibleTargets(sourceRowOrColInfo, currentTargetRowOrColInfo);
}
else if (sourceRowOrColInfo.Hidden && !currentTargetRowOrColInfo.Hidden)
{
// Allocate the hidden source column before the current visible target column
RowOrColumnInfo insertedColumn = RowOrColumnInfo.Create(this.isRowModel);
insertedColumn.Hidden = sourceRowOrColInfo.Hidden;
insertedColumn.HeightOrWidth = sourceRowOrColInfo.HeightOrWidth;
insertedColumn.AddMaps(sourceRowOrColInfo);
insertedColumn.AddMaps(currentTargetRowOrColInfo);
insertedColumn.Next = currentTargetRowOrColInfo;
if (previousTargetRowOrColInfo == null)
{
// The new hidden target column is first column in this model
this.first = insertedColumn;
}
else
{
previousTargetRowOrColInfo.Next = insertedColumn;
}
// Move back to newly inserted column, so next current remains unchanged
currentTargetRowOrColInfo = insertedColumn;
}
else if (sourceRowOrColInfo.Hidden && currentTargetRowOrColInfo.Hidden)
{
// Allocate the source to the current target (creating new target row/columns for splits etc).
currentTargetRowOrColInfo = AllocateTargetToSource(previousTargetRowOrColInfo, sourceRowOrColInfo);
}
else if (!sourceRowOrColInfo.Hidden && currentTargetRowOrColInfo.Hidden)
{
currentTargetRowOrColInfo = AllocateVisibleSourceToTargets(sourceRowOrColInfo, currentTargetRowOrColInfo, sourceRowOrColInfo.HeightOrWidth);
}
// Source column allocation complete, move on to next source column.
sourceRowOrColInfo = sourceRowOrColInfo.Next;
// If there is a next source column, and no next target column, then create
// a null width target column with the same visibility as the source to accept the next source.
if (sourceRowOrColInfo != null && currentTargetRowOrColInfo.Next == null)
{
currentTargetRowOrColInfo.Next = RowOrColumnInfo.Create(this.isRowModel);
currentTargetRowOrColInfo.Next.Hidden = sourceRowOrColInfo.Hidden;
// Update the last column if the inserted column is now the last column.
if (currentTargetRowOrColInfo == this.last)
{
this.last = currentTargetRowOrColInfo.Next;
}
}
// Move on to next target column
previousTargetRowOrColInfo = currentTargetRowOrColInfo;
currentTargetRowOrColInfo = currentTargetRowOrColInfo.Next;
}
}
}
/// <summary>
/// Write the content of the <see cref="ExcelMapCoOrdinateContainer"> to the worksheet</see>.
/// </summary>
/// <param name="sheetName">Name of the sheet.</param>
/// <param name="worksheetPart">The worksheet part.</param>
/// <param name="mapCoOrdinateContainer">The map co ordinate container.</param>
/// <param name="stylesManager">The styles manager.</param>
/// <param name="spreadsheetDocument">The spreadsheet document.</param>
public static void WriteMapToExcel(string sheetName,
WorksheetPart worksheetPart,
ExcelMapCoOrdinateContainer mapCoOrdinateContainer,
ExcelStylesManager stylesManager,
SpreadsheetDocument spreadsheetDocument)
{
TempDiagnostics.Output(string.Format("Writing map for ExcelMap[{0}] to worksheet '{1}'", mapCoOrdinateContainer.ContainerType, sheetName));
var dimensionConverter = new ExcelDimensionConverter("Calibri", 11.0f);
// Manages the writing to Excel.
var excelWriteManager = new OpenXmlExcelWriteManager(worksheetPart.Worksheet);
//** First we need to clear the destination worksheet down (rows, columns and merged areas)
excelWriteManager.EmptyWorksheet();
// Build up Columns models on all nested containers.
RowOrColumnsModel columnsModel = mapCoOrdinateContainer.BuildColumnsModel();
int colCount = columnsModel.Count();
// ==========================================================
// Traverse each column assigning start and end
// column indexes to the maps associated with that column.
// ==========================================================
RowOrColumnInfo columnInfo = columnsModel.First;
while (columnInfo != null)
{
double?width = columnInfo.HeightOrWidth.HasValue ? (double?)dimensionConverter.WidthToOpenXmlWidth(columnInfo.HeightOrWidth.Value) : null;
excelWriteManager.AddColumn(width, columnInfo.Hidden);
// Assign Excel start and end columns to maps for merge operations.
foreach (ExcelMapCoOrdinate map in columnInfo.Maps)
{
// Extend any cells that are merged across maps.
if (map is ExcelMapCoOrdinatePlaceholder)
{
var cell = map as ExcelMapCoOrdinatePlaceholder;
if (cell.MergeWith != null)
{
cell.ExcelColumnStart = cell.MergeWith.ExcelColumnStart;
cell.MergeWith.ExcelColumnEnd = columnInfo.ExcelIndex; //excelCol
}
}
if (map.ExcelColumnStart == 0)
{
map.ExcelColumnStart = columnInfo.ExcelIndex; //excelCol;
map.ExcelColumnEnd = columnInfo.ExcelIndex; //excelCol;
}
else
{
map.ExcelColumnEnd = columnInfo.ExcelIndex; //excelCol;
}
}
// Move on to next column in list
columnInfo = columnInfo.Next;
}
TempDiagnostics.Output(string.Format("Created ColumnsModel which contains '{0}' columns", colCount));
// Build up Rows models on all nested containers.
RowOrColumnsModel rowsModel = mapCoOrdinateContainer.BuildRowsModel();
int rowCount = rowsModel.Count();
// ==========================================================
// Traverse each row assigning start and end
// row indexes to the maps associated with that row.
// ==========================================================
RowOrColumnInfo rowInfo = rowsModel.First;
while (rowInfo != null)
{
double?height = rowInfo.HeightOrWidth.HasValue ? (double?)dimensionConverter.HeightToOpenXmlHeight(rowInfo.HeightOrWidth.Value) : null;
excelWriteManager.AddRow(height, rowInfo.Hidden);
// Assign Excel start and end rows to maps for merge operations.
foreach (ExcelMapCoOrdinate map in rowInfo.Maps)
{
if (map.ExcelRowStart == 0)
{
map.ExcelRowStart = rowInfo.ExcelIndex; //excelRow;
map.ExcelRowEnd = rowInfo.ExcelIndex; //excelRow;
}
else
{
map.ExcelRowEnd = rowInfo.ExcelIndex; //excelRow;
}
}
// Move on to next Row in list
rowInfo = rowInfo.Next;
}
TempDiagnostics.Output(string.Format("Created RowsModel which contains '{0}' rows", rowCount));
// Build a layered cells dictionary for all cells, keyed by Excel row and column index
var layeredCellsDictionary = new LayeredCellsDictionary();
mapCoOrdinateContainer.UpdateLayeredCells(ref layeredCellsDictionary);
TempDiagnostics.Output(string.Format("Updated Layered Cell Information for worksheet '{0}' = {1}", sheetName, layeredCellsDictionary.Count));
// Probe the Row, Column and Cell Layered maps, embellishing them with row, column and cell formatting information.
for (uint worksheetRow = 1; worksheetRow <= rowCount; worksheetRow++)
{
for (uint worksheetCol = 1; worksheetCol <= colCount; worksheetCol++)
{
// We can now use the layeredCellsDictionary to build the
// excel workbook based on layered cell information
var currentCoOrdinate = new System.Drawing.Point((int)worksheetCol, (int)worksheetRow);
LayeredCellInfo layeredCellInfo = layeredCellsDictionary[currentCoOrdinate];
// Work through the layered maps to determine what needs to be written to the Excel worksheet at that Row/Column
ProcessLayeredCellMaps(currentCoOrdinate, layeredCellInfo);
}
}
TempDiagnostics.Output(string.Format("Built Worksheet CellInfos[Cols={0},Rows={1}]", colCount, rowCount));
//** Write the 2D array of cell information to the Excel Worksheet
//** building a list of areas that are to be merged.
for (uint worksheetRow = 1; worksheetRow <= rowCount; worksheetRow++)
{
OpenXmlSpreadsheet.Row row = excelWriteManager.GetRow(worksheetRow);
for (uint worksheetCol = 1; worksheetCol <= colCount; worksheetCol++)
{
// Pluck out information relating to the current cell
var currentCoOrdinate = new System.Drawing.Point((int)worksheetCol, (int)worksheetRow);
ExcelCellInfo cellInfo = layeredCellsDictionary[currentCoOrdinate].CellInfo;
// Not sure if we need this as column letters are easily (quickly) translated using existing OpenXml helpers
string columnLetter = excelWriteManager.GetColumnLetter(worksheetCol);
// All merge cells should have the same style as the source merge cell.
if (cellInfo.MergeFrom != null)
{
// If MergeFrom is non-null, then this cell has been already been marked as a merge cell,
// whose style is to be the same as the source 'MergeFrom cell.
// Update the source (MergeFrom) cell so it ends up containing a reference to the last (MergeTo) cell to be merged.
cellInfo.MergeFrom.MergeTo = cellInfo;
// Create/lookup styles in the target workbook and return index of created style
uint cellStyleIndex = stylesManager.GetOrCreateStyle(cellInfo.MergeFrom.StyleInfo);
// Write in to Excel (style information only)
var cell = new OpenXmlSpreadsheet.Cell();
cell.SetCellReference(columnLetter, worksheetRow);
cell.StyleIndex = cellStyleIndex;
row.Append(cell);
cellInfo.Cell = cell;
}
else
{
// Create/lookup styles in the target workbook and return index of created style
uint cellStyleIndex = stylesManager.GetOrCreateStyle(cellInfo.StyleInfo);
// NB! If we write a Null value then we lose cell formatting information for some reason
object value = cellInfo.Value == null ? string.Empty : cellInfo.Value;
// Write in to Excel
var cell = new OpenXmlSpreadsheet.Cell();
cell.SetCellReference(columnLetter, worksheetRow);
excelWriteManager.SetCellValue(cell, value);
cell.StyleIndex = cellStyleIndex;
row.Append(cell);
cellInfo.Cell = cell;
}
// Span the cell accross it's parent columns if specified
if (cellInfo.LastSpanRow == 0)
{
cellInfo.LastSpanRow = worksheetRow;
}
if (cellInfo.LastSpanColumn == 0)
{
cellInfo.LastSpanColumn = worksheetCol;
}
// Merge cells if required (spanning)
for (uint rowIdx = worksheetRow; rowIdx <= cellInfo.LastSpanRow; rowIdx++)
{
for (uint colIdx = worksheetCol; colIdx <= cellInfo.LastSpanColumn; colIdx++)
{
// Mark processed (so we don't over-write)
var coOrdinate = new System.Drawing.Point((int)colIdx, (int)rowIdx);
if (coOrdinate != currentCoOrdinate)
{
var mergeCoOrdinate = new System.Drawing.Point((int)colIdx, (int)rowIdx);
ExcelCellInfo mergeCellInfo = layeredCellsDictionary[mergeCoOrdinate].CellInfo;
if (mergeCellInfo.MergeFrom == null)
{
mergeCellInfo.MergeFrom = cellInfo;
}
}
}
}
}
}
//#if DEBUG
// if (!skipMerge)
// {
//#endif
// Merge cells that have been marked to merge in the cellInfos dictionary.
MergeCells(worksheetPart.Worksheet, (uint)rowCount, (uint)colCount, layeredCellsDictionary);
//#if DEBUG
// }
//#endif
TempDiagnostics.Output(string.Format("Written CellInfos[Cols={0},Rows={1}] to Excel", colCount, rowCount));
// Create a list of all of the the defined names in the container.
var definedNameList = new List <ExcelDefinedNameInfo>();
mapCoOrdinateContainer.UpdateDefinedNameList(ref definedNameList, sheetName);
// And write into Excel workbook
foreach (var definedNameInfo in definedNameList)
{
uint rangeColumnCount = definedNameInfo.EndColumnIndex - definedNameInfo.StartColumnIndex + 1;
uint rangeRowCount = definedNameInfo.EndRowIndex - definedNameInfo.StartRowIndex + 1;
if (rangeRowCount > 0 && rangeColumnCount > 0)
{
spreadsheetDocument.WorkbookPart.Workbook.AddDefinedName(sheetName,
definedNameInfo.DefinedName,
(uint)definedNameInfo.StartColumnIndex,
(uint)definedNameInfo.StartRowIndex,
(int)rangeColumnCount,
(int)rangeRowCount);
}
}
TempDiagnostics.Output(string.Format("Defined Names added - write map for {0} complete...", mapCoOrdinateContainer.ContainerType));
}
