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

Defines the fluent API for configuring GridSmartBoxSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

Syntax:

C#
public class GridSmartBoxSettingsBuilder<T> where T : class

Inheritance: objectGridSmartBoxSettingsBuilder<T>

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

Constructors

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

C#
public GridSmartBoxSettingsBuilder(GridSmartBoxSettings<T> container)
Parameters:containerGridSmartBoxSettings<T>

Properties

Gets the container settings.

C#
protected GridSmartBoxSettings<T> Container { get; }

Methods

Defines the active mode of the SmartBox.

C#
public GridSmartBoxSettingsBuilder<T> ActiveMode(SmartBoxActiveMode value)
Parameters:valueSmartBoxActiveMode

The value for ActiveMode

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Configures the initial settings for the AI Assistant mode.

C#
public GridSmartBoxSettingsBuilder<T> AiAssistantSettings(Action<GridSmartBoxAiAssistantSettingsSettingsBuilder<T>> configurator)
Parameters:configuratorAction<GridSmartBoxAiAssistantSettingsSettingsBuilder<T>>

The GridSmartBoxAiAssistantSettingsSettingsBuilder<T> for the aiassistantsettings setting.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxSettingsBuilder<T> .

Configures the client-side events.

C#
public GridSmartBoxSettingsBuilder<T> Events(Action<GridSmartBoxEventBuilder> configurator)
Parameters:configuratorAction<GridSmartBoxEventBuilder>

The client events action.

Returns:

GridSmartBoxSettingsBuilder<T>

The current GridSmartBoxSettingsBuilder<T> instance for method chaining.

Sets the settings for the history queries of all modes. When set to true, enables history with default settings. Can be set to an object to customize the history behavior.

C#
public GridSmartBoxSettingsBuilder<T> History()
Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxHistorySettingsBuilder<T> .

Sets the settings for the history queries of all modes. When set to true, enables history with default settings. Can be set to an object to customize the history behavior.

C#
public GridSmartBoxSettingsBuilder<T> History(Action<GridSmartBoxHistorySettingsBuilder<T>> configurator)
Parameters:configuratorAction<GridSmartBoxHistorySettingsBuilder<T>>

The GridSmartBoxHistorySettingsBuilder<T> for the history setting.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxSettingsBuilder<T> .

Sets the settings for the history queries of all modes. When set to true, enables history with default settings. Can be set to an object to customize the history behavior.

C#
public GridSmartBoxSettingsBuilder<T> History(bool enabled)
Parameters:enabledbool

Enables or disables the history option.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxHistorySettingsBuilder<T> .

Represents the template for a history query in the SmartBox component.

C#
public GridSmartBoxSettingsBuilder<T> HistoryItemTemplate(string value)
Parameters:valuestring

The value for HistoryItemTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a history query in the SmartBox component.

C#
public GridSmartBoxSettingsBuilder<T> HistoryItemTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the historyitemtemplate.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a history query in the SmartBox component.

C#
public GridSmartBoxSettingsBuilder<T> HistoryItemTemplateHandler(string templateHandler)
Parameters:templateHandlerstring

The handler that returs the template for HistoryItemTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a history query in the SmartBox component.

C#
public GridSmartBoxSettingsBuilder<T> HistoryItemTemplateId(string templateId)
Parameters:templateIdstring

The ID of the template element for HistoryItemTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

The unified placeholder text of the SmartBox input independent of the activated mode.

C#
public GridSmartBoxSettingsBuilder<T> Placeholder(string value)
Parameters:valuestring

The value for Placeholder

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Configures the initial settings for the Search mode.

C#
public GridSmartBoxSettingsBuilder<T> SearchSettings(Action<GridSmartBoxSearchSettingsSettingsBuilder<T>> configurator)
Parameters:configuratorAction<GridSmartBoxSearchSettingsSettingsBuilder<T>>

The GridSmartBoxSearchSettingsSettingsBuilder<T> for the searchsettings setting.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxSettingsBuilder<T> .

Configures the initial settings for the Semantic Search mode.

C#
public GridSmartBoxSettingsBuilder<T> SemanticSearchSettings(Action<GridSmartBoxSemanticSearchSettingsSettingsBuilder<T>> configurator)
Parameters:configuratorAction<GridSmartBoxSemanticSearchSettingsSettingsBuilder<T>>

The GridSmartBoxSemanticSearchSettingsSettingsBuilder<T> for the semanticsearchsettings setting.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current instance of GridSmartBoxSettingsBuilder<T> .

Represents the template for a suggestion in the SmartBox component AI Assistant mode.

C#
public GridSmartBoxSettingsBuilder<T> SuggestionTemplate(string value)
Parameters:valuestring

The value for SuggestionTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a suggestion in the SmartBox component AI Assistant mode.

C#
public GridSmartBoxSettingsBuilder<T> SuggestionTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the suggestiontemplate.

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a suggestion in the SmartBox component AI Assistant mode.

C#
public GridSmartBoxSettingsBuilder<T> SuggestionTemplateHandler(string templateHandler)
Parameters:templateHandlerstring

The handler that returs the template for SuggestionTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.

Represents the template for a suggestion in the SmartBox component AI Assistant mode.

C#
public GridSmartBoxSettingsBuilder<T> SuggestionTemplateId(string templateId)
Parameters:templateIdstring

The ID of the template element for SuggestionTemplate

Returns:

GridSmartBoxSettingsBuilder<T>

Returns the current GridSmartBoxSettingsBuilder<T> instance.