Class

SpreadStreamExportRenderer

Declaration

public SpreadStreamExportRenderer()

Gets or sets the index of the column.

Declaration

public int ColumnIndex { get; set; }

Property Value

Implements ISpreadStreamExportRenderer.ColumnIndex

Gets or sets the index of the row.

Declaration

public int RowIndex { get; set; }

Property Value

Implements ISpreadStreamExportRenderer.RowIndex

Create and add excel worksheet to the workbook.

Declaration

public virtual void AddWorksheet(string sheetName)

Parameters

Implements ISpreadStreamExportRenderer.AddWorksheet(string)

Applies the cell format. Note that format needs to be of SpreadCellFormat type in order to be applied to current cell.

Declaration

public virtual void ApplyCellFormat(object format)

Parameters

Implements ISpreadStreamExportRenderer.ApplyCellFormat(object)

Applies the cell style.

Declaration

public virtual void ApplyCellStyle(ISpreadStreamExportCellStyleInfo cellStyle, string formatString)

Parameters

Implements ISpreadStreamExportRenderer.ApplyCellStyle(ISpreadStreamExportCellStyleInfo, string)

Calls the WorksheetCreated event.

Declaration

public virtual bool CallOnWorksheetCreated()

Returns

Implements ISpreadStreamExportRenderer.CallOnWorksheetCreated()

Clears the value of current Cell.

Declaration

public virtual void ClearCellValue()

Implements ISpreadStreamExportRenderer.ClearCellValue()

Creates the border cell style.

Declaration

public virtual void CreateBorderCellStyle(ISpreadStreamExportCellStyleInfo cellStyle)

Parameters

Implements ISpreadStreamExportRenderer.CreateBorderCellStyle(ISpreadStreamExportCellStyleInfo)

Creates CellSelection.

Declaration

public virtual void CreateCell()

Implements ISpreadStreamExportRenderer.CreateCell()

Creates a SpreadStreamCellStyleInfo by given visual styles.

Declaration

public virtual void CreateCellStyle(Color backColor, Color foreColor, FontFamily fontFamily, double fontSize, bool isBold, bool isItalic, bool underline, ContentAlignment textAlignment, bool textWrap, BorderBoxStyle borderBoxStyle, Color borderColor, Color borderTopColor, Color borderBottomColor, Color borderRightColor, Color borderLeftColor)

Parameters

Implements ISpreadStreamExportRenderer.CreateCellStyle(Color, Color, FontFamily, double, bool, bool, bool, ContentAlignment, bool, BorderBoxStyle, Color, Color, Color, Color, Color)

Creates the cell style from light style.

Declaration

public virtual ISpreadStreamExportCellStyleInfo CreateCellStyleFromLightStyle(ISpreadStreamExportCellStyleInfo cellStyle)

Parameters

Returns

Implements ISpreadStreamExportRenderer.CreateCellStyleFromLightStyle(ISpreadStreamExportCellStyleInfo)

Creates SpreadStreamCellStyleInfo from theme normal style.

Declaration

public virtual void CreateCellStyleFromTheme()

Implements ISpreadStreamExportRenderer.CreateCellStyleFromTheme()

Creates the column.

Declaration

public virtual void CreateColumn()

Implements ISpreadStreamExportRenderer.CreateColumn()

Creates freeze panes.

Declaration

public virtual void CreateFreezePanes(int rowsCount, int columnsCount)

Parameters

Implements ISpreadStreamExportRenderer.CreateFreezePanes(int, int)

Creates a SpreadStreamLightCellStyleInfo by given visual styles.

Declaration

public virtual void CreateLightCellStyle(Color backColor, Color foreColor, FontFamily fontFamily, double fontSize, bool isBold, bool isItalic, bool underline, ContentAlignment textAlignment, bool textWrap, BorderBoxStyle borderBoxStyle, Color borderColor, Color borderTopColor, Color borderBottomColor, Color borderRightColor, Color borderLeftColor)

Parameters

Implements ISpreadStreamExportRenderer.CreateLightCellStyle(Color, Color, FontFamily, double, bool, bool, bool, ContentAlignment, bool, BorderBoxStyle, Color, Color, Color, Color, Color)

Creates CellSelection.

Declaration

public virtual void CreateMergedCells(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)

Parameters

Implements ISpreadStreamExportRenderer.CreateMergedCells(int, int, int, int)

Creates the row.

Declaration

public virtual void CreateRow()

Implements ISpreadStreamExportRenderer.CreateRow()

Creates new workbook.

Declaration

public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)

Parameters

Implements ISpreadStreamExportRenderer.CreateWorkbook(Stream, SpreadStreamExportFormat)

Creates new workbook.

Declaration

public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat, FileExportMode fileExportMode)

Parameters

Implements ISpreadStreamExportRenderer.CreateWorkbook(Stream, SpreadStreamExportFormat, FileExportMode)

Finishes the cell.

Declaration

public virtual void FinishCell()

Implements ISpreadStreamExportRenderer.FinishCell()

Finishes the column.

Declaration

protected virtual void FinishColumn()

Exports workbook.

Declaration

public virtual void FinishExport()

Implements ISpreadStreamExportRenderer.FinishExport()

Finishes the row.

Declaration

protected virtual void FinishRow()

Finishes the workbook.

Declaration

protected virtual void FinishWorkbook()

Finishes the worksheet.

Declaration

protected virtual void FinishWorksheet()

Gets the borders from existing style.

Declaration

public virtual ISpreadStreamExportCellStyleInfo GetBordersFromExistingStyle(ISpreadStreamExportCellStyleInfo cellStyle)

Parameters

Returns

Implements ISpreadStreamExportRenderer.GetBordersFromExistingStyle(ISpreadStreamExportCellStyleInfo)

Gets current Cell.

Declaration

public virtual object GetCell()

Returns

Implements ISpreadStreamExportRenderer.GetCell()

Gets current SpreadCellFormat.

Declaration

public virtual object GetCellFormat(bool createNew)

Parameters

Returns

Implements ISpreadStreamExportRenderer.GetCellFormat(bool)

Gets the cell style info.

Declaration

public virtual ISpreadStreamExportCellStyleInfo GetCellStyleInfo()

Returns

Implements ISpreadStreamExportRenderer.GetCellStyleInfo()

Gets the column.

Declaration

public virtual object GetColumn()

Returns

Implements ISpreadStreamExportRenderer.GetColumn()

Gets file extension.

Declaration

public virtual string GetFileExtension(SpreadStreamExportFormat exportFormat)

Parameters

Returns

Implements ISpreadStreamExportRenderer.GetFileExtension(SpreadStreamExportFormat)

Determines if a cell(by given row and column index) belongs to a merged cell.

Declaration

public virtual bool GetIsMerged(int rowIndex, int columnIndex)

Parameters

Returns

Implements ISpreadStreamExportRenderer.GetIsMerged(int, int)

Gets current Row.

Declaration

public virtual object GetRow(bool finishCell)

Parameters

Returns

Implements ISpreadStreamExportRenderer.GetRow(bool)

Gets current worksheet.

Declaration

public virtual object GetWorksheet()

Returns

Implements ISpreadStreamExportRenderer.GetWorksheet()

Groups current row in current worksheet.

Declaration

public virtual void GroupCurrentRow(int level)

Parameters

Implements ISpreadStreamExportRenderer.GroupCurrentRow(int)

Raises the event.

Declaration

protected virtual void OnWorkbookCreated(SpreadStreamWorkbookEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual bool OnWorksheetCreated(SpreadStreamWorksheetEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnWorksheetExporting(SpreadStreamWorksheetEventArgs e)

Parameters

Sets the value as boolean.

Declaration

protected virtual bool SetBooleanValue(object value)

Parameters

Returns

Sets the cell format.

Declaration

public virtual void SetCellFormat(string formatString, bool apply)

Parameters

Implements ISpreadStreamExportRenderer.SetCellFormat(string, bool)

Sets the value of current CellSelection.

Declaration

public virtual void SetCellValue(DataType dataType, object value)

Parameters

Implements ISpreadStreamExportRenderer.SetCellValue(DataType, object)

Sets the value of current CellSelection.

Declaration

public virtual void SetCellValue(string text)

Parameters

Implements ISpreadStreamExportRenderer.SetCellValue(string)

Sets the width of current worksheet column.

Declaration

public virtual void SetColumnWidth(double width, bool inPixels)

Parameters

Implements ISpreadStreamExportRenderer.SetColumnWidth(double, bool)

Sets the value as date time.

Declaration

protected virtual bool SetDateTimeValue(object value)

Parameters

Returns

Sets current worksheet column as hidden.

Declaration

public virtual void SetHiddenColumn()

Implements ISpreadStreamExportRenderer.SetHiddenColumn()

Sets current worksheet row as hidden.

Declaration

public virtual void SetHiddenRow()

Implements ISpreadStreamExportRenderer.SetHiddenRow()

Sets the value as number.

Declaration

protected virtual bool SetNumberValue(object value)

Parameters

Returns

Sets height of current row in worksheet.

Declaration

public virtual void SetRowHeight(double height, bool inPixels)

Parameters

Implements ISpreadStreamExportRenderer.SetRowHeight(double, bool)

Sets the value as string.

Declaration

protected virtual bool SetStringValue(object value)

Parameters

Returns

Skips the cells.

Declaration

public virtual void SkipCells(int count)

Parameters

Implements ISpreadStreamExportRenderer.SkipCells(int)

Skips the columns.

Declaration

public virtual void SkipColumns(int count)

Parameters

Implements ISpreadStreamExportRenderer.SkipColumns(int)

Occurs when the workbook is created. This is suitable place to add and/or modify cell styles.

Declaration

public event SpreadStreamWorkbookEventHandler WorkbookCreated

Event Value

Occurs when a new worksheet is created. This is suitable place to set width of columns, add indent/header rows.

Declaration

public event SpreadStreamWorksheetEventHandler WorksheetCreated

Event Value

Occurs when a worksheet is about to be exported. This is suitable place to add footer rows.

Declaration

public event SpreadStreamWorksheetEventHandler WorksheetExporting

Event Value