DatePicker Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Represents a control that allows the user to select a date.
Inheritance Hierarchy
System.Object
System.Windows.DependencyObject
System.Windows.UIElement
System.Windows.FrameworkElement
System.Windows.Controls.Control
System.Windows.Controls.DatePicker
Microsoft.Internal.Pivot.Controls.CommandDatePicker
Namespace: System.Windows.Controls
Assembly: System.Windows.Controls (in System.Windows.Controls.dll)
Syntax
'Declaration
<TemplatePartAttribute(Name := "TextBox", Type := GetType(DatePickerTextBox))> _
<TemplatePartAttribute(Name := "Popup", Type := GetType(Popup))> _
<TemplateVisualStateAttribute(Name := "Valid", GroupName := "ValidationStates")> _
<StyleTypedPropertyAttribute(Property := "CalendarStyle", StyleTargetType := GetType(Calendar))> _
<TemplatePartAttribute(Name := "Root", Type := GetType(FrameworkElement))> _
<TemplateVisualStateAttribute(Name := "InvalidFocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "InvalidUnfocused", GroupName := "ValidationStates")> _
<TemplatePartAttribute(Name := "Button", Type := GetType(Button))> _
Public Class DatePicker _
Inherits Control
[TemplatePartAttribute(Name = "TextBox", Type = typeof(DatePickerTextBox))]
[TemplatePartAttribute(Name = "Popup", Type = typeof(Popup))]
[TemplateVisualStateAttribute(Name = "Valid", GroupName = "ValidationStates")]
[StyleTypedPropertyAttribute(Property = "CalendarStyle", StyleTargetType = typeof(Calendar))]
[TemplatePartAttribute(Name = "Root", Type = typeof(FrameworkElement))]
[TemplateVisualStateAttribute(Name = "InvalidFocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "InvalidUnfocused", GroupName = "ValidationStates")]
[TemplatePartAttribute(Name = "Button", Type = typeof(Button))]
public class DatePicker : Control
<sdk:DatePicker .../>
The DatePicker type exposes the following members.
Properties
Name | Description | |
---|---|---|
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) | |
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) | |
AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.) | |
Background | Gets or sets a brush that provides the background of the control. (Inherited from Control.) | |
BlackoutDates | Gets or sets a collection of dates that are marked as not selectable. | |
BorderBrush | Gets or sets a brush that describes the border background of a control. (Inherited from Control.) | |
BorderThickness | Gets or sets the border thickness of a control. (Inherited from Control.) | |
CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) | |
CalendarStyle | Gets or sets the style that is used when rendering the calendar. | |
CharacterSpacing | Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.) | |
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) | |
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) | |
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) | |
DefaultStyleKey | Gets or sets the key that references the default style for the control. (Inherited from Control.) | |
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) | |
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) | |
DisplayDate | Gets or sets the date to display. | |
DisplayDateEnd | Gets or sets the last date to be displayed. | |
DisplayDateStart | Gets or sets the first date to be displayed. | |
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) | |
FirstDayOfWeek | Gets or sets the day that is considered the beginning of the week. | |
FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) | |
FontFamily | Gets or sets the font used to display text in the control. (Inherited from Control.) | |
FontSize | Gets or sets the size of the text in this control. (Inherited from Control.) | |
FontStretch | Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.) | |
FontStyle | Gets or sets the style in which the text is rendered. (Inherited from Control.) | |
FontWeight | Gets or sets the thickness of the specified font. (Inherited from Control.) | |
Foreground | Gets or sets a brush that describes the foreground color. (Inherited from Control.) | |
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) | |
HorizontalAlignment | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.) | |
HorizontalContentAlignment | Gets or sets the horizontal alignment of the control's content. (Inherited from Control.) | |
IsDropDownOpen | Gets or sets a value that indicates whether the drop-down Calendar is open or closed. | |
IsEnabled | Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.) | |
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) | |
IsTabStop | Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.) | |
IsTodayHighlighted | Gets or sets a value that indicates whether the current date will be highlighted. | |
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) | |
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) | |
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
Name | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.) | |
Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) | |
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) | |
Padding | Gets or sets the padding inside a control. (Inherited from Control.) | |
Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) | |
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) | |
RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) | |
RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) | |
RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) | |
Resources | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.) | |
SelectedDate | Gets or sets the currently selected date. | |
SelectedDateFormat | Gets or sets the format that is used to display the selected date. | |
SelectionBackground | Gets or sets the background used for selected dates. | |
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) | |
TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.) | |
TabNavigation | Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.) | |
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) | |
Template | Gets or sets a control template. (Inherited from Control.) | |
Text | Gets the text that is displayed by the DatePicker, or sets the selected date. | |
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) | |
UseLayoutRounding | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.) | |
VerticalAlignment | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.) | |
VerticalContentAlignment | Gets or sets the vertical alignment of the control's content. (Inherited from Control.) | |
Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) | |
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
Name | Description | |
---|---|---|
AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) | |
ApplyTemplate | Loads the relevant control template so that its parts can be referenced. (Inherited from Control.) | |
Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.) | |
ArrangeOverride | Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) | |
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) | |
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) | |
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) | |
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) | |
Focus | Attempts to set the focus on the control. (Inherited from Control.) | |
GetAnimationBaseValue | Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) | |
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetTemplateChild | Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) | |
InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.) | |
InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.) | |
Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.) | |
MeasureOverride | Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnApplyTemplate | Builds the visual tree for the DatePicker control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().) | |
OnCreateAutomationPeer | Returns a DatePickerAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().) | |
OnDateValidationError | Raises the DateValidationError event. | |
OnDragEnter | Called before the DragEnter event occurs. (Inherited from Control.) | |
OnDragLeave | Called before the DragLeave event occurs. (Inherited from Control.) | |
OnDragOver | Called before the DragOver event occurs. (Inherited from Control.) | |
OnDrop | Called before the Drop event occurs. (Inherited from Control.) | |
OnGotFocus | Called before the GotFocus event occurs. (Inherited from Control.) | |
OnKeyDown | Called before the KeyDown event occurs. (Inherited from Control.) | |
OnKeyUp | Called before the KeyUp event occurs. (Inherited from Control.) | |
OnLostFocus | Called before the LostFocus event occurs. (Inherited from Control.) | |
OnLostMouseCapture | Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) | |
OnMouseEnter | Called before the MouseEnter event occurs. (Inherited from Control.) | |
OnMouseLeave | Called before the MouseLeave event occurs. (Inherited from Control.) | |
OnMouseLeftButtonDown | Called before the MouseLeftButtonDown event occurs. (Inherited from Control.) | |
OnMouseLeftButtonUp | Called before the MouseLeftButtonUp event occurs. (Inherited from Control.) | |
OnMouseMove | Called before the MouseMove event occurs. (Inherited from Control.) | |
OnMouseRightButtonDown | Called before the MouseRightButtonDown event occurs. (Inherited from Control.) | |
OnMouseRightButtonUp | Called before the MouseRightButtonUp event occurs. (Inherited from Control.) | |
OnMouseWheel | Provides handling for the MouseWheel event. (Overrides Control.OnMouseWheel(MouseWheelEventArgs).) | |
OnTextInput | Called before the TextInput event occurs. (Inherited from Control.) | |
OnTextInputStart | Called before the TextInputStart event occurs. (Inherited from Control.) | |
OnTextInputUpdate | Called before the TextInputUpdate event occurs. (Inherited from Control.) | |
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) | |
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) | |
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) | |
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) | |
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) | |
ToString | Returns a string that represents the current object. (Overrides Object.ToString().) | |
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) | |
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
Name | Description | |
---|---|---|
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) | |
CalendarClosed | Occurs when the drop-down Calendar is closed. | |
CalendarOpened | Occurs when the drop-down Calendar is opened. | |
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) | |
DateValidationError | Occurs when Text is assigned a value that cannot be interpreted as a date. | |
DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.) | |
DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.) | |
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.) | |
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) | |
GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) | |
IsEnabledChanged | Occurs when the IsEnabled property changes. (Inherited from Control.) | |
KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.) | |
KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.) | |
LayoutUpdated | Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.) | |
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) | |
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) | |
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) | |
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) | |
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) | |
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) | |
MouseLeftButtonDown | Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.) | |
MouseLeftButtonUp | Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) | |
MouseMove | Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) | |
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) | |
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.) | |
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) | |
SelectedDateChanged | Occurs when the SelectedDate property is changed. | |
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) | |
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) | |
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) | |
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) | |
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
Name | Description | |
---|---|---|
CalendarStyleProperty | Identifies the CalendarStyle dependency property. | |
DisplayDateEndProperty | Identifies the DisplayDateEnd dependency property. | |
DisplayDateProperty | Identifies the DisplayDate dependency property. | |
DisplayDateStartProperty | Identifies the DisplayDateStart dependency property. | |
FirstDayOfWeekProperty | Identifies the FirstDayOfWeek dependency property. | |
IsDropDownOpenProperty | Identifies the IsDropDownOpen dependency property. | |
IsTodayHighlightedProperty | Identifies the IsTodayHighlighted dependency property. | |
SelectedDateFormatProperty | Identifies the SelectedDateFormat dependency property. | |
SelectedDateProperty | Identifies the SelectedDate dependency property. | |
SelectionBackgroundProperty | Identifies the SelectionBackground dependency property. | |
TextProperty | Identifies the Text dependency property. |
Top
Remarks
The DatePicker control allows the user to select a date by either typing it into a text field or by using a drop-down Calendar control.
Many of a DatePicker control's properties are for managing its built-in Calendar, and function identically to the equivalent property in Calendar. In particular, the DatePicker.IsTodayHighlighted, DatePicker.FirstDayOfWeek, DatePicker.BlackoutDates, DatePicker.DisplayDateStart, DisplayDateEnd, DatePicker.DisplayDate, and DatePicker.SelectedDate properties function identically to their Calendar counterparts. For more information, see Calendar.
Users can type a date directly into a text field, which sets the Text property. If the DatePicker cannot convert the entered string to a valid date, the DateValidationError event will be raised. By default, this causes an exception, but an event handler for DateValidationError can set the ThrowException property to false and prevent an exception from being raised. To change the watermark hint displayed in a DatePicker control, see DatePickerTextBox.Watermark.
Note: |
---|
The DatePicker control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools. |
Customizing the DatePicker Control
To apply the same property settings to multiple DatePicker controls, use the Style property. To change the visual structure and visual behavior of a DatePicker, copy and modify its default style and template. For more information, see Control Customization.
Dependency properties for this control might be set by the default style of the control. If a dependency property for a DatePicker is set by its default style, the property might change from its default value when the DatePicker appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for DatePicker from DatePicker Styles and Templates.
Note: |
---|
Setting a visual property will only have an effect if that property is both present in DatePicker control's default template and is set by using a TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section of Customizing the Appearance of an Existing Control by Using a ControlTemplate. |
Examples
The following code and XAML creates a page with two Calendar controls and two DatePicker controls. The Calendar and DatePicker controls are configured in a variety of ways. To run this sample, create a Silverlight project named CalendarExample. In the project, add a reference to the System.Windows.Controls assembly and add the following code to the appropriate files.
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Documents
Imports System.Windows.Input
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Imports System.Windows.Shapes
Partial Public Class Page
Inherits UserControl
Public Sub New()
InitializeComponent()
' Sets a Calendar to display a range of dates from 1/10/2009 to
' 4/18/2009. 2/15/2009 is selected, but 3/2009 is initially
' displayed.
cal.SelectedDate = New DateTime(2009, 2, 15)
cal.DisplayDate = New DateTime(2009, 3, 15)
' if DisplayDate is not set, the Calendar displays
' the SelectedDate.
cal.DisplayDateStart = New DateTime(2009, 1, 10)
cal.DisplayDateEnd = New DateTime(2009, 4, 18)
'Sets a Calendar to allow multiple selections, and configures
'some dates to be unselectable.
cal3.SelectionMode = CalendarSelectionMode.MultipleRange
cal3.DisplayDate = New DateTime(2009, 1, 1)
cal3.DisplayDateStart = New DateTime(2009, 1, 1)
cal3.DisplayDateEnd = New DateTime(2009, 1, 31)
cal3.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 2), New DateTime(2009, 1, 4)))
cal3.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 9)))
cal3.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 16)))
cal3.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 23), New DateTime(2009, 1, 25)))
cal3.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 30)))
cal3.SelectedDates.Add(New DateTime(2009, 1, 5))
cal3.SelectedDates.AddRange(New DateTime(2009, 1, 12), New DateTime(2009, 1, 15))
cal3.SelectedDates.Add(New DateTime(2009, 1, 27))
End Sub
'Simple event handlers that updates a TextBlock when
'the drop-down calendar is opened or closed.
Private Sub dp1_CalendarOpened(ByVal sender As Object, ByVal e As RoutedEventArgs) Handles dp1.CalendarOpened
text1.Text = "DatePicker Calendar opened!"
End Sub
Private Sub dp1_CalendarClosed(ByVal sender As Object, ByVal e As RoutedEventArgs) Handles dp1.CalendarClosed
text1.Text = "DatePicker Calendar closed!"
End Sub
'Updates a TextBlock with information from the SelectedDateChanged event.
Private Sub dp2_SelectedDateChanged(ByVal sender As Object, ByVal e As SelectionChangedEventArgs) Handles dp2.SelectedDateChanged
'RemovedItems will be null if this is the first time a date was selected.
If e.RemovedItems Is Nothing OrElse e.RemovedItems.Count = 0 Then
text1.Text = "Changed SelectedDate from nothing to " + e.AddedItems(0) + "!"
Else
text1.Text = "Changed SelectedDate from " + e.RemovedItems(0) + " to " + e.AddedItems(0) + "!"
End If
End Sub
'Updates a TextBlock with information from the DisplayDateChanged event.
'This will happen every time the visible month changes, whether triggered
'by user input or by code.
Private Sub cal_DisplayDateChanged(ByVal sender As Object, ByVal e As CalendarDateChangedEventArgs) Handles cal.DisplayDateChanged
'This should never occur unless DisplayDate is explicitly set to nothing.
If e.RemovedDate Is Nothing Then
text1.Text = "Changed DisplayDate from nothing to " + e.AddedDate + "!"
Else
text1.Text = "Changed DisplayDate from " + e.RemovedDate + " to " + e.AddedDate + "!"
End If
End Sub
End Class
using System;
using System.Collections.Generic;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
namespace CalendarExample
{
public partial class Page : UserControl
{
public Page()
{
InitializeComponent();
//Sets a Calendar to display a range of dates from 1/10/2009 to
//4/18/2009. 2/15/2009 is selected, but 3/2009 is initially
//displayed.
cal.SelectedDate = new DateTime(2009, 2, 15);
cal.DisplayDate = new DateTime(2009, 3, 15); //if DisplayDate is not set, the Calendar displays
//the SelectedDate.
cal.DisplayDateStart = new DateTime(2009, 1, 10);
cal.DisplayDateEnd = new DateTime(2009, 4, 18);
//Sets a Calendar to allow multiple selections, and configures
//some dates to be unselectable.
cal3.SelectionMode = CalendarSelectionMode.MultipleRange;
cal3.DisplayDate = new DateTime(2009, 1, 1);
cal3.DisplayDateStart = new DateTime(2009, 1, 1);
cal3.DisplayDateEnd = new DateTime(2009, 1, 31);
cal3.BlackoutDates.Add(new CalendarDateRange(new DateTime(2009, 1, 2), new DateTime(2009, 1, 4)));
cal3.BlackoutDates.Add(new CalendarDateRange(new DateTime(2009, 1, 9)));
cal3.BlackoutDates.Add(new CalendarDateRange(new DateTime(2009, 1, 16)));
cal3.BlackoutDates.Add(new CalendarDateRange(new DateTime(2009, 1, 23), new DateTime(2009, 1, 25)));
cal3.BlackoutDates.Add(new CalendarDateRange(new DateTime(2009, 1, 30)));
cal3.SelectedDates.Add(new DateTime(2009, 1, 5));
cal3.SelectedDates.AddRange(new DateTime(2009, 1, 12), new DateTime(2009, 1, 15));
cal3.SelectedDates.Add(new DateTime(2009, 1, 27));
//Hook up events to event handlers.
dp1.CalendarOpened += new RoutedEventHandler(dp1_CalendarOpened);
dp1.CalendarClosed += new RoutedEventHandler(dp1_CalendarClosed);
dp2.SelectedDateChanged += new EventHandler<SelectionChangedEventArgs>(dp2_SelectedDateChanged);
cal2.DisplayDateChanged += new EventHandler<CalendarDateChangedEventArgs>(cal_DisplayDateChanged);
}
//Simple event handlers that updates a TextBlock when
//the drop-down calendar is opened or closed.
void dp1_CalendarOpened(object sender, RoutedEventArgs e)
{
text1.Text = "DatePicker Calendar opened!";
}
void dp1_CalendarClosed(object sender, RoutedEventArgs e)
{
text1.Text = "DatePicker Calendar closed!";
}
//Updates a TextBlock with information from the SelectedDateChanged event.
void dp2_SelectedDateChanged(object sender, SelectionChangedEventArgs e)
{
//RemovedItems will be null if this is the first time a date was selected.
if (e.RemovedItems == null || e.RemovedItems.Count == 0)
{
text1.Text = "Changed SelectedDate from null to " + e.AddedItems[0] + "!";
}
else
{
text1.Text = "Changed SelectedDate from " + e.RemovedItems[0] + " to " + e.AddedItems[0] + "!";
}
}
//Updates a TextBlock with information from the DisplayDateChanged event.
//This will happen every time the visible month changes, whether triggered
//by user input or by code.
void cal_DisplayDateChanged(object sender, CalendarDateChangedEventArgs e)
{
//This should never occur unless DisplayDate is explicitly set to null.
if (e.RemovedDate == null)
{
text1.Text = "Changed DisplayDate from null to " + e.AddedDate + "!";
}
else
{
text1.Text = "Changed DisplayDate from " + e.RemovedDate + " to " + e.AddedDate + "!";
}
}
}
}
<!-- NOTE:
By convention, the sdk prefix indicates a URI-based XAML namespace declaration
for Silverlight SDK client libraries. This namespace declaration is valid for
Silverlight 4 only. In Silverlight 3, you must use individual XAML namespace
declarations for each CLR assembly and namespace combination outside the scope
of the default Silverlight XAML namespace. For more information, see the help
topic "Prefixes and Mappings for Silverlight Libraries".
-->
<UserControl xmlns:sdk="https://schemas.microsoft.com/winfx/2006/xaml/presentation/sdk" x:Class="CalendarExample.Page"
xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
FontFamily="Trebuchet MS" FontSize="11"
Width="600" Height="750">
<StackPanel x:Name="LayoutRoot" Background="White">
<StackPanel Orientation="Horizontal" Margin="5" >
<!-- A basic Calendar. -->
<TextBlock Width="100"
Text="Calendar with date ranges defined:" TextWrapping="Wrap" Margin="5" />
<sdk:Calendar x:Name="cal" />
<!-- A Calendar does not highlight today's date. -->
<TextBlock Width="100"
Text="Calendar that does not highlight today's date:" TextWrapping="Wrap" Margin="5"/>
<sdk:Calendar x:Name="cal2" Canvas.Left="270" Canvas.Top="100"
IsTodayHighlighted="false" />
</StackPanel>
<!-- Two DatePicker controls, one using the default Short date format -->
<!-- and the other using the Long date format. -->
<StackPanel Orientation="Horizontal" >
<TextBlock Width="200" Margin="5"
Text="DatePicker with Short date format and Calendar event handlers:" TextWrapping="Wrap" />
<sdk:DatePicker x:Name="dp1" Height="20" Width="200" />
</StackPanel>
<StackPanel Orientation="Horizontal" >
<TextBlock Width="200" Margin="5"
Text="DatePicker with Long date format and DateSelected event handler:" TextWrapping="Wrap" />
<sdk:DatePicker Height="20" x:Name="dp2" SelectedDateFormat="Long" Width="200"/>
</StackPanel>
<!-- Output TextBlock -->
<TextBlock x:Name="text1" HorizontalAlignment="Left" Height="40" Width="350" Margin="5" />
<!-- A Calendar to demonstrate multiple selection. -->
<StackPanel Orientation="Horizontal" >
<TextBlock Width="200" Margin="5"
Text="Calendar with multiple selections and blackout dates:" TextWrapping="Wrap" />
<sdk:Calendar x:Name="cal3" />
</StackPanel>
</StackPanel>
</UserControl>
The previous example produces output that is similar to the following illustration. The first part of the illustration shows a DatePicker before it is selected. The second part of the illustration shows the DatePicker with the calendar visible. The third part of the illustration shows the DatePicker after a date has been selected.
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also