Class StepperBuilder
Inheritance
System.Object
StepperBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class StepperBuilder : ControlBuilder
Constructors
StepperBuilder()
Declaration
StepperBuilder(Stepper)
Declaration
public StepperBuilder(Stepper model)
Parameters
Type |
Name |
Description |
Stepper |
model |
|
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
System.Collections.Generic.IDictionary<System.String, System.Object> |
ID
Declaration
public string ID { get; set; }
Property Value
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
System.IO.TextWriter |
Overrides
Methods
ActiveStep(Int32)
Defines the current step index of the Stepper.
Declaration
public StepperBuilder ActiveStep(int activeStep)
Parameters
Type |
Name |
Description |
System.Int32 |
activeStep |
|
Returns
Animation(StepperAnimationSettings)
Defines the step progress animation of the Stepper.
Declaration
public StepperBuilder Animation(StepperAnimationSettings animation)
Parameters
Returns
Animation(Action<StepperAnimationSettingsBuilder>)
Declaration
public StepperBuilder Animation(Action<StepperAnimationSettingsBuilder> animation)
Parameters
Returns
BeforeStepRender(String)
Event triggers before rendering each step.
Declaration
public StepperBuilder BeforeStepRender(string beforeStepRender)
Parameters
Type |
Name |
Description |
System.String |
beforeStepRender |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public StepperBuilder ContentTemplate(Action<object> template)
Parameters
Type |
Name |
Description |
System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public StepperBuilder ContentTemplate(Func<object, object> template)
Parameters
Type |
Name |
Description |
System.Func<System.Object, System.Object> |
template |
|
Returns
Created(String)
Event callback that is raised after rendering the stepper.
Declaration
public StepperBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
CssClass(String)
Defines the CSS class to customize the Stepper appearance.
Declaration
public StepperBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public StepperBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public StepperBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
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 StepperBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
LabelPosition(StepLabelPosition)
Defines the label position in the Stepper.
Declaration
public StepperBuilder LabelPosition(StepLabelPosition labelPosition)
Parameters
Returns
Linear(Boolean)
Defines whether allows to complete one step in order to move to the next or not.
Declaration
public StepperBuilder Linear(bool linear = true)
Parameters
Type |
Name |
Description |
System.Boolean |
linear |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public StepperBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Orientation(StepperOrientation)
Defines the orientation type of the Stepper.
Declaration
public StepperBuilder Orientation(StepperOrientation orientation)
Parameters
Returns
ReadOnly(Boolean)
Defines whether the read-only mode is enabled for a Stepper control, which means that the user will not be able to interact with it.
Declaration
public StepperBuilder ReadOnly(bool readOnly = true)
Parameters
Type |
Name |
Description |
System.Boolean |
readOnly |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Microsoft.AspNetCore.Html.HtmlString |
Defines a value that defines whether to show tooltip or not on each step.
Declaration
public StepperBuilder ShowTooltip(bool showTooltip = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showTooltip |
|
Returns
StepChanged(String)
Event triggers after active step changed.
Declaration
public StepperBuilder StepChanged(string stepChanged)
Parameters
Type |
Name |
Description |
System.String |
stepChanged |
|
Returns
StepChanging(String)
Event triggers before active step change.
Declaration
public StepperBuilder StepChanging(string stepChanging)
Parameters
Type |
Name |
Description |
System.String |
stepChanging |
|
Returns
StepClick(String)
Event triggers when clicked on step.
Declaration
public StepperBuilder StepClick(string stepClick)
Parameters
Type |
Name |
Description |
System.String |
stepClick |
|
Returns
Steps(Action<StepBuilder>)
Declaration
public StepperBuilder Steps(Action<StepBuilder> steps)
Parameters
Returns
Steps(List<Step>)
Defines the list of steps.
Declaration
public StepperBuilder Steps(List<Step> steps)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<Step> |
steps |
|
Returns
StepType(StepType)
Defines whether steps are display with only indicator, only labels or combination of both.
Declaration
public StepperBuilder StepType(StepType stepType)
Parameters
Returns
Template(String)
Defines the template content for each step.
Declaration
public StepperBuilder Template(string template)
Parameters
Type |
Name |
Description |
System.String |
template |
|
Returns
Defines the template content for the tooltip.
Declaration
public StepperBuilder TooltipTemplate(string tooltipTemplate)
Parameters
Type |
Name |
Description |
System.String |
tooltipTemplate |
|
Returns