ClassRadDateRangePicker
Represents an input control for selecting a range of two dates.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Input.dll
Syntax:
[Themable]
[TelerikToolboxCategory("Input")]
public class RadDateRangePicker : ControlInheritance: objectRadDateRangePicker
Constructors
RadDateRangePicker()
Initializes a new instance of the RadDateRangePicker class.
Declaration
public RadDateRangePicker()Fields
AreWeekNamesVisibleProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty AreWeekNamesVisiblePropertyField Value
DependencyProperty
AreWeekNumbersVisibleProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty AreWeekNumbersVisiblePropertyField Value
DependencyProperty
BlackoutDatesProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty BlackoutDatesPropertyField Value
DependencyProperty
CalendarWeekRuleProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty CalendarWeekRulePropertyField Value
DependencyProperty
ClearButtonStyleProperty
Identifies the ClearButtonStyle dependency property.
Declaration
public static readonly DependencyProperty ClearButtonStylePropertyField Value
DependencyProperty
CultureProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty CulturePropertyField Value
DependencyProperty
DatePatternProperty
Identifies the DatePattern dependency property.
Declaration
public static readonly DependencyProperty DatePatternPropertyField Value
DependencyProperty
EmptyContentProperty
Identifies the EmptyContent dependency property.
Declaration
public static readonly DependencyProperty EmptyContentPropertyField Value
DependencyProperty
EmptyContentTemplateProperty
Identifies the EmptyContentTemplate dependency property.
Declaration
public static readonly DependencyProperty EmptyContentTemplatePropertyField Value
DependencyProperty
EndDateProperty
Identifies EndDate dependency property.
Declaration
public static readonly DependencyProperty EndDatePropertyField Value
DependencyProperty
FirstDayOfWeekProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty FirstDayOfWeekPropertyField Value
DependencyProperty
FormatStringProperty
Identifies the FormatString dependency property.
Declaration
public static readonly DependencyProperty FormatStringPropertyField Value
DependencyProperty
HeaderVisibilityProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty HeaderVisibilityPropertyField Value
DependencyProperty
IsClearButtonVisibleProperty
Identifies the IsClearButtonVisible dependency property.
Declaration
public static readonly DependencyProperty IsClearButtonVisiblePropertyField Value
DependencyProperty
IsDefaultRangesPanelVisibleProperty
Identifies the IsDefaultRangesPanelVisible dependency property.
Declaration
public static readonly DependencyProperty IsDefaultRangesPanelVisiblePropertyField Value
DependencyProperty
IsDropDownOpenProperty
Identifies the IsDropDownOpen dependency property.
Declaration
public static readonly DependencyProperty IsDropDownOpenPropertyField Value
DependencyProperty
IsRangeEndProperty
Identifies IsRangeEnd attached property.
Declaration
public static readonly DependencyProperty IsRangeEndPropertyField Value
DependencyProperty
IsRangeStartProperty
Identifies IsRangeStart attached property.
Declaration
public static readonly DependencyProperty IsRangeStartPropertyField Value
DependencyProperty
IsReadOnlyProperty
Identifies the IsReadOnly dependency property.
Declaration
public static readonly DependencyProperty IsReadOnlyPropertyField Value
DependencyProperty
IsTopBarVisibleProperty
Identifies the IsTopBarVisible dependency property.
Declaration
public static readonly DependencyProperty IsTopBarVisiblePropertyField Value
DependencyProperty
PlaceholderProperty
Identifies the Placeholder dependency property.
Declaration
public static readonly DependencyProperty PlaceholderPropertyField Value
DependencyProperty
SelectableDateEndProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty SelectableDateEndPropertyField Value
DependencyProperty
SelectableDateStartProperty
Identifies the dependency property.
Declaration
public static readonly DependencyProperty SelectableDateStartPropertyField Value
DependencyProperty
SelectionOnFocusProperty
Identifies the SelectionOnFocus dependency property.
Declaration
public static readonly DependencyProperty SelectionOnFocusPropertyField Value
DependencyProperty
SeparatorProperty
Identifies the Separator dependency property.
Declaration
public static readonly DependencyProperty SeparatorPropertyField Value
DependencyProperty
StartDateProperty
Identifies StartDate dependency property.
Declaration
public static readonly DependencyProperty StartDatePropertyField Value
DependencyProperty
UseShortestDayNamesProperty
Identifies the dependency property.
The value that indicates whether the week names buttons are using shortest day names.
Declaration
public static readonly DependencyProperty UseShortestDayNamesPropertyField Value
DependencyProperty
Properties
AreWeekNamesVisible
Gets or sets whether WeekNames will be displayed.
Declaration
public bool AreWeekNamesVisible { get; set; }Property Value
Remarks
Please note that if you hide the WeekNames would not automatically change the template of the calendar. Depending on the skin, you may need to change the template to visually make up for the fewer displayed elements.
The AreWeekNumbersVisible can also be hidden.
The default value is true.
AreWeekNumbersVisible
Gets or sets whether WeekNumbers will be displayed.
Declaration
public bool AreWeekNumbersVisible { get; set; }Property Value
Remarks
Please note that if you hide the WeekNumbers it would not automatically change the template of the calendar. Depending on the skin, you may need to change the template to visually make up for the fewer displayed elements.
The AreWeekNamesVisible can also be hidden.
The default value is true.
BlackoutDates
Gets or sets a list of dates that cannot be selected. This is a dependency property.
Declaration
public IEnumerable<DateTime> BlackoutDates { get; set; }Property Value
Remarks
The BlackoutDates specifies a list of dates that cannot be selected by the user.
CalendarWeekRule
Gets or sets how should the first week in the year be counted. This is a dependency property.
Declaration
public CalendarWeekRule? CalendarWeekRule { get; set; }Property Value
Remarks
By default if no value is set (or is set to null), the CalendarWeek rule will be taken from Culture property (or InvariantCulture)'s DateTimeFormat.CalendarWeekRule.
ClearButtonStyle
Gets or sets the Clear Button style.
Declaration
public Style ClearButtonStyle { get; set; }Property Value
Style
Culture
Gets or sets the culture that the Calendar uses. This is a dependency property.
Declaration
public CultureInfo Culture { get; set; }Property Value
Remarks
Some of the elements in the Calendar are culture-specific, for example: The day/month names, rules for date formatting, the FirstDayOfWeek, CalendarWeekRule. Some more specific properties like FirstDayOfWeek take precedence over the Culture property if they are set.
If no Culture is specified, all the elements that rely on it will fall back to the CultureInfo.CurrentCulture.
The default value is null.
DatePattern
Gets or sets a value indicating the date pattern used in formatting the dates. Formats for abbreviated days (ddd,dddd), months (MMM, MMMM) are not supported. Hours, minutes, seconds, milliseconds are not supported.
EmptyContent
Gets or sets the Empty content.
EmptyContentTemplate
Gets or sets the template of the EmptyContent.
Declaration
public DataTemplate EmptyContentTemplate { get; set; }Property Value
DataTemplate
EndDate
Gets or sets a value indicating the end date of the date range.
FirstDayOfWeek
Gets or sets the day that is considered the beginning of the week.
Declaration
public DayOfWeek? FirstDayOfWeek { get; set; }Property Value
Remarks
The FirstDayOfWeek property specifies which is the day in the leftmost column of the calendar view, i.e. which is the first day of the week.
If the property is set to null, the Culture will be checked, if a specific culture is set, its FirstDayOfWeek is considered. Otherwise the CurrentCulture will be used.
Generally, the start of the week varies with different cultures so if you would like the Calendar to display the dates as you see them, be sure to set the FirstDayOfWeek property or the Culture property.
calendar.FirstDayOfWeek = CultureInfo.CurrentCulture.DateTimeFormat.FirstDayOfWeek;FormatString
Gets or sets the formatting string used to format the whole input text.
HeaderVisibility
Gets or sets the visibility of the Calendar's header. This is a dependency property.
Declaration
public Visibility HeaderVisibility { get; set; }Property Value
Visibility
Remarks
The header of the calendar is the area on the top in which the Header Button and the Previous and NextButtons reside.
IsClearButtonVisible
Gets or sets whether the clear button is visible.
IsDefaultRangesPanelVisible
Gets or sets a value indicating whether the default ranges panel of the control is visible or not.
Declaration
public bool IsDefaultRangesPanelVisible { get; set; }Property Value
IsDropDownOpen
Gets or sets a value indicating whether the drop-down part of the control is open.
IsReadOnly
Gets or sets whether the control is IsReadOnly.
IsTopBarVisible
Gets or sets a value indicating whether the top bar of the control is visible or not.
Placeholder
Gets or sets the placeholder symbol marking an empty position in the input.
Declaration
[TypeConverter(typeof(CharConverter))]
public char Placeholder { get; set; }Property Value
SelectableDateEnd
Gets or sets the last date that can be selected. This is a dependency property.
Declaration
public DateTime? SelectableDateEnd { get; set; }Property Value
Remarks
The SelectableDateEnd specifies the last date that can be selected by the user.
SelectableDateStart
Gets or sets the first date that can be selected. This is a dependency property.
Declaration
public DateTime? SelectableDateStart { get; set; }Property Value
Remarks
The SelectableDateStart specifies the first date that can be selected by the user.
SelectionOnFocus
Gets or sets a value indicating the behavior of the caret/selection when the control receives focus.
Declaration
public SelectionOnFocus SelectionOnFocus { get; set; }Property Value
Separator
Gets or sets the string representing the separator between the dates in the input.
Methods
GetIsRangeEnd(DependencyObject)
Gets the value of IsRangeEnd attached property for particular CalendarButton.
Declaration
public static bool GetIsRangeEnd(DependencyObject obj)Parameters
obj
DependencyObject
Returns
GetIsRangeStart(DependencyObject)
Gets the value of IsRangeStart attached property for particular CalendarButton.
Declaration
public static bool GetIsRangeStart(DependencyObject obj)Parameters
obj
DependencyObject
Returns
GetSelectedDaysRepresentation()
Called when user changes start/end day candidates and total selected days UI needs update.
Declaration
protected virtual string GetSelectedDaysRepresentation()Returns
GetTemporaryEndDateRepresentation(DateTime?)
Called when user has selected end day candidate and selection UI needs update.
GetTemporaryStartDateRepresentation(DateTime?)
Called when user has selected start day candidate and selection UI needs update.
IsValidRange()
Called when range is invalidated against blackout dates.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .
Declaration
public override void OnApplyTemplate()OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The RoutedEventArgs that contains the event data.
OnPreviewKeyDown(KeyEventArgs)
Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)Parameters
e
KeyEventArgs
SetIsRangeEnd(DependencyObject, bool)
Sets the value of IsRangeEnd attached property for particular CalendarButton.
Declaration
public static void SetIsRangeEnd(DependencyObject obj, bool value)Parameters
obj
DependencyObject
value
SetIsRangeStart(DependencyObject, bool)
Sets the value of IsRangeStart attached property for particular CalendarButton.
Declaration
public static void SetIsRangeStart(DependencyObject obj, bool value)Parameters
obj
DependencyObject
value
Events
CustomRangesLoading
Occurs before custom ranges are loaded, so that user can reset them according to the current DateTime.
Declaration
public event EventHandler<CustomRangesLoadingEventArgs> CustomRangesLoadingEvent Value