Table of Contents

Class MudTimePicker

Namespace
MudBlazor
Assembly
MudBlazor.dll

A component for selecting time values.

public class MudTimePicker : MudPicker<TimeSpan?>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IAsyncDisposable
Inheritance
MudTimePicker
Implements
Inherited Members
Extension Methods

Constructors

MudTimePicker() 

public MudTimePicker()

Properties

AmButtonClassname 

protected string AmButtonClassname { get; }

Property Value

string

AmPm

Shows a 12-hour selection clock.

[Parameter]
[Category("Behavior")]
public bool AmPm { get; set; }

Property Value

bool

Remarks

Defaults to false.
When true, hours 1-12 are displayed with an AM or PM marker.
When false, hours 0-23 are displayed.

AutoClose

Closes this picker when the value is set or cleared.

[Parameter]
[Category("Picker behavior")]
public bool AutoClose { get; set; }

Property Value

bool

Remarks

Defaults to false. When true and PickerActions are defined, the hour and the minutes can be selected and the drop-down will close without having to click any of the action buttons.

ClockElementReference 

protected ElementReference ClockElementReference { get; }

Property Value

ElementReference

ClosingDelay

The amount of time, in milliseconds, to wait before closing the picker.

[Parameter]
[Category("Picker behavior")]
public int ClosingDelay { get; set; }

Property Value

int

Remarks

Defaults to 200. The delay gives users a moment to see the selected time before the popover disappears.

HoursButtonClassname 

protected string HoursButtonClassname { get; }

Property Value

string

MinuteButtonClassname 

protected string MinuteButtonClassname { get; }

Property Value

string

MinuteSelectionStep

The step interval when selecting minutes.

[Parameter]
[Category("Picker behavior")]
public int MinuteSelectionStep { get; set; }

Property Value

int

Remarks

Defaults to 1. For example: a value of 15 would allow minutes 0, 15, 30, and 45 be selected.

OpenTo

The initial view for this picker.

[Parameter]
[Category("Picker behavior")]
public OpenTo OpenTo { get; set; }

Property Value

OpenTo

Remarks

Defaults to Hours.

PickerContent

Gets the content to be rendered inside the picker. Override this property to provide custom content for the picker.

protected override RenderFragment PickerContent { get; }

Property Value

RenderFragment

PmButtonClassname 

protected string PmButtonClassname { get; }

Property Value

string

PointerMoving

Whether the pointer button is held down and moving.

public bool PointerMoving { get; set; }

Property Value

bool

Remarks

When true, clock animations are disabled.

Time

The currently selected time.

[Parameter]
[Category("Data")]
public TimeSpan? Time { get; set; }

Property Value

TimeSpan?

Remarks

When this value changes, TimeChanged occurs.

TimeChanged

Occurs when Time has changed.

[Parameter]
public EventCallback<TimeSpan?> TimeChanged { get; set; }

Property Value

EventCallback<TimeSpan?>

TimeEditMode

Controls which values can be edited.

[Parameter]
[Category("Picker behavior")]
public TimeEditMode TimeEditMode { get; set; }

Property Value

TimeEditMode

Remarks

Defaults to Normal.

TimeFormat

The format applied to time values.

[Parameter]
[Category("Behavior")]
public string TimeFormat { get; set; }

Property Value

string

Remarks

Defaults to hh:mm tt when AmPm is true, otherwise HH:mm.
Format strings are typically a combination of these characters:

  • h (lowercase) for hours in 12-hour time,
  • H (uppercase) for hours in 24-hour time,
  • m for minutes,
  • tt for AM/PM markers.
    For example: h:mm tt would display 6:32 PM, and HH:mm would display 18:32.

ToolbarClassname 

protected string ToolbarClassname { get; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ChangeHourAsync(int) 

protected Task ChangeHourAsync(int hour)

Parameters

hour int

Returns

Task

ChangeMinuteAsync(int) 

protected Task ChangeMinuteAsync(int minute)

Parameters

minute int

Returns

Task

ClearAsync(bool)

Hides this picker.

public override Task ClearAsync(bool close = true)

Parameters

close bool

When true, the picker will be closed if PickerVariant is not Static.

Returns

Task

DisposeAsyncCore()

Called to dispose this instance.

protected override ValueTask DisposeAsyncCore()

Returns

ValueTask

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnHandleKeyDownAsync(KeyboardEventArgs) 

protected override Task OnHandleKeyDownAsync(KeyboardEventArgs obj)

Parameters

obj KeyboardEventArgs

Returns

Task

OnInitialized() 

protected override void OnInitialized()

OnPickerOpenedAsync() 

protected override Task OnPickerOpenedAsync()

Returns

Task

OnStickClick(int)

Performs the click action for the sticks.

[JSInvokable]
public Task OnStickClick(int value)

Parameters

value int

The minute or hour.

Returns

Task

Remarks

This method is invoked via JavaScript.

ReturnTimeBackUpAsync() 

protected Task ReturnTimeBackUpAsync()

Returns

Task

SelectTimeFromStick(int, bool)

Updates the position of the hands on the clock.

[JSInvokable]
public Task SelectTimeFromStick(int value, bool pointerMoving)

Parameters

value int

The minute or hour.

pointerMoving bool

Is the pointer being moved?

Returns

Task

Remarks

This method is invoked via JavaScript.

SetTimeAsync(TimeSpan?, bool)

Sets the selected time value.

protected Task SetTimeAsync(TimeSpan? time, bool updateValue)

Parameters

time TimeSpan?

The new value to set.

updateValue bool

When true, the Text will also be updated.

Returns

Task

StringValueChangedAsync(string)

Occurs when the string value has changed.

protected override Task StringValueChangedAsync(string value)

Parameters

value string

Returns

Task

SubmitAndCloseAsync() 

protected Task SubmitAndCloseAsync()

Returns

Task

SubmitAsync() 

protected override Task SubmitAsync()

Returns

Task

See Also

MudDatePicker
MudDateRangePicker