TcxSchedulerResourceNavigator Class

Implements the resource navigator.

Declaration

TcxSchedulerResourceNavigator = class(
    TcxSchedulerSubControl
)

Remarks

Resources are used to group schedules (if the View’s GroupingKind property is set to gkByResource or gkByDate and more than one resource is defined) to facilitate managing user time.

The scheduler allows an end-user to navigate through the resources in the scheduling area. To change the resources in the time View, an end-user can use the resource navigation buttons and scrollbar located in the scheduling area:

An end-user can scroll resources forwards or backwards one at a time, browse resources by pages forwards or backwards, jump to the first or last resource and increment or decrement the number of resources that will be displayed in the scheduling area.

The TcxSchedulerResourceNavigator class provides a flexible mechanism for organizing resources into multiple pages to allow end-users to view resources that are split across pages or to show all the resources in the scheduling area at the same time (see the TcxSchedulerOptionsView.ResourcesPerPage property).

It allows custom buttons to be specified to define other ways of changing the resources displayed in the scheduling area (see the CustomButtons property and the OnButtonClick event).

The TcxSchedulerResourceNavigator class provides access to the built-in buttons (see the Buttons property) allowing them to be modified as follows:

The visibility of each button (see the TcxSchedulerNavigatorButton.Visible property);
The button’s glyph (see the TcxSchedulerNavigatorButton.ImageIndex property);
The hint text (see the TcxSchedulerNavigatorButton.Hint property).

The visibility of the entire resource navigator can be specified (see the Visibility property) or just a set of the resource navigation buttons (see the ShowButtons property).

If required, a different collection of images with which the buttons are drawn can be specified (see the ButtonImages property). And the buttons can also be custom painted (see the TcxSchedulerResourceNavigator.OnCustomDrawButton event).

The scheduler’s ResourceNavigator property references a TcxSchedulerResourceNavigator object.