Class ProgressBarPropertiesBuilder

Represents the ProgressBar property builder.

Inheritance

System.Object

ProgressBarPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class ProgressBarPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ProgressBarPropertiesBuilder()

Initializes a new instance of the ProgressBarPropertiesBuilder class.

Declaration

public ProgressBarPropertiesBuilder()

ProgressBarPropertiesBuilder(ProgressBar)

Initializes a new instance of the ProgressBarPropertiesBuilder class.

Declaration

public ProgressBarPropertiesBuilder(ProgressBar progressBar)

Parameters

Type	Name	Description
ProgressBar	progressBar	Accepts the ProgressBar properties

Fields

progressBar

Initializes a new instance of the ProgressBar class.

Declaration

public ProgressBar progressBar

Field Value

Type	Description
ProgressBar

Methods

ClientSideEvents(Action<ProgressBarClientSideEventsBuilder>)

Progressbar ClientSideEvents

Declaration

public ProgressBarPropertiesBuilder ClientSideEvents(Action<ProgressBarClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<ProgressBarClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns progressbar properties builder value

CssClass(String)

Sets the root CSS class for ProgressBar theme, which is used customize.

Declaration

public ProgressBarPropertiesBuilder CssClass(string customCssClass)

Parameters

Type	Name	Description
System.String	customCssClass	customCssClass

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns string value

Enabled()

When this property sets to false, it disables the ProgressBar control

Declaration

public ProgressBarPropertiesBuilder Enabled()

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

Enabled(Boolean)

When this property sets to false, it disables the ProgressBar control.A boolean variable enabled is passed as an argument.

Declaration

public ProgressBarPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

EnablePersistence()

Save current model value to browser cookies for state maintains. While refresh the progressBar control page retains the model value apply from browser cookies

Declaration

public ProgressBarPropertiesBuilder EnablePersistence()

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

EnablePersistence(Boolean)

Save current model value to browser cookies for state maintains. While refresh the progressBar control page retains the model value apply from browser cookies.A boolean variable enablePersistence is passed.

Declaration

public ProgressBarPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence	enablePersistence

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

EnableRTL()

Sets the ProgressBar direction as right to left alignment.

Declaration

public ProgressBarPropertiesBuilder EnableRTL()

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Sets the ProgressBar direction as right to left alignment.A boolean variable enableRTL is passed as an argument.

Declaration

public ProgressBarPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

Height(String)

Defines the height of the ProgressBar.

Declaration

public ProgressBarPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns string value

HtmlAttributes(IDictionary<String, Object>)

Specifies the list of html attributes to be added to Progressbar control.

Declaration

public ProgressBarPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	itemHtmlAttributes

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns object value

MaxValue(Int32)

Sets the maximum value of the ProgressBar.

Declaration

public ProgressBarPropertiesBuilder MaxValue(int maxValue)

Parameters

Type	Name	Description
System.Int32	maxValue	maxValue

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns number value

MinValue(Int32)

Sets the minimum value of the ProgressBar.

Declaration

public ProgressBarPropertiesBuilder MinValue(int minvalue)

Parameters

Type	Name	Description
System.Int32	minvalue	minvalue

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns number value

Percentage(Double)

Sets the ProgressBar value in percentage. The value should be in between 0 to 100.

Declaration

public ProgressBarPropertiesBuilder Percentage(double percentage)

Parameters

Type	Name	Description
System.Double	percentage	percentage

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns number value

Render()

Renders this instance.

Declaration

public void Render()

ShowRoundedCorner()

Specifies the ProgressBar with rounded corners.

Declaration

public ProgressBarPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

ShowRoundedCorner(Boolean)

Specifies the ProgressBar with rounded corners.

Declaration

public ProgressBarPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns boolean value

Text(String)

Sets the custom text for the ProgressBar. The text placed in the middle of the ProgressBar and it can be customizable using the class ‘e-progress-text’.

Declaration

public ProgressBarPropertiesBuilder Text(string text)

Parameters

Type	Name	Description
System.String	text	text

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns string value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Value(Int32)

Sets the ProgressBar value. The value should be in between min and max values.

Declaration

public ProgressBarPropertiesBuilder Value(int value)

Parameters

Type	Name	Description
System.Int32	value	value

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns number value

Width(String)

Defines the width of the ProgressBar.

Declaration

public ProgressBarPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
ProgressBarPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString