Documentation

Class SpreadStreamExportRenderer

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

Inheritance
System.Object
SpreadStreamExportRenderer
Namespace: Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport
Assembly: Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport.dll

Syntax

public class SpreadStreamExportRenderer : Object

Constructors

SpreadStreamExportRenderer()

Declaration
public SpreadStreamExportRenderer()

Properties

ColumnIndex

Gets or sets the index of the column.

Declaration
public int ColumnIndex { get; set; }
Property Value
System.Int32

The index of the column.

RowIndex

Gets or sets the index of the row.

Declaration
public int RowIndex { get; set; }
Property Value
System.Int32

The index of the row.

Methods

add_WorkbookCreated(SpreadStreamWorkbookEventHandler)

Declaration
public void add_WorkbookCreated(SpreadStreamWorkbookEventHandler value)
Parameters
SpreadStreamWorkbookEventHandler value

add_WorksheetCreated(SpreadStreamWorksheetEventHandler)

Declaration
public void add_WorksheetCreated(SpreadStreamWorksheetEventHandler value)
Parameters
SpreadStreamWorksheetEventHandler value

add_WorksheetExporting(SpreadStreamWorksheetEventHandler)

Declaration
public void add_WorksheetExporting(SpreadStreamWorksheetEventHandler value)
Parameters
SpreadStreamWorksheetEventHandler value

AddWorksheet(String)

Create and add excel worksheet to the workbook.

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

Excel workbook.

ApplyCellFormat(Object)

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
System.Object format

The format.

ApplyCellStyle(SpreadStreamCellStyle, String)

Applies the cell style.

Declaration
public virtual void ApplyCellStyle(SpreadStreamCellStyle cellStyle, string numberFormat)
Parameters
SpreadStreamCellStyle cellStyle

The cell style.
System.String numberFormat

The format string.

CallOnWorksheetCreated()

Calls the WorksheetCreated event.

Declaration
public virtual bool CallOnWorksheetCreated()
Returns
System.Boolean

ClearCellValue()

Clears the value of current Cell.

Declaration
public virtual void ClearCellValue()

CreateAndAddCellForMerge(Int32, Int32, Int32, Int32)

Creates CellSelection.

Declaration
public virtual void CreateAndAddCellForMerge(int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex)
Parameters
System.Int32 startRowIndex

From row index.
System.Int32 startColumnIndex

From column index.
System.Int32 endRowIndex

To row index.
System.Int32 endColumnIndex

To column index.

CreateCell()

Creates CellSelection.

Declaration
public virtual void CreateCell()

CreateColumn()

Creates the column.

Declaration
public virtual void CreateColumn()

CreateRow()

Creates the row.

Declaration
public virtual void CreateRow()

CreateWorkbook(Stream, SpreadStreamExportFormat)

Creates new workbook.

Declaration
public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)
Parameters
System.IO.Stream stream

The stream.
SpreadStreamExportFormat exportFormat

The export format.

FinishCell()

Finishes the cell.

Declaration
public virtual void FinishCell()

FinishColumn()

Finishes the column.

Declaration
protected virtual void FinishColumn()

FinishExport()

Exports workbook.

Declaration
public virtual void FinishExport()

FinishRow()

Finishes the row.

Declaration
protected virtual void FinishRow()

FinishWorkbook()

Finishes the workbook.

Declaration
protected virtual void FinishWorkbook()

FinishWorksheet()

Finishes the worksheet.

Declaration
protected virtual void FinishWorksheet()

GetCell()

Gets current Cell.

Declaration
public virtual object GetCell()
Returns
System.Object

Cell as object.

GetCellFormat(Boolean)

Gets current SpreadCellFormat.

Declaration
public virtual SpreadCellFormat GetCellFormat(bool createNew)
Parameters
System.Boolean createNew

Returns
Telerik.Documents.SpreadsheetStreaming.SpreadCellFormat

GetCellStyle()

Gets the cell style info.

Declaration
public virtual SpreadStreamCellStyle GetCellStyle()
Returns
SpreadStreamCellStyle

GetColumn()

Gets the column.

Declaration
public virtual object GetColumn()
Returns
System.Object

GetFileExtension(SpreadStreamExportFormat)

Gets file extension.

Declaration
public virtual string GetFileExtension(SpreadStreamExportFormat exportFormat)
Parameters
SpreadStreamExportFormat exportFormat

Export format.
Returns
System.String

GetRow(Boolean)

Gets current Row.

Declaration
public virtual object GetRow(bool finishCell)
Parameters
System.Boolean finishCell

Returns
System.Object

Row as object.

GetWorksheet()

Gets current worksheet.

Declaration
public virtual object GetWorksheet()
Returns
System.Object

Worksheet as object.

OnWorkbookCreated(SpreadStreamWorkbookEventArgs)

Raises the SpreadWorkbookCreated event.

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

The SpreadStreamWorkbookEventArgs instance containing the event data.

OnWorksheetCreated(SpreadStreamWorksheetEventArgs)

Raises the SpreadWorksheetCreated event.

Declaration
protected virtual bool OnWorksheetCreated(SpreadStreamWorksheetEventArgs e)
Parameters
SpreadStreamWorksheetEventArgs e

The SpreadStreamWorksheetEventArgs instance containing the event data.
Returns
System.Boolean

OnWorksheetExporting(SpreadStreamWorksheetEventArgs)

Raises the SpreadWorksheetExporting event.

Declaration
protected virtual void OnWorksheetExporting(SpreadStreamWorksheetEventArgs e)
Parameters
SpreadStreamWorksheetEventArgs e

The SpreadStreamWorksheetEventArgs instance containing the event data.

remove_WorkbookCreated(SpreadStreamWorkbookEventHandler)

Declaration
public void remove_WorkbookCreated(SpreadStreamWorkbookEventHandler value)
Parameters
SpreadStreamWorkbookEventHandler value

remove_WorksheetCreated(SpreadStreamWorksheetEventHandler)

Declaration
public void remove_WorksheetCreated(SpreadStreamWorksheetEventHandler value)
Parameters
SpreadStreamWorksheetEventHandler value

remove_WorksheetExporting(SpreadStreamWorksheetEventHandler)

Declaration
public void remove_WorksheetExporting(SpreadStreamWorksheetEventHandler value)
Parameters
SpreadStreamWorksheetEventHandler value

SetBooleanValue(Object)

Sets the value as boolean.

Declaration
protected virtual bool SetBooleanValue(object value)
Parameters
System.Object value

The value.
Returns
System.Boolean

True is the cell value is set, otherwise - false.

SetCellFormat(SpreadCellFormat)

Sets the cell format.

Declaration
public virtual void SetCellFormat(SpreadCellFormat spreadCellFormat)
Parameters
Telerik.Documents.SpreadsheetStreaming.SpreadCellFormat spreadCellFormat

The cell format.

SetCellValue(String)

Sets the value of current CellSelection.

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

Text.

SetCellValue(DataType, Object)

Sets the value of current CellSelection.

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

CellSelection data type.
System.Object value

Value.

SetColumnWidth(Double, Boolean)

Sets the width of current worksheet column.

Declaration
public virtual void SetColumnWidth(double width, bool pixels)
Parameters
System.Double width

The width.
System.Boolean pixels

If true, setts the width in pixels, otherwise - in characters.

SetDateTimeValue(Object)

Sets the value as date time.

Declaration
protected virtual bool SetDateTimeValue(object value)
Parameters
System.Object value

The value.
Returns
System.Boolean

True is the cell value is set, otherwise - false.

SetHiddenColumn()

Sets current worksheet column as hidden.

Declaration
public virtual void SetHiddenColumn()

SetHiddenRow()

Sets current worksheet row as hidden.

Declaration
public virtual void SetHiddenRow()

SetNumberValue(Object)

Sets the value as number.

Declaration
protected virtual bool SetNumberValue(object value)
Parameters
System.Object value

The value.
Returns
System.Boolean

True is the cell value is set, otherwise - false.

SetRowHeight(Double, Boolean)

Sets height of current row in worksheet.

Declaration
public virtual void SetRowHeight(double height, bool pixels)
Parameters
System.Double height

Height of row.
System.Boolean pixels

If true, sets the row height in pixels, otherwise - in points.

SetStringValue(Object)

Sets the value as string.

Declaration
protected virtual bool SetStringValue(object value)
Parameters
System.Object value

The value.
Returns
System.Boolean

True is the cell value is set, otherwise - false.

SkipCells(Int32)

Skips the cells.

Declaration
public virtual void SkipCells(int count)
Parameters
System.Int32 count

The count.

SkipColumns(Int32)

Skips the columns.

Declaration
public virtual void SkipColumns(int count)
Parameters
System.Int32 count

The count.

Events

WorkbookCreated

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

Declaration
public event SpreadStreamWorkbookEventHandler WorkbookCreated
Event Type
SpreadStreamWorkbookEventHandler

WorksheetCreated

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 Type
SpreadStreamWorksheetEventHandler

WorksheetExporting

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

Declaration
public event SpreadStreamWorksheetEventHandler WorksheetExporting
Event Type
SpreadStreamWorksheetEventHandler

Extension Methods