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

PromptBoxBuilder

Class

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

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class PromptBoxBuilder : WidgetBuilderBase<PromptBox, PromptBoxBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<PromptBox, PromptBoxBuilder>PromptBoxBuilder

Implements: IHtmlString

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

Constructors

PromptBoxBuilder(PromptBox)

Initializes a new instance of the PromptBox class.

C#
public PromptBoxBuilder(PromptBox component)
Parameters:componentPromptBox

The component.

Methods

ActionButton(Action<PromptBoxActionButtonSettingsBuilder>)

Configures the Action button (send/stop) in the end affix. The button is always visible. When null or not configured, the button is enabled by default. Use { enable: false } to disable it.

C#
public PromptBoxBuilder ActionButton(Action<PromptBoxActionButtonSettingsBuilder> configurator)
Parameters:configuratorAction<PromptBoxActionButtonSettingsBuilder>

The action that configures the actionbutton.

Returns:

PromptBoxBuilder

Enable(bool)

If set to false, the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.

C#
public PromptBoxBuilder Enable(bool value)
Parameters:valuebool

The value that configures the enable.

Returns:

PromptBoxBuilder

EndAffixTemplate<TModel>(TemplateBuilder<TModel>)

Defines a custom template for the end affix area. The end affix is positioned after the input field and typically contains action buttons.

C#
public PromptBoxBuilder EndAffixTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the endaffixtemplate.

Returns:

PromptBoxBuilder

EndAffixTemplateHandler(string)

Defines a custom template for the end affix area. The end affix is positioned after the input field and typically contains action buttons.

C#
public PromptBoxBuilder EndAffixTemplateHandler(string value)
Parameters:valuestring

The value that configures the endaffixtemplate.

Returns:

PromptBoxBuilder

Events(Action<PromptBoxEventBuilder>)

Configures the client-side events.

C#
public PromptBoxBuilder Events(Action<PromptBoxEventBuilder> configurator)
Parameters:configuratorAction<PromptBoxEventBuilder>

The client events action.

Returns:

PromptBoxBuilder

Example:
C#
@(Html.Kendo().PromptBox()
.Name("PromptBox")
.Events(events =&gt; events
.Blur("onBlur")
)
)

FileSelectButton()

Controls the visibility and configuration of the File Select button in the end affix. When enabled, users can attach files to their prompts.

C#
public PromptBoxBuilder FileSelectButton()
Returns:

PromptBoxBuilder

FileSelectButton(Action<PromptBoxFileSelectButtonSettingsBuilder>)

Controls the visibility and configuration of the File Select button in the end affix. When enabled, users can attach files to their prompts.

C#
public PromptBoxBuilder FileSelectButton(Action<PromptBoxFileSelectButtonSettingsBuilder> configurator)
Parameters:configuratorAction<PromptBoxFileSelectButtonSettingsBuilder>

The action that configures the fileselectbutton.

Returns:

PromptBoxBuilder

FileSelectButton(bool)

Controls the visibility and configuration of the File Select button in the end affix. When enabled, users can attach files to their prompts.

C#
public PromptBoxBuilder FileSelectButton(bool enabled)
Parameters:enabledbool

Enables or disables the fileselectbutton option.

Returns:

PromptBoxBuilder

FillMode(FillMode)

Defines the fill mode for the PromptBox container.

C#
public PromptBoxBuilder FillMode(FillMode value)
Parameters:valueFillMode

The value that configures the fillmode.

Returns:

PromptBoxBuilder

Loading(bool)

Sets the loading state of the Action button. When true, the button displays a stop icon and allows users to cancel ongoing generation.

C#
public PromptBoxBuilder Loading(bool value)
Parameters:valuebool

The value that configures the loading.

Returns:

PromptBoxBuilder

MaxTextAreaHeight(double)

Sets the maximum height of the textarea in pixels. The textarea resizes automatically until it reaches this height. When the content exceeds this height, a scrollbar appears.

C#
public PromptBoxBuilder MaxTextAreaHeight(double value)
Parameters:valuedouble

The value that configures the maxtextareaheight.

Returns:

PromptBoxBuilder

Messages(Action<PromptBoxMessagesSettingsBuilder>)

Defines the localization messages for the PromptBox.

C#
public PromptBoxBuilder Messages(Action<PromptBoxMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<PromptBoxMessagesSettingsBuilder>

The action that configures the messages.

Returns:

PromptBoxBuilder

Mode(PromptBoxMode)

Sets the mode of the PromptBox. Available options are "single", "multi", and "auto". single - Displays a single-line input field; multi - Displays a multi-line textarea with configurable rows or auto - Starts as a single line and expands automatically as the user types.

C#
public PromptBoxBuilder Mode(PromptBoxMode value)
Parameters:valuePromptBoxMode

The value that configures the mode.

Returns:

PromptBoxBuilder

Placeholder(string)

Sets the placeholder text displayed in the PromptBox when it is empty.

C#
public PromptBoxBuilder Placeholder(string value)
Parameters:valuestring

The value that configures the placeholder.

Returns:

PromptBoxBuilder

Readonly(bool)

Sets the read-only state of the PromptBox. When set to true, the PromptBox content cannot be modified but remains accessible.

C#
public PromptBoxBuilder Readonly(bool value)
Parameters:valuebool

The value that configures the readonly.

Returns:

PromptBoxBuilder

Rows(double)

Sets the number of visible text lines in the textarea. Applies only when the mode is set to "multi".

C#
public PromptBoxBuilder Rows(double value)
Parameters:valuedouble

The value that configures the rows.

Returns:

PromptBoxBuilder

SpeechToTextButton(Action<PromptBoxSpeechToTextButtonSettingsBuilder>)

Configures the Speech to Text button in the end affix. The button is always visible. When null or not configured, the button is enabled by default. Use { enable: false } to disable it.

C#
public PromptBoxBuilder SpeechToTextButton(Action<PromptBoxSpeechToTextButtonSettingsBuilder> configurator)
Parameters:configuratorAction<PromptBoxSpeechToTextButtonSettingsBuilder>

The action that configures the speechtotextbutton.

Returns:

PromptBoxBuilder

SpeechToTextButton(bool)

Configures the Speech to Text button in the end affix. The button is always visible. When null or not configured, the button is enabled by default. Use { enable: false } to disable it.

C#
public PromptBoxBuilder SpeechToTextButton(bool enabled)
Parameters:enabledbool

Enables or disables the speechtotextbutton option.

Returns:

PromptBoxBuilder

StartAffixTemplate<TModel>(TemplateBuilder<TModel>)

Defines a custom template for the start affix area. The start affix is positioned before the input field.

C#
public PromptBoxBuilder StartAffixTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the startaffixtemplate.

Returns:

PromptBoxBuilder

StartAffixTemplateHandler(string)

Defines a custom template for the start affix area. The start affix is positioned before the input field.

C#
public PromptBoxBuilder StartAffixTemplateHandler(string value)
Parameters:valuestring

The value that configures the startaffixtemplate.

Returns:

PromptBoxBuilder

Title(string)

Sets the title attribute of the input or textarea element.

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

The value that configures the title.

Returns:

PromptBoxBuilder

TopAffixTemplate<TModel>(TemplateBuilder<TModel>)

Defines a custom template for the top affix area. The top affix is positioned at the top of the content area in multi-line mode only.

C#
public PromptBoxBuilder TopAffixTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the topaffixtemplate.

Returns:

PromptBoxBuilder

TopAffixTemplateHandler(string)

Defines a custom template for the top affix area. The top affix is positioned at the top of the content area in multi-line mode only.

C#
public PromptBoxBuilder TopAffixTemplateHandler(string value)
Parameters:valuestring

The value that configures the topaffixtemplate.

Returns:

PromptBoxBuilder

Value(string)

Sets the value of the PromptBox.

C#
public PromptBoxBuilder Value(string value)
Parameters:valuestring

The value that configures the value.

Returns:

PromptBoxBuilder

In this article
DefinitionConstructorsPromptBoxBuilder(PromptBox)MethodsActionButton(Action<PromptBoxActionButtonSettingsBuilder>)Enable(bool)EndAffixTemplate<TModel>(TemplateBuilder<TModel>)EndAffixTemplateHandler(string)Events(Action<PromptBoxEventBuilder>)FileSelectButton()FileSelectButton(Action<PromptBoxFileSelectButtonSettingsBuilder>)FileSelectButton(bool)FillMode(FillMode)Loading(bool)MaxTextAreaHeight(double)Messages(Action<PromptBoxMessagesSettingsBuilder>)Mode(PromptBoxMode)Placeholder(string)Readonly(bool)Rows(double)SpeechToTextButton(Action<PromptBoxSpeechToTextButtonSettingsBuilder>)SpeechToTextButton(bool)StartAffixTemplate<TModel>(TemplateBuilder<TModel>)StartAffixTemplateHandler(string)Title(string)TopAffixTemplate<TModel>(TemplateBuilder<TModel>)TopAffixTemplateHandler(string)Value(string)
Not finding the help you need?
Contact Support