DatePickerExtender Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

The datepicker is tied to a standard form input field. Focus on the input (click, or use the tab key) to open an interactive calendar in a small overlay. Choose a date, click elsewhere on the page (blur the input), or hit the Esc key to close. If a date is chosen, feedback is shown as the input's value.
Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    ContentStudio.Site.ControlsDatePickerExtender

Namespace: ContentStudio.Site.Controls
Assembly: ContentStudio.Site.Controls (in ContentStudio.Site.Controls.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public class DatePickerExtender : Control

The DatePickerExtender type exposes the following members.

Constructors

  NameDescription
Public methodDatePickerExtender
Initializes a new instance of the DatePickerExtender class
Top
Properties

  NameDescription
Protected propertyAdapter (Inherited from Control.)
Public propertyAlternateField
The jQuery selector for another field that is to be updated with the selected date from the datepicker. Use the altFormat setting below to change the format of the date within this field. Leave as blank for no alternate field.
Public propertyAlternateFormat
The dateFormat to be used for the altField option. This allows one date format to be shown to the user for selection purposes, while a different format is actually sent behind the scenes. For a full list of the possible formats see http://docs.jquery.com/UI/Datepicker/formatDate.
Public propertyAppendText
The text to display after each date field, e.g. to show the required format.
Public propertyAppRelativeTemplateSourceDirectory (Inherited from Control.)
Public propertyAssociatedControlID
The ID of the control to extend as a date picker.
Public propertyBindingContainer (Inherited from Control.)
Public propertyButtonImage
The URL for the popup button image. If set, button text becomes the alt value and is not directly displayed.
Public propertyButtonImageOnly
Set to true to place an image after the field to use as the trigger without it appearing on a button.
Public propertyButtonText
The text to display on the trigger button. Use in conjunction with showOn equal to 'button' or 'both'.
Public propertyChangeMonth
Allows you to change the month by selecting from a drop-down list. You can enable this feature by setting the attribute to true.
Public propertyChangeYear
Allows you to change the year by selecting from a drop-down list. You can enable this feature by setting the attribute to true.
Protected propertyChildControlsCreated (Inherited from Control.)
Public propertyClientID (Inherited from Control.)
Protected propertyClientIDSeparator (Inherited from Control.)
Public propertyCloseText
The text to display for the close link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
Public propertyConstrainInput
True if the input field is constrained to the current date format.
Protected propertyContext (Inherited from Control.)
Public propertyControls (Inherited from Control.)
Public propertyCurrentText
The text to display for the current day link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
Public propertyDateFormat
The dateFormat to be used for the altField option. This allows one date format to be shown to the user for selection purposes, while a different format is actually sent behind the scenes. For a full list of the possible formats see http://docs.jquery.com/UI/Datepicker/formatDate.
Public propertyDayNames
The list of long day names, starting from Sunday, for use as requested via the dateFormat setting. They also appear as popup hints when hovering over the corresponding column headings. This attribute is one of the regionalisation attributes.
Public propertyDayNamesMin
The list of minimised day names, starting from Sunday, for use as column headers within the datepicker. This attribute is one of the regionalisation attributes.
Public propertyDayNamesShort
The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Public propertyDefaultDate
Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object, or a number of days from today (e.g. +7) or a string of values and periods ('y' for years, 'm' for months, 'w' for weeks, 'd' for days, e.g. '+1m +7d'), or null for today.
Protected propertyDesignMode (Inherited from Control.)
Public propertyDuration
Control the speed at which the datepicker appears, it may be a time in milliseconds, a string representing one of the three predefined speeds (\"slow\", \"normal\", \"fast\"), or '' for immediately.
Public propertyEnableTheming (Inherited from Control.)
Public propertyEnableViewState (Inherited from Control.)
Protected propertyEvents (Inherited from Control.)
Public propertyFirstDay
Set the first day of the week: Sunday is 0, Monday is 1, ... This attribute is one of the regionalisation attributes.
Public propertyGotoCurrent
If true, the current day link moves to the currently selected date instead of today.
Protected propertyHasChildViewState (Inherited from Control.)
Public propertyHideIfNoPrevNext
Normally the previous and next links are disabled when not applicable (see minDate/maxDate). You can hide them altogether by setting this attribute to true.
Public propertyID (Inherited from Control.)
Protected propertyIdSeparator (Inherited from Control.)
Public propertyIgnoreJQueryUIComponentCheck
Gets or sets a value indicating whether [ignore J query UI component check]. Set this to true to ignore checking whether the JQuery UI component exists on the page or not.
Protected propertyIsChildControlStateCleared (Inherited from Control.)
Public propertyIsRTL
True if the current language is drawn from right to left. This attribute is one of the regionalisation attributes.
Protected propertyIsTrackingViewState (Inherited from Control.)
Protected propertyIsViewStateEnabled (Inherited from Control.)
Protected propertyLoadViewStateByID (Inherited from Control.)
Public propertyMaxDate
Set a maximum selectable date via a Date object, or a number of days from today (e.g. +7) or a string of values and periods ('y' for years, 'm' for months, 'w' for weeks, 'd' for days, e.g. '+1m +1w'), or null for no limit.
Public propertyMinDate
Set a minimum selectable date via a Date object, or a number of days from today (e.g. +7) or a string of values and periods ('y' for years, 'm' for months, 'w' for weeks, 'd' for days, e.g. '-1y -1m'), or null for no limit.
Public propertyMonthNames
The list of full month names, as used in the month header on each datepicker and as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Public propertyMonthNamesShort
The list of abbreviated month names, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Public propertyNamingContainer (Inherited from Control.)
Public propertyNavigationAsDateFormat
When true the formatDate function is applied to the prevText, nextText, and currentText values before display, allowing them to display the target month names for example.
Public propertyNextText
The text to display for the next month link. This attribute is one of the regionalisation attributes. With the standard ThemeRoller styling, this value is replaced by an icon.
Public propertyNumberOfMonths
Set how many months to show at once. The value can be a straight integer, or can be a two-element array to define the number of rows and columns to display.
Public propertyPage (Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyPrevText
The text to display for the previous month link. This attribute is one of the regionalisation attributes. With the standard ThemeRoller styling, this value is replaced by an icon.
Public propertyShortYearCutoff
Set the cutoff year for determining the century for a date (used in conjunction with dateFormat 'y'). If a numeric value (0-99) is provided then this value is used directly. If a string value is provided then it is converted to a number and added to the current year. Once the cutoff year is calculated, any dates entered with a year value less than or equal to it are considered to be in the current century, while those greater than it are deemed to be in the previous century.
Public propertyShowAnim
Set the name of the animation used to show/hide the datepicker. Use 'show' (the default), 'slideDown', 'fadeIn', or any of the show/hide jQuery UI effects.
Public propertyShowButtonPanel
Gets or sets a value indicating whether to show button panel.
Public propertyShowCurrentAtPos
Specify where in a multi-month display the current month shows, starting from 0 at the top/left.
Public propertyShowMonthAfterYear
Whether to show the month after the year in the header.
Public propertyShowOn
Have the datepicker appear automatically when the field receives focus ('focus'), appear only when a button is clicked ('button'), or appear when either event takes place ('both').
Public propertyShowOptions
If using one of the jQuery UI effects for showAnim, you can provide additional settings for that animation via this option, e.g. direction: 'up'.
Public propertyShowOtherMonths
Display dates in other months (non-selectable) at the start or end of the current month.
Public propertySite (Inherited from Control.)
Public propertySkinID (Inherited from Control.)
Public propertyStepMonths
Set how many months to move when clicking the Previous/Next links.
Public propertyTemplateControl (Inherited from Control.)
Public propertyTemplateSourceDirectory (Inherited from Control.)
Public propertyUniqueID (Inherited from Control.)
Protected propertyViewState (Inherited from Control.)
Protected propertyViewStateIgnoresCase (Inherited from Control.)
Public propertyVisible (Inherited from Control.)
Public propertyYearRange
Control the range of years displayed in the year drop-down: either relative to current year (-nn:+nn) or absolute (nnnn:nnnn).
Top
Methods

  NameDescription
Protected methodAddedControl (Inherited from Control.)
Protected methodAddParsedSubObject (Inherited from Control.)
Public methodApplyStyleSheetSkin (Inherited from Control.)
Protected methodBuildProfileTree (Inherited from Control.)
Protected methodClearChildControlState (Inherited from Control.)
Protected methodClearChildState (Inherited from Control.)
Protected methodClearChildViewState (Inherited from Control.)
Protected methodCreateChildControls (Inherited from Control.)
Protected methodCreateControlCollection (Inherited from Control.)
Public methodDataBind (Inherited from Control.)
Protected methodDataBind(Boolean) (Inherited from Control.)
Protected methodDataBindChildren (Inherited from Control.)
Public methodDispose (Inherited from Control.)
Protected methodEnsureChildControls (Inherited from Control.)
Protected methodEnsureID (Inherited from Control.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFindControl(String) (Inherited from Control.)
Protected methodFindControl(String, Int32) (Inherited from Control.)
Public methodFocus (Inherited from Control.)
Protected methodGetDesignModeState (Inherited from Control.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodHasControls (Inherited from Control.)
Protected methodHasEvents (Inherited from Control.)
Protected methodIsLiteralContent (Inherited from Control.)
Protected methodLoadControlState (Inherited from Control.)
Protected methodLoadViewState (Inherited from Control.)
Protected methodMapPathSecure (Inherited from Control.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnBubbleEvent (Inherited from Control.)
Protected methodOnDataBinding (Inherited from Control.)
Protected methodOnInit
Raises the Init event.
(Overrides ControlOnInit(EventArgs).)
Protected methodOnLoad (Inherited from Control.)
Protected methodOnPreRender
Raises the PreRender event.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodOnUnload (Inherited from Control.)
Protected methodOpenFile (Inherited from Control.)
Protected methodRaiseBubbleEvent (Inherited from Control.)
Protected methodRemovedControl (Inherited from Control.)
Protected methodRender (Inherited from Control.)
Protected methodRenderChildren (Inherited from Control.)
Public methodRenderControl(HtmlTextWriter) (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Protected methodResolveAdapter (Inherited from Control.)
Public methodResolveClientUrl (Inherited from Control.)
Public methodResolveUrl (Inherited from Control.)
Protected methodSaveControlState (Inherited from Control.)
Protected methodSaveViewState (Inherited from Control.)
Protected methodSetDesignModeState (Inherited from Control.)
Public methodSetRenderMethodDelegate (Inherited from Control.)
Public methodToString (Inherited from Object.)
Protected methodTrackViewState (Inherited from Control.)
Top
Events

  NameDescription
Public eventDataBinding (Inherited from Control.)
Public eventDisposed (Inherited from Control.)
Public eventInit (Inherited from Control.)
Public eventLoad (Inherited from Control.)
Public eventPreRender (Inherited from Control.)
Public eventUnload (Inherited from Control.)
Top
See Also

Reference