Class TextValidateField

Text field that validates input through a ITextValidateProvider
Inheritance
object
Responder
View
TextValidateField
Implements
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class TextValidateField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

| Edit this page View Source

TextValidateField()

Initializes a new instance of the TextValidateField class using Computed positioning.
Declaration
public TextValidateField()
| Edit this page View Source

TextValidateField(ITextValidateProvider)

Initializes a new instance of the TextValidateField class using Computed positioning.
Declaration
public TextValidateField(ITextValidateProvider provider)
Parameters
Type Name Description
ITextValidateProvider provider

Properties

| Edit this page View Source

IsValid

This property returns true if the input is valid.
Declaration
public virtual bool IsValid { get; }
Property Value
Type Description
bool
| Edit this page View Source

Provider

Provider
Declaration
public ITextValidateProvider Provider { get; set; }
Property Value
Type Description
ITextValidateProvider
| Edit this page View Source

Text

Text
Declaration
public ustring Text { get; set; }
Property Value
Type Description
ustring

Methods

| Edit this page View Source

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent mouseEvent)
Parameters
Type Name Description
MouseEvent mouseEvent Contains the details about the mouse event.
Returns
Type Description
bool true, if the event was handled, false otherwise.
Overrides
| Edit this page View Source

PositionCursor()

Positions the cursor in the right position based on the currently focused view in the chain.
Declaration
public override void PositionCursor()
Overrides
| Edit this page View Source

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.
Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
bool
Overrides
Remarks

Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process.

The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses.

| Edit this page View Source

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect bounds)
Parameters
Type Name Description
Rect bounds The bounds (view-relative region) to redraw.
Overrides
Remarks

Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).

Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.

Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region.

Implements