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
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbDateTimeInput()Returns IgbDateTimeInput
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbDateTimeInputBase
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Outlined
Section titled "Outlined"Inherited from: IgbDateTimeInputBase
Whether the control will have outlined appearance. false
[Parameter]
public bool Outlined { get; set; }Placeholder
Section titled "Placeholder"Inherited from: IgbDateTimeInputBase
The placeholder attribute of the control.
[Parameter]
public string Placeholder { get; set; }Label
Section titled "Label"Inherited from: IgbDateTimeInputBase
The label for the control.
[Parameter]
public string Label { get; set; }InputFormat
Section titled "InputFormat"Inherited from: IgbDateTimeInputBase
[Parameter]
public string InputFormat { get; set; }Inherited from: IgbDateTimeInputBase
The minimum value required for the input to remain valid.
[Parameter]
public DateTime? Min { get; set; }Inherited from: IgbDateTimeInputBase
The maximum value required for the input to remain valid.
[Parameter]
public DateTime? Max { get; set; }DisplayFormat
Section titled "DisplayFormat"Inherited from: IgbDateTimeInputBase
Format to display the value in when not editing. Defaults to the locale format if not set.
[Parameter]
public string DisplayFormat { get; set; }SpinDelta
Section titled "SpinDelta"Inherited from: IgbDateTimeInputBase
Delta values used to increment or decrement each date part on step actions. All values default to 1.
[Parameter]
public IgbDatePartDeltas SpinDelta { get; set; }SpinLoop
Section titled "SpinLoop"Inherited from: IgbDateTimeInputBase
Sets whether to loop over the currently spun segment.
[Parameter]
public bool SpinLoop { get; set; }Locale
Section titled "Locale"Inherited from: IgbDateTimeInputBase
Gets/Sets the locale used for formatting the display value.
[Parameter]
public string Locale { get; set; }ReadOnly
Section titled "ReadOnly"Inherited from: IgbDateTimeInputBase
Makes the control a readonly field. false
[Parameter]
public bool ReadOnly { get; set; }Inherited from: IgbDateTimeInputBase
The mask pattern of the component.
[Parameter]
public string Mask { get; set; }Prompt
Section titled "Prompt"Inherited from: IgbDateTimeInputBase
The prompt symbol to use for unfilled parts of the mask pattern. '_'
[Parameter]
public string Prompt { get; set; }Disabled
Section titled "Disabled"Inherited from: IgbDateTimeInputBase
The disabled state of the component
[Parameter]
public bool Disabled { get; set; }Required
Section titled "Required"Inherited from: IgbDateTimeInputBase
Makes the control a required field in a form context.
[Parameter]
public bool Required { get; set; }Invalid
Section titled "Invalid"Inherited from: IgbDateTimeInputBase
Control the validity of the control.
[Parameter]
public bool Invalid { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }Value
Section titled "Value"The value of the input.
[Parameter]
public DateTime? Value { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbDateTimeInputBase
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbDateTimeInputBase
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SelectAsync()
Section titled "SelectAsync()"Inherited from: IgbDateTimeInputBase
Selects all the text inside the input.
public Task SelectAsync()Returns any
Select()
Section titled "Select()"Inherited from: IgbDateTimeInputBase
public void Select()Returns any
FocusComponentAsync(IgbFocusOptions)
Section titled "FocusComponentAsync(IgbFocusOptions)"Inherited from: IgbDateTimeInputBase
Sets focus on the control.
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
FocusComponent(IgbFocusOptions)
Section titled "FocusComponent(IgbFocusOptions)"Inherited from: IgbDateTimeInputBase
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
BlurComponentAsync()
Section titled "BlurComponentAsync()"Inherited from: IgbDateTimeInputBase
Removes focus from the control.
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()Returns any
BlurComponent()
Section titled "BlurComponent()"Inherited from: IgbDateTimeInputBase
[WCWidgetMemberName("Blur")]
public void BlurComponent()Returns any
HasDatePartsAsync()
Section titled "HasDatePartsAsync()"Inherited from: IgbDateTimeInputBase
public Task<bool> HasDatePartsAsync()Returns any
HasDateParts()
Section titled "HasDateParts()"Inherited from: IgbDateTimeInputBase
public bool HasDateParts()Returns any
HasTimePartsAsync()
Section titled "HasTimePartsAsync()"Inherited from: IgbDateTimeInputBase
public Task<bool> HasTimePartsAsync()Returns any
HasTimeParts()
Section titled "HasTimeParts()"Inherited from: IgbDateTimeInputBase
public bool HasTimeParts()Returns any
SetSelectionRangeAsync(double, double, string)
Section titled "SetSelectionRangeAsync(double, double, string)"Inherited from: IgbDateTimeInputBase
public Task SetSelectionRangeAsync(double start = -1, double end = -1, string direction = null)Parameters
- start:
double - end:
double - direction:
string
Returns any
SetSelectionRange(double, double, string)
Section titled "SetSelectionRange(double, double, string)"Inherited from: IgbDateTimeInputBase
public void SetSelectionRange(double start = -1, double end = -1, string direction = null)Parameters
- start:
double - end:
double - direction:
string
Returns any
SetRangeTextAsync(string, double, double, string)
Section titled "SetRangeTextAsync(string, double, double, string)"Inherited from: IgbDateTimeInputBase
public Task SetRangeTextAsync(string replacement, double start = -1, double end = -1, string selectMode = null)Parameters
- replacement:
string - start:
double - end:
double - selectMode:
string
Returns any
SetRangeText(string, double, double, string)
Section titled "SetRangeText(string, double, double, string)"Inherited from: IgbDateTimeInputBase
public void SetRangeText(string replacement, double start = -1, double end = -1, string selectMode = null)Parameters
- replacement:
string - start:
double - end:
double - selectMode:
string
Returns any
ReportValidityAsync()
Section titled "ReportValidityAsync()"Inherited from: IgbDateTimeInputBase
Checks for validity of the control and shows the browser message if it invalid.
public Task ReportValidityAsync()Returns any
ReportValidity()
Section titled "ReportValidity()"Inherited from: IgbDateTimeInputBase
public void ReportValidity()Returns any
CheckValidityAsync()
Section titled "CheckValidityAsync()"Inherited from: IgbDateTimeInputBase
Checks for validity of the control and emits the invalid event if it invalid.
public Task CheckValidityAsync()Returns any
CheckValidity()
Section titled "CheckValidity()"Inherited from: IgbDateTimeInputBase
public void CheckValidity()Returns any
SetCustomValidityAsync(string)
Section titled "SetCustomValidityAsync(string)"Inherited from: IgbDateTimeInputBase
Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.
public Task SetCustomValidityAsync(string message)Parameters
- message:
string
Returns any
SetCustomValidity(string)
Section titled "SetCustomValidity(string)"Inherited from: IgbDateTimeInputBase
public void SetCustomValidity(string message)Parameters
- message:
string
Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
Clear()
Section titled "Clear()"public void Clear()Returns any
ClearAsync()
Section titled "ClearAsync()"Clears the input element of user input.
public Task ClearAsync()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetCurrentValue()
Section titled "GetCurrentValue()"public DateTime? GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<DateTime?> GetCurrentValueAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
StepDown()
Section titled "StepDown()"public void StepDown()Returns any
StepDown(DatePart)
Section titled "StepDown(DatePart)"public void StepDown(DatePart datePart)Parameters
- datePart:
DatePart
Returns any
StepDown(DatePart?, double)
Section titled "StepDown(DatePart?, double)"public void StepDown(DatePart? datePart = null, double delta = -1)Parameters
- datePart:
DatePart? - delta:
double
Returns any
StepDownAsync()
Section titled "StepDownAsync()"public Task StepDownAsync()Returns any
StepDownAsync(DatePart)
Section titled "StepDownAsync(DatePart)"public Task StepDownAsync(DatePart datePart)Parameters
- datePart:
DatePart
Returns any
StepDownAsync(DatePart?, double)
Section titled "StepDownAsync(DatePart?, double)"public Task StepDownAsync(DatePart? datePart = null, double delta = -1)Parameters
- datePart:
DatePart? - delta:
double
Returns any
StepUp()
Section titled "StepUp()"public void StepUp()Returns any
StepUp(DatePart)
Section titled "StepUp(DatePart)"public void StepUp(DatePart datePart)Parameters
- datePart:
DatePart
Returns any
StepUp(DatePart?, double)
Section titled "StepUp(DatePart?, double)"public void StepUp(DatePart? datePart = null, double delta = -1)Parameters
- datePart:
DatePart? - delta:
double
Returns any
StepUpAsync()
Section titled "StepUpAsync()"public Task StepUpAsync()Returns any
StepUpAsync(DatePart)
Section titled "StepUpAsync(DatePart)"public Task StepUpAsync(DatePart datePart)Parameters
- datePart:
DatePart
Returns any
StepUpAsync(DatePart?, double)
Section titled "StepUpAsync(DatePart?, double)"public Task StepUpAsync(DatePart? datePart = null, double delta = -1)Parameters
- datePart:
DatePart? - delta:
double
Returns any
Events
Section titled "Events"[Parameter]
public EventCallback<IgbVoidEventArgs> Blur { get; set; }Change
Section titled "Change"[Parameter]
public EventCallback<IgbComponentDateValueChangedEventArgs> Change { get; set; }Focus
Section titled "Focus"[Parameter]
public EventCallback<IgbVoidEventArgs> Focus { get; set; }InputOcurred
Section titled "InputOcurred"[Parameter]
public EventCallback<IgbComponentValueChangedEventArgs> InputOcurred { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<DateTime?> ValueChanged { get; set; }BlurScript
Section titled "BlurScript"[Parameter]
public string BlurScript { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }FocusScript
Section titled "FocusScript"[Parameter]
public string FocusScript { get; set; }InputOcurredScript
Section titled "InputOcurredScript"[Parameter]
public string InputOcurredScript { get; set; }