Click or drag to resize
CMSCalendar Class
CMSCalendar class.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0
Syntax
C#
[SerializableAttribute]
public class CMSCalendar : BasicCalendar, 
	ICMSControlProperties, ICMSBaseProperties

The CMSCalendar type exposes the following members.

Constructors
  NameDescription
Public methodCMSCalendar
Constructor.
Top
Fields
  NameDescription
Protected fieldmDataLoaded
Indicates whether data should be loaded.
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmMonthEvents
Hashtable with events for current month (key - DateTime, value - DataTable with events).
(Inherited from BasicCalendar.)
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
(Inherited from BasicCalendar.)
Protected fieldmProperties
Control properties variable.
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from BasicCalendar.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from BasicCalendar.)
Top
Properties
  NameDescription
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyCategoryName
Property to set and get the category name for filtering documents.
Public propertyCheckPermissions
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 propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyControlContext
Control context.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyCustomTimeZone
Custom TimeZoneInfo object.
(Inherited from BasicCalendar.)
Public propertyDataMember
Name of the table when DataSet is used as a DataSource.
(Inherited from BasicCalendar.)
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public propertyDayField
Name of the field in the DataSource that contains the datetime value.
(Inherited from BasicCalendar.)
Public propertyDayWithEventsStyle
Style of the day with an event.
(Inherited from BasicCalendar.)
Public propertyDayWithOutEventsStyle
Style of the day without an event.
(Inherited from BasicCalendar.)
Public propertyDisplayOnlySingleDayItem
Indicates whether the only one item is displayed in the day.
(Inherited from BasicCalendar.)
Public propertyEventEndField
Name of the field in the DataSource that contains the datetime value of event end date.
(Inherited from BasicCalendar.)
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
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
(Inherited from BasicCalendar.)
Public propertyItemTemplate
Template for displaying a day with event.
(Inherited from BasicCalendar.)
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
Public propertyNoEventsTemplate
Template for displaying a day without any event.
(Inherited from BasicCalendar.)
Public propertyNoEventTransformationName
No event transformation name in format application.class.transformation.
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyPath
Property to set and get the Path.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from BasicCalendar.)
Public propertyRelatedNodeIsOnTheLeftSide
If true, the returned nodes are on the right side of the relationship.
Public propertyRelationshipName
Name of the relationship.
Public propertyRelationshipWithNodeGuid
Select nodes with given relationship with given node.
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
(Inherited from BasicCalendar.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
Public propertySelectedItemID
ID of selected item displayed in the calendar.
(Inherited from BasicCalendar.)
Public propertySelectedItemIDColumn
ID column name of selected item displayed in the calendar.
(Inherited from BasicCalendar.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertyShortID
Short ID of the control.
(Inherited from UICalendar.)
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTimeZone
Specifies timezone type.
(Inherited from BasicCalendar.)
Public propertyTopN
Select top N rows.
Public propertyTransformationName
Transformation name in format application.class.transformation.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyWhereCondition
Property to set and get the WhereCondition.
Top
Methods
  NameDescription
Public methodClearCache
Clears the cached items.
Protected methodCreateChildControls
Renders the control at run-time.
(Overrides ControlCreateChildControls.)
Public methodDataBind
Binds a data source to calendar control and its child controls.
(Inherited from BasicCalendar.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
Protected methodGetDataSet
Retrieves DataSet.
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
Protected methodLoadData
Prepares event data to hashtable to speed up rendering of calendar cells (days).
(Inherited from BasicCalendar.)
Protected methodManageDayNumber
Hides day number in calendar cell if required.
(Inherited from BasicCalendar.)
Protected methodOnDayRender
Renders particular day.
(Inherited from BasicCalendar.)
Protected methodOnInit
OnInit Handler.
(Overrides BasicCalendarOnInit(EventArgs).)
Protected methodOnLoad
OnLoad.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnVisibleMonthChanged
Handles calendar month change.
(Inherited from BasicCalendar.)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
(Inherited from BasicCalendar.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Reload control data.
Protected methodRender
Renders the control.
(Overrides CalendarRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
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.
(Inherited from BasicCalendar.)
Top
See Also