ASP.NET Pack Programmer's Guide
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 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

 Initializes a new instance of the Calendar class.

 Public Properties

  Name Description

AllowInplaceEdit

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

AutoPostBack

Gets or sets a value specifying whether the calendar should automatically post back to the server each time an appointment is created, modified or deleted.

BackColor

Gets or sets the background color of this control.

BorderColor

Gets or sets the border color of this control.

BorderStyle

Gets or sets the border style of this control.

BorderWidth

Gets or sets the border width of this control.

CalendarLoadScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar is loaded

ClickScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar is clicked.

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.

CssClass

Gets or sets the name of the CSS class applied to the control.

Culture

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

CurrentView

Gets or sets the type of the calendar view.

Date

Gets or sets the date currently displayed in the calendar.

DateClickScript

Gets or sets the name of a JavaScript function that should be invoked when a click event is raised from a calendar date cell.

DateDoubleClickScript

Gets or sets the name of a JavaScript function that should be invoked when a doubleclick event is raised from a calendar date cell.

DateHeaderClickScript

Gets or sets the name of a JavaScript function that should be invoked when a click event is raised from a calendar date cell header.

DateMouseDownScript

Gets or sets the name of a JavaScript function that should be invoked when a mousedown event is raised from a calendar date cell.

DateMouseUpScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseup event is raised from a calendar date cell.

DateTimeFormat

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

DoubleClickScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar is double-clicked.

EnableScheduleContactsState

Gets or sets whether Contacts are written in the current ViewState.

EnableScheduleItemsState

Gets or sets whether Items are written in the current ViewState.

EnableScheduleLocationsState

Gets or sets whether Locations are written in the current ViewState.

EnableScheduleResourcesState

Gets or sets whether Resources are written in the current ViewState.

EnableScheduleTasksState

Gets or sets whether Tasks are written in the current ViewState.

EnableViewSettingsState

Gets or sets whether ViewSettings are written in the current ViewState.

EndDate

Gets or sets the last date displayed in the calendar.

FirstWeekendDay

Gets or sets the first weekend day in the calendar.

Font

Gets the font associated with this control.

ForeColor

Gets or sets the foreground color (typically the color of the text) of this control.

FormShowScript

Gets or sets the name of a JavaScript function that should be invoked when a built-in form is about to be shown.

GroupType

Gets or sets the grouping criteria for the Timetable view.

Height

WebControl.Height override.

ItemChangeResourceKey

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

ItemClickScript

Gets or sets the name of a JavaScript function that should be invoked when a click event is raised from an item.

ItemCloneKey

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

ItemCreatedScript

Gets or sets the name of a JavaScript function that should be invoked while an item has been created.

ItemCreatingScript

Gets or sets the name of a JavaScript function that should be invoked while an item is being created.

ItemDeletedScript

Gets or sets the name of a JavaScript function that should be invoked when an item is deleted.

ItemDeletingScript

Gets or sets the name of a JavaScript function that should be invoked when an item is about to be deleted.

ItemDoubleClickScript

Gets or sets the name of a JavaScript function that should be invoked when a doubleclick event is raised from an item.

ItemDragEndScript

Gets or sets the name of a JavaScript function that should be invoked when a drag operation on an item is finished.

ItemDragStartScript

Gets or sets the name of a JavaScript function that should be invoked when a drag operation on an item is started.

ItemInplaceEditEndingScript

Gets or sets the name of a JavaScript function that should be invoked when inplace editing of item's text is about to be accepted.

ItemInplaceEditStartingScript

Gets or sets the name of a JavaScript function that should be invoked when inplace editing of item's text is about to begin.

ItemModifiedScript

Gets or sets the name of a JavaScript function that should be invoked when an item is modified.

ItemModifyingScript

Gets or sets the name of a JavaScript function that should be invoked while an item is about to be modified.

ItemMouseDownScript

Gets or sets the name of a JavaScript function that should be invoked when a mousedown event is raised from an item.

ItemMouseEnterScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseover event is raised from an item.

ItemMouseLeaveScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseout event is raised from an item.

ItemMouseMoveScript

Gets or sets the name of a JavaScript function that should be invoked when a mousemove event is raised from an item.

ItemMouseUpScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseup event is raised from an item.

ItemReminderTriggeredScript

Gets or sets the name of a JavaScript function that should be invoked when an item reminder is triggered.

ItemResizeEndScript

Gets or sets the name of a JavaScript function that should be invoked when a resize operation on an item is finished.

ItemResizeStartScript

Gets or sets the name of a JavaScript function that should be invoked when a resize operation on an item is started.

ItemSelection

Gets an ItemSelection object representing the current selection of items in the calendar.

ItemSelectionChangedScript

Gets or sets the name of a JavaScript function that should be invoked when the items selection changes.

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.

LicenseKey

Gets or sets the license key of the control.

ListViewHeaderClickScript

Gets or sets the name of a JavaScript function that should be invoked when the header in the ListView is clicked.

ListViewSettings

Gets the ListViewSettings object used to customize the appearance 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.

MonthHeaderClickScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar's header is clicked.

MonthRangeHeaderClickScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar's header is clicked.

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 appearance of a month range in the SingleMonth view.

MoreItemsCueMouseDownScript

Gets or sets the name of a JavaScript function that should be invoked when a mousedown event is raised from the items cue.

MoreItemsCueMouseUpScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseup event is raised from the items cue.

MouseEnterScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseover event is raised from the calendar.

MouseLeaveScript

Gets or sets the name of a JavaScript function that should be invoked when a mouseout event is raised from the calendar.

MouseMoveScript

Gets or sets the name of a JavaScript function that should be invoked when a mousemove event is raised from the calendar.

RecurrenceStringValidationScript

Gets or sets the name of a JavaScript function that should be invoked after the recurrence information text in a popup form has changed.

RecurringItemDeletingScript

Gets or sets the name of a JavaScript function that should be invoked when a recurring item is being deleted.

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 appearance of the Resource view.

Schedule

Gets or sets the schedule to be displayed inside the calendar control.

Selection

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

SelectionChangedScript

Gets or sets the name of a JavaScript function that should be invoked when the calendar date selection changes.

SelectionEndScript

Gets or sets the name of a JavaScript function that should be invoked when cells' selection has ended.

SelectionStartScript

Gets or sets the name of a JavaScript function that should be invoked when cells' selection has started.

ShowToolTips

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

TaskReminderTriggeredScript

Gets or sets the name of a JavaScript function that should be invoked when a task reminder is triggered.

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.

TimetableColumnHeaderClickScript

Gets or sets the name of a JavaScript function that is invoked when a column header is clicked in the Timetable view.

TimetableSettings

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

UseForms

Gets or sets a value indicating whether the control should use the built-in forms.

WeekRangeHeaderClickScript

Gets or sets the name of a JavaScript function that is invoked when the view header is clicked in the WeekRange view.

WeekRangeSettings

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

Width

WebControl.Width override.

 Protected Properties

  Name Description

SecondWeekendDay

Gets the second day of the weekend.

TagKey

WebControl.TagKey override. Gets the HtmlTextWriterTag value that corresponds to this Calendar control.

 Public Methods

  Name Description

LoadPostData

When implemented by a derived class, processes postback data for the Calendar server control.

OnContactSerialization

Raises the ContactSerialization event.

OnCultureChanged

Raises the CultureChanged event.

OnItemCreated

Raises the ItemCreated event.

OnItemDeleted

Raises the ItemDeleted event.

OnItemInplaceEdited

Raises the ItemInplaceEdited event.

OnItemModified

Raises the ItemModified event.

OnItemSerialization

Raises the ItemSerialization event.

OnLocationSerialization

Raises the LocationSerialization event.

OnRecurrenceSerialization

Raises the RecurrenceSerialization event.

OnReminderSerialization

Raises the ReminderSerialization event.

OnResourceSerialization

Raises the ResourceSerialization event.

OnTaskSerialization

Raises the TaskSerialization event.

OnThemeChanged

Raises the ThemeChanged event.

OnVisibleDateChanged

Raises the VisibleDateChanged event.

RaisePostBackEvent

When implemented by a derived class, enables a server control to process an event raised when a form is posted to the server.

RaisePostDataChangedEvent

When implemented by a derived class in the server control notifies the ASP.NET application that the state of the control has changed.

 Protected Methods

  Name Description

AddAttributesToRender

WebControl.AddAttributesToRender override. Adds HTML attributes and styles that need to be rendered by the specified HtmlTextWriter.

LoadViewState

Control.LoadViewState override. Restores view-state information from a previous page request that was saved by the SaveViewState method.

OnPreRender

Control.OnPreRender override.

Render

Control.Render override.

RenderContents

WebControl.RenderContents override. Renders the contents of the control to the specified writer.

SaveViewState

Control.SaveViewState override. Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

TrackViewState

Control.TrackViewState override. Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object.

 Public Events

  Name Description

ContactSerialization

Represents the method that will handle the ContactSerialization event.

CultureChanged

Raised when the calendar Culture has changed.

ItemCreated

Raised when a schedule item is created.

ItemDeleted

Raised when a schedule item is deleted.

ItemInplaceEdited

Raised when a schedule item's text is inplace-edited.

ItemModified

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

ItemSerialization

Raised when an item is about to be serialized.

LocationSerialization

Raised when a Location is about to be serialized.

RecurrenceSerialization

Raised when a Recurrence is about to be serialized.

ReminderSerialization

Raised when a Reminder is about to be serialized.

ResourceSerialization

Raised when a Resource is about to be serialized.

TaskSerialization

Raised when a Task is about to be serialized.

ThemeChanged

Raised when the calendar theme has changed.

VisibleDateChanged

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

 See Also

Calendar Class
MindFusion.Scheduling.WebForms Namespace