The igc-date-range-picker allows the user to select a range of dates.
Inheritance
object
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbDateRangePicker()Returns IgbDateRangePicker
Properties
Section titled "Properties"KeepOpenOnSelect
Section titled "KeepOpenOnSelect"Inherited from: IgbComboBoxBaseLike
Whether the component dropdown should be kept open on selection.
[Parameter]
public bool KeepOpenOnSelect { get; set; }KeepOpenOnOutsideClick
Section titled "KeepOpenOnOutsideClick"Inherited from: IgbComboBoxBaseLike
Whether the component dropdown should be kept open on clicking outside of it.
[Parameter]
public bool KeepOpenOnOutsideClick { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbBaseComboBox
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Inherited from: IgbBaseComboBox
Sets the open state of the component.
[Parameter]
public bool Open { 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; }ActiveDate
Section titled "ActiveDate"Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date.
[Parameter]
public DateTime ActiveDate { get; set; }CustomRanges
Section titled "CustomRanges"Renders chips with custom ranges based on the elements of the array.
[Parameter]
public IgbCustomDateRange[] CustomRanges { get; set; }Disabled
Section titled "Disabled"The disabled state of the component
[Parameter]
public bool Disabled { get; set; }DisabledDates
Section titled "DisabledDates"Gets/sets disabled dates.
[Parameter]
public IgbDateRangeDescriptor[] DisabledDates { get; set; }DisplayFormat
Section titled "DisplayFormat"Format to display the value in when not editing. Defaults to the locale format if not set.
[Parameter]
public string DisplayFormat { get; set; }HeaderOrientation
Section titled "HeaderOrientation"The orientation of the calendar header.
[Parameter]
public ContentOrientation HeaderOrientation { get; set; }HideHeader
Section titled "HideHeader"Determines whether the calendar hides its header.
[Parameter]
public bool HideHeader { get; set; }HideOutsideDays
Section titled "HideOutsideDays"Controls the visibility of the dates that do not belong to the current month.
[Parameter]
public bool HideOutsideDays { get; set; }InputFormat
Section titled "InputFormat"The date format to apply on the inputs. Defaults to the current locale Intl.DateTimeFormat
[Parameter]
public string InputFormat { get; set; }Invalid
Section titled "Invalid"Control the validity of the control.
[Parameter]
public bool Invalid { get; set; }Label
Section titled "Label"The label of the control (single input).
[Parameter]
public string Label { get; set; }LabelEnd
Section titled "LabelEnd"The label attribute of the end input.
[Parameter]
public string LabelEnd { get; set; }LabelStart
Section titled "LabelStart"The label attribute of the start input.
[Parameter]
public string LabelStart { get; set; }Locale
Section titled "Locale"The locale settings used to display the value.
[Parameter]
public string Locale { get; set; }The maximum value required for the date range picker to remain valid.
[Parameter]
public DateTime? Max { get; set; }The minimum value required for the date range picker to remain valid.
[Parameter]
public DateTime? Min { get; set; }Determines whether the calendar is opened in a dropdown or a modal dialog
[Parameter]
public PickerMode Mode { get; set; }NonEditable
Section titled "NonEditable"Whether to allow typing in the input.
[Parameter]
public bool NonEditable { get; set; }Orientation
Section titled "Orientation"The orientation of the multiple months displayed in the calendar's days view.
[Parameter]
public ContentOrientation Orientation { get; set; }Outlined
Section titled "Outlined"Whether the control will have outlined appearance.
[Parameter]
public bool Outlined { get; set; }Placeholder
Section titled "Placeholder"The placeholder attribute of the control (single input).
[Parameter]
public string Placeholder { get; set; }PlaceholderEnd
Section titled "PlaceholderEnd"The placeholder attribute of the end input.
[Parameter]
public string PlaceholderEnd { get; set; }PlaceholderStart
Section titled "PlaceholderStart"The placeholder attribute of the start input.
[Parameter]
public string PlaceholderStart { get; set; }Prompt
Section titled "Prompt"The prompt symbol to use for unfilled parts of the mask.
[Parameter]
public string Prompt { get; set; }ReadOnly
Section titled "ReadOnly"Makes the control a readonly field.
[Parameter]
[WCAttributeName("readonly")]
public bool ReadOnly { get; set; }Required
Section titled "Required"Makes the control a required field in a form context.
[Parameter]
public bool Required { get; set; }ResourceStrings
Section titled "ResourceStrings"The resource strings of the date range picker.
[Parameter]
public IgbDateRangePickerResourceStrings ResourceStrings { get; set; }ShowWeekNumbers
Section titled "ShowWeekNumbers"Whether to show the number of the week in the calendar.
[Parameter]
public bool ShowWeekNumbers { get; set; }SpecialDates
Section titled "SpecialDates"Gets/sets special dates.
[Parameter]
public IgbDateRangeDescriptor[] SpecialDates { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }UsePredefinedRanges
Section titled "UsePredefinedRanges"Whether the control will show chips with predefined ranges.
[Parameter]
public bool UsePredefinedRanges { get; set; }UseTwoInputs
Section titled "UseTwoInputs"Use two inputs to display the date range values. Makes the input editable in dropdown mode.
[Parameter]
public bool UseTwoInputs { get; set; }Value
Section titled "Value"The value of the picker
[Parameter]
public IgbDateRangeValue? Value { get; set; }WeekStart
Section titled "WeekStart"Sets the start day of the week for the calendar.
[Parameter]
public WeekDays WeekStart { 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: IgbBaseComboBox
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbBaseComboBox
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ShowAsync()
Section titled "ShowAsync()"Inherited from: IgbBaseComboBox
Shows the component.
public Task<bool> ShowAsync()Returns any
Show()
Section titled "Show()"Inherited from: IgbBaseComboBox
public bool Show()Returns any
HideAsync()
Section titled "HideAsync()"Inherited from: IgbBaseComboBox
Hides the component.
public Task<bool> HideAsync()Returns any
Hide()
Section titled "Hide()"Inherited from: IgbBaseComboBox
public bool Hide()Returns any
ToggleAsync()
Section titled "ToggleAsync()"Inherited from: IgbBaseComboBox
Toggles the open state of the component.
public Task<bool> ToggleAsync()Returns any
Toggle()
Section titled "Toggle()"Inherited from: IgbBaseComboBox
public bool Toggle()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
CheckValidity()
Section titled "CheckValidity()"public bool CheckValidity()Returns any
CheckValidityAsync()
Section titled "CheckValidityAsync()"Checks for validity of the control and emits the invalid event if it invalid.
public Task<bool> CheckValidityAsync()Returns any
Clear()
Section titled "Clear()"public void Clear()Returns any
ClearAsync()
Section titled "ClearAsync()"Clears the input parts of the component of any 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 IgbDateRangeValue? GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<IgbDateRangeValue?> GetCurrentValueAsync()Returns any
ReportValidity()
Section titled "ReportValidity()"public bool ReportValidity()Returns any
ReportValidityAsync()
Section titled "ReportValidityAsync()"Checks for validity of the control and shows the browser message if it invalid.
public Task<bool> ReportValidityAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
Select(IgbDateRangeValue)
Section titled "Select(IgbDateRangeValue)"public void Select(IgbDateRangeValue value)Parameters
- value:
IgbDateRangeValue
Returns any
SelectAsync(IgbDateRangeValue)
Section titled "SelectAsync(IgbDateRangeValue)"Selects a date range value in the picker
public Task SelectAsync(IgbDateRangeValue value)Parameters
- value:
IgbDateRangeValue
Returns any
SetCustomValidity(string)
Section titled "SetCustomValidity(string)"public void SetCustomValidity(string message)Parameters
- message:
string
Returns any
SetCustomValidityAsync(string)
Section titled "SetCustomValidityAsync(string)"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
Events
Section titled "Events"Change
Section titled "Change"[Parameter]
public EventCallback<IgbDateRangeValueEventArgs> Change { get; set; }Closed
Section titled "Closed"[Parameter]
public EventCallback<IgbVoidEventArgs> Closed { get; set; }Closing
Section titled "Closing"[Parameter]
public EventCallback<IgbVoidEventArgs> Closing { get; set; }Input
Section titled "Input"[Parameter]
public EventCallback<IgbDateRangeValueEventArgs> Input { get; set; }Opened
Section titled "Opened"[Parameter]
public EventCallback<IgbVoidEventArgs> Opened { get; set; }Opening
Section titled "Opening"[Parameter]
public EventCallback<IgbVoidEventArgs> Opening { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<IgbDateRangeValue?> ValueChanged { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }ClosedScript
Section titled "ClosedScript"[Parameter]
public string ClosedScript { get; set; }ClosingScript
Section titled "ClosingScript"[Parameter]
public string ClosingScript { get; set; }InputScript
Section titled "InputScript"[Parameter]
public string InputScript { get; set; }OpenedScript
Section titled "OpenedScript"[Parameter]
public string OpenedScript { get; set; }OpeningScript
Section titled "OpeningScript"[Parameter]
public string OpeningScript { get; set; }