OBOUT - ASP.NET Calendar - Documentation

ASP.NET Calendar - Documentation - Server side

Properties: appearance settings, settings, date picker mode only, advanced properties, CSS properties, Advanced CSS properties; Methods;

<%@ Register TagPrefix="obout" Namespace="OboutInc.Calendar2" Assembly="obout_Calendar2_Net" %>

Properties - Appearance settings

Name	Description
MonthWidth	Width of each month in pixels. Default is 250. Optional
MonthHeight	Height of each month in pixels. Default is 170. Optional
MonthMarginWidth	Width of the margin between months. Default is 10. Optional
Columns	Number of columns in the calendar. Default is 2. Optional
Rows	Number of rows in the calendar. Default is 1. Optional
TitleText	The text that will be shown in the title of the calendar between left and right arrows. Default value is today's date. Optional
ShowYearSelector	Displays a drop-down list or a html list of years. It depends on the value of the property YearSelectorType. By default, it takes ±10 years from current year. If DateMin and DateMax are defined, then the range is taken from those values. If only one of these properties is defined, then that value is used and the second is ±10 years from current year. Default is false. Optional
YearSelectorType	Specifies the year selector type. Available values are HtmlList and DropDownList. Default is HtmlList.Optional
ShowMonthSelector	Displays a drop-down list or a html list of months. It depends on the value of the property MonthSelectorType. Default is false.Optional
MonthSelectorType	Specifies the month selector type. Available values are HtmlList and DropDownList. Default is HtmlList.Optional
ShowTimeSelector	Displays a drop-down list or a html list for hours, for minutes and for seconds. It depends on the value of the property TimeSelectorType. Default is false.Optional
TimeSelectorType	Specifies the time selector type. Available values are HtmlList and DropDownList. Default is HtmlList.Optional
ShowHourSelector	If false, then the hour selector if not visible. Default is true.Optional
ShowMinuteSelector	If false, then the minute selector if not visible. Default is true.Optional
ShowSecondSelector	If false, then the second selector if not visible. Default is true.Optional
TextArrowLeft	Any text or HTML for left arrow. Default value: <<. Optional
TextArrowRight	Any text or HTML for right arrow. Default value: >>. Optional
ShowOtherMonthDays	If true, then dates for previous and next months are shown in the main month. Default is true. Optional
TextSelectTime	Select time text. Default is Set. Optional

Properties - settings

Name	Description
Speed	Scrolling speed. Default value: 25. Optional
ScrollBy	Number of columns to scroll by. If this value is more than number of columns defined in Columns, then calendar scrolls by blocks of months. For example, if calendar has Columns=2, Rows=2 and ScrollBy=4,then view of January-April would change to May-August. Optional
DateToday	A DateTime value representing today's date. Optional Default value is today's date on the server.
DateFirstMonth	A DateTime value representing the first month to show in the calendar. If not defined, then the value from DateToday is used. Optional
DateMin	Minimum date allowed. Any date lower than this is disabled. Optional
DateMax	Maximum date allowed. Any date greater than this is disabled. Optional
YearMinScroll	Minimum year visible without using the scroll. Any year lower than this is visible when scrolling, inside DateMin, DateMax range. Optional
YearMaxScroll	Maximum year visible without using the scroll. Any year bigger than this is visible when scrolling, inside DateMin, DateMax range. Optional
SelectedDate	Changes when new date is selected and postback occured. You can also set it to any DateTime value initially.
SelectedDates	Changes when dates are selected and postback occured. You can also set it to a list of DateTime values initially. To allow multiple dates selection set MultiSelectedDates to true.
MultiSelectedDates	When true, multiple dates can be selected. Default value: false. Optional
AllowDeselect	When true, selected date can be deselected. Default value: true. Optional
AllowSelectSpecial	When true, special dates can be selected. Default value: true. Optional
AllowSelectRegular	Specifies whether regular dates can be selected. Default value: true. Optional
OnClientDateChanged	A client-side function name to call when a date is selected. The function is called with the selected date as the only parameter. Optional
OnClientDateMouseOver	A client-side function name to call on date mouse over event. The function is called with the calendar and date as parameters. Optional
OnClientDateMouseOut	A client-side function name to call on date mouse out event. The function is called with the calendar and date as parameters. Optional
OnClientMonthScrollLeft	A client-side function name to call on left month scrolling. The function is called with the calendar as parameter. Optional
OnSwitchView	A client-side function name to call on calendar switching view. The function is called with the calendar as parameter. Optional
OnClientMonthScrollRight	A client-side function name to call on right month scrolling. The function is called with the calendar as parameter. Optional
AutoPostBack	When true, calendar will automatically post back to the server when date is selected. Default value: false. Optional
EnabledDateExpression	A boolean expression that enables or disables certain dates. Optional Check the EnabledDateExpression tutorial
SpecialDates	A collection containing all special dates.
YearSelectorScrollSpeed	Specifies the scolling speed of the year selector. Default value: 100 (milliseconds). Optional
FirstYearSelectorScrollSpeed	Specifies the amount of time till the year selector is starting to scroll. Default value: 0 (milliseconds). Optional
HourSelectorScrollSpeed	Specifies the scolling speed of the hour selector. Default value: 100 (milliseconds). Optional
FirstHourSelectorScrollSpeed	Specifies the amount of time till the hour selector is starting to scroll. Default value: 0 (milliseconds). Optional
MinuteSelectorScrollSpeed	Specifies the scolling speed of the minute selector. Default value: 100 (milliseconds). Optional
FirstMinuteSelectorScrollSpeed	Specifies the amount of time till the minute selector is starting to scroll. Default value: 0 (milliseconds). Optional
SecondSelectorScrollSpeed	Specifies the scolling speed of the second selector. Default value: 100 (milliseconds). Optional
FirstSecondSelectorScrollSpeed	Specifies the amount of time till the second selector is starting to scroll. Default value: 0 (milliseconds). Optional

Properties - date picker mode only

Name	Description
DatePickerMode	A true/false value. When true, calendar is in date picker mode. Default value: false.
TextBoxId	ID of a textbox where to show the selected date.
DatePickerImagePath	Path to the image to be used as date picker button. Optional Example: "/calendar/styles/icon2.gif"
DatePickerImageTooltip	Tooltip text for the image of a date picker button. Default value is Select date.Optional
CSSDatePickerButton	CSS class name for the date picker button. Optional
Enabled	Specify whether calendar should be enabled or not. Default value: true. Optional
Align	Specify the position where calendar is displayed when in date picker mode. Available values are Cursor, Left, Right, Above, Under. Default value: Cursor. Optional Check the Date picker align tutorial
BeginDateCalendarId	The ID of another calendar to be used as a starting date. When you want to select a range of dates (airline tickets, for example) you can create the first calendar, then in the second one you specify BeginDateCalendarId with ID of the first. The calendars will work together then. Optional Check the Date Range tutorial
DatePickerSynchronize	If true, calendar is synchronized with the textbox modifications. Default is false. Optional
OffsetLeft	The horizontal offset of the calendar from the date picker button, in pixels. Default is 0. Optional
OffsetTop	The vertical offset of the calendar from the date picker button, in pixels. Default is 0. Optional

CSS Properties

Name	Description
StyleFolder	Path to the folder with style to use. Optional

Advanced CSS Properties

Name	Description
CSSPath	Path to the css file. Optional
CSSCalendar	CSS class for the whole calendar. It is the DIV that holds everything.
CSSTitle	CSS class for the title, without the arrows.
CSSArrowLeft	CSS class for the left arrow.
CSSArrowRight	CSS class for the right arrow.
CSSMonth	CSS class for each month.
CSSMonthTitle	CSS class for each month title. It is the part where the current month and current year are shown.
CSSDayName	CSS class for each day name (Mon, Tue, etc.)
CSSDay	CSS class for each day in a month.
CSSDayOver	CSS class for each day in a month when the mouse is over.
CSSDayToday	CSS class for today's date.
CSSDayTodayOver	CSS class for today's date when the mouse is over.
CSSDayDisabled	CSS class for a disabled date.
CSSDayDisabledOver	CSS class for a disabled date when the mouse is over.
CSSDaySelected	CSS class for a selected date.
CSSDaySelectedOver	CSS class for a selected date when the mouse is over.
CSSDaySpecial	CSS class for a special date. Each special date can have its own css class, but if none were specified, then this value is used.
CSSDaySpecialOver	CSS class for a special date when the mouse is over. Each special date can have its own css class, but if none were specified, then this value is used.
CSSYearSelectorTitle	CSS class for the year selector's title.
CSSYearSelectorContainer	CSS class for the year selector's container.
CSSYearSelectorArrowUp	CSS class for the year selector's arrow up.
CSSYearSelectorArrowDown	CSS class for the year selector's arrow down.
CSSYearSelector	CSS class for the year container from the year selector list.
CSSYearSelected	CSS class for the selected year container from the year selector list.
CSSMonthSelectorTitle	CSS class for the month selector's title.
CSSMonthSelectorContainer	CSS class for the month selector's container.
CSSMonthSelectorArrowUp	CSS class for the month selector's arrow up.
CSSMonthSelectorArrowDown	CSS class for the month selector's arrow down.
CSSMonthSelector	CSS class for the month container from the month selector list.
CSSMonthSelected	CSS class for the selected month container from the month selector list.
CSSSelectTime	CSS class for selecting time button.
CSSHourSelectorTitle	CSS class for the hour selector's title.
CSSHourSelectorContainer	CSS class for the hour selector's container.
CSSHourSelectorArrowUp	CSS class for the hour selector's arrow up.
CSSHourSelectorArrowDown	CSS class for the hour selector's arrow down.
CSSHourSelector	CSS class for the hour container from the hour selector list.
CSSHourSelected	CSS class for the selected hour container from the hour selector list.
CSSMinuteSelectorTitle	CSS class for the minute selector's title.
CSSMinuteSelectorContainer	CSS class for the minute selector's container.
CSSMinuteSelectorArrowUp	CSS class for the minute selector's arrow up.
CSSMinuteSelectorArrowDown	CSS class for the minute selector's arrow down.
CSSMinuteSelector	CSS class for the minute container from the minute selector list.
CSSMinuteSelected	CSS class for the selected minute container from the minute selector list.
CSSSecondSelectorTitle	CSS class for the second selector's title.
CSSSecondSelectorContainer	CSS class for the second selector's container.
CSSSecondSelectorArrowUp	CSS class for the second selector's arrow up.
CSSSecondSelectorArrowDown	CSS class for the second selector's arrow down.
CSSSecondSelector	CSS class for the second container from the second selector list.
CSSSecondSelected	CSS class for the selected second container from the second selector list.

Advanced properties

Name	Description
CultureName	Sets the culture name that will be used. Default is "en-US". Optional
FullMonthNames	A comma-delimeted string of full month names. By default, these are taken from the defined culture, but you can set your own: "January,February,March,...". Optional
ShortMonthNames	A comma-delimeted string of short month names. By default, these are taken from the defined culture, but you can set your own: "Jan,Feb,Mar,...". Optional
FullDayNames	A comma-delimeted string of full day names. By default, these are taken from the defined culture, but you can set your own: "Monday,Tuesday,Wednesday,...". Optional
ShortDayNames	A comma-delimeted string of short day names. By default, these are taken from the defined culture, but you can set your own: "Mo,Tu,We,...". Optional
FirstDayOfWeek	An integer value representing the first day of week. By default this is taken from the culture, but you can set your own. 0=Sunday Optional
DateFormat	Takes a formatting string. By default this is taken from the culture, but you can define your own. Optional Check the DateFormat tutorial
YearMonthFormat	Month and year format for every month title.
ShowErrorAlert	If true, the alert message in case of some error is visible. Default value is true.
DisableEmbeddedScriptFileResource	If true, the script file resource is disabled. Default value is false.

Methods

Name	Description
AddSpecialDate	Adds a new special date. Overloaded methods: AddSpecialDate(DateTime Date) AddSpecialDate(DateTime Date, string ToolTip) AddSpecialDate(DateTime Date, string ToolTip, string CSSClass) AddSpecialDate(DateTime Date, string ToolTip, string CSSClass, string Url) AddSpecialDate(DateTime Date, string ToolTip, string CSSClass, string CSSClassOver, string Url) AddSpecialDate(int Year, int Month, int Day) AddSpecialDate(int Year, int Month, int Day, string Tooltip) AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass) AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass, string Url) AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass, string CSSClassOver, string Url) Date - a DateTime object Year - year of this special date. Month - month of this special date. Day - day of this special date. Tooltip - tooltip to display on mouse over. CssClass - css class for the special date. CssClassOver - css class for the special date when the mouse is over. Url - URL to open when clicked on special date.
RemoveSpecialDate	Removes a special date. Overloaded methods: RemoveSpecialDate(int index) RemoveSpecialDate(DateTime data) RemoveSpecialDate(int Year, int Month, int Day) RemoveAllSpecialDates() index - special date index from the collection Date - a DateTime object Year - year of this special date. Month - month of this special date. Day - day of this special date.

Name

Description

AddSpecialDate

Adds a new special date.

Overloaded methods:

AddSpecialDate(DateTime Date)
AddSpecialDate(DateTime Date, string ToolTip)
AddSpecialDate(DateTime Date, string ToolTip, string CSSClass)
AddSpecialDate(DateTime Date, string ToolTip, string CSSClass, string Url)
AddSpecialDate(DateTime Date, string ToolTip, string CSSClass, string CSSClassOver, string Url)
AddSpecialDate(int Year, int Month, int Day)
AddSpecialDate(int Year, int Month, int Day, string Tooltip)
AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass)
AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass, string Url)
AddSpecialDate(int Year, int Month, int Day, string Tooltip, string CSSClass, string CSSClassOver, string Url)