CMSCalendar Class

CMSCalendar class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Calendar
        CMS.ExtendedControls.UICalendar
          CMS.Controls.BasicCalendar
            CMS.Controls.CMSCalendar

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0

Syntax

[SerializableAttribute]
public class CMSCalendar : BasicCalendar, 
	ICMSControlProperties, ICMSBaseProperties

The CMSCalendar type exposes the following members.

Constructors

	Name	Description
Public method	CMSCalendar	Constructor.

Fields

	Name	Description
Protected field	mDataLoaded	Indicates whether data should be loaded.
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mMonthEvents	Hashtable with events for current month (key - DateTime, value - DataTable with events). (Inherited from BasicCalendar.)
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicCalendar.)
Protected field	mProperties	Control properties variable.
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicCalendar.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicCalendar.)

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CategoryName	Property to set and get the category name for filtering documents.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	Columns	Gets or sets the columns to be retrieved from database.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	ControlContext	Control context.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	CustomTimeZone	Custom TimeZoneInfo object. (Inherited from BasicCalendar.)
Public property	DataMember	Name of the table when DataSet is used as a DataSource. (Inherited from BasicCalendar.)
Public property	DataSource	Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public property	DayField	Name of the field in the DataSource that contains the datetime value. (Inherited from BasicCalendar.)
Public property	DayWithEventsStyle	Style of the day with an event. (Inherited from BasicCalendar.)
Public property	DayWithOutEventsStyle	Style of the day without an event. (Inherited from BasicCalendar.)
Public property	DisplayOnlySingleDayItem	Indicates whether the only one item is displayed in the day. (Inherited from BasicCalendar.)
Public property	EventEndField	Name of the field in the DataSource that contains the datetime value of event end date. (Inherited from BasicCalendar.)
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
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 (Inherited from BasicCalendar.)
Public property	CheckPermissions	Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public property	ItemTemplate	Template for displaying a day with event. (Inherited from BasicCalendar.)
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
Public property	NoEventsTemplate	Template for displaying a day without any event. (Inherited from BasicCalendar.)
Public property	NoEventTransformationName	No event transformation name in format application.class.transformation.
Public property	OrderBy	Property to set and get the OrderBy.
Public property	Path	Property to set and get the Path.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicCalendar.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship.
Public property	RelationshipName	Name of the relationship.
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node.
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved (Inherited from BasicCalendar.)
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	SelectedItemID	ID of selected item displayed in the calendar. (Inherited from BasicCalendar.)
Public property	SelectedItemIDColumn	ID column name of selected item displayed in the calendar. (Inherited from BasicCalendar.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	ShortID	Short ID of the control. (Inherited from UICalendar.)
Public property	SiteName	Property to set and get the SiteName.
Public property	StopProcessing	Stop processing
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TimeZone	Specifies timezone type. (Inherited from BasicCalendar.)
Public property	TopN	Select top N rows.
Public property	TransformationName	Transformation name in format application.class.transformation.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	WhereCondition	Property to set and get the WhereCondition.

Methods

	Name	Description
Public method	ClearCache	Clears the cached items.
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Public method	DataBind	Binds a data source to calendar control and its child controls. (Inherited from BasicCalendar.)
Public method	GetCacheDependency	Gets the cache dependency for the control.
Protected method	GetDataSet	Retrieves DataSet.
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
Protected method	LoadData	Prepares event data to hashtable to speed up rendering of calendar cells (days). (Inherited from BasicCalendar.)
Protected method	ManageDayNumber	Hides day number in calendar cell if required. (Inherited from BasicCalendar.)
Protected method	OnDayRender	Renders particular day. (Inherited from BasicCalendar.)
Protected method	OnInit	OnInit Handler. (Overrides BasicCalendar.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnVisibleMonthChanged	Handles calendar month change. (Inherited from BasicCalendar.)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicCalendar.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Reload control data.
Protected method	Render	Renders the control. (Overrides Calendar.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.

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. (Inherited from BasicCalendar.)