Back to all docs
API Reference / Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport / SpreadStreamExportRenderer
New to Telerik UI for WPF? Start a free 30-day trial

SpreadStreamExportRenderer

Class

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:
C#
public class SpreadStreamExportRenderer

Inheritance: objectSpreadStreamExportRenderer

Constructors

SpreadStreamExportRenderer()

C#
public SpreadStreamExportRenderer()

Properties

ColumnIndex

Gets or sets the index of the column.

C#
public int ColumnIndex { get; set; }
Property Value:

The index of the column.

RowIndex

Gets or sets the index of the row.

C#
public int RowIndex { get; set; }
Property Value:

The index of the row.

Methods

AddWorksheet(string)

Create and add excel worksheet to the workbook.

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

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.

C#
public virtual void ApplyCellFormat(object format)
Parameters:formatobject

The format.

ApplyCellStyle(SpreadStreamCellStyle, string)

Applies the cell style.

C#
public virtual void ApplyCellStyle(SpreadStreamCellStyle cellStyle, string numberFormat)
Parameters:cellStyleSpreadStreamCellStyle

The cell style.

numberFormatstring

The format string.

CallOnWorksheetCreated()

Calls the WorksheetCreated event.

C#
public virtual bool CallOnWorksheetCreated()
Returns:

bool

ClearCellValue()

Clears the value of current Cell.

C#
public virtual void ClearCellValue()

CreateAndAddCellForMerge(int, int, int, int)

Creates CellSelection.

C#
public virtual void CreateAndAddCellForMerge(int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex)
Parameters:startRowIndexint

From row index.

startColumnIndexint

From column index.

endRowIndexint

To row index.

endColumnIndexint

To column index.

CreateCell()

Creates CellSelection.

C#
public virtual void CreateCell()

CreateColumn()

Creates the column.

C#
public virtual void CreateColumn()

CreateRow()

Creates the row.

C#
public virtual void CreateRow()

CreateWorkbook(Stream, SpreadStreamExportFormat)

Creates new workbook.

C#
public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)
Parameters:streamStream

The stream.

exportFormatSpreadStreamExportFormat

The export format.

FinishCell()

Finishes the cell.

C#
public virtual void FinishCell()

FinishColumn()

Finishes the column.

C#
protected virtual void FinishColumn()

FinishExport()

Exports workbook.

C#
public virtual void FinishExport()

FinishRow()

Finishes the row.

C#
protected virtual void FinishRow()

FinishWorkbook()

Finishes the workbook.

C#
protected virtual void FinishWorkbook()

FinishWorksheet()

Finishes the worksheet.

C#
protected virtual void FinishWorksheet()

GetCell()

Gets current Cell.

C#
public virtual object GetCell()
Returns:

object

Cell as object.

GetCellFormat(bool)

Gets current SpreadCellFormat.

C#
public virtual SpreadCellFormat GetCellFormat(bool createNew)
Parameters:createNewboolReturns:

SpreadCellFormat

GetCellStyle()

Gets the cell style info.

C#
public virtual SpreadStreamCellStyle GetCellStyle()
Returns:

SpreadStreamCellStyle

GetColumn()

Gets the column.

C#
public virtual object GetColumn()
Returns:

object

GetFileExtension(SpreadStreamExportFormat)

Gets file extension.

C#
public virtual string GetFileExtension(SpreadStreamExportFormat exportFormat)
Parameters:exportFormatSpreadStreamExportFormat

Export format.

Returns:

string

GetRow(bool)

Gets current Row.

C#
public virtual object GetRow(bool finishCell)
Parameters:finishCellboolReturns:

object

Row as object.

GetWorksheet()

Gets current worksheet.

C#
public virtual object GetWorksheet()
Returns:

object

Worksheet as object.

OnWorkbookCreated(SpreadStreamWorkbookEventArgs)

Raises the event.

C#
protected virtual void OnWorkbookCreated(SpreadStreamWorkbookEventArgs e)
Parameters:eSpreadStreamWorkbookEventArgs

The SpreadStreamWorkbookEventArgs instance containing the event data.

OnWorksheetCreated(SpreadStreamWorksheetEventArgs)

Raises the event.

C#
protected virtual bool OnWorksheetCreated(SpreadStreamWorksheetEventArgs e)
Parameters:eSpreadStreamWorksheetEventArgs

The SpreadStreamWorksheetEventArgs instance containing the event data.

Returns:

bool

OnWorksheetExporting(SpreadStreamWorksheetEventArgs)

Raises the event.

C#
protected virtual void OnWorksheetExporting(SpreadStreamWorksheetEventArgs e)
Parameters:eSpreadStreamWorksheetEventArgs

The SpreadStreamWorksheetEventArgs instance containing the event data.

SetBooleanValue(object)

Sets the value as boolean.

C#
protected virtual bool SetBooleanValue(object value)
Parameters:valueobject

The value.

Returns:

bool

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

SetCellFormat(SpreadCellFormat)

Sets the cell format.

C#
public virtual void SetCellFormat(SpreadCellFormat spreadCellFormat)
Parameters:spreadCellFormatSpreadCellFormat

The cell format.

SetCellValue(DataType, object)

Sets the value of current CellSelection.

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

CellSelection data type.

valueobject

Value.

SetCellValue(string)

Sets the value of current CellSelection.

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

Text.

SetColumnWidth(double, bool)

Sets the width of current worksheet column.

C#
public virtual void SetColumnWidth(double width, bool pixels)
Parameters:widthdouble

The width.

pixelsbool

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

SetDateTimeValue(object)

Sets the value as date time.

C#
protected virtual bool SetDateTimeValue(object value)
Parameters:valueobject

The value.

Returns:

bool

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

SetHiddenColumn()

Sets current worksheet column as hidden.

C#
public virtual void SetHiddenColumn()

SetHiddenRow()

Sets current worksheet row as hidden.

C#
public virtual void SetHiddenRow()

SetNumberValue(object)

Sets the value as number.

C#
protected virtual bool SetNumberValue(object value)
Parameters:valueobject

The value.

Returns:

bool

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

SetRowHeight(double, bool)

Sets height of current row in worksheet.

C#
public virtual void SetRowHeight(double height, bool pixels)
Parameters:heightdouble

Height of row.

pixelsbool

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

SetStringValue(object)

Sets the value as string.

C#
protected virtual bool SetStringValue(object value)
Parameters:valueobject

The value.

Returns:

bool

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

SkipCells(int)

Skips the cells.

C#
public virtual void SkipCells(int count)
Parameters:countint

The count.

SkipColumns(int)

Skips the columns.

C#
public virtual void SkipColumns(int count)
Parameters:countint

The count.

Events

WorkbookCreated

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

C#
public event SpreadStreamWorkbookEventHandler WorkbookCreated

WorksheetCreated

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

C#
public event SpreadStreamWorksheetEventHandler WorksheetCreated

WorksheetExporting

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

C#
public event SpreadStreamWorksheetEventHandler WorksheetExporting
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