Class SliderBuilder

Inheritance
System.Object
ControlBuilder
SliderBuilder
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.EJ2.Inputs
Assembly: Syncfusion.EJ2.dll
Syntax
public class SliderBuilder : ControlBuilder

Constructors

SliderBuilder()

Declaration
public SliderBuilder()

SliderBuilder(Slider)

Declaration
public SliderBuilder(Slider model)
Parameters
Type Name Description
Slider model

Fields

model

Declaration
public Slider model
Field Value
Type Description
Slider

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

Methods

Change(String)

We can trigger change event whenever Slider value is changed. In other term, this event will be triggered while drag the slider thumb. {% codeBlock src='slider/changeEvent/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder Change(string change)
Parameters
Type Name Description
System.String change
Returns
Type Description
SliderBuilder

Changed(String)

Fires whenever the Slider value is changed. In other term, this event will be triggered, while drag the slider thumb completed.

Declaration
public SliderBuilder Changed(string changed)
Parameters
Type Name Description
System.String changed
Returns
Type Description
SliderBuilder

ColorRange(Object)

Specifies the color to the slider based on given value.

Declaration
public SliderBuilder ColorRange(object colorRange)
Parameters
Type Name Description
System.Object colorRange
Returns
Type Description
SliderBuilder

Created(String)

Triggers when the Slider is successfully created.

Declaration
public SliderBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
SliderBuilder

CssClass(String)

Specifies the custom classes to be added to the element used to customize the slider. {% codeBlock src='slider/cssClass/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder CssClass(string cssClass)
Parameters
Type Name Description
System.String cssClass
Returns
Type Description
SliderBuilder

CustomValues(Double[])

Specifies an array of slider values in number or string type. The min and max step values are not considered.

Declaration
public SliderBuilder CustomValues(double[] customValues)
Parameters
Type Name Description
System.Double[] customValues
Returns
Type Description
SliderBuilder

CustomValues(Object)

Specifies an array of slider values in number or string type. The min and max step values are not considered.

Declaration
public SliderBuilder CustomValues(object customValues)
Parameters
Type Name Description
System.Object customValues
Returns
Type Description
SliderBuilder

CustomValues(String[])

Specifies an array of slider values in number or string type. The min and max step values are not considered.

Declaration
public SliderBuilder CustomValues(string[] customValues)
Parameters
Type Name Description
System.String[] customValues
Returns
Type Description
SliderBuilder

EnableAnimation(Boolean)

Enable or Disable the animation for slider movement.

Declaration
public SliderBuilder EnableAnimation(bool enableAnimation = true)
Parameters
Type Name Description
System.Boolean enableAnimation
Returns
Type Description
SliderBuilder

Enabled(Boolean)

Enable or Disable the slider.

Declaration
public SliderBuilder Enabled(bool enabled = true)
Parameters
Type Name Description
System.Boolean enabled
Returns
Type Description
SliderBuilder

EnableHtmlSanitizer(Boolean)

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

Declaration
public SliderBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
Type Name Description
System.Boolean enableHtmlSanitizer
Returns
Type Description
SliderBuilder

EnablePersistence(Boolean)

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

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

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

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

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 SliderBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
SliderBuilder

Limits(SliderLimitData)

Specified the limit within which the slider to be moved. Refer the documentation here to know more about this property.

Declaration
public SliderBuilder Limits(SliderLimitData limits)
Parameters
Type Name Description
SliderLimitData limits
Returns
Type Description
SliderBuilder

Limits(Action<SliderLimitDataBuilder>)

Declaration
public SliderBuilder Limits(Action<SliderLimitDataBuilder> limits)
Parameters
Type Name Description
System.Action<SliderLimitDataBuilder> limits
Returns
Type Description
SliderBuilder

Locale(String)

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

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

Max(Double)

Gets/Sets the maximum value of the slider.

Declaration
public SliderBuilder Max(double max)
Parameters
Type Name Description
System.Double max
Returns
Type Description
SliderBuilder

Min(Double)

Gets/Sets the minimum value of the slider.

Declaration
public SliderBuilder Min(double min)
Parameters
Type Name Description
System.Double min
Returns
Type Description
SliderBuilder

Orientation(SliderOrientation)

Specifies whether to render the slider in vertical or horizontal orientation. Refer the documentation here to know more about this property.

Declaration
public SliderBuilder Orientation(SliderOrientation orientation)
Parameters
Type Name Description
SliderOrientation orientation
Returns
Type Description
SliderBuilder

Readonly(Boolean)

Declaration
public SliderBuilder Readonly(bool readOnly = true)
Parameters
Type Name Description
System.Boolean readOnly
Returns
Type Description
SliderBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
System.Web.HtmlString

RenderedTicks(String)

Triggers when the ticks are rendered on the Slider. {% codeBlock src='slider/renderedticksEvent/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder RenderedTicks(string renderedTicks)
Parameters
Type Name Description
System.String renderedTicks
Returns
Type Description
SliderBuilder

RenderingTicks(String)

Triggers on rendering the ticks element in the Slider, which is used to customize the ticks labels dynamically. {% codeBlock src='slider/renderingticksEvent/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder RenderingTicks(string renderingTicks)
Parameters
Type Name Description
System.String renderingTicks
Returns
Type Description
SliderBuilder

ShowButtons(Boolean)

Specifies whether to show or hide the increase/decrease buttons of Slider to change the slider value. Refer the documentation here to know more about this property.

Declaration
public SliderBuilder ShowButtons(bool showButtons = true)
Parameters
Type Name Description
System.Boolean showButtons
Returns
Type Description
SliderBuilder

Step(Double)

Specifies the step value for each value change when the increase / decrease button is clicked or on arrow keys press or on dragging the thumb. Refer the documentation here to know more about this property.

Declaration
public SliderBuilder Step(double step)
Parameters
Type Name Description
System.Double step
Returns
Type Description
SliderBuilder

Ticks(SliderTicksData)

It is used to render the slider ticks options such as placement and step values. Refer the documentation here to know more about this property with demo. {% codeBlock src='slider/ticks/index.md' %}{% endcodeBlock %} {% codeBlock src="slider/ticks-api/index.ts" %}{% endcodeBlock %}

Declaration
public SliderBuilder Ticks(SliderTicksData ticks)
Parameters
Type Name Description
SliderTicksData ticks
Returns
Type Description
SliderBuilder

Ticks(Action<SliderTicksDataBuilder>)

Declaration
public SliderBuilder Ticks(Action<SliderTicksDataBuilder> ticks)
Parameters
Type Name Description
System.Action<SliderTicksDataBuilder> ticks
Returns
Type Description
SliderBuilder

Tooltip(SliderTooltipData)

Specifies the visibility, position of the tooltip over the slider element.

Declaration
public SliderBuilder Tooltip(SliderTooltipData tooltip)
Parameters
Type Name Description
SliderTooltipData tooltip
Returns
Type Description
SliderBuilder

Tooltip(Action<SliderTooltipDataBuilder>)

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

TooltipChange(String)

Triggers when the Sider tooltip value is changed. {% codeBlock src='slider/tooltipChangeEvent/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder TooltipChange(string tooltipChange)
Parameters
Type Name Description
System.String tooltipChange
Returns
Type Description
SliderBuilder

Type(SliderType)

Defines the type of the Slider. The available options are: default - Allows to a single value in the Slider. minRange - Allows to select a single value in the Slider. It display’s a shadow from the start to the current value. range - Allows to select a range of values in the Slider. It displays shadow in-between the selection range. {% codeBlock src='slider/types/index.md' %}{% endcodeBlock %}

Declaration
public SliderBuilder Type(SliderType type)
Parameters
Type Name Description
SliderType type
Returns
Type Description
SliderBuilder

Value(Double)

It is used to denote the current value of the Slider. The value should be specified in array of number when render Slider type as range.

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

Value(Double[])

It is used to denote the current value of the Slider. The value should be specified in array of number when render Slider type as range.

Declaration
public SliderBuilder Value(double[] value)
Parameters
Type Name Description
System.Double[] value
Returns
Type Description
SliderBuilder

Value(Object)

It is used to denote the current value of the Slider. The value should be specified in array of number when render Slider type as range.

Declaration
public SliderBuilder Value(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
SliderBuilder

Width(Double)

Specifies the width of the Slider.

Declaration
public SliderBuilder Width(double width)
Parameters
Type Name Description
System.Double width
Returns
Type Description
SliderBuilder

Width(String)

Specifies the width of the Slider.

Declaration
public SliderBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
SliderBuilder