Class

RadSpinElement

Declaration

public RadSpinElement()

Occurs when the nullable value has changed.

Declaration

public EventHandler NullableValueChanged

Field Value

Declaration

protected decimal internalValue

Field Value

Gets a reference to the down button element used for decrementing the value.

Declaration

[Browsable(false)]
public RadRepeatArrowElement ButtonDown { get; }

Property Value

Gets a reference to the up button element used for incrementing the value.

Declaration

[Browsable(false)]
public RadRepeatArrowElement ButtonUp { get; }

Property Value

Gets the layout element that contains the increment and decrement buttons.

Declaration

protected StackLayoutElement ButtonsLayout { get; }

Property Value

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

Declaration

public int DecimalPlaces { get; set; }

Property Value

Gets or sets the default value for the numeric up/down element.

Declaration

protected decimal DefaultValue { get; set; }

Property Value

Gets or sets a value indicating whether the user can change the value using the mouse wheel.

Declaration

[Browsable(false)]
public bool EnableMouseWheel { get; set; }

Property Value

Gets or sets a value indicating whether empty text in the editor should be interpreted as a null value. When true, an empty text box will result in a null NullableValue.

Declaration

[Browsable(false)]
public virtual bool EnableNullValueInput { get; set; }

Property Value

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

Declaration

public bool Hexadecimal { get; set; }

Property Value

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

Declaration

public bool InterceptArrowKeys { get; set; }

Property Value

Gets the main layout element that arranges the text box and buttons.

Declaration

protected StackLayoutElement Layout { get; }

Property Value

Gets or sets the maximum value that can be entered in the spin element.

Declaration

public decimal MaxValue { get; set; }

Property Value

Gets or sets the minimum value that can be entered in the spin element.

Declaration

public decimal MinValue { get; set; }

Property Value

Gets or sets the nullable decimal value in the numeric up/down element. This value can be null when EnableNullValueInput is true.

Declaration

[Browsable(false)]
public virtual decimal? NullableValue { get; set; }

Property Value

Gets or sets a value indicating whether the text can be changed by the use of the up or down buttons only. When true, direct text input is disabled.

Declaration

public bool ReadOnly { get; set; }

Property Value

Gets or sets a value indicating whether right-clicking the up/down buttons resets the value to maximum/minimum respectively.

Declaration

public bool RightMouseButtonReset { get; set; }

Property Value

Gets or sets a value indicating whether the border around the spin element is visible.

Declaration

[Browsable(true)]
public bool ShowBorder { get; set; }

Property Value

Gets or sets a value indicating whether the up/down buttons are visible and functional. When false, the spin element acts as a numeric text box without increment/decrement buttons.

Declaration

public bool ShowUpDownButtons { get; set; }

Property Value

Gets or sets the value that is added to or subtracted from the current value when incrementing or decrementing.

Declaration

public decimal Step { get; set; }

Property Value

Gets or sets a value indicating whether the element should be stretched vertically to fill available space.

Declaration

public override bool StretchVertically { get; set; }

Property Value

Overrides RadElement.StretchVertically

Gets or sets the text content of the spin element.

Declaration

public override string Text { get; set; }

Property Value

Overrides RadItem.Text

Gets or sets the minimum value that could be set in the spin editor

Declaration

public virtual HorizontalAlignment TextAlignment { get; set; }

Property Value

Gets the underlying text box control used for input.

Declaration

public TextBox TextBoxControl { get; }

Property Value

Gets RadTextBoxItem contained in the spin editor.

Declaration

public virtual RadTextBoxItem TextBoxItem { get; }

Property Value

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

Declaration

public bool ThousandsSeparator { get; set; }

Property Value

Gets or sets the current decimal value of the spin element.

Declaration

public decimal Value { get; set; }

Property Value

Gets or sets a value indicating whether the value wraps around when reaching minimum or maximum limits. When true, exceeding the maximum value wraps to minimum and vice versa.

Declaration

public bool Wrap { get; set; }

Property Value

Constrains the specified value to be within the minimum and maximum range, applying wrap-around logic if enabled.

Declaration

protected virtual decimal Constrain(decimal value)

Parameters

Returns

Creates the child elements that compose the RadSpinElement including text box, buttons, and layout containers.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates the button element for decrementing the value.

Declaration

protected virtual RadRepeatArrowElement CreateDownButton()

Returns

Creates the button element for incrementing the value.

Declaration

protected virtual RadRepeatArrowElement CreateUpButton()

Returns

Disposes of managed resources and unbinds properties.

Declaration

protected override void DisposeManagedResources()

Overrides RadItem.DisposeManagedResources()

Ends the current text editing session and validates the input.

Declaration

protected virtual void EndTextEdit()

Gets the formatted number text representation of the specified value.

Declaration

protected virtual string GetNumberText(decimal num)

Parameters

Returns

Parses the current text content and returns the corresponding decimal value.

Declaration

protected virtual decimal GetValueFromText()

Returns

Initializes the up and down arrow buttons and their container layout.

Declaration

protected virtual void InitializeButtons()

Initializes the default field values for the spin element.

Declaration

protected override void InitializeFields()

Overrides RadItem.InitializeFields()

Measures the desired size of the element within the specified available size.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadElement.MeasureOverride(SizeF)

Handles changes to bit state flags and updates the UI accordingly.

Declaration

protected override void OnBitStateChanged(long key, bool oldValue, bool newValue)

Parameters

Overrides DisposableObject.OnBitStateChanged(long, bool, bool)

Handles key down events and processes arrow keys for value increment/decrement if enabled.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadItem.OnKeyDown(KeyEventArgs)

Handles key press events and performs validation for the current key press.

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides RadItem.OnKeyPress(KeyPressEventArgs)

Raises the NullableValueChanged event.

Declaration

protected virtual void OnNullableValueChanged()

Handles property change notifications and updates related elements.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Handles key press events for the text box, filtering valid numeric input based on current format settings.

Declaration

protected void OnTextBoxKeyPress(KeyPressEventArgs e)

Parameters

Raises the TextChanged event.

Declaration

protected override void OnTextChanged(EventArgs e)

Parameters

Overrides RadItem.OnTextChanged(EventArgs)

Raises the ValueChanged event.

Declaration

protected virtual void OnValueChanged(EventArgs e)

Parameters

Raises the ValueChanging event.

Declaration

protected virtual void OnValueChanging(ValueChangingEventArgs e)

Parameters

Increments or decrements the current value by the specified step amount.

Declaration

public virtual void PerformStep(decimal step)

Parameters

Processes mouse wheel events and forwards them to the parent control.

Declaration

protected virtual void ProcessMouseWheel(MouseEventArgs e)

Parameters

Sets the internal value of the spin element and updates the display.

Declaration

protected virtual void SetSpinValue(decimal value, bool fromValue)

Parameters

Detaches event handlers from the increment and decrement buttons.

Declaration

protected void UnwireButtonEvents()

Detaches event handlers from the text box and other child elements.

Declaration

protected virtual void UnwireEvents()

Validates the current value and updates the display if necessary.

Declaration

public virtual bool Validate()

Returns

Performs core validation logic for the current internal value.

Declaration

protected virtual void ValidateCore()

Validates the input on key press and handles Enter key for value validation.

Declaration

protected virtual void ValidateOnKeyPress(KeyPressEventArgs e)

Parameters

Attaches event handlers to the increment and decrement buttons.

Declaration

protected void WireButtonEvents()

Attaches event handlers to the text box and other child elements.

Declaration

protected virtual void WireEvents()

Handles the focus gained event for the text item and updates the focus border.

Declaration

protected virtual void textItem_GotFocus(object sender, EventArgs e)

Parameters

Handles the focus lost event for the text item and updates the focus border.

Declaration

protected virtual void textItem_LostFocus(object sender, EventArgs e)

Parameters

Occurs when the user presses a key while the spin element has focus.

Declaration

public event KeyEventHandler KeyDown

Event Value

Occurs before the value of the spin element has changed.

Declaration

[Browsable(true)]
public event EventHandler ValueChanged

Event Value

Occurs when the value is being changed. This is a cancelable event.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value