Class MaskedTextBoxControl

Uses a mask to distinguish between proper and improper user input. Wraps the System.Windows.Forms.MaskedTextBox control.

Inheritance
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Base
ComponentBase
DialogComponentBase
DialogControl
DataFilterBaseControl
MaskedTextBoxControl
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 MaskedTextBoxControl : DataFilterBaseControl, IComponent, IDisposable, IFRSerializable, IHasEditor

Constructors

MaskedTextBoxControl()

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

Declaration
public MaskedTextBoxControl()

Properties

Mask

Gets or sets the input mask to use at run time. Wraps the System.Windows.Forms.MaskedTextBox.Mask property.

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

MaskedTextBox

Gets an internal MaskedTextBox.

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

SkipLiterals

Gets or sets a value indicating whether the user is allowed to reenter literal values. Wraps the System.Windows.Forms.MaskedTextBox.SkipLiterals property.

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

TextAlign

Gets or sets how text is aligned in a masked text box control. Wraps the System.Windows.Forms.MaskedTextBox.TextAlign property.

Declaration
public HorizontalAlignment TextAlign { get; set; }
Property Value
Type Description
System.Windows.Forms.HorizontalAlignment

Methods

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

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

ShouldSerializeCursor()

Determines whether is necessary to serialize the Cursor property.

Declaration
protected override bool ShouldSerializeCursor()
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

Implements