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

DialogBuilder

Class

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

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class DialogBuilder : WidgetBuilderBase<Dialog, DialogBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Dialog, DialogBuilder>DialogBuilder

Implements: IHtmlString

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

Constructors

DialogBuilder(Dialog)

Initializes a new instance of the Dialog class.

C#
public DialogBuilder(Dialog component)
Parameters:componentDialog

The component.

Methods

Actions(Action<DialogActionFactory>)

A collection of objects containing text, action and primary attributes used to specify the dialog buttons.

C#
public DialogBuilder Actions(Action<DialogActionFactory> configurator)
Parameters:configuratorAction<DialogActionFactory>

The action that configures the actions.

Returns:

DialogBuilder

Animation(Action<PopupAnimationBuilder>)

A collection of {Animation} objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.

C#
public DialogBuilder Animation(Action<PopupAnimationBuilder> configurator)
Parameters:configuratorAction<PopupAnimationBuilder>

The action that configures the animation.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Animation(animation =&gt; animation.Open(open =&gt; open.Duration(700)))
)

Animation(bool)

A collection of {Animation} objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.

C#
public DialogBuilder Animation(bool enabled)
Parameters:enabledbool

Enables or disables the animation option.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Animation(false)
)

ButtonLayout(string)

Specifies the possible layout of the action buttons in the Dialog.Note: Stretched layout has no effect in browsers, like IE9, that do not support flexbox. Possible values are: normal or stretched.

C#
public DialogBuilder ButtonLayout(string value)
Parameters:valuestring

The value that configures the buttonlayout.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Actions(actions =&gt;
{
actions.Add().Text("Remind me later").Primary(true);
actions.Add().Text("Cancel");
})
.ButtonLayout("normal")
)

Closable(bool)

Specifies whether a close button should be rendered at the top corner of the dialog.

C#
public DialogBuilder Closable(bool value)
Parameters:valuebool

The value that configures the closable.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Closable(true)
)

Content(Action)

Sets the HTML content which the window should display.

C#
public DialogBuilder Content(Action value)
Parameters:valueAction

The action which renders the content.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("dialog")
.Content(() =&gt;
{
&lt;strong&gt;Dialog content&lt;/strong&gt;
})
)

Content(Func<object, object>)

Sets the HTML content which the dialog should display

C#
public DialogBuilder Content(Func<object, object> value)
Parameters:valueFunc<object, object>

The Razor inline template

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("dialog")
.Dialog(@&lt;strong&gt; Hello World!&lt;/strong&gt;))

Content(string)

The content of the dialog

C#
public DialogBuilder Content(string value)
Parameters:valuestring

The value that configures the content.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
)

Events(Action<DialogEventBuilder>)

Configures the client-side events.

C#
public DialogBuilder Events(Action<DialogEventBuilder> configurator)
Parameters:configuratorAction<DialogEventBuilder>

The client events action.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Events(events =&gt; events
.Close("onClose")
)
)

Height(double)

Specifies height of the dialog.

C#
public DialogBuilder Height(double value)
Parameters:valuedouble

The value that configures the height.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Height(300)
)

Height(string)

Specifies height of the dialog.

C#
public DialogBuilder Height(string value)
Parameters:valuestring

The value that configures the height.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Height("300px")
)

MaxHeight(double)

The maximum height (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MaxHeight(double value)
Parameters:valuedouble

The value that configures the maxheight.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MaxHeight(500))
)

MaxHeight(string)

The maximum height (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MaxHeight(string value)
Parameters:valuestring

The value that configures the maxheight.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MaxHeight("500px"))
)

MaxWidth(double)

The maximum width (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MaxWidth(double value)
Parameters:valuedouble

The value that configures the maxwidth.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MaxWidth(800))
)

MaxWidth(string)

The maximum width (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MaxWidth(string value)
Parameters:valuestring

The value that configures the maxwidth.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MaxWidth("800px"))
)

Messages(Action<DialogMessagesSettingsBuilder>)

Defines the text of the labels that are shown within the dialog. Used primarily for localization.

C#
public DialogBuilder Messages(Action<DialogMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<DialogMessagesSettingsBuilder>

The action that configures the messages.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Messages(m =&gt; m.Close("Close the dialog"))
)

MinHeight(double)

The minimum height (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MinHeight(double value)
Parameters:valuedouble

The value that configures the minheight.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MinHeight(300))
)

MinHeight(string)

The minimum height (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MinHeight(string value)
Parameters:valuestring

The value that configures the minheight.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MinHeight("300px"))
)

MinWidth(double)

The minimum width (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MinWidth(double value)
Parameters:valuedouble

The value that configures the minwidth.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MinWidth(400))
)

MinWidth(string)

The minimum width (in pixels) that may be achieved by resizing the window.

C#
public DialogBuilder MinWidth(string value)
Parameters:valuestring

The value that configures the minwidth.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Window()
.Name("window")
.Visible(true)
.Content("Window Content")
.Resizable(r =&gt; r.MinWidth("400px"))
)

Modal(Action<DialogModalSettingsBuilder>)

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

C#
public DialogBuilder Modal(Action<DialogModalSettingsBuilder> configurator)
Parameters:configuratorAction<DialogModalSettingsBuilder>

The action that configures additional modality settings.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Modal(modal =&gt; modal.PreventScroll(true))
)

Modal(bool)

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

C#
public DialogBuilder Modal(bool enabled)
Parameters:enabledbool

Enables or disables the modal option.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Modal(true)
)

Size(string)

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

C#
public DialogBuilder Size(string value)
Parameters:valuestring

The value that configures the size.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Size("small")
)

Title(bool)

Specifies whether the dialog title will be initially visible.

C#
public DialogBuilder Title(bool show)
Parameters:showbool

The value that configures the visibility of the title.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Title(false)
)

Title(string)

The text in the dialog title bar. If false, the dialog will be displayed without a title bar.

C#
public DialogBuilder Title(string value)
Parameters:valuestring

The value that configures the title of the dialog.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Title("Dialog title")
)

Visible(bool)

Specifies whether the dialog will be initially visible.

C#
public DialogBuilder Visible(bool value)
Parameters:valuebool

If true, the dialog will be initially visible.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
)

Width(double)

Specifies width of the dialog.

C#
public DialogBuilder Width(double value)
Parameters:valuedouble

The value that configures the width.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Width(500)
)

Width(string)

Specifies width of the dialog.

C#
public DialogBuilder Width(string value)
Parameters:valuestring

The value that configures the width.

Returns:

DialogBuilder

Example:
C#
@(Html.Kendo().Dialog()
.Name("Dialog")
.Visible(true)
.Content("Dialog content")
.Width("500px")
)
In this article
DefinitionConstructorsDialogBuilder(Dialog)MethodsActions(Action<DialogActionFactory>)Animation(Action<PopupAnimationBuilder>)Animation(bool)ButtonLayout(string)Closable(bool)Content(Action)Content(Func<object, object>)Content(string)Events(Action<DialogEventBuilder>)Height(double)Height(string)MaxHeight(double)MaxHeight(string)MaxWidth(double)MaxWidth(string)Messages(Action<DialogMessagesSettingsBuilder>)MinHeight(double)MinHeight(string)MinWidth(double)MinWidth(string)Modal(Action<DialogModalSettingsBuilder>)Modal(bool)Size(string)Title(bool)Title(string)Visible(bool)Width(double)Width(string)
Not finding the help you need?
Contact Support