TimeEdit Class

An editor that allows users to specify a time. Supports the 12- and 24-hour formats.

Namespace : DevExpress.XamarinForms.Editors

Assembly : DevExpress.XamarinForms.Editors.dll

NuGet Package : DevExpress.XamarinForms.Editors

Declaration

csharp

public class TimeEdit :
    EditBase,
    ITimeEditController,
    IEditController,
    IElementController

Remarks

Use the TimeEdit to display and edit a DateTime value.

When a user taps the editor, it invokes the standard iOS or Android time picker that allows the user to select the time.

The editor initially displays a time icon on the right in the edit box. You can also add the following elements:

Left-Hand Custom Icon 2. Label 3. Right-Hand Custom and Predefined Icons 4. Help Text 5. Error Message

Time

Use the Time or TimeSpan property to specify the time in the editor. These properties are synchronized — the time span specifies the amount of time elapsed since midnight.

The following properties allow you to change the appearance and alignment of the time in the edit box:

Property

Description

| | --- | --- | |

TextColor / DisabledTextColor

Specify the text color for each state of the editor.

| |

TextFontSize
TextFontFamily
TextFontAttributes

Specify the font settings of a time displayed in the editor.

| |

TextHorizontalAlignment

Specifies the horizontal alignment of a time displayed in the editor.

Use the following event and properties to specify the action executed when the time changes:

Property/Event

Description

| | --- | --- | |

TimeChanged

Fires when the time displayed in the editor changes.

| |

TimeChangedCommand

Specifies the command executed when the time displayed in the editor changes.

| |

TimeChangedCommandParameter

Specifies the parameter passed to the TimeChangedCommand.

Time Format

The editor can display the time in 12- and 24-hour formats.

The default format depends on the current culture. Use the TimeFormatMode property to specify the time format explicitly.

XAML

xaml

<dxe:TimeEdit TimeFormatMode="HourFormat12"/>

Label

The LabelText property specifies the editor’s input prompt string. The label is displayed inside the editor while the editor is not focused. When the editor gets focus, the label moves to the top. If a value is assigned to the editor, the label is always displayed at the top.

Set the IsLabelFloating property to false to pin the label to the top of the editor. To customize the label’s appearance, use the following properties:

Property

Description

| | --- | --- | |

LabelColor / FocusedLabelColor
DisabledLabelColor / ErrorColor

Specify the label’s color for each state of the editor.

| |

LabelFontSize
TextFontFamily
TextFontAttributes

Specify the label’s font settings.

Placeholder

A placeholder (PlaceholderText) is the input prompt string displayed within the edit box when the editor is empty and focused.

Use the PlaceholderColor property to specify the color of the placeholder text.

Help Text and Error Message

You can display the following labels below an editor:

HelpText - A brief editor description.
ErrorText - A message shown when an error occurs (HasError is true ).

The BottomTextTopIndent property specifies the indent between the editor’s bottom border and the help or error text.

To specify the color and font attributes for the help/error text, use the following properties:

Property

Description

| | --- | --- | |

HelpTextColor
DisabledHelpTextColor

Specify the help text color for different states of an editor.

| |

ErrorColor

Specifies the error message text color.

| |

BottomTextFontSize
BottomTextFontFamily
BottomTextFontAttributes

Specify font settings.

If HelpText is not set, ErrorText appears as an additional line below the edit box and page content shifts down. To prevent this behavior, set the ReserveBottomTextLine property to true.