New to Telerik UI for ASP.NET AJAXStart a free 30-day trial

RadProgressBar Object

The RadProgressBar client-side object exposes the following public methods and properties to control its behavior:

Table 1: Helper Methods

NameParametersReturn TypeDescription
$telerik.findProgressBar(id, parent)String, HTMLElementRadProgressBarFinds a RadProgressBar instance. The first passed parameter is the string that contains at least a part of the ID of the RadProgressBar to find and the second one is the component or element that contains it.
$telerik.toProgressBar(object)ObjectRadProgressBarCasts an object to a RadProgressBar instance.

Table 2: RadProgressBar Client-Side Methods

NameParametersReturn TypeDescription
get_animationSettingsObject LiteralReturns the animation settings of the progress bar. They are presented with an object literal with the following fields: duration—contains the duration of the animation in milliseconds; enableChunkAnimation—specifies whether the animation will be enabled when the BarType property of the progress bar is set to Chunk .
get_barTypeTelerik.Web.UI.ProgressBarTypeReturns the type of the progress bar as a value from the Telerik.Web.UI.ProgressBarType enum that has the following values: Value; Percent; Chunk.
get_chunksCountNumberReturns the number of chunks in the progress bar when its BarType property is set to Chunk .
get_enabledBooleanReturns the enabled state of the progress bar.
get_labelStringReturns the label text of the progress bar.
get_maxValueNumberReturns the maximum value of the progress bar.
get_minValueNumberReturns the minimum value of the progress bar.
get_orientationTelerik.Web.UI.ProgressBarOrientationReturns the orientation of the progress bar as a value from the Telerik.Web.UI.ProgressBarOrientation that has the following values: Horizontal; Vertical.
get_progressWrapperHTMLElementReturns the progress wrapper DOM element.
get_reversedBooleanIndicates whether the direction of the progress bar is reversed.
get_showLabelBooleanReturns the visible state of the label of the progress bar.
get_valueNumberReturns the current value of the progress bar. Undefined means indeterminate state.
isCompletedBooleanReturns the completed state of the progress bar.
set_animationSettingsObject LiteralSets the animation settings of the progress bar. They are presented with an object literal with the following fields: duration—contains the duration of the animation in milliseconds; enableChunkAnimation—specifies whether the animation will be enabled when the BarType property of the progress bar is set to Chunk. Example: progressBar.set_animationSettings({ duration: 500, enableChunkAnimation: true });
set_enabledBooleanSets the enabled state of the progress bar.
set_labelStringSets the label text of the progress bar.
set_maxValueNumberSets the maximum value of the progress bar.
set_minValueNumberSets the minimum value of the progress bar.
set_showLabelBooleanSets the visible state of the label of the progress bar.
set_valueNumber, BooleanSets the current value of the progress bar. Undefined/false sets indeterminate state.
Not finding the help you need?
Contact Support