Class RadSpinEditor

Represents a numeric up/down control box. The RadSpinEditor class is a simple wrapper for the RadSpinElement class. The RadSpinEditor acts to transfer events to and from its corresponding RadSpinElement. The RadSpinElement which is essentially the RadSpinEditor control may be nested in other telerik controls.

Inheritance
System.Object
RadControl
RadEditorControl
RadSpinEditor
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Editors")]
public class RadSpinEditor : RadEditorControl, INotifyPropertyChanged, ISupportInitializeNotification, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, ISupportInitialize, ISupportRootUIAutomation

Constructors

RadSpinEditor()

Initializes a new instance of the RadSpinEditor class.

Declaration
public RadSpinEditor()

Properties

AutoSize

Gets or sets whether the edit control is auto-sized.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

CausesValidation

Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.

Declaration
public bool CausesValidation { get; set; }
Property Value
System.Boolean

true if the control causes validation to be performed on any controls requiring validation when it receives focus; otherwise, false.

DecimalPlaces

Gets or sets the number of decimal places to display in the RadSpinEditor.

Declaration
public int DecimalPlaces { get; set; }
Property Value
System.Int32

DefaultSize

Gets the default control size.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

EnableNullValueInput

Gets or sets how to interpret the empty text in the editor portion of the control. If true the empty value will set NULL in NullableValue property.

Declaration
public virtual bool EnableNullValueInput { get; set; }
Property Value
System.Boolean

EnableUIAutomation

Gets or sets a value indicating whether the UI Automation functionality is enabled or disabled for this control.

Declaration
public override bool EnableUIAutomation { get; set; }
Property Value
System.Boolean

Overrides
Implements

Hexadecimal

Gets or sets a value indicating whether the RadSpinEditor should display the value it contains in hexadecimal format.

Declaration
public bool Hexadecimal { get; set; }
Property Value
System.Boolean

Increment

Gets or sets the increment value for step.

Declaration
public decimal Increment { get; set; }
Property Value
System.Decimal

InterceptArrowKeys

Gets or sets a value indicating whether the user can use the UP ARROW and DOWN ARROW keys to select values.

Declaration
public bool InterceptArrowKeys { get; set; }
Property Value
System.Boolean

Maximum

Gets or sets the maximum value for the spin editor.

Declaration
public decimal Maximum { get; set; }
Property Value
System.Decimal

Minimum

Gets or sets the minimum value for the spin editor.

Declaration
public decimal Minimum { get; set; }
Property Value
System.Decimal

Name

Gets or sets the name of the control.

Declaration
public string Name { get; set; }
Property Value
System.String

NullableValue

Gets or sets the decimal value in the numeric up/down control. The Value can be null.

Declaration
public decimal? NullableValue { get; set; }
Property Value
System.Nullable<System.Decimal>

ReadOnly

Gets or sets a value indicating whether the text can be changed by the use of the up or down buttons only.

Declaration
public bool ReadOnly { get; set; }
Property Value
System.Boolean

RightMouseButtonReset

Gets or sets whether by right-mouse clicking the up/down button you reset the value to the Maximum/Minimum value respectively.

Declaration
public bool RightMouseButtonReset { get; set; }
Property Value
System.Boolean

ShowBorder

Gets or sets a value indicating whether the border is shown.

Declaration
public bool ShowBorder { get; set; }
Property Value
System.Boolean

ShowUpDownButtons

Gets or sets whether RadSpinEditor will be used as a numeric textbox.

Declaration
public bool ShowUpDownButtons { get; set; }
Property Value
System.Boolean

SpinElement

Gets the instance of RadSpinElement wrapped by this control. RadSpinElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadSpinEditor.

Declaration
public RadSpinElement SpinElement { get; }
Property Value
RadSpinElement

Step

Set or get the Step value

Declaration
public decimal Step { get; set; }
Property Value
System.Decimal

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

Declaration
public bool TabStop { get; set; }
Property Value
System.Boolean

true if the user can give the focus to the control using the TAB key, otherwise false. The default is true.

Text

The property is not used in RadSpinEditor. It is overridden to hide the Text property of the base class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

TextAlignment

Gets or sets the text alignment of the RadSpinEditor.

Declaration
public virtual HorizontalAlignment TextAlignment { get; set; }
Property Value
System.Windows.Forms.HorizontalAlignment

ThousandsSeparator

Gets or sets a value indicating whether a thousands separator is displayed in the RadSpinEditor.

Declaration
public bool ThousandsSeparator { get; set; }
Property Value
System.Boolean

Value

Gets or sets the decimal value in the numeric up/down control.

Declaration
public decimal Value { get; set; }
Property Value
System.Decimal

Wrap

Gets or sets a value indicating that value will revert to minimum value after reaching maximum and to maximum after reaching minimum.

Declaration
public bool Wrap { get; set; }
Property Value
System.Boolean

Methods

ControlDefinesThemeForElement(RadElement)

Determines whether the control defines the theme for the specified element.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element to check.
Returns
System.Boolean

true if the control defines the theme for the element; otherwise, false.
Overrides

CreateAccessibilityInstance()

Creates the accessibility instance for this control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

An System.Windows.Forms.AccessibleObject instance for accessibility support.

CreateChildItems(RadElement)

Creates child items in the RadSpinEditor control element hierarchy.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which child items are added.
Overrides

CreateSpinElement()

Creates the spin element for this control.

Declaration
protected virtual RadSpinElement CreateSpinElement()
Returns
RadSpinElement

A RadSpinElement instance.

OnEnter(EventArgs)

Raises the System.Windows.Forms.Control.Enter event.

Declaration
protected override void OnEnter(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs containing the event data.

OnLeave(EventArgs)

Raises the System.Windows.Forms.Control.Leave event.

Declaration
protected override void OnLeave(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs containing the event data.

OnLostFocus(EventArgs)

Raises the System.Windows.Forms.Control.LostFocus event.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs containing the event data.
Overrides

OnRightToLeftChanged(EventArgs)

Raises the System.Windows.Forms.Control.RightToLeftChanged event.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs containing the event data.
Overrides

OnValidated(EventArgs)

Raises the Validated event.

Declaration
protected override void OnValidated(EventArgs e)
Parameters
System.EventArgs e

An EventArgs containing the event data.

OnValueChanged(EventArgs)

Raises the ValueChanged event.

Declaration
protected virtual void OnValueChanged(EventArgs args)
Parameters
System.EventArgs args

An System.EventArgs containing the event data.

OnValueChanging(ValueChangingEventArgs)

Raises the ValueChanging event.

Declaration
protected virtual void OnValueChanging(ValueChangingEventArgs args)
Parameters
ValueChangingEventArgs args

A ValueChangingEventArgs containing the event data.

PerformStep(Decimal)

Increases or decreases the value in the numeric up/down control by the specified step value.

Declaration
public void PerformStep(decimal step)
Parameters
System.Decimal step

The value to add to or subtract from the current value.

ProcessAutoSizeChanged(Boolean)

Processes the AutoSize property when it changes.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

The new value of the AutoSize property.
Overrides

ResetBackColorThemeOverrides()

Resets the BackColor theme overrides.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets the ForeColor theme overrides.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

Select(Boolean, Boolean)

Activates a child control.

Declaration
protected override void Select(bool directed, bool forward)
Parameters
System.Boolean directed

true to specify the direction of the control to select; otherwise, false.
System.Boolean forward

true to move forward in the tab order; false to move backward in the tab order.

SetBackColorThemeOverrides()

Sets the BackColor theme overrides.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Sets the ForeColor theme overrides.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

WndProc(ref Message)

Processes Windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows Message to process.
Overrides

Events

NullableValueChanged

Occurs when the NullableValue of the RadSpinEditor is changed.

Declaration
public event EventHandler NullableValueChanged
Event Type
System.EventHandler

ValueChanged

Occurs before the value of the RadSpinEditor is changed.

Declaration
public event EventHandler ValueChanged
Event Type
System.EventHandler

ValueChanging

Occurs before the value of the RadSpinEditor is changing.

Declaration
public event ValueChangingEventHandler ValueChanging
Event Type
ValueChangingEventHandler

Explicit Interface Implementations

ISupportRootUIAutomation.DisposeUIAutomationProvider()

Clears the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.DisposeUIAutomationProvider()
Implements

ISupportRootUIAutomation.InitializeUIAutomationProvider()

Creates the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.InitializeUIAutomationProvider()
Implements

ISupportRootUIAutomation.RootUIAutomationManager

Gets the UI Automation Manager.

Declaration
IRootUIAutomationManager ISupportRootUIAutomation.RootUIAutomationManager { get; }
Returns
IRootUIAutomationManager

Implements

ISupportRootUIAutomation.UIAutomationProvider

Gets the UI Automation Provider.

Declaration
IRadRawElementProviderFragmentRoot ISupportRootUIAutomation.UIAutomationProvider { get; }
Returns
IRadRawElementProviderFragmentRoot

Implements

Extension Methods