Class NumericUpDownControl

Represents a Windows spin box (also known as an up-down control) that displays numeric values. Wraps the System.Windows.Forms.NumericUpDown control.

Inheritance
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Base
ComponentBase
DialogComponentBase
DialogControl
DataFilterBaseControl
NumericUpDownControl
Implements
Inherited Members
FastReport.ComponentBase.CheckNegativeSize(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.DrawDragAcceptFrame(FastReport.Utils.FRPaintEventArgs, System.Drawing.Color)
FastReport.ComponentBase.GetPreferredSize()
FastReport.ComponentBase.GetSmartTag()
FastReport.ComponentBase.HandleDoubleClick()
FastReport.ComponentBase.HandleDragDrop(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleDragOver(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleKeyDown(System.Windows.Forms.Control, System.Windows.Forms.KeyEventArgs)
FastReport.ComponentBase.HandleMouseDown(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseHover(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseMove(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseUp(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseWheel(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.PointInObject(System.Drawing.PointF)
FastReport.ComponentBase.DrawSelectionPoint(FastReport.Utils.FRPaintEventArgs, System.Drawing.Pen, System.Drawing.Brush, System.Single, System.Single)
FastReport.ComponentBase.PointInSelectionPoint(System.Single, System.Single, System.Drawing.PointF)
FastReport.Base.IsSelected
FastReport.Base.IsParentSelected
FastReport.Base.Delete()
FastReport.Base.OnAfterInsert(FastReport.InsertFrom)
FastReport.Base.SelectionChanged()
FastReport.Base.GetImageIndex()
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class NumericUpDownControl : DataFilterBaseControl, IComponent, IDisposable, IFRSerializable, IHasEditor

Constructors

NumericUpDownControl()

Initializes a new instance of the NumericUpDownControl class with default settings.

Declaration
public NumericUpDownControl()

Properties

DecimalPlaces

Gets or sets the number of decimal places to display in the up-down control. Wraps the System.Windows.Forms.NumericUpDown.DecimalPlaces property.

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

Hexadecimal

Gets or sets a value indicating whether the up-down control should display the value it contains in hexadecimal format. Wraps the System.Windows.Forms.NumericUpDown.Hexadecimal property.

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

Increment

Gets or sets the value to increment or decrement the up-down control when the up or down buttons are clicked. Wraps the System.Windows.Forms.NumericUpDown.Increment property.

Declaration
public float Increment { get; set; }
Property Value
Type Description
System.Single

Maximum

Gets or sets the maximum value for the up-down control. Wraps the System.Windows.Forms.NumericUpDown.Maximum property.

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

Minimum

Gets or sets the minimum value for the up-down control. Wraps the System.Windows.Forms.NumericUpDown.Minimum property.

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

NumericUpDown

Gets an internal NumericUpDown.

Declaration
[Browsable(false)]
public NumericUpDown NumericUpDown { get; }
Property Value
Type Description
System.Windows.Forms.NumericUpDown

Text

This property is not relevant to this class.

Declaration
[Browsable(false)]
public override string Text { get; set; }
Property Value
Type Description
System.String
Overrides

ThousandsSeparator

Gets or sets a value indicating whether a thousands separator is displayed in the up-down control when appropriate. Wraps the System.Windows.Forms.NumericUpDown.ThousandsSeparator property.

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

Value

Gets or sets the value assigned to the up-down control. Wraps the System.Windows.Forms.NumericUpDown.Value property.

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

ValueChangedEvent

Gets or sets a script method name that will be used to handle the ValueChanged event.

Declaration
public string ValueChangedEvent { get; set; }
Property Value
Type Description
System.String

Methods

AttachEvents()

Attaches Control events to its event handlers.

Declaration
protected override void AttachEvents()
Overrides
Remarks

Override this method if your custom control has own events.

DetachEvents()

Detaches Control events from its event handlers.

Declaration
protected override void DetachEvents()
Overrides
Remarks

Override this method if your custom control has own events. In this method, you should detach control's events that were attached in the AttachEvents() method.

GetSelectionPoints()

Gets the object's selection points.

Declaration
protected override SelectionPoint[] GetSelectionPoints()
Returns
Type Description
SelectionPoint[]

Array of SelectionPoint objects.
Overrides
Remarks

Selection point is a small square displayed at the object's sides when object is selected in the designer. You can drag this square by the mouse to change the object's size. For example, the TextObject has eight selection points to change its width and height by the mouse.

If you are developing a new component for FastReport, you may override this method if your object has non-standard set of selection points. For example, if an object has something like "AutoSize" property, it would be good to disable all selection points if that property is true, to disable resizing of the object by the mouse.

GetValue()

Returns value entered in the control.

Declaration
protected override object GetValue()
Returns
Type Description
System.Object

The value of type supported by this control.
Overrides
Remarks

This method must return a value entered by the user. For example, TextBox control must return its Text property value. If this control supports multi-selection, return selected values in an array, for example string[] array for CheckedListBox.

OnLeave(EventArgs)

This method fires the Leave event and the script code connected to the LeaveEvent.

Declaration
public override void OnLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Event data.
Overrides

OnValueChanged(EventArgs)

This method fires the ValueChanged event and the script code connected to the ValueChangedEvent.

Declaration
public virtual void OnValueChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Event data.

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

ShouldSerializeBackColor()

Determines whether is necessary to serialize the BackColor property.

Declaration
protected override bool ShouldSerializeBackColor()
Returns
Type Description
System.Boolean

true if serialization is necessary.
Overrides

ShouldSerializeForeColor()

Determines whether is necessary to serialize the ForeColor property.

Declaration
protected override bool ShouldSerializeForeColor()
Returns
Type Description
System.Boolean

true if serialization is necessary.
Overrides

Events

ValueChanged

Occurs when the Value property has been changed in some way. Wraps the System.Windows.Forms.NumericUpDown.ValueChanged event.

Declaration
public event EventHandler ValueChanged
Event Type
Type Description
System.EventHandler

Implements