ProgressBarBuilder
Properties
WriteAction - Func
Methods
Value(System.Double)
Sets the initial value of the ProgressBar
Parameters
value - System.Double
Number specifying the value
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(100)
.Max(200)
.Value(100)
)
Value(System.Boolean)
Sets the initial value of the ProgressBar
Parameters
value - System.Boolean
Pass false to set indeterminate value
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(100)
.Max(200)
.Value(false)
)
Animation(System.Action)
Configures the progress animation. Currently only the duration of the animation could be set.
Parameters
configurator - System.Action<ProgressBarAnimationSettingsBuilder>
The configurator for the animation setting.
RETURNS
Returns the current instance of ProgressBarBuilder .
Animation(System.Boolean)
Configures the progress animation. Currently only the duration of the animation could be set.
Parameters
enabled - System.Boolean
Enables or disables the animation option.
RETURNS
Returns the current instance of ProgressBarAnimationSettingsBuilder .
AriaRole(System.Boolean)
If set to true the 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 ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.AriaRole()
)
AriaRole()
If set to true the 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 ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.AriaRole()
)
ChunkCount(System.Double)
Specifies the number of chunks.
Parameters
value - System.Double
The value for ChunkCount
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Type(ProgressBarType.Chunk)
.ChunkCount(10)
)
Enable(System.Boolean)
If set to false the widget will be disabled. It will still allow changing the value. The widget is enabled by default.
Parameters
value - System.Boolean
The value for Enable
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Enable(false)
)
Label(System.String)
The label that would be used as a aria-label for the ProgressBar element. Will be applied only if ariaRole is set to true.
Parameters
value - System.String
The value for Label
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Label("value")
.AriaRole()
)
LabelId(System.String)
The ID of the element that will be used as a label of the 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 ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.LabelId("value")
.AriaRole()
)
Max(System.Double)
The maximum value of the ProgressBar.
Parameters
value - System.Double
The value for Max
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Max(200)
)
Min(System.Double)
The minimum value of the ProgressBar.
Parameters
value - System.Double
The value for Min
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(50)
)
Reverse(System.Boolean)
Specifies if the progress direction will be reversed.
Parameters
value - System.Boolean
The value for Reverse
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Reverse(true)
)
Reverse()
Specifies if the progress direction will be reversed.
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Reverse(true)
)
ShowStatus(System.Boolean)
Specifies if the progress status will be shown.
Parameters
value - System.Boolean
The value for ShowStatus
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.ShowStatus(false)
)
Orientation(Kendo.Mvc.UI.ProgressBarOrientation)
Defines the orientation of the ProgressBar.
Parameters
value - ProgressBarOrientation
The value for Orientation
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Orientation(ProgressBarOrientation.Vertical)
)
Type(Kendo.Mvc.UI.ProgressBarType)
Represents the supported progress types
Parameters
value - ProgressBarType
The value for Type
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Type(ProgressBarType.Percent)
)
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ProgressBarEventBuilder>
The client events action.
RETURNS
Returns the current ProgressBarBuilder instance.
Example
@(Html.Kendo().ProgressBar()
.Name("ProgressBar")
.Events(events => events
.Change("onChange")
)
)
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
The name.
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
The name.
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 Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean,System.Boolean)
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.