Class SpreadStreamExportRenderer
Represents a class which exposes all methods needed to export using RadSpreadStreamProcessing.
Inheritance
Inherited Members
Namespace: Telerik.WinControls.Export
Assembly: TelerikExport.dll
Syntax
public class SpreadStreamExportRenderer : ISpreadStreamExportRendererConstructors
SpreadStreamExportRenderer()
Declaration
public SpreadStreamExportRenderer()Properties
ColumnIndex
Gets or sets the index of the column.
Declaration
public int ColumnIndex { get; set; }Property Value
|
System. The index of the column. |
Implements
RowIndex
Gets or sets the index of the row.
Declaration
public int RowIndex { get; set; }Property Value
|
System. The index of the row. |
Implements
Methods
AddWorksheet(String)
Create and add excel worksheet to the workbook.
Declaration
public virtual void AddWorksheet(string sheetName)Parameters
|
System. Excel workbook. |
Implements
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. The format. |
Implements
ApplyCellStyle(ISpreadStreamExportCellStyleInfo, String)
Applies the cell style.
Declaration
public virtual void ApplyCellStyle(ISpreadStreamExportCellStyleInfo cellStyle, string formatString)Parameters
|
ISpread The cell style. |
|
System. The format string. |
Implements
CallOnWorksheetCreated()
Calls the WorksheetCreated event.
Declaration
public virtual bool CallOnWorksheetCreated()Returns
|
System.
|
Implements
ClearCellValue()
Clears the value of current Cell.
Declaration
public virtual void ClearCellValue()Implements
CreateBorderCellStyle(ISpreadStreamExportCellStyleInfo)
Creates the border cell style.
Declaration
public virtual void CreateBorderCellStyle(ISpreadStreamExportCellStyleInfo cellStyle)Parameters
|
ISpread The cell style. |
Implements
CreateCell()
Creates CellSelection.
Declaration
public virtual void CreateCell()Implements
CreateCellStyle(Color, Color, FontFamily, Double, Boolean, Boolean, Boolean, ContentAlignment, Boolean, BorderBoxStyle, Color, Color, Color, Color, Color)
Creates a Spread
Declaration
public virtual void CreateCellStyle(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)Parameters
|
System. BackColor of cell. |
|
System. ForeColor of cell. |
|
System. FontFamily of cell. |
|
System. Font size of cell. |
|
System. Is text bold. |
|
System. Is text italic. |
|
System. Is text underlined. |
|
System. Text alignment. |
|
System. Is text wrapped. |
|
Border Border box style. |
|
System. Color of border. |
|
System. Color of top border. |
|
System. Color of bottom border. |
|
System. Color of right border. |
|
System. Color of left border. |
Implements
CreateCellStyleFromLightStyle(ISpreadStreamExportCellStyleInfo)
Creates the cell style from light style.
Declaration
public virtual ISpreadStreamExportCellStyleInfo CreateCellStyleFromLightStyle(ISpreadStreamExportCellStyleInfo cellStyle)Parameters
|
ISpread The cell style. |
Returns
Implements
CreateCellStyleFromTheme()
Creates SpreadStreamCellStyleInfo from theme normal style.
Declaration
public virtual void CreateCellStyleFromTheme()Implements
CreateColumn()
Creates the column.
Declaration
public virtual void CreateColumn()Implements
CreateFreezePanes(Int32, Int32)
Creates freeze panes.
Declaration
public virtual void CreateFreezePanes(int rowsCount, int columnsCount)Parameters
|
System. Count of frozen rows. |
|
System. Count of frozen columns. |
Implements
CreateLightCellStyle(Color, Color, FontFamily, Double, Boolean, Boolean, Boolean, ContentAlignment, Boolean, BorderBoxStyle, Color, Color, Color, Color, Color)
Creates a Telerik.
Declaration
public virtual void CreateLightCellStyle(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)Parameters
|
System. BackColor of cell. |
|
System. ForeColor of cell. |
|
System. FontFamily of cell. |
|
System. Font size of cell. |
|
System. Is text bold. |
|
System. Is text italic. |
|
System. Is text underlined. |
|
System. Text alignment. |
|
System. Is text wrapped. |
|
Border Border box style. |
|
System. Color of border. |
|
System. Color of top border. |
|
System. Color of bottom border. |
|
System. Color of right border. |
|
System. Color of left border. |
Implements
CreateMergedCells(Int32, Int32, Int32, Int32)
Creates CellSelection.
Declaration
public virtual void CreateMergedCells(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)Parameters
|
System. From row index. |
|
System. From column index. |
|
System. To row index. |
|
System. To column index. |
Implements
CreateRow()
Creates the row.
Declaration
public virtual void CreateRow()Implements
CreateWorkbook(Stream, SpreadStreamExportFormat)
Creates new workbook.
Declaration
public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)Parameters
|
System. The stream. |
|
Spread The export format. |
Implements
CreateWorkbook(Stream, SpreadStreamExportFormat, FileExportMode)
Creates new workbook.
Declaration
public virtual void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat, FileExportMode fileExportMode)Parameters
|
System. The stream. |
|
Spread The export format. |
|
File The file export mode. |
Implements
FinishCell()
Finishes the cell.
Declaration
public virtual void FinishCell()Implements
FinishColumn()
Finishes the column.
Declaration
protected virtual void FinishColumn()FinishExport()
Exports workbook.
Declaration
public virtual void FinishExport()Implements
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()GetBordersFromExistingStyle(ISpreadStreamExportCellStyleInfo)
Gets the borders from existing style.
Declaration
public virtual ISpreadStreamExportCellStyleInfo GetBordersFromExistingStyle(ISpreadStreamExportCellStyleInfo cellStyle)Parameters
|
ISpread The cell style. |
Returns
Implements
GetCell()
Gets current Cell.
Declaration
public virtual object GetCell()Returns
|
System. Cell as object. |
Implements
GetCellFormat(Boolean)
Gets current SpreadCellFormat.
Declaration
public virtual object GetCellFormat(bool createNew)Parameters
|
System.
|
Returns
|
System.
|
Implements
GetCellStyleInfo()
Gets the cell style info.
Declaration
public virtual ISpreadStreamExportCellStyleInfo GetCellStyleInfo()Returns
Implements
GetColumn()
Gets the column.
Declaration
public virtual object GetColumn()Returns
|
System.
|
Implements
GetFileExtension(SpreadStreamExportFormat)
Gets file extension.
Declaration
public virtual string GetFileExtension(SpreadStreamExportFormat exportFormat)Parameters
|
Spread Export format. |
Returns
|
System.
|
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. The row of cell. |
|
System. The column of cell. |
Returns
|
System. A value indicating, whether given cell is part of a merged cell. |
Implements
GetRow(Boolean)
Gets current Row.
Declaration
public virtual object GetRow(bool finishCell)Parameters
|
System.
|
Returns
|
System. Row as object. |
Implements
GetWorksheet()
Gets current worksheet.
Declaration
public virtual object GetWorksheet()Returns
|
System. Worksheet as object |
Implements
GroupCurrentRow(Int32)
Groups current row in current worksheet.
Declaration
public virtual void GroupCurrentRow(int level)Parameters
|
System. Outline level. |
Implements
OnWorkbookCreated(SpreadStreamWorkbookEventArgs)
Raises the Spread
Declaration
protected virtual void OnWorkbookCreated(SpreadStreamWorkbookEventArgs e)Parameters
|
Spread The Spread |
OnWorksheetCreated(SpreadStreamWorksheetEventArgs)
Raises the Spread
Declaration
protected virtual bool OnWorksheetCreated(SpreadStreamWorksheetEventArgs e)Parameters
|
Spread The Spread |
Returns
|
System.
|
OnWorksheetExporting(SpreadStreamWorksheetEventArgs)
Raises the Spread
Declaration
protected virtual void OnWorksheetExporting(SpreadStreamWorksheetEventArgs e)Parameters
|
Spread The Spread |
SetBooleanValue(Object)
Sets the value as boolean.
Declaration
protected virtual bool SetBooleanValue(object value)Parameters
|
System. The value. |
Returns
|
System. True is the cell value is set, otherwise - false. |
SetCellFormat(String, Boolean)
Sets the cell format.
Declaration
public virtual void SetCellFormat(string formatString, bool apply)Parameters
|
System. The format string. |
|
System. The apply. |
Implements
SetCellValue(String)
Sets the value of current CellSelection.
Declaration
public virtual void SetCellValue(string text)Parameters
|
System. Text. |
Implements
SetCellValue(DataType, Object)
Sets the value of current CellSelection.
Declaration
public virtual void SetCellValue(DataType dataType, object value)Parameters
|
Data CellSelection data type. |
|
System. Value. |
Implements
SetColumnWidth(Double, Boolean)
Sets the width of current worksheet column.
Declaration
public virtual void SetColumnWidth(double width, bool inPixels)Parameters
|
System. The width. |
|
System. If true, setts the width in pixels, otherwise - in characters. |
Implements
SetDateTimeValue(Object)
Sets the value as date time.
Declaration
protected virtual bool SetDateTimeValue(object value)Parameters
|
System. The value. |
Returns
|
System. True is the cell value is set, otherwise - false. |
SetHiddenColumn()
Sets current worksheet column as hidden.
Declaration
public virtual void SetHiddenColumn()Implements
SetHiddenRow()
Sets current worksheet row as hidden.
Declaration
public virtual void SetHiddenRow()Implements
SetNumberValue(Object)
Sets the value as number.
Declaration
protected virtual bool SetNumberValue(object value)Parameters
|
System. The value. |
Returns
|
System. 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 inPixels)Parameters
|
System. Height of row. |
|
System. If true, sets the row height in pixels, otherwise - in points. |
Implements
SetStringValue(Object)
Sets the value as string.
Declaration
protected virtual bool SetStringValue(object value)Parameters
|
System. The value. |
Returns
|
System. True is the cell value is set, otherwise - false. |
SkipCells(Int32)
Skips the cells.
Declaration
public virtual void SkipCells(int count)Parameters
|
System. The count. |
Implements
SkipColumns(Int32)
Skips the columns.
Declaration
public virtual void SkipColumns(int count)Parameters
|
System. The count. |
Implements
Events
WorkbookCreated
Occurs when the workbook is created. This is suitable place to add and/or modify cell styles.
Declaration
public event SpreadStreamWorkbookEventHandler WorkbookCreatedEvent Type
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 WorksheetCreatedEvent Type
WorksheetExporting
Occurs when a worksheet is about to be exported. This is suitable place to add footer rows.
Declaration
public event SpreadStreamWorksheetEventHandler WorksheetExporting
