ScheduleLayout

Overview

The schedule layout allows users to see a calendar of schedule items associated one or more entities. You can configure the control to show a calendar associated with a contact (as is done in EntitySchedule.layout) or a calendar associated with one or more users (as is done in ScheduleEntity.layout). To show a calendar for multiple users, configure the Resources and Editor sub-elements to show a selection menu of users or other entities.

For detailed information on how users can interact with calendars, see the end user documentation set and search for "Using your schedule."

Example

The following example is taken from the "Schedule" portlet. It has been simplified from the source for illustration purposes.

XML

      <ScheduleLayout entity="entity" head="true" name="schedule" names="fullName" spanEnd="endTime" spanStart="startTime">
         <Schedule allDay="act isAllDay" captions="act scheduleItemSummary" codes="act scheduleStyle" contactNames="fullName" contacts="lightEntityParticipants" endTimes="act adjustedEndTime" icons="act icon" monthCaptions="act scheduleItemCaptionMonth" notes="act textPreview" participantIds="entity" participants="resource" precisions="day workweek week month" startTimes="act startTime" weekCaptions="act scheduleItemSummary">
            <Resources icons="(image . (viewee image))(data . mimeData)(type . mimeType)(icon . (viewee icon))(default . "businessman_workspace")" ids="viewee" items="(@@ ScheduleViewState)" names="viewee fullName" order="displayOrder" texts="viewee initial" visible="visible" where="(= (@ viewer) (user-person))"/>
            <Editor caption="idsf.ScheduleViewOthers.caption" editCaption="ids.edit" ref="mda:UserPersonScheduleViewPicker"/>
         </Schedule>
         <Toolbar name="toolbarMenu">
            <Item caption="ids.addScheduleItem" icon="plus_grey" name="addItem" source="schedule">
               <Menu action="true" captions="caption" event="scheduleItemDetailAdd" icons="icon" items="(@@ ActTemplate)" name="insertMenuItem13" order="(((@ currentLocalization caption) . #t))" source="schedule" where="(and (@ allowNew) (@ isSchedTemplate))"/>
            </Item>
         </Toolbar>
         <Menu name="rightClickMenu">
            <Item caption="idsa.UIEvents.edit" event="sysProperties" icon="edit" name="mitRMBEdit"/>
            <Item caption="ids.record.remove" event="sysRemove" icon="remove" name="mitRMBDelete"/>
         </Menu>
         <Indicators endTimes="act endTime" items="(@@ ScheduleEntity)" resourceValues="entity" spanEndTimes="endTime" spanStartTimes="startTime" startTimes="act startTime"/>
	</ScheduleLayout>

Explanation

Supported elements for the schedule layout control are Schedule, Toolbar, Menu, Indicator.

Schedule

The schedule element configures the calendar and how the different aspects of the calendar are displayed with respect to associations in the model.

The Resources and Editor sub-elements determine the configuration for the user picker that displays on the bottom-left corner of a calendar.

Similar to other toolbars, you can use this to configure menu items accessible at the top level of the schedule portlet.

Similar to other Menu elements, you can use this to configure actionable menu items for each schedule item displayed in the calendar.

Indicator

The indicator element configures the mini calendar shown on the top-left corner of the calendar. Specifically, it configures the model associations to determine how a "dot" appears on days of the calendar with schedule items, and for which users.

More details

More information about specific properties for the ScheduleLayout control and Schedule control can be found in the Model Description Language Reference.