TIWCGJQDatePickerOptions Class
The DatePicker Options class
IWCGJQCommon.TIWCGJSon
IWCGJQDatePicker.TIWCGJQDatePickerOptions
IWCGJQGrid.TIWCGJQGridColDatePickerOptions
The TIWCGJQDatePickerOptions type exposes the following members.
Name | Description | |
---|---|---|
![]() | Create(TCollection) | |
![]() | CreateSingle(TPersistent,string) | Initializes a new instance of the TIWCGJQDatePickerOptions class. (Overrides TIWCGJSon.CreateSingle(TPersistent,string).) |
Name | Description | |||
---|---|---|---|---|
![]() | 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. | ||
![]() | 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 | ||
![]() | AppendText | The text to display after each date field, e.g. to show the required format. | ||
![]() | AutoMaxZPopup | If true, will detect if the element is inside of dialog, and use the max ZIndex for popup.
| ||
![]() | AutoSize | Set to true to automatically resize the input field to accommodate dates in the current dateFormat. | ||
![]() | ButtonCss | Button css class, added to button/image when ShowOn <> dposFocus | ||
![]() | ButtonImage | The URL for the popup button image. If set, buttonText becomes the alt value and is not directly displayed. | ||
![]() | ButtonImageOnly | Set to true to place an image after the field to use as the trigger without it appearing on a button. | ||
![]() | ButtonText | The text to display on the trigger button. Use in conjunction with showOn equal to 'button' or 'both'. | ||
![]() | CGJSContainer | Represents property | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | ClassData | Represents property | ||
![]() | CloseText | The text to display for the close link. This attribute is one of the Regionalisation attributes. Use the showButtonPanel to display this button. | ||
![]() | ConstrainInput | When true entry in the input field is constrained to those characters allowed by the current dateFormat. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | DatePicker | Represents property | ||
![]() | DateSep | Date separator (/- etc) | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | Disabled | Disables (true) or enables (false) the datepicker. Can be set when initialising (first creating) the datepicker | ||
![]() | DisabledDays | Disable days | ||
![]() | DisplayInline | Display the datepicker embedded in the page instead of in an overlay. | ||
![]() | DisplayInlineStretch | If true and DisplayInline = True, will stretch (width) the datepicker in container, ie, respecting the property Width.
| ||
![]() | DisplayInlineVertically | When true, the months will appear vertically.
| ||
![]() | Duration | 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"). | ||
![]() | FirstDay | Set the first day of the week: Sunday is 0, Monday is 1, ... This attribute is one of the Regionalisation attributes. | ||
![]() | GoToCurrent | When true the current day link moves to the currently selected date instead of today. | ||
![]() | 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 | ||
![]() | InstList | Represents property | ||
![]() | IsRTL | True if the current language is drawn from right to left. This attribute is one of the Regionalisation attributes. | ||
![]() | IsStored | Represents property | ||
![]() | JSDateFormat | Represents property | ||
![]() | JSon | Return the Interface of SuperObject (ISuperObject) (Inherited from TIWCGJSon.) | ||
![]() | JSonEvents[string] | Represents property | ||
![]() | List | Represents property | ||
![]() | MaxDate | Set a maximum selectable 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 +1w'), or null for no limit. | ||
![]() | MemberList | Represents property | ||
![]() | MinDate | Set a minimum selectable 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. '-1y -1m'), or null for no limit. | ||
![]() | MonthNames | The list of full month names, for use as requested via the dateFormat setting. This attribute is one of the Regionalisation attributes | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | OnBeforeShow | Can be a function that takes an input field and current datepicker instance and returns an options object to update the datepicker with. It is called just before the datepicker is displayed. | ||
![]() | OnBeforeShowDay | The function takes a date as a parameter and must return an array with [0] equal to true/false indicating whether or not this date is selectable, [1] equal to a CSS class name(s) or '' for the default presentation, and [2] an optional popup tooltip for this date. It is called for each day in the datepicker before it is displayed. | ||
![]() | OnCalculateWeek | 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. | ||
![]() | OnChangeMonthYear | Allows you to define your own event when the datepicker moves to a new month and/or year. The function receives the selected year, month (1-12), and the datepicker instance as parameters. this refers to the associated input field. | ||
![]() | OnClose | Allows you to define your own event when the datepicker is closed, whether or not a date is selected. The function receives the selected date as text ('' if none) and the datepicker instance as parameters. this refers to the associated input field. | ||
![]() | OnCreate | This event is triggered when datepicker is created. | ||
![]() | OnSelect | onSelectfunction(dateText, inst) Allows you to define your own event when the datepicker is selected. The function receives the selected date as text and the datepicker instance as parameters. this refers to the associated input field. | ||
![]() | Owner | Represents property | ||
![]() | 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. | ||
![]() | PropCount | Represents property | ||
![]() | PropIndexByName[string] | Represents property | ||
![]() | PropList | Represents property | ||
![]() | PropName | Represents property | ||
![]() | PropNameByIndex[Integer] | Represents property | ||
![]() | Regional | Regional settings for datepicker(dporDefault,dporAfrikaans,dporAlbanian, dporAlgerianArabic, dporArabic, dporArmenian, dporAzerbaijani, dporBasque, dporBosnian, dporBulgarian, dporCatalan, dporChineseHongKong, dporChineseSimplified, dporChineseTraditional, dporCroatian, dporCzech, dporDanish, dporDutchBelgium, dporDutchNederlands, dporEnglishAustralia, dporEnglishNewZealand, dporEnglishUK, dporEsperanto, dporEstonian, dporFaroese, dporFarsiPersian, dporFinnish, dporFrench, dporFrenchSwiss, dporGalician, dporGerman, dporGreek, dporHebrew, dporHindi, dporHungarian, dporIcelandic, dporIndonesian, dporItalian, dporJapanese, dporKazakhstan, dporKhmer, dporKorean, dporLatvian, dporLithuanian, dporLuxembourgish, dporMacedonian, dporMalayalam, dporMalaysian, dporNorwegian, dporPolish, dporPortuguese, dporPortugueseBrazilian, dporRhaetoRomanic, dporRomanian, dporRussian, dporSerbian, dporSlovak, dporSlovenian, dporSpanish, dporSwedish, dporTamil, dporThai, dporTajikistan, dporTurkish, dporUkranian, dporVietnamese, dporWelshUK, dporGeorgia); | ||
![]() | SelectOtherMonths | When true days in other months shown before or after the current month are selectable. This only applies if showOtherMonths is also true. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | ShowButtonPanel | Whether to show the button panel. | ||
![]() | ShowCurrentAtPos | Specify where in a multi-month display the current month shows, starting from 0 at the top/left | ||
![]() | ShowMonthAfterYear | Whether to show the month after the year in the header. This attribute is one of the Regionalisation attributes. | ||
![]() | 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'). | ||
![]() | ShowOptions | If using one of the jQuery UI effects for showAnim | ||
![]() | ShowOtherMonths | Display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use selectOtherMonths. | ||
![]() | ShowPopUpOnReadOnly | Hide/Show the datepicker popup when input is readonly. | ||
![]() | 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. | ||
![]() | SObj | Represents property | ||
![]() | StepBigMonths | Use stepBigMonths to set the number of months to move for previous/next links to scroll by year (by default) using showBigPrevNext setting | ||
![]() | StepMonths | Set how many months to move when clicking the Previous/Next links. | ||
![]() | 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. | ||
![]() | 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. | ||
![]() | YearSuffix | Additional text to display after the year in the month headers. This attribute is one of the Regionalisation attributes. |
Name | Description | |||
---|---|---|---|---|
![]() | AddBooleanMember(string,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddColorMember(string,TIWCGColor,Boolean,Boolean) | Represents method | ||
![]() | AddCurrencyMember(string,Currency,Boolean,Boolean) | Represents method | ||
![]() | AddDoubleMember(string,Double,Boolean,Boolean) | Represents method | ||
![]() | AddDynObjListMember(string,Boolean,Boolean) | Represents method | ||
![]() | AddEnumMember(string,string[],Byte,Boolean,Boolean) | Represents method | ||
![]() | AddEnumSetMember(string,string[],Void,Word,Boolean,Boolean) | Represents method | ||
![]() | AddFuncMember(string,string,string,Boolean,TIWCGJSonFuncClass,Boolean,Boolean) | Represents method | ||
![]() | AddHTML5(TIWHTMLTag) | Represents method | ||
![]() | AddIntegerMember(string,Integer,Boolean,Boolean) | Represents method | ||
![]() | AddJSonMember(string,TCGJSon,Boolean,Boolean) | Represents method | ||
![]() | AddMembers | The procedure add jquery properties.
| ||
![]() | AddObjListMember(string,TIWCGJSonListClass,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddObjMember(string,TIWCGJSonClass,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddSimpleArrayMember(string,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddStringMember(string,string,Boolean,Boolean) | Represents method | ||
![]() | AddVariantMember(string,Variant,Boolean,Boolean) | Represents method | ||
![]() | AfterConstruction | Represents method | ||
![]() | Assign(TPersistent) | Represents method | ||
![]() | CheckJSonMember(Integer) | Represents method | ||
![]() | ConvertEnumToString(string) | Represents method | ||
![]() | ConvertSetToString(string,TCGStringArray) | Represents method | ||
![]() | Disable | Disable the datepicker. | ||
![]() | Enable | Enable the datepicker | ||
![]() | FreeJSonObj(Integer) | Overloaded. Represents method | ||
![]() | FreeJSonObj(string) | Overloaded. Represents method | ||
![]() | GetBooleanValue(Integer) | Represents method | ||
![]() | GetCGJSContainer | Represents method | ||
![]() | GetColorValue(Integer) | Represents method | ||
![]() | GetCurrencyValue(Integer) | Represents method | ||
![]() | GetCustomJq(string,ISuperObject) | Represents method | ||
![]() | GetDoubleValue(Integer) | Represents method | ||
![]() | GetDynObjListValue(Integer) | Represents method | ||
![]() | GetEnumAsString(Integer) | Represents method | ||
![]() | GetEnumerValue(Integer) | Represents method | ||
![]() | GetEnumSetValue(Integer,Pointer) | Represents method | ||
![]() | GetFixedScript(TIWCGJSonFunc,Boolean) | Represents method | ||
![]() | GetFormatSettings | Represents method | ||
![]() | GetFuncValue(Integer) | Represents method | ||
![]() | GetHTMLName | Represents method | ||
![]() | GetImplComponent | Represents method | ||
![]() | GetIntegerValue(Integer) | Represents method | ||
![]() | GetIsStored | Represents method | ||
![]() | GetItemIndex | Represents method | ||
![]() | GetIWCLName | Represents method | ||
![]() | GetJSon | Represents method | ||
![]() | GetJSonByType(Boolean,Boolean) | Represents method | ||
![]() | GetJSonEx(Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
![]() | GetJSonValue(Integer) | Represents method | ||
![]() | GetJSonValueObj(Integer) | Represents method | ||
![]() | GetMemberJSon(TCGJSonMember,ISuperObject,Boolean,Boolean,string) | Represents method | ||
![]() | GetMemberSetterHandler(TObject,TCGJSonMember) | Represents method | ||
![]() | GetMemberSetterScriptParts(TIWCGResponseMemberList,TIWCGJScript) | Represents method | ||
![]() | GetMembersJSon(TIWCGResponseMemberList,Boolean,Boolean) | Represents method | ||
![]() | GetObjListValue(Integer) | Represents method | ||
![]() | GetObjValue(Integer) | Represents method | ||
![]() | GetOwner | Represents method | ||
![]() | GetPropName | Represents method | ||
![]() | GetSimpleArrayValue(Integer) | Represents method | ||
![]() | GetStringValue(Integer) | Represents method | ||
![]() | GetVariantValue(Integer) | Represents method | ||
![]() | Hide | Close a previously opened datepicker. | ||
![]() | InternalGetJSon(TEachPropJSonProc,Boolean,Boolean,Void,Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
![]() ![]() | IsArray | Represents method | ||
![]() | IsBooleanStored(Integer) | Represents method | ||
![]() | IsColorStored(Integer) | Represents method | ||
![]() | IsCurrencyStored(Integer) | Represents method | ||
![]() | IsDoubleStored(Integer) | Represents method | ||
![]() | IsEnumerStored(Integer) | Represents method | ||
![]() | IsEnumSetStored(Integer) | Represents method | ||
![]() | IsFuncStored(Integer) | Represents method | ||
![]() | IsIntegerStored(Integer) | Represents method | ||
![]() | IsJSonObjStored(string) | Represents method | ||
![]() | IsJSonStored(Integer) | Represents method | ||
![]() | IsObjStored(Integer) | Represents method | ||
![]() | IsStringStored(Integer) | Represents method | ||
![]() | IsVariantStored(Integer) | Represents method | ||
![]() | jsDisable | Returns the JavaScript code to disable datepicker | ||
![]() | jsEnable | Returns the JavaScript code to enable datepicker | ||
![]() | jsGetDate | Returns JavaSript code of the current date for the datepicker or null if no date has been selected. | ||
![]() | jsHide | Returns JavaSript code to determine whether a datepicker has been disabled. | ||
![]() | jsIsDisabled | Returns JavaSript code to determine whether a datepicker has been disabled. | ||
![]() ![]() | JSonEscape | Represents method | ||
![]() ![]() | JSonIdent | Represents method | ||
![]() ![]() | JSonNameQuote | Represents method | ||
![]() | jsRefresh | Returns JavaSript code to refresh datepicker | ||
![]() | jsSetDate(string) | Returns JavaSript code to SetDate | ||
![]() | jsShow | Returns JavaSript code to show datepicker | ||
![]() | jsWidget | Returns the .ui-datepicker element. | ||
![]() | Refresh | Redraw a date picker, after having made some external modifications. | ||
![]() | RegionalJSFile | Represents method | ||
![]() | ResetProps | Represents method | ||
![]() | SetBooleanValue(Integer,Boolean) | Represents method | ||
![]() | SetColorValue(Integer,TIWCGColor) | Represents method | ||
![]() | SetCurrencyValue(Integer,Currency) | Represents method | ||
![]() | SetDate(string) | Sets the current date for the datepicker. The new date must be a string in the current date format (e.g. '01/26/2009') | ||
![]() | SetDoubleValue(Integer,Double) | Represents method | ||
![]() | SetDynObjListValue(Integer,TIWCGJSonDynObjList) | Represents method | ||
![]() | SetEnumerValue(Integer,Byte) | Represents method | ||
![]() | SetEnumSetValue(Integer,Pointer) | Represents method | ||
![]() | SetFuncValue(Integer,TIWCGJSonFunc) | Represents method | ||
![]() | SetIntegerValue(Integer,Integer) | Represents method | ||
![]() | SetJSonValue(Integer,TCGJSon) | Represents method | ||
![]() | SetObjListValue(Integer,TIWCGJSonList) | Represents method | ||
![]() | SetObjValue(Integer,TIWCGJSon) | Represents method | ||
![]() | SetSimpleArrayValue(Integer,TIWCGJSonSimpleArray) | Represents method | ||
![]() | SetStringValue(Integer,string) | Represents method | ||
![]() | SetVariantValue(Integer,Variant) | Represents method | ||
![]() | Show | Call up a previously attached datepicker. If the datepicker is attached to an input, the input must be visible for the datepicker to be shown. | ||
![]() | StoreProperty(PPropInfo,TObject) | Represents method | ||
![]() | SupportsSetter(TObject,TCGJSonMember) | Represents method |