Class DateField

Simple Date editing View
Inheritance
object
Responder
View
TextField
DateField
Implements
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
The DateField View provides date editing functionality with mouse support.

Constructors

| Edit this page View Source

DateField()

Initializes a new instance of DateField using Computed layout.
Declaration
public DateField()
| Edit this page View Source

DateField(DateTime)

Initializes a new instance of DateField using Computed layout.
Declaration
public DateField(DateTime date)
Parameters
Type Name Description
DateTime date
| Edit this page View Source

DateField(int, int, DateTime, bool)

Initializes a new instance of DateField using Absolute layout.
Declaration
public DateField(int x, int y, DateTime date, bool isShort = false)
Parameters
Type Name Description
int x The x coordinate.
int y The y coordinate.
DateTime date Initial date contents.
bool isShort If true, shows only two digits for the year.

Properties

| Edit this page View Source

CursorPosition

Sets or gets the current cursor position.
Declaration
public override int CursorPosition { get; set; }
Property Value
Type Description
int
Overrides
| Edit this page View Source

Date

Gets or sets the date of the DateField.
Declaration
public DateTime Date { get; set; }
Property Value
Type Description
DateTime
| Edit this page View Source

IsShortFormat

Get or set the date format for the widget.
Declaration
public bool IsShortFormat { get; set; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

DeleteCharLeft(bool)

Deletes the left character.
Declaration
public override void DeleteCharLeft(bool useOldCursorPos = true)
Parameters
Type Name Description
bool useOldCursorPos
Overrides
| Edit this page View Source

DeleteCharRight()

Deletes the right character.
Declaration
public override void DeleteCharRight()
Overrides
| Edit this page View Source

MouseEvent(MouseEvent)

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

OnDateChanged(DateTimeEventArgs<DateTime>)

Event firing method for the DateChanged event.
Declaration
public virtual void OnDateChanged(DateTimeEventArgs<DateTime> args)
Parameters
Type Name Description
DateTimeEventArgs<DateTime> args Event arguments
| Edit this page View Source

ProcessKey(KeyEvent)

Processes key presses for the TextField.
Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
bool
Overrides
Remarks
The TextField control responds to the following keys:
KeysFunction
Delete, BackspaceDeletes the character before cursor.

Events

| Edit this page View Source

DateChanged

DateChanged event, raised when the Date property has changed.
Declaration
public event Action<DateTimeEventArgs<DateTime>> DateChanged
Event Type
Type Description
Action<DateTimeEventArgs<DateTime>>
Remarks
This event is raised when the Date property changes.

Implements