SpreadsheetBuilder
Methods
ActiveSheet(System.String)
The name of the currently active sheet. Must exactly match one of the (sheet names)[#configuration-sheets.name].
Parameters
value - System.String
The value that configures the activesheet.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.ActiveSheet("Sheet2")
)
ColumnWidth(System.Double)
The default column width in pixels.
Parameters
value - System.Double
The value that configures the columnwidth.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.ColumnWidth(100)
)
Columns(System.Double)
The number of columns in the document.
Parameters
value - System.Double
The value that configures the columns.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Columns(10)
)
DefaultCellStyle(System.Action)
The default cell styles that will be applied to the sheet cells.
Parameters
configurator - System.Action<SpreadsheetDefaultCellStyleSettingsBuilder>
The action that configures the defaultcellstyle.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.DefaultCellStyle(dcs => dcs.Background("lightblue"))
)
HeaderHeight(System.Double)
The height of the header row in pixels.
Parameters
value - System.Double
The value that configures the headerheight.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.HeaderHeight(50)
)
HeaderWidth(System.Double)
The width of the header column in pixels.
Parameters
value - System.Double
The value that configures the headerwidth.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.HeaderWidth(100)
)
Excel(System.Action)
Configures the Excel export settings of the Spreadsheet.
Parameters
configurator - System.Action<SpreadsheetExcelSettingsBuilder>
The action that configures the excel.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Excel(excel => excel
.ProxyURL(Url.Action("Index_Proxy", "Home"))
.ForceProxy(true)
)
)
Pdf(System.Action)
Configures the PDF export settings of the Spreadsheet.
Parameters
configurator - System.Action<SpreadsheetPdfSettingsBuilder>
The action that configures the pdf.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf => pdf
.ProxyURL(Url.Action("Index_Proxy", "Home"))
.ForceProxy(true)
)
)
RowHeight(System.Double)
The default row height in pixels.
Parameters
value - System.Double
The value that configures the rowheight.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.RowHeight(30)
)
Rows(System.Double)
The number of rows in the document.
Parameters
value - System.Double
The value that configures the rows.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Rows(50)
)
Sheetsbar(System.Boolean)
A Boolean value which indicates if the sheets-bar will be displayed.
Parameters
value - System.Boolean
The value that configures the sheetsbar.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheetsbar(false)
)
UseCultureDecimals(System.Boolean)
If set to true, the Spreadsheet formula parser will obey the decimal separator of the current culture. If set to false (default), the decimal separator in formulas will always be the dot.This flag has implications on how formulas are entered. When it is set to true, in cultures where the decimal separator is the comma (,), similar to Excel, the following additional changes upon entering a formula will occur: The semicolon will become a function argument separator. For example, =SUM(A1;A2) instead of =SUM(A1,A2). or The backslash will become an element separator in an array formula. For example, ={1;3} instead of ={1,2;3,4}.. This flag only affects the presentation - the way formulas are entered by the end user or displayed on screen. Serialization to JSON or XLSX as well as the public API functions will continue to use the dot as decimal separator and the comma as an argument separator (canonical form). For example, to apply a formula by using the API, even if useCultureDecimals is in effect, you still need to use the canonical form.To make the API functions obey useCultureDecimals, wrap your code in a call to sheet.withCultureDecimals. Assuming a culture where the comma is used for decimals, compare the previous example with the following one.
Parameters
value - System.Boolean
The value that configures the useculturedecimals.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.UseCultureDecimals(false)
)
BindTo(System.Collections.Generic.IEnumerable)
Parameters
value - System.Collections.Generic.IEnumerable<SpreadsheetSheet>
BindTo(System.Collections.Generic.Dictionary)
Parameters
workbook - System.Collections.Generic.Dictionary<String,Object>
Sheets(System.Action)
An array defining the document sheets and their content.
Parameters
configurator - System.Action<SpreadsheetSheetFactory>
The action that configures the sheets.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =>
{
sheets.Add()
.Name("Food Order")
.Columns(columns =>
{
columns.Add().Width(100);
})
.Rows(rows =>
{
rows.Add().Height(70).Cells(cells =>
{
cells.Add()
.Value("Invoice1")
.FontSize(22)
.Color("lightblue");
});
});
})
)
Images(System.Object)
An object containing any images used in the Spreadsheet. The keys should be image ID-s (they are referenced by this ID in (sheets.drawings)[#configuration-sheets.drawings]) and the values should be image URLs.The image URLs can be eitherdata URLs, in which case the images are fully contained by the JSON, or can be external URLs.Note that when external URLs are used, they should reside on the same domain, or the server must be configured with the properCORS headers, for the Spreadsheet to be able to fetch binary image data using a XMLHttpRequest. If it cannot fetch the image, export to Excel or PDF might not work.
Parameters
value - System.Object
The value that configures the images.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Images(new { testImage = "../images/image1.png" })
)
Toolbar(System.Boolean)
A Boolean value which indicates if the toolbar will be displayed.
Parameters
enabled - System.Boolean
Enables or disables the toolbar option.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Toolbar(false)
)
Toolbar(System.Action)
Configures the toolbar tabs and the options within the tabs.
Parameters
configurator - System.Action<SpreadsheetToolbarSettingsBuilder>
The action that configures the toolbar.
Example
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Toolbar(toolbar => toolbar.Home(false))
)
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<SpreadsheetEventBuilder>
The client events action.
Example
@( Html.Kendo().Spreadsheet()
.Name("Spreadsheet")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name of the component.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
ModelMetadata(System.Web.Mvc.ModelMetadata)
Uses the Metadata of the Model.
Parameters
modelMetadata - System.Web.Mvc.ModelMetadata
The metadata set for the Model
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
Render()
Renders the component.
Example
@(@Page Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" )
@( Html.Kendo().Grid(Model)
.Name("grid")
.DetailTemplate(product => {
)
Product Details:
<div>Product Name: @( product.ProductName )</div>
<div>Units In Stock: @( product.UnitsInStock )</div>
@(
})
.Render();
)
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.