Class ProgressButtonBuilder

Inheritance

System.Object

ControlBuilder

ProgressButtonBuilder

Inherited Members

ControlBuilder.Context

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.EJ2.SplitButtons

Assembly: Syncfusion.EJ2.dll

Syntax

public class ProgressButtonBuilder : ControlBuilder

Constructors

ProgressButtonBuilder()

Declaration

public ProgressButtonBuilder()

ProgressButtonBuilder(ProgressButton)

Declaration

public ProgressButtonBuilder(ProgressButton model)

Parameters

Type	Name	Description
ProgressButton	model

Fields

model

Declaration

public ProgressButton model

Field Value

Type	Description
ProgressButton

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

AnimationSettings(ProgressButtonAnimationSettings)

Specifies the animation settings.

Declaration

public ProgressButtonBuilder AnimationSettings(ProgressButtonAnimationSettings animationSettings)

Parameters

Type	Name	Description
ProgressButtonAnimationSettings	animationSettings

Returns

Type	Description
ProgressButtonBuilder

AnimationSettings(Action<ProgressButtonAnimationSettingsBuilder>)

Declaration

public ProgressButtonBuilder AnimationSettings(Action<ProgressButtonAnimationSettingsBuilder> animationSettings)

Parameters

Type	Name	Description
System.Action<ProgressButtonAnimationSettingsBuilder>	animationSettings

Returns

Type	Description
ProgressButtonBuilder

Begin(String)

Triggers when the progress starts.

Declaration

public ProgressButtonBuilder Begin(string begin)

Parameters

Type	Name	Description
System.String	begin

Returns

Type	Description
ProgressButtonBuilder

Content(String)

Defines the text content of the progress button element.

Declaration

public ProgressButtonBuilder Content(string content)

Parameters

Type	Name	Description
System.String	content

Returns

Type	Description
ProgressButtonBuilder

ContentTemplate(Action<Object>)

Declaration

public ProgressButtonBuilder ContentTemplate(Action<object> template)

Parameters

Type	Name	Description
System.Action<System.Object>	template

Returns

Type	Description
ProgressButtonBuilder

ContentTemplate(Func<Object, Object>)

Declaration

public ProgressButtonBuilder ContentTemplate(Func<object, object> template)

Parameters

Type	Name	Description
System.Func<System.Object, System.Object>	template

Returns

Type	Description
ProgressButtonBuilder

Created(String)

Triggers once the component rendering is completed.

Declaration

public ProgressButtonBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
ProgressButtonBuilder

CssClass(String)

Specifies the root CSS class of the progress button that allows customization of component’s appearance. The progress button types, styles, and size can be achieved by using this property.

Declaration

public ProgressButtonBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
ProgressButtonBuilder

Disabled(Boolean)

Enables or disables the progress button.

Declaration

public ProgressButtonBuilder Disabled(bool disabled = true)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type	Description
ProgressButtonBuilder

Duration(Double)

Specifies the duration of progression in the progress button.

Declaration

public ProgressButtonBuilder Duration(double duration)

Parameters

Type	Name	Description
System.Double	duration

Returns

Type	Description
ProgressButtonBuilder

EnableHtmlSanitizer(Boolean)

Defines whether to allow the cross-scripting site or not.

Declaration

public ProgressButtonBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)

Parameters

Type	Name	Description
System.Boolean	enableHtmlSanitizer

Returns

Type	Description
ProgressButtonBuilder

EnableProgress(Boolean)

Enables or disables the background filler UI in the progress button.

Declaration

public ProgressButtonBuilder EnableProgress(bool enableProgress = true)

Parameters

Type	Name	Description
System.Boolean	enableProgress

Returns

Type	Description
ProgressButtonBuilder

End(String)

Triggers when the progress is completed.

Declaration

public ProgressButtonBuilder End(string end)

Parameters

Type	Name	Description
System.String	end

Returns

Type	Description
ProgressButtonBuilder

Fail(String)

Triggers when the progress is incomplete.

Declaration

public ProgressButtonBuilder Fail(string fail)

Parameters

Type	Name	Description
System.String	fail

Returns

Type	Description
ProgressButtonBuilder

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 ProgressButtonBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
ProgressButtonBuilder

IconCss(String)

Defines class/multiple classes separated by a space for the progress button that is used to include an icon. Progress button can also include font icon and sprite image.

Declaration

public ProgressButtonBuilder IconCss(string iconCss)

Parameters

Type	Name	Description
System.String	iconCss

Returns

Type	Description
ProgressButtonBuilder

IconPosition(IconPosition)

Positions an icon in the progress button. The possible values are: Left: The icon will be positioned to the left of the text content. Right: The icon will be positioned to the right of the text content. Top: The icon will be positioned at the top of the text content. Bottom: The icon will be positioned at the bottom of the text content.

Declaration

public ProgressButtonBuilder IconPosition(IconPosition iconPosition)

Parameters

Type	Name	Description
IconPosition	iconPosition

Returns

Type	Description
ProgressButtonBuilder

IsPrimary(Boolean)

Allows the appearance of the progress button to be enhanced and visually appealing when set to true.

Declaration

public ProgressButtonBuilder IsPrimary(bool isPrimary = true)

Parameters

Type	Name	Description
System.Boolean	isPrimary

Returns

Type	Description
ProgressButtonBuilder

IsToggle(Boolean)

Makes the progress button toggle, when set to true. When you click it, the state changes from normal to active.

Declaration

public ProgressButtonBuilder IsToggle(bool isToggle = true)

Parameters

Type	Name	Description
System.Boolean	isToggle

Returns

Type	Description
ProgressButtonBuilder

Progress(String)

Triggers in specified intervals.

Declaration

public ProgressButtonBuilder Progress(string progress)

Parameters

Type	Name	Description
System.String	progress

Returns

Type	Description
ProgressButtonBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

SpinSettings(ProgressButtonSpinSettings)

Specifies a spinner and its related properties.

Declaration

public ProgressButtonBuilder SpinSettings(ProgressButtonSpinSettings spinSettings)

Parameters

Type	Name	Description
ProgressButtonSpinSettings	spinSettings

Returns

Type	Description
ProgressButtonBuilder

SpinSettings(Action<ProgressButtonSpinSettingsBuilder>)

Declaration

public ProgressButtonBuilder SpinSettings(Action<ProgressButtonSpinSettingsBuilder> spinSettings)

Parameters

Type	Name	Description
System.Action<ProgressButtonSpinSettingsBuilder>	spinSettings

Returns

Type	Description
ProgressButtonBuilder