New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

SpreadsheetSheetBuilder

Class

Defines the fluent API for configuring the SpreadsheetSheet settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class SpreadsheetSheetBuilder

Inheritance: objectSpreadsheetSheetBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SpreadsheetSheetBuilder(SpreadsheetSheet, Spreadsheet)

public SpreadsheetSheetBuilder(SpreadsheetSheet settings, Spreadsheet widget)

Parameters:settingsSpreadsheetSheetwidgetSpreadsheet

Methods

ActiveCell(string)

The active cell in the sheet, for example, A1.

public SpreadsheetSheetBuilder ActiveCell(string value)

Parameters:valuestring

The value that configures the activecell.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.ActiveCell("D4");
})
)

Columns(Action<SpreadsheetSheetColumnFactory>)

An array which defines the columns in this sheet and their content.

public SpreadsheetSheetBuilder Columns(Action<SpreadsheetSheetColumnFactory> configurator)

Parameters:configuratorAction<SpreadsheetSheetColumnFactory>

The action that configures the columns.

Returns:

SpreadsheetSheetBuilder

DataSource<T>(Action<DataSourceBuilder<T>>)

Sets the data source configuration of the grid.

public SpreadsheetSheetBuilder DataSource<T>(Action<DataSourceBuilder<T>> configurator) where T : class

Parameters:configuratorAction<DataSourceBuilder<T>>

The lambda which configures the data source

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Products")
.DataSource&lt;SpreadsheetProductViewModel&gt;(ds =&gt; ds
.Custom()
.Batch(true)
.Transport(t =&gt; t
.Read("onRead")
.Submit("onSubmit")
)
.Events(e =&gt; e.Change("onChange"))
.Schema(s =&gt; s
.Model(m =&gt;
{
m.Id(p =&gt; p.ProductID);
})
)
)
})
)

Drawings(Action<SpreadsheetSheetDrawingFactory>)

An array which contains the drawings used in this sheet.

public SpreadsheetSheetBuilder Drawings(Action<SpreadsheetSheetDrawingFactory> configurator)

Parameters:configuratorAction<SpreadsheetSheetDrawingFactory>

The action that configures the drawings.

Returns:

SpreadsheetSheetBuilder

Filter(Action<SpreadsheetSheetFilterSettingsBuilder>)

Defines the filtering criteria for this sheet, if any.

public SpreadsheetSheetBuilder Filter(Action<SpreadsheetSheetFilterSettingsBuilder> configurator)

Parameters:configuratorAction<SpreadsheetSheetFilterSettingsBuilder>

The action that configures the filter.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.Filter(filter =&gt; filter.Columns(col =&gt; col.ValueFilter(vf =&gt; vf.Index(1))));
})
)

FrozenColumns(int)

The number of frozen columns in this sheet.

public SpreadsheetSheetBuilder FrozenColumns(int value)

Parameters:valueint

The value that configures the frozencolumns.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.FrozenColumns(2);
})
)

FrozenRows(int)

The number of frozen rows in this sheet.

public SpreadsheetSheetBuilder FrozenRows(int value)

Parameters:valueint

The value that configures the frozenrows.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.FrozenRows(10);
})
)

MergedCells(params string[])

An array of merged cell ranges, for example, B1:D2.

public SpreadsheetSheetBuilder MergedCells(params string[] value)

Parameters:valuestring[]

The value that configures the mergedcells.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.MergedCells("A1:G1", "C15:E15");
})
)

Name(string)

The name of the sheet.

public SpreadsheetSheetBuilder Name(string value)

Parameters:valuestring

The value that configures the name.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order");
})
)

Rows(Action<SpreadsheetSheetRowFactory>)

The row data for this sheet.

public SpreadsheetSheetBuilder Rows(Action<SpreadsheetSheetRowFactory> configurator)

Parameters:configuratorAction<SpreadsheetSheetRowFactory>

The action that configures the rows.

Returns:

SpreadsheetSheetBuilder

Selection(string)

The selected range in the sheet, for example, A1:B10.

public SpreadsheetSheetBuilder Selection(string value)

Parameters:valuestring

The value that configures the selection.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.Selection("D4");
})
)

ShowGridLines(bool)

A Boolean value which indicates if the grid lines of the sheet will be displayed.

public SpreadsheetSheetBuilder ShowGridLines(bool value)

Parameters:valuebool

The value that configures the showgridlines.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.ShowGridLines(false);
})
)

Sort(Action<SpreadsheetSheetSortSettingsBuilder>)

Defines the sort criteria for the sheet.

public SpreadsheetSheetBuilder Sort(Action<SpreadsheetSheetSortSettingsBuilder> configurator)

Parameters:configuratorAction<SpreadsheetSheetSortSettingsBuilder>

The action that configures the sort.

Returns:

SpreadsheetSheetBuilder

Example:

@( Html.Kendo().Spreadsheet()
.Name("spreadsheet")
.Sheets(sheets =&gt;
{
sheets.Add()
.Name("Food Order")
.Sort(sort =&gt; sort.Columns(cols =&gt; cols.Add().Ascending(true)));
})
)