ISpreadExportRenderer
Defines the workbook, worksheet, cell, and formatting operations used by spreadsheet export.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
public interface ISpreadExportRenderer
Methods
Adds a hyperlink to the current cell selection.
Adds a worksheet with the specified name. If the name is blank, the renderer uses its default name; if the name already exists, the renderer may add a suffix to make it unique.
Notifies the renderer that workbook construction is complete.
void CallWorkbookCreated()
Clears the value in the current cell selection.
void ClearCellSelectionValue()
Selects a rectangular worksheet cell range for subsequent operations.
Creates style information for the current cell selection.
void CreateCellStyleInfo()
Creates style information for the current cell selection from explicit visual attributes.
void CreateCellStyleInfo(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, Orientation textOrientation = Orientation.Horizontal)
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.
textOrientationOrientationThe orientation of the cell text.
Creates an image positioned relative to a worksheet cell.
void CreateFloatingImage(int rowIndex, int columnIndex, int offsetX, int offsetY, byte[] bytes, string extension, int width, int height, int rotationAngle)
The row containing the image anchor.
columnIndexintThe column containing the image anchor.
offsetXintThe horizontal offset from the cell anchor.
offsetYintThe vertical offset from the cell anchor.
bytesbyte[]The image data.
extensionstringThe image file extension.
widthintThe image width.
heightintThe image height.
rotationAngleintThe image rotation angle.
Creates non-group row metadata at a specified hierarchy level.
IGridViewSpreadExportRowInfo CreateGridViewExportDataRowInfo(int currentIndent, List<IGridViewSpreadExportCellInfo> cells, bool exportAsHidden, int hierarchyLevel)
The number of leading cells used to represent the row's hierarchy indentation.
cellsList<IGridViewSpreadExportCellInfo>The cell data for the row.
exportAsHiddenbooltrue to mark the exported row as hidden.
The row's hierarchy level.
Returns:The row metadata used by the renderer to write the data row.
Creates row metadata for a non-group row, such as a data, header, or summary row.
IGridViewSpreadExportRowInfo CreateGridViewExportDataRowInfo(int currentIndent, List<IGridViewSpreadExportCellInfo> cells, bool exportAsHidden)
The number of leading cells used to represent the row's hierarchy indentation.
cellsList<IGridViewSpreadExportCellInfo>The cell data for the row.
exportAsHiddenbooltrue to mark the exported row as hidden.
The row metadata used by the renderer to write the data row.
Creates group-row metadata at a specified hierarchy level.
IGridViewSpreadExportRowInfo CreateGridViewExportGroupRowInfo(int currentIndent, string content, int colSpan, bool exportAsHidden, int hierarchyLevel)
The number of leading cells used to represent the group's hierarchy indentation.
contentstringThe text displayed in the group row.
colSpanintThe offset from the starting column to the inclusive last column; the merged range spans this offset plus one column.
exportAsHiddenbooltrue to mark the exported row as hidden.
The group's hierarchy level.
Returns:The row metadata used by the renderer to write the group row.
Creates row metadata for a group row containing the specified text.
IGridViewSpreadExportRowInfo CreateGridViewExportGroupRowInfo(int currentIndent, string content, int colSpan, bool exportAsHidden)
The number of leading cells used to represent the group's hierarchy indentation.
contentstringThe text displayed in the group row.
colSpanintThe offset from the starting column to the inclusive last column; the merged range spans this offset plus one column.
exportAsHiddenbooltrue to mark the exported row as hidden.
The row metadata used by the renderer to write the group row.
Initializes a new workbook for export.
void CreateWorkbook()
Writes the current workbook to the specified stream.
Gets the renderer-specific object for the current cell selection.
Gets the value in the current cell selection.
Gets the style attributes for the current cell selection.
Gets the filename extension associated with an export format.
object GetFileExtension(SpreadExportFormat exportFormat)
The export format.
Returns:The extension associated with exportFormat.
Selects the registered format provider for subsequent workbook operations.
void GetFormatProvider(SpreadExportFormat exportFormat)
The format whose provider to select.
Gets the renderer-specific object for the current worksheet.
Loads an existing workbook from the specified stream.
Merges the cells in the current selection.
void MergeCellSelection()
Registers the format provider required for the specified export format.
void RegisterFormatProvider(SpreadExportFormat exportFormat)
The format whose provider to register.
Sets the format string for the current cell selection.
void SetCellSelectionFormat(string formatString)
The format string to apply.
Sets the selected cell value from text.