Class IgbDateRangePicker

The igc-date-range-picker allows the user to select a range of dates.

Inheritance

System.Object

BaseRendererControl

IgbBaseComboBoxLike

IgbDateRangePicker

Implements

JsonSerializable

System.IDisposable

Inherited Members

IgbBaseComboBoxLike.SetNativeElementAsync(Object)

IgbBaseComboBoxLike.SetNativeElement(Object)

IgbBaseComboBoxLike.ShowAsync()

IgbBaseComboBoxLike.Show()

IgbBaseComboBoxLike.HideAsync()

IgbBaseComboBoxLike.Hide()

IgbBaseComboBoxLike.ToggleAsync()

IgbBaseComboBoxLike.Toggle()

IgbBaseComboBoxLike.DefaultEventBehavior

IgbBaseComboBoxLike.EmitEvent

IgbBaseComboBoxLike.KeepOpenOnSelect

IgbBaseComboBoxLike.KeepOpenOnOutsideClick

IgbBaseComboBoxLike.Open

BaseRendererControl.eventCallbacksCache

BaseRendererControl._cachedSerializedContent

BaseRendererControl.ResolveEventBehavior()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.IsTransformedEnumValue(String)

BaseRendererControl.TransformPotentialEnumValue(String, Object)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererControl.SuspendNotifications(Object)

BaseRendererControl.ResumeNotifications(Object, Boolean)

BaseRendererControl.NotifyInsertItem(Object, Int32, Object)

BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)

BaseRendererControl.NotifyClearItems(Object)

BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.SetResourceStringAsync(String, String, String)

BaseRendererControl.SetResourceStringAsync(String, String)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)

BaseRendererControl.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ParentTypeName

BaseRendererControl.EventBehavior

BaseRendererControl.ChildContent

BaseRendererControl.RoundTripDateConversion

BaseRendererControl.UseDirectRender

BaseRendererControl.DirectRenderElementName

BaseRendererControl.NeedsDynamicContent

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbDateRangePicker : IgbBaseComboBoxLike, RefSink, JsonSerializable, IDisposable

Constructors

IgbDateRangePicker()

Declaration

public IgbDateRangePicker()

Properties

ActiveDate

Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date.

Declaration

public DateTime ActiveDate { get; set; }

Property Value

Type	Description
System.DateTime

Change

Declaration

public EventCallback<IgbDateRangeValueEventArgs> Change { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDateRangeValueEventArgs>

ChangeScript

Declaration

public string ChangeScript { get; set; }

Property Value

Type	Description
System.String

Closed

Declaration

public EventCallback<IgbVoidEventArgs> Closed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

Declaration

public string ClosedScript { get; set; }

Property Value

Type	Description
System.String

Closing

Declaration

public EventCallback<IgbVoidEventArgs> Closing { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

Declaration

public string ClosingScript { get; set; }

Property Value

Type	Description
System.String

CustomRanges

Renders chips with custom ranges based on the elements of the array.

Declaration

public IgbCustomDateRange[] CustomRanges { get; set; }

Property Value

Type	Description
IgbCustomDateRange[]

Disabled

The disabled state of the component

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean

DisabledDates

Gets/sets disabled dates.

Declaration

public IgbDateRangeDescriptor[] DisabledDates { get; set; }

Property Value

Type	Description
IgbDateRangeDescriptor[]

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

HeaderOrientation

The orientation of the calendar header.

Declaration

public ContentOrientation HeaderOrientation { get; set; }

Property Value

Type	Description
ContentOrientation

HideHeader

Determines whether the calendar hides its header.

Declaration

public bool HideHeader { get; set; }

Property Value

Type	Description
System.Boolean

HideOutsideDays

Controls the visibility of the dates that do not belong to the current month.

Declaration

public bool HideOutsideDays { get; set; }

Property Value

Type	Description
System.Boolean

Input

Declaration

public EventCallback<IgbDateRangeValueEventArgs> Input { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDateRangeValueEventArgs>

InputFormat

The date format to apply on the inputs. Defaults to the current locale Intl.DateTimeFormat

Declaration

public string InputFormat { get; set; }

Property Value

Type	Description
System.String

InputScript

Declaration

public string InputScript { get; set; }

Property Value

Type	Description
System.String

Invalid

Control the validity of the control.

Declaration

public bool Invalid { get; set; }

Property Value

Type	Description
System.Boolean

Label

The label of the control (single input).

Declaration

public string Label { get; set; }

Property Value

Type	Description
System.String

LabelEnd

The label attribute of the end input.

Declaration

public string LabelEnd { get; set; }

Property Value

Type	Description
System.String

LabelStart

The label attribute of the start input.

Declaration

public string LabelStart { get; set; }

Property Value

Type	Description
System.String

Locale

The locale settings used to display the value.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Max

The maximum value required for the date range picker 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 date range picker to remain valid.

Declaration

public Nullable<DateTime> Min { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Mode

Determines whether the calendar is opened in a dropdown or a modal dialog

Declaration

public PickerMode Mode { get; set; }

Property Value

Type	Description
PickerMode

NonEditable

Whether to allow typing in the input.

Declaration

public bool NonEditable { get; set; }

Property Value

Type	Description
System.Boolean

Opened

Declaration

public EventCallback<IgbVoidEventArgs> Opened { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpenedScript

Declaration

public string OpenedScript { get; set; }

Property Value

Type	Description
System.String

Opening

Declaration

public EventCallback<IgbVoidEventArgs> Opening { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpeningScript

Declaration

public string OpeningScript { get; set; }

Property Value

Type	Description
System.String

Orientation

The orientation of the multiple months displayed in the calendar's days view.

Declaration

public ContentOrientation Orientation { get; set; }

Property Value

Type	Description
ContentOrientation

Outlined

Whether the control will have outlined appearance.

Declaration

public bool Outlined { get; set; }

Property Value

Type	Description
System.Boolean

Placeholder

The placeholder attribute of the control (single input).

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String

PlaceholderEnd

The placeholder attribute of the end input.

Declaration

public string PlaceholderEnd { get; set; }

Property Value

Type	Description
System.String

PlaceholderStart

The placeholder attribute of the start input.

Declaration

public string PlaceholderStart { get; set; }

Property Value

Type	Description
System.String

Prompt

The prompt symbol to use for unfilled parts of the mask.

Declaration

public string Prompt { get; set; }

Property Value

Type	Description
System.String

ReadOnly

Makes the control a readonly field.

Declaration

[WCAttributeName("readonly")]
public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

Required

Makes the control a required field in a form context.

Declaration

public bool Required { get; set; }

Property Value

Type	Description
System.Boolean

ResourceStrings

The resource strings of the date range picker.

Declaration

public IgbDateRangePickerResourceStrings ResourceStrings { get; set; }

Property Value

Type	Description
IgbDateRangePickerResourceStrings

ShowWeekNumbers

Whether to show the number of the week in the calendar.

Declaration

public bool ShowWeekNumbers { get; set; }

Property Value

Type	Description
System.Boolean

SpecialDates

Gets/sets special dates.

Declaration

public IgbDateRangeDescriptor[] SpecialDates { get; set; }

Property Value

Type	Description
IgbDateRangeDescriptor[]

SupportsVisualChildren

Declaration

protected override bool SupportsVisualChildren { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseRendererControl.SupportsVisualChildren

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

IgbBaseComboBoxLike.Type

UsePredefinedRanges

Whether the control will show chips with predefined ranges.

Declaration

public bool UsePredefinedRanges { get; set; }

Property Value

Type	Description
System.Boolean

UseTwoInputs

Use two inputs to display the date range values. Makes the input editable in dropdown mode.

Declaration

public bool UseTwoInputs { get; set; }

Property Value

Type	Description
System.Boolean

Value

The value of the picker

Declaration

public IgbDateRangeValue Value { get; set; }

Property Value

Type	Description
IgbDateRangeValue

ValueChanged

Declaration

public EventCallback<IgbDateRangeValue> ValueChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbDateRangeValue>

VisibleMonths

Declaration

public double VisibleMonths { get; set; }

Property Value

Type	Description
System.Double

WeekStart

Sets the start day of the week for the calendar.

Declaration

public WeekDays WeekStart { get; set; }

Property Value

Type	Description
WeekDays

Methods

CheckValidity()

Declaration

public void CheckValidity()

CheckValidityAsync()

Checks for validity of the control and emits the invalid event if it invalid.

Declaration

public Task CheckValidityAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Clear()

Declaration

public void Clear()

ClearAsync()

Clears the input parts of the component of any user input

Declaration

public Task ClearAsync()

Returns

Type	Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration

protected override void EnsureModulesLoaded()

Overrides

BaseRendererControl.EnsureModulesLoaded()

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

IgbBaseComboBoxLike.FindByName(String)

GetCurrentValue()

Declaration

public IgbDateRangeValue GetCurrentValue()

Returns

Type	Description
IgbDateRangeValue

GetCurrentValueAsync()

Declaration

public Task<IgbDateRangeValue> GetCurrentValueAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbDateRangeValue>

ReportValidity()

Declaration

public void ReportValidity()

ReportValidityAsync()

Checks for validity of the control and shows the browser message if it invalid.

Declaration

public Task ReportValidityAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration

protected override string ResolveDisplay()

Returns

Type	Description
System.String

Overrides

IgbBaseComboBoxLike.ResolveDisplay()

Select(IgbDateRangeValue)

Declaration

public void Select(IgbDateRangeValue value)

Parameters

Type	Name	Description
IgbDateRangeValue	value

SelectAsync(IgbDateRangeValue)

Selects a date range value in the picker

Declaration

public Task SelectAsync(IgbDateRangeValue value)

Parameters

Type	Name	Description
IgbDateRangeValue	value

Returns

Type	Description
System.Threading.Tasks.Task

SetCustomValidity(String)

Declaration

public void SetCustomValidity(string message)

Parameters

Type	Name	Description
System.String	message

SetCustomValidityAsync(String)

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Declaration

public Task SetCustomValidityAsync(string message)

Parameters

Type	Name	Description
System.String	message

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable