RadzenTimeSpanPicker<TValue> Class

RadzenTimeSpanPicker component.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenTimeSpanPicker<TValue>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IRadzenFormComponent

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenTimeSpanPicker<TValue> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IRadzenFormComponent

Type Parameters

Name Description
TValueTYPEREF:System.TimeSpanTimeSpan/TYPEREF and nullable TYPEREF:System.TimeSpanTimeSpan/TYPEREF are supported.

Examples

<RadzenTimeSpanPicker @bind-Value="@someValue" TValue="TimeSpan" Change=@(args => Console.WriteLine($"Selected time span: {args}")) />

Constructors

RadzenTimeSpanPicker<TValue>Link to this section

RadzenTimeSpanPicker component.

Declaration
public RadzenTimeSpanPicker<TValue>()

Fields

inputLink to this section

Gets the input reference.

Declaration
protected ElementReference input

Properties

AllowClearLink to this section

Specifies whether the value can be cleared.

Declaration
public bool AllowClear { get; set; }
Property Value
Type Description
boolSpecifies whether the value can be cleared.

AllowInputLink to this section

Specifies whether input in the input field is allowed. Set to true by default.

Declaration
public bool AllowInput { get; set; }
Property Value
Type Description
boolSpecifies whether input in the input field is allowed. Set to true by default.

ChangeLink to this section

Specifies the callback of the underlying nullable TimeSpan value.

Declaration
public EventCallback<TimeSpan?> Change { get; set; }
Property Value
Type Description
EventCallback<TimeSpan?>Specifies the callback of the underlying nullable TimeSpan value.

ClearAriaLabelLink to this section

Gets or sets the clear button aria label text.

Declaration
public string ClearAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the clear button aria label text.

ConfirmationButtonTextLink to this section

Specifies the text of the confirmation button. Used only if ShowConfirmationButton is true.

Declaration
public string ConfirmationButtonText { get; set; }
Property Value
Type Description
stringSpecifies the text of the confirmation button. Used only if ShowConfirmationButton is true.

DaysStepLink to this section

Specifies the step of the days field in the picker panel.

Declaration
public string DaysStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the days field in the picker panel.

DaysUnitTextLink to this section

Specifies the days label text.

Declaration
public string DaysUnitText { get; set; }
Property Value
Type Description
stringSpecifies the days label text.

DisabledLink to this section

Specifies whether the input field is disabled.

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
boolSpecifies whether the input field is disabled.

EditContextLink to this section

Specifies the edit context of this component.

Declaration
public Forms.EditContext EditContext { get; set; }
Property Value
Type Description
Forms.EditContextSpecifies the edit context of this component.

FieldIdentifierLink to this section

Gets the field identifier.

Declaration
public Forms.FieldIdentifier FieldIdentifier { get; set; }
Property Value
Type Description
Forms.FieldIdentifierGets the field identifier.

FieldPrecisionLink to this section

Specifies the most precise time unit field in the picker panel. Set to Second by default.

Declaration
public TimeSpanUnit FieldPrecision { get; set; }
Property Value
Type Description
TimeSpanUnitSpecifies the most precise time unit field in the picker panel. Set to Second by default.

FormLink to this section

Specifies the form this component belongs to.

Declaration
public IRadzenForm Form { get; set; }
Property Value
Type Description
IRadzenFormSpecifies the form this component belongs to.

FormFieldContextLink to this section

Specifies the RadzenFormField context of this component.

Declaration
public IFormFieldContext FormFieldContext { get; set; }
Property Value
Type Description
IFormFieldContextSpecifies the RadzenFormField context of this component.

FormattedValueLink to this section

Gets the formatted value.

Declaration
public string FormattedValue { get; }
Property Value
Type Description
stringGets the formatted value.

HasValueLink to this section

Indicates whether this instance has a confirmed value.

Declaration
public bool HasValue { get; }
Property Value
Type Description
boolIndicates whether this instance has a confirmed value.

HoursStepLink to this section

Specifies the step of the hours field in the picker panel.

Declaration
public string HoursStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the hours field in the picker panel.

HoursUnitTextLink to this section

Specifies the hours label text.

Declaration
public string HoursUnitText { get; set; }
Property Value
Type Description
stringSpecifies the hours label text.

InlineLink to this section

Specifies whether the component is inline or shows a popup.

Declaration
public bool Inline { get; set; }
Property Value
Type Description
boolSpecifies whether the component is inline or shows a popup.

InputAttributesLink to this section

Specifies additional custom attributes that will be rendered by the input.

Declaration
public IReadOnlyDictionary<string, object> InputAttributes { get; set; }
Property Value
Type Description
IReadOnlyDictionary<string, object>Specifies additional custom attributes that will be rendered by the input.

InputClassLink to this section

Specifies the input CSS classes, separated with spaces.

Declaration
public string InputClass { get; set; }
Property Value
Type Description
stringSpecifies the input CSS classes, separated with spaces.

InputSizeLink to this section

Gets or sets the size of the component.

Declaration
public InputSize InputSize { get; set; }
Property Value
Type Description
InputSizeGets or sets the size of the component.

IsBoundLink to this section

Indicates whether this instance is bound ValueChanged callback has delegate).

Declaration
public bool IsBound { get; }
Property Value
Type Description
boolIndicates whether this instance is bound ValueChanged callback has delegate).

MaxLink to this section

Specifies the maximum time span allowed.

Declaration
public TimeSpan Max { get; set; }
Property Value
Type Description
TimeSpanSpecifies the maximum time span allowed.

MicrosecondsStepLink to this section

Specifies the step of the microseconds field in the picker panel.

Declaration
public string MicrosecondsStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the microseconds field in the picker panel.

MicrosecondsUnitTextLink to this section

Specifies the microseconds label text.

Declaration
public string MicrosecondsUnitText { get; set; }
Property Value
Type Description
stringSpecifies the microseconds label text.

MillisecondsStepLink to this section

Specifies the step of the milliseconds field in the picker panel.

Declaration
public string MillisecondsStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the milliseconds field in the picker panel.

MillisecondsUnitTextLink to this section

Specifies the milliseconds label text.

Declaration
public string MillisecondsUnitText { get; set; }
Property Value
Type Description
stringSpecifies the milliseconds label text.

MinLink to this section

Specifies the minimum time span allowed.

Declaration
public TimeSpan Min { get; set; }
Property Value
Type Description
TimeSpanSpecifies the minimum time span allowed.

MinutesStepLink to this section

Specifies the step of the minutes field in the picker panel.

Declaration
public string MinutesStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the minutes field in the picker panel.

MinutesUnitTextLink to this section

Specifies the minutes label text.

Declaration
public string MinutesUnitText { get; set; }
Property Value
Type Description
stringSpecifies the minutes label text.

NameLink to this section

Specifies the name of the input field.

Declaration
public string Name { get; set; }
Property Value
Type Description
stringSpecifies the name of the input field.

NegativeButtonTextLink to this section

Specifies the text of the negative value button.

Declaration
public string NegativeButtonText { get; set; }
Property Value
Type Description
stringSpecifies the text of the negative value button.

NegativeValueTextLink to this section

Specifies the text displayed next to the fields in the panel when the value is negative and there's no sign picker.

Declaration
public string NegativeValueText { get; set; }
Property Value
Type Description
stringSpecifies the text displayed next to the fields in the panel when the value is negative and there's no sign picker.

PadTimeValuesLink to this section

Specifies whether the time fields in the panel, except for the days field, are padded with leading zeros.

Declaration
public bool PadTimeValues { get; set; }
Property Value
Type Description
boolSpecifies whether the time fields in the panel, except for the days field, are padded with leading zeros.

ParseInputLink to this section

Specifies custom function to parse the input. If it's not defined or the function it returns null, a built-in parser us used instead.

Declaration
public Func<string, TimeSpan?> ParseInput { get; set; }
Property Value
Type Description
Func<string, TimeSpan?>Specifies custom function to parse the input. If it's not defined or the function it returns null, a built-in parser us used instead.

PlaceholderLink to this section

Specifies the input placeholder.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
stringSpecifies the input placeholder.

PopupAriaLabelLink to this section

Specifies the aria label for the popup.

Declaration
public string PopupAriaLabel { get; set; }
Property Value
Type Description
stringSpecifies the aria label for the popup.

PopupButtonClassLink to this section

Specifies the popup toggle button CSS classes, separated with spaces.

Declaration
public string PopupButtonClass { get; set; }
Property Value
Type Description
stringSpecifies the popup toggle button CSS classes, separated with spaces.

PopupRenderModeLink to this section

Specifies the render mode of the popup.

Declaration
public PopupRenderMode PopupRenderMode { get; set; }
Property Value
Type Description
PopupRenderModeSpecifies the render mode of the popup.

PositiveButtonTextLink to this section

Specifies the text of the positive value button.

Declaration
public string PositiveButtonText { get; set; }
Property Value
Type Description
stringSpecifies the text of the positive value button.

PositiveValueTextLink to this section

Specifies the text displayed next to the fields in the panel when the value is positive and there's no sign picker.

Declaration
public string PositiveValueText { get; set; }
Property Value
Type Description
stringSpecifies the text displayed next to the fields in the panel when the value is positive and there's no sign picker.

ReadOnlyLink to this section

Specifies whether the input field is read only.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type Description
boolSpecifies whether the input field is read only.

SecondsStepLink to this section

Specifies the step of the seconds field in the picker panel.

Declaration
public string SecondsStep { get; set; }
Property Value
Type Description
stringSpecifies the step of the seconds field in the picker panel.

SecondsUnitTextLink to this section

Specifies the seconds label text.

Declaration
public string SecondsUnitText { get; set; }
Property Value
Type Description
stringSpecifies the seconds label text.

ShowConfirmationButtonLink to this section

Specifies whether to display the confirmation button in the panel to accept changes.

Declaration
public bool ShowConfirmationButton { get; set; }
Property Value
Type Description
boolSpecifies whether to display the confirmation button in the panel to accept changes.

ShowPopupButtonLink to this section

Specifies whether to display popup icon button in the input field.

Declaration
public bool ShowPopupButton { get; set; }
Property Value
Type Description
boolSpecifies whether to display popup icon button in the input field.

TabIndexLink to this section

Specifies the tab index.

Declaration
public int TabIndex { get; set; }
Property Value
Type Description
intSpecifies the tab index.

TimeSpanFormatLink to this section

Specifies the time span format in the input field. For more details, see the documentation of and time span format strings.

Declaration
public string TimeSpanFormat { get; set; }
Property Value
Type Description
stringSpecifies the time span format in the input field. For more details, see the documentation of and time span format strings.

TogglePopupAriaLabelLink to this section

Specifies the aria label for the toggle popup button.

Declaration
public string TogglePopupAriaLabel { get; set; }
Property Value
Type Description
stringSpecifies the aria label for the toggle popup button.

ValueLink to this section

Specifies the value of the component.

Declaration
public TValue Value { get; set; }
Property Value
Type Description
TValueSpecifies the value of the component.

ValueChangedLink to this section

Specifies the callback of the value change.

Declaration
public EventCallback<TValue> ValueChanged { get; set; }
Property Value
Type Description
EventCallback<TValue>Specifies the callback of the value change.

ValueExpressionLink to this section

Specifies the value expression used while creating the FieldIdentifier.

Declaration
public Expressions.Expression<Func<TValue>> ValueExpression { get; set; }
Property Value
Type Description
Expressions.Expression<Func<TValue>>Specifies the value expression used while creating the FieldIdentifier.

Methods

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

CloseLink to this section

Closes this instance popup.

Declaration
public Task Close()
Returns
Type Description
Task

DisposeLink to this section

Declaration
public override void Dispose()

FocusAsyncLink to this section

Declaration
public ValueTask FocusAsync()
Returns
Type Description
ValueTask

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

GetValueLink to this section

Gets the value of the component.

Declaration
public object GetValue()
Returns
Type Description
objectSystem.Object.

OnAfterRenderAsyncLink to this section

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender
Returns
Type Description
Task

OnInitializedLink to this section

Declaration
protected override void OnInitialized()

SetParametersAsyncLink to this section

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙