Class Spinner
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
The Spinner is a widget that increases or decreases the numeric values using arrow buttons, or edit values directly. Inherits Layout.
public class Spinner : Layout, IAccessibleObject
- Inheritance
- Derived
- Implements
Constructors
View SourceSpinner()
Creates and initializes a new instance of the Layout class.
Declaration
protected Spinner()
Spinner(EvasObject)
Creates and initializes a new instance of the Spinner class.
Declaration
public Spinner(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | The parent of new Spinner instance |
Properties
View SourceInterval
Sets or gets the interval on time updates for a user mouse button to hold on the spinner widgets' arrows.
Declaration
public double Interval { get; set; }
Property Value
Type | Description |
---|---|
double |
IsEditable
Sets or gets whether the spinner can be directly edited by the user or not.
Declaration
public bool IsEditable { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
By default, it is enabled.
IsWrapEnabled
Sets or gets the wrap of a given spinner widget.
Declaration
public bool IsWrapEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
If wrap is disabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the maximum value. If wrap is enabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the minimum value. By default, it's disabled.
LabelFormat
Sets or gets the label format of the spinner.
Declaration
public string LabelFormat { get; set; }
Property Value
Type | Description |
---|---|
string |
Maximum
Sets or gets the maximum value for the spinner.
Declaration
public double Maximum { get; set; }
Property Value
Type | Description |
---|---|
double |
Minimum
Sets or gets the minimum value for the spinner.
Declaration
public double Minimum { get; set; }
Property Value
Type | Description |
---|---|
double |
RoundBase
Sets or gets the base for rounding.
Declaration
public double RoundBase { get; set; }
Property Value
Type | Description |
---|---|
double |
RoundValue
Sets or gets the round value for rounding.
Declaration
public int RoundValue { get; set; }
Property Value
Type | Description |
---|---|
int |
Step
Sets or gets the step that is used to increment or decrement the spinner value.
Declaration
public double Step { get; set; }
Property Value
Type | Description |
---|---|
double |
Value
Sets or gets the value displayed by the spinner.
Declaration
public double Value { get; set; }
Property Value
Type | Description |
---|---|
double |
Methods
View SourceAddSpecialValue(double, string)
Sets a special string to display in the place of the numerical value.
Declaration
public void AddSpecialValue(double value, string label)
Parameters
Type | Name | Description |
---|---|---|
double | value | The numerical value to be replaced |
string | label | The label to be used |
CreateHandle(EvasObject)
Creates a widget handle.
Declaration
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | Parent EvasObject. |
Returns
Type | Description |
---|---|
System.IntPtr | Handle IntPtr. |
Overrides
View SourceGetSpecialValue(double)
Gets the special string display in the place of the numerical value.
Declaration
public string GetSpecialValue(double value)
Parameters
Type | Name | Description |
---|---|---|
double | value | The replaced numerical value. |
Returns
Type | Description |
---|---|
string | The value of the spinner, which replaced the numerical value with a special string. |
OnRealized()
The callback of the Realized event.
Declaration
protected override void OnRealized()
Overrides
View SourceRemoveSpecialValue(double)
Removes a previously added special value. After this, the spinner will display the value itself instead of a label.
Declaration
public void RemoveSpecialValue(double value)
Parameters
Type | Name | Description |
---|---|---|
double | value | The replaced numerical value. |
Events
View SourceDelayedValueChanged
DelayedValueChanged will be triggered after a short time when the value is changed.
Declaration
public event EventHandler DelayedValueChanged
Event Type
Type | Description |
---|---|
System.EventHandler |
ValueChanged
ValueChanged will be triggered whenever the spinner value is changed.
Declaration
public event EventHandler ValueChanged
Event Type
Type | Description |
---|---|
System.EventHandler |