Click or drag to resize
BasicCalendar Class
Calendar control with databinding features.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
[SerializableAttribute]
public class BasicCalendar : UICalendar, 
	INamingContainer, IRelatedData

The BasicCalendar type exposes the following members.

Constructors
  NameDescription
Public methodBasicCalendar
Constructor.
Top
Fields
  NameDescription
Protected fieldmMonthEvents
Hashtable with events for current month (key - DateTime, value - DataTable with events).
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRelatedDataLoaded
Related data is loaded.
Top
Properties
  NameDescription
Public propertyCustomTimeZone
Custom TimeZoneInfo object.
Public propertyDataMember
Name of the table when DataSet is used as a DataSource.
Public propertyDataSource
Data source with calendar events - either DataSet or DataTable object.
Public propertyDayField
Name of the field in the DataSource that contains the datetime value.
Public propertyDayWithEventsStyle
Style of the day with an event.
Public propertyDayWithOutEventsStyle
Style of the day without an event.
Public propertyDisplayOnlySingleDayItem
Indicates whether the only one item is displayed in the day.
Public propertyEventEndField
Name of the field in the DataSource that contains the datetime value of event end date.
Public propertyHideDefaultDayNumber
Indicates whether the day number is displayed or cell is full filled by the transformation Current day is saved in the "__day" column
Public propertyItemTemplate
Template for displaying a day with event.
Public propertyNoEventsTemplate
Template for displaying a day without any event.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
Public propertySelectedItemID
ID of selected item displayed in the calendar.
Public propertySelectedItemIDColumn
ID column name of selected item displayed in the calendar.
Public propertyShortID
Short ID of the control.
(Inherited from UICalendar.)
Public propertyTimeZone
Specifies timezone type.
Top
Methods
  NameDescription
Public methodDataBind
Binds a data source to calendar control and its child controls.
(Overrides ControlDataBind.)
Protected methodLoadData
Prepares event data to hashtable to speed up rendering of calendar cells (days).
Protected methodManageDayNumber
Hides day number in calendar cell if required.
Protected methodOnDayRender
Renders particular day.
(Overrides CalendarOnDayRender(TableCell, CalendarDay).)
Protected methodOnInit
Initializes the control.
(Overrides UICalendarOnInit(EventArgs).)
Protected methodOnVisibleMonthChanged
Handles calendar month change.
(Overrides CalendarOnVisibleMonthChanged(DateTime, DateTime).)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnBeforeInit
On before init handler.
Top
See Also