Schedule

Properties

collection : identifierList

Collection of schedule items.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

collectionAnnotation : string

Space separated list of annotations which do not exist in the Domain Model.

collectionNew : string

Alternative association path to use for create. Subclass name is optional. Format: "assoc1(SubClassName) ... assocN(SubClassName).

collectionQuery : string

List of additional attributes to include in collection read query.

collectionWhere : string

Optional clause to be added to collection model query.

context : string

The attribute, association path, or a constant specifying context indentifier to be set. For context bus adapter.

See: Application'contextImplementation

control : identifier

The control type this should be rendered with.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

customWeekLength : int

For Custom Week View, the number of days displayed. Must be an Integer between 2 and 7.

customWeekStartDay : int

For Custom Week View, the day the custom week should start at where 1 = Sunday and 7 = Saturday. Must be an Integer between 1 and 7.

day : boolean

Specifies if the day is included in the Schedule.

delete : string

Boolean attribute name, or constant specifying whether the delete operation is allowed in the layout.

deletePrompt : string

Delete prompt string indentifier. Valid if promptOnDelete is true.

The string indentifier may accept the Class name, and instance name args.

edit : string

Boolean property specifying whether the insert, delete, or edit operations are allowed in the column.

enabled : string

The attribute, association path, or a constant returning boolean to set enablement.

endBusDay : string

The end day of the business week.

endTime : identifierList

End time of each day.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

error : string

Expression returning non-#f if the message should be treated as an error. The raw message is passed as "this".

event : identifier

The UIEvent attached to the Schedule control. UIEvents are handled by UIActions.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

exclusive : boolean

If true lack of selection means disabling children collection query. Otherwise, children query is generated.

factory : identifierList

Factory method for many to many schedule.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

firstDayOfWeek : int

For Week View, the day the normal week view should start at, where 1 = Sunday and 7 = Saturday. Must be an Integer between 1 and 7.

gannt : boolean

Specifies if a gantt chart is included in the Schedule.

Note: This attribute is mispelled. Correct: 'gantt'

insert : string

Boolean attribute name, or constant specifying whether the insert operation is allowed in the layout.

itemAllDay : string

The attribute, association path, or a constant specifying all day flat for each schedule item.

itemBannerStyle : string

The attribute, association path, or a constant specifying banner style name of each item.

Banner appears as a thick line on the left border of an item.

itemCaption : string

String identifier for caption display in the UI for each item in the Schedule.

itemCaptionFormat : string

Schedule item caption format stringId. The arguments are start time, end time, title, and entity names. If not set the default caption format is used including start, end time, title, entity names, and resource names.

itemCaptionFormatMonth : string

Schedule item caption format stringId in the schedule month view. The arguments are start time, end time, and caption.

itemCaptionFormatWeek : string

Schedule item caption week view format stringId in the schedule week view. The arguments are start time, end time, and caption.

itemCaptionMonth : string

String identifier for caption display in the UI for each item in the Schedule's month view.

itemCaptionWeek : string

String identifier for caption display in the UI for each item in the Schedule's week view.

itemEntities : string

The attribute from which to obtain a collection of entities for which the item was schedule.

itemEntitiesCount : int

The maximum number of entities to show from the collection specified in itemEntities. If there are more entries then an ellipsis is shown at the end of the list.

itemEntityHiddenObjectCaption : string

The attribute, association path, or a string constant to display when the entity in the itemEntities collection is an object that is hidden from the user.

itemEntityName : string

The attribute from which to retrieve the caption text for an entity specified in the itemEntities collection.

itemEntityPopupTooltip : identifier

The name of screen appearing as item's entity popup tooltip.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

itemEntityPopupTooltipJustification : RelativeJustification

The item's entity popup tooltip justification relative to its anchor. One of "before", or "after".

Valid values based on“string”.
before
after

itemEntityPopupTooltipPosition : RelativePosition

The position of the item's entity popup tooltip relative to its anchor. One of "above", "below", "left", or "right.

Valid values based on“string”.
above
below
left
right

itemEntityPopupTooltipStyle : PopupTooltipStyle

The item's entity popup tooltip appearance style. One of "clean", or "callout".

Valid values based on“string”.
clean
callout

itemEntityPopupTooltipValue : string

The attribute or an association path to the instance to appear in the item's entity popup tooltip. Can be empty.

itemIcon : string

Icon provides a visual recognition for each item in the Schedule.

itemNotes : identifierList

Notes for an item.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

itemPerformer : string

TODO: comment attribute itemPerformer

itemPerformerName : string

TODO: comment attribute itemPerformerName

itemResourceEntity : identifierList

The attribute or association path to the entity associated to the resource.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

itemResourceHiddenObjectCaption : string

The attribute, association path, or a string constant to display when the resource in the itemResources collection is an object that is hidden from the user.

itemResourceName : string

The attribute or association path to the caption string of a item's resource.

itemResourcePopupTooltip : identifier

The name of screen appearing as item's resource popup tooltip.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

itemResourcePopupTooltipJustification : RelativeJustification

The item's resource popup tooltip justification relative to its anchor. One of "before", or "after".

Valid values based on“string”.
before
after

itemResourcePopupTooltipPosition : RelativePosition

The position of the item's resource popup tooltip relative to its anchor. One of "above", "below", "left", or "right.

Valid values based on“string”.
above
below
left
right

itemResourcePopupTooltipStyle : PopupTooltipStyle

The item's resource popup tooltip appearance style. One of "clean", or "callout".

Valid values based on“string”.
clean
callout

itemResourcePopupTooltipValue : string

The attribute or an association path to the instance to appear in the item's resource popup tooltip. Can be empty.

itemResources : identifierList

The attribute or association path to the collection of the item's resources. If empty, the schedule will not filter by item resource, i.e. all items in the collection within the date range will be displayed.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

itemStatusIcon : string

Status icon provides a visual recognition for status of each item in the Schedule.

itemStyle : string

The attribute, association path, or a constant specifying style name of each item.

itemSubject : string

TODO: comment attribute itemSubject

itemSubjectName : string

TODO: comment attribute itemSubjectName

itemTooltip : string

The attribute, association path, or a constant specifying tooltip for each item in the Schedule.

itemType : identifierList

Deprecated. Do not use.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

menu : identifier

The menu associated with the Schedule.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

month : boolean

Specifies if the month is included in the Schedule.

name : uiIdentifier

Uniquely identifies the tabbable control.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

popupTooltip : identifier

The name of screen appearing as popup tooltip.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

popupTooltipJustification : RelativeJustification

The popup tooltip justification relative to its anchor. One of "before", or "after".

Valid values based on“string”.
before
after

popupTooltipPosition : RelativePosition

The position of the popup tooltip relative to its anchor. One of "above", "below", "left", or "right.

Valid values based on“string”.
above
below
left
right

popupTooltipStyle : PopupTooltipStyle

The popup tooltip appearance style. One of "clean", or "callout".

Valid values based on“string”.
clean
callout

popupTooltipValue : string

The attribute or an association path to the instance to appear in the popup tooltip. Can be empty.

promptOnDelete : boolean

Prompt the user before deleting an item.

query : string

List of additional attributes to include in read query.

quickAddMenu : identifier

The name of the menu item in the toolbar that will serve as the quick add menu for the Schedule

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

required : string

The attribute, association path, or a constant returning boolean to set whether the value for the control is required.

If the attribute is required in the model, it takes precedence and one cannot change this setting in the UI. If the attribute is not required in the model, the requiredness can be set to an attribute, association path, or a constant returning boolean. If the value is set to #t, or the attribute value is true, the requiredness cannot be changed using 'required' view property that is set via client-side API. If the value is left blank, it is set to #f, or the attribute value is false, the requiredness can be changed using 'required' view property that is set via client-side API.

resourceName : string

The attribute or association path to the caption string which is displayed in the list of resources.

resources : identifierList

The attribute or association path to the collection of resources (intersection class for users) that can be displayed in this schedule.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

rowHeight : Dimension

Height of each row in the Schedule. Units can be one of pixels, points, percentage, or integer.

Valid values based on“string”.
(\d{1,8})\|(\d{1,8}px)\|(\d{1,8}pt)\|(\d{1,8}%)

scheduleEventType : ScheduleEventType

Specifies the type of the event for an 'event' schedule.

Valid values based on“string”.
roadshow

startBusDay : string

The start day of the week.

startTime : identifierList

Start time of each day.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

style : string

Style of the Schedule background

tabIndex : long

The index number of the tabbable control. Must be a long integer.

tabStop : boolean

Specifies if tabbing should stop on the tabbable control

timeSlotInterval : int

The interval of each time slot in minutes. Must be an Integer.

timeZone : string

Identifies the time zone used for the Schedule. A timezone ID; a name such as "America/Los_Angeles", or a custom ID such as "GMT-8:00". The client's detected time zone will be used if this is empty.

Example: "Etc/UTC", "America/New_York", "America/Los_Angeles"

toolbar : identifier

The toolbar associated with the Schedule

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

tooltip : string

The attribute, association path, or a constant specifying tooltip.

type : ScheduleRenderingType

Specifies if the schedule is the standard (calendar) or roadshow (event planning) type.

Valid values based on“string”.
standard
event

value : string

The attribute to which the control will bind.

visible : string

The attribute, association path, or a constant returning boolean to set visibility.

week : boolean

Specifies if the week is included in the Schedule.

year : boolean

Specifies if the year is included in the Schedule.

Parents