Search
Calendar Members
Constructors Properties Methods Events
 


The Calendar control serves as a view in document-view architecture, where the document is implemented by the Schedule class. The Calendar provides several schedule related views, such as Month, List, Timetable, that present the scheduled events in different styles and layouts.

The following tables list the members exposed by the Calendar type.

 Public Constructors

  Name Description

Calendar

Overloaded. Initializes a new instance of the Calendar class.

 Public Properties

  Name Description

AllowAutoScroll

Gets or sets a value indicating whether the control scrolls automatically its contents when users drag items near the edge of the client rectangle.

AllowContextMenu

Gets or sets a value indicating whether tapping and holding over an item or an empty cell will display a context menu.

AllowInplaceEdit

Gets or sets a value indicating whether users are allowed to edit items interactively.

ButtonOffset

Gets or set the offset of the navigation buttons, displayed in the views' headers.

ButtonSize

Gets or sets the size of the navigation buttons, displayed in the views' headers.

ContactNameFormat

Gets or sets how to format and display contact names in the timetable header.

Contacts

Gets the contacts whose schedule to display when GroupType is set to GroupByContacts.

Culture

Gets or sets the CultureInfo object used to format and display time information in the calendar.

CurrentTime

Gets or sets the current time. When this property is set to DateTime.MinValue, the actual system time is returned.

CurrentView

Gets or sets the type of the calendar view.

CustomDraw

Gets or sets which UI elements of the calendar should be custom drawn.

CustomTheme

Gets or sets the custom theme applied to the control.

Date

Gets or sets the date currently displayed in the calendar.

DateTimeFormat

Gets or sets the DateTimeFormatInfo object that specifies how to format and display all dates within the calendar.

DayOfWeekStyles

Gets a collection of DayOfWeekStyle objects that allow customizing the appearance of specific days of the week in the calendar.

DayStyles

Gets a collection of DateStyle objects that allow customizing the appearance of specific days in the calendar.

DragBehavior

Gets or sets how the calendar responds to users touching and dragging over empty cells.

DragItemsOnDisabledAreas

Gets or sets a value indicating whether to update the position of items dragged over areas which do not allow items.

EnableAntialiasing

Gets or sets a value indicating whether to use antialiasing when rendering

EnsureVisibleSelection

Gets or sets a value indicating whether the selected cells should be automatically brought into view.

FirstWeekendDay

Gets or sets the first weekend day in the calendar.

GroupType

Gets or sets the grouping criteria for the Timetable and List views.

InteractiveItemType

Gets or sets the type of a Item-derived class whose instance should be created when a user starts typing while the calendar control has the keyboard focus.

IsRightToLeft

Gets or sets a flag indicating whether the calendar is in a Right-to-Left mode.

ItemEffects

Gets a collection with all effects applied to the elements of this calendar.

ItemSelection

Gets a list of all selected items.

ItemSettings

Gets the ItemSettings object used to customize the visualization of schedule items in all calendar views.

KeepItemSelection

Gets or sets a value indicating whether the item selection is preserved when an item from the selection is clicked.

LicenseKey

Gets or sets the license key of the control.

ListViewSettings

Gets the ListViewSettings object used to customize the visualization of the List view.

LocalizationInfo

Gets or sets the LocalizationInfo object containing the settings used to customize various UI controls within the calendar.

Locations

Gets the locations whose schedule to display in the timetable when GroupType is set to GroupByLocations.

MenuSize

Gets or sets the size of the context menu, in device-independent pixels.

MinItemLength

Gets or sets the minimal length of interactively created items, expressed in minutes.

MonthSettings

Gets the MonthSettings object used to customize the visualization of months in a Month view.

MonthStyles

Gets a collection of DateStyle objects that allow customizing the appearance of specific months in the calendar.

Resources

Gets the resources whose schedule to display in the control when GroupType is set to GroupByResources.

ResourceViewSettings

Gets the ResourceViewSettings object used to customize the visualization of a Resource view.

Schedule

Gets or sets the schedule whose information should be displayed inside the calendar control.

ScrollX

Gets or sets the current horizontal scroll position.

ScrollY

Gets or sets the current vertical scroll position.

ScrollZoneSize

Gets or sets the distance from the edge of the view where user interactions would trigger autoscrolling.

Selection

Gets a Selection object representing the current selection in the calendar.

SystemCalendar

Gets or sets the System.Globalization.Calendar object to use when displaying dates in the control.

Tasks

Gets the tasks whose schedule to display in the control when GroupType is set to GroupByTasks.

Theme

Gets or sets the theme applied to the calendar control UI elements.

TimetableSettings

Gets the TimetableSettings object used to customize the visualization of days and hours in Timetable view.

WeekRangeSettings

Gets the WeekRangeSettings object used to customize the visualization of the WeekRange view.

 Public Methods

  Name Description

ApplyTheme

Overloaded. Applies a Theme to the calendar.

BeginEdit

Starts in-place editing mode for the specified item to let users edit the item's text.

BeginInit

Implements the ISupportInitialize.BeginInit method. Call this method before making several consecutive changes to the control to suppress internal updates, but don't forget to invoke EndInit at the end.

CollapseResourceRow

Overloaded. Collapses the row associated with the specified resource.

CompactItemLanes

Overloaded. Reassigns new lane indices to schedule items.

EndInit

Implements the ISupportInitialize.EndInit method. Call this method to signal that object initialization started with BeginInit is complete.

EnsureVisible

Overloaded. Ensures that the specified date or item is visible within the control, scrolling the contents of the control if necessary.

ExpandResourceRow

Overloaded. Expands the row associated with the specified resource.

GetContactAt

Overloaded. Gets the Contact object whose schedule is displayed at a specified coordinates.

GetContentBounds

Gets the calendar's cell content bounds.

GetDateAt

Overloaded. Returns the date of the calendar cell located at the specified coordinates.

GetElementBounds

Gets the bounding rectangle of a particular calendar element.

GetExactDateAt

Overloaded. Returns the date located at a specified position.

GetFirstDate

Gets the first date of the time range displayed in the calendar.

GetFirstVisibleDate

Determines which is the first visible date in the current view.

GetFirstVisibleResource

Determines which is the first visible resource in the current view.

GetGraphics

For internal use.

GetItemAt

Overloaded. Gets the scheduled Item object displayed at a specified coordinates.

GetItemBounds

Retrieves the bounding rectangle of the specified item.

GetItemListLane

Gets the index of the lane of the specified item within a List view whose FreeDrag property is enabled.

GetLastDate

Gets the last date of the time range displayed in the calendar.

GetLastVisibleDate

Determines which is the last visible date in the current view.

GetLastVisibleResource

Determines which is the last visible resource in the current view.

GetListLaneAt

Retrieves the index of the List view lane at the specified point, expressed in client coordinates.

GetLocationAt

Overloaded. Gets the Location object whose schedule is displayed at a specified coordinates.

GetResourceAt

Overloaded. Gets the Resource object whose schedule is displayed at a specified coordinates.

GetTaskAt

Overloaded. Gets the Task object whose schedule is displayed at a specified coordinates.

GetVisibleItems

Retrieves a collection with all currently visible items.

HandleLongPress

Invoked to handle long press interactions.

HandleTouchDown

Invoked to handle touch down interactions.

HandleTouchMove

Invoked to handle touch move interactions.

HandleTouchUp

Invoked to handle touch up interactions.

Invalidate

Overloaded. Repaints the control.

IsResourceRowExpanded

Overloaded. Checks whether the row associated with the specified resource in a Resource view is expanded.

LoadFrom

Loads schedule data from the specified file.

LoadViewSettings

Loads the view settings under the specified name from the specified XML document.

Paint

Draws the calendar to the specified graphics.

ResetDrag

If there is a drag operation in progress, it is canceled.

ResetItemViewState

Resets the view-related item data contained in the underlying schedule. For example, items moved around in a list view with enabled FreeDrag property have their relative positions within the view reset.

ResumeDrag

Resumes the previously paused drag operation.

SaveTo

Saves the underlying schedule to the specified file.

SaveViewSettings

Saves the view settings to the specified XML document under the specified name.

SetItemListLane

Sets the lane index for the specified item within a List view whose FreeDrag property is enabled.

SetTransform

For internal use.

SetViewport

Sets the displayed time interval to the specified range, optionally changing the view resolution. If the interval is outside of the view range, the view range is expanded to include the interval.

SnapInResourceView

Returns a new date representing the the specified date when snapped according to the current Resource View settings.

SuspendDrag

Temporarily pauses the current drag operation.

Update

Forces an update of the control.

UpdateLayout

Updates the position of the calendar's child controls such as buttons and scrollbars.

 Protected Methods

  Name Description

OnBeginItemDrawing

Raises the BeginItemDrawing event.

OnCustomizeText

Raises the CustomizeText event.

OnDateClick

Raises the DateClick event.

OnDraw

Raises the Draw event.

OnDrawing

Raises the Drawing event.

OnEndItemDrawing

Raises the EndItemDrawing event.

OnFilterItem

Raises the FilterItem event.

OnItemClick

Raises the ItemClick event.

OnItemCreated

Raises the ItemCreated event.

OnItemCreating

Raises the ItemCreating event.

OnItemDeleted

Raises the ItemDeleted event.

OnItemDeleting

Raises the ItemDeleting event.

OnItemDeselecting

Raises the ItemDeselecting event.

OnItemDrawing

Raises the ItemDrawing event.

OnItemInplaceEdited

Raises the ItemInplaceEdited event.

OnItemInplaceEditEnding

Raises the ItemInplaceEditEnding event.

OnItemInplaceEditStarting

Raises the ItemInplaceEditStarting event.

OnItemListLaneChanged

Raises the ItemListLaneChanged event.

OnItemModificationCanceled

Raises the ItemModificationCanceled event.

OnItemModified

Raises the ItemModified event.

OnItemModifying

Raises the ItemModifying event.

OnItemSelecting

Raises the ItemSelecting event.

OnItemSelectionChanged

Raises the ItemSelectionChanged event.

OnItemSelectionComplete

Raises the ItemSelectionComplete event.

OnItemsModified

Raises the ItemsModified event.

OnListViewHeaderClick

Raises the ListViewHeaderClick event.

OnMenuCreated

Raises the MenuCreated event.

OnMonthCellClick

Raises the MonthCellClick event.

OnMonthHeaderClick

Raises the MonthHeaderClick event.

OnMonthWeekHeaderClick

Raises the MonthWeekHeaderClick event.

OnRecurringItemDeleting

Raises the RecurringItemDeleting event.

OnRepaint

Raises the Repaint event.

OnResourceViewBottomTimelineClick

Raises the ResourceViewBottomTimelineClick event.

OnResourceViewMiddleTimelineClick

Raises the ResourceViewMiddleTimelineClick event.

OnResourceViewRowHeaderClick

Raises the ResourceViewRowHeaderClick event.

OnResourceViewTopTimelineClick

Raises the ResourceViewTopTimelineClick event.

OnScroll

Raises the Scroll event.

OnSizeAllocated

AbsoluteLayout.OnSizeAllocated override.

OnTimetableColumnHeaderClick

Raises the TimetableColumnHeaderClick event.

OnVisibleDateChanged

Raises the VisibleDateChanged event.

 Public Events

  Name Description

BeginItemDrawing

Raised before the items are drawn in the current drawing pass.

CustomizeText

Raised to allow text customization of various calendar elements.

DateClick

Raised when the user clicks a date cell in the calendar.

Draw

Raised to allow custom drawing of calendar UI elements.

Drawing

Raised to allow custom drawing of calendar elements before the default rendering done by the control.

EndItemDrawing

Raised after the items are drawn in the current drawing pass.

FilterItem

Raised to allow filtering specific items from the view.

ItemClick

Raised when the user clicks a schedule item.

ItemCreated

Raised when a schedule item is created by the user.

ItemCreating

Raised when the user is about to create a new schedule item.

ItemDeleted

Raised when the user deletes a schedule item.

ItemDeleting

Raised when the user is about to delete a schedule item.

ItemDeselecting

Raised when an item is about to be deselected.

ItemDrawing

Raised to allow custom drawing of calendar items before the default rendering done by the control.

ItemInplaceEdited

Raised when item's text is in-place edited.

ItemInplaceEditEnding

Raised when in-place editing of item's text is about to be accepted.

ItemInplaceEditStarting

Raised when in-place editing of item's text is about to begin.

ItemListLaneChanged

Raised when the lane index of an item within a List view has changed.

ItemModificationCanceled

Raised when an item modification is canceled by the user.

ItemModified

Raised when a schedule item is moved or resized by the user.

ItemModifying

Raised when the user moves or resizes a schedule item, which would change the item's scheduled start or end date and time.

ItemSelecting

Raised when an item is about to be selected.

ItemSelectionChanged

Raised when an item is selected or deselected.

ItemSelectionComplete

Raised when an item is selected or deselected.

ItemsModified

Raised when one or more items have been modified interactively.

ListViewHeaderClick

Raised when the header of a List view is clicked.

MenuCreated

Raised when the context menu for an item is displayed.

MonthCellClick

Raised when the user clicks on a month cell in a Month view.

MonthHeaderClick

Raised when the header of a Month view is clicked.

MonthWeekHeaderClick

Raised when a cell in the week header of a Month view is clicked.

RecurringItemDeleting

Raised when the user is about to delete a recurring item.

Repaint

Raised when the calendar should be repainted.

ResourceViewBottomTimelineClick

Raised when the bottom timeline of a Resource view is clicked.

ResourceViewMiddleTimelineClick

Raised when the middle timeline of a Resource view is clicked.

ResourceViewRowHeaderClick

Raised when the header of a Resource view row is clicked.

ResourceViewTopTimelineClick

Raised when the top timeline of a Resource view is clicked.

Scroll

Raised when the value of a scrollbar has changed.

TimetableColumnHeaderClick

Raised when the header of a Timetable column is clicked.

VisibleDateChanged

Raised when the user selects another date using the month or year navigation controls on the calendar header area.

 See Also