menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ProgressBarBuilder - API Reference

    Show / Hide Table of Contents

    Class ProgressBarBuilder

    Inheritance
    System.Object
    ControlBuilder
    ProgressBarBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.ProgressBar
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class ProgressBarBuilder : ControlBuilder

    Constructors

    ProgressBarBuilder()

    Declaration
    public ProgressBarBuilder()

    ProgressBarBuilder(ProgressBar)

    Declaration
    public ProgressBarBuilder(ProgressBar model)
    Parameters
    Type Name Description
    ProgressBar model

    Fields

    model

    Declaration
    public ProgressBar model
    Field Value
    Type Description
    ProgressBar

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    Animation(ProgressBarAnimation)

    Animation for the progress bar

    Declaration
    public ProgressBarBuilder Animation(ProgressBarAnimation animation)
    Parameters
    Type Name Description
    ProgressBarAnimation animation
    Returns
    Type Description
    ProgressBarBuilder

    Animation(Action<ProgressBarAnimationBuilder>)

    Declaration
    public ProgressBarBuilder Animation(Action<ProgressBarAnimationBuilder> animation)
    Parameters
    Type Name Description
    System.Action<ProgressBarAnimationBuilder> animation
    Returns
    Type Description
    ProgressBarBuilder

    AnimationComplete(String)

    Triggers after the animation completed.

    Declaration
    public ProgressBarBuilder AnimationComplete(string animationComplete)
    Parameters
    Type Name Description
    System.String animationComplete
    Returns
    Type Description
    ProgressBarBuilder

    Annotations(Action<ProgressBarAnnotationSettingsBuilder>)

    Declaration
    public ProgressBarBuilder Annotations(Action<ProgressBarAnnotationSettingsBuilder> annotations)
    Parameters
    Type Name Description
    System.Action<ProgressBarAnnotationSettingsBuilder> annotations
    Returns
    Type Description
    ProgressBarBuilder

    Annotations(List<ProgressBarAnnotationSettings>)

    The configuration for annotation in Progressbar.

    Declaration
    public ProgressBarBuilder Annotations(List<ProgressBarAnnotationSettings> annotations)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ProgressBarAnnotationSettings> annotations
    Returns
    Type Description
    ProgressBarBuilder

    CornerRadius(CornerType)

    corner type

    Declaration
    public ProgressBarBuilder CornerRadius(CornerType cornerRadius)
    Parameters
    Type Name Description
    CornerType cornerRadius
    Returns
    Type Description
    ProgressBarBuilder

    EnablePersistence(Boolean)

    Enable or disable persisting component's state between page reloads.

    Declaration
    public ProgressBarBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    ProgressBarBuilder

    EnablePieProgress(Boolean)

    pie view

    Declaration
    public ProgressBarBuilder EnablePieProgress(bool enablePieProgress = true)
    Parameters
    Type Name Description
    System.Boolean enablePieProgress
    Returns
    Type Description
    ProgressBarBuilder

    EnableProgressSegments(Boolean)

    disable the trackSegment

    Declaration
    public ProgressBarBuilder EnableProgressSegments(bool enableProgressSegments = true)
    Parameters
    Type Name Description
    System.Boolean enableProgressSegments
    Returns
    Type Description
    ProgressBarBuilder

    EnableRtl(Boolean)

    right to left

    Declaration
    public ProgressBarBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    ProgressBarBuilder

    EndAngle(Double)

    endAngle for circular progress bar

    Declaration
    public ProgressBarBuilder EndAngle(double endAngle)
    Parameters
    Type Name Description
    System.Double endAngle
    Returns
    Type Description
    ProgressBarBuilder

    GapWidth(Double)

    gapwidth of the segment

    Declaration
    public ProgressBarBuilder GapWidth(double gapWidth)
    Parameters
    Type Name Description
    System.Double gapWidth
    Returns
    Type Description
    ProgressBarBuilder

    Height(String)

    height of the progress bar

    Declaration
    public ProgressBarBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    ProgressBarBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public ProgressBarBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    ProgressBarBuilder

    InnerRadius(String)

    progress radius for circular

    Declaration
    public ProgressBarBuilder InnerRadius(string innerRadius)
    Parameters
    Type Name Description
    System.String innerRadius
    Returns
    Type Description
    ProgressBarBuilder

    IsActive(Boolean)

    Active state

    Declaration
    public ProgressBarBuilder IsActive(bool isActive = true)
    Parameters
    Type Name Description
    System.Boolean isActive
    Returns
    Type Description
    ProgressBarBuilder

    IsGradient(Boolean)

    gradient

    Declaration
    public ProgressBarBuilder IsGradient(bool isGradient = true)
    Parameters
    Type Name Description
    System.Boolean isGradient
    Returns
    Type Description
    ProgressBarBuilder

    IsIndeterminate(Boolean)

    Indeterminate progress

    Declaration
    public ProgressBarBuilder IsIndeterminate(bool isIndeterminate = true)
    Parameters
    Type Name Description
    System.Boolean isIndeterminate
    Returns
    Type Description
    ProgressBarBuilder

    IsStriped(Boolean)

    striped

    Declaration
    public ProgressBarBuilder IsStriped(bool isStriped = true)
    Parameters
    Type Name Description
    System.Boolean isStriped
    Returns
    Type Description
    ProgressBarBuilder

    LabelOnTrack(Boolean)

    labelOnTrack

    Declaration
    public ProgressBarBuilder LabelOnTrack(bool labelOnTrack = true)
    Parameters
    Type Name Description
    System.Boolean labelOnTrack
    Returns
    Type Description
    ProgressBarBuilder

    LabelStyle(ProgressBarFont)

    Option for customizing the label text.

    Declaration
    public ProgressBarBuilder LabelStyle(ProgressBarFont labelStyle)
    Parameters
    Type Name Description
    ProgressBarFont labelStyle
    Returns
    Type Description
    ProgressBarBuilder

    LabelStyle(Action<ProgressBarFontBuilder>)

    Declaration
    public ProgressBarBuilder LabelStyle(Action<ProgressBarFontBuilder> labelStyle)
    Parameters
    Type Name Description
    System.Action<ProgressBarFontBuilder> labelStyle
    Returns
    Type Description
    ProgressBarBuilder

    Load(String)

    Triggers before the progress bar get rendered.

    Declaration
    public ProgressBarBuilder Load(string load)
    Parameters
    Type Name Description
    System.String load
    Returns
    Type Description
    ProgressBarBuilder

    Loaded(String)

    Triggers after the progress bar has loaded.

    Declaration
    public ProgressBarBuilder Loaded(string loaded)
    Parameters
    Type Name Description
    System.String loaded
    Returns
    Type Description
    ProgressBarBuilder

    Locale(String)

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public ProgressBarBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    ProgressBarBuilder

    Margin(ProgressBarMargin)

    margin size

    Declaration
    public ProgressBarBuilder Margin(ProgressBarMargin margin)
    Parameters
    Type Name Description
    ProgressBarMargin margin
    Returns
    Type Description
    ProgressBarBuilder

    Margin(Action<ProgressBarMarginBuilder>)

    Declaration
    public ProgressBarBuilder Margin(Action<ProgressBarMarginBuilder> margin)
    Parameters
    Type Name Description
    System.Action<ProgressBarMarginBuilder> margin
    Returns
    Type Description
    ProgressBarBuilder

    Maximum(Double)

    maximum progress value

    Declaration
    public ProgressBarBuilder Maximum(double maximum)
    Parameters
    Type Name Description
    System.Double maximum
    Returns
    Type Description
    ProgressBarBuilder

    Minimum(Double)

    minimum progress value

    Declaration
    public ProgressBarBuilder Minimum(double minimum)
    Parameters
    Type Name Description
    System.Double minimum
    Returns
    Type Description
    ProgressBarBuilder

    MouseClick(String)

    Trigger after mouse click

    Declaration
    public ProgressBarBuilder MouseClick(string mouseClick)
    Parameters
    Type Name Description
    System.String mouseClick
    Returns
    Type Description
    ProgressBarBuilder

    MouseDown(String)

    Trigger after mouse down

    Declaration
    public ProgressBarBuilder MouseDown(string mouseDown)
    Parameters
    Type Name Description
    System.String mouseDown
    Returns
    Type Description
    ProgressBarBuilder

    MouseLeave(String)

    Trigger after mouse down

    Declaration
    public ProgressBarBuilder MouseLeave(string mouseLeave)
    Parameters
    Type Name Description
    System.String mouseLeave
    Returns
    Type Description
    ProgressBarBuilder

    MouseMove(String)

    Trigger after mouse move

    Declaration
    public ProgressBarBuilder MouseMove(string mouseMove)
    Parameters
    Type Name Description
    System.String mouseMove
    Returns
    Type Description
    ProgressBarBuilder

    MouseUp(String)

    Trigger after mouse up

    Declaration
    public ProgressBarBuilder MouseUp(string mouseUp)
    Parameters
    Type Name Description
    System.String mouseUp
    Returns
    Type Description
    ProgressBarBuilder

    ProgressColor(String)

    progressColor

    Declaration
    public ProgressBarBuilder ProgressColor(string progressColor)
    Parameters
    Type Name Description
    System.String progressColor
    Returns
    Type Description
    ProgressBarBuilder

    ProgressCompleted(String)

    Triggers after the progress value completed.

    Declaration
    public ProgressBarBuilder ProgressCompleted(string progressCompleted)
    Parameters
    Type Name Description
    System.String progressCompleted
    Returns
    Type Description
    ProgressBarBuilder

    ProgressThickness(Double)

    progress thickness

    Declaration
    public ProgressBarBuilder ProgressThickness(double progressThickness)
    Parameters
    Type Name Description
    System.Double progressThickness
    Returns
    Type Description
    ProgressBarBuilder

    Radius(String)

    track radius for circular

    Declaration
    public ProgressBarBuilder Radius(string radius)
    Parameters
    Type Name Description
    System.String radius
    Returns
    Type Description
    ProgressBarBuilder

    RangeColors(Action<ProgressBarRangeColorBuilder>)

    Declaration
    public ProgressBarBuilder RangeColors(Action<ProgressBarRangeColorBuilder> rangeColors)
    Parameters
    Type Name Description
    System.Action<ProgressBarRangeColorBuilder> rangeColors
    Returns
    Type Description
    ProgressBarBuilder

    RangeColors(List<ProgressBarRangeColor>)

    RangeColor in Progressbar.

    Declaration
    public ProgressBarBuilder RangeColors(List<ProgressBarRangeColor> rangeColors)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ProgressBarRangeColor> rangeColors
    Returns
    Type Description
    ProgressBarBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    Role(ModeType)

    modes of linear progress

    Declaration
    public ProgressBarBuilder Role(ModeType role)
    Parameters
    Type Name Description
    ModeType role
    Returns
    Type Description
    ProgressBarBuilder

    SecondaryProgress(Double)

    secondary progress value

    Declaration
    public ProgressBarBuilder SecondaryProgress(double secondaryProgress)
    Parameters
    Type Name Description
    System.Double secondaryProgress
    Returns
    Type Description
    ProgressBarBuilder

    SecondaryProgressColor(String)

    Defines color for the secondary progress bar. By default, it takes the primary progress bar color with half of the opacity.

    Declaration
    public ProgressBarBuilder SecondaryProgressColor(string secondaryProgressColor)
    Parameters
    Type Name Description
    System.String secondaryProgressColor
    Returns
    Type Description
    ProgressBarBuilder

    SecondaryProgressThickness(Double)

    Defines thickness for the secondary progress bar. By default, it takes the primary progress bar thickness.

    Declaration
    public ProgressBarBuilder SecondaryProgressThickness(double secondaryProgressThickness)
    Parameters
    Type Name Description
    System.Double secondaryProgressThickness
    Returns
    Type Description
    ProgressBarBuilder

    SegmentColor(String[])

    Segment color

    Declaration
    public ProgressBarBuilder SegmentColor(string[] segmentColor)
    Parameters
    Type Name Description
    System.String[] segmentColor
    Returns
    Type Description
    ProgressBarBuilder

    SegmentCount(Double)

    segmentCount of the progress bar

    Declaration
    public ProgressBarBuilder SegmentCount(double segmentCount)
    Parameters
    Type Name Description
    System.Double segmentCount
    Returns
    Type Description
    ProgressBarBuilder

    ShowProgressValue(Boolean)

    label of the progress bar

    Declaration
    public ProgressBarBuilder ShowProgressValue(bool showProgressValue = true)
    Parameters
    Type Name Description
    System.Boolean showProgressValue
    Returns
    Type Description
    ProgressBarBuilder

    StartAngle(Double)

    startAngle for circular progress bar

    Declaration
    public ProgressBarBuilder StartAngle(double startAngle)
    Parameters
    Type Name Description
    System.Double startAngle
    Returns
    Type Description
    ProgressBarBuilder

    TextRender(String)

    Triggers before the progress bar label renders.

    Declaration
    public ProgressBarBuilder TextRender(string textRender)
    Parameters
    Type Name Description
    System.String textRender
    Returns
    Type Description
    ProgressBarBuilder

    Theme(ProgressTheme)

    theme style

    Declaration
    public ProgressBarBuilder Theme(ProgressTheme theme)
    Parameters
    Type Name Description
    ProgressTheme theme
    Returns
    Type Description
    ProgressBarBuilder

    Tooltip(ProgressBarTooltipSettings)

    Options for customizing the tooltip of progressbar.

    Declaration
    public ProgressBarBuilder Tooltip(ProgressBarTooltipSettings tooltip)
    Parameters
    Type Name Description
    ProgressBarTooltipSettings tooltip
    Returns
    Type Description
    ProgressBarBuilder

    Tooltip(Action<ProgressBarTooltipSettingsBuilder>)

    Declaration
    public ProgressBarBuilder Tooltip(Action<ProgressBarTooltipSettingsBuilder> tooltip)
    Parameters
    Type Name Description
    System.Action<ProgressBarTooltipSettingsBuilder> tooltip
    Returns
    Type Description
    ProgressBarBuilder

    TooltipRender(String)

    Triggers before the tooltip for series is rendered.

    Declaration
    public ProgressBarBuilder TooltipRender(string tooltipRender)
    Parameters
    Type Name Description
    System.String tooltipRender
    Returns
    Type Description
    ProgressBarBuilder

    TrackColor(String)

    trackColor

    Declaration
    public ProgressBarBuilder TrackColor(string trackColor)
    Parameters
    Type Name Description
    System.String trackColor
    Returns
    Type Description
    ProgressBarBuilder

    TrackThickness(Double)

    track thickness

    Declaration
    public ProgressBarBuilder TrackThickness(double trackThickness)
    Parameters
    Type Name Description
    System.Double trackThickness
    Returns
    Type Description
    ProgressBarBuilder

    Type(ProgressType)

    type of the progress bar

    Declaration
    public ProgressBarBuilder Type(ProgressType type)
    Parameters
    Type Name Description
    ProgressType type
    Returns
    Type Description
    ProgressBarBuilder

    Value(Double)

    progress value

    Declaration
    public ProgressBarBuilder Value(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    ProgressBarBuilder

    ValueChanged(String)

    Triggers after the value has changed.

    Declaration
    public ProgressBarBuilder ValueChanged(string valueChanged)
    Parameters
    Type Name Description
    System.String valueChanged
    Returns
    Type Description
    ProgressBarBuilder

    Width(String)

    width of the progress bar

    Declaration
    public ProgressBarBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    ProgressBarBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved