End-User Capabilities

Transcription

1 End-User Capabilities 2391 W informs Controls > Products > Scheduler > End-User Capabilities The topics in this section describe operations available to end-users of the XtraScheduler suite. The following topics are available: Change the Active View Control Visible Resources Create Appointments Delete Appointments Edit Appointments Navigate through Dates Navigate through Resources Navigate through Time Cells Select Dates Select Time Cells 2013 DevExpress Inc. 2391

2 Change the Active View 2392 W informs Controls > Products > Scheduler > End-User Capabilities > Change the Active View The SchedulerControl is intended to display appointments using one of the standard views. The currently active view used by the SchedulerControl can be either deliberately selected by an end-user, or changed by the SchedulerControl itself according to its internal logic. Only view s with the SchedulerView Base.Enabled property set to true are available. The active view is changed in the follow ing cases. Context Menu An end-user right-clicks anywhere within a scheduler area which is not occupied with an appointment and selects the corresponding item from the invoked context menu. The Change View To submenu contains several items which are responsible for changing the currently active view. These items can be represented by the SchedulerMenuItemId.SwitchToDayView, SchedulerMenuItemId.SwitchToWorkW eekview, SchedulerMenuItemId.SwitchToWeekView, SchedulerMenuItemId.SwitchToMonthView, SchedulerMenuItemId.SwitchToTimelineView and SchedulerMenuItemId.SwitchToGanttView enumeration members. Their availability depends on the view 's SchedulerView Base.Enabled property value. W hen a particular view is disabled, the corresponding menu item is not shown. Date Navigator The scheduler view is automatically sw itched to the most appropriate display type to show the date range w hich an end-user selects in the DateNavigator control. To learn more about this capability, refer to the Select Dates topic. Bar or Ribbon UI An end-user uses the Active View and Arrange toolbar or Ribbon page group. To know how to provide your scheduling application with a Bar or Ribbon UI, see Provide Bar UI for a Scheduler or Provide Ribbon UI for a Scheduler, respectively. Change the active view via Bar UI Change the active view via Ribbon UI 2013 DevExpress Inc. 2392

3 or - - or - To change the scheduler view programmatically, change the value of the SchedulerControl.ActiveView Type property. See the How to: Programmatically Change the Active View document, for more information DevExpress Inc. 2393

4 Control Visible Resources 2394 W informs Controls > Products > Scheduler > End-User Capabilities > Control Visible Resources To prevent the SchedulerControl from being overcrowded w ith too many resources displayed for the currently active view, end-users may choose to limit the number of currently visible resources. To provide this ability, we have introduced several controls into the XtraScheduler suite. Resource navigator This control is useful w hen appointments are grouped by resources or dates. Change the SchedulerControl.GroupType property to "Dates" or "Resources" and set the ResourceNavigator.Visibility to "Alw ays". It allows end-users to browse through the list of resources and change their number simultaneously. Also, refer to the Navigate through Resources document, to learn how this control can be used to brow se through visible resources. Special set of controls Although they look like the standard controls they're derived from, these controls are specially modified for cooperation with the SchedulerControl. After any of them is dropped onto the form, its SchedulerControl property is automatically set to the existing SchedulerControl, and is ready to work. Then, an end-user may check the boxes or select items from a drop-down list, resulting in the appointments with selected resources being hidden or displayed. ResourcesPopupCheckedListBoxControl ResourcesCheckedListBoxControl ResourcesComboBoxControl To programmatically change the number of resources which are simultaneously shown for a specific view, change the SchedulerViewBase.ResourcesPerPage property value of an appropriate view DevExpress Inc. 2394

5 Create Appointments 2395 W informs Controls > Products > Scheduler > End-User Capabilities > Create Appointments The actions available to end-users can be restricted by specifying the SchedulerOptionsCustomization properties. For an example, see the How to: Prevent End-Users from Editing Appointments document. Context menu An appointment can be created via the SchedulerControl's context menu. The corresponding items which may be used to create a new appointment are available in the context menu, invoked w hen an end-user right-clicks any scheduler area which is not occupied w ith an appointment. 1.New Appointment Invokes the Edit Appointment dialog. The Start time and End time values are initially set to the low and upper boundaries of the current date and time selection. The Show time as field is set to the Busy value of the AppointmentStatusType enumeration. The Resource field value is Any, although w hen appointments are grouped by resources, this field is set to the resource to which the selected cell belongs. Scheduling an appointment means filling in the Subject (Appointment.Subject) and Location ( Appointment.Location) fields. If necessary, an end-user may drop some lines of text into the Description text box (Appointment.Description), and they will be show n w ithin an appointment in either Day View or Work-Week View. To learn how to set the appointment's label and status values, refer to the Appointment Labels and Statuses. End-users can switch the appointment's Reminder for future notifications (Reminders for Appointments). 2.New All Day Event 2013 DevExpress Inc. 2395

6 2396 Invokes the Edit Event dialog which is used to create a new all-day appointment (also called 'all-day event'). The dialog is identical to Edit Appointment, except that in this case the All day event ( Appointment.AllDay) option is checked, its time range is measured in days (not hours) and marked as Free. The appointment can be transformed into the all-day event and vice-versa by checking this box. 3.New Recurring Appointment The concept of recurrence is explained in the Recurring Appointments and Exceptions document. Selecting this menu item invokes the Edit Appointment dialog used to create a new appointment, and also invokes the Appointment Recurrence dialog, which allow s the recurrence pattern to be specified for the new appointment. 4.New Recurring Event The concept of recurrence is explained in the Recurring Appointments and Exceptions document. Selecting this menu item invokes the Edit Event dialog used to create a new event, and also invokes the Appointment Recurrence dialog, which allow s the recurrence pattern to be specified for the new event. Bar or Ribbon UI If a scheduling application is provided w ith the Bar or Ribbon UI, end-users can create new appointments (simple and recurring) using the New Appointment and New Recurring Appointment buttons on the Appointment toolbar or Ribbon page group. These buttons invoke the Edit Appointment and Appointment Recurrence dialog, respectively. Create a new appointment via Bar UI Create a new appointment via Ribbon UI 2013 DevExpress Inc. 2396

7 2397 Key combinations and mouse clicks Invoke the In-place Editor Pressing an alphanumeric key or ENTER invokes an in-place editor that allows typing the subject of a new appointment occupying the currently selected area. Then, an end-user can either create and save the appointment by pressing ENTER or by changing the focus, or cancel the operation by pressing ESC. The type of the created appointment depends on the selected time cell(s). When typing is done in Day or Work-Week view, the appointment is created w ith the time interval starting with the earliest time of the selected cells, and ending with the latest, and the time is marked as Busy. If an all-day area is selected, or the Timeline or Gantt view is active, then an all-day appointment is created w ith the time marked as Free. When the scheduler display mode is Week or Month view, the appointment is created with the start time set to 12 AM of the first selected day, and the end time is set to 12 AM of the day following the last selected day. The built-in type of an in-place editor is simple. To customize it, handle the SchedulerControl. InplaceEditorShow ing event. For an example, refer to How to: Customize the In-Place Editor. Invoke the Edit Appointment Dialog Double-clicking within a scheduler view 's time cell that does not contain any appointments or pressing CTRL+N, invokes the Edit Appointment dialog described above. Copy an Existing Appointment Dragging an appointment with the right mouse button invokes the context menu, w hich an end-user can use to decide whether to move or copy the appointment, or cancel the operation. Dragging an appointment while holding CTRL creates a copy of the selected appointment and moves it, leaving the original appointment intact DevExpress Inc. 2397

8 Delete Appointments 2398 W informs Controls > Products > Scheduler > End-User Capabilities > Delete Appointments The actions available to end-users can be restricted by specifying the SchedulerOptionsCustomization properties. For an example, see the How to: Prevent End-Users from Editing Appointments document. Context menu An end-user may delete the selected appointment via the Delete item of the context menu, which is invoked when the appointment is right-clicked. Selecting this item removes the currently selected appointment. If the selected appointment is recurring, the Confirm Delete dialog is invoked. For more information on deleting appointments, see the Appointment.Delete method's description. Edit Appointment dialog When the appointment is being edited via the Edit Appointment dialog, an end-user is able to delete the corresponding appointment (a simple appointment, a w hole series of recurring appointments or particular occurrence) by clicking the Delete button of this dialog. For more information on deleting appointments, see the Appointment.Delete method's description DevExpress Inc. 2398

9 2399 Bar or Ribbon UI If a scheduling application is provided w ith the Bar or Ribbon UI, end-users can delete appointments (simple and recurring) using the Delete button on the Actions toolbar or Ribbon page group. If the appointment to be deleted is recurring, clicking this button invokes the drop-down list allow ing end-users to decide whether the w hole series of recurring appointments should be deleted or just a particular occurrence. Delete an appointment via Bar UI Delete an appointment via Ribbon UI Key combinations and mouse clicks The Delete key or the CTRL-D key combination can be used to delete the selected appointment(s). If the selected appointment is recurring, the Confirm Delete dialog is invoked DevExpress Inc. 2399

10 Edit Appointments 2400 W informs Controls > Products > Scheduler > End-User Capabilities > Edit Appointments The actions available to end-users can be restricted by specifying the SchedulerOptionsCustomization properties. For an example, see the How to: Prevent End-Users from Editing Appointments document. The SchedulerControl allow s end-users to modify existing appointments in the following ways: using the appointment context menu using the built-in dialogs using the in-place editor via the Bar or Ribbon UI via keyboard shortcuts and mouse operations Context Menu After an appointment has been right-clicked, the appointment context menu is invoked. The Show Time As and Label As items are used to alter an appointment. They allow changing the basic visual characteristics of an appointment - status and label. Change the appointment status Change the appointment label Edit Appointment and Appointment Recurrence Dialogs Edit a Simple Appointment End-users can edit properties of a simple (non-recurring) appointment via the Edit Appointment dialog that can be invoked via the appointment context menu, Bar or Ribbon UI, keyboard shortcuts and mouse operations. Context Menu Bar UI Ribbon UI Keyboard Invoked Edit 2013 DevExpress Inc. 2400

11 2401 Shortcuts and Mouse Operations Appointment Dialog Double-click the appointment to be edited. - or - Select an appointment, and then press ENTER or CTRL-O. Edit a Particular Occurrence in a Series The same dialog is used to edit a particular occurrence in the series of recurring appointments. If an enduser selects a recurring appointment, and clicks Open in the appointment context menu or the Open Occurrence button on the Action toolbar or Ribbon page group, the Edit Appointment dialog is invoked to allow editing the current appointment only, but not its entire series. Context Menu Bar UI Ribbon UI Keyboard Shortcuts and Mouse Operations Invoked Edit Appointment Dialog Double-click an appointment to be edited. - or - Select an appointment, and then press ENTER or CTRL-O. Edit a Series of Recurring Appointments To edit an entire series of recurring appointments (a pattern appointment), it's necessary to select a recurring appointment, and click Edit Series in the appointment context menu or select the Open Series item from the Open drop-down list on the Actions toolbar or Ribbon page group. In this instance, the Edit Appointment dialog is shown w ith a different w indow icon. Time fields are inaccessible. Context Menu Bar UI Ribbon UI Invoked Edit Appointment Dialog The recurrence pattern can be edited via the Appointment Recurrence dialog. End-users can invoke it by clicking the Recurrence button of the Edit Appointment dialog, or using the Recurrence button on the Options toolbar or Ribbon page group. The Edit Appointment Dialog Bar UI Ribbon UI Invoked Appointment Recurrence Dialog 2013 DevExpress Inc. 2401

12 2402 In-place Editing A single mouse click within an appointment, or pressing F2, invokes the in-place editor, which can be used to edit the selected appointment's Subject. To learn how to create a custom in-place editor, refer to How to: Customize the In-Place Editor. Bar or Ribbon UI If a scheduling application is provided w ith the Bar or Ribbon UI, end-users can modify appointment properties ( status, label, recurrence and reminder) using the Options toolbar or Ribbon page group, w hich is active when an appointment is selected by an end-user. Modify an appointment via the Bar UI Modify an appointment via the Ribbon UI Keyboard Shortcuts and Mouse Operations 2013 DevExpress Inc. 2402

13 2403 Action Click an appointment Right-click an appointment Click appointments w hile holding the CTRL key pressed ENTER or CTRL+O Double-click an appointment F2 Drag appointment edges Click and drag an appointment w ith the left mouse button Click and drag an appointment w ith the right mouse button Press and hold the CTRL key, click and drag an appointment(s) w ith the left mouse button Description Selects an appointment. Selects an appointment and invokes the context menu for the selected appointment. Enables end-users to select multiple appointments. Invokes the Edit Appointment dialog for the selected appointment. Invokes the Edit Appointment dialog. Invokes the in-place editor to modify the selected appointment. Resizes the rectangle representing an appointment. Results in changing its start/end times. Moves the appointment across time cells, changing its Start time and End time properties. Invokes the context menu allowing end-users to select between moving the appointment, copying it or canceling the operation. Creates a copy of the selected appointment(s) when the mouse button is released DevExpress Inc. 2403

14 Navigate through Dates 2404 W informs Controls > Products > Scheduler > End-User Capabilities > Navigate through Dates End-users are able to navigate through dates with the help of the Date Navigator, via the corresponding items of the scheduler's context menu, or via the Bar or Ribbon UI. Date Navigator W hen the DateNavigator control is placed onto the form at design time, its DateNavigator.SchedulerControl property is automatically set to the available SchedulerControl. When two controls are bound this w ay, an enduser is able to pick a date within the date navigator, and see this date's appointments displayed by the SchedulerControl. End-users can navigate to the desired month and year by clicking the corresponding arrow s on the DateNavigator date header. Clicking the left and right scrolling buttons navigates back and forth by one step. Clicking the Today button selects the current date. W hen an end-user clicks the DateNavigator control, one day is selected, and the SchedulerControl displays it using the Day View. that if the currently active view of the SchedulerControl is of another type, then it is automatically changed to the Day View. The only exception is the Work Week View. When the scheduler is showing its data using the Work Week View, an attempt to select one day by DateNavigator selects the entire work w eek. The scheduler synchronizes itself w ith the date navigator. So, w hen a w eek long range of dates is selected in a date navigator, the scheduler switches to Week View. If a end-user selects more than one week, then a Month View is chosen automatically w hich improves the visual appearance. For more information on how to select date ranges, see the Select Dates document. Context Menu Right-clicking w ithin the scheduler main area w hich is not occupied with an appointment invokes the context menu which contains items for navigation through dates. They are: Go to This Day, Go to Today, Go to Date.... Go to This Day This item is shown only in the Week View and Month View, and is active only w hen one day is selected. Clicking this item displays the selected day in the Day View. Go to Today Moves focus to the current day preserving the existing view mode. Go to Date... Invokes the Go To Date dialog to select the date and view type. The date can be selected using either the calendar control, or by entering a string with the placeholders. To select the desired view type, use the Show In drop-dow n list DevExpress Inc. 2404

15 2405 Bar or Ribbon UI If a scheduling application is provided w ith the Bar or Ribbon UI, end-users can navigate through dates within a scheduler using the Backward, Forward and Go to Today buttons on the Navigate toolbar or Ribbon page group. Navigate through dates via Bar UI Navigate through dates via Ribbon UI See Also DateTime Navigation Services 2013 DevExpress Inc. 2405

16 Navigate through Resources 2406 W informs Controls > Products > Scheduler > End-User Capabilities > Navigate through Resources When appointments data is grouped (either by resources or by dates), the number of resources shown on the screen within the Scheduler Control at one time can make it difficult to see all the scheduled data. To make the Scheduler's layout more readable, it is possible to limit the number of visible resources, and then scroll betw een them. There is a ResourceNavigator control embedded into the SchedulerControl, and show n if required, which allows end-users to scroll betw een resources. The visibility of the resource navigator element depends on several conditions. First, ResourceNavigator can only be show n when there are visible resources to display. Second, the appointments should be grouped (the SchedulerControl.GroupType property value is other than SchedulerGroupType.None). Third, there is a ResourceNavigator.Visibility property. W hen it is set to ResourceNavigatorVisibility.Auto, the control is show n only w hen the SchedulerView Base.ResourcesPerPage property for the current view is not 0 (zero value means an indefinite number of resources per page). The Resource Navigator control is composed of a scroll bar and a set of buttons. It may be show n horizontally (on the bottom line of a scheduler control, with buttons in the right corner) or vertically (on the right side, buttons at the bottom). The position of the control is chosen automatically. It is vertical in a DayView mode or in a WeekView, if appointments are grouped by dates, and horizontal in other view modes. The mode of operation is rather straightforward - the user can click the buttons to move back and forth through the list of resources; one by one, or straight to the last one on the list. The scroll bar scrolls through resources. The scheduler tracks selections and displays the corresponding resource groups. The buttons w ith plus and minus signs increase or decrease the number of show n resources by one. The number of resources displayed simultaneously is specified by the SchedulerViewBase.ResourcesPerPage property for each view individually. See Also Resource Navigation Services 2013 DevExpress Inc. 2406

17 Navigate through Time Cells 2407 W informs Controls > Products > Scheduler > End-User Capabilities > Navigate through Time Cells The keyboard shortcuts and mouse operations described in this topic can be used to move focus between time cells. The follow ing table contains the common navigation operations available to end-users. Action Clicking a cell Pressing the UP or DOWN ARROW key Pressing the LEFT or RIGHT ARROW key Pressing the PAGE DOWN key Pressing the PAGE UP key Pressing the HOME key Pressing the END key Pressing the CTRL + HOME key Pressing the CTRL + END key Effect Moves focus to the clicked cell. Dependent on the type of the active view Day View, Work Week View - Moves focus to the previous or next time cell w ithin the current day. Week View - Moves focus to the previous or next day. Month View - Moves focus to the same day of the w eek for the previous or next week. Dependent on the type of the active view Day View, Work Week View - Moves focus to the corresponding time cell of the previous or next day. Week View - Moves focus to the left or right of the corresponding cell of a column. The view is scrolled to the previous or next week if necessary. Month View - Moves focus to the previous or next day. Moves the row focus one page dow n preserving the column focus. Moves the row focus one page up preserving the column focus. Dependent on the type of the active view Day View, Work Week View - Moves focus to the cell corresponding to the time value of the DayView.W orktime within the current day. Week View, Month View - Moves focus to the first day shown in the current w eek - SchedulerView Base.VisibleIntervals Dependent on the type of the active view Day View, Work Week View - Moves focus to the cell corresponding to the TimeOfDayInterval.End time value of the DayView.WorkTime w ithin the current day. Week View, Month View - Moves focus to the last day shown in the current w eek. Dependent on the type of the active view Day View, Work Week View - Moves focus to the first cell of the day's visible time span. Week View, Month View - Moves focus to the first day shown in the current w eek. Dependent on the type of the active view Day View, Work Week View - Moves focus to the 2013 DevExpress Inc. 2407

18 2408 last cell of the day's visible time span. Week View, Month View - Moves focus to the last day shown in the current w eek. Pressing the TAB key Pressing the SHIFT-TAB key Pressing the ALT with UP (DOWN) ARROW keys Sw itches to appointments navigation. A focus shifts to the next time appointment within the time span shown. Pressing the key repeatedly iterates through the appointments in the follow ing way- appointments w ith a definite duration are follow ed by all-day appointments. Sw itches to appointments navigation. A focus shifts to the previous time appointment within the time span shown. Pressing the key repeatedly iterates through the appointments in the follow ing way- appointments w ith a definite duration are follow ed by all-day appointments. Dependent on the type of the active view Day View, Work Week View, Month View - Moves focus one w eek before or after. Week View - acts as LEFT(RIGHT) ARROW keys W hen appointments are grouped, only ARROW keys can move focus to another resource group DevExpress Inc. 2408

19 Select Dates 2409 W informs Controls > Products > Scheduler > End-User Capabilities > Select Dates End-users are able to select either a particular date, or a range of dates by means of the DateNavigator control, or directly in Scheduler's time cell grid. Selecting dates using the DateNavigator control results in displaying them by the SchedulerControl, to which it is linked. The behavior of these controls is similar to that of MS Outlook. Using the DateNavigator control Action Click any date in the DateNavigator calendar. Click and drag across the DateNavigator calendar. Hold dow n the CTRL key and click several dates. Effect One day becomes selected, and the SchedulerControl displays it using the Day View. If the currently active view is of another type, it is automatically changed to Day View. The only exception is the Work Week View. In this instance, the entire w ork week is selected. The continuous range of dates is selected. The SchedulerControl adjusts the currently active view to display the selected range of dates. If the selection is smaller than a week, the view type is switched to Day View. A week-long range is displayed using the Scheduler's W eek View. If the range is more than a week, then the Month View is used. A set of dates is selected. The SchedulerControl displays it using the Day View, irrespective of the size of the selected range. To prevent end-users from selecting multiple dates, set the DateNavigator.Multiselect property to false. The selection is defined by the Selection, SelectionStart and SelectionEnd properties of the DateNavigator class. Using the SchedulerControl control Action Click any date in the SchedulerControl (if the currently active view is set to either the Week View or the Month View). Click and drag across the time cells (in the Week View or Month View only). Effect One day is selected. A continuous range of dates is selected. The selected range in the DateNavigator control is not affected, although it goes along w ith the range displayed within the SchedulerControl. The selection is defined by the SchedulerControl.SelectedInterval property of the SchedulerControl class. Only view s w ith SchedulerViewBase.Enabled set to true are available for the scheduler to display data DevExpress Inc. 2409

20 Select Time Cells 2410 W informs Controls > Products > Scheduler > End-User Capabilities > Select Time Cells The actions available to the user can be restricted by specifying the SchedulerOptionsCustomization properties. The SchedulerControl provides end-users with the ability to select time cells using either a mouse or the available keyboard shortcuts. Action Clicking w ith the mouse. Clicking and dragging with the mouse. Pressing the SHIFT+ARROW KEY combination. Effect One time cell is selected. A continuous range of time cells is selected. Enables end-users to select a continuous range of time cells. that w hen such actions are carried out any previous cell selection is cleared. The selected range is defined by the SchedulerControl.SelectedInterval property of the SchedulerControl class DevExpress Inc. 2410

21 Zoom 2411 W informs Controls > Products > Scheduler > End-User Capabilities > Zoom End-users can zoom in the scheduler view to display its content in greater detail, or zoom out for a more general view. Zooming is implemented by adjusting the time scale (in the Day View, Work-Week View and Timeline View ) or changing the number of visible w eeks (in the Month View ). Zooming operations are available for end-users via the CTRL+PLUS SIGN, CTRL+MINUS SIGN or CTRL+MOUSE WHEEL key combinations. If a scheduling application is provided w ith the Bar or Ribbon UI, end-users can zoom in and zoom out the scheduler area using the corresponding buttons on the Navigate toolbar or Ribbon page group. Bar UI Ribbon UI 2013 DevExpress Inc. 2411