Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / SpreadsheetBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

SpreadsheetBuilder

Class

Defines the fluent API for configuring the Kendo Spreadsheet for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class SpreadsheetBuilder : WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>SpreadsheetBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ToComponent()WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.Name(string)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.Deferred(bool)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.HtmlAttributes(object)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.AsModule(bool)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.Render()WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ToHtmlString()WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ToClientTemplate()WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.ToString()WidgetBuilderBase<Spreadsheet, SpreadsheetBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SpreadsheetBuilder(Spreadsheet)

Initializes a new instance of the Spreadsheet class.

C#
public SpreadsheetBuilder(Spreadsheet component)
Parameters:componentSpreadsheet

The component.

Methods

ActiveSheet(string)

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

C#
public SpreadsheetBuilder ActiveSheet(string value)
Parameters:valuestring

The value that configures the activesheet.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.ActiveSheet("Sheet2")
)

BindTo(Dictionary<string, object>)

An object defining the document workbook and its content that sets the document data.

C#
public SpreadsheetBuilder BindTo(Dictionary<string, object> workbook)
Parameters:workbookDictionary<string, object>Returns:

SpreadsheetBuilder

BindTo(IEnumerable<SpreadsheetSheet>)

An array defining the document sheets and their content that sets to document data.

C#
public SpreadsheetBuilder BindTo(IEnumerable<SpreadsheetSheet> value)
Parameters:valueIEnumerable<SpreadsheetSheet>Returns:

SpreadsheetBuilder

Columns(double)

The number of columns in the document.

C#
public SpreadsheetBuilder Columns(double value)
Parameters:valuedouble

The value that configures the columns.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Columns(10)
)

ColumnWidth(double)

The default column width in pixels.

C#
public SpreadsheetBuilder ColumnWidth(double value)
Parameters:valuedouble

The value that configures the columnwidth.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.ColumnWidth(100)
)

DefaultCellStyle(Action<SpreadsheetDefaultCellStyleSettingsBuilder>)

The default cell styles that will be applied to the sheet cells.

C#
public SpreadsheetBuilder DefaultCellStyle(Action<SpreadsheetDefaultCellStyleSettingsBuilder> configurator)
Parameters:configuratorAction<SpreadsheetDefaultCellStyleSettingsBuilder>

The action that configures the defaultcellstyle.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.DefaultCellStyle(dcs =&gt; dcs.Background("lightblue"))
)

Events(Action<SpreadsheetEventBuilder>)

Configures the client-side events.

C#
public SpreadsheetBuilder Events(Action<SpreadsheetEventBuilder> configurator)
Parameters:configuratorAction<SpreadsheetEventBuilder>

The client events action.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("Spreadsheet")
.Events(events =&gt; events
.Change("onChange")
)
)

Excel(Action<SpreadsheetExcelSettingsBuilder>)

Configures the Excel export settings of the Spreadsheet.

C#
public SpreadsheetBuilder Excel(Action<SpreadsheetExcelSettingsBuilder> configurator)
Parameters:configuratorAction<SpreadsheetExcelSettingsBuilder>

The action that configures the excel.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Excel(excel =&gt; excel
.ProxyURL(Url.Action("Index_Proxy", "Home"))
.ForceProxy(true)
)
)

HeaderHeight(double)

The height of the header row in pixels.

C#
public SpreadsheetBuilder HeaderHeight(double value)
Parameters:valuedouble

The value that configures the headerheight.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.HeaderHeight(50)
)

HeaderWidth(double)

The width of the header column in pixels.

C#
public SpreadsheetBuilder HeaderWidth(double value)
Parameters:valuedouble

The value that configures the headerwidth.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.HeaderWidth(100)
)

Images(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.

C#
public SpreadsheetBuilder Images(object value)
Parameters:valueobject

The value that configures the images.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Images(new { testImage = "../images/image1.png" })
)

Pdf(Action<SpreadsheetPdfSettingsBuilder>)

Configures the PDF export settings of the Spreadsheet.

C#
public SpreadsheetBuilder Pdf(Action<SpreadsheetPdfSettingsBuilder> configurator)
Parameters:configuratorAction<SpreadsheetPdfSettingsBuilder>

The action that configures the pdf.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Pdf(pdf =&gt; pdf
.ProxyURL(Url.Action("Index_Proxy", "Home"))
.ForceProxy(true)
)
)

RowHeight(double)

The default row height in pixels.

C#
public SpreadsheetBuilder RowHeight(double value)
Parameters:valuedouble

The value that configures the rowheight.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.RowHeight(30)
)

Rows(double)

The number of rows in the document.

C#
public SpreadsheetBuilder Rows(double value)
Parameters:valuedouble

The value that configures the rows.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Rows(50)
)

Sheets(Action<SpreadsheetSheetFactory>)

An array defining the document sheets and their content.

C#
public SpreadsheetBuilder Sheets(Action<SpreadsheetSheetFactory> configurator)
Parameters:configuratorAction<SpreadsheetSheetFactory>

The action that configures the sheets.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.Columns(columns =&gt;
{
columns.Add().Width(100);
})
.Rows(rows =&gt;
{
rows.Add().Height(70).Cells(cells =&gt;
{
cells.Add()
.Value("Invoice1")
.FontSize(22)
.Color("lightblue");
});
});
})
)

Sheetsbar(bool)

A Boolean value which indicates if the sheets-bar will be displayed.

C#
public SpreadsheetBuilder Sheetsbar(bool value)
Parameters:valuebool

The value that configures the sheetsbar.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheetsbar(false)
)

Toolbar(Action<SpreadsheetToolbarSettingsBuilder>)

Configures the toolbar tabs and the options within the tabs.

C#
public SpreadsheetBuilder Toolbar(Action<SpreadsheetToolbarSettingsBuilder> configurator)
Parameters:configuratorAction<SpreadsheetToolbarSettingsBuilder>

The action that configures the toolbar.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Toolbar(toolbar =&gt; toolbar.Home(false))
)

Toolbar(bool)

A Boolean value which indicates if the toolbar will be displayed.

C#
public SpreadsheetBuilder Toolbar(bool enabled)
Parameters:enabledbool

Enables or disables the toolbar option.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Toolbar(false)
)

UseCultureDecimals(bool)

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.

C#
public SpreadsheetBuilder UseCultureDecimals(bool value)
Parameters:valuebool

The value that configures the useculturedecimals.

Returns:

SpreadsheetBuilder

Example:
C#
@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.UseCultureDecimals(false)
)
In this article
DefinitionConstructorsSpreadsheetBuilder(Spreadsheet)MethodsActiveSheet(string)BindTo(Dictionary<string, object>)BindTo(IEnumerable<SpreadsheetSheet>)Columns(double)ColumnWidth(double)DefaultCellStyle(Action<SpreadsheetDefaultCellStyleSettingsBuilder>)Events(Action<SpreadsheetEventBuilder>)Excel(Action<SpreadsheetExcelSettingsBuilder>)HeaderHeight(double)HeaderWidth(double)Images(object)Pdf(Action<SpreadsheetPdfSettingsBuilder>)RowHeight(double)Rows(double)Sheets(Action<SpreadsheetSheetFactory>)Sheetsbar(bool)Toolbar(Action<SpreadsheetToolbarSettingsBuilder>)Toolbar(bool)UseCultureDecimals(bool)
Not finding the help you need?
Contact Support