DateTimePicker Class

Date and time picker.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.AbstractDateTimePicker
        CMS.ExtendedControls.DateTimePicker

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

Syntax

public class DateTimePicker : AbstractDateTimePicker, 
	ICallbackEventHandler

The DateTimePicker type exposes the following members.

Constructors

	Name	Description
Public method	DateTimePicker	Constructor.

Fields

	Name	Description
Protected field	btnCalendarImage	Calendar image literal (Inherited from AbstractDateTimePicker.)
Protected field	btnNA	N/A button
Protected field	btnNow	Now button.
Protected field	imgDisabled	Disabled image
Protected field	imgEnabled	Enabled image
Protected field	lblDateTime	DateTime label
Protected field	lblGMTShift	GMT shift label

Properties

	Name	Description
Public property	AllowEmptyValue	Indicates if empty value is allowed.
Protected property	ApplyTimeZones	Indicates if timezones can be applied based on timezones and edit time settings. (Inherited from AbstractDateTimePicker.)
Public property	CalendarImageClientID	Client ID of calendar icon. (Inherited from AbstractDateTimePicker.)
Public property	CultureCode	CultureCode to correct DateTime convert. Returns current culture name if UseCustomCalendar is false. (Overrides AbstractDateTimePicker.CultureCode.)
Public property	CustomCalendarControlPath	Custom calendar control path. (Inherited from AbstractDateTimePicker.)
Public property	CustomCalendarSupportFolder	Path to theme files of custom calendar control. (Inherited from AbstractDateTimePicker.)
Public property	CustomTimeZone	Custom TimeZoneInfo object. (Inherited from AbstractDateTimePicker.)
Public property	DateTimeTextBox	TextBox displaying the selected date and time. (Inherited from AbstractDateTimePicker.)
Public property	DisplayNA	Display N/A option within the control.
Public property	DisplayNow	Display now option within the control.
Public property	EditTime	Indicates if the user should be able to edit time. (Inherited from AbstractDateTimePicker.)
Public property	Inherited	Indicates whether current time zone type is inherited or directly selected. (Inherited from AbstractDateTimePicker.)
Public property	IsLiveSite	Indicates whether is live site. (Inherited from AbstractDateTimePicker.)
Public property	MaxDate	Maximum DateTime allowed for calendar. (Inherited from AbstractDateTimePicker.)
Public property	MinDate	Minimum DateTime allowed for calendar. (Inherited from AbstractDateTimePicker.)
Public property	RenderDisableScript	Indicates whether to render also client scripts for enabling controls.
Public property	SelectedDateTime	Selected date and time. (Overrides AbstractDateTimePicker.SelectedDateTime.)
Public property	SupportFolder	Path to the folder with supporting files.
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from AbstractDateTimePicker.)
Public property	TimeZone	Specifies timezone type. (Inherited from AbstractDateTimePicker.)
Public property	TimeZoneOffset	Time zone offset (in minutes). (Inherited from AbstractDateTimePicker.)
Public property	UseCalendarLimit	If true calendar date are restricted by min and max date. (Inherited from AbstractDateTimePicker.)
Public property	UseCustomCalendar	Indicates whether use custom calendar. Default value is true. Can be overwritten by 'CMSUseCustomCalendarPicker' application setting.
Protected property	ValidTimeZone	Valid time zone info object. It depends on TimeZoneTypeEnum (inherited, server, website). (Inherited from AbstractDateTimePicker.)

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Protected method	DateTimeToString	Creates string representation of DateTime. (Inherited from AbstractDateTimePicker.)
Protected method	DateTimeToStringFormat	Modifies date and time format string based on UseCustomCalendar property. (Overrides AbstractDateTimePicker.DateTimeToStringFormat(String, CultureInfo).)
Public method	GenerateNonCustomCalendarImageEvent	Generate JavaScript onClick event for non custom calendar.
Public method	GetCallbackResult	Returns the result of the callback.
Public method	IsValidRange	Validates if time is in interval (set by UseCalendarLimit, MinDate and MaxDate properties). (Overrides AbstractDateTimePicker.IsValidRange().)
Protected method	IsValidRangeInternal	Basic validation if time is in interval (set by UseCalendarLimit, MinDate and MaxDate properties). (Inherited from AbstractDateTimePicker.)
Protected method	OnInit	OnInit event. (Inherited from AbstractDateTimePicker.)
Protected method	OnPreRender	PreRender event handler. (Overrides Control.OnPreRender(EventArgs).)
Public method	RaiseCallbackEvent	Callback processing.
Protected method	Render	Renders the control at design-time. (Overrides WebControl.Render(HtmlTextWriter).)

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.)