Class SpreadExportRenderer

Implements ISpreadExportRenderer.AddHyperlink(string)

AddWorksheet(string)

Create and add excel worksheet to the workbook.

Declaration

cs-api-definition

public virtual void AddWorksheet(string sheetName)

Parameters

sheetName

Excel workbook.

Implements ISpreadExportRenderer.AddWorksheet(string)

CallWorkbookCreated()

Calls event.

Declaration

cs-api-definition

public virtual void CallWorkbookCreated()

Implements ISpreadExportRenderer.CallWorkbookCreated()

ClearCellSelectionValue()

Clears the value of current CellSelection.

Declaration

cs-api-definition

public virtual void ClearCellSelectionValue()

Implements ISpreadExportRenderer.ClearCellSelectionValue()

CreateCellSelection(int, int)

Creates CellSelection.

Declaration

cs-api-definition

public virtual void CreateCellSelection(int rowIndex, int columnIndex)

Parameters

rowIndex

Row index.

columnIndex

Column index.

Implements ISpreadExportRenderer.CreateCellSelection(int, int)

CreateCellSelection(int, int, int, int)

Creates CellSelection.

Declaration

cs-api-definition

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

Parameters

fromRowIndex

From row index.

fromColumnIndex

From column index.

toRowIndex

To row index.

toColumnIndex

To column index.

Implements ISpreadExportRenderer.CreateCellSelection(int, int, int, int)

CreateCellStyleInfo()

Creates CellStyleInfo using current CellSelection and Worksheet.

Declaration

cs-api-definition

public virtual void CreateCellStyleInfo()

Implements ISpreadExportRenderer.CreateCellStyleInfo()

CreateCellStyleInfo(Color, Color, FontFamily, double, bool, bool, bool, ContentAlignment, bool, BorderBoxStyle, Color, Color, Color, Color, Color, Orientation)

Creates CellStyleInfo.

Declaration

cs-api-definition

public virtual void CreateCellStyleInfo(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, Orientation textOrientation = Orientation.Horizontal)

Parameters

backColor

BackColor of cell.

foreColor

ForeColor of cell.

fontFamily

FontFamily

FontFamily of cell.

fontSize

double

Font size of cell.

isBold

Is text bold.

isItalic

Is text italic.

underline

Is text underlined.

textAlignment

ContentAlignment

Text alignment.

textWrap

Is text wrapped.

borderBoxStyle

BorderBoxStyle

Border box style.

borderColor

Color of border.

borderTopColor

Color of top border.

borderBottomColor

Color of bottom border.

borderRightColor

Color of right border.

borderLeftColor

Implements ISpreadExportRenderer.CreateCellStyleInfo(Color, Color, FontFamily, double, bool, bool, bool, ContentAlignment, bool, BorderBoxStyle, Color, Color, Color, Color, Color, Orientation)

Color of left border.

textOrientation

Orientation

The text orientation/

CreateFloatingImage(int, int, int, int, byte[], string, int, int, int)

Creates a new floating image in current worksheet.

Declaration

cs-api-definition

public virtual void CreateFloatingImage(int rowIndex, int columnIndex, int offsetX, int offsetY, byte[] bytes, string extension, int width, int height, int rotationAngle)

Parameters

rowIndex

columnIndex

offsetX

offsetY

bytes

byte[]

extension

width

height

rotationAngle

Implements ISpreadExportRenderer.CreateFloatingImage(int, int, int, int, byte[], string, int, int, int)

CreateFreezePanes(int, int)

Creates freeze panes.

Declaration

cs-api-definition

public virtual void CreateFreezePanes(int rowsCount, int columnsCount)

Parameters

rowsCount

Count of frozen rows.

columnsCount

Count of frozen columns.

Implements ISpreadExportRenderer.CreateFreezePanes(int, int)

CreateWorkbook()

Creates new workbook.

Declaration

cs-api-definition

public virtual void CreateWorkbook()

Implements ISpreadExportRenderer.CreateWorkbook()

Export(Stream)

Exports workbook.

Declaration

cs-api-definition

public virtual void Export(Stream stream)

Parameters

stream

Stream

Associated stream.

Implements ISpreadExportRenderer.Export(Stream)

GetCellSelection()

Gets current CellSelection.

Declaration

cs-api-definition

public virtual object GetCellSelection()

Returns

CellSelection as object.

Implements ISpreadExportRenderer.GetCellSelection()

GetCellSelectionValue()

Gets the value of current CellSelection.

Declaration

cs-api-definition

public virtual object GetCellSelectionValue()

Returns

ISpreadExportCellStyleInfo

Implements ISpreadExportRenderer.GetCellSelectionValue()

GetCellStyleInfo()

Gets current CellStyleInfo.

Declaration

cs-api-definition

public virtual ISpreadExportCellStyleInfo GetCellStyleInfo()

Returns

Implements ISpreadExportRenderer.GetCellStyleInfo()

GetFileExtension(SpreadExportFormat)

Gets file extension.

Declaration

cs-api-definition

public virtual object GetFileExtension(SpreadExportFormat exportFormat)

Parameters

exportFormat

SpreadExportFormat

Export format.

Returns

Implements ISpreadExportRenderer.GetFileExtension(SpreadExportFormat)

GetFormatProvider(SpreadExportFormat)

Gets current format provider.

Declaration

cs-api-definition

public virtual void GetFormatProvider(SpreadExportFormat exportFormat)

Parameters

exportFormat

SpreadExportFormat

Export format.

Implements ISpreadExportRenderer.GetFormatProvider(SpreadExportFormat)

GetIsMerged(int, int)

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

Declaration

cs-api-definition

public virtual bool GetIsMerged(int rowIndex, int columnIndex)

Parameters

rowIndex

The row of cell.

columnIndex

The column of cell.

Returns

A value indicating, whether given cell is part of a merged cell.

Implements ISpreadExportRenderer.GetIsMerged(int, int)

GetWorksheet()

Gets current worksheet.

Declaration

cs-api-definition

public virtual object GetWorksheet()

Returns

Worksheet as object

Implements ISpreadExportRenderer.GetWorksheet()

GetWorksheetColumnWidth(int)

Gets the width of column by given column index.

Declaration

cs-api-definition

public virtual int GetWorksheetColumnWidth(int columnIndex)

Parameters

columnIndex

Column index

Returns

Column width

Implements ISpreadExportRenderer.GetWorksheetColumnWidth(int)

GetWorksheetRowHeight(int)

Gets height of row in worksheet by given row index.

Declaration

cs-api-definition

public virtual double GetWorksheetRowHeight(int rowIndex)

Parameters

rowIndex

Row index.

Returns

double

Implements ISpreadExportRenderer.GetWorksheetRowHeight(int)

GroupRows(int, int, int)

Groups rows in current worksheet.

Declaration

cs-api-definition

public virtual void GroupRows(int startRow, int endRow, int level)

Parameters

startRow

Start row.

endRow

End row.

level

Outline level.

Implements ISpreadExportRenderer.GroupRows(int, int, int)

ImportWorkbook(Stream)

Imports workbook.

Declaration

cs-api-definition

public virtual void ImportWorkbook(Stream stream)

Parameters

stream

Stream

Associated stream.

Implements ISpreadExportRenderer.ImportWorkbook(Stream)

MergeCellSelection()

Merges the cells of current CellSelection.

Declaration

cs-api-definition

public virtual void MergeCellSelection()

Implements ISpreadExportRenderer.MergeCellSelection()

OnWorkbookCreated(WorkbookCreatedEventArgs)

Raises the event.

Declaration

cs-api-definition

protected virtual void OnWorkbookCreated(WorkbookCreatedEventArgs e)

Parameters

WorkbookCreatedEventArgs

The WorkbookCreatedEventArgs instance containing the event data.

RegisterFormatProvider(SpreadExportFormat)

Registers format provider.

Declaration

cs-api-definition

public virtual void RegisterFormatProvider(SpreadExportFormat exportFormat)

Parameters

exportFormat

SpreadExportFormat

Export format.

Implements ISpreadExportRenderer.RegisterFormatProvider(SpreadExportFormat)

ReplaceWorksheet(string)

Removes an existing worksheet from the workbook and creates a new one with the same name. If there is no sheet with this name, only creates a new one.

Declaration

cs-api-definition

public virtual bool ReplaceWorksheet(string sheetName)

Parameters

sheetName

The name of the sheet to be replaced.

Returns

A value indicating whether a sheet with given name was removed.

Implements ISpreadExportRenderer.ReplaceWorksheet(string)

SetCellSelectionFormat(string)

Sets format of current CellSelection.

Declaration

cs-api-definition

public virtual void SetCellSelectionFormat(string formatString)

Parameters

formatString

Format string.

Implements ISpreadExportRenderer.SetCellSelectionFormat(string)

SetCellSelectionValue(DataType, object)

Sets the value of current CellSelection.

Declaration

cs-api-definition

public virtual void SetCellSelectionValue(DataType dataType, object value)

Parameters

dataType

DataType

CellSelection data type.

value

Value.

Implements ISpreadExportRenderer.SetCellSelectionValue(DataType, object)

SetCellSelectionValue(string)

Sets the value of current CellSelection.

Declaration

cs-api-definition

public virtual void SetCellSelectionValue(string text)

Parameters

text

Text.

Implements ISpreadExportRenderer.SetCellSelectionValue(string)

SetWorksheetColumnWidth(int, double, bool)

Sets width of column in worksheet by given column index.

Declaration

cs-api-definition

public virtual void SetWorksheetColumnWidth(int columnIndex, double value, bool isCustom)

Parameters

columnIndex

Column index.

value

double

Width of column.

isCustom

Implements ISpreadExportRenderer.SetWorksheetColumnWidth(int, double, bool)

SetWorksheetRowHeight(int, int, bool)

Sets height of row in worksheet by given row index.

Declaration

cs-api-definition

public virtual void SetWorksheetRowHeight(int rowIndex, int rowHeight, bool isCustom)

Parameters

rowIndex

Row index.

rowHeight

Height of row.

isCustom