MonthCalendar

Wisej.Web.MonthCalendar

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • MonthCalendar

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

C#

public class MonthCalendar : Control, IReadOnly

VB.NET

Public Class MonthCalendar
    Inherits Control
    Implements 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

MonthCalendar()

Initializes an instance of the MonthCalendar control.

MonthCalendar(onDateChanged)

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

Name	Type	Description
onDateChanged	Action<Object, DateRangeEventArgs>	The event handler that is called when the selected date changes.

MonthCalendar(location, size, onDateChanged)

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

Name	Type	Description
location	Point	The location of the TextBox on its parent control.
size	Size	The size of the TextBox.
onDateChanged	Action<Object, DateRangeEventArgs>	The event handler that is called when the selected date changes.

Properties

AnnuallyBoldedDates

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

AutoSize

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

BoldedDates

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

BorderStyle

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

CalendarDimensions

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

DefaultSize

Size:

FirstDayOfWeek

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

MaxDate

DateTime: Returns or sets the maximum allowable date.

Throws:

• ArgumentException The value is less than the MinDate.

MaxSelectionCount

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

Throws:

• ArgumentException The value is less than 1; or the MaxSelectionCount cannot be set.

MinDate

DateTime: Returns or sets the minimum allowable date.

Throws:

• ArgumentException The date set is greater than the MaxDate; or the date set is earlier than 01/01/1753.

MonthlyBoldedDates

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

ReadOnly

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

SelectionEnd

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

Throws:

• ArgumentOutOfRangeException The date value is less than the MinDate value; or the date value is greater than the MaxDate value.

SelectionRange

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.

SelectionStart

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

Throws:

• ArgumentOutOfRangeException The date value is less than MinDate; or the date value is greater than MaxDate.

ShowOtherMonth

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

ShowToday

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

ShowToolTips

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

ShowWeekNumbers

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

TodayDate

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.

TodayFormat

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.

Tools

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

ToolsPosition

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

Methods

AddAnnuallyBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to be displayed in bold.

AddBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to be displayed in bold.

AddMonthlyBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to be displayed in bold.

Dispose(disposing)

Dispose the control.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

GetDisplayRange()

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

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

OnDateChanged(e)

Fires the DateChanged event.

Parameter	Type	Description
e	DateRangeEventArgs	A DateRangeEventArgs that contains the event data.

OnDateSelected(e)

Fires the DateSelected event.

Parameter	Type	Description
e	DateRangeEventArgs	A DateRangeEventArgs that contains the event data.

OnDisplayRangeChanged(e)

Fires the DisplayRangeChanged event.

Parameter	Type	Description
e	DateRangeEventArgs	A DateRangeEventArgs that contains the event data.

OnReadOnlyChanged(e)

Fires the ReadOnlyChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnToolClick(e)

Fires the ToolClick event.

Parameter	Type	Description
e	ToolClickEventArgs	A ToolClickEventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

RemoveAllAnnuallyBoldedDates()

Removes all the annually bold dates.

RemoveAllBoldedDates()

Removes all the nonrecurring bold dates.

RemoveAllMonthlyBoldedDates()

Removes all the monthly bold dates.

RemoveAnnuallyBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to remove from the date list.

RemoveBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to remove from the date list.

RemoveMonthlyBoldedDate(date)

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

Parameter	Type	Description
date	DateTime	The date to remove from the date list.

SetBoundsCore(x, y, width, height, specified)

Sets the specified bounds of the ToolBar control.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	Not used.
specified	BoundsSpecified	A combination of the BoundsSpecified values.

SetCalendarDimensions(x, y)

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

Parameter	Type	Description
x	Int32	The number of columns.
y	Int32	The number of rows.

Throws:

• ArgumentOutOfRangeExceptionx or y is less than 1.

SetDate(date)

Sets a date as the currently selected date.

Parameter	Type	Description
date	DateTime	The date to be selected.

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.

SetSelectionRange(start, end)

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

Parameter	Type	Description
start	DateTime	The beginning date of the selection range.
end	DateTime	The end date of the selection range.

Throws:

• ArgumentOutOfRangeExceptionstart 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

DateChanged

DateRangeEventHandler Fired when the date shown in the MonthCalendar changes.

DateSelected

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

DisplayRangeChanged

DateRangeEventHandler Fired when the displayed range changes.

ReadOnlyChanged

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

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.