Class IgbDateTimeInput

A date time input is an input field that lets you set and edit the date and time in a chosen input element using customizable display and input formats.

Inheritance
System.Object
BaseRendererControl
IgbInputBase
IgbMaskInputBase
IgbDateTimeInput
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDateTimeInput : IgbMaskInputBase, RefSink, JsonSerializable, IDisposable

Constructors

IgbDateTimeInput()

Declaration
public IgbDateTimeInput()

Properties

Change

Declaration
public EventCallback<IgbComponentDateValueChangedEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComponentDateValueChangedEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

DisplayFormat

Format to display the value in when not editing. Defaults to the locale format if not set.

Declaration
public string DisplayFormat { get; set; }
Property Value
Type Description
System.String

InputFormat

The date format to apply on the input.

Declaration
public string InputFormat { get; set; }
Property Value
Type Description
System.String

Locale

Gets/Sets the locale used for formatting the display value.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

Max

The maximum value required for the input to remain valid.

Declaration
public Nullable<DateTime> Max { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Min

The minimum value required for the input to remain valid.

Declaration
public Nullable<DateTime> Min { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

SpinDelta

Delta values used to increment or decrement each date part on step actions. All values default to 1.

Declaration
public IgbDatePartDeltas SpinDelta { get; set; }
Property Value
Type Description
IgbDatePartDeltas

SpinLoop

Sets whether to loop over the currently spun segment.

Declaration
public bool SpinLoop { get; set; }
Property Value
Type Description
System.Boolean

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Value

The value of the input.

Declaration
public Nullable<DateTime> Value { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

ValueChanged

Declaration
public EventCallback<Nullable<DateTime>> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Nullable<System.DateTime>>

Methods

Clear()

Declaration
public void Clear()

ClearAsync()

Clears the input element of user input.

Declaration
public Task ClearAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrentValue()

Declaration
public Nullable<DateTime> GetCurrentValue()
Returns
Type Description
System.Nullable<System.DateTime>

GetCurrentValueAsync()

Declaration
public Task<Nullable<DateTime>> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Nullable<System.DateTime>>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

StepDown()

Declaration
public void StepDown()

StepDown(DatePart)

Declaration
public void StepDown(DatePart datePart)
Parameters
Type Name Description
DatePart datePart

StepDown(Nullable<DatePart>, Double)

Declaration
public void StepDown(Nullable<DatePart> datePart = null, double delta = -1)
Parameters
Type Name Description
System.Nullable<DatePart> datePart
System.Double delta

StepDownAsync()

Declaration
public Task StepDownAsync()
Returns
Type Description
System.Threading.Tasks.Task

StepDownAsync(DatePart)

Declaration
public Task StepDownAsync(DatePart datePart)
Parameters
Type Name Description
DatePart datePart
Returns
Type Description
System.Threading.Tasks.Task

StepDownAsync(Nullable<DatePart>, Double)

Declaration
public Task StepDownAsync(Nullable<DatePart> datePart = null, double delta = -1)
Parameters
Type Name Description
System.Nullable<DatePart> datePart
System.Double delta
Returns
Type Description
System.Threading.Tasks.Task

StepUp()

Declaration
public void StepUp()

StepUp(DatePart)

Declaration
public void StepUp(DatePart datePart)
Parameters
Type Name Description
DatePart datePart

StepUp(Nullable<DatePart>, Double)

Declaration
public void StepUp(Nullable<DatePart> datePart = null, double delta = -1)
Parameters
Type Name Description
System.Nullable<DatePart> datePart
System.Double delta

StepUpAsync()

Declaration
public Task StepUpAsync()
Returns
Type Description
System.Threading.Tasks.Task

StepUpAsync(DatePart)

Declaration
public Task StepUpAsync(DatePart datePart)
Parameters
Type Name Description
DatePart datePart
Returns
Type Description
System.Threading.Tasks.Task

StepUpAsync(Nullable<DatePart>, Double)

Declaration
public Task StepUpAsync(Nullable<DatePart> datePart = null, double delta = -1)
Parameters
Type Name Description
System.Nullable<DatePart> datePart
System.Double delta
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable