ISpreadStreamExportRenderer
Defines the operations used by GridView stream export to write workbook, worksheet, row, cell, and style data.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
public interface ISpreadStreamExportRenderer
Properties
Gets or sets the column currently addressed by the renderer.
int ColumnIndex { get; set; }
Methods
Adds a worksheet with the specified name to the workbook.
Applies a renderer-specific format object to the current cell.
Applies a style and format string to the current cell.
void ApplyCellStyle(ISpreadStreamExportCellStyleInfo cellStyle, string formatString)
The style attributes to apply.
formatStringstringThe value format string to apply.
Invokes the worksheet-created handler when one is subscribed.
bool CallOnWorksheetCreated()
true if a worksheet-created handler was invoked; otherwise, false.
Clears the value from the current cell.
void ClearCellValue()
Creates a border-only cell style from the supplied style attributes.
void CreateBorderCellStyle(ISpreadStreamExportCellStyleInfo cellStyle)
The style whose borders are used.
Creates a cell at the current row and column position.
void CreateCell()
Creates a cell style from explicit colors, font, alignment, wrapping, and border settings.
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)
The cell fill color.
foreColorColorThe text color.
fontFamilyFontFamilyThe font family.
fontSizedoubleThe font size.
isBoldbooltrue to use bold text.
true to use italic text.
true to underline the text.
The cell's text alignment.
textWrapbooltrue to wrap text in the cell.
The cell border-box style.
borderColorColorThe general border color.
borderTopColorColorThe top border color.
borderBottomColorColorThe bottom border color.
borderRightColorColorThe right border color.
borderLeftColorColorThe left border color.
Creates a renderer-specific style from the supplied lightweight style attributes.
ISpreadStreamExportCellStyleInfo CreateCellStyleFromLightStyle(ISpreadStreamExportCellStyleInfo cellStyle)
The lightweight style attributes to convert.
Returns:ISpreadStreamExportCellStyleInfo
The style representation used by the renderer.
Initializes the current cell style from the export renderer's theme.
void CreateCellStyleFromTheme()
Creates a column at the renderer's current column position.
void CreateColumn()
Creates a lightweight cell style from explicit colors, font, alignment, wrapping, and border settings.
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)
The cell fill color.
foreColorColorThe text color.
fontFamilyFontFamilyThe font family.
fontSizedoubleThe font size.
isBoldbooltrue to use bold text.
true to use italic text.
true to underline the text.
The cell's text alignment.
textWrapbooltrue to wrap text in the cell.
The cell border-box style.
borderColorColorThe general border color.
borderTopColorColorThe top border color.
borderBottomColorColorThe bottom border color.
borderRightColorColorThe right border color.
borderLeftColorColorThe left border color.
Merges the worksheet cells in the specified rectangular range.
Creates a row at the renderer's current row position.
void CreateRow()
Creates a workbook in the specified stream using the requested file-handling mode.
void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat, FileExportMode fileExportMode)
The destination stream for the workbook.
exportFormatSpreadStreamExportFormatThe workbook format.
fileExportModeFileExportModeHow the export handles an existing file or worksheet.
Creates a workbook in the specified stream using the requested format.
void CreateWorkbook(Stream stream, SpreadStreamExportFormat exportFormat)
The destination stream for the workbook.
exportFormatSpreadStreamExportFormatThe workbook format.
Finalizes the current cell.
void FinishCell()
Finalizes the workbook output after the export has written its content.
void FinishExport()
Gets style attributes containing the borders from an existing cell style.
ISpreadStreamExportCellStyleInfo GetBordersFromExistingStyle(ISpreadStreamExportCellStyleInfo cellStyle)
The style from which to retrieve borders.
Returns:ISpreadStreamExportCellStyleInfo
Style attributes for the existing borders.
Gets the renderer-specific object for the current cell.
Gets the style attributes currently associated with the cell.
Gets the renderer-specific object for the current column.
Gets the filename extension associated with an export format.
string GetFileExtension(SpreadStreamExportFormat exportFormat)
The format for which to retrieve the extension.
Returns:The extension associated with exportFormat.
Gets the renderer-specific worksheet object for the active worksheet.
Assigns the current row to the specified outline level.
Sets the current cell's value from text.
Marks the current column as hidden in the exported worksheet.
void SetHiddenColumn()
Marks the current row as hidden in the exported worksheet.
void SetHiddenRow()
Advances the current cell position without creating the specified number of cells.
Advances the current column position without creating the specified number of columns.