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

WindowBuilder

Class

Defines the fluent interface for configuring the Window component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class WindowBuilder : WidgetBuilderBase<Window, WindowBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Window, WindowBuilder>WindowBuilder

Implements: IHtmlString

Methods

Actions(Action<WindowActionsBuilder>)

Configures the window buttons.

public WindowBuilder Actions(Action<WindowActionsBuilder> actionsBuilderAction)

Parameters:actionsBuilderActionAction<WindowActionsBuilder>

The buttons configuration action.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Actions(actions =&gt;
actions.Close()
)
)

Animation(Action<PopupAnimationBuilder>)

Configures the animation effects of the panelbar.

public WindowBuilder Animation(Action<PopupAnimationBuilder> animationAction)

Parameters:animationActionAction<PopupAnimationBuilder>

The action that configures the animation.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Animation(animation =&gt; animation.Close(close =&gt; close.Duration(600)))
)

Animation(bool)

Enables or disables the animation effects of the window.

public WindowBuilder Animation(bool enable)

Parameters:enablebool

If true, enables the window animation

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Animation(false)
)

AppendTo(string)

Defines a selector for the element to which the Window will be appended. By default this is the page body.

public WindowBuilder AppendTo(string selector)

Parameters:selectorstring

A selector of the Window container

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.AppendTo(".container")
)

AutoFocus(bool)

Sets whether the window automatically gains focus when opened.

public WindowBuilder AutoFocus(bool value)

Parameters:valuebool

If true, the Window is focused automatically when opened.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.AutoFocus(true)
)

Content(Action)

Sets the HTML content which the window should display.

public WindowBuilder Content(Action value)

Parameters:valueAction

The action which renders the content.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Content(() =&gt;
{

&lt;strong&gt;Window content&lt;/strong&gt;

})
)

Content(Func<object, object>)

Sets the HTML content which the window should display

public WindowBuilder Content(Func<object, object> value)

Parameters:valueFunc<object, object>

The Razor inline template

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Content(@&lt;strong&gt; Hello World!&lt;/strong&gt;))

Content(string)

Sets the HTML content which the item should display as a string.

public WindowBuilder Content(string value)

Parameters:valuestring

The action which renders the content.

Returns:

WindowBuilder

ContentSettings(Action<WindowContentBuilder>)

Configure how the window content is fetched, parsed, and rendered

public WindowBuilder ContentSettings(Action<WindowContentBuilder> action)

Parameters:actionAction<WindowContentBuilder>

The content settings action

Returns:

WindowBuilder

Draggable()

Sets whether the window can be moved.

public WindowBuilder Draggable()

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Draggable()
)

Draggable(Action<WindowDraggableSettingsBuilder>)

Configures the draggable settings.

public WindowBuilder Draggable(Action<WindowDraggableSettingsBuilder> draggableSettings)

Parameters:draggableSettingsAction<WindowDraggableSettingsBuilder>

The configurator for the draggable setting.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Draggable(settings =&gt;
settings.Containment("#containment").DragHandle("#handle")
)
)

Draggable(bool)

Sets whether the window can be moved.

public WindowBuilder Draggable(bool value)

Parameters:valueboolReturns:

WindowBuilder

Events(Action<WindowEventBuilder>)

Configures the client-side events.

public WindowBuilder Events(Action<WindowEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<WindowEventBuilder>

The client events action.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Events(events =&gt;
events.Open("onOpen").Close("onClose")
)
)

Height(int)

Sets the height of the window.

public WindowBuilder Height(int height)

Parameters:heightint

The height of the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Height(500)
)

Height(string)

Sets the height of the window.

public WindowBuilder Height(string height)

Parameters:heightstring

The height of the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Height("500")
)

Iframe(bool)

Explicitly specifies whether the loaded window content will be rendered as an iframe or in-line

public WindowBuilder Iframe(bool value)

Parameters:valuebool

If true, enables the iframe, otherwise disables it.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Iframe(true)
)

LoadContentFrom(RouteValueDictionary)

Sets the Url, which will be requested to return the content.

public WindowBuilder LoadContentFrom(RouteValueDictionary routeValues)

Parameters:routeValuesRouteValueDictionary

The route values of the Action method.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.LoadContentFrom(MVC.Home.Index().GetRouteValueDictionary());
)

LoadContentFrom(string, string, object)

Sets the Url, which will be requested to return the content.

public WindowBuilder LoadContentFrom(string actionName, string controllerName, object routeValues)

Parameters:actionNamestring

The action name.

controllerNamestring

The controller name.

routeValuesobject

Route values.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.LoadContentFrom("AjaxView_OpenSource", "Window", new { id = 10})
)

LoadContentFrom(string, string, RouteValueDictionary)

Sets the Url, which will be requested to return the content.

public WindowBuilder LoadContentFrom(string actionName, string controllerName, RouteValueDictionary routeValues)

Parameters:actionNamestring

The action name.

controllerNamestring

The controller name.

routeValuesRouteValueDictionary

Route values.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.LoadContentFrom("AjaxView_OpenSource", "Window", new RouteValueDictionary { { "param1", "1" }, { "param2", "2" } })
)

LoadContentFrom(string, string)

Sets the Url, which will be requested to return the content.

public WindowBuilder LoadContentFrom(string actionName, string controllerName)

Parameters:actionNamestring

The action name.

controllerNamestring

The controller name.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.LoadContentFrom("AjaxView_OpenSource", "Window")
)

LoadContentFrom(string)

Sets the Url, which will be requested to return the content.

public WindowBuilder LoadContentFrom(string value)

Parameters:valuestring

The url.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.LoadContentFrom(Url.Action("AjaxView_OpenSource", "Window"))
)

Modal(Action<WindowModalSettingsBuilder>)

Specifies whether the dialog should show a modal overlay over the page.

public WindowBuilder Modal(Action<WindowModalSettingsBuilder> configurator)

Parameters:configuratorAction<WindowModalSettingsBuilder>

The action that configures the modal.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Modal(m =&gt; m.PreventScroll(true))
)

Modal(bool)

Sets whether the window should be modal or not.

public WindowBuilder Modal(bool modal)

Parameters:modalbool

If true, makes the window modal.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Modal(true)
)

Pinned()

Sets whether the window is pinned.

public WindowBuilder Pinned()

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Pinned()
)

Pinned(bool)

Sets whether the window is pinned.

public WindowBuilder Pinned(bool value)

Parameters:valuebool

If true, pins the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Pinned(true)
)

Position(Action<WindowPositionSettingsBuilder>)

Configures the position of the window.

public WindowBuilder Position(Action<WindowPositionSettingsBuilder> positionSettingsAction)

Parameters:positionSettingsActionAction<WindowPositionSettingsBuilder>

Position settings action.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Position(settings =&gt;
settings.Top(100).Left(100)
)
)

Resizable()

Enables windows resizing.

public WindowBuilder Resizable()

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Resizable()
)

Resizable(Action<WindowResizingSettingsBuilder>)

Configures the resizing ability of the window.

public WindowBuilder Resizable(Action<WindowResizingSettingsBuilder> resizingSettingsAction)

Parameters:resizingSettingsActionAction<WindowResizingSettingsBuilder>

Resizing settings action.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Resizable(settings =&gt;
settings.Enabled(true).MaxHeight(500).MaxWidth(500)
)
)

Scrollable(bool)

Sets whether the window should have scrollbars.

public WindowBuilder Scrollable(bool scrollable)

Parameters:scrollablebool

If true, enables scrolling in the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Scrollable(true)
)

Size(string)

Set predefined size to the window. The width and height configuration options override the predefined size.Possible values are: auto; small; medium or large.

public WindowBuilder Size(string value)

Parameters:valuestring

The value that configures the size.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Size("small")
)

Title(Action<WindowTitleSettingsBuilder>)

The text in the window title bar. If false, the window will be displayed without a title bar. Note that this will prevent the window from being dragged, and the window titlebar buttons will not be shown.

public WindowBuilder Title(Action<WindowTitleSettingsBuilder> titleSettings)

Parameters:titleSettingsAction<WindowTitleSettingsBuilder>

The configurator for the title setting.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Title(t =&gt; t.Text("My Title"))
)

Title(bool)

Allows title to be shown / hidden

public WindowBuilder Title(bool show)

Parameters:showbool

If true, a title is shown.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Title(true)
)

Title(string)

Sets title, which appears in the header of the window.

public WindowBuilder Title(string title)

Parameters:titlestring

The title.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Title("My title")
)

Visible(bool)

Sets whether the window should be rendered visible.

public WindowBuilder Visible(bool visible)

Parameters:visiblebool

If true, the window is initially visible, otherwise it is hidden.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Visible(true)
)

Width(int)

Sets the width of the window.

public WindowBuilder Width(int width)

Parameters:widthint

The width of the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Width(600)
)

Width(string)

Sets the width of the window.

public WindowBuilder Width(string width)

Parameters:widthstring

The width of the window.

Returns:

WindowBuilder

Example:

@(Html.Kendo().Window()
.Name("Window")
.Width("600")
)