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

SortableBuilder

Class

Defines the fluent interface for configuring the Sortable component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class SortableBuilder : IHtmlString

Inheritance: objectSortableBuilder

Implements: IHtmlString

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

Constructors

SortableBuilder(Sortable)

Initializes a new instance of the SortableBuilder class.

C#
public SortableBuilder(Sortable component)
Parameters:componentSortable

The component.

Methods

AutoScroll(bool)

If set to true the component will auto-scroll the container when the mouse/finger is close to the top/bottom of it.

C#
public virtual SortableBuilder AutoScroll(bool value)
Parameters:valueboolReturns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.AutoScroll(true)
)

Axis(SortableAxis)

Constrains the hint movement to either the horizontal (x) or vertical (y) axis.

C#
public virtual SortableBuilder Axis(SortableAxis axis)
Parameters:axisSortableAxis

The axis

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Axis(SortableAxis.Y)
)

ConnectWith(string)

The selector which determines if items from the current Sortable component can be accepted from another Sortable container(s). The connectWith option describes one way relationship, if the developer wants a two way connection then the connectWith option should be set on both components.

C#
public virtual SortableBuilder ConnectWith(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.ConnectWith("#element2")
)

ContainerSelector(string)

Selector that determines the container boundaries in which hint movement will be constrained to.

C#
public virtual SortableBuilder ContainerSelector(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.ContainerSelector("#element2")
)

Cursor(string)

The CSS style which determines the cursor that will be shown while user drags sortable item. For example 'move', 'pointer', etc.

C#
public virtual SortableBuilder Cursor(string cursor)
Parameters:cursorstring

String

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Cursor("pointer")
)

CursorOffset(Action<SortableCursorOffsetSettingsBuilder>)

Configures the cursor offset of Sortable component.

C#
public virtual SortableBuilder CursorOffset(Action<SortableCursorOffsetSettingsBuilder> cursorOffsetSettingsAction)
Parameters:cursorOffsetSettingsActionAction<SortableCursorOffsetSettingsBuilder>

Cursor offset settings action.

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.CursorOffset(co =&gt; co.Top(12))
)

Deferred()

Suppress initialization script rendering. Note that this options should be used in conjunction with WidgetFactory.DeferredScripts(bool)

C#
public virtual SortableBuilder Deferred()
Returns:

SortableBuilder

Disabled(string)

The selector that determines which items are disabled. Disabled items cannot be dragged but are valid sort targets.

C#
public virtual SortableBuilder Disabled(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Disabled("#element2")
)

Events(Action<SortableEventBuilder>)

Sets the event configuration of the Sortable.

C#
public SortableBuilder Events(Action<SortableEventBuilder> configurator)
Parameters:configuratorAction<SortableEventBuilder>

The lambda which configures the events

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Events(events =&gt; events.Start("start"))
)

Filter(string)

The selector that determines which items are sortable. Filtered items cannot be dragged and are not valid sort targets.

C#
public virtual SortableBuilder Filter(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Filter("#element2")
)

For(string)

The selector to match the DOM element to which the Sortable component will be instantiated

C#
public virtual SortableBuilder For(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
)

Handler(string)

The selector that determines which element will be used as a draggable handler.

C#
public virtual SortableBuilder Handler(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Handler("#element2")
)

Hint(string)

HTML string representing the hint element

C#
public virtual SortableBuilder Hint(string content)
Parameters:contentstring

Html string

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Hint("content")
)

HintHandler(Func<object, object>)

Sets JavaScript function which to return the hint for the sorted item.

C#
public virtual SortableBuilder HintHandler(Func<object, object> handler)
Parameters:handlerFunc<object, object>

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

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.HintHandler(@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
)
)

HintHandler(string)

Sets JavaScript function which to return the hint for the sorted item.

C#
public virtual SortableBuilder HintHandler(string handler)
Parameters:handlerstring

JavaScript function name

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.HintHandler("handler")
)

HoldToDrag(bool)

When set to true, the item will be activated after the user taps and holds the finger on the element for a short amount of time.

C#
public virtual SortableBuilder HoldToDrag(bool value)
Parameters:valueboolReturns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.HoldToDrag(true)
)

Ignore(string)

The selector which determines child elements for which the sort will not be initiated. Useful if the sortable item contains input elements.

C#
public virtual SortableBuilder Ignore(string selector)
Parameters:selectorstring

jQuery selector

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Ignore("#element2")
)

Placeholder(string)

HTML string representing the placeholder

C#
public virtual SortableBuilder Placeholder(string content)
Parameters:contentstring

Html string

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.Placeholder("content")
)

PlaceholderHandler(Func<object, object>)

Sets JavaScript function which to return the placeholder for the sorted item.

C#
public virtual SortableBuilder PlaceholderHandler(Func<object, object> handler)
Parameters:handlerFunc<object, object>

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

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.PlaceholderHandler(@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
)
)

PlaceholderHandler(string)

Sets JavaScript function which to return the placeholder for the sorted item.

C#
public virtual SortableBuilder PlaceholderHandler(string handler)
Parameters:handlerstring

JavaScript function name

Returns:

SortableBuilder

Example:
C#
@(Html.Kendo().Sortable()
.For("#element")
.PlaceholderHandler("handler")
)

Render()

Renders the component.

C#
public virtual void Render()

ToClientTemplate()

C#
public MvcHtmlString ToClientTemplate()
Returns:

MvcHtmlString

ToComponent()

Returns the internal view component.

C#
public Sortable ToComponent()
Returns:

Sortable

ToHtmlString()

C#
public string ToHtmlString()
Returns:

string

ToString()

C#
public override string ToString()
Returns:

string

Overrides: object.ToString()

Operators

implicit operator Sortable(SortableBuilder)

C#
public static implicit operator Sortable(SortableBuilder builder)
Parameters:builderSortableBuilderReturns:

Sortable

In this article
DefinitionConstructorsSortableBuilder(Sortable)MethodsAutoScroll(bool)Axis(SortableAxis)ConnectWith(string)ContainerSelector(string)Cursor(string)CursorOffset(Action<SortableCursorOffsetSettingsBuilder>)Deferred()Disabled(string)Events(Action<SortableEventBuilder>)Filter(string)For(string)Handler(string)Hint(string)HintHandler(Func<object, object>)HintHandler(string)HoldToDrag(bool)Ignore(string)Placeholder(string)PlaceholderHandler(Func<object, object>)PlaceholderHandler(string)Render()ToClientTemplate()ToComponent()ToHtmlString()ToString()Operatorsimplicit operator Sortable(SortableBuilder)
Not finding the help you need?
Contact Support