Back to all docs
API Reference / Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport / SpreadStreamExportRenderer

Class
SpreadStreamExportRenderer

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

Definition

Namespace:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport

Assembly:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport.dll

Syntax:
cs-api-definition
public class SpreadStreamExportRenderer

Inheritance: objectSpreadStreamExportRenderer

Constructors

SpreadStreamExportRenderer()

Declaration

cs-api-definition
public SpreadStreamExportRenderer()

Properties

ColumnIndex

Gets or sets the index of the column.

Declaration

cs-api-definition
public int ColumnIndex { get; set; }

Property Value

int

The index of the column.

RowIndex

Gets or sets the index of the row.

Declaration

cs-api-definition
public int RowIndex { get; set; }

Property Value

int

The index of the row.

Methods

AddWorksheet(string)

Create and add excel worksheet to the workbook.

Declaration

cs-api-definition
public virtual void AddWorksheet(string sheetName)

Parameters

sheetName

string

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

cs-api-definition
public virtual void ApplyCellFormat(object format)

Parameters

format

object

The format.

ApplyCellStyle(SpreadStreamCellStyle, string)

Applies the cell style.

Declaration

cs-api-definition
public virtual void ApplyCellStyle(SpreadStreamCellStyle cellStyle, string numberFormat)

Parameters

cellStyle

SpreadStreamCellStyle

The cell style.

numberFormat

string

The format string.

CallOnWorksheetCreated()

Calls the WorksheetCreated event.

Declaration

cs-api-definition
public virtual bool CallOnWorksheetCreated()

Returns

bool

ClearCellValue()

Clears the value of current Cell.

Declaration

cs-api-definition
public virtual void ClearCellValue()

CreateAndAddCellForMerge(int, int, int, int)

Creates CellSelection.

Declaration

cs-api-definition
public virtual void CreateAndAddCellForMerge(int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex)

Parameters

startRowIndex

int

From row index.

startColumnIndex

int

From column index.

endRowIndex

int

To row index.

endColumnIndex

int

To column index.

CreateCell()

Creates CellSelection.

Declaration

cs-api-definition
public virtual void CreateCell()

CreateColumn()

Creates the column.

Declaration

cs-api-definition
public virtual void CreateColumn()

CreateRow()

Creates the row.

Declaration

cs-api-definition
public virtual void CreateRow()

CreateWorkbook(Stream, SpreadStreamExportFormat)

Creates new workbook.

Declaration

cs-api-definition
public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)

Parameters

stream

Stream

The stream.

exportFormat

SpreadStreamExportFormat

The export format.

FinishCell()

Finishes the cell.

Declaration

cs-api-definition
public virtual void FinishCell()

FinishColumn()

Finishes the column.

Declaration

cs-api-definition
protected virtual void FinishColumn()

FinishExport()

Exports workbook.

Declaration

cs-api-definition
public virtual void FinishExport()

FinishRow()

Finishes the row.

Declaration

cs-api-definition
protected virtual void FinishRow()

FinishWorkbook()

Finishes the workbook.

Declaration

cs-api-definition
protected virtual void FinishWorkbook()

FinishWorksheet()

Finishes the worksheet.

Declaration

cs-api-definition
protected virtual void FinishWorksheet()

GetCell()

Gets current Cell.

Declaration

cs-api-definition
public virtual object GetCell()

Returns

object

Cell as object.

GetCellFormat(bool)

Gets current SpreadCellFormat.

Declaration

cs-api-definition
public virtual SpreadCellFormat GetCellFormat(bool createNew)

Parameters

createNew

bool

Returns

SpreadCellFormat

GetCellStyle()

Gets the cell style info.

Declaration

cs-api-definition
public virtual SpreadStreamCellStyle GetCellStyle()

Returns

SpreadStreamCellStyle

GetColumn()

Gets the column.

Declaration

cs-api-definition
public virtual object GetColumn()

Returns

object

GetFileExtension(SpreadStreamExportFormat)

Gets file extension.

Declaration

cs-api-definition
public virtual string GetFileExtension(SpreadStreamExportFormat exportFormat)

Parameters

exportFormat

SpreadStreamExportFormat

Export format.

Returns

string

GetRow(bool)

Gets current Row.

Declaration

cs-api-definition
public virtual object GetRow(bool finishCell)

Parameters

finishCell

bool

Returns

object

Row as object.

GetWorksheet()

Gets current worksheet.

Declaration

cs-api-definition
public virtual object GetWorksheet()

Returns

object

Worksheet as object.

OnWorkbookCreated(SpreadStreamWorkbookEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnWorkbookCreated(SpreadStreamWorkbookEventArgs e)

Parameters

e

SpreadStreamWorkbookEventArgs

The SpreadStreamWorkbookEventArgs instance containing the event data.

OnWorksheetCreated(SpreadStreamWorksheetEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual bool OnWorksheetCreated(SpreadStreamWorksheetEventArgs e)

Parameters

e

SpreadStreamWorksheetEventArgs

The SpreadStreamWorksheetEventArgs instance containing the event data.

Returns

bool

OnWorksheetExporting(SpreadStreamWorksheetEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnWorksheetExporting(SpreadStreamWorksheetEventArgs e)

Parameters

e

SpreadStreamWorksheetEventArgs

The SpreadStreamWorksheetEventArgs instance containing the event data.

SetBooleanValue(object)

Sets the value as boolean.

Declaration

cs-api-definition
protected virtual bool SetBooleanValue(object value)

Parameters

value

object

The value.

Returns

bool

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

SetCellFormat(SpreadCellFormat)

Sets the cell format.

Declaration

cs-api-definition
public virtual void SetCellFormat(SpreadCellFormat spreadCellFormat)

Parameters

spreadCellFormat

SpreadCellFormat

The cell format.

SetCellValue(DataType, object)

Sets the value of current CellSelection.

Declaration

cs-api-definition
public virtual void SetCellValue(DataType dataType, object value)

Parameters

dataType

DataType

CellSelection data type.

value

object

Value.

SetCellValue(string)

Sets the value of current CellSelection.

Declaration

cs-api-definition
public virtual void SetCellValue(string text)

Parameters

text

string

Text.

SetColumnWidth(double, bool)

Sets the width of current worksheet column.

Declaration

cs-api-definition
public virtual void SetColumnWidth(double width, bool pixels)

Parameters

width

double

The width.

pixels

bool

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

SetDateTimeValue(object)

Sets the value as date time.

Declaration

cs-api-definition
protected virtual bool SetDateTimeValue(object value)

Parameters

value

object

The value.

Returns

bool

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

SetHiddenColumn()

Sets current worksheet column as hidden.

Declaration

cs-api-definition
public virtual void SetHiddenColumn()

SetHiddenRow()

Sets current worksheet row as hidden.

Declaration

cs-api-definition
public virtual void SetHiddenRow()

SetNumberValue(object)

Sets the value as number.

Declaration

cs-api-definition
protected virtual bool SetNumberValue(object value)

Parameters

value

object

The value.

Returns

bool

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

SetRowHeight(double, bool)

Sets height of current row in worksheet.

Declaration

cs-api-definition
public virtual void SetRowHeight(double height, bool pixels)

Parameters

height

double

Height of row.

pixels

bool

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

SetStringValue(object)

Sets the value as string.

Declaration

cs-api-definition
protected virtual bool SetStringValue(object value)

Parameters

value

object

The value.

Returns

bool

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

SkipCells(int)

Skips the cells.

Declaration

cs-api-definition
public virtual void SkipCells(int count)

Parameters

count

int

The count.

SkipColumns(int)

Skips the columns.

Declaration

cs-api-definition
public virtual void SkipColumns(int count)

Parameters

count

int

The count.

Events

WorkbookCreated

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

Declaration

cs-api-definition
public event SpreadStreamWorkbookEventHandler WorkbookCreated

Event Value

SpreadStreamWorkbookEventHandler

WorksheetCreated

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

Declaration

cs-api-definition
public event SpreadStreamWorksheetEventHandler WorksheetCreated

Event Value

SpreadStreamWorksheetEventHandler

WorksheetExporting

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

Declaration

cs-api-definition
public event SpreadStreamWorksheetEventHandler WorksheetExporting

Event Value

SpreadStreamWorksheetEventHandler

In this article
DefinitionConstructorsSpreadStreamExportRenderer()PropertiesColumnIndexRowIndexMethodsAddWorksheet(string)ApplyCellFormat(object)ApplyCellStyle(SpreadStreamCellStyle, string)CallOnWorksheetCreated()ClearCellValue()CreateAndAddCellForMerge(int, int, int, int)CreateCell()CreateColumn()CreateRow()CreateWorkbook(Stream, SpreadStreamExportFormat)FinishCell()FinishColumn()FinishExport()FinishRow()FinishWorkbook()FinishWorksheet()GetCell()GetCellFormat(bool)GetCellStyle()GetColumn()GetFileExtension(SpreadStreamExportFormat)GetRow(bool)GetWorksheet()OnWorkbookCreated(SpreadStreamWorkbookEventArgs)OnWorksheetCreated(SpreadStreamWorksheetEventArgs)OnWorksheetExporting(SpreadStreamWorksheetEventArgs)SetBooleanValue(object)SetCellFormat(SpreadCellFormat)SetCellValue(DataType, object)SetCellValue(string)SetColumnWidth(double, bool)SetDateTimeValue(object)SetHiddenColumn()SetHiddenRow()SetNumberValue(object)SetRowHeight(double, bool)SetStringValue(object)SkipCells(int)SkipColumns(int)EventsWorkbookCreatedWorksheetCreatedWorksheetExporting
Not finding the help you need?
Contact Support