BasicCalendar Class

Calendar control with databinding features.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Calendar
        CMS.Base.Web.UI.UICalendar
          CMS.DocumentEngine.Web.UI.BasicCalendar
            CMS.DocumentEngine.Web.UI.CMSCalendar

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

[SerializableAttribute]
public class BasicCalendar : UICalendar, 
	INamingContainer, IRelatedData

The BasicCalendar type exposes the following members.

Constructors

	Name	Description
Public method	BasicCalendar	Constructor.

Fields

	Name	Description
Protected field	mMonthEvents	Hashtable with events for current month (key - DateTime, value - DataTable with events).
Protected field	mOnBeforeInitFired	True if the on before init was fired.
Protected field	mRelatedData	Custom data connected to the object.
Protected field	mRelatedDataLoaded	Related data is loaded.

Properties

	Name	Description
Public property	CustomTimeZone	Custom TimeZoneInfo object.
Public property	DataMember	Name of the table when DataSet is used as a DataSource.
Public property	DataSource	Data source with calendar events - either DataSet or DataTable object.
Public property	DayField	Name of the field in the DataSource that contains the datetime value.
Public property	DayWithEventsStyle	Style of the day with an event.
Public property	DayWithOutEventsStyle	Style of the day without an event.
Public property	DisplayOnlySingleDayItem	Indicates whether the only one item is displayed in the day.
Public property	EventEndField	Name of the field in the DataSource that contains the datetime value of event end date.
Public property	HideDefaultDayNumber	Indicates whether the day number is displayed or cell is full filled by the transformation Current day is saved in the "__day" column
Public property	ItemTemplate	Template for displaying a day with event.
Public property	NoEventsTemplate	Template for displaying a day without any event.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved
Public property	SelectedItemID	ID of selected item displayed in the calendar.
Public property	SelectedItemIDColumn	ID column name of selected item displayed in the calendar.
Public property	ShortID	Short ID of the control. (Inherited from UICalendar.)
Public property	TimeZone	Specifies timezone type.

Methods

	Name	Description
Public method	DataBind	Binds a data source to calendar control and its child controls. (Overrides Control.DataBind().)
Protected method	LoadData	Prepares event data to hashtable to speed up rendering of calendar cells (days).
Protected method	ManageDayNumber	Hides day number in calendar cell if required.
Protected method	OnDayRender	Renders particular day. (Overrides Calendar.OnDayRender(TableCell, CalendarDay).)
Protected method	OnInit	Initializes the control. (Overrides UICalendar.OnInit(EventArgs).)
Protected method	OnVisibleMonthChanged	Handles calendar month change. (Overrides Calendar.OnVisibleMonthChanged(DateTime, DateTime).)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnBeforeInit	On before init handler.