CircularProgressBarBuilder
Properties
WriteAction - Func
Methods
AriaRole(System.Boolean)
If set to true the Circular ProgressBar will have its role attribute set to progressbar. It will also render its aria-valuemin, aria-valuemax, and aria-valuenow attributes.
Parameters
value - System.Boolean
The value for AriaRole
RETURNS
Returns the current CircularProgressBarBuilder instance.
AriaRole()
If set to true the Circular ProgressBar will have its role attribute set to progressbar. It will also render its aria-valuemin, aria-valuemax, and aria-valuenow attributes.
RETURNS
Returns the current CircularProgressBarBuilder instance.
CenterTemplate(System.String)
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Parameters
value - System.String
The value for CenterTemplate
RETURNS
Returns the current CircularProgressBarBuilder instance.
CenterTemplateId(System.String)
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Parameters
templateId - System.String
The ID of the template element for CenterTemplate
RETURNS
Returns the current CircularProgressBarBuilder instance.
CenterTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for CenterTemplate
RETURNS
Returns the current CircularProgressBarBuilder instance.
CenterTemplateHandler(System.String)
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Parameters
templateHandler - System.String
The handler that returs the template for CenterTemplate
RETURNS
Returns the current CircularProgressBarBuilder instance.
CenterTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the centertemplate.
RETURNS
Returns the current CircularProgressBarBuilder instance.
Color(System.String)
The color of the value pointer. Accepts a valid CSS color string, including hex and rgb.
Parameters
value - System.String
The value for Color
RETURNS
Returns the current CircularProgressBarBuilder instance.
Colors(System.Action)
The color ranges of the value pointer. The pointer color will be set to the color from the range that contains the current value.
Parameters
configurator - System.Action<CircularProgressBarColorFactory>
The configurator for the colors setting.
RETURNS
Returns the current instance of CircularProgressBarBuilder .
Label(System.String)
The label that would be used as a aria-label for the Circular ProgressBar element. Will be applied only if ariaRole is set to true.
Parameters
value - System.String
The value for Label
RETURNS
Returns the current CircularProgressBarBuilder instance.
LabelId(System.String)
The ID of the element that will be used as a label of the Circular ProgressBar. Will be used as a value of the aria-labelledby attribute. Will be applied only if ariaRole is set to true.
Parameters
value - System.String
The value for LabelId
RETURNS
Returns the current CircularProgressBarBuilder instance.
Opacity(System.Double)
The opacity of the value pointer.
Parameters
value - System.Double
The value for Opacity
RETURNS
Returns the current CircularProgressBarBuilder instance.
Theme(System.String)
The circularProgressBar theme. With versions prior to R1 2023 this can be either the respective LESS theme from the list below or "sass". When set to "sass" the circularProgressBar will read the variables from the Sass-based themes.Note: Since Q2 2024 release, the default value for the theme property is "sass" instead of "default". It is recommended to use "sass" with version Q2 2024 or later.The supported values are: "sass"; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
Parameters
value - System.String
The value for Theme
RETURNS
Returns the current CircularProgressBarBuilder instance.
Transitions(System.Boolean)
A value indicating if transition animations should be played.
Parameters
value - System.Boolean
The value for Transitions
RETURNS
Returns the current CircularProgressBarBuilder instance.
Indeterminate(System.Boolean)
A value indicating whether endloess loading is enabled
Parameters
value - System.Boolean
The value for Indeterminate
RETURNS
Returns the current CircularProgressBarBuilder instance.
PointerWidth(System.Double)
A value indicating how wide will the pointer be
Parameters
value - System.Double
The value for PointerWidth
RETURNS
Returns the current CircularProgressBarBuilder instance.
Value(System.Double)
The component value.
Parameters
value - System.Double
The value for Value
RETURNS
Returns the current CircularProgressBarBuilder instance.
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.