MindFusion WinForms Programmer's Guide
Calendar Members
Constructors Fields 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 SingleMonth, 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 Fields

  Name Description

AttachRowUpdated

Invoked during data-binding to attach an event handler to a DataAdapter, which is not one of the common data adapters - OleDb or Sql.

 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.

AllowDrag

Gets or sets a value indicating whether the user can initiate a drag operation within the control.

AllowInplaceCreate

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

AllowInplaceEdit

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

ButtonOffset

Gets or set the offset of the buttons, displayed in the MonthRange and SingleMonth views' headers.

ButtonSize

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

ColumnResizeCursorH

Gets or set the cursor that is displayed when a column can be resized or is being resized in a horizontal Timetable view.

ColumnResizeCursorV

Gets or set the cursor that is displayed when a column can be resized or is being resized in a vertical Timetable view.

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.

ContactsDataMember

Gets or sets the name of the data member from the associated data source to bind the contacts to.

ContactsDataPropertyMap

Gets or sets a BoundPropertyList object that maps contact properties to fields in the associated data member.

ControlAppearance

Gets or sets the visual style of the calendar child controls.

ControlStyle

Gets a ControlStyle object that allows customizing the visualization of the calendar child controls.

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.

Cursor

Gets or sets the cursor that is displayed when the mouse pointer is over the calendar.

CustomBrushesDataMember

Gets or sets the name of the data member from the associated data source to bind the custom brushes to.

CustomBrushesDataPropertyMap

Gets or sets a BoundPropertyList object that maps custom brush properties to fields in the associated data member.

CustomDraw

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

CustomGroupType

Gets or sets a runtime type of the resources to group by.

CustomSecondaryGroupType

Gets or sets a runtime type of the secondary resources to group by.

CustomTheme

Gets or sets the custom theme applied to the control.

DataSource

Gets or sets the data source associated with 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.

DelayInplaceEdit

Gets or sets a value indicating whether the in-place editing of an item is delayed for a second when the item is clicked.

DragItemsOnDisabledAreas

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

EnableDragCreate

Gets or sets a value indicating whether items are created merely by dragging in the control.

EnableKeyboard

Gets or sets a value indicating whether the selection can be manipulated through the keyboard.

EnableOptimization

Gets or sets a value indicating whether the control should try to optimize item rendering.

EndDate

Gets or sets the last date displayed in the calendar.

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, WeekRange, List and Resource views.

HiddenItemsCursor

Gets or sets the cursor that is displayed when the mouse pointer is over the hidden items cue icon.

HScrollerSmallChange

Gets or sets the small step for the horizontal scroll bar.

HScrollerVisible

Gets or sets a value indicating whether the horizontal scroller should always be visible, always hidden or visible only when it is needed.

HScrollPos

Gets or sets the current horizontal scroll position.

ImageList

Gets or sets the image list associated with the calendar.

InteractiveItemType

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

ItemChangeResourceKey

Gets or sets the modifier key, which lets users drag items between different contacts, resources, locations or tasks in a grouped view.

ItemCloneKey

Gets or sets the modifier key, which when pressed allows users to interactively clone items.

ItemDragCursor

Gets or sets the cursor that is displayed when an item is being dragged.

ItemDragKey

Gets or sets the modifier key that lets users start an OLE drag-and-drop operation when they drag an item.

ItemEffects

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

ItemHResizeCursor

Gets or sets the cursor that is displayed when the mouse pointer is over the horizontal resize area of an item.

ItemModificationStyle

Gets or sets a value indicating the way items are processed when modified interactively.

ItemMoveCursor

Gets or sets the cursor that is displayed when the mouse pointer is over the move area of an item.

ItemNoDragCursor

Gets or sets the cursor that is displayed when an item is dragged over a location that cannot contain items.

ItemScroll

Gets or sets the current scroll position in a List view whose EnableVirtualItemSpace property is set to Enabled.

ItemsDataMember

Gets or sets the name of the data member from the associated data source to bind the schedule items to.

ItemsDataPropertyMap

Gets or sets a BoundPropertyList object that maps item properties to fields in the associated data member.

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.

ItemTooltipFormat

Gets or sets the format of item tooltips.

ItemVResizeCursor

Gets or sets the cursor that is displayed when the mouse pointer is over the vertical resize area of an item.

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.

LocationsDataMember

Gets or sets the name of the data member from the associated data source to bind the locations to.

LocationsDataPropertyMap

Gets or sets a BoundPropertyList object that maps location properties to fields in the associated data member.

MinItemLength

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

MonthRangeSettings

Gets the MonthRangeSettings object used to customize the visualization of a month range in the MonthRange view.

MonthSettings

Gets the MonthSettings object used to customize the visualization of months in the MonthRange and SingleMonth views.

MonthStyles

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

PrintOptions

Gets a PrintOptions object that allows customizing various aspects of printing.

RecurrenceExceptionsDataMember

Gets or sets the name of the data member from the associated data source to bind the recurrence exceptions to.

RecurrenceExceptionsDataPropertyMap

Gets or sets a BoundPropertyList object that maps recurrence exception properties to fields in the associated data member.

RecurrencesDataMember

Gets or sets the name of the data member from the associated data source to bind the recurrences to.

RecurrencesDataPropertyMap

Gets or sets a BoundPropertyList object that maps recurrence properties to fields in the associated data member.

RemindersDataMember

Gets or sets the name of the data member from the associated data source to bind the reminders to.

RemindersDataPropertyMap

Gets or sets a BoundPropertyList object that maps reminder properties to fields in the associated data member.

RescheduleRecurrenceKey

Gets or sets the modifier key, which when pressed allows users to interactively reschedule recurrent items.

Resources

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

ResourcesDataMember

Gets or sets the name of the data member from the associated data source to bind the resources to.

ResourcesDataPropertyMap

Gets or sets a BoundPropertyList object that maps resource properties to fields in the associated data member.

ResourceViewSettings

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

RowHeaderResizeCursor

Gets or set the cursor that is displayed when a row header can be resized or is being resized in a Resource view.

Schedule

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

ScrollPosition

Gets or sets the current scroll position.

SecondaryGroupType

Gets or sets the secondary grouping criteria for the Resource view.

Selection

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

ShowToolTips

Gets or sets a value indicating whether the calendar displays tooltips.

StartEditAfterModify

Gets or sets a value indicating whether in-place editing of items should automatically start after they are modified interactively.

StylesDataMember

Gets or sets the name of the data member from the associated data source to bind the styles to.

StylesDataPropertyMap

Gets or sets a BoundPropertyList object that maps style properties to fields in the associated data member.

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.

TasksDataMember

Gets or sets the name of the data member from the associated data source to bind the schedule tasks to.

TasksDataPropertyMap

Gets or sets a BoundPropertyList object that maps task properties to fields in the associated data member.

TextRendering

Gets or sets the text rendering mode.

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.

ToolTip

Gets the underlying ToolTip component.

VScrollerSmallChange

Gets or sets the small step for the vertical scroll bar.

VScrollerVisible

Gets or sets a value indicating whether the vertical scroller should always be visible, always hidden or visible only when it is needed.

VScrollPos

Gets or sets the current vertical scroll position.

WeekRangeSettings

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

 Protected Properties

  Name Description

DefaultSize

Gets the default size of the control.

 Public Methods

  Name Description

ApplyTheme

Overloaded. Applies a Theme to the calendar.

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.

BeginPrint

Initiates a print or print preview for the specified document. The document can be subsequently selected for preview in a PrintPreviewControl or printed by calling its Print method. Call Calendar.EndPrint after the document is no longer used.

CancelModify

Cancels an interactive modification of an item, previously started by a call to StartModify.

CollapseResourceRow

Overloaded. Collapses a row in a Resource view.

CompactItemLanes

Overloaded.  

CompleteModify

Completes an interactive modification of an item, previously started by a call to StartModify.

CreateImage

Overloaded. Creates a bitmap image of the current calendar view.

EndInit

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

EndPrint

Finalizes a print or print preview for the specified document. Call after Calendar.BeginPrint when the document is no longer used.

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 a row in a Resource view.

GetContactAt

Overloaded. Gets the Contact object whose schedule is displayed at the specified coordinates. This method can be only be used in views that support grouping.

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.

GetItemAt

Overloaded. Gets the scheduled Item object displayed at the 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 the specified coordinates. This method can be only be used in views that support grouping.

GetResourceAt

Overloaded. Gets the Resource object whose schedule is displayed at the specified coordinates. This method can be only be used in views that support grouping.

GetResourcesAt

Gets the Resource objects associated with the cells at the specified coordinates.

GetSortedItems

Returns all items from the specified range, sorted by their lanes.

GetTaskAt

Overloaded. Gets the Task object whose schedule is displayed at the specified coordinates. This method can be only be used in views that support grouping.

GetVisibleItems

Retrieves a collection with all currently visible items.

IsResourceRowExpanded

Overloaded. Checks whether a row in a Resource view is expanded.

LoadFrom

Loads schedule data from the specified file.

LoadFromDataSource

Overloaded. Loads the schedule data from the underlying data source.

LoadFromJson

Loads schedule and view state data from a JSON-formatted string.

LoadViewSettings

Overloaded. Loads the view settings from the specified stream or XML document.

Print

Overloaded. Prints the current calendar view.

PrintPreview

Overloaded. Displays a print preview window for the current calendar view.

ResetDrag

If there is a mouse 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 mouse drag operation.

SaveTo

Saves the underlying schedule to the specified file.

SaveToDataSource

Overloaded. Saves the current schedule to the underlying data source.

SaveToJson

Saves the underlying schedule and current view state to a JSON-formatted string.

SaveViewSettings

Overloaded. Saves the view settings to the specified stream or XML document.

SetItemListLane

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

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.

StartInplaceEdit

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

StartModify

Initiates interactive modification on the specified item.

SuspendDrag

Temporarily pauses the current mouse drag operation.

UpdateLayout

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

UpdateModify

Updates an interactive modification of an item, previously started by a call to StartModify.

UpdateRow

 

 Protected Methods

  Name Description

Dispose

Cleans up any resources being used.

OnBeginItemDrawing

Raises the BeginItemDrawing event.

OnContinuePrinting

Raises the ContinuePrinting event.

OnCustomizeGrouping

Raises the CustomizeGrouping 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.

OnHiddenItemClick

Raises the HiddenItemClick event.

OnHScroll

Raises the HScroll event.

OnItemClick

Raises the ItemClick event.

OnItemCloned

Raises the ItemCloned event.

OnItemCloning

Raises the ItemCloning event.

OnItemCreated

Raises the ItemCreated event.

OnItemCreating

Raises the ItemCreating event.

OnItemCreationCanceled

Raises the ItemCreationCanceled 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.

OnItemTooltipDisplaying

Raises the ItemTooltipDisplaying event.

OnKeyDown

Control.OnKeyDown override.

OnKeyPress

Control.OnKeyPress override.

OnListViewHeaderClick

Raises the ListViewHeaderClick event.

OnLostFocus

Control.OnLostFocus override.

OnMonthCellClick

Raises the MonthCellClick event.

OnMonthHeaderClick

Raises the MonthHeaderClick event.

OnMonthRangeHeaderClick

Raises the MonthRangeHeaderClick event.

OnMonthWeekHeaderClick

Raises the MonthWeekHeaderClick event.

OnMouseDown

Control.OnMouseDown override.

OnMouseMove

Control.OnMouseMove override.

OnMouseUp

Control.OnMouseUp override.

OnPaint

Control.OnPaint override.

OnPaintBackground

Control.OnPaintBackground override.

OnRecurringItemDeleting

Raises the RecurringItemDeleting event.

OnResize

Control.OnResize override.

OnResourceViewBottomTimelineClick

Raises the ResourceViewBottomTimelineClick event.

OnResourceViewMiddleTimelineClick

Raises the ResourceViewMiddleTimelineClick event.

OnResourceViewRowHeaderClick

Raises the ResourceViewRowHeaderClick event.

OnResourceViewTopTimelineClick

Raises the ResourceViewTopTimelineClick event.

OnRightToLeftChanged

Control.OnRightToLeftChanged override.

OnScroll

Raises the Scroll event.

OnTimetableColumnHeaderClick

Raises the TimetableColumnHeaderClick event.

OnTooltipDisplaying

Raises the TooltipDisplaying event.

OnVisibleDateChanged

Raises the VisibleDateChanged event.

OnVScroll

Raises the VScroll event.

OnWeekRangeHeaderClick

Raises the WeekRangeHeaderClick event.

ProcessDialogKey

Control.ProcessDialogKey override.

 Public Events

  Name Description

BeginItemDrawing

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

ContinuePrinting

Occurs at the end of a printing operation to enable users to continue printing the calendar with different view settings.

CustomizeGrouping

Raised when secondary grouping is enabled to allow the client to filter some of the secondary resources.

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.

HiddenItemClick

Raised when a hidden items cue icon is clicked.

HScroll

Raised when the control has been scrolled horizontally.

ItemClick

Raised when the user clicks a schedule item.

ItemCloned

Raised when the user has cloned an item interactively.

ItemCloning

Raised when the user is about to clone an item interactively.

ItemCreated

Raised when a schedule item is created by the user.

ItemCreating

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

ItemCreationCanceled

Raised when an interactive item creation is canceled by the user.

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.

ItemTooltipDisplaying

Raised to allow modification of an item's ToolTip before it gets displayed.

ListViewHeaderClick

Raised when the header of a List view is clicked.

MonthCellClick

Raised when the user clicks on a month cell in a SingleMonth and MonthRange views.

MonthHeaderClick

Raised when the header of a Month view is clicked.

MonthRangeHeaderClick

Raised when the header of an MonthRange 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.

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.

TooltipDisplaying

Raised to allow modification of the ToolTip of a calendar element before it gets displayed.

VisibleDateChanged

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

VScroll

Raised when the control has been scrolled vertically.

WeekRangeHeaderClick

Raised when the header of a WeekRange view is clicked.

 See Also

Calendar Class
MindFusion.Scheduling.WinForms Namespace