ButtonBadgeSettingsBuilder
Methods
Align(Kendo.Mvc.UI.BadgeAlign)
Specifies alignment of the badge relative to button. Valid position options are: top start, top end, bottom start, bottom end. works in conjunction with badge.position.
Parameters
value - BadgeAlign
The value for Align
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
CutoutBorder(System.Boolean)
Specifies wether or not to render additional "cutout" border around the badge.
Parameters
value - System.Boolean
The value for CutoutBorder
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
CutoutBorder()
Specifies wether or not to render additional "cutout" border around the badge.
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Encoded(System.Boolean)
Determines whether the textual content should be rendered as an HTML string or it should be encoded.
Parameters
value - System.Boolean
The value for Encoded
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
FillMode(Kendo.Mvc.UI.BadgeFill)
Sets a value controlling how the color is applied to the badge. When undefined (the default), the theme controls the fill mode. Can also be set to the following string values: "solid" or "outline".
Parameters
value - BadgeFill
The value for FillMode
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Icon(System.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.Set this option to an icon descriptor such as { name: "gear", variant: "outline" }. The variant can be outline, solid, or duotone; it applies to SVG rendering and is ignored for font icons.
Parameters
icon - System.String
The icon.
RETURNS
Returns the current instance of ButtonBadgeSettingsBuilder .
Icon(System.Action)
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.Set this option to an icon descriptor such as { name: "gear", variant: "outline" }. The variant can be outline, solid, or duotone; it applies to SVG rendering and is ignored for font icons.
Parameters
configurator - System.Action<ButtonBadgeIconSettingsBuilder>
The configurator for the icon setting.
RETURNS
Returns the current instance of ButtonBadgeSettingsBuilder .
Max(System.Double)
If text is a number, it will cap that number.
Parameters
value - System.Double
The value for Max
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Position(Kendo.Mvc.UI.BadgePosition)
Specifies position of the badge relative to the edge of the button. Valid placemnt options are: inline, edge, inside, outside.Note: position configuration, other than inline, requires the badge to be aligned. See badge.align for more details.
Parameters
value - BadgePosition
The value for Position
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Rounded(Kendo.Mvc.UI.Rounded)
Specifies the rounding of the badge. When undefined (the default), the theme controls the default border radius. Valid options are small, medium, large and full.
Parameters
value - Rounded
The value for Rounded
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Size(Kendo.Mvc.UI.BadgeSize)
Sets a value controlling the size of the badge. When undefined (the default), the theme controls the size. Can also be set to the following string values: "small"; "medium" or "large".
Parameters
value - BadgeSize
The value for Size
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Template(System.String)
The template which renders the content of the badge.
Parameters
value - System.String
The value for Template
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
TemplateId(System.String)
The template which renders the content of the badge.
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the content of the badge.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
TemplateHandler(System.String)
The template which renders the content of the badge.
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the content of the badge.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Text(System.String)
The text of the badge. Valid input includes string, number or object with toString method. Default is empty string.
Parameters
value - System.String
The value for Text
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
ThemeColor(Kendo.Mvc.UI.BadgeColor)
Specifies the color of the component. Valid options are inherit, default, primary, secondary, tertiary, info, success, warning, error, inverted.
Parameters
value - BadgeColor
The value for ThemeColor
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.
Visible(System.Boolean)
If set to false the badge will not be displayed.
Parameters
value - System.Boolean
The value for Visible
RETURNS
Returns the current ButtonBadgeSettingsBuilder instance.