Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / WidgetBuilderBase<TViewComponent, TBuilder>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

WidgetBuilderBase<TViewComponent, TBuilder>

Class

View component Builder base class.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TViewComponent

TBuilder

Syntax:
C#
public abstract class WidgetBuilderBase<TViewComponent, TBuilder> : IHtmlString where TViewComponent : WidgetBase where TBuilder : WidgetBuilderBase<TViewComponent, TBuilder>

Inheritance: objectWidgetBuilderBase<TViewComponent, TBuilder>

Derived Classes: AIPromptBuilderActionSheetBuilderAppBarBuilderArcGaugeBuilderAvatarBuilderBadgeBuilderBarcodeBuilderBottomNavigationBuilderBreadcrumbBuilderButtonBuilderButtonGroupBuilderCalendarBuilderCaptchaBuilderChainOfThoughtBuilderChartBreadcrumbBuilderChartBuilder<T>ChartWizardBuilder<T>ChatBuilderCheckBoxBuilderCheckBoxGroupBuilderCheckpointBuilderChipBuilderChipListBuilderCircularGaugeBuilderCircularProgressBarBuilderCitationBuilderColorGradientBuilderColorPaletteBuilderColorPickerBuilderContextMenuBuilderDataSourceWidgetBuilder<T>DateInputBuilderDatePickerBuilderBase<TPicker, TPickerBuilder>DateRangePickerBuilderDiagramBuilder<TShapeModel, TConnectionModel>DialogBuilderDockManagerBuilderDrawerBuilderDropDownButtonBuilderDropDownTreeBuilderEditorBuilderExpansionPanelBuilderFileManagerBuilderFilterBuilder<T>FlatColorPickerBuilderFloatingActionButtonBuilderFormBuilder<T>GanttBuilder<TTaskModel, TDependenciesModel>GridBuilder<T>ImageEditorBuilderInlineAIPromptBuilderLinearGaugeBuilderListBoxBuilderListBuilderBase<TDropDown, TDropDownBuilder>ListViewBuilder<T>LoaderBuilderMapBuilderMaskedTextBoxBuilderMediaPlayerBuilderMenuBuilderMultiViewCalendarBuilderNotificationBuilderNumericTextBoxBuilder<T>OTPInputBuilderOrgChartBuilder<T>PDFViewerBuilderPagerBuilderPanelBarBuilderPivotConfiguratorBuilderPivotConfiguratorButtonBuilderPivotConfiguratorV2BuilderPivotContainerBuilderPivotGridBuilder<TModel>PivotGridV2Builder<TModel>PopoverBuilderProgressBarBuilderPromptBoxBuilderPropertyGridBuilder<T>QRCodeBuilderRadialGaugeBuilderRadioButtonBuilderRadioGroupBuilderRangeSliderBuilder<T>RatingBuilderReasoningBuilderRecurrenceEditorBuilderResponsivePanelBuilderSankeyBuilderSchedulerBuilder<TModel>ScrollViewBuilderSegmentedControlBuilderSignatureBuilderSkeletonContainerBuilderSliderBuilder<T>SmartPasteButtonBuilderSparklineBuilder<T>SpeechToTextButtonBuilderSplitButtonBuilderSplitterBuilderSpreadsheetBuilderStepperBuilderStockChartBuilder<T>SwitchBuilderTabStripBuilderTaskBoardBuilder<TCard, TColumn>TextAreaBuilderTextBoxBuilder<T>TileLayoutBuilderTimeDurationPickerBuilderTimelineBuilder<T>TimezoneEditorBuilderToggleButtonBuilderToolBarBuilderToolCallBuilderTreeListBuilder<T>TreeMapBuilderTreeViewBuilderUploadBuilderWindowBuilderWizardBuilderGridLayoutBuilderStackLayoutBuilder...

Implements: IHtmlString

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

Constructors

WidgetBuilderBase(TViewComponent)

Initializes a new instance of the WidgetBuilderBase<TViewComponent, TBuilder> class.

C#
protected WidgetBuilderBase(TViewComponent component)
Parameters:componentTViewComponent

The component.

Properties

Component

TViewComponent

Gets the view component.

C#
protected TViewComponent Component { get; set; }
Property Value:

The component.

Methods

AsModule(bool)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

C#
public virtual TBuilder AsModule(bool value)
Parameters:valueboolReturns:

TBuilder

Deferred(bool)

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

C#
public virtual TBuilder Deferred(bool deferred = true)
Parameters:deferredboolReturns:

TBuilder

HtmlAttributes(IDictionary<string, object>)

C#
public virtual TBuilder HtmlAttributes(IDictionary<string, object> attributes)
Parameters:attributesIDictionary<string, object>Returns:

TBuilder

HtmlAttributes(object)

Sets the HTML attributes.

C#
public virtual TBuilder HtmlAttributes(object attributes)
Parameters:attributesobject

The HTML attributes.

Returns:

TBuilder

Example:
C#
@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
    .Name("grid")
    .Columns(columns =&gt;
    {
        columns.Bound(p =&gt; p.OrderID).Filterable(false);
        columns.Bound(p =&gt; p.Freight);
    })
    .Pageable()
    .Scrollable()
    .HtmlAttributes(new { style = "height: 550px;" })
    .DataSource(dataSource =&gt; dataSource
        .Ajax()
        .PageSize(20)
        .Read(read =&gt; read.Action("Orders_Read", "Grid"))
    )
)

ModelMetadata(ModelMetadata)

Uses the Metadata of the Model.

C#
public TBuilder ModelMetadata(ModelMetadata modelMetadata)
Parameters:modelMetadataModelMetadata

The metadata set for the Model

Returns:

TBuilder

Example:
C#
@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
    .Name("grid")
    .Columns(columns =&gt;
    {
        columns.Bound(p =&gt; p.OrderID).Filterable(false);
        columns.Bound(p =&gt; p.Freight);
    })
    .Pageable()
    .Scrollable()
    .ModelMetadata(ModelMetadata.FromStringExpression("Name", ViewData))
    .HtmlAttributes(new { style = "height: 550px;" })
    .DataSource(dataSource =&gt; dataSource
        .Ajax()
        .PageSize(20)
        .Read(read =&gt; read.Action("Orders_Read", "Grid"))
    )
)

Name(string)

Sets the name of the component.

C#
public virtual TBuilder Name(string componentName)
Parameters:componentNamestring

The name of the component.

Returns:

TBuilder

Example:
C#
@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Render()

Renders the component.

C#
public virtual void Render()
Example:
C#
@(@Page Inherits="System.Web.Mvc.ViewPage&lt;IEnumerable&lt;Product&gt;&gt;" )
@( Html.Kendo().Grid(Model)
.Name("grid")
.DetailTemplate(product =&gt; {
)
Product Details:
&lt;div&gt;Product Name: @( product.ProductName )&lt;/div&gt;
&lt;div&gt;Units In Stock: @( product.UnitsInStock )&lt;/div&gt;
@(
})
.Render();
)

ScriptAttributes(IDictionary<string, object>, bool)

Sets the JavaScript attributes to the initialization script.

C#
public virtual TBuilder ScriptAttributes(IDictionary<string, object> attributes, bool overrideAttributes)
Parameters:attributesIDictionary<string, object>

The JavaScript attributes.

overrideAttributesbool

Argument which determines whether attributes should be overriden.

Returns:

TBuilder

ScriptAttributes(object, bool)

Sets the JavaScript attributes to the initialization script.

C#
public virtual TBuilder ScriptAttributes(object attributes, bool overrideAttributes = false)
Parameters:attributesobject

The JavaScript attributes.

overrideAttributesbool

Argument which determines whether attributes should be overriden.

Returns:

TBuilder

ToClientTemplate()

C#
public virtual MvcHtmlString ToClientTemplate()
Returns:

MvcHtmlString

ToComponent()

Returns the internal view component.

C#
public TViewComponent ToComponent()
Returns:

TViewComponent

ToHtmlString()

C#
public virtual string ToHtmlString()
Returns:

string

ToString()

C#
public override string ToString()
Returns:

string

Overrides: object.ToString()

Operators

implicit operator TViewComponent(WidgetBuilderBase<TViewComponent, TBuilder>)

C#
public static implicit operator TViewComponent(WidgetBuilderBase<TViewComponent, TBuilder> builder)
Parameters:builderWidgetBuilderBase<TViewComponent, TBuilder>Returns:

TViewComponent

In this article
DefinitionConstructorsWidgetBuilderBase(TViewComponent)PropertiesComponentMethodsAsModule(bool)Deferred(bool)HtmlAttributes(IDictionary<string, object>)HtmlAttributes(object)ModelMetadata(ModelMetadata)Name(string)Render()ScriptAttributes(IDictionary<string, object>, bool)ScriptAttributes(object, bool)ToClientTemplate()ToComponent()ToHtmlString()ToString()Operatorsimplicit operator TViewComponent(WidgetBuilderBase<TViewComponent, TBuilder>)
Not finding the help you need?
Contact Support