SchedulerControl.QueryResourceColorSchema Event

Enables visible resources to be painted according to certain conditions.

Namespace: DevExpress.Xpf.Scheduler

Assembly: DevExpress.Xpf.Scheduler.v14.2.dll

Declaration

C#

public event QueryResourceColorSchemaEventHandler QueryResourceColorSchema

VB.NET

Public Event QueryResourceColorSchema As QueryResourceColorSchemaEventHandler

Event Data

The QueryResourceColorSchema event's handler receives an argument of the QueryResourceColorSchemaEventArgs type. The following properties provide information specific to this event:

Property	Description
Resource	Gets the resource for which the color schema is queried.
ResourceColorIndex	Gets the index of the processed resource's color schema in a SchedulerColorSchemaCollection collection.
ResourceColorSchema	Gets or sets a color schema to be used for a visible resource coloring.

Remarks

By default, if you change a set of visible resources (for example, by using resource filter controls) the collection of resource color schemas will remain unchanged (SchedulerControl.GetResourceColorSchemasCopy), i.e. the same color schemas in the same order will be used to paint newly selected resources that are to be displayed in the scheduler.

However, you can assign a specific color schema to each resource to be displayed. To do this, handle the QueryResourceColorSchema event.

The QueryResourceColorSchema event is raised before a resource to be displayed in the scheduler is painted. The event parameter's Resource property provides information on a processed resource. To associate this resource with a required color schema, use the QueryResourceColorSchemaEventArgs.ResourceColorSchema property.

The QueryResourceColorSchema event can be helpful, if it is required to paint resources according to certain conditions (for example, to highlight a selected resource or specify a certain color schema for a resource, depending on its custom field value, etc.).

Examples

This example demonstrates how to link a specific scheduler color schema to each visible resource.

Call the SchedulerControl.GetResourceColorSchemasCopy method to obtain a collection of color schemas that are currently available for resource coloring, and handle the SchedulerControl.QueryResourceColorSchema event to associate a specific color schema from the obtained collection to each resource displayed in the scheduler control.

C#

using DevExpress.XtraScheduler;
using System.Collections.Generic;
// ...

namespace WpfApplication1 {
    public partial class MainWindow : Window {

        Dictionary<object, SchedulerColorSchema> resourceColorSchemas = 
            new Dictionary<object, SchedulerColorSchema>();

        public MainWindow() {
            InitializeComponent();

            // Get copies of color schemas that are currently used to paint resources.
            PrepareResourceColorSchemas();
        }

        // ...

        private void PrepareResourceColorSchemas() {
            int count = schedulerControl1.Storage.ResourceStorage.Count;
            SchedulerColorSchemaCollection currentColorchemas = 
                schedulerControl1.GetResourceColorSchemasCopy();
            int schemaCount = currentColorchemas.Count;
            for (int i = 0; i < count; i++) {
                Resource resource = schedulerControl1.Storage.ResourceStorage[i];
                resourceColorSchemas.Add(resource.Id, currentColorchemas[i % schemaCount]);
            }
        }

        private void schedulerControl1_QueryResourceColorSchema(object sender, 
                                                                QueryResourceColorSchemaEventArgs e) {
            object key = e.Resource.Id;
            if (this.resourceColorSchemas.ContainsKey(key))
                e.ResourceColorSchema = this.resourceColorSchemas[key];
            }
        }
    }
}

VB.NET

using DevExpress.XtraScheduler;
using System.Collections.Generic;
// ...

namespace WpfApplication1 {
    public partial class MainWindow : Window {

        Dictionary<object, SchedulerColorSchema> resourceColorSchemas = 
            new Dictionary<object, SchedulerColorSchema>();

        public MainWindow() {
            InitializeComponent();

            // Get copies of color schemas that are currently used to paint resources.
            PrepareResourceColorSchemas();
        }

        // ...

        private void PrepareResourceColorSchemas() {
            int count = schedulerControl1.Storage.ResourceStorage.Count;
            SchedulerColorSchemaCollection currentColorchemas = 
                schedulerControl1.GetResourceColorSchemasCopy();
            int schemaCount = currentColorchemas.Count;
            for (int i = 0; i < count; i++) {
                Resource resource = schedulerControl1.Storage.ResourceStorage[i];
                resourceColorSchemas.Add(resource.Id, currentColorchemas[i % schemaCount]);
            }
        }

        private void schedulerControl1_QueryResourceColorSchema(object sender, 
                                                                QueryResourceColorSchemaEventArgs e) {
            object key = e.Resource.Id;
            if (this.resourceColorSchemas.ContainsKey(key))
                e.ResourceColorSchema = this.resourceColorSchemas[key];
            }
        }
    }
}

XAML

<dxsch:SchedulerControl Name="schedulerControl1"
                        QueryResourceColorSchema="schedulerControl1_QueryResourceColorSchema"/>