MonthCalendar

Wisej.Web.MonthCalendar

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a control that enables the user to select a date using a visual monthly calendar display.

public class MonthCalendar : Control, IReadOnly

There are 4 tooltip labels that can be localized for this control. They are already localized in the default languages provided by Wisej. An application can localize the tooltip labels by adding the string resources to the localized Resources.resx or /Properties/Resources.resx.

  • $Next year The tooltip text displayed on the popup calendar for the next-year button.

  • $Last year The tooltip text displayed on the popup calendar for the last-year button.

  • $Next month The tooltip text displayed on the popup calendar for the next-month button.

  • $Last month The tooltip text displayed on the popup calendar for the last-month button.

Constructors

Initializes an instance of the MonthCalendar control.

Initializes an instance of the MonthCalendar control with the specified settings.

Initializes an instance of the MonthCalendar control with the specified settings.

Properties

DateTime[]: Returns or sets the array of DateTime objects that determines which annual days are displayed in bold.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)

DateTime[]: Returns or sets the array of DateTime objects that determines which nonrecurring dates are displayed in bold.

BorderStyle: Returns or sets the type of border that is drawn around the MonthCalendar. (Default: Solid)

Size: Returns or sets the number of columns and rows of months displayed.

Day: Returns or sets the first day of the week as displayed in the month calendar. (Default: Default)

DateTime: Returns or sets the maximum allowable date.

Throws:

Int32: Returns or sets the maximum number of days that can be selected in a month calendar control. (Default: 7)

Throws:

DateTime: Returns or sets the minimum allowable date.

Throws:

DateTime[]: Returns or sets the array of DateTime objects that determine which monthly days to bold.

Boolean: Returns or sets whether the control is read-only. (Default: False)

DateTime: Returns or sets the end date of the selected range of dates.

Throws:

SelectionRange: Returns or sets the selected range of dates for a month calendar control.

Throws:

  • ArgumentOutOfRangeException The Start value of the assigned SelectionRange is less than the minimum date allowable for a month calendar control; or the Start value of the assigned SelectionRange is greater than the maximum allowable date for a month calendar control; or the End value of the assigned SelectionRange is less than the minimum date allowable for a month calendar control; or the End value of the assigned SelectionRange is greater than the maximum allowable date for a month calendar control.

DateTime: Returns or sets the start date of the selected range of dates.

Throws:

Boolean: Returns or sets whether the month calendar control displays days from the previous and the next month. (Default: True)

Boolean: Returns or sets whether the date represented by the TodayDate property is displayed at the bottom of the control. (Default: True)

Boolean: Returns or sets whether the month calendar shows ToolTips. (Default: True)

Boolean: Returns or sets whether the month calendar control displays week numbers (1-52) to the left of each row of days. (Default: True)

DateTime: Returns or sets the value that is used by MonthCalendar as today's date.

Throws:

  • ArgumentOutOfRangeException The value is less than the minimum allowable date; or the value is greater than the maximum allowable date.

String: Returns or sets the format string used to display today's date. (Default: "d")

See Custom Date and Time Format Strings for the supported format definitions.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

HeaderPosition: Returns or sets the position of the ComponentTool items associated with this control. (Default: Top)

Methods

Adds a day that is displayed in bold on an annual basis in the month calendar.

Adds a day to be displayed in bold in the month calendar.

Adds a day that is displayed in bold on a monthly basis in the month calendar.

Returns the low and high limits of the displayed dates of the control.

Returns: SelectionRange. The begin and end dates of the displayed calendar.

Removes all the annually bold dates.

Removes all the nonrecurring bold dates.

Removes all the monthly bold dates.

Removes the specified date from the list of annually bold dates.

Removes the specified date from the list of nonrecurring bold dates.

Removes the specified date from the list of monthly bolded dates.

Sets the number of columns and rows of months to display.

Throws:

Sets a date as the currently selected date.

Throws:

  • ArgumentOutOfRangeException The value is less than the minimum allowable date; or the value is greater than the maximum allowable date. This exception will only be thrown if MinDate or MaxDate have been set explicitly.

Sets the selected dates in a month calendar control to the specified date range.

Throws:

  • ArgumentOutOfRangeException start is less than the minimum date allowable for a month calendar control; or start is greater than the maximum allowable date for a month calendar control; or end is less than the minimum date allowable for a month calendar control; or end is greater than the maximum allowable date for a month calendar control. This exception will only be thrown if MinDate or MaxDate have been set explicitly.

Events

DateRangeEventHandler Fired when the date shown in the MonthCalendar changes.

DateRangeEventHandler Fired when the user changes the selected date or range.

DateRangeEventHandler Fired when the displayed range changes.

EventHandler Fired when the value of the ReadOnly property has changed.

ToolClickEventHandler Fired when a ComponentTool is clicked.

Implements

Last updated