new Calendar(client, oOptionsopt)
Every option of the Calendar.Options type has associated a property of the control. For instance, the option:
cursors {string}, specifies the mouse cursor to be displayed when pointing over a part of the controlis associated with the property:
Cursors {string}, specifies the mouse cursor to be displayed when pointing over a part of the controlwhich means that the following statements are equivalent:
oCalendar.Options = {cursors: "pointer(d,p,n)"}where oCalendar is an object of Calendar type
oCalendar.SetOptions({cursors: "pointer(d,p,n)"})
oCalendar.Cursors = "pointer(d,p,n)"
oCalendar.SetCursors("pointer(d,p,n)")
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
client |
any | The client parameter indicates the control's client area as:
|
|
oOptions |
object |
<optional> |
An object of Calendar.Options type that defines different options to display the control. |
Requires:
- module:exontrol.commmon.min.js
- module:exontrol.icalendar.min.js
Requires
- module:exontrol.commmon.min.js
- module:exontrol.icalendar.min.js
Classes
Members
(static, readonly) AutoSizeEnum :number
Each AutoSizeEnum property can be specified in one of the following ways:
- A numeric value.
- A single enumeration constant.
- A case-insensitive partial string containing the name that matches the enumeration constant.
For instance, the string "fitclient" is equivalent to the numeric value 1, or to the enumeration constant exFitClient.
Type:
- number
Properties:
| Name | value | Type | Description |
|---|---|---|---|
exFontSize |
-1 |
number | The exFontSize value indicates that the size of the calendar's date is automatically computed based on the current font. |
exFixedSize |
0 |
number | The exFixedSize value specifies that the size of the calendar's date is fixed. The dayFixedWidth / dayFixedHeight specifies the size of the calendar's date while autoSize property is Calendar.AutoSizeEnum.exFixedSize. |
exFitClient |
1 |
number | The exFitClient value indicates that the size of the calendar's date is computed so entire calendar fits the control's client area |
(static, readonly) CollectEnum :number
Each CollectEnum property can be specified in one of the following ways:
- A numeric value.
- A single enumeration constant.
- A case-insensitive partial string containing the name that matches the enumeration constant.
For instance, the string "weekday" is equivalent to the numeric value 4, or to the enumeration constant exWeekDay.
Type:
- number
Properties:
| Name | value | Type | Description |
|---|---|---|---|
exContinue |
0 |
number | The exContinue type specifies that the Collect() method collects dates from current to target date. |
exMonth |
1 |
number | The exMonth type specifies that the Collect() method collects months between current and target date. |
exWeek |
2 |
number | The exWeek type specifies that the Collect() method collects weeks between current and target date (in the same month). |
exWeekAll |
3 |
number | The exWeek type specifies that the Collect() method collects weeks between current and target date. |
exWeekDay |
4 |
number | The exWeekDay type specifies that the Collect() method collects week-days between current and target date. |
(static, readonly) FlowEnum :number
Each FlowEnum property can be specified in one of the following ways:
- A numeric value.
- A single enumeration constant.
- A case-insensitive partial string containing the name that matches the enumeration constant.
For instance, the string "top" is equivalent to the numeric value 1, or to the enumeration constant exTopToBottom.
Type:
- number
Properties:
| Name | value | Type | Description |
|---|---|---|---|
exLeftToRight |
0 |
number | The exLeftToRight mode indicates that the next month gets arranged to the right of the current month. |
exTopToBottom |
1 |
number | The exTopToBottom mode indicates that the next month gets arranged to the bottom of the current month. |
(static, readonly) ModeEnum :number
Each ModeEnum property can be specified in one of the following ways:
- A numeric value.
- A single enumeration constant.
- A case-insensitive partial string containing the name that matches the enumeration constant.
For instance, the string "horizontal" is equivalent to the numeric value 1, or to the enumeration constant exHorizontal.
Type:
- number
Properties:
| Name | value | Type | Description |
|---|---|---|---|
exVertical |
0 |
number | The exVertical mode specifies that the days of the week are vertically arranged. |
exHorizontal |
1 |
number | The exHorizontal mode specifies that the days of the week are horizontally arranged. |
(static, readonly) SingleSelEnum :number
Each SingleSelEnum property can be specified in one of the following ways:
- A numeric value.
- A single enumeration constant.
- A combination of one or more compatible enumeration constants, separated by the | operator.
- A case-insensitive partial string containing one or more comma-separated names that match the enumeration constants.
For instance, the string "single,toggle,drag" is equivalent to the numeric value 38, or to the combination of enumeration constants exSingleSel | exToggleSel | exDisableDrag.
Type:
- number
Properties:
| Name | value | Type | Description |
|---|---|---|---|
exDisableSel |
0 |
number | The exDisableSel value specifies that the control's selection is disabled. |
exEnableSel |
1 |
number | The exEnableSel flag specifies that the control's selection is enabled (multiple-selection, unless the exSingleSel is set ). |
exSingleSel |
2 |
number | The exSingleSel flag specifies that the user can select a date only. |
exToggleSel |
4 |
number | The exToggleSel flag specifies that the date's selection state is toggled once the user clicks a date. |
exDisableCtrlSel |
8 |
number | The exDisableCtrlSel flag disables toggling the date's selection state when user clicks a date, while CTRL modifier key is pressed. |
exDisableShiftSel |
16 |
number | The exDisableShiftSel flag disables selecting dates using the SHIFT key. |
exDisableDrag |
32 |
number | The exDisableDrag flag disables selecting dates by drag. |
(static, readonly) type :string
Type:
- string
- Since:
- 1.8
Example
console.log(exontrol.Calendar.type); // logs "Calendar"
(static, readonly) version :string
Type:
- string
Example
console.log(exontrol.Calendar.version); // displays the version of the control, for instance "5.2"
AlignCal :exontrol.AlignEnum
The exontrol.AlignEnum type supports the following values:
- exAlignTop (0x00), justifies the object to the top of the rectangle
- exAlignLeft (0x00), aligns object to the left
- exAlignCenter (0x01), centers object horizontally in the rectangle
- exAlignRight (0x02), aligns object to the right
- exAlignVCenter (0x04), centers object vertically
- exAlignBottom (0x08), justifies the object to the bottom of the rectangle
Type:
- exontrol.AlignEnum
Example
0 or exontrol.AlignEnum.exAlignTop | exontrol.AlignEnum.exAlignLeft {number}, aligns the calendar to the top-left corner
5 or exontrol.AlignEnum.exAlignCenter | exontrol.AlignEnum.exAlignVCenter {number}, centers the calendar
AlignCal
AllowScrollByDrag :boolean
Type:
- boolean
Example
false {boolean}, disables scrolling the control by drag
true {boolean}, the user can scrolls the control by drag (click a month area where no dates is displayed and drag in any direction to get control scrolled)
AllowScrollByDrag
AllowSwitchView :boolean
It indicates whether the user can switch the view (month or year):
- false {boolean}, disables month or year view
- true {boolean}, enables month or year view
Type:
- boolean
Example
false {boolean}, disables month or year view
true {boolean}, enables month or year view
AllowSwitchView
AutoSize :Calendar.AutoSizeEnum
The Calendar.AutoSizeEnum type defines the following values:
- exFontSize(-1), indicates that the size of the calendar's date is automatically computed based on the current font
- exFixedSize(0), specifies that the size of the calendar's date is fixed. The dayFixedWidth / dayFixedHeight specifies the size of the calendar's date while autoSize property is Calendar.AutoSizeEnum.exFixedSize
- exFitClient(1), indicates that the size of the calendar's date is computed so entire calendar fits the control's client area
Type:
Example
-1 or Calendar.AutoSizeEnum.exFontSize {number}, defines the size of the calendar's date based on the current font.
1 or Calendar.AutoSizeEnum.exFitClient {number}, resizes the calendar's date to ensure all months fit the control's client area
AutoSize
Cursors :string
The format of the property is:
"cursor(part),cursor(part),..."where:
- "cursor", defines the CSS mouse cursor to display while cursor hovers the part
- "part", defines the name of the part the cursor is applied on (as defined bellow)
The "part" can be any of the following:
Cursor Description "alias" indicates a shortcut or alias will be created "all-scroll" indicates scrolling in any direction "auto" lets the browser decide the cursor based on context "cell" indicates a table cell "col-resize" indicates a column can be resized horizontally "context-menu" indicates a context menu is available "copy" indicates something will be copied "crosshair" a precise crosshair cursor "default" the default arrow cursor "e-resize" resize east (right edge) "ew-resize" resize horizontally "grab" indicates an item can be grabbed "grabbing" indicates an item is being grabbed "help" indicates help information is available "move" indicates something can be moved "n-resize" resize north (top edge) "ne-resize" resize northeast (top-right corner) "nesw-resize" resize along the northeast–southwest axis "no-drop" indicates dropping is not permitted "not-allowed" indicates the action is not allowed "ns-resize" resize vertically "nw-resize" resize northwest (top-left corner) "nwse-resize" resize along the northwest–southeast axis "pointer" the pointer cursor (a hand with a pointing finger) "progress" indicates background processing "row-resize" indicates a row can be resized vertically "s-resize" resize south (bottom edge) "se-resize" resize southeast (bottom-right corner) "sw-resize" resize southwest (bottom-left corner) "text" the text selection cursor (I-beam) "url(...)" uses a custom cursor image (with optional fallback) "vertical-text" the vertical text selection cursor "w-resize" resize west (left edge) "wait" indicates the program is busy "zoom-in" indicates zooming in "zoom-out" indicates zooming out
The following parts are available while the control displays the day-view:
Part Description "p" (prev) defines the prev button (available for any view) "n" (next) defines the next button (available for any view) "anchor" (hyperlink) defines the mouse-cursor when the mouse pointer hovers the anchor (the <a> ex-HTML part marks an anchor or hyperlink element) (@since 2.2)
The following parts are available while the control displays the month-view:
Part Description "da" (day-all) indicates all objects of the month "dmh" (day-month-header) object that indicates the header that displays the month "dm" (days-month) specifies all days displayed in the current month (it can include also non-month days as well) "d" (day) specifies a day of the current month "dnm" (day-non-month) specifies a day that is not part of the current month, but it is still displayed "dt" (today) specifies today in the current month "ds" (day-select) indicates a selected date "de" (week-end) specifies a day of weekend "dwa" (day-weeks-all) indicates the top-left corner object, when the week-header and week-number headers are visible "dwh" (day-week-header) indicates the header that shows the days of the week "dw" (day-week) specifies a day into the week-header "dwnh" (day-week-number-header) indicates the header that displays the week-numbers "dwn" (day-week-number) specifies the week-number "dwnn" (day-week-number-non-month) specifies the week-number that is not part of the current month
The following parts are available while the control displays the year-view:
Part Description "ma" (month-all) specifies the area to display the entire year "mh" (month-header) indicates the header for month-view (it displays the year) "mm" (month-month) indicates the portion of the layout that displays the months of the year (excludes its header) "m" (month) specifies a single month within the month-view "mt" (month-today) indicates the current month (the month that contains today) "ms" (month-select) indicates a month that contains a selected date
Part Description "ya" (year-all) specifies the area to display the entire layout "yh" (year-header) indicates the header for year-view (it displays the range of years) "yy" (year-years) indicates the portion of the layout that displays the years (excludes its header) "y" (year) specifies a single year within the year-view "yt" (year-today) specifies the year of today "ys" (year-select) indicates a year that contains a selected date
Type:
- string
Example
"" {string}, no mouse cursor support
"pointer(d,p,n)" {string}, indicates that the "pointer" mouse cursor is shown once the cursor hovers the "d", "p" or "n" parts of the control
Cursors
Date :string
Type:
- string
Example
null {null}, browses today date
"#12/31/1971#" {string}, browses December 31, 1971
Date
DayAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
DayAlign
DayFixedHeight :number
Type:
- number
Example
24 {number}, defines the date's height to 24-pixels
DayFixedHeight
DayFixedWidth :number
Type:
- number
Example
24 {number}, defines the date's width to 24-pixels
DayFixedWidth
DayLabel :string
The DayLabel property can include any of the following fields:
Also, DayLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"<%d%>" {string}, displays the day of the month in one or two numeric digits, as needed (1 to 31),
"<%dd%>" {string}, displays day of the month in two numeric digits (01 to 31)
"<%d%>\n<font ;8><fgcolor gray><%y%></fgcolor>" {string}, displays the day of the month in one or two numeric digits, as needed (1 to 31) on the first line, and on the second line displays the number of the day of the year (1 to 366) in gray
DayLabel
DayMonthAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
DayMonthAlign
DayMonthHeader :boolean
Type:
- boolean
Example
false {boolean}, hides the calendar's header (month's name)
true {boolean}, shows the calendar's header (month's name)
DayMonthHeader
DayMonthLabel :string
The DayMonthLabel property can include any of the following fields:
Also, DayMonthLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%mmm%>" {string}, displays three-letters of the month
"<%mmmm%> <%yyyy%>" {string}, displays the full month and year
"<b><%mmm%></b><r><fgcolor gray><font ;8><off 6><%yyyy%>" {string}, displays an combined ex-HTML format
DayMonthLabel
DayNonMonth :number
Type:
- number
Example
false {boolean}, hides the dates that are not part of the current month.
true {boolean}, shows the dates that are not part of the current month.
DayNonMonth
DayNonMonthLabel :string
The DayNonMonthLabel property can include any of the following fields:
Also, DayNonMonthLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%d%>" {string}, displays the day of the month in one or two numeric digits, as needed (1 to 31)
"<fgcolor lightgray><%d%></fgcolor>" {string}, displays the day of the month in one or two numeric digits, as needed (1 to 31) in gray
DayNonMonthLabel
DayWeekAllLabel :string
The DayWeekAllLabel property can include any of the following fields:
Also, DayWeekAllLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<b><%mr%>" {string}, displays month of the year in Roman numerals, as needed (I to XII) in bold
DayWeekAllLabel
DayWeekHeader :boolean
Type:
- boolean
Example
false {boolean}, hides the header that displays the days of the week (day-view only).
true {boolean}, shows the header that displays the days of the week (day-view only).
DayWeekHeader
DayWeekLabel :string
The DayWeekLabel property can include any of the following fields:
Also, DayWeekLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%d2%>" {string}, displays first two letters of the weekday (Su to Sa)
"<b><%d3%></b>" {string}, displays first thee letters of the weekday (Sun to Sat) in bold
DayWeekLabel
DayWeekNoHeader :boolean
Type:
- boolean
Example
false {boolean}, hides the calendar's header that displays the week-number
true {boolean}, shows the calendar's header that displays the week-number
DayWeekNoHeader
DayWeekNoLabel :string
The DayWeekNoLabel property can include any of the following fields:
Also, DayWeekNoLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%ww%>" {string}, displays the week of the year (1 to 53)
"<fgcolor red><%ww%></fgcolor>" {string}, displays the week of the year (1 to 53) in red
DayWeekNoLabel
Events :array|object
- {array(any)}, defines multiple events, with specified options, as an array of [{EventOptions}] type
- {object}, defines multiple events, where each property(key) of the object defines the event with its options, of EventOptions type
Type:
- array | object
Example
Events = [{date: "#1/1/2001#", shape: "red"}], {array} defines a single event
Events =
{
"E1":
{
date: "#1/1/2001#",
shape: "rgba(255,0,0,0.5)"
},
"E2":
{
date: "#1/1/2001#",
shape: "rgba(255,255,0,0.5)"
}
}, {object} defines two events "E1" and "E2"
Events
Flow :Calendar.FlowEnum
The Calendar.FlowEnum type supports the following values:
- exLeftToRight(0), indicates that the next month gets arranged to the right of the current month
- exTopToBottom(1), indicates that the next month gets arranged to the bottom of the current month
Type:
Example
0 or Calendar.FlowEnum.exLeftToRight {number}, arranges months from left to right
1 or Calendar.FlowEnum.exTopToBottom {number}, arranges months from top to bottom
Flow
HlShapes :string
The format of the property is:
"shape(part),shape(part),..."where:
- "shape", indicates the name of the sub-object within the exontrol.Shapes.Calendar or exontrol.Shapes namespace to be applied on the part (also it can be a CSS color or a JSON string-representation of a {normal,disabled,hover,click} or exontrol.Def.Shape object),
- "part", defines the name of the part the shape is applied on (as defined bellow)
The following parts are available while the control displays the day-view:
Part Description "n" (next) defines the next button (available for any view) "p" (prev) defines the prev button (available for any view)
The following parts are available while the control displays the month-view:
Part Description "d" (day) specifies a day of the current month "da" (day-all) indicates all objects of the month "de" (week-end) specifies a day of weekend "dm" (days-month) specifies all days displayed in the current month (it can include also non-month days as well) "dmh" (day-month-header) object that indicates the header that displays the month "dnm" (day-non-month) specifies a day that is not part of the current month, but it is still displayed "ds" (day-select) indicates a selected date "dt" (today) specifies today in the current month "dw" (day-week) specifies a day into the week-header "dwa" (day-weeks-all) indicates the top-left corner object, when the week-header and week-number headers are visible "dwh" (day-week-header) indicates the header that shows the days of the week "dwn" (day-week-number) specifies the week-number "dwnh" (day-week-number-header) indicates the header that displays the week-numbers "dwnn" (day-week-number-non-month) specifies the week-number that is not part of the current month
The following parts are available while the control displays the year-view:
Part Description "m" (month) specifies a single month within the month-view "ma" (month-all) specifies the area to display the entire year "mh" (month-header) indicates the header for month-view (it displays the year) "mm" (month-month) indicates the portion of the layout that displays the months of the year (excludes its header) "ms" (month-select) indicates a month that contains a selected date "mt" (month-today) indicates the current month (the month that contains today)
Part Description "y" (year) that specifies a single year within the year-view "ya" (year-all) that specifies the area to display the entire layout "yh" (year-header) that indicates the header for year-view (it displays the range of years) "yy" (year-years) that indicates the portion of the layout that displays the years (excludes its header) "ys" (year-select) indicates a year that contains a selected date "yt" (year-today) specifies the year of today
Type:
- string
Example
"" {string}, no shape (no visual appearance is applied to any part of the control)
"star(d,dnm,dwa)" {string}, indicates that a exontrol.Shapes.Calendar.star object is applied on "d", "dnm" and "dwa" parts of the control.
"xxx(d),yyy(d,m),zzz(y)" {string}, specifies that the exontrol.Shapes.Calendar.xxx combined with exontrol.Shapes.Calendar.yyy object defines the visual appearance of "d" part of the control, exontrol.Shapes.RadialMenu.yyy object defines the visual appearance of "m" part of the control and exontrol.Shapes.RadialMenu.zzz object defines the visual appearance of "y" part of the control
HlShapes
Layout :string
Type:
- string
Example
The following statements are equivalents:
oCalendar.Layout = sLayout, sets the control's layout
oCalendar.SetLayout( sLayout ), sets the control's layout
sLayout = oCalendar.Layout, gets the control's layout
sLayout = oCalendar.GetLayout(), gets the control's layout
where oCalendar is an object of Calendar type
Layout
Listeners :exontrol.Lts
Type:
- exontrol.Lts
Example
The following sample shows how you can get all events the component currently supports:
oCalendar.Listeners.forEach(function(name)
{
console.log(name);
});
The following sample displays selected dates once the selection is changed:
oCalendar.Listeners.Add("onselchange", function (oEvent)
{
console.log(oEvent);
});
where oCalendar is an object of Calendar type
Listeners
Locale :string
For example:
- When the Locale property is set to "de" (German), month names are displayed as "Januar", "Februar", and so on.
- When the Locale property is set to "en-US" (U.S. English), month names appear as "January", "February", etc.
By default, the Locale property is null, meaning the browser's UI language determines the calendar formatting.
Type:
- string
Example
null {null}, indicates that the browser's UI language is used.
"de" {string}, defines German locale
"ro" {string}, defines Romanian locale
Locale
Locked :boolean
Type:
- boolean
Example
false {boolean}, unlocks the control (can select any date)
true {boolean}, locks the control (can't select any date)
Locked
MaxMonthX :number
Type:
- number
Example
6 {number}, indicates that the calendar displays maximum six months.
MaxMonthX
MaxMonthY :number
Type:
- number
Example
6 {number}, indicates that the calendar displays maximum six months.
MaxMonthY
MinMonthX :number
Type:
- number
Example
2 {number}, indicates that the calendar displays minimum two months
MinMonthX
MinMonthY :number
Type:
- number
Example
2 {number}, indicates that the calendar displays minimum two months
MinMonthY
Mode :Calendar.ModeEnum
The Calendar.ModeEnum type supports the following values:
- exVertical(0), specifies that the days of the week are vertically arranged
- exHorizontal(1), specifies that the days of the week are horizontally arranged
Type:
Example
0 or Calendar.ModeEnum.exVertical {number}, shows vertically the week days
1 or Calendar.ModeEnum.exHorizontal {number}, shows horizontally the week days
Mode
MonthAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
MonthAlign
MonthLabel :string
The MonthLabel property can include any of the following fields:
Also, MonthLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%mmm%>" {string}, displays first three letters of the month (Jan to Dec)
MonthLabel
MonthYearAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
MonthYearAlign
Options :string
Each field within the options object is applied internally by invoking the corresponding Set... method of the control. For instance, updating the locale field automatically triggers the SetLocale() method, which updates the calendar's regional settings accordingly.
This ensures that any change made through the options object is immediately reflected in the control, keeping its configuration consistent and synchronized.
Type:
- string
Example
{locale: "de"}, {object} changes the calendar's locale to German
{selectable: "not(weekday(value) in (0,6))"}, {object} makes all dates selectable except Sundays and Saturdays
Options
Pad :number|string|Array.<number>
Type:
- number | string | Array.<number>
Example
null {null}, indicates that the default-padding field is used ([4,2])
0 {number}, indicates no padding
"8,4" {string}, increases the object's width with 2 * 8-pixels and object's height with 2 * 4-pixels
[8,4] {array}, increases the object's width with 2 * 8-pixels and object's height with 2 * 4-pixels
Pad
PadCal :number|string|Array.<number>
Type:
- number | string | Array.<number>
Example
null {null}, indicates that the default-padding field is used (4)
0 {number}, indicates no padding
"8,4" {string}, increases the object's width with 2 * 8-pixels and object's height with 2 * 4-pixels
[8,4] {array}, increases the object's width with 2 * 8-pixels and object's height with 2 * 4-pixels
PadCal
ReadOnly :boolean
Type:
- boolean
- Since:
- 1.8
Example
false {boolean}, the user can select new dates
true {boolean}, the user can not select dates
ReadOnly
Selectable :string
- value {Date}, defines the date being checked
- eventuserdata {any}, defines the UserData property of events added through Events.Add
- isevent {boolean}, indicates if the date being checked has an event added through Events.Add
- the selectable expression is invalid or returns false
- the date has an event added through Events.Add and the Event.Selectable event returns false
Type:
- string
- Since:
- 4.8
Example
"0" {string}, no dates is selectable
"not(weekday(value) in (0,6))" {string}, all dates are selectable except Sundays and Saturdays
"not(isevent)" {string}, all dates are selectable except those that have an event added through Events.Add
"eventuserdata = `holiday`" {string}, only dates that have an event added through Events.Add, with UserData equal to "holiday", are selectable
"year(value) = 2020" or "value >= #1/1/2020# and value <= #12/31/2020#" {string}, only dates within the year 2020 are selectable
Selectable
Selection :any
It Indicates the control's selection, as one of the following:
- {null}, clears the control's selection
- {string}, defines the date to select in string-format as "#MM/DD/YYYY[ HH:mm:ss]#" or string-format as "YYYY-MM-DDTHH:mm:ss.sssZ" (ISO 8601), such as "2011-10-10" (date-only format), "2011-10-10T14:48:00" (local date-time format), "2011-10-10T14:48:00Z" (UTC date-time format), or "2011-10-10T14:48:00.000+09:00" (date-time format with milliseconds and time zone offset) (since 1.3)
- {number}, integer value representing the year of the date to be selected. For instance, 2022 goes for "Jan 1st, 2022"
- {Date}, indicates a JavaScript date to be selected
- {array}, indicates a collection of dates to be selected, as an array of [date] type, where date could be null, string, number or a Date expression
Type:
- any
Example
null {null}, clears the control's selection
[null] {array}, selects today
"#1/15/2022#" or "2022-1-15" {string}, selects the specified date
2022 {number}, selects "Jan 1st, 2022"
Date.Today().NextDay(1) {Date}, selects tomorrow
Calendar.Collect(Date.Today(), null, Calendar.CollectEnum.exWeek) {Date}, selects the current week (in case the control allows multiple selection, else it selects the first day of the current week)
[null,Date.Today().NextDay(1)] {array}, selects today and tommorow date
["#1/13/2022#","#1/15/2022#"] {array}, selects Jan 13 and 15 of 2022
Selection
Shapes :string
The format of the property is:
"shape(part),shape(part),..."where:
- "shape", defines the shape to apply on the UI part as one of the following:
◦ any of 140 color names any browser supports (such as red, blue, green, ...)
◦ hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF (such as #0000ff which defines a blue background)
◦ hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF (such as #0000ff80 which defines a semi-transparent blue background)
◦ RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255( such as rgb(0,0,255) that defines a blue background)
◦ RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) ( such as rgba(0,0,255,0.5) which defines a semi-transparent blue background)
◦ HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors (such as hsl(240, 100%, 50%) that defines a blue background)
◦ HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) (such as hsla(240, 100%, 50%,0.5) that defines a semi-transparent blue background)
◦ a JSON representation of the shape object to apply (while it starts with { character, such as '{"normal": {"primitive": "RoundRect","fillColor":"black","tfi": {"fgColor": "white"}}}')
◦ specifies the name of the field within the exontrol.Shapes.Calendar object (while it starts with a lowercase letter, such as today which refers to exontrol.Shapes.Calendar.today shape)
◦ specifies the name of the field within the exontrol.Shapes object (while it starts with an uppercase letter, such as Button which refers to exontrol.Shapes.Button shape)
- "part", defines the name of the part the shape is applied on (as defined bellow)
The following parts are available while the control displays the day-view:
Part Description "n" (next) defines the next button (available for any view) "p" (prev) defines the prev button (available for any view)
The following parts are available while the control displays the month-view:
Part Description "d" (day) specifies a day of the current month "da" (day-all) indicates all objects of the month "de" (week-end) specifies a day of weekend "dm" (days-month) specifies all days displayed in the current month (it can include also non-month days as well) "dmh" (day-month-header) object that indicates the header that displays the month "dnm" (day-non-month) specifies a day that is not part of the current month, but it is still displayed "ds" (day-select) indicates a selected date "dt" (today) specifies today in the current month "dw" (day-week) specifies a day into the week-header "dwa" (day-weeks-all) indicates the top-left corner object, when the week-header and week-number headers are visible "dwh" (day-week-header) indicates the header that shows the days of the week "dwn" (day-week-number) specifies the week-number "dwnh" (day-week-number-header) indicates the header that displays the week-numbers "dwnn" (day-week-number-non-month) specifies the week-number that is not part of the current month
The following parts are available while the control displays the year-view:
Part Description "m" (month) specifies a single month within the month-view "ma" (month-all) specifies the area to display the entire year "mh" (month-header) indicates the header for month-view (it displays the year) "mm" (month-month) indicates the portion of the layout that displays the months of the year (excludes its header) "ms" (month-select) indicates a month that contains a selected date "mt" (month-today) indicates the current month (the month that contains today)
Part Description "y" (year) that specifies a single year within the year-view "ya" (year-all) that specifies the area to display the entire layout "yh" (year-header) that indicates the header for year-view (it displays the range of years) "yy" (year-years) that indicates the portion of the layout that displays the years (excludes its header) "ys" (year-select) indicates a year that contains a selected date "yt" (year-today) specifies the year of today
Type:
- string
Example
null {null}, specifies the default visual appearance
"" {string}, no shape (no visual appearance is applied to any part of the control)
"red(dt)", "#FF0000(dt)", "rgb(255,0,0)(dt)", "rgba(255,0,0,1)(dt)" {string}, shows "today" in red
'{"normal":{"fillColor":"lightgray","primitive":"Circle"},"hover":{"frameColor":"black"}}(d)' {string}, shows all-days within a circle, and draws a black-frame when hovers it
"xxx(d),yyy(d,m),zzz(y)" {string}, specifies that the exontrol.Shapes.Calendar.xxx combined with exontrol.Shapes.Calendar.yyy object defines the visual appearance of "d" part of the control, exontrol.Shapes.Calendar.yyy object defines the visual appearance of "m" part of the control and exontrol.Shapes.Calendar.zzz object defines the visual appearance of "y" part of the control
Shapes
SingleSel :Calendar.SingleSelEnum
The Calendar.SingleSelEnum type supports the following flags:
- exDisableSel(0), specifies that the control's selection is disabled (can not be combined with any other flags)
- exEnableSel(1), specifies that the control's selection is enabled (multiple-selection, unless the exSingleSel is set )
- exSingleSel(2), specifies that the user can select a date only
- exToggleSel(4), specifies that the date's selection state is toggled once the user clicks a date.
- exDisableCtrlSel(8), disables toggling the date's selection state when user clicks a date, while CTRL modifier key is pressed.
- exDisableShiftSel(16), disables selecting dates using the SHIFT key.
- exDisableDrag(32), disables selecting dates by drag.
Type:
Example
0 or Calendar.SingleSelEnum.exDisableSel {number}, disables selecting any date
3 or Calendar.SingleSelEnum.exSingleSel | Calendar.SingleSelEnum.exEnableSel {number}, enables control's single selection, so only a single date can be selected
6 or Calendar.SingleSelEnum.exToggleSel | Calendar.SingleSelEnum.exSingleSel {number}, enables control's single and toggle selection, which means that once a date is selected it gets unselected once it is clicked, or reverse, and only a single-date can be selected at once.
SingleSel
SmoothScroll :number
Type:
- number
Example
0 {number}, no smooth changes once the control goes from a layout to another
250 {number}, specifies that a smooth-transition is performed from a layout to another for 250 ms.
SmoothScroll
SmoothSel :number
Type:
- number
Example
0 {number}, no smooth changes once the control goes from a layout to another
125 {number}, specifies that a smooth-transition is performed from a layout to another for 125 ms.
SmoothSel
Tfi :string|object
The Tfi property as string supports any of the following keywords (each keyword can be specified using first letters only such as "b" for "bold) separated by space characters:
- bold, displays the text in bold (equivalent of <b> tag)
- italic, displays the text in italics (equivalent of <i> tag)
- underline, underlines the text (equivalent of <u> tag)
- strikeout, specifies whether the text is strike-through (equivalent of <s> tag)
- <fontName name>, specifies the font's family (equivalent of <font name> tag)
- <fontSize size>, specifies the size of the font (equivalent of <font ;size> tag)
- <fgColor CSSColor>, specifies the text's foreground color (equivalent of <fgcolor> tag)
- <bgColor CSSColor>, specifies the text's background color (equivalent of <bgcolor> tag)
- <shaColor CSSColor;width;offset>, defines the text's shadow (equivalent of <sha color;width;offset> tag)
- <outColor CSSColor>, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- <graColor CSSColor;mode;blend>, defines a gradient text (equivalent of <gra color;mode;blend> tag)
Any other word within the Tfi property that's not recognized as a keyword is interpreted as:
- name of the font (not a number), specifies the font's family (equivalent of <font name> tag)
- size of the font (number), specifies the size of the font (equivalent of <font ;size> tag)
The Tfi property as object supports any of the following fields:
- bold {boolean}, displays the text in bold (equivalent of <b> tag)
- italic {boolean}, displays the text in italics (equivalent of <i> tag)
- underline {boolean}, underlines the text (equivalent of <u> tag)
- strikeout {boolean}, specifies whether the text is strike-through (equivalent of <s> tag)
- fontName {string}, specifies the font's family (equivalent of <font name> tag)
- fontSize {number}, specifies the size of the font (equivalent of <font ;size> tag)
- fgColor {string}, specifies the text's foreground color (CSScolor) (equivalent of <fgcolor> tag)
- bgColor {string}, specifies the text's background color (CSScolor) (equivalent of <bgcolor> tag)
- shaColor {object}, specifies an object of {color, width, offset} type that defines the text's shadow (equivalent of <sha color;width;offset> tag), where:
- color {string}, defines the color of the text's shadow (CSScolor)
- width {number}, defines the size of the text's shadow
- offset {number}, defines the offset to show the text's shadow relative to the text
- outColor {string}, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- graColor {object}, specifies an object of {color, mode, blend} type that defines a gradient text (equivalent of <gra color;mode;blend> tag), where:
- color {string}, defines the gradient-color (CSScolor)
- mode {number}, defines the gradient direction as 0 (left-right), 1 (default, top-bottom), 2 (left-center-right), and 3 (top-center-bottom)
- blend {number}, defines the gradient blend as a value between 0 and 1
CSSColor or CSS legal color values can be specified by the following methods:
- Hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF. For example, #0000ff value is rendered as blue, because the blue component is set to its highest value (ff) and the others are set to 00.
- Hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF. For example, #0000ff80 defines a semi-transparent blue.
- RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255. For example, rgb(0,0,255) defines the blue color.
- RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, rgba(0,0,255,0.5) defines a semi-transparent blue.
- HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors. For example, hsl(240, 100%, 50%) defines the blue color.
- HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, hsla(240, 100%, 50%,0.5) defines a semi-transparent blue.
- Predefined/Cross-browser color names, 140 color names are predefined in the HTML and CSS color specification. For example, blue defines the blue color.
Type:
- string | object
Example
null {null}, the Tfi property is ignored
"bold monospace 16 <fg blue>" {string}, defines Monospace font of 16px height, bold and blue
{bold: true, fontName: "monospace", fontSize: 16, fgColor: "blue"} {object}, defines Monospace font of 16px height, bold and blue
Tfi
ToolTipDelay :number
Type:
- number
Example
0 {number}, the tooltip is shown "immediately"
128 {number}, the tooltip is displayed in 128 ms.
ToolTipDelay
ToolTipPopDelay :number
The property supports the following values:
- 0 {number}, no tooltip is shown for any object (disabled)
- -1 {number}, the tooltip stays indefinitely (negative)
- positive {number}, the tooltip is visible for the specified number of milliseconds (for example, 1000 means that the tooltip is visible for 1 second)
By default, the tooltip remains visible for 5000 milliseconds.
Type:
- number
Example
0 {number}, no tooltip is shown for any object (disabled)
-1 {number}, the tooltip stays indefinitely (negative)
1000 {number}, the tooltip is visible for 1 second
ToolTipPopDelay
ToolTipWidth :number
0 {number}, no tooltip is shown for any object (disabled)The default value is -1.
-1 {number}, the tooltip's content is displayed on a single line (without limit the width of it)
300 {number}, the tooltip's max-width is 300 pixels
Type:
- number
Example
0 {number}, no tooltip is shown for any object (disabled)
-1 {number}, the tooltip's content is displayed on a single line (without limit the width of it)
300 {number}, the tooltip's max-width is 300 pixels
ToolTipWidth
WheelChange :number
- Setting wheelChange to 0 disables mouse wheel actions, preventing the control from changing when the wheel is scrolled
- Setting wheelChange to a positive number, such as 5, increases the control's value by that amount each time the wheel is rotated, enabling faster adjustments
By modifying this value, you can fine-tune the control's responsiveness, making it easier for users to perform precise changes or larger adjustments as needed.
Type:
- number
Example
0 {number}, locks any action the mouse's wheel performs
1 {number}, advances one month back or forward once the user rotates the mouse wheel
WheelChange
YearAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
YearAlign
YearLabel :string
The YearLabel property can include any of the following fields:
Also, YearLabel property supports ex-HTML tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
- "<b>text</b>", displays the text in bold.
- "<li>text</li>", displays the text in italics.
- "<u>text</u>", underlines the text.
- "<s>text</s>", strike-through text
- "<a [id][;options]>text</a>", displays an anchor element that can be clicked
- "<font [family][;size]>text</font>", displays portions of text with a different font and/or different size.
- "<fgcolor color>text</fgcolor>", displays text with a specified foreground color.
- "<bgcolor color>text</bgcolor>", displays text with a specified background color.
- "<br>", defines a forced line-break
- "<r>", right aligns the text
- "<c>", centers the text
- "<img>key[:width]</img>", displays a custom-sized picture into the text. The key defines the name of the picture/image to be shown. The image can be added using the exontrol.HTMLPicture.Add method.
- & glyph characters as "&" ( & ), "<" ( < ), ">" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "€" displays the EURO sign
- "<off offset>text</off>", defines the vertical offset to display the text.
- "<gra color[;mode[;blend]]>text</gra>", shows the text in gradient
- "<out color[;width]>text</out>", shows the text with outlined characters
- "<sha color[;width[;offset]]>text</sha>", shows the text with a shadow
Type:
- string
Example
"" {string}, displays nothing
"<%yyyy%>" {string}, displays the year with four digits
YearLabel
YearRangeAlign :exontrol.DrawTextFormatEnum
The exontrol.DrawTextFormatEnum type support the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the
and tags. - exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
Type:
- exontrol.DrawTextFormatEnum
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
YearRangeAlign
Methods
BeginUpdate()
Example
oCalendar.BeginUpdate();
// performs multiple changes to the control
oCalendar.EndUpdate();
BeginUpdate
EndUpdate()
Example
oCalendar.BeginUpdate();
// performs multiple changes to the control
oCalendar.EndUpdate();
EndUpdate
Event(id) → {Event}
Parameters:
| Name | Type | Description |
|---|---|---|
id |
any | The event parameter could be any of the following:
|
- Since:
- 1.5
Returns:
- Type
- Event
Example
The following statements are equivalent:
oCalendar.Event(0), returns the first event within the control
oCalendar.Event("E1"), returns the event with the identifier/key of "E1"
oCalendar.Events.Item(0), returns the first event within the control
oCalendar.Events..Item("E1"), returns the event with the identifier/key of "E1"
where oCalendar is an instance of the Calendar control, and oEvent is an object of Event type.
Event
Next(step)
Parameters:
| Name | Type | Description |
|---|---|---|
step |
number | Specifies the number of month(s)/year(s) to advance. The number can be negative which specifies the number of month(s)/year(s) to move backward by. |
Example
oCalendar.Next(), advances the calendar's date by 1 month/year
oCalendar.Next(3), advances the calendar's date by 3 month(s)/year(s)
oCalendar.Next(-1), moves backward the calendar's date by 1 month/year
oCalendar.Next(-3), moves backward the calendar's date by 3 month(s)/year(s)
Next
Prev(step)
Parameters:
| Name | Type | Description |
|---|---|---|
step |
number | Specifies the number of month(s)/year(s) to move backward. |
Example
oCalendar.Prev(), moves backward the calendar's date by 1 month/year
oCalendar.Prev(3), moves backward the calendar's date by 3 month(s)/year(s)
oCalendar.Prev(-1), advances the calendar's date by 1 month/year
oCalendar.Prev(-3), advances the calendar's date by 3 month(s)/year(s)
Prev
Refresh()
For example, call Refresh() when:
- The control's container has been resized and the layout must be recalculated.
- External CSS or styling changes affect the control's appearance.
- The control becomes visible after being hidden.
- You need to ensure the UI is visually synchronized with its current internal state.
The method does not alter the control's data, options, or configuration - it only updates the rendered output.
- Since:
- 1.3
Example
oCalendar.Refresh(), refreshes the control
Refresh
SetSmoothDate(year, month, day) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
year |
null | number | string | date | A value of one of the following types:
|
month |
number | Integer value representing the month, beginning with 1 for January to 12 for December. If missing/null/undefined, 1 (January) is used instead. |
day |
number | Integer value representing the day of the month, beginning with 1 for the first day of the month, 2 for the second day, .... If missing/null/undefined, 1-st is used instead. |
Returns:
- Type
- boolean
Example
"#12/31/1971#" {string}, smoothly browses December 31, 1971
SetSmoothDate
Shuffle(ratio)
Parameters:
| Name | Type | Description |
|---|---|---|
ratio |
number | specifies how far each element is randomized relative to the current size of the layout. For instance, 0 indicates that the element is not moved/shuffled, while 1, indicates that the element can randomize its position up to one width/height. |
Example
oCalendar.Shuffle(), randomly rearranges all elements within the control, changing their current order without altering the elements themselves
oCalendar.Shuffle(0.25), randomly rearranges all elements within the control, changing their current order without altering the elements themselves, where each element can randomize its position up to 0.25 of its width/height
Shuffle
Unshuffle()
Example
oCalendar.Unshuffle(), restores the control's elements to their original order after they have been shuffled
Unshuffle
Update(callback, thisArgopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
callback | Indicates a callback to perform changes within the control. | |
thisArg |
any |
<optional> |
Specifies the value of "this" keyword during the callback. If missing/empty/undefined the thisArg points to the control itself, as an object of Calendar type. |
Example
oCalendar.Update(function()
{
// performs multiple changes to the control
});
Update
off(event, listener, methodopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
string | Indicates the event to unbind, which can either be:
|
|
listener |
object | callback | Defines the listener to remove, which can either be:
|
|
method |
string |
<optional> |
Defines an optional case-sensitive string specifying the method on the listener to remove. If not provided, the listener[type]() function is used. This parameter is ignored when the listener is a JavaScript callback function. |
- Since:
- 4.4
Example
The following example removes the click event handler from the control:
oCalendar.off("click");
where oCalendar is an object of Calendar type.
This sample is equivalent to:
oCalendar.Listeners.Remove("onclick");
The following example removes all event handlers from the control:
oCalendar.off();
where oCalendar is an object of Calendar type.
This sample is equivalent to:
oCalendar.Listeners.Clear();
or
oCalendar.Listeners.Remove();
off
on(event, listener, methodopt) → {object}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
string | Specifies the event to listen for or a keyboard shortcut, in one of the following forms:
|
|
listener |
object | callback | Defines the listener to add, which can either be:
|
|
method |
string |
<optional> |
Defines an optional case-sensitive string specifying the method on the listener to handle the event. If not provided, the listener[type]() function is used. This parameter is ignored when the listener is a JavaScript callback function. |
- Since:
- 4.4
Returns:
- type {string}, specifies a case-sensitive string that specifies the type of event to listen for
- do(event) {callback}, indicates a function that can be invoked to trigger the specified event for all listeners registered for that event type
- callback {callback}, defines the listener's callback function
- thisArg {any}, defines the value of this during the listener's callback execution
- lock {number}, locks or unlocks the invocation of the listener's callback
- name {string}, defines the name of the callback, mostly used for debugging purposes
- equal(oCompareListenerCallback) {callback}, indicates a function of callback(oCompareListenerCallback) {boolean} type compares the current object with the provided object. It returns true if the objects contain the same data
- Type
- object
Example
The following example logs event details when the control is clicked:
oCalendar.on("click", function(oEvent)
{
console.log(oEvent);
});
where oCalendar is an object of Calendar type.
This sample is quivalent of
oCalendar.Listeners.Add("onclick", function (oEvent)
{
console.log(oEvent);
});
on
(static) Collect(from, to, type) → {array}
Parameters:
| Name | Type | Description |
|---|---|---|
from |
number | string | date | A value of one of the following types:
|
to |
number | string | date | A value of one of the following types:
|
type |
Calendar.CollectEnum | Indicates how the dates between from and to parameters are collected. The type parameter can be any of the following:
|
Returns:
- Type
- array
Example
The following example shows how to use the Collect() method to get all week-days of the week that contains January 1, 2018:
console.log(Calendar.Collect( Date.Create(2018,1,1), null, Calendar.CollectEnum.exWeek ));
or
console.log(Calendar.Collect( Date.Create(2018,1,1), null, "week" ));
returns 5 week-days as: Array(5) [Mon, 01 Jan 2018 00:00:00 GMT, Tue, 02 Jan 2018 00:00:00 GMT, Wed, 03 Jan 2018 00:00:00 GMT, Thu, 04 Jan 2018 00:00:00 GMT, Fri, 05 Jan 2018 00:00:00 GMT]
while:
console.log(Calendar.Collect( Date.Create(2018,1,1), null, Calendar.CollectEnum.exWeekAll ))
returns 7 week-days as: Array(7) [Sun, 31 Dec 2017 00:00:00 GMT, Mon, 01 Jan 2018 00:00:00 GMT, Tue, 02 Jan 2018 00:00:00 GMT, Wed, 03 Jan 2018 00:00:00 GMT, Thu, 04 Jan 2018 00:00:00 GMT, Fri, 05 Jan 2018 00:00:00 GMT, Sat, 06 Jan 2018 00:00:00 GMT]
Collect
Events
onanchorclick
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
oEvent |
object | Holds information about anchor being clicked.
Properties
|
- Since:
- 2.2
Example
The following samples display information about the element being clicked:
oCalendar.Listeners.Add("onanchorclick", function (oEvent)
{
console.log(oEvent);
})
or
oCalendar.onanchorclick = function (oEvent)
{
console.log(oEvent);
}
where oCalendar is an object of Calendar type.
onanchorclick
onclick
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
oEvent |
object | specifies an object of {dblClick,button,modifiers,..} type, that holds information about the object being clicked.
Properties
|
- Since:
- 1.5
Example
The following samples display information about the event being clicked:
oCalendar.Listeners.Add("onclick", function (oEvent)
{
console.log(oEvent);
})
or
oCalendar.onclick = function (oEvent)
{
console.log(oEvent);
}
where oCalendar is an object of Calendar type.
onclick
ondatechange
Parameters:
| Name | Type | Description |
|---|---|---|
oEvent |
Date | Specifies the newly date that the control displays. The control's GetDate() method returns the same value. |
Example
The following samples display the control's date once it changes:
oCalendar.ondatechange = function (oEvent)
{
console.log(oEvent);
}
or
oCalendar.Listeners.Add("ondatechange", function (oEvent)
{
console.log(oEvent);
})
where oCalendar is an object of Calendar type
ondatechange
onselchange
Parameters:
| Name | Type | Description |
|---|---|---|
oEvent |
null | Date | Array.<Date> | Holds the control's selection as:
|
Example
The following samples display the control's selection once it changed:
oCalendar.onselchange = function (oEvent)
{
console.log(oEvent);
}
or
oCalendar.Listeners.Add("onselchange", function (oEvent)
{
console.log(oEvent);
})
where oCalendar is an object of Calendar type
onselchange
onselchanging
Parameters:
| Name | Type | Description |
|---|---|---|
oEvent |
null | Date | Array.<Date> | Holds the control's selection as:
|
Example
The following samples display the control's selection before it changes:
oCalendar.onselchanging = function (oEvent)
{
console.log(oEvent);
}
or
oCalendar.Listeners.Add("onselchanging", function (oEvent)
{
console.log(oEvent);
})
where oCalendar is an object of Calendar type
onselchanging