A slider component used to select numeric value within a range.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbSlider()Returns IgbSlider
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbSliderBase
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Inherited from: IgbSliderBase
The minimum value of the slider scale. Defaults to 0. If min is greater than max the call is a no-op. If labels are provided (projected), then min is always set to 0. If lowerBound ends up being less than than the current min value, it is automatically assigned the new min value.
[Parameter]
public double Min { get; set; }Inherited from: IgbSliderBase
The maximum value of the slider scale. Defaults to 100. If max is less than min the call is a no-op. If labels are provided (projected), then max is always set to the number of labels. If upperBound ends up being greater than than the current max value, it is automatically assigned the new max value.
[Parameter]
public double Max { get; set; }LowerBound
Section titled "LowerBound"Inherited from: IgbSliderBase
The lower bound of the slider value. If not set, the min value is applied.
[Parameter]
public double LowerBound { get; set; }UpperBound
Section titled "UpperBound"Inherited from: IgbSliderBase
The upper bound of the slider value. If not set, the max value is applied.
[Parameter]
public double UpperBound { get; set; }Disabled
Section titled "Disabled"Inherited from: IgbSliderBase
Disables the UI interactions of the slider.
[Parameter]
public bool Disabled { get; set; }DiscreteTrack
Section titled "DiscreteTrack"Inherited from: IgbSliderBase
Marks the slider track as discrete so it displays the steps. If the step is 0, the slider will remain continuos even if discreteTrack is true.
[Parameter]
public bool DiscreteTrack { get; set; }HideTooltip
Section titled "HideTooltip"Inherited from: IgbSliderBase
Hides the thumb tooltip.
[Parameter]
public bool HideTooltip { get; set; }Inherited from: IgbSliderBase
Specifies the granularity that the value must adhere to. If set to 0 no stepping is implied and any value in the range is allowed. If labels are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.
[Parameter]
public double Step { get; set; }PrimaryTicks
Section titled "PrimaryTicks"Inherited from: IgbSliderBase
The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.
[Parameter]
public double PrimaryTicks { get; set; }SecondaryTicks
Section titled "SecondaryTicks"Inherited from: IgbSliderBase
The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.
[Parameter]
public double SecondaryTicks { get; set; }TickOrientation
Section titled "TickOrientation"Inherited from: IgbSliderBase
Changes the orientation of the ticks.
[Parameter]
public SliderTickOrientation TickOrientation { get; set; }HidePrimaryLabels
Section titled "HidePrimaryLabels"Inherited from: IgbSliderBase
Hides the primary tick labels.
[Parameter]
public bool HidePrimaryLabels { get; set; }HideSecondaryLabels
Section titled "HideSecondaryLabels"Inherited from: IgbSliderBase
Hides the secondary tick labels.
[Parameter]
public bool HideSecondaryLabels { get; set; }Locale
Section titled "Locale"Inherited from: IgbSliderBase
The locale used to format the thumb and tick label values in the slider.
[Parameter]
public string Locale { get; set; }ValueFormat
Section titled "ValueFormat"Inherited from: IgbSliderBase
String format used for the thumb and tick label values in the slider.
[Parameter]
public string ValueFormat { get; set; }TickLabelRotation
Section titled "TickLabelRotation"Inherited from: IgbSliderBase
The degrees for the rotation of the tick labels. Defaults to 0.
[Parameter]
public SliderTickLabelRotation TickLabelRotation { get; set; }ValueFormatOptions
Section titled "ValueFormatOptions"Inherited from: IgbSliderBase
Number format options used for the thumb and tick label values in the slider.
[Parameter]
public IgbNumberFormatSpecifier ValueFormatOptions { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }DirectRenderElementName
Section titled "DirectRenderElementName"protected override string DirectRenderElementName { get; }Invalid
Section titled "Invalid"Control the validity of the control.
[Parameter]
public bool Invalid { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }UseDirectRender
Section titled "UseDirectRender"protected override bool UseDirectRender { get; }Value
Section titled "Value"The current value of the component.
[Parameter]
public double Value { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbSliderBase
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbSliderBase
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
CheckValidity()
Section titled "CheckValidity()"public void CheckValidity()Returns any
CheckValidityAsync()
Section titled "CheckValidityAsync()"Checks for validity of the control and emits the invalid event if it invalid.
public Task CheckValidityAsync()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetCurrentValue()
Section titled "GetCurrentValue()"public double GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<double> GetCurrentValueAsync()Returns any
ReportValidity()
Section titled "ReportValidity()"public void ReportValidity()Returns any
ReportValidityAsync()
Section titled "ReportValidityAsync()"Checks for validity of the control and shows the browser message if it invalid.
public Task ReportValidityAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
SetCustomValidity(string)
Section titled "SetCustomValidity(string)"public void SetCustomValidity(string message)Parameters
- message:
string
Returns any
SetCustomValidityAsync(string)
Section titled "SetCustomValidityAsync(string)"Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.
public Task SetCustomValidityAsync(string message)Parameters
- message:
string
Returns any
StepDown(double)
Section titled "StepDown(double)"public void StepDown(double stepDecrement = 1)Parameters
- stepDecrement:
double
Returns any
StepDownAsync(double)
Section titled "StepDownAsync(double)"Decrements the value of the slider by stepDecrement * step, where stepDecrement defaults to 1. stepDecrement Optional step decrement. If no parameter is passed, it defaults to 1.
public Task StepDownAsync(double stepDecrement = 1)Parameters
- stepDecrement:
double
Returns any
StepUp(double)
Section titled "StepUp(double)"public void StepUp(double stepIncrement = 1)Parameters
- stepIncrement:
double
Returns any
StepUpAsync(double)
Section titled "StepUpAsync(double)"Increments the value of the slider by stepIncrement * step, where stepIncrement defaults to 1. stepIncrement Optional step increment. If no parameter is passed, it defaults to 1.
public Task StepUpAsync(double stepIncrement = 1)Parameters
- stepIncrement:
double
Returns any
Events
Section titled "Events"Change
Section titled "Change"[Parameter]
public EventCallback<IgbNumberEventArgs> Change { get; set; }Input
Section titled "Input"[Parameter]
public EventCallback<IgbNumberEventArgs> Input { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<double> ValueChanged { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }InputScript
Section titled "InputScript"[Parameter]
public string InputScript { get; set; }