Class: Options

Calendar.Options()

new Options()

The Calendar.Options type defines different options you can apply on the control.

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 control
is associated with the property:
Cursors {string}, specifies the mouse cursor to be displayed when pointing over a part of the control
which means that the following statements are equivalent:
oCalendar.Options = {cursors: "pointer(d,p,n)"}
oCalendar.SetOptions({cursors: "pointer(d,p,n)"})
oCalendar.Cursors = "pointer(d,p,n)"
oCalendar.SetCursors("pointer(d,p,n)")
where oCalendar is an object of Calendar type

Members

(static) alignCal :exontrol.AlignEnum

The alignCal field aligns the calendar relative to the canvas. 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

(static) allowScrollByDrag :boolean

The allowScrollByDrag field specifies whether the user can scroll the control by drag.
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)

(static) allowSwitchView :boolean

The allowSwitchView field specifies whether the user can switch the view (month or year).
Type:
  • boolean
Example
false {boolean}, disables month or year view
 true {boolean}, enables month or year view

(static) autoSize :Calendar.AutoSizeEnum

The autoSize field determines whether the size of the calendar's date is fixed, or relative to the current font or client area. 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

(static) cursors :string

The cursors field specifies the mouse cursor to be displayed when pointing over a part of the control. The format of cursors 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:
  • "p" (prev), defines the prev button (available for any view)
  • "n" (next), defines the next button (available for any view)
The following parts are available while the control displays the day-view:
  • "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 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)
  • "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
The following parts are available while the control displays 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)
  • "y" (year) that 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

(static) date :string

The date field specifies the calendar's browsing date as string in format "#mm/dd/yyyy#" (the month of the date defines the first visible month within the calendar)
Type:
  • string
Example
null {null}, browses today date
 "#12/31/1971#" {string}, browses December 31, 1971

(static) dayAlign :exontrol.DrawTextFormatEnum

The dayAlign field aligns the date's label, while the calendar is in day-view. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the way the date's label is being displayed. 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

(static) dayFixedHeight :number

The dayFixedHeight field defines the height of the calendar's date when autoSize is Calendar.AutoSizeEnum.exFixedSize. The dayFixedHeight field has effect only if the autoSize is Calendar.AutoSizeEnum.exFixedSize. The dayFixedHeight property does not include the date's padding.
Type:
  • number
Example
24 {number}, defines the date's height to 24-pixels

(static) dayFixedWidth :number

The dayFixedWidth field defines the width of the calendar's date when autoSize is Calendar.AutoSizeEnum.exFixedSize. The dayFixedWidth field has effect only if the autoSize is Calendar.AutoSizeEnum.exFixedSize. The dayFixedWidth property does not include the date's padding.
Type:
  • number
Example
24 {number}, defines the date's width to 24-pixels

(static) dayLabel :string

The dayLabel field indicates a ex-HTML string that can include expression fields (<%...%>) to display the date while the calendar is in day-view. The dayLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) dayMonthAlign :exontrol.DrawTextFormatEnum

The dayMonthAlign field aligns the month's label, while the calendar is in day-view. Indicates a exontrol.DrawTextFormatEnum value that defines the way the date's label is being displayed. 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

(static) dayMonthHeader :boolean

The dayMonthHeader field specifies whether the calendar shows the header to display month's name (day-view only).
Type:
  • boolean
Example
false {boolean}, hides the calendar's header (month's name)
 true {boolean}, shows the calendar's header (month's name)

(static) dayMonthLabel :string

The dayMonthLabel field defines the ex-HTML label to show the month-name into the calendar's header (day-view only). The dayMonthLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayMonthLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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>&lt;r&gt;<fgcolor gray><font ;8><off 6><%yyyy%>" {string}, displays an combined ex-HTML format

(static) dayNonMonth :number

The dayNonMonth field specifies whether the calendar displays the dates that are not part of the current month.
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.

(static) dayNonMonthLabel :string

The dayNonMonthLabel field defines the ex-HTML label to show the dates that are not part of the current month (day-view only). The dayNonMonthLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayNonMonthLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) dayWeekAllLabel :string

The dayWeekAllLabel field defines the ex-HTML label to show the first day of the month on the top-left corner of the calendar, when the week-number and week-days headers are present (day-view only). The dayWeekAllLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayWeekAllLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) dayWeekHeader :boolean

The dayWeekHeader field specifies whether the calendar shows the header to display the days of the week (day-view only).
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).

(static) dayWeekLabel :string

The dayWeekLabel field defines the ex-HTML label to show the days of the week into the calendar's header (day-view only). The dayWeekLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayWeekLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) dayWeekNoHeader :boolean

The dayWeekNoHeader field specifies whether the calendar shows the header to display week-number (day-view only).
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

(static) dayWeekNoLabel :string

The dayWeekNoLabel field defines the ex-HTML label to show the week-number into the calendar's header (day-view only). The dayWeekNoLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, dayWeekNoLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) flow :Calendar.FlowEnum

The flow field determines whether the months gets arranged from left to right or top to bottom. 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

(static) hlShapes :string

The hlShapes field defines the shape(s) to be applied on a part of the control, when it requires to be highlighted The format of hlShapes 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 shapes property supports any of the following parts:
  • "p" (prev), defines the prev button (available for any view)
  • "n" (next), defines the next button (available for any view)
The following parts are available while the control displays the day-view:
  • "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 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)
  • "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
The following parts are available while the control displays 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)
  • "y" (year) that 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 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

(static) locale :string

The locale field specifies the language (BCP 47 language tag) whose formatting conventions should be used to customize the calendar.
Type:
  • string
Example
null {null}, indicates that the browser's UI language is used.
  "de" {string}, defines German locale
  "ro" {string}, defines Romanian locale

(static) locked :boolean

The locked field indicates whether the control is locked(protected) or unlocked
Type:
  • boolean
Example
false {boolean}, unlocks the control (can select any date)
  true {boolean}, locks the control (can't select any date)

(static) maxMonthX :number

The maxMonthX field specifies the maximum number of months horizontally displayed. The minMonthX and maxMonthX properties determines the number of months horizontally displayed. The number of months horizontally displayed depends on the month's size and the canvas's size. If the minMonthX and maxMonthX properties are equal it specifies exactly the months horizontally displayed.
Type:
  • number
Example
6 {number}, indicates that the calendar displays maximum six months.

(static) maxMonthY :number

The maxMonthY field specifies the maximum number of months vertically displayed. The minMonthY and maxMonthY properties determines the number of months vertically displayed. The number of months vertically displayed depends on the month's size and the canvas's size. If the minMonthY and maxMonthY properties are equal it specifies exactly the months vertically displayed.
Type:
  • number
Example
6 {number}, indicates that the calendar displays maximum six months.

(static) minMonthX :number

The minMonthX field specifies the minimum number of months horizontally displayed. The minMonthX and maxMonthX properties determines the number of months horizontally displayed. The number of months horizontally displayed depends on the month's size and the canvas's size. If the minMonthX and maxMonthX properties are equal it specifies exactly the months horizontally displayed.
Type:
  • number
Example
2 {number}, indicates that the calendar displays minimum two months

(static) minMonthY :number

The minMonthY field specifies the minimum number of months vertically displayed. The minMonthY and maxMonthY properties determines the number of months vertically displayed. The number of months vertically displayed depends on the month's size and the canvas's size. If the minMonthY and maxMonthY properties are equal it specifies exactly the months vertically displayed.
Type:
  • number
Example
2 {number}, indicates that the calendar displays minimum two months

(static) mode :Calendar.ModeEnum

The mode field specifies the orientation the calendar displays the days of the weeks. 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

(static) monthAlign :exontrol.DrawTextFormatEnum

The monthAlign field aligns the month's label, while the calendar is in month-view. Indicates a exontrol.DrawTextFormatEnum value that defines the way the month's label is being displayed. 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

(static) monthLabel :string

The monthLabel field specifies the ex-HTML string that can include expression fields (<%...%>) to display the month while the calendar is in month-view. The monthLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, monthLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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)

(static) monthYearAlign :exontrol.DrawTextFormatEnum

The monthYearAlign field aligns the year's label, while the calendar is in month-view. Indicates a exontrol.DrawTextFormatEnum value that defines the way the year's label is being displayed. 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

(static) pad :number|string|Array.<number>

The padding field specifies the padding to be applied on dates of the calendar
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

(static) padCal :number|string|Array.<number>

The padCal field specifies the padding to display the calendar.
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

(static) selection :any

The selection field specifies the selected date(s). 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 ISO 9601 string representation such as "2011-10-10" (date-only form), "2011-10-10T14:48:00" (date-time form), or "2011-10-10T14:48:00.000+09:00" (date-time form with milliseconds and time zone) (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

(static) shapes :string

The shapes field defines the shapes each part of the control can display. The shapes field customizes the control's visual appearance. The format of shapes 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 shapes property supports any of the following parts:
  • "p" (prev), defines the prev button (available for any view)
  • "n" (next), defines the next button (available for any view)
The following parts are available while the control displays the day-view:
  • "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 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)
  • "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
The following parts are available while the control displays 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)
  • "y" (year) that 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
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

(static) singleSel :Calendar.SingleSelEnum

The singleSel field specifies whether the control supports single, multiple, toggle selection. 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. 

(static) smoothScroll :number

The smoothScroll field defines the time in ms the calendar's date scrolls to another (250, by default).
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.

(static) smoothSel :number

The smoothSel field defines the time in ms the calendar's selection goes from one state to another.
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.

(static) tfi :string|object

The tfi field applies font attributes to captions within the control. The tfi field can be defined using a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}.

The tfi field 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 field 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 field 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 mode as a value between 0 and 4
    • 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 field is ignored
  "bold monospace 16 &lt;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

(static) wheelChange :number

The wheelChange field specifies the amount the calendar scrolls when the user rolls the mouse wheel.
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

(static) yearAlign :exontrol.DrawTextFormatEnum

The yearAlign field aligns the year's label, while the calendar is in year-view. Indicates a exontrol.DrawTextFormatEnum value that defines the way the year's label is being displayed. 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

(static) yearLabel :string

The yearLabel field specifies the ex-HTML string that can include expression fields (<%...%>) to display the year while the calendar is in year-view. The yearLabel property can include any of the following fields:
  • "<%d%>", day of the month in one or two numeric digits, as needed (1 to 31)
  • "<%dd%>", day of the month in two numeric digits (01 to 31)
  • "<%d1%>", first letter of the weekday (S to S)"
  • "<%loc_d1%>", indicates day of week as a one-letter abbreviation using the current user settings
  • "<%d2%>", first two letters of the weekday (Su to Sa)
  • "<%loc_d2%>", indicates day of week as a two-letters abbreviation using the current user settings
  • "<%d3%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_d3%>", equivalent with "<%loc_ddd%>"
  • "<%ddd%>", first three letters of the weekday (Sun to Sat)
  • "<%loc_ddd%>", indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • "<%dddd%>", full name of the weekday (Sunday to Saturday)
  • "<%loc_dddd%>", indicates day of week as its full name using the current user regional and language settings
  • "<%i%>", displays the number instead the date
  • "<%w%>", day of the week (1 to 7)
  • "<%ww%>", week of the year (1 to 53)
  • "<%m%>", month of the year in one or two numeric digits, as needed (1 to 12)
  • "<%mr%>", month of the year in Roman numerals, as needed (I to XII)
  • "<%mm%>", month of the year in two numeric digits (01 to 12)
  • "<%m1%>", first letter of the month (J to D)
  • "<%loc_m1%>", indicates month as a one-letter abbreviation using the current user settings
  • "<%m2%>", first two letters of the month (Ja to De)
  • "<%loc_m2%>", indicates month as a two-letters abbreviation using the current user settings
  • "<%m3%>", first three letters of the month (Jan to Dec)
  • "<%loc_m3%>", equivalent with "<%loc_mmm%>"
  • "<%mmm%>", first three letters of the month (Jan to Dec)
  • "<%loc_mmm%>", indicates month as a three-letter abbreviation using the current user regional and language settings
  • "<%mmmm%>", full name of the month (January to December)
  • "<%loc_mmmm%>", indicates month as its full name using the current user regional and language settings
  • "<%q%>", Date displayed as the quarter of the year (1 to 4)
  • "<%y%>", number of the day of the year (1 to 366)
  • "<%yy%>", last two digits of the year (01 to 99)
  • "<%yyyy%>", full year (0100 to 9999)
  • "<%hy%>", date displayed as the half of the year (1 to 2)
  • "<%loc_g%>", indicates period/era using the current user regional and language settings
  • "<%loc_gg%>", indicates period/era using the current user regional and language settings
  • "<%loc_sdate%>", indicates the date in the short format using the current user regional and language settings
  • "<%loc_ldate%>", indicates the date in the long format using the current user regional and language settings
  • "<%loc_dsep%>", indicates the date separator using the current user regional and language settings (/)
  • "<%h%>", hour in one or two digits, as needed (0 to 23)
  • "<%hh%>", hour in two digits (00 to 23)
  • "<%h12%>", hour in 12-hour time format, in one or two digits - [0(12),11]
  • "<%hh12%>", hour in 12-hour time format, in two digits - [00(12),11]
  • "<%n%>", minute in one or two digits, as needed (0 to 59)
  • "<%nn%>", minute in two digits (00 to 59)
  • "<%s%>", second in one or two digits, as needed (0 to 59)
  • "<%ss%>", second in two digits (00 to 59)
  • "<%AM/PM%>", twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • "<%loc_AM/PM%>", indicates the time marker such as AM or PM using the current user regional and language settings
  • "<%loc_A/P%>", indicates the one character time marker such as A or P using the current user regional and language settings
  • "<%loc_time%>", indicates the time using the current user regional and language settings
  • "<%loc_time24%>", indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • "<%loc_tsep%>", indicates the time separator using the current user regional and language settings (:)
  • "<%loc_y%>", represents the Year only by the last digit, using current regional settings
  • "<%loc_yy%>", represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years.
  • "<%loc_yyyy%>", represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
Also, yearLabel property supports ex-HTML tags as follows:
  • "<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 "&amp;" ( & ), "&lt;" ( < ), "&gt;" ( > ), "&qout;" ( quote character ) and "&#number;" ( the character with specified code ). For instance, "&#8364;" 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

(static) yearRangeAlign :exontrol.DrawTextFormatEnum

The yearRangeAlign field aligns the label that displays the range of years, while the calendar is in year-view. Indicates a exontrol.DrawTextFormatEnum value that defines the way the label that displays the range of years is being displayed. 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