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

GridEditingSettingsBuilder<T>

Class

Defines the fluent interface for configuring grid editing.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

Syntax:

public class GridEditingSettingsBuilder<T> where T : class

Inheritance: objectGridEditingSettingsBuilder<T>

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

Constructors

GridEditingSettingsBuilder(GridEditableSettings<T>)

Initializes a new instance of the GridEditingSettingsBuilder<T> class.

public GridEditingSettingsBuilder(GridEditableSettings<T> settings)

Parameters:settingsGridEditableSettings<T>

The settings.

Methods

AdditionalViewData(object)

Provides additional view data in the editor template.

public GridEditingSettingsBuilder<T> AdditionalViewData(object additionalViewData)

Parameters:additionalViewDataobject

An anonymous object which contains the additional data

Returns:

GridEditingSettingsBuilder<T>

The additional view data will be provided if the editing mode is set to in-form or popup. For other editing modes use EditorViewData(object)

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(editing =&gt; editing.AdditionalViewData(new { customers = Model.Customers }))
)

CancelDelete(string)

Change default text for cancel delete button. Note: Available only on mobile devices.

public GridEditingSettingsBuilder<T> CancelDelete(string text)

Parameters:textstring

The text for the CancelDelete action.

Returns:

GridEditingSettingsBuilder<T>

Available only on mobile devices.

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.CancelDelete("No"))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

ConfirmDelete(string)

Change default text for confirm delete button. Note: Available only on mobile devices.

public GridEditingSettingsBuilder<T> ConfirmDelete(string text)

Parameters:textstring

The text for the ConfirmDelete action.

Returns:

GridEditingSettingsBuilder<T>

Available only on mobile devices.

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.ConfirmDelete("Yes"))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

CreateAt(GridInsertRowPosition)

Sets insert row position.

public GridEditingSettingsBuilder<T> CreateAt(GridInsertRowPosition position)

Parameters:positionGridInsertRowPosition

The position of the row inserted.

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.CreateAt(GridInsertRowPosition.Bottom))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

DisplayDeleteConfirmation(bool)

Enables or disables delete confirmation.

public GridEditingSettingsBuilder<T> DisplayDeleteConfirmation(bool value)

Parameters:valuebool

The boolean value for displaying a delete confirmation message.

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.DisplayDeleteConfirmation(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

DisplayDeleteConfirmation(Func<object, object>)

Displays a message in the delete confirmation dialog.

public GridEditingSettingsBuilder<T> DisplayDeleteConfirmation(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag (Razor syntax)

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;Order&gt;()
.Name("Orders")
.Editable(settings =&gt; settings.DisplayDeleteConfirmation(
@&lt;text&gt;
function(e) {
//handling code
}
&lt;/text&gt;
))
)

DisplayDeleteConfirmation(string)

Displays a message in the delete confirmation dialog.

public GridEditingSettingsBuilder<T> DisplayDeleteConfirmation(string message)

Parameters:messagestring

The message

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;Order&gt;()
.Name("Orders")
.Editable(settings =&gt; settings.DisplayDeleteConfirmation("Delete record"))
)

Enabled(bool)

Enables or disables grid editing.

public GridEditingSettingsBuilder<T> Enabled(bool value)

Parameters:valuebool

The boolean value for enabling or disabling the grid editing.

Returns:

GridEditingSettingsBuilder<T>

The Enabled method is useful when you need to enable grid editing on certain conditions.

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.Enabled(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Mode(GridEditMode)

Sets the Edit Mode for a Grid.

public GridEditingSettingsBuilder<T> Mode(GridEditMode mode)

Parameters:modeGridEditMode

The grid edit Mode.

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(e =&gt; e.Mode(GridEditMode.InCell))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.Model(m =&gt; m.Id(o =&gt; o.OrderID))
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
.Update(u =&gt; u.Action("Update", "Grid"))
)
)

Readonly(bool)

Places the component in a Readonly or Editable mode.

public GridEditingSettingsBuilder<T> Readonly(bool value)

Parameters:valuebool

The boolean value for placing the component in a Readonly or Editable mode.

Returns:

GridEditingSettingsBuilder<T>

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(settings =&gt; settings.Readonly(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

TemplateComponentName(string)

Specifies the name of the template component to be used in PopUp edit mode.

public GridEditingSettingsBuilder<T> TemplateComponentName(string templateName)

Parameters:templateNamestring

The name of the template component.

Returns:

GridEditingSettingsBuilder<T>

This setting is applicable only when Mode is PopUp

TemplateName(string)

Specify an editor template to be used in PopUp edit mode.

public GridEditingSettingsBuilder<T> TemplateName(string templateName)

Parameters:templateNamestring

The name of the editor template.

Returns:

GridEditingSettingsBuilder<T>

This settings is applicable only when Mode is PopUp

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.Scrollable()
.Editable(e =&gt; e.Mode(GridEditMode.PopUp).TemplateName("EditorTemplateName"))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.Model(m =&gt; m.Id(o =&gt; o.OrderID))
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
.Update(u =&gt; u.Action("Update", "Grid"))
)
)

Window(Action<WindowBuilder>)

Configures the popup editing window.

public GridEditingSettingsBuilder<T> Window(Action<WindowBuilder> configurator)

Parameters:configuratorAction<WindowBuilder>

The configurator for the popup window.

Returns:

GridEditingSettingsBuilder<T>

The GridEditingSettingsBuilder<T> instance.