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

BadgeBuilder

Class

Defines the fluent API for configuring the Telerik UI Badge for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class BadgeBuilder : WidgetBuilderBase<Badge, BadgeBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Badge, BadgeBuilder>BadgeBuilder

Implements: IHtmlString

Constructors

BadgeBuilder(Badge)

Initializes a new instance of the Badge class.

public BadgeBuilder(Badge component)

Parameters:componentBadge

The component.

Methods

Align(BadgeAlign)

Defines the alignment of the Badge when it is integrated into a Button.

public BadgeBuilder Align(BadgeAlign value)

Parameters:valueBadgeAlign

The value that configures the Badge alignment.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Button()
.Name("save")
.Content("Save")
.Badge(b =&gt; b
.Align(BadgeAlign.TopStart)
.Icon("save")
)
)

CutoutBorder(bool)

Specifies whether or not to render an additional "cutout" border around the Badge.

public BadgeBuilder CutoutBorder(bool value)

Parameters:valuebool

The value that enables the border.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.CutoutBorder(false)
)

Encoded(bool)

Determines whether the textual content should be rendered as an HTML string or it should be encoded.

public BadgeBuilder Encoded(bool value)

Parameters:valuebool

The value that configures the encoded.

Returns:

BadgeBuilder

FillMode(BadgeFill)

Defines how theme colors are applied to a Badge.

public BadgeBuilder FillMode(BadgeFill value)

Parameters:valueBadgeFill

The value that configures the fill mode.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("user")
.FillMode(BadgeFill.Outline)
)

Icon(string)

Defines the name for an existing icon in a Kendo UI theme or SVG content. The icon is rendered inside the Badge by a 'span.k-icon' or 'span.k-svg-icon' element.

public BadgeBuilder Icon(string value)

Parameters:valuestring

The value that configures the icon.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Icon("user")
)

Max(double)

If text is a number, it will cap that number.

public BadgeBuilder Max(double value)

Parameters:valuedouble

The value that configures the max.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text(100.2f)
.Max(99)
)

Position(BadgePosition)

Defines the position of the Badge when it is integrated into a Button.

public BadgeBuilder Position(BadgePosition value)

Parameters:valueBadgePosition

The value that configures the position.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Button()
.Name("save")
.Content("Save")
.Badge(b =&gt; b
.Position(BadgePosition.Edge)
.Icon("save")
)
)

Rounded(Rounded)

Defines the rounded appearance of the Badge.

public BadgeBuilder Rounded(Rounded value)

Parameters:valueRounded

The value that configures the rounding of the Badge.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("Most Popular")
.Rounded(Rounded.Large)
)

Size(BadgeSize)

Defines the size of the Badge.

public BadgeBuilder Size(BadgeSize value)

Parameters:valueBadgeSize

The value that configures the size.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("Most Popular")
.Size(BadgeSize.Large)
)

Template(string)

The template that renders the content of the Badge.

public BadgeBuilder Template(string value)

Parameters:valuestring

The value that configures the template.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("120")
.Template("#= +this._text &gt; 100 ? 'a lot' : this._text #")
)

Template<TModel>(TemplateBuilder<TModel>)

The template that renders the content of the Badge.

public BadgeBuilder Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

BadgeBuilder

TemplateHandler(string)

The template that renders the content of the Badge.

public BadgeBuilder TemplateHandler(string value)

Parameters:valuestring

The value that configures the template.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("100")
.TemplateHandler("getBadgeContent")
)
&lt;script&gt;
function getBadgeContent() {
if(this._text &gt; 100) {
return 'a lot';
} else return this._text;
}
&lt;/script&gt;

TemplateId(string)

The template that renders the content of the Badge.

public BadgeBuilder TemplateId(string value)

Parameters:valuestring

The value that configures the template.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("15")
.TemplateId("sentTemplate")
)
&lt;script id="sentTemplate" type="text/x-kendo-template"&gt;
#= this._text # items
&lt;/script&gt;

TemplateView(MvcHtmlString)

The template that renders the content of the Badge.

public BadgeBuilder TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("100")
.TemplateView(Html.Partial("BadgeTemplateView"))
)

Text(float)

The text of the Badge. The valid input includes a string, number, or object with the 'toString()' method. The default value is an empty string.

public BadgeBuilder Text(float value)

Parameters:valuefloat

The value for the Text option.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("100")
)

Text(string)

The text of the Badge. The valid input includes a string, number, or object with the 'toString()' method. The default value is an empty string.

public BadgeBuilder Text(string value)

Parameters:valuestring

The value for the Text option.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("Most Popular")
)

ThemeColor(BadgeColor)

Defines the color applied of the Badge.

public BadgeBuilder ThemeColor(BadgeColor value)

Parameters:valueBadgeColor

The value that configures the theme color.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("user")
.ThemeColor(BadgeColor.Primary)
)

Visible(bool)

If set to 'false', the Badge will not be displayed.

public BadgeBuilder Visible(bool value)

Parameters:valuebool

The value that configures the visibility of the Badge.

Returns:

BadgeBuilder

Example:

@(Html.Kendo().Badge()
.Name("badge")
.Text("Most Popular")
.Visible(false)
)