Class ProgressBar
Inherited Members
Namespace: Syncfusion.EJ2.ProgressBar
Assembly: Syncfusion.EJ2.dll
Syntax
public class ProgressBar : EJTagHelper
Constructors
ProgressBar()
Declaration
public ProgressBar()
Properties
Animation
Animation for the progress bar
Declaration
[HtmlAttributeName("animation")]
public ProgressBarAnimation Animation { get; set; }
Property Value
Type | Description |
---|---|
ProgressBarAnimation | The default value is null |
AnimationComplete
Triggers after the animation completed.
Declaration
[HtmlAttributeName("animationComplete")]
public string AnimationComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Annotations
The configuration for annotation in Progressbar.
Declaration
[HtmlAttributeName("annotations")]
public List<ProgressBarAnnotationSettings> Annotations { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ProgressBarAnnotationSettings> | The default value is null |
CornerRadius
corner type
Declaration
[HtmlAttributeName("cornerRadius")]
public CornerType CornerRadius { get; set; }
Property Value
Type | Description |
---|---|
CornerType | The default value is CornerType.Auto |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePieProgress
pie view
Declaration
[HtmlAttributeName("enablePieProgress")]
public bool EnablePieProgress { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableProgressSegments
disable the trackSegment
Declaration
[HtmlAttributeName("enableProgressSegments")]
public bool EnableProgressSegments { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
right to left
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EndAngle
endAngle for circular progress bar
Declaration
[HtmlAttributeName("endAngle")]
public double EndAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
GapWidth
gapwidth of the segment
Declaration
[HtmlAttributeName("gapWidth")]
public double GapWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
Height
height of the progress bar
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
InnerRadius
progress radius for circular
Declaration
[HtmlAttributeName("innerRadius")]
public string InnerRadius { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |
IsActive
Active state
Declaration
[HtmlAttributeName("isActive")]
public bool IsActive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
IsGradient
gradient
Declaration
[HtmlAttributeName("isGradient")]
public bool IsGradient { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
IsIndeterminate
Indeterminate progress
Declaration
[HtmlAttributeName("isIndeterminate")]
public bool IsIndeterminate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
IsStriped
striped
Declaration
[HtmlAttributeName("isStriped")]
public bool IsStriped { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
LabelOnTrack
labelOnTrack
Declaration
[HtmlAttributeName("labelOnTrack")]
public bool LabelOnTrack { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
LabelStyle
Option for customizing the label text.
Declaration
[HtmlAttributeName("labelStyle")]
public ProgressBarFont LabelStyle { get; set; }
Property Value
Type | Description |
---|---|
ProgressBarFont | The default value is null |
Load
Triggers before the progress bar get rendered.
Declaration
[HtmlAttributeName("load")]
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Loaded
Triggers after the progress bar has loaded.
Declaration
[HtmlAttributeName("loaded")]
public string Loaded { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Margin
margin size
Declaration
[HtmlAttributeName("margin")]
public ProgressBarMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
ProgressBarMargin | The default value is null |
Maximum
maximum progress value
Declaration
[HtmlAttributeName("maximum")]
public double Maximum { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Minimum
minimum progress value
Declaration
[HtmlAttributeName("minimum")]
public double Minimum { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
MouseClick
Trigger after mouse click
Declaration
[HtmlAttributeName("mouseClick")]
public string MouseClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
MouseDown
Trigger after mouse down
Declaration
[HtmlAttributeName("mouseDown")]
public string MouseDown { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
MouseLeave
Trigger after mouse down
Declaration
[HtmlAttributeName("mouseLeave")]
public string MouseLeave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
MouseMove
Trigger after mouse move
Declaration
[HtmlAttributeName("mouseMove")]
public string MouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
MouseUp
Trigger after mouse up
Declaration
[HtmlAttributeName("mouseUp")]
public string MouseUp { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ProgressColor
progressColor
Declaration
[HtmlAttributeName("progressColor")]
public string ProgressColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ProgressCompleted
Triggers after the progress value completed.
Declaration
[HtmlAttributeName("progressCompleted")]
public string ProgressCompleted { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ProgressThickness
progress thickness
Declaration
[HtmlAttributeName("progressThickness")]
public double ProgressThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Radius
track radius for circular
Declaration
[HtmlAttributeName("radius")]
public string Radius { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |
RangeColors
RangeColor in Progressbar.
Declaration
[HtmlAttributeName("rangeColors")]
public List<ProgressBarRangeColor> RangeColors { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ProgressBarRangeColor> | The default value is null |
Role
modes of linear progress
Declaration
[HtmlAttributeName("role")]
public ModeType Role { get; set; }
Property Value
Type | Description |
---|---|
ModeType | The default value is null |
SecondaryProgress
secondary progress value
Declaration
[HtmlAttributeName("secondaryProgress")]
public double SecondaryProgress { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
SecondaryProgressColor
Defines color for the secondary progress bar. By default, it takes the primary progress bar color with half of the opacity.
Declaration
[HtmlAttributeName("secondaryProgressColor")]
public string SecondaryProgressColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
SecondaryProgressThickness
Defines thickness for the secondary progress bar. By default, it takes the primary progress bar thickness.
Declaration
[HtmlAttributeName("secondaryProgressThickness")]
public double SecondaryProgressThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
SegmentColor
Segment color
Declaration
[HtmlAttributeName("segmentColor")]
public string[] SegmentColor { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
SegmentCount
segmentCount of the progress bar
Declaration
[HtmlAttributeName("segmentCount")]
public double SegmentCount { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1 |
ShowProgressValue
label of the progress bar
Declaration
[HtmlAttributeName("showProgressValue")]
public bool ShowProgressValue { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
StartAngle
startAngle for circular progress bar
Declaration
[HtmlAttributeName("startAngle")]
public double StartAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
TextRender
Triggers before the progress bar label renders.
Declaration
[HtmlAttributeName("textRender")]
public string TextRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Theme
theme style
Declaration
[HtmlAttributeName("theme")]
public ProgressTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
ProgressTheme | The default value is ProgressTheme.Fabric |
Tooltip
Options for customizing the tooltip of progressbar.
Declaration
[HtmlAttributeName("tooltip")]
public ProgressBarTooltipSettings Tooltip { get; set; }
Property Value
Type | Description |
---|---|
ProgressBarTooltipSettings | The default value is null |
TooltipRender
Triggers before the tooltip for series is rendered.
Declaration
[HtmlAttributeName("tooltipRender")]
public string TooltipRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TrackColor
trackColor
Declaration
[HtmlAttributeName("trackColor")]
public string TrackColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TrackThickness
track thickness
Declaration
[HtmlAttributeName("trackThickness")]
public double TrackThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Type
type of the progress bar
Declaration
[HtmlAttributeName("type")]
public ProgressType Type { get; set; }
Property Value
Type | Description |
---|---|
ProgressType | The default value is ProgressType.Linear |
Value
progress value
Declaration
[HtmlAttributeName("value")]
public double Value { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
ValueChanged
Triggers after the value has changed.
Declaration
[HtmlAttributeName("valueChanged")]
public string ValueChanged { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Width
width of the progress bar
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |