Class TimeField

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

Constructors

| Edit this page View Source

TimeField()

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

TimeField(int, int, TimeSpan, bool)

Initializes a new instance of TimeField using Absolute positioning.
Declaration
public TimeField(int x, int y, TimeSpan time, bool isShort = false)
Parameters
Type Name Description
int x The x coordinate.
int y The y coordinate.
TimeSpan time Initial time.
bool isShort If true, the seconds are hidden. Sets the IsShortFormat property.
| Edit this page View Source

TimeField(TimeSpan)

Initializes a new instance of TimeField using Computed positioning.
Declaration
public TimeField(TimeSpan time)
Parameters
Type Name Description
TimeSpan time Initial time

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

IsShortFormat

Get or sets whether TimeField uses the short or long time format.
Declaration
public bool IsShortFormat { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Time

Gets or sets the time of the TimeField.
Declaration
public TimeSpan Time { get; set; }
Property Value
Type Description
TimeSpan

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

OnTimeChanged(DateTimeEventArgs<TimeSpan>)

Event firing method that invokes the TimeChanged event.
Declaration
public virtual void OnTimeChanged(DateTimeEventArgs<TimeSpan> args)
Parameters
Type Name Description
DateTimeEventArgs<TimeSpan> args The 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

TimeChanged

TimeChanged event, raised when the Date has changed.
Declaration
public event Action<DateTimeEventArgs<TimeSpan>> TimeChanged
Event Type
Type Description
Action<DateTimeEventArgs<TimeSpan>>
Remarks
This event is raised when the Time changes.

Implements