CalendarPicker class
[This API is for evaluation purposes only and is subject to change or removal.]
[This documentation is preliminary and is subject to change.]
Represents a control that allows a user to pick a date from a calendar display.
Inheritance
CalendarPicker
Syntax
public class CalendarPicker : Control
Public Class CalendarPicker
Inherits Control
public ref class CalendarPicker : Control
Attributes
[Experimental()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version]
[WebHostHidden()]
Members
The CalendarPicker class has these types of members:
- Constructors
- Events
- Methods
- Properties
Constructors
The CalendarPicker class has these constructors.
| Constructor | Description |
|---|---|
| CalendarPicker | Initializes a new instance of the CalendarPicker class. |
Events
The CalendarPicker class has these events.
| Event | Description |
|---|---|
| CalendarViewDayItemChanging | Occurs when a CalendarViewDayItem is loading in the picker's CalendarView. |
| Closed | Occurs when the picker's CalendarView is hidden. |
| DataContextChanged | Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement) |
| DateChanged | Occurs when the collection of selected dates is changed. |
| DoubleTapped | Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| DragCompleted | (Inherited from UIElement) |
| 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) |
| DragStarting | Occurs when a drag operation is initiated. (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) |
| Holding | Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (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 visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement) |
| Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement) |
| Loading | Occurs when a FrameworkElement begins to load. (Inherited from FrameworkElement) |
| LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement) |
| ManipulationCompleted | Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement) |
| ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement) |
| ManipulationInertiaStarting | Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement) |
| ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement) |
| ManipulationStarting | Occurs when the manipulation processor is first created. (Inherited from UIElement) |
| Opened | Occurs when the picker's CalendarView is shown. |
| PointerCanceled | Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement) |
| PointerCaptureLost | Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement) |
| PointerEntered | Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement) |
| PointerExited | Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement) |
| PointerMoved | Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement) |
| PointerPressed | Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement) |
| PointerReleased | Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement) |
| PointerWheelChanged | Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement) |
| RightTapped | Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement) |
| SizeChanged | Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement) |
| Tapped | Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement) |
Methods
The CalendarPicker class has these methods. It also inherits methods from the Object class.
| Method | 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 even if the event is handled elsewhere. (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 layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement) |
| CancelDirectManipulations | Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement) |
| CapturePointer | Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| CreateValidationIndicator | Instantiates a new validation error indicator for the control. (Inherited from Control) |
| FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement) |
| FindSubElementsForTouchTargeting | Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement) |
| Focus | Attempts to set the focus on the control. (Inherited from Control) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetBindingExpression | Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement) |
| GetIsTemplateFocusTarget | Gets the value of the Control.IsTemplateFocusTarget XAML attached property for the target element. (Inherited from Control) |
| GetTemplateChild | Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| GoToElementStateCore | When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement) |
| 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 the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement) |
| OnApplyTemplate | Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement) |
| OnDisconnectVisualChildren | Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement) |
| OnDoubleTapped | Called before the DoubleTapped event occurs. (Inherited from Control) |
| 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) |
| OnHolding | Called before the Holding 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) |
| OnManipulationCompleted | Called before the ManipulationCompleted event occurs. (Inherited from Control) |
| OnManipulationDelta | Called before the ManipulationDelta event occurs. (Inherited from Control) |
| OnManipulationInertiaStarting | Called before the ManipulationInertiaStarting event occurs. (Inherited from Control) |
| OnManipulationStarted | Called before the ManipulationStarted event occurs. (Inherited from Control) |
| OnManipulationStarting | Called before the ManipulationStarting event occurs. (Inherited from Control) |
| OnPointerCanceled | Called before the PointerCanceled event occurs. (Inherited from Control) |
| OnPointerCaptureLost | Called before the PointerCaptureLost event occurs. (Inherited from Control) |
| OnPointerEntered | Called before the PointerEntered event occurs. (Inherited from Control) |
| OnPointerExited | Called before the PointerExited event occurs. (Inherited from Control) |
| OnPointerMoved | Called before the PointerMoved event occurs. (Inherited from Control) |
| OnPointerPressed | Called before the PointerPressed event occurs. (Inherited from Control) |
| OnPointerReleased | Called before the PointerReleased event occurs. (Inherited from Control) |
| OnPointerWheelChanged | Called before the PointerWheelChanged event occurs. (Inherited from Control) |
| OnRightTapped | Called before the RightTapped event occurs. (Inherited from Control) |
| OnTapped | Called before the Tapped event occurs. (Inherited from Control) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback | Registers an instance-specific property value for a property-changed notification that comes from the core property system. (Inherited from DependencyObject) |
| ReleasePointerCapture | Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement) |
| ReleasePointerCaptures | Releases all pointer captures held by this element. (Inherited from UIElement) |
| RemoveHandler | Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement) |
| SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement) |
| SetDisplayDate | Shows the specified date in the calendar picker. |
| SetIsTemplateFocusTarget | Sets the value of the Control.IsTemplateFocusTarget XAML attached property for a target element. (Inherited from Control) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| SetYearDecadeDisplayDimensions | Sets the number of rows and columns to use in the Year and Decade display modes of the picker's CalendarView. |
| StartDragAsync | Initiates a drag-and-drop operation. (Inherited from UIElement) |
| TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement) |
| UnregisterPropertyChangedCallback | Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
| UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement) |
Properties
The CalendarPicker class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read-only | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement) | |
| Read/write | Gets or sets a brush that provides the background of the control. (Inherited from Control) | |
| Read-only | Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a brush that describes the border fill of a control. (Inherited from Control) | |
| Read/write | Gets or sets the border thickness of a control. (Inherited from Control) | |
| Read/write | Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement) | |
| Read/write | Gets or sets the calendar system to use. | |
| Read-only | Identifies the CalendarIdentifier dependency property. | |
| Read/write | Gets or sets the Style associated with the control's internal CalendarView object. | |
| Read-only | Identifies the CalendarViewStyle dependency property. | |
| Read-only | Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation. (Inherited from UIElement) | |
| Read/write | Gets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control) | |
| Read/write | Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement) | |
| Read/write | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the date currently set in the calendar picker. | |
| Read/write | Gets or sets the display format for the date value in the picker's text box. | |
| Read-only | Identifies the DateFormat dependency property. | |
| Read-only | Identifies the Date dependency property. | |
| Read/write | Gets or sets the display format for the day of the week headers in the picker's CalendarView. | |
| Read-only | Identifies the DayOfWeekFormat dependency property. | |
| Read/write | Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses. (Inherited from Control) | |
| Read-only | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement) | |
| Read-only | Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject) | |
| Read/write | Gets or sets a value that indicates whether the calendar shows selections for month, year, or decade in the picker's CalendarView. | |
| Read-only | Identifies the DisplayMode dependency property. | |
| Read/write | Gets or sets a value that indicates which day is shown as the first day of the week in the picker's CalendarView. | |
| Read-only | Identifies the FirstDayOfWeek dependency property. | |
| Read/write | Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement) | |
| Read-only | Gets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from Control) | |
| Read/write | Gets or sets the font used to display text in the control. (Inherited from Control) | |
| Read/write | Gets or sets the size of the text in this control. (Inherited from Control) | |
| Read/write | Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control) | |
| Read/write | Gets or sets the style in which the text is rendered. (Inherited from Control) | |
| Read/write | Gets or sets the thickness of the specified font. (Inherited from Control) | |
| Read/write | Gets or sets a brush that describes the foreground color. (Inherited from Control) | |
| Read/write | Gets or sets the content for the calendar picker's header. | |
| Read-only | Identifies the Header dependency property. | |
| Read/write | Gets or sets the DataTemplate used to display the content of the header. | |
| Read-only | Identifies the HeaderTemplate dependency property. | |
| Read/write | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | 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) | |
| Read/write | Gets or sets the horizontal alignment of the control's content. (Inherited from Control) | |
| Read/write | Gets or sets a value that indicates whether the calendar view of the CalendarPicker is currently shown. | |
| Read-only | Identifies the IsCalendarOpen dependency property. | |
| Read/write | Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control) | |
| Read/write | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that indicates whether the month name is shown with the first day of the month in the picker's CalendarView. | |
| Read-only | Identifies the IsLabelVisible dependency property. | |
| Read/write | Gets or sets a value that indicates whether out-of-scope calendar items are shown with a unique foreground color in the picker's CalendarView. | |
| Read-only | Identifies the IsOutOfScopeEnabled dependency property. | |
| Read/write | Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control) | |
| Read/write | Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that indicates whether this element is the part of a control template that has the focus visual. For use in a ControlTemplate only. (Inherited from Control) | |
| Read/write | Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from Control) | |
| Read/write | Gets or sets a value that indicates whether the current date is highlighted in the picker's CalendarView. | |
| Read-only | Identifies the IsTodayHighlighted dependency property. | |
| Read/write | Gets or sets a value that indicates whether the control UI shows validation errors. (Inherited from Control) | |
| Read/write | Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the calendar languages. | |
| Read-only | Identifies the Languages dependency property. | |
| Read/write | Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement) | |
| Read/write | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the last date that can be set in the picker. | |
| Read-only | Identifies the MaxDate dependency property. | |
| Read/write | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the first date that can be set in the picker. | |
| Read-only | Identifies the MinDate dependency property. | |
| Read/write | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | 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) | |
| Read/write | Gets or sets the degree of the object's opacity. (Inherited from UIElement) | |
| Read/write | Gets or sets the padding inside a control. (Inherited from Control) | |
| Read-only | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the text that is displayed in the picker's text box until the value is changed by a user action or some other operation. | |
| Read-only | Identifies the PlaceholderText dependency property. | |
| Read-only | Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement) | |
| Read/write | Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement) | |
| Read-only | Gets the final render size of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement) | |
| Read/write | 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) | |
| Read/write | Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. (Inherited from Control) | |
| Read/write | Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control) | |
| Read/write | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup. (Inherited from Control) | |
| Read-only | Gets or sets the 3-D transform effect to apply when rendering this element. (Inherited from UIElement) | |
| Read/write | Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement) | |
| Read-only | Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement) | |
| Read/write | 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) | |
| Read/write | Gets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template. (Inherited from Control) | |
| Read/write | Gets the collection of data validation errors. (Inherited from Control) | |
| Read/write | Gets or sets the style used to display validation errors. (Inherited from Control) | |
| Read/write | Gets a value that describes the state of the control's ValidationErrors collection. (Inherited from Control) | |
| Read/write | 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) | |
| Read/write | Gets or sets the vertical alignment of the control's content. (Inherited from Control) | |
| Read/write | Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement) | |
| Read/write | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement) |
Requirements (device family)
Device family |
Universal |
API contract |
Windows.Foundation.UniversalApiContract, introduced version 1.0 |
Namespace |
Windows.UI.Xaml.Controls Windows::UI::Xaml::Controls [C++] |
Metadata |
Windows.Foundation.UniversalApiContract.winmd |