Documentation

Class SpreadExportRenderer

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

Inheritance
System.Object
SpreadExportRenderer
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.Export
Assembly: TelerikExport.dll

Syntax

public class SpreadExportRenderer : ISpreadExportRenderer

Constructors

SpreadExportRenderer()

Declaration
public SpreadExportRenderer()

Methods

AddHyperlink(String)

Declaration
public virtual void AddHyperlink(string link)
Parameters
System.String link

Implements

AddWorksheet(String)

Create and add excel worksheet to the workbook.

Declaration
public virtual void AddWorksheet(string sheetName)
Parameters
System.String sheetName

Excel workbook.
Implements

CallWorkbookCreated()

Calls WorkbookCreated event.

Declaration
public virtual void CallWorkbookCreated()
Implements

ClearCellSelectionValue()

Clears the value of current CellSelection.

Declaration
public virtual void ClearCellSelectionValue()
Implements

CreateCellSelection(Int32, Int32)

Creates CellSelection.

Declaration
public virtual void CreateCellSelection(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Row index.
System.Int32 columnIndex

Column index.
Implements

CreateCellSelection(Int32, Int32, Int32, Int32)

Creates CellSelection.

Declaration
public virtual void CreateCellSelection(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)
Parameters
System.Int32 fromRowIndex

From row index.
System.Int32 fromColumnIndex

From column index.
System.Int32 toRowIndex

To row index.
System.Int32 toColumnIndex

To column index.
Implements

CreateCellStyleInfo()

Creates CellStyleInfo using current CellSelection and Worksheet.

Declaration
public virtual void CreateCellStyleInfo()
Implements

CreateCellStyleInfo(Color, Color, FontFamily, Double, Boolean, Boolean, Boolean, ContentAlignment, Boolean, BorderBoxStyle, Color, Color, Color, Color, Color, Orientation)

Creates CellStyleInfo.

Declaration
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)
Parameters
System.Drawing.Color backColor

BackColor of cell.
System.Drawing.Color foreColor

ForeColor of cell.
System.Drawing.FontFamily fontFamily

FontFamily of cell.
System.Double fontSize

Font size of cell.
System.Boolean isBold

Is text bold.
System.Boolean isItalic

Is text italic.
System.Boolean underline

Is text underlined.
System.Drawing.ContentAlignment textAlignment

Text alignment.
System.Boolean textWrap

Is text wrapped.
BorderBoxStyle borderBoxStyle

Border box style.
System.Drawing.Color borderColor

Color of border.
System.Drawing.Color borderTopColor

Color of top border.
System.Drawing.Color borderBottomColor

Color of bottom border.
System.Drawing.Color borderRightColor

Color of right border.
System.Drawing.Color borderLeftColor

Color of left border.
System.Windows.Forms.Orientation textOrientation

The text orientation/
Implements

CreateFloatingImage(Int32, Int32, Int32, Int32, Byte[], String, Int32, Int32, Int32)

Creates a new floating image in current worksheet.

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

System.Int32 columnIndex

System.Int32 offsetX

System.Int32 offsetY

System.Byte[] bytes

System.String extension

System.Int32 width

System.Int32 height

System.Int32 rotationAngle

Implements

CreateFreezePanes(Int32, Int32)

Creates freeze panes.

Declaration
public virtual void CreateFreezePanes(int rowsCount, int columnsCount)
Parameters
System.Int32 rowsCount

Count of frozen rows.
System.Int32 columnsCount

Count of frozen columns.
Implements

CreateWorkbook()

Creates new workbook.

Declaration
public virtual void CreateWorkbook()
Implements

Export(Stream)

Exports workbook.

Declaration
public virtual void Export(Stream stream)
Parameters
System.IO.Stream stream

Associated stream.
Implements

GetCellSelection()

Gets current CellSelection.

Declaration
public virtual object GetCellSelection()
Returns
System.Object

CellSelection as object.
Implements

GetCellSelectionValue()

Gets the value of current CellSelection.

Declaration
public virtual object GetCellSelectionValue()
Returns
System.Object

Implements

GetCellStyleInfo()

Gets current CellStyleInfo.

Declaration
public virtual ISpreadExportCellStyleInfo GetCellStyleInfo()
Returns
ISpreadExportCellStyleInfo

Implements

GetFileExtension(SpreadExportFormat)

Gets file extension.

Declaration
public virtual object GetFileExtension(SpreadExportFormat exportFormat)
Parameters
SpreadExportFormat exportFormat

Export format.
Returns
System.Object

Implements

GetFormatProvider(SpreadExportFormat)

Gets current format provider.

Declaration
public virtual void GetFormatProvider(SpreadExportFormat exportFormat)
Parameters
SpreadExportFormat exportFormat

Export format.
Implements

GetIsMerged(Int32, Int32)

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
System.Int32 rowIndex

The row of cell.
System.Int32 columnIndex

The column of cell.
Returns
System.Boolean

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

GetWorksheet()

Gets current worksheet.

Declaration
public virtual object GetWorksheet()
Returns
System.Object

Worksheet as object
Implements

GetWorksheetColumnWidth(Int32)

Gets the width of column by given column index.

Declaration
public virtual int GetWorksheetColumnWidth(int columnIndex)
Parameters
System.Int32 columnIndex

Column index
Returns
System.Int32

Column width
Implements

GetWorksheetRowHeight(Int32)

Gets height of row in worksheet by given row index.

Declaration
public virtual double GetWorksheetRowHeight(int rowIndex)
Parameters
System.Int32 rowIndex

Row index.
Returns
System.Double

Implements

GroupRows(Int32, Int32, Int32)

Groups rows in current worksheet.

Declaration
public virtual void GroupRows(int startRow, int endRow, int level)
Parameters
System.Int32 startRow

Start row.
System.Int32 endRow

End row.
System.Int32 level

Outline level.
Implements

ImportWorkbook(Stream)

Imports workbook.

Declaration
public virtual void ImportWorkbook(Stream stream)
Parameters
System.IO.Stream stream

Associated stream.
Implements

MergeCellSelection()

Merges the cells of current CellSelection.

Declaration
public virtual void MergeCellSelection()
Implements

OnWorkbookCreated(WorkbookCreatedEventArgs)

Raises the WorkbookCreated event.

Declaration
protected virtual void OnWorkbookCreated(WorkbookCreatedEventArgs e)
Parameters
WorkbookCreatedEventArgs e

The WorkbookCreatedEventArgs instance containing the event data.

RegisterFormatProvider(SpreadExportFormat)

Registers format provider.

Declaration
public virtual void RegisterFormatProvider(SpreadExportFormat exportFormat)
Parameters
SpreadExportFormat exportFormat

Export format.
Implements

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
public virtual bool ReplaceWorksheet(string sheetName)
Parameters
System.String sheetName

The name of the sheet to be replaced.
Returns
System.Boolean

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

SetCellSelectionFormat(String)

Sets format of current CellSelection.

Declaration
public virtual void SetCellSelectionFormat(string formatString)
Parameters
System.String formatString

Format string.
Implements

SetCellSelectionValue(String)

Sets the value of current CellSelection.

Declaration
public virtual void SetCellSelectionValue(string text)
Parameters
System.String text

Text.
Implements

SetCellSelectionValue(DataType, Object)

Sets the value of current CellSelection.

Declaration
public virtual void SetCellSelectionValue(DataType dataType, object value)
Parameters
DataType dataType

CellSelection data type.
System.Object value

Value.
Implements

SetWorksheetColumnWidth(Int32, Double, Boolean)

Sets width of column in worksheet by given column index.

Declaration
public virtual void SetWorksheetColumnWidth(int columnIndex, double value, bool isCustom)
Parameters
System.Int32 columnIndex

Column index.
System.Double value

Width of column.
System.Boolean isCustom

Implements

SetWorksheetRowHeight(Int32, Int32, Boolean)

Sets height of row in worksheet by given row index.

Declaration
public virtual void SetWorksheetRowHeight(int rowIndex, int rowHeight, bool isCustom)
Parameters
System.Int32 rowIndex

Row index.
System.Int32 rowHeight

Height of row.
System.Boolean isCustom

Implements

Events

WorkbookCreated

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

Declaration
public event WorkbookCreatedEventHandler WorkbookCreated
Event Type
WorkbookCreatedEventHandler

Explicit Interface Implementations

ISpreadExportRenderer.CreateGridViewExportDataRowInfo(Int32, List<IGridViewSpreadExportCellInfo>, Boolean)

Creates and returns GridViewSpreadExportDataRowInfo.

Declaration
IGridViewSpreadExportRowInfo ISpreadExportRenderer.CreateGridViewExportDataRowInfo(int currentIndent, List<IGridViewSpreadExportCellInfo> cells, bool exportAsHidden)
Parameters
System.Int32 currentIndent

Cells indent.
System.Collections.Generic.List<IGridViewSpreadExportCellInfo> cells

Cells.
System.Boolean exportAsHidden

Export as hidden.
Returns
IGridViewSpreadExportRowInfo

Implements

ISpreadExportRenderer.CreateGridViewExportDataRowInfo(Int32, List<IGridViewSpreadExportCellInfo>, Boolean, Int32)

Creates and returns GridViewSpreadExportDataRowInfo.

Declaration
IGridViewSpreadExportRowInfo ISpreadExportRenderer.CreateGridViewExportDataRowInfo(int currentIndent, List<IGridViewSpreadExportCellInfo> cells, bool exportAsHidden, int hierarchyLevel)
Parameters
System.Int32 currentIndent

Cells indent.
System.Collections.Generic.List<IGridViewSpreadExportCellInfo> cells

Cells.
System.Boolean exportAsHidden

Export as hidden.
System.Int32 hierarchyLevel

Hierarchy level of row.
Returns
IGridViewSpreadExportRowInfo

Implements

ISpreadExportRenderer.CreateGridViewExportGroupRowInfo(Int32, String, Int32, Boolean)

Creates and returns GridViewExportGroupRowInfo.

Declaration
IGridViewSpreadExportRowInfo ISpreadExportRenderer.CreateGridViewExportGroupRowInfo(int currentIndent, string content, int colSpan, bool exportAsHidden)
Parameters
System.Int32 currentIndent

Cells indent.
System.String content

Content string.
System.Int32 colSpan

Column span.
System.Boolean exportAsHidden

Export as hidden.
Returns
IGridViewSpreadExportRowInfo

Implements

ISpreadExportRenderer.CreateGridViewExportGroupRowInfo(Int32, String, Int32, Boolean, Int32)

Creates and returns GridViewExportGroupRowInfo.

Declaration
IGridViewSpreadExportRowInfo ISpreadExportRenderer.CreateGridViewExportGroupRowInfo(int currentIndent, string content, int colSpan, bool exportAsHidden, int hierarchyLevel)
Parameters
System.Int32 currentIndent

Cells indent.
System.String content

Content string.
System.Int32 colSpan

Column span.
System.Boolean exportAsHidden

Export as hidden.
System.Int32 hierarchyLevel

Hierarchy level of row.
Returns
IGridViewSpreadExportRowInfo

Implements

Extension Methods