Back to all docs
API Reference / Telerik.WinControls.Export / SpreadExportRenderer
New to Telerik UI for WinForms? Start a free 30-day trial

SpreadExportRenderer

Class

Represents a class which exposes all methods needed to export using RadSpreadProcessing.

Definition

Namespace:Telerik.WinControls.Export

Assembly:TelerikExport.dll

Syntax:
C#
public class SpreadExportRenderer : ISpreadExportRenderer

Inheritance: objectSpreadExportRenderer

Implements: ISpreadExportRenderer

Constructors

SpreadExportRenderer()

C#
public SpreadExportRenderer()

Methods

AddHyperlink(string)

C#
public virtual void AddHyperlink(string link)
Parameters:linkstring

Implements: ISpreadExportRenderer.AddHyperlink(string)

AddWorksheet(string)

Create and add excel worksheet to the workbook.

C#
public virtual void AddWorksheet(string sheetName)
Parameters:sheetNamestring

Excel workbook.

Implements: ISpreadExportRenderer.AddWorksheet(string)

CallWorkbookCreated()

Calls event.

C#
public virtual void CallWorkbookCreated()

Implements: ISpreadExportRenderer.CallWorkbookCreated()

ClearCellSelectionValue()

Clears the value of current CellSelection.

C#
public virtual void ClearCellSelectionValue()

Implements: ISpreadExportRenderer.ClearCellSelectionValue()

CreateCellSelection(int, int, int, int)

Creates CellSelection.

C#
public virtual void CreateCellSelection(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)
Parameters:fromRowIndexint

From row index.

fromColumnIndexint

From column index.

toRowIndexint

To row index.

toColumnIndexint

To column index.

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

CreateCellSelection(int, int)

Creates CellSelection.

C#
public virtual void CreateCellSelection(int rowIndex, int columnIndex)
Parameters:rowIndexint

Row index.

columnIndexint

Column index.

Implements: ISpreadExportRenderer.CreateCellSelection(int, int)

CreateCellStyleInfo()

Creates CellStyleInfo using current CellSelection and Worksheet.

C#
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.

C#
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:backColorColor

BackColor of cell.

foreColorColor

ForeColor of cell.

fontFamilyFontFamily

FontFamily of cell.

fontSizedouble

Font size of cell.

isBoldbool

Is text bold.

isItalicbool

Is text italic.

underlinebool

Is text underlined.

textAlignmentContentAlignment

Text alignment.

textWrapbool

Is text wrapped.

borderBoxStyleBorderBoxStyle

Border box style.

borderColorColor

Color of border.

borderTopColorColor

Color of top border.

borderBottomColorColor

Color of bottom border.

borderRightColorColor

Color of right border.

borderLeftColorColor

Color of left border.

textOrientationOrientation

The text orientation/

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

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

Creates a new floating image in current worksheet.

C#
public virtual void CreateFloatingImage(int rowIndex, int columnIndex, int offsetX, int offsetY, byte[] bytes, string extension, int width, int height, int rotationAngle)
Parameters:rowIndexintcolumnIndexintoffsetXintoffsetYintbytesbyte[]extensionstringwidthintheightintrotationAngleint

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

CreateFreezePanes(int, int)

Creates freeze panes.

C#
public virtual void CreateFreezePanes(int rowsCount, int columnsCount)
Parameters:rowsCountint

Count of frozen rows.

columnsCountint

Count of frozen columns.

Implements: ISpreadExportRenderer.CreateFreezePanes(int, int)

CreateWorkbook()

Creates new workbook.

C#
public virtual void CreateWorkbook()

Implements: ISpreadExportRenderer.CreateWorkbook()

Export(Stream)

Exports workbook.

C#
public virtual void Export(Stream stream)
Parameters:streamStream

Associated stream.

Implements: ISpreadExportRenderer.Export(Stream)

GetCellSelection()

Gets current CellSelection.

C#
public virtual object GetCellSelection()
Returns:

object

CellSelection as object.

Implements: ISpreadExportRenderer.GetCellSelection()

GetCellSelectionValue()

Gets the value of current CellSelection.

C#
public virtual object GetCellSelectionValue()
Returns:

object

Implements: ISpreadExportRenderer.GetCellSelectionValue()

GetCellStyleInfo()

Gets current CellStyleInfo.

C#
public virtual ISpreadExportCellStyleInfo GetCellStyleInfo()
Returns:

ISpreadExportCellStyleInfo

Implements: ISpreadExportRenderer.GetCellStyleInfo()

GetFileExtension(SpreadExportFormat)

Gets file extension.

C#
public virtual object GetFileExtension(SpreadExportFormat exportFormat)
Parameters:exportFormatSpreadExportFormat

Export format.

Returns:

object

Implements: ISpreadExportRenderer.GetFileExtension(SpreadExportFormat)

GetFormatProvider(SpreadExportFormat)

Gets current format provider.

C#
public virtual void GetFormatProvider(SpreadExportFormat exportFormat)
Parameters:exportFormatSpreadExportFormat

Export format.

Implements: ISpreadExportRenderer.GetFormatProvider(SpreadExportFormat)

GetIsMerged(int, int)

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

C#
public virtual bool GetIsMerged(int rowIndex, int columnIndex)
Parameters:rowIndexint

The row of cell.

columnIndexint

The column of cell.

Returns:

bool

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

Implements: ISpreadExportRenderer.GetIsMerged(int, int)

GetWorksheet()

Gets current worksheet.

C#
public virtual object GetWorksheet()
Returns:

object

Worksheet as object

Implements: ISpreadExportRenderer.GetWorksheet()

GetWorksheetColumnWidth(int)

Gets the width of column by given column index.

C#
public virtual int GetWorksheetColumnWidth(int columnIndex)
Parameters:columnIndexint

Column index

Returns:

int

Column width

Implements: ISpreadExportRenderer.GetWorksheetColumnWidth(int)

GetWorksheetRowHeight(int)

Gets height of row in worksheet by given row index.

C#
public virtual double GetWorksheetRowHeight(int rowIndex)
Parameters:rowIndexint

Row index.

Returns:

double

Implements: ISpreadExportRenderer.GetWorksheetRowHeight(int)

GroupRows(int, int, int)

Groups rows in current worksheet.

C#
public virtual void GroupRows(int startRow, int endRow, int level)
Parameters:startRowint

Start row.

endRowint

End row.

levelint

Outline level.

Implements: ISpreadExportRenderer.GroupRows(int, int, int)

ImportWorkbook(Stream)

Imports workbook.

C#
public virtual void ImportWorkbook(Stream stream)
Parameters:streamStream

Associated stream.

Implements: ISpreadExportRenderer.ImportWorkbook(Stream)

MergeCellSelection()

Merges the cells of current CellSelection.

C#
public virtual void MergeCellSelection()

Implements: ISpreadExportRenderer.MergeCellSelection()

OnWorkbookCreated(WorkbookCreatedEventArgs)

Raises the event.

C#
protected virtual void OnWorkbookCreated(WorkbookCreatedEventArgs e)
Parameters:eWorkbookCreatedEventArgs

The WorkbookCreatedEventArgs instance containing the event data.

RegisterFormatProvider(SpreadExportFormat)

Registers format provider.

C#
public virtual void RegisterFormatProvider(SpreadExportFormat exportFormat)
Parameters:exportFormatSpreadExportFormat

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.

C#
public virtual bool ReplaceWorksheet(string sheetName)
Parameters:sheetNamestring

The name of the sheet to be replaced.

Returns:

bool

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

Implements: ISpreadExportRenderer.ReplaceWorksheet(string)

SetCellSelectionFormat(string)

Sets format of current CellSelection.

C#
public virtual void SetCellSelectionFormat(string formatString)
Parameters:formatStringstring

Format string.

Implements: ISpreadExportRenderer.SetCellSelectionFormat(string)

SetCellSelectionValue(DataType, object)

Sets the value of current CellSelection.

C#
public virtual void SetCellSelectionValue(DataType dataType, object value)
Parameters:dataTypeDataType

CellSelection data type.

valueobject

Value.

Implements: ISpreadExportRenderer.SetCellSelectionValue(DataType, object)

SetCellSelectionValue(string)

Sets the value of current CellSelection.

C#
public virtual void SetCellSelectionValue(string text)
Parameters:textstring

Text.

Implements: ISpreadExportRenderer.SetCellSelectionValue(string)

SetWorksheetColumnWidth(int, double, bool)

Sets width of column in worksheet by given column index.

C#
public virtual void SetWorksheetColumnWidth(int columnIndex, double value, bool isCustom)
Parameters:columnIndexint

Column index.

valuedouble

Width of column.

isCustombool

Implements: ISpreadExportRenderer.SetWorksheetColumnWidth(int, double, bool)

SetWorksheetRowHeight(int, int, bool)

Sets height of row in worksheet by given row index.

C#
public virtual void SetWorksheetRowHeight(int rowIndex, int rowHeight, bool isCustom)
Parameters:rowIndexint

Row index.

rowHeightint

Height of row.

isCustombool

Implements: ISpreadExportRenderer.SetWorksheetRowHeight(int, int, bool)

Events

WorkbookCreated

Occurs when the workbook is created and is ready to be exported. Suitable for any final touches.

C#
public event WorkbookCreatedEventHandler WorkbookCreated
In this article
DefinitionConstructorsSpreadExportRenderer()MethodsAddHyperlink(string)AddWorksheet(string)CallWorkbookCreated()ClearCellSelectionValue()CreateCellSelection(int, int, int, int)CreateCellSelection(int, int)CreateCellStyleInfo()CreateCellStyleInfo(Color, Color, FontFamily, double, bool, bool, bool, ContentAlignment, bool, BorderBoxStyle, Color, Color, Color, Color, Color, Orientation)CreateFloatingImage(int, int, int, int, byte[], string, int, int, int)CreateFreezePanes(int, int)CreateWorkbook()Export(Stream)GetCellSelection()GetCellSelectionValue()GetCellStyleInfo()GetFileExtension(SpreadExportFormat)GetFormatProvider(SpreadExportFormat)GetIsMerged(int, int)GetWorksheet()GetWorksheetColumnWidth(int)GetWorksheetRowHeight(int)GroupRows(int, int, int)ImportWorkbook(Stream)MergeCellSelection()OnWorkbookCreated(WorkbookCreatedEventArgs)RegisterFormatProvider(SpreadExportFormat)ReplaceWorksheet(string)SetCellSelectionFormat(string)SetCellSelectionValue(DataType, object)SetCellSelectionValue(string)SetWorksheetColumnWidth(int, double, bool)SetWorksheetRowHeight(int, int, bool)EventsWorkbookCreated
Not finding the help you need?
Contact Support