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

Defines the fluent API for configuring ButtonBadgeSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

C#
public class ButtonBadgeSettingsBuilder

Inheritance: objectButtonBadgeSettingsBuilder

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

Constructors

C#
public ButtonBadgeSettingsBuilder(ButtonBadgeSettings container)
Parameters:containerButtonBadgeSettings

Properties

C#
protected ButtonBadgeSettings Container { get; }

Methods

Defines the alignment of the badge

C#
public ButtonBadgeSettingsBuilder Align(BadgeAlign value)
Parameters:valueBadgeAlign

The value that configures the align.

Returns:

ButtonBadgeSettingsBuilder

Specifies wether or not to render additional "cutout" border around the badge.

C#
public ButtonBadgeSettingsBuilder CutoutBorder()
Returns:

ButtonBadgeSettingsBuilder

Specifies wether or not to render additional "cutout" border around the badge.

C#
public ButtonBadgeSettingsBuilder CutoutBorder(bool value)
Parameters:valuebool

The value for CutoutBorder

Returns:

ButtonBadgeSettingsBuilder

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

C#
public ButtonBadgeSettingsBuilder Encoded(bool value)
Parameters:valuebool

The value for Encoded

Returns:

ButtonBadgeSettingsBuilder

Defines how theme colors are applied to a badge

C#
public ButtonBadgeSettingsBuilder Fill(BadgeFill? value)
Parameters:valueBadgeFill?

The value that configures the fill.

Returns:

ButtonBadgeSettingsBuilder

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.

C#
public ButtonBadgeSettingsBuilder Icon(string value)
Parameters:valuestring

The value for Icon

Returns:

ButtonBadgeSettingsBuilder

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

C#
public ButtonBadgeSettingsBuilder Max(double value)
Parameters:valuedouble

The value for Max

Returns:

ButtonBadgeSettingsBuilder

Specifies position of the badge relative to button. Valid position options are: inline, top start, top end, bottom start, bottom end. works in conjunction with badge.placement.

C#
public ButtonBadgeSettingsBuilder Position(BadgePosition value)
Parameters:valueBadgePosition

The value for Position

Returns:

ButtonBadgeSettingsBuilder

Specifies the shape of the badge. Valid options are: rectangle, rounded, pill, circle, dot.

C#
public ButtonBadgeSettingsBuilder Shape(BadgeShape value)
Parameters:valueBadgeShape

The value for Shape

Returns:

ButtonBadgeSettingsBuilder

Specifies the size of the badge. Valid options are small, medium and large.

C#
public ButtonBadgeSettingsBuilder Size(BadgeSize? value)
Parameters:valueBadgeSize?

The value for Shape

Returns:

ButtonBadgeSettingsBuilder

The template which renders the content of the badge

C#
public ButtonBadgeSettingsBuilder Template(string value)
Parameters:valuestring

The value for Template

Returns:

ButtonBadgeSettingsBuilder

The template which renders the content of the badge

C#
public ButtonBadgeSettingsBuilder Template<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

The value for Template

Returns:

ButtonBadgeSettingsBuilder

Sets the template handler function name for rendering the badge content.

C#
public ButtonBadgeSettingsBuilder TemplateHandler(string value)
Parameters:valuestring

The template handler function name.

Returns:

ButtonBadgeSettingsBuilder

The builder instance.

The template which renders the content of the badge

C#
public ButtonBadgeSettingsBuilder TemplateId(string templateId)
Parameters:templateIdstring

The ID of the template element for Template

Returns:

ButtonBadgeSettingsBuilder

The template which renders the content of the badge

C#
public ButtonBadgeSettingsBuilder TemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The name of the view for the Template value

Returns:

ButtonBadgeSettingsBuilder

The text of the badge. Valid input includes string, number or object with toString method. Default is empty string.

C#
public ButtonBadgeSettingsBuilder Text(string value)
Parameters:valuestring

The value for Text

Returns:

ButtonBadgeSettingsBuilder

Specifies the color of the component. Valid options are inherit, default, primary, secondary, tertiary, info, success, warning, error, dark, light, inverted.

C#
public ButtonBadgeSettingsBuilder ThemeColor(BadgeColor? value)
Parameters:valueBadgeColor?

The value for Color

Returns:

ButtonBadgeSettingsBuilder

If set to false the badge will not be displayed.

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

The value for Visible

Returns:

ButtonBadgeSettingsBuilder