Table of Contents

Class MudTimePicker

Namespace
MudBlazor
Assembly
MudBlazor.dll
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

If true, enables 12 hour selection clock.

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

Property Value

bool

AutoClose

If true and PickerActions are defined, the hour and the minutes can be defined without any action.

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

Property Value

bool

ClockElementReference

protected ElementReference ClockElementReference { get; }

Property Value

ElementReference

ClosingDelay

Sets 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

This helps the user see that the time was selected before the popover disappears.

HoursButtonClassname

protected string HoursButtonClassname { get; }

Property Value

string

MinuteButtonClassname

protected string MinuteButtonClassname { get; }

Property Value

string

MinuteSelectionStep

Sets the number interval for minutes.

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

Property Value

int

OpenTo

First view to show in the MudDatePicker.

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

Property Value

OpenTo

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

true while the main pointer button is held down and moving.

public bool PointerMoving { get; set; }

Property Value

bool

Remarks

Disables clock animations.

Time

The currently selected time (two-way bindable). If null, nothing was selected.

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

Property Value

TimeSpan?

TimeChanged

Fired when the date changes.

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

Property Value

EventCallback<TimeSpan?>

TimeEditMode

Selects the edit mode. By default, you can edit hours and minutes.

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

Property Value

TimeEditMode

TimeFormat

String format for selected time view.

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

Property Value

string

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. This method is called by the JavaScript events.

[JSInvokable]
public Task OnStickClick(int value)

Parameters

value int

The minute or hour.

Returns

Task

ReturnTimeBackUpAsync()

protected Task ReturnTimeBackUpAsync()

Returns

Task

SelectTimeFromStick(int, bool)

Updates the position of the hands on the clock. This method is called by the JavaScript events.

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

Parameters

value int

The minute or hour.

pointerMoving bool

Is the pointer being moved?

Returns

Task

SetTimeAsync(TimeSpan?, bool)

protected Task SetTimeAsync(TimeSpan? time, bool updateValue)

Parameters

time TimeSpan?
updateValue bool

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