MiscellaneousOptions class (Schedule)

The allowEmptyEvents field determines whether users can create empty events using drag and drop. An empty event has a duration of 0, meaning its start and end date-times are identical. The allowEmptyEvents field specifies the minimum duration for events created or resized using drag and drop. By default, allowEmptyEvents is set to 1, which allows creating empty events and treats their duration as defined by a single minorTimeRuler.

The allowEmptyEvents field can be one of the following:

• {number}
  • 0 {number}, permits empty events or events with duration 0 (start and end are equals)
  • positive {number}, specifies how many minorTimeRuler defines the minimum duration
  • negative {number}, that indicates the number of miliseconds (absolute value)
• {string}, indicates the hours and minutes in "hh:mm" format

0 {number}, the user can create empty events
1 {number}, the mimimum duration for events being created or resized is specified by minorTimeRuler option of the time-scale. For instance, if the minor time-scale are displayed from 15 to 15 minutes, the mimimum duration is 15 minutes
2 {number}, the mimimum duration for events being created or resized is minorTimeRuler option of the time-scale multiplied by 2. For instance, if the minor time-scale are displayed from 15 to 15 minutes, the mimimum duration is 30 minutes
-5 * 1000 or -5 * exontrol.mssec {number}, defines 5 seconds
-5 * 60 * 1000 or -5 * exontrol.msmin {number}, defines 5 minutes
-5 * 60 * 60 * 1000 or -5 * exontrol.mshour {number}, defines 5 hours
-5 * 24 * 60 * 60 * 1000 or -5 * exontrol.msday {number}, defines 5 days
"1:30" {string}, indicates 1 hour and 30 minutes

The arrangeEventsOnDrag field indicates whether the control re-arranges the events during the drag and drop. When the arrangeEventsOnDrag field is set to true, the control automatically re-arranges the events while the user creates, moves or resizes events by drag and drop. This means that as the user drags an event to a new position or resizes it, the control will adjust the layout of the events in real-time to accommodate the changes. When the arrangeEventsOnDrag field is set to false, no automatic arrangement occurs during drag and drop operations, and events will only be re-arranged after the drag operation is completed. By default, the arrangeEventsOnDrag field is set to false.

false {boolean}, no event gets arranged during the drag and drop
true {boolean}, the events get arranged during the drag and drop

The arrowSizeMultiDatesEvent field specifies the size of the up/down arrow(s) to show within the multi-dates events. The arrowSizeMultiDatesEvent field can be a number which indicates a fixed width, or an array of [min, max] type that specifies the minimum and maximum size of the arrow. The size of the up/down arrow depends on the size of the event/date. The BackgroundOptions.eventContinueDay field field specifies the up/down/keft/right arrow's color when event continues on previously or next day (multi-dates event), single-date event starts before time-scale's start time, ends after time-scale's end time. By default, the arrowSizeMultiDatesEvent field is set to [3,6], which indicates that the size of the up/down arrow(s) of multi-dates event is variable from 3 to 6-pixels wide.

0 {number}, hides the up/down arrow(s) are for any multi-dates event
4 {number}, indicates a 4-pixels wide for up/down arrow(s) of multi-dates event (fixed size)
[4,8] {number[]}, specifies that the size of up/down arrow(s) of multi-dates event is variable from 4 to 8-pixels wide (variable size)

The createEventMargin field specifies the size of the right-margin/down-margin of each date to allow users to create new events by drag and drop. The control displays a visual indication for the right-margin of each date when the user drags an event over it, to indicate that a new event can be created by dropping the dragged event on that margin. If changing the createEventMargin field the Refresh() method should be called to apply the new value. By default, the createEventMargin field is set to 6, which indicates a 6-pixels wide for the right-margin/down-margin of each date to allow users to create new events by drag and drop.

0 {number}, hides the right-margin/down-margin of each date to allow users to create new events by drag and drop
8 {number}, indicates a 8-pixels wide for the right-margin/down-margin of each date to allow users to create new events by drag and drop

The displayTimeScaleHeight field specifies the minimum-height for the day's time-scale so it is visible. The displayTimeScaleHeight field can be:

• zero value which hides entirely the day's time-scale
• positive value which indicates a minimum-height relative to the control's font size, such as 2 (the day's time-scale will not be visible if its height is less than 2 times the control's font size)
• negative value which indicates a fixed minimum-height in pixels, such as -32 (the day's time-scale will not be visible if its height is less than 32 pixels)

The displayTimeScaleHeight field is useful when the "day-resize" action in the allowActions field is enabled, as it prevents the day's time-scale from being displayed when its size becomes too small. By default, the displayTimeScaleHeight field is set to 1, which means that the day's time-scale will not be visible if its height is less than the control's font size.

0 {number} hides the date's time-scale
-32 {number} indicates a minimum 32-pixels
2 {number} specifies 2 times control's font-size

The dragAlpha field specifies the transparency to display the source-event being dragged. The dragAlphaNegate field indicates that the dragAlpha transparency is applied to any other than source-event. The dragDummyAlpha field specifies the transparency to display the dummy-event being dragged. The dummy-event is moved during drag and drop. The dragAlpha field can be set to null or 1 to show the source-event being dragged unchanged, while any value between 0 and 1 indicates the transparency level to show the source-event being dragged. By default, the dragAlpha field is set to 0.5, which indicates that the source-event being dragged is shown semi-transparent.

null {null} or 1 {number}, the field is ignored, so the source-event being dragged is shown unchanged
0 {number}, hides the source-event being dragged (fully transparent)
0.5 {number}, the source-event being dragged is shown semi-transparent

The dragAlphaNegate field indicates that the dragAlpha transparency is applied to any other than source-event. The dragAlpha field specifies the transparency to display the source-event being dragged. The dragAlphaNegate field can be set to true to apply the dragAlpha transparency to any other than source-event, or false to apply the dragAlpha transparency to source-event only. By default, the dragAlphaNegate field is set to false, which indicates that the dragAlpha transparency is applied to source-event only.

false {boolean}, the dragAlpha transparency is applied to source-event only
true {boolean}, the dragAlpha transparency is applied to any other than source-event

The dragDummyAlpha field specifies the transparency to display the dummy-event being dragged. The dummy-event is moved during drag and drop. The dragDummyAlpha field can be set to null or 1 to show the dummy-event being dragged unchanged, while any value between 0 and 1 indicates the transparency level to show the dummy-event being dragged. By default, the dragDummyAlpha field is set to 1, which indicates that the dummy-event being dragged is shown unchanged.

null {null} or 1 {number}, the field is ignored, so the dummy-event being dragged is shown unchanged
0 {number}, hides the dummy-event being dragged (fully transparent)
0.5 {number}, the dummy-event being dragged is shown semi-transparent

The dragStartOnMove field specifies the drag-operations (create, resize or move) that start once the pointer is moved.

The dragStartOnMove field can be one of the following values:

• -1 {number}, any drag-operation (create, resize or move) begins once the user clicks and drags the pointer
• 0 {number}, any drag-operation (create, resize or move) begins once the user clicks the view, without initially dragging the pointer

Additionally, the dragStartOnMove field can be a combination of one or more of the following values to specify which drag-operations start once the pointer is moved:

• 1 {number}, create a new event by drag and drop
• 2 {number}, resize one or more events by drag and drop
• 4 {number}, move one or more events by drag and drop

By default, the dragStartOnMove field is set to 1, which means that a new event is created once the user clicks and drags the pointer (prevents creating a new event once the user clicks the control without dragging/moving the mouse/pointer).

0 {number}, any drag-operation (create, resize or move) begins once the user clicks the view, without initially dragging the pointer
-1 {number}, any drag-operation (create, resize or move) begins once the user clicks and drags the pointer
1 {number}, a new event is created once the user clicks and drags the pointer (prevents creating a new event once the user clicks the control without dragging/moving the mouse/pointer)
6 {number}, the move or resize drag-operation begins once the user clicks and drags the pointer

The ensureVisibleOnDrag field specifies the drag-operations (create, resize or move) that calls the EnsureVisibleClient() method once the drag-operation ends. The EnsureVisibleClient() method scrolls the control's content to ensure that the event fits the view's client-area.

The ensureVisibleOnDrag field can be one of the following values:

• -1 {number}, the EnsureVisibleClient() method is called for any drag and drop operation (create, resize or move)
• 0 {number}, no EnsureVisibleClient() method is called once any drag-operation (create, resize or move) ends

Additionally, the ensureVisibleOnDrag field can be a combination of one or more of the following values to specify for which drag-operations the EnsureVisibleClient() method is called once the drag-operation ends:

• 1 {number}, create a new event by drag and drop
• 2 {number}, resize one or more events by drag and drop
• 4 {number}, move one or more events by drag and drop

By default, the ensureVisibleOnDrag field is set to -1, which means that the EnsureVisibleClient() method is called for any drag and drop operation (create, resize or move). This ensures that after any drag and drop operation, the control will automatically scroll to make sure that the event being created, moved, or resized is visible within the client area of the view.

0 {number}, no EnsureVisibleClient() method is called once any drag-operation (create, resize or move) ends
-1 {number}, the EnsureVisibleClient() method is called for any drag and drop operation (create, resize or move)
1 {number}, the EnsureVisibleClient() method is called only if the user creates new events by drag and drop
6 {number}, the EnsureVisibleClient() method is called only if the user moves or resizes events by drag and drop

The eventDisplayMarginsSep field indicates the separator character(s) between start and end date-times. This string is used when displaying the event's date and time information, such as in tooltips or event labels, to separate the start and end date-times. By default, the eventDisplayMarginsSep field is set to " - ", which means that the start and end date-times will be displayed in the format "Start Date-Time - End Date-Time". You can customize this separator to use different characters or strings as needed. For instance, the shortDateFormat field specifies how dates are displayed in short form (date only, no time), and the longDateFormat field specifies how dates are displayed in long form (date and time). The eventDisplayMarginsSep field works in conjunction with these date format settings to ensure that the date and time information for events is presented clearly and consistently.

" - " {string}, defines " - " the separator character(s) between start and end date-times

The eventMargin field specifies the distance (horizontal or/and vertical) between events and date's borders. The eventMargin field can be used to create a gap between the events and the date's borders, which can enhance the visual distinction of events. The eventMargin field is applied to neighboring events as well, so it creates a distance between them. If changing the eventMargin field the Refresh() method should be called to apply the new value. By default, the eventMargin field is set to 3, which indicates a 3-pixels distance between events and date's borders, and between neighboring events.

0 {number}, indicates no distance between events
4 {number} or [4,4] {array}, indicates a 4-pixels distance between events, horizontally and vertically as well
[4,0] {array}, indicates a 4-pixels distance between events horizontally and 0 vertically
[8,4] {array}, indicates a 8-pixels distance between events horizontally and 4-pixels vertically

The formatCreateEventLabel field specifies the format and alignment used to display the event's label while the user creates it by drag and drop. It accepts a combination of one or more exontrol.DrawTextFormatEnum flags that define how the label is rendered during this operation. By default, the formatCreateEventLabel field is set to the following flags: exTextWordBreak | exTextNoClip, which allows the label to break into multiple lines if necessary and prevents clipping of the text during the drag operation.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatEventExtraLabel field specifies the format and alignment to display the event's extra-label. The extra-label is a single-line label that is shown additonally to the short or long label. The formatEventExtraLabel field is a combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's extra-label. By default, the formatEventExtraLabel field is set to the following flags: exTextAlignBottom | exTextSingleLine | exTextEndEllipsis, which defines a single-line label, justifies it to the bottom of the event and adds ellipses if the label is too long to fit in the available space.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatEventLongLabel field specifies the format and alignment to display the event's long-label. The long-label is a multi-line label that is shown within the event when the event's height is enough to show it. The formatEventLongLabel field is a combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's long-label. By default, the formatEventLongLabel field is set to the following flags: exTextWordBreak, which breaks words and displays the long-label on multiple lines if necessary to fit in the available space.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatEventShortLabel field specifies the format and alignment to display the event's short-label. The short-label is a single-line label that is shown within the event when the event's height is not enough to show the long-label. The formatEventShortLabel field is a combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's short-label. By default, the formatEventShortLabel field is set to the following flags: exTextSingleLine | exTextWordEllipsis, which defines a single-line label and adds ellipses if the label is too long to fit in the available space.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatGroupCaption field specifies the format and alignment to display the group's caption. The Group.Caption property specifies the ex-HTML caption of the group, while the Group.ID property specifies the group's id. The formatGroupCaption field supports a collection of flags within the exontrol.DrawTextFormatEnum object, that specifies how the text will be written on the context. By default, the formatGroupCaption field is set to the following flags: exTextAlignCenter | exTextAlignVCenter | exTextWordEllipsis, which centers the caption and adds ellipses if the caption is too long to fit in the available space.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

The exontrol.DrawTextFormatEnum type supports 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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatMarkZoneCaption field specifies the format and alignment to display the mark-zone's caption. The MarkZone.Caption property defines the ex-HTML caption of the mark-zone. It accepts a combination of one or more exontrol.DrawTextFormatEnum flags that define how the mark-zone's caption is rendered. By default, the formatMarkZoneCaption field is set to the following flags: exTextAlignCenter | exTextAlignVCenter | exTextWordBreak | exTextWordEllipsis, which centers the caption both horizontally and vertically, allows it to break into multiple lines if necessary and adds ellipses if the caption is too long to fit in the available space.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The formatUpdateEventLabel field specifies the format and alignment to display the event's label while user moves or resizes it by drag and drop. It accepts a combination of one or more exontrol.DrawTextFormatEnum flags that define how the label is rendered during this operation. By default, the formatUpdateEventLabel field is set to the following flags: exTextWordBreak | exTextNoClip, which allows the label to break into multiple lines if necessary and prevents clipping of the text during the drag operation.

The following fields can be used to specify the format for different captions and labels within the control:

• Event captions and labels
  • The formatText field specifies the format used to display event (appointment) captions.
  • The formatEventShortLabel, formatEventLongLabel, and formatEventExtraLabel fields specify the format and alignment for the event's short, long, and extra labels.
• Event interaction (drag & drop)
  • The formatCreateEventLabel field specifies the format and alignment of the event's label while the user creates it by drag and drop.
  • The formatUpdateEventLabel field specifies the format and alignment of the event's label while the user moves or resizes it by drag and drop.
• Other captions
  • The formatMarkZoneCaption field specifies the format and alignment of the mark-zone's caption.
  • The formatGroupCaption field specifies the format and alignment of the group's caption.

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.

null {null}, centers the caption
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned

The groupingButtonPrompt field defines the message to show within the prompt, once the user clicks the header's grouping-button (if exontrol.menu library is not included). The groupingButtonPrompt field can be set to null to show the default message, or to empty string to show no message at all. The groupingButtonCaption field specifies the ex-HTML caption of the header's grouping-button. The grouping button allows the user to toggle the visibility of grouped events within the schedule view. When the user clicks the grouping button, the schedule view shows or hides the groups of events. The displayGroupingButton field gets or sets a value that indicates whether the grouping button is displayed in the date header. The showGroupingEvents field specifies whether the schedule view shows grouped events.

null {null}, equivalent of "Enter the id or index of each visible-group (separated by comma):"
"" {string}, no message is displayed

The minHeight field specifies the minimum-height for the day's view. The minHeight field can be:

• positive value which indicates a minimum-height relative to the control's font size, such as 2 (the schedule view will not be displayed if the height of a day is less than 2 times the control's font size)
• negative value which indicates a fixed minimum-height in pixels, such as -32 (the schedule view will not be displayed if the height of a day is less than 32 pixels)

The minWidth and minHeight fields are useful when the "day-resize" action in the allowActions field is enabled, as they prevent the schedule view from being displayed when a day's size becomes too small. The DayViewHeight property specifies the height of a day within the schedule panel, while the ShowViewCompact property determines how days are arranged within the schedule view. The DayViewHeight property has no effect when ShowViewCompact is set to exViewSingleRow or exViewSingleRowLockHeader. By default, the minHeight field is set to 1, which means that the schedule view will not be displayed if the height of a day is less than the control's font size.

-32 {number} indicates a minimum 32-pixels
2 {number} specifies 2 times control's font-size

The minWidth field specifies the minimum-width in pixels for the day's view. The minHeight field specifies the minimum-height for the day's view. The minWidth and minHeight fields are useful when the "day-resize" action in the allowActions field is enabled, as they prevent the schedule view from being displayed when a day's size becomes too small. The DayViewWidth property defines the width of a day within the schedule panel, while the DayViewHeight property specifies its height. The ShowViewCompact property determines how days are arranged within the schedule view. The DayViewWidth property has no effect when ShowViewCompact is set to exViewSingleColumn, while the DayViewHeight property has no effect when ShowViewCompact is set to exViewSingleRow or exViewSingleRowLockHeader. By default, the minWidth field is set to 16 pixels, which means that the schedule view will not be displayed if the width of a day is less than 16 pixels.

16 {number} defines a minimum width of 16 pixels

The padSelectEvent field can be used to create a gap between the event and its selection border, which can enhance the visual distinction of selected events, while the pad field can be used to increase the event's size by adding extra space around its content. The padSelectEvent field has effect only if the selectEventStyle option is 1 (the event's shape and color is not altered so the "select" shape is displayed on the event's background). By default, the padSelectEvent field is set to 3, which creates a 3-pixels gap between the event and its selection border.

The padSelectEvent field can be of one of the following types:

• {number} a numeric value, to pad horizontal and vertical size with the same value
• {(string|number[])} a "x,y" or [x,y] type to specify the padding on horizontal and vertical side

null {null}, indicates that the default-padding field is used ([3,3])
0 {number}, indicates no padding
4 {number} or [4,4] {array}, increases the size of selected-border around event, with 2 * 4-pixels
"8,4" {string} or [8,4] {array}, increases the width of selected-border around event, with 2 * 8-pixels height with 2 * 4-pixels

The requireRulerDistance field specifies the minimum-distance between two consecutive rulers. The MajorTimeRuler and MinorTimeRuler properties of TimeScale object specify the time interval between two consecutive major and minor rulers, respectively. The requireRulerDistance field can be used to hide the rulers when the distance between them becomes too small.

The requireRulerDistance field can be:

• zero value which indicates that the field is ignored and the distance between two consecutive rulers is not checked
• positive value which indicates a minimum-distance relative to the control's font size, such as 2 (the distance between two consecutive rulers will not be checked if it is less than 2 times the control's font size)
• negative value which indicates a fixed minimum-distance in pixels, such as -32 (the distance between two consecutive rulers will not be checked if it is less than 32 pixels)

The requireRulerDistance field is useful when the "day-resize" action in the allowActions field is enabled, as it prevents the rulers from being displayed when the distance between them becomes too small. By default, the requireRulerDistance field is set to 1, which means that the distance between two consecutive rulers will not be checked if it is less than the control's font size.

0 {number} the requireRulerDistance option is ignored
-32 {number} indicates a minimum 32-pixels
2 {number} specifies 2 times control's font-size

The requireTimeScaleHeight field specifies the minimum-height for the view's time-scale header to be visible. The requireTimeScaleHeight field can be:

• zero value which hides entirely the view's time-scale header
• positive value which indicates a minimum-height relative to the control's font size, such as 2 (the view's time-scale header will not be visible if its height is less than 2 times the control's font size)
• negative value which indicates a fixed minimum-height in pixels, such as -32 (the view's time-scale header will not be visible if its height is less than 32 pixels)

The requireTimeScaleHeight field is useful when the "day-resize" action in the allowActions field is enabled, as it prevents the view's time-scale header from being displayed when its size becomes too small. By default, the requireTimeScaleHeight field is set to 4, which means that the view's time-scale header will not be visible if its height is less than 4 times the control's font size.

0 {number} hides the view's time-scale
-32 {number} indicates a minimum 32-pixels
2 {number} specifies 2 times control's font-size