Method | Description | |
---|---|---|
SetAltField ( string altField ) : |
The jQuery selector for another field that is to be updated with the selected date from the datepicker. Use the altFormat setting to change the format of the date within this field. Leave as blank for no alternate field.
|
|
SetAltFormat ( string altFormat ) : |
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 the formatDate function
|
|
SetAppendText ( string appendText ) : |
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 the formatDate function
|
|
SetAutoSize ( bool autoSize ) : |
Set to true to automatically resize the input field to accommodate dates in the current dateFormat.
|
|
SetButtonImage ( string buttonImage ) : |
The URL for the popup button image. If set, buttonText becomes the alt value and is not directly displayed.
|
|
SetButtonImageOnly ( bool buttonImageOnly ) : |
Set to true to place an image after the field to use as the trigger without it appearing on a button.
|
|
SetButtonText ( string buttonText ) : |
The text to display on the trigger button. Use in conjunction with showOn equal to 'button' or 'both'.
|
|
SetCalculateWeek ( string calculateWeek ) : |
A function to calculate the week of the year for a given date. The default implementation uses the ISO 8601 definition: weeks start on a Monday; the first week of the year contains the first Thursday of the year.
|
|
SetChangeMonth ( bool changeMonth ) : |
Allows you to change the month by selecting from a drop-down list. You can enable this feature by setting the attribute to true.
|
|
SetChangeYear ( bool changeYear ) : |
Allows you to change the year by selecting from a drop-down list. You can enable this feature by setting the attribute to true. Use the yearRange option to control which years are made available for selection.
|
|
SetCloseText ( string closeText ) : |
The text to display for the close link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
|
|
SetConstrainInput ( bool constrainInput ) : |
When true entry in the input field is constrained to those characters allowed by the current dateFormat.
|
|
SetCurrentText ( string currentText ) : |
The text to display for the current day link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
|
|
SetDateFormat ( string dateFormat ) : |
The format for parsed and displayed dates. This attribute is one of the regionalisation attributes. For a full list of the possible formats see the formatDate function.
|
|
SetDayNames ( List |
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.
|
|
SetDayNames ( string dayNames ) : |
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.
|
|
SetDayNamesMin ( List |
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.
|
|
SetDayNamesMin ( string dayNamesMin ) : |
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.
|
|
SetDayNamesShort ( List |
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.
|
|
SetDayNamesShort ( string dayNamesShort ) : |
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.
|
|
SetDefaultDate ( System.DateTime newDate ) : |
Set the date to highlight on first opening if the field is blank, using an actual date object.
|
|
SetDefaultDate ( int relativeDays ) : |
Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object or as a string in the current dateFormat, 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.
|
|
SetDefaultDate ( string defaultDate ) : |
Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object or as a string in the current dateFormat, 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.
|
|
SetDisabled ( bool disabled ) : |
Disables (true) or enables (false) the control. Can be set when initialising (first creating) the control.
|
|
SetDuration ( Core speed ) : |
Control the speed at which the datepicker appears using one of the three predefined speeds ("slow", "normal", "fast").
|
|
SetDuration ( int durationInMilliseconds ) : |
Control the speed at which the datepicker appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast").
|
|
SetDuration ( string duration ) : |
Control the speed at which the datepicker appears using one of the three predefined speeds ("slow", "normal", "fast").
|
|
SetFirstDay ( int firstDay ) : |
Set the first day of the week: Sunday is 0, Monday is 1, ... This attribute is one of the regionalisation attributes.
|
|
SetGotoCurrent ( bool gotoCurrent ) : |
When true the current day link moves to the currently selected date instead of today.
|
|
SetHideIfNoPrevNext ( bool hideIfNoPrevNext ) : |
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.
|
|
SetIsRTL ( bool isRTL ) : |
True if the current language is drawn from right to left. This attribute is one of the regionalisation attributes
|
|
SetMaxDate ( System.DateTime maxDate ) : |
Set a maximum selectable date via a Date object.
|
|
SetMaxDate ( int relativeDays ) : |
Set a maximum selectable date via a string in the current dateFormat, 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.
|
|
SetMaxDate ( string maxDate ) : |
Set a maximum selectable date via a string in the current dateFormat, 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.
|
|
SetMinDate ( System.DateTime minDate ) : |
Set a minimum selectable date via a Date object.
|
|
SetMinDate ( int relativeDays ) : |
Set a minimum selectable date via a string in the current dateFormat, 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.
|
|
SetMinDate ( string minDate ) : |
Set a minimum selectable date via a string in the current dateFormat, 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.
|
|
SetMonthNames ( List |
The list of full month names, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
|
|
SetMonthNames ( string monthNames ) : |
The list of full month names, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
|
|
SetMonthNamesShort ( List |
The list of abbreviated 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.
|
|
SetMonthNamesShort ( string monthNamesShort ) : |
The list of abbreviated 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.
|
|
SetNavigationAsDateFormat ( bool navigationAsDateFormat ) : |
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.
|
|
SetNextText ( string nextText ) : |
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.
|
|
SetNumberOfMonths ( int numberOfMonths ) : |
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.
|
|
SetNumberOfMonths ( int rows, int columns ) : |
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.
|
|
SetPrevText ( string prevText ) : |
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.
|
|
SetSelectOtherMonths ( bool selectOtherMonths ) : |
When true days in other months shown before or after the current month are selectable. This only applies if showOtherMonths is also true.
|
|
SetShortYearCutoff ( int shortYearCutOff ) : |
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.
|
|
SetShortYearCutoff ( string shortYearCutoff ) : |
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.
|
|
SetShowAnim ( Core showAnimation ) : |
Set the name of the animation used to show/hide the datepicker. Use 'show' (the default), 'slideDown', 'fadeIn', any of the show/hide jQuery UI effects, or '' for no animation.
|
|
SetShowAnim ( string showAnim ) : |
Set the name of the animation used to show/hide the datepicker. Use 'show' (the default), 'slideDown', 'fadeIn', any of the show/hide jQuery UI effects, or '' for no animation.
|
|
SetShowButtonPanel ( bool showButtonPanel ) : |
Whether to show the button panel
|
|
SetShowCurrentAtPos ( int showCurrentAtPos ) : |
Specify where in a multi-month display the current month shows, starting from 0 at the top/left
|
|
SetShowInline ( bool showInline ) : |
Shows the calendar inline on the page (attaches the datePicker to a DIV rather than an INPUT)
|
|
SetShowMonthAfterYear ( bool showMonthAfterYear ) : |
Whether to show the month after the year in the header. This attribute is one of the regionalisation attributes.
|
|
SetShowOn ( string showOn ) : |
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').
|
|
SetShowOptions ( string showOptions ) : |
If using one of the jQuery UI effects for showAnim, you can provide additional settings for that animation via this option. showOptions is expected to be a JSON type object, including the curly braces.
|
|
SetShowOtherMonths ( bool showOtherMonths ) : |
Display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use selectOtherMonths.
|
|
SetShowWeek ( bool showWeek ) : |
When true a column is added to show the week of the year. The calculateWeek option determines how the week of the year is calculated. You may also want to change the firstDay option.
|
|
SetStepMonths ( int stepMonths ) : |
Set how many months to move when clicking the Previous/Next links
|
|
SetWeekHeader ( string weekHeader ) : |
The text to display for the week of the year column heading. This attribute is one of the regionalisation attributes. Use showWeek to display this column.
|
|
SetYearRange ( string yearRange ) : |
Control the range of years displayed in the year drop-down: either relative to today's year (-nn:+nn), relative to the currently selected year (c-nn:c+nn), absolute (nnnn:nnnn), or combinations of these formats (nnnn:-nn). Note that this option only affects what appears in the drop-down, to restrict which dates may be selected use the minDate and/or maxDate options.
|
|
SetYearSuffix ( string yearSuffix ) : |
Additional text to display after the year in the month headers. This attribute is one of the regionalisation attributes.
|
public SetAltField ( string altField ) : |
||
altField | string | |
return |
public SetAltFormat ( string altFormat ) : |
||
altFormat | string | |
return |
public SetAppendText ( string appendText ) : |
||
appendText | string | |
return |
public SetAutoSize ( bool autoSize ) : |
||
autoSize | bool | |
return |
public SetButtonImage ( string buttonImage ) : |
||
buttonImage | string | |
return |
public SetButtonImageOnly ( bool buttonImageOnly ) : |
||
buttonImageOnly | bool | |
return |
public SetButtonText ( string buttonText ) : |
||
buttonText | string | |
return |
public SetCalculateWeek ( string calculateWeek ) : |
||
calculateWeek | string | |
return |
public SetChangeMonth ( bool changeMonth ) : |
||
changeMonth | bool | |
return |
public SetChangeYear ( bool changeYear ) : |
||
changeYear | bool | |
return |
public SetCloseText ( string closeText ) : |
||
closeText | string | |
return |
public SetConstrainInput ( bool constrainInput ) : |
||
constrainInput | bool | |
return |
public SetCurrentText ( string currentText ) : |
||
currentText | string | |
return |
public SetDateFormat ( string dateFormat ) : |
||
dateFormat | string | |
return |
public SetDayNames ( List |
||
dayNames | List |
|
return |
public SetDayNames ( string dayNames ) : |
||
dayNames | string | |
return |
public SetDayNamesMin ( List |
||
dayNamesMin | List |
|
return |
public SetDayNamesMin ( string dayNamesMin ) : |
||
dayNamesMin | string | |
return |
public SetDayNamesShort ( List |
||
dayNamesShort | List |
|
return |
public SetDayNamesShort ( string dayNamesShort ) : |
||
dayNamesShort | string | |
return |
public SetDefaultDate ( System.DateTime newDate ) : |
||
newDate | System.DateTime | |
return |
public SetDefaultDate ( int relativeDays ) : |
||
relativeDays | int | |
return |
public SetDefaultDate ( string defaultDate ) : |
||
defaultDate | string | |
return |
public SetDisabled ( bool disabled ) : |
||
disabled | bool | |
return |
public SetDuration ( int durationInMilliseconds ) : |
||
durationInMilliseconds | int | |
return |
public SetDuration ( string duration ) : |
||
duration | string | |
return |
public SetFirstDay ( int firstDay ) : |
||
firstDay | int | |
return |
public SetGotoCurrent ( bool gotoCurrent ) : |
||
gotoCurrent | bool | |
return |
public SetHideIfNoPrevNext ( bool hideIfNoPrevNext ) : |
||
hideIfNoPrevNext | bool | |
return |
public SetMaxDate ( System.DateTime maxDate ) : |
||
maxDate | System.DateTime | |
return |
public SetMaxDate ( int relativeDays ) : |
||
relativeDays | int | |
return |
public SetMaxDate ( string maxDate ) : |
||
maxDate | string | |
return |
public SetMinDate ( System.DateTime minDate ) : |
||
minDate | System.DateTime | |
return |
public SetMinDate ( int relativeDays ) : |
||
relativeDays | int | |
return |
public SetMinDate ( string minDate ) : |
||
minDate | string | |
return |
public SetMonthNames ( List |
||
monthNames | List |
|
return |
public SetMonthNames ( string monthNames ) : |
||
monthNames | string | |
return |
public SetMonthNamesShort ( List |
||
monthNamesShort | List |
|
return |
public SetMonthNamesShort ( string monthNamesShort ) : |
||
monthNamesShort | string | |
return |
public SetNavigationAsDateFormat ( bool navigationAsDateFormat ) : |
||
navigationAsDateFormat | bool | |
return |
public SetNextText ( string nextText ) : |
||
nextText | string | |
return |
public SetNumberOfMonths ( int numberOfMonths ) : |
||
numberOfMonths | int | |
return |
public SetNumberOfMonths ( int rows, int columns ) : |
||
rows | int | |
columns | int | |
return |
public SetPrevText ( string prevText ) : |
||
prevText | string | |
return |
public SetSelectOtherMonths ( bool selectOtherMonths ) : |
||
selectOtherMonths | bool | |
return |
public SetShortYearCutoff ( int shortYearCutOff ) : |
||
shortYearCutOff | int | |
return |
public SetShortYearCutoff ( string shortYearCutoff ) : |
||
shortYearCutoff | string | |
return |
public SetShowAnim ( Core showAnimation ) : |
||
showAnimation | Core | |
return |
public SetShowAnim ( string showAnim ) : |
||
showAnim | string | |
return |
public SetShowButtonPanel ( bool showButtonPanel ) : |
||
showButtonPanel | bool | |
return |
public SetShowCurrentAtPos ( int showCurrentAtPos ) : |
||
showCurrentAtPos | int | |
return |
public SetShowInline ( bool showInline ) : |
||
showInline | bool | /// If true datePicker is shown inline (inside a DIV) /// If false datePicker is shown against an INPUT /// |
return |
public SetShowMonthAfterYear ( bool showMonthAfterYear ) : |
||
showMonthAfterYear | bool | |
return |
public SetShowOptions ( string showOptions ) : |
||
showOptions | string | |
return |
public SetShowOtherMonths ( bool showOtherMonths ) : |
||
showOtherMonths | bool | |
return |
public SetShowWeek ( bool showWeek ) : |
||
showWeek | bool | |
return |
public SetStepMonths ( int stepMonths ) : |
||
stepMonths | int | |
return |
public SetWeekHeader ( string weekHeader ) : |
||
weekHeader | string | |
return |
public SetYearRange ( string yearRange ) : |
||
yearRange | string | |
return |
public SetYearSuffix ( string yearSuffix ) : |
||
yearSuffix | string | |
return |