DatePicker
in namespace DotVVM.BusinessPack.Controls
Renders a calendar allowing users to select year, month or full date.
Usage & Scenarios
Renders a text field that allows the user to enter or select date using a Gregorian-style calendar popup.
Sample 1: Basic Usage
The SelectedDate property represents a Date value with a date selected in the control.
<bp:DatePicker SelectedDate="{value: SelectedDate}" />
<p>Selected date: <dot:Literal Text="{value: SelectedDate}" FormatString="g" /></p>using System;
using DotVVM.Framework.ViewModel;
namespace DotvvmWeb.Views.Docs.Controls.businesspack.DatePicker.sample1
{
public class ViewModel : DotvvmViewModelBase
{
public DateTime SelectedDate { get; set; } = DateTime.Now;
}
}Sample 2: Selection Bounds
You can use the MinDate and MaxDate properties to specify the minimum and maximum values for the selection.
<bp:DatePicker SelectedDate="{value: SelectedDate}"
MinDate="{value: MinimumDate}"
MaxDate="{value: MaximumDate}" />
<p>Selected date: <dot:Literal Text="{value: SelectedDate}" FormatString="g" /></p>using System;
using DotVVM.Framework.ViewModel;
namespace DotvvmWeb.Views.Docs.Controls.businesspack.DatePicker.sample2
{
public class ViewModel : DotvvmViewModelBase
{
public DateTime SelectedDate { get; set; } = DateTime.Now;
public DateTime MinimumDate { get; set; } = DateTime.Now.AddDays(-5);
public DateTime MaximumDate { get; set; } = DateTime.Now.AddDays(5);
}
}Sample 3: Restrictions
If you require more granular control over what dates can be selected, you can use the Restrictions property. We currently support the following types of restrictions:
- DayOfWeekRestriction - Allows to disable selection of a specific day of week.
- DateRangeRestriction - Allows to disable a specific range of dates (one day, one month, etc.). You just need to set the
StartDateandEndDateproperties, where theStartDaterepresents inclusive start of the restriction andEndDaterepresents exclusive end of the restriction.
Restrictions can be combined with MinDate and MaxDate properties and are verified both on client-side and server-side.
<bp:DatePicker SelectedDate="{value: SelectedDate}"
Restrictions="{value: Restrictions}" />
<p>Selected date: <dot:Literal Text="{value: SelectedDate}" FormatString="g" /></p>using System;
using System.Collections.Generic;
using DotVVM.BusinessPack.Controls;
using DotVVM.Framework.ViewModel;
namespace DotvvmWeb.Views.Docs.Controls.businesspack.DatePicker.sample3
{
public class ViewModel : DotvvmViewModelBase
{
public DateTime SelectedDate { get; set; } = DateTime.Now;
public List<DateRestriction> Restrictions { get; set; } = new List<DateRestriction>()
{
//These will prevent saturdays and sundays from being selected
new DayOfWeekRestriction() { DayOfWeek = DayOfWeek.Saturday },
new DayOfWeekRestriction() { DayOfWeek = DayOfWeek.Sunday },
//This will prevent selection of all dates from the 1st of June to the 6th of June of current year
new DateRangeRestriction()
{
StartDate = new DateTime(DateTime.Today.Year, 6, 1),
EndDate = new DateTime(DateTime.Today.Year, 6, 7)
}
};
}
}
Sample 4: Format Strings
The FormatString property specifies the format that will be used to display selected date. Use standard or
custom .NET date format strings.
The language of the calendar and the first day of week is specified by the request culture. You can find more info in the Globalization tutorial.
<bp:DatePicker SelectedDate="{value: SelectedDate}"
FormatString="dd MMM yyyy"/>
<p>Selected date: <dot:Literal Text="{value: SelectedDate}" FormatString="g" /></p>using System;
using DotVVM.Framework.ViewModel;
namespace DotvvmWeb.Views.Docs.Controls.businesspack.DatePicker.sample4
{
public class ViewModel : DotvvmViewModelBase
{
public DateTime SelectedDate { get; set; } = DateTime.Now;
}
}Sample 5: Inline
The 'ShowInline' property toggle whether the DatePicker is displayed inline in page or as a drop-down editor.
<bp:DatePicker SelectedDate="{value: SelectedDate}"
ShowInline />
<p>Selected date: <dot:Literal Text="{value: SelectedDate}" FormatString="g" /></p>using System;
using DotVVM.Framework.ViewModel;
namespace DotvvmWeb.Views.Docs.Controls.businesspack.DatePicker.sample5
{
public class ViewModel : DotvvmViewModelBase
{
public DateTime SelectedDate { get; set; } = DateTime.Now;
}
}Properties
| Name | Type | Description | Notes | Default Value | |
|---|---|---|---|---|---|
 |
AllowUnselect | Boolean | Gets or sets whether the selected value can be unselected. It is allowed by default. |
attribute
static value
bindable
|
True |
|
AutoFocus | Boolean | Gets or sets whether the control should have focus when page loads or when a dialog is opened. The default value is false. |
attribute
static value
|
False |
|
ClientIDMode | ClientIDMode | Gets or sets the client ID generation algorithm. |
attribute
static value
|
Static |
|
ConfirmIcon | IconBase | Gets or sets the icon to confirm selection and close popup dialog. |
inner element
static value
bindable
|
null |
|
DataContext | Object | Gets or sets a data context for the control and its children. All value and command bindings are evaluated in context of this value. The DataContext is null in client-side templates. |
attribute
bindable
|
null |
|
Enabled | Boolean | Gets or sets whether the control is enabled and can be modified. |
attribute
static value
bindable
|
True |
|
FirstDayOfWeek | DayOfWeek? | Gets or sets the first day of a week. Set the value to Monday if you want to display ISO 8601 weeks. The default value is based on the current culture. |
attribute
static value
|
null |
|
FormatString | String | Gets or sets the format string that will be used to display the value. |
attribute
static value
|
null |
|
ID | String | Gets or sets the control client ID within its naming container. |
attribute
static value
bindable
|
null |
|
IncludeInPage | Boolean | Gets or sets whether the control is included in the DOM of the page. |
attribute
bindable
|
True |
|
MaxDate | DateTime? | Gets or sets the highest date that can be selected by user. |
attribute
bindable
|
null |
|
MinDate | DateTime? | Gets or sets the lowest date that can be selected by user. |
attribute
bindable
|
null |
|
NextIcon | IconBase | Gets or sets the icon displayed on the button navigating to next page. |
inner element
static value
bindable
|
null |
|
Placeholder | String | Gets or sets the text displayed when value is not selected. |
attribute
static value
|
null |
|
PrevIcon | IconBase | Gets or sets the icon displayed on the button navigating to previous page. |
inner element
static value
bindable
|
null |
|
Restrictions | IEnumerable<DateRestriction> | Gets or sets a collection of rules specifying which date intervals can't be selected. |
attribute
bindable
|
null |
|
SelectedDate | DateTime? | Gets or sets the date selected by user. |
attribute
bindable
|
null |
|
ShowInline | Boolean | Gets or sets whether the picker is displayed inline in page or as a drop-down editor. |
attribute
static value
|
False |
|
TabIndex | Int32 | Gets or sets the order in which the control is reachable in sequential keyboard navigation. The default value is 0 which means the document order. |
attribute
static value
bindable
|
0 |
|
ToggleIcon | IconBase | Gets or sets the icon displayed on the toggle button. |
inner element
static value
bindable
|
null |
|
UnselectIcon | IconBase | Gets or sets the icon displayed on the unselect button. |
inner element
static value
bindable
|
null |
|
UseFormatStringAsPlaceholder | Boolean | Gets or sets whether to use the FormatString as a placeholder when placeholder property is not set. It is enabled by default. |
attribute
static value
|
True |
|
Visible | Boolean |
attribute
bindable
|
True | |
|
WeekNumberMode | WeekNumberMode | Gets or sets how are week numbers computed and whether to display them. The default value is Disabled. |
attribute
static value
|
Disabled |
Events
| Name | Type | Description | |
|---|---|---|---|
 |
Changed | Command | Gets or sets the command triggered when the value is changed. |