RibbonNumericBox Class

Represents a numeric box element in C1Ribbon and C1StatusBar controls.

Inheritance

object

MarshalByRefObject

Component

RibbonItem

RibbonIconItem

RibbonNumericBox

Implements

IComponent

IDisposable

ISupportUiaContainer

IUiaRangeValueProvider

Namespace: C1.Win.Ribbon

Assembly: C1.Win.Ribbon.10.dll

Syntax

public class RibbonNumericBox : RibbonIconItem, IComponent, IDisposable, ISupportUiaContainer, IUiaRangeValueProvider

Public Class RibbonNumericBox
    Inherits RibbonIconItem
    Implements IComponent, IDisposable, ISupportUiaContainer, IUiaRangeValueProvider

Constructors

Name	Description
RibbonNumericBox()	Creates a new instance of RibbonNumericBox.

Properties

Name	Description
CanBeAddedToQat	Gets or sets whether the user can add this RibbonItem to the Quick Access Toolbar at runtime.
ContextMenuStrip	Gets or sets the context menu strip associated with the numeric box.
CueBanner	Gets or sets the textual cue, or tip, that is displayed by RibbonNumericBox to prompt the user for information.
CurrencySymbol	Gets or sets the string to use as the currency symbol.
DecimalPlaces	Gets or sets the number of decimal places to display in the RibbonNumericBox.
Format	Gets or sets the format of the Value displayed in the RibbonNumericBox.
GapBeforeTextArea	Gets or sets the gap between the label and text area when this RibbonNumericBox appears on a RibbonGroup.
Increment	Gets or sets the amount by which the Value property changes when the users presses the up and down keys.
KeyTip	Gets or sets the KeyTip providing keyboard access to a RibbonNumericBox.
Label	Gets or sets the label used to identify this RibbonNumericBox.
LabelWidth	Gets or sets the width of the text label. Set to -1 to let the label calculate width automatically.
Maximum	Gets or sets the maximum value accepted by the component.
Minimum	Gets or sets the minimum value accepted by the component.
NegativePattern	Gets or sets the format pattern for negative values. The meaning depends on the StandardFormat.
NumberFormat	Gets the NumberFormatInfo that is used for data formatting.
PositivePattern	Gets or sets the format pattern for positive values. The meaning depends on the StandardFormat.
ReadOnly	Gets or sets a value indicating whether the contents of the component can be changed.
SpinButtonPressDelay	Gets or sets the interval before the spin buttons start firing click events, in milliseconds.
SpinButtonPressInterval	Gets or sets the interval between clicks when the spin buttons are kept pressed, in milliseconds.
StandardFormat	Sets the standard numeric format.
Text	Gets or sets the text in the RibbonNumericBox.
TextAlign	Gets or sets how text is aligned in the RibbonNumericBox.
TextAreaWidth	Gets or sets the width of RibbonNumericBox's text area.
TextBox	Gets the TextBox control contained in this RibbonNumericBox.
Value	Gets or sets the current decimal value in the component.
ValueIsNull	Gets or sets whether the current Value is null.

Methods

Name	Description
DownButton()	Simulates a click of the down button.
OnChangeCanceled(EventArgs)	Raises the ChangeCanceled event.
OnChangeCommitted(EventArgs)	Raises the ChangeCommitted event.
OnFormatChanged(EventArgs)	Raises the FormatChanged event.
OnGotFocus(EventArgs)	Raises the GotFocus event.
OnKeyDown(KeyEventArgs)	Raises the KeyDown event.
OnKeyPress(KeyPressEventArgs)	Raises the KeyPress event.
OnKeyUp(KeyEventArgs)	Raises the KeyUp event.
OnLostFocus(EventArgs)	Raises the LostFocus event.
OnPrepareNumberFormat(PrepareNumberFormatEventArgs)	Raises the PrepareNumberFormat event.
OnSpinButtonClick(SpinButtonClickEventArgs)	Raises the SpinButtonClick event.
OnTextChanged(EventArgs)	Raises the TextChanged event.
OnValueChanged(EventArgs)	Raises the ValueChanged event.
ResetIncrement()
ResetMaximum()
ResetMinimum()
ResetValue()
ShouldSerializeIncrement()
ShouldSerializeMaximum()
ShouldSerializeMinimum()
ShouldSerializeStandardFormat()
ShouldSerializeValue()
UpButton()	Simulates a click of the up button.

Events

Name	Description
ChangeCanceled	Occurs when the user cancels changes to the RibbonNumericBox.
ChangeCommitted	Occurs when the user commits changes to the RibbonNumericBox.
FormatChanged	Fires when the Format property changes.
GotFocus	Occurs when the RibbonNumericBox receives focus.
KeyDown	Occurs when a key is first pressed.
KeyPress	Occurs when the user presses and releases a key.
KeyUp	Occurs when a key is released.
LostFocus	Occurs when the RibbonNumericBox loses focus.
PrepareNumberFormat	Fires when the NumberFormat property is recreated.
SpinButtonClick	Fires when the up/down buttons are clicked, before their built-in processing.
TextChanged	Event raised when the text is changed.
ValueChanged	Fires when the Value property changes.