Telerik.Web.Spreadsheet

Extensions for the Cells class

Gets a cell selection from A1 reference

The cells collection An A1 reference designating a rectangular area, e.g. "A1:B5" A cell selection matching the referenced area

Extensions for System.Windows.Media.Color class

Converts to CSS style color, i.e #ff00ff

The color to be converted String representing the CSS style color.

Converts CSS style color to System.Windows.Media.Color

Hex color code to convert System.Windows.Media.Color instance

Extensions for CellBorder class

Converts CellBorder to BorderStyle

The document border style Document theme Converted BorderStyle instances

General purpose extension methods

Converts the value to pixels string, i.e 10.0 to "10px"

The value to convert Converted value

Converts cell reference to CellIndex structure

Cell reference, i.e A7 Structure representing cell index

Converts cell reference to list of cell ranges

Cell reference, i.e A7:B5 or A7:A7 Collection of cell ranges

Returns the collection, if not null, or a new collection.

The collection item type A collection The collection, if not null, or a new collection.

Converts string to camel-case string

Check string value for empty string or null

Converts string to enum

The type of enum The value to convert Default value if convertion fails The result enum

Extensions methods for DPL filters

Converts DPL filter expressions to Telerik.Web.Spreadsheet.FilterColumn

Extensions for RadVerticalAlignment class

Convert RadVerticalAlignment to string

Current alignment Spreadsheet friendly alignment. Possible values "center", "top" and "bottom".

Convert string to RadVerticalAlignment

Current alignment. Possible values "center", "top" and "bottom". RadVerticalAlignment value for the string

Extensions for the DocumentWorksheet class

Gather all rows with changed properties.

DocumentWorksheet from which to import rows A collection of rows with changed properties

Represents a Validation

Serialize current instance to Dictionary

Describes an item used by the value filter to filter date values.

Gets or sets or sets the year.

Gets or sets the month.

Gets or sets the day.

Gets or sets the hour.

Gets or sets the minute.

Gets or sets the second.

Represents a Workbook

Creates a Workbook instance and populates it with data from JSON

The source JSON The populated Workbook

Converts this Workbook to JSON

The JSON string

Converts the Telerik DPL Workbook Document to a Workbook.

The source document A Workbook populated with the data from the source document

Converts the Workbook to a Telerik DPL Workbook Document.

Creates a Workbook instance and populates it with data from the specified file. Supported file formats are XLSX, CSV, TXT (Tab-separated) and JSON.

The fully-qualified path to the file The populated Workbook

Creates a Workbook instance and populates it with data from the provided stream. The stream will be closed after completion.

The input stream The file extension. Supported extensions are ".xlsx", ".csv", ".txt" and ".json" The populated Workbook

Stores the data from the Workbook in the specified file. Supported file formats are XLSX, CSV, TXT (Tab-separated) and JSON.

The fully-qualified path to the output file

Stores the data from the Workbook in the provided stream. The stream will be closed after completion.

The output stream The file extension. Supported extensions are ".xlsx", ".csv", ".txt" and ".json"

Adds an empty sheet

The new sheet

Implicit Workbook conversion to Dictionary

Workbook instance

Serialize current instance to Dictionary

The name of the currently active sheet.Must match one of the (sheet names)[#configuration-sheets.name] exactly.

Configures the Kendo UI Spreadsheet PDF export settings.

An array defining the document sheets and their content.

Represents the common settings used for JSON Import/Export

Initializes the default settings

Gets or sets the encoding to use during the import/export operation. The default is UTF-8.

Gets or sets the buffer size in bytes. The default value is 4096.

Represents the common settings used for JSON Import

Represents the settings used for JSON Export

A format provider that converts JSON streams to Telerik DPL Workbooks and vice versa

Creates a new instance of the JSON Format Provider

Reads an input stream with JSON data and produces a Telerik DPL Workbook.

An input stream containing JSON data A Telerik DPL Workbook

Writes a Telerik DPL Workbook to an output stream in JSON format

A Telerik DPL Workbook The stream to write to

Gets the name of the provider

Gets a list of supported file extensions

Gets a value indicating whether can import.

The value indicating whether can import.

Gets a value indicating whether can export.

The value indicating whether can export.

The settings to use during export

The settings to use during import

Defines common MIME types supported file types

MIME type for CSV files

MIME type for JSON files

MIME type for PDF files

MIME type for Tab-delimited text file

MIME type for Office Open XML Workbook

List of all supported MIME types by extension

Represents a BorderStyle

Serialize current instance to Dictionary

Represents a Worksheet

Adds rows to the worksheet.

The rows to add

Adds a row to the worksheet.

The row to add

Adds a merged range to the worksheet.

The merged range, e.g. "A1:B4"

Serialize current instance to Dictionary

The active cell in the sheet, e.g. "A1".

The name of the sheet.

An array defining the columns in this sheet and their content.

Defines the filtering criteria for this sheet, if any.

The number of frozen columns in this sheet.

The number of frozen rows in this sheet.

The row data for this sheet.

The selected range in the sheet, e.g. "A1:B10".

A boolean value indicating if the sheet grid lines should be displayed.

Defines the sort criteria for the sheet.

Represents a Column

Serialize current instance to Dictionary

The zero-based index of the column. Required to ensure correct positioning.

The width of the column in pixels. Defaults to columnWidth.

Represents a Filter

Serialize current instance to Dictionary

An array defining the filter configuration of individual columns.

The active range for the filter, e.g. "B1:D8".

Represents a FilterColumn

Serialize current instance to Dictionary

An array of dates to filter.

An array of filter criteria for custom filters.

The filter to apply to this column.The supported filters are: * value - filters based on unique values * custom - applies custom filtering criteria * top - filters the top or bottom records * dynamic - filters based on dynamic criteria

The index of the column relative to the filter range.

The logical operator to apply to filter criteria.Possible values are and, or.

The filter sub-type, if any.Applicable types according to the main filter. * top * topNumber * topPercent * bottomNumber * bottomPercent * dynamic * aboveAverage * belowAverage * tomorrow * today * yesterday * nextWeek * thisWeek * lastWeek * nextMonth * thisMonth * lastMonth * nextQuarter * thisQuarter * lastQuarter * nextYear * thisYear * lastYear * yearToDate

The filter value for filters that require a single value, e.g. "top".

Indicates whether to include blank values

Represents a Row

Adds the cells to the row

The cells to add

Adds a cell to the row

The cell to add

Serialize current instance to Dictionary

The cells for this row.

The row height in pixels. Defaults to rowHeight.

The absolute row index. Required to ensure correct positioning.

Represents a Cell

Serialize current instance to Dictionary

The style information for the bottom border of the cell.

The style information for the left border of the cell.

The style information for the top border of the cell.

The style information for the right border of the cell.

The information for the validation.

The background color of the cell.Many standard CSS formats are supported, but the canonical form is "#ccff00".

The font color of the cell.Many standard CSS formats are supported, but the canonical form is "#ccff00".

The font family for the cell.

The font size of the cell in pixels.

Sets the cell font to italic, if set to true.

Sets the cell font to bold, if set to true.

Disables the cell, if set to false.

The format of the cell text.See Create or delete a custom number format on MS Office.

The cell formula without the leading equals sign, e.g. A1 * 10.

The zero-based index of the cell. Required to ensure correct positioning.

The hyperlink (URL) of the cell.

The text align setting for the cell content.Available options are: * left * center * right * justify

Sets the cell font to underline, if set to true.

The cell value.

The vertical align setting for the cell content.Available options are: * left * center * right * justify

Will wrap the cell content if set to true.

Sets the editor of the cell.

Represents a Sort

Serialize current instance to Dictionary

Specifies the sort options for individual columns.

The sorted range, e.g. "A1:D5".

Represents a SortColumn

Serialize current instance to Dictionary

Indicates if the data in the cell should be sorted ascending (true) or descending or (false).

The index of the column within the sheet.For example, column C will have index 2.

Represents a Criteria

Serialize current instance to Dictionary

The criterion operator type.Supported types vary based on the inferred column data type (inferred): * Text * contains - the text contains the value * doesnotcontain - text does not contain the value * startswith - text starts with the value * endswith - text ends with the value * Date * eq - date is the same as the value * neq - date is not the same as the value * lt - date is before the value * gt - date is after the value * Number * eq - is equal to the value * neq - is not equal to the value * gte - is greater than or equal to the value * gt - is greater than the value * lte - is less than or equal to the value * lt - is less than the value

The value for the criteria operator.

Represents a Pdf

Serialize current instance to Dictionary

The area to export. Possible values:

The author of the PDF document.

The creator of the PDF document.

The date when the PDF document is created. Defaults to new Date().

Specifies the file name of the exported PDF file.

An option indicating whether to fit the spreadsheet content to page width.

If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.

An option indicating whether to export the cell guidelines.

An option indicating whether to center the content horizontally.See also vCenter.

Specifies the keywords of the exported PDF file.

Set to true to reverse the paper dimensions if needed such that width is the larger edge.

Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).

Specifies the paper size of the PDF document. The default "auto" means paper size is determined by content.Supported values:

The URL of the server side proxy which will stream the file to the end user.A proxy will be used when the browser isn't capable of saving files locally e.g. Internet Explorer 9 and Safari. PDF export is not supported in Internet Explorer 8 and below.The developer is responsible for implementing the server-side proxy.The proxy will receive a POST request with the following parameters in the request body:The proxy should return the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.pdf>".

A name or keyword indicating where to display the document returned from the proxy.If you want to display the document in a new window or iframe, the proxy should set the "Content-Disposition" header to inline; filename="<fileName.pdf>".

Sets the subject of the PDF file.

Sets the title of the PDF file.

An option indicating whether to center the content vertically.See also hCenter.

Represents a Margin

Serialize current instance to Dictionary

The bottom margin. Numbers are considered as "pt" units.

The left margin. Numbers are considered as "pt" units.

The right margin. Numbers are considered as "pt" units.

The top margin. Numbers are considered as "pt" units.