Class Spinner

View Source

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.


                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public class Spinner : Layout, IAccessibleObject
Inheritance
object
EvasObject
AccessibleObject
Widget
Container
Layout
Spinner
Derived
CircleSpinner
CircleSpinner
Implements
IAccessibleObject

Constructors

View Source

Spinner()

Creates and initializes a new instance of the Layout class.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
protected Spinner()
View Source

Spinner(EvasObject)

Creates and initializes a new instance of the Spinner class.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public Spinner(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

The parent of new Spinner instance

Properties

View Source

Interval

Sets or gets the interval on time updates for a user mouse button to hold on the spinner widgets' arrows.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Interval { get; set; }
Property Value
Type Description
double
View Source

IsEditable

Sets or gets whether the spinner can be directly edited by the user or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public bool IsEditable { get; set; }
Property Value
Type Description
bool
Remarks

By default, it is enabled.

View Source

IsWrapEnabled

Sets or gets the wrap of a given spinner widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
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.

View Source

LabelFormat

Sets or gets the label format of the spinner.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public string LabelFormat { get; set; }
Property Value
Type Description
string
View Source

Maximum

Sets or gets the maximum value for the spinner.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Maximum { get; set; }
Property Value
Type Description
double
View Source

Minimum

Sets or gets the minimum value for the spinner.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Minimum { get; set; }
Property Value
Type Description
double
View Source

RoundBase

Sets or gets the base for rounding.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double RoundBase { get; set; }
Property Value
Type Description
double
View Source

RoundValue

Sets or gets the round value for rounding.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public int RoundValue { get; set; }
Property Value
Type Description
int
View Source

Step

Sets or gets the step that is used to increment or decrement the spinner value.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Step { get; set; }
Property Value
Type Description
double
View Source

Value

Sets or gets the value displayed by the spinner.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Value { get; set; }
Property Value
Type Description
double

Methods

View Source

AddSpecialValue(double, string)

Sets a special string to display in the place of the numerical value.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
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
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.
Returns
Type Description
System.IntPtr

Handle IntPtr.
Overrides
View Source

GetSpecialValue(double)

Gets the special string display in the place of the numerical value.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
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.
View Source

OnRealized()

The callback of the Realized event.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
protected override void OnRealized()
Overrides
View Source

RemoveSpecialValue(double)

Removes a previously added special value. After this, the spinner will display the value itself instead of a label.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public void RemoveSpecialValue(double value)
Parameters
Type Name Description
double value

The replaced numerical value.

Events

View Source

DelayedValueChanged

DelayedValueChanged will be triggered after a short time when the value is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public event EventHandler DelayedValueChanged
Event Type
Type Description
System.EventHandler
View Source

ValueChanged

ValueChanged will be triggered whenever the spinner value is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public event EventHandler ValueChanged
Event Type
Type Description
System.EventHandler

Implements

Extension Methods