RangeControlAdjustEventArgs.Scales Property

Provides access to the collection of scales that will be visible in the RangeControl after it is automatically adjusted.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.Core.Desktop.dll

NuGet Package: DevExpress.Scheduler.CoreDesktop

Declaration

C#

public TimeScaleCollection Scales { get; }

VB.NET

Public ReadOnly Property Scales As TimeScaleCollection

Property Value

Type	Description
TimeScaleCollection	A TimeScaleCollection object specifying a set of RangeControl scales.

Remarks

Handle the SchedulerControl.RangeControlAutoAdjusting event and use the Scales property to customize a scale collection of the RangeControl before it is displayed when auto-adjusting is applied (see the SchedulerOptionsRangeControl.AutoAdjustMode property). For example, you can specify your own collection of scales for each scheduler view. The specified scale collections will be automatically switched when an end-user changes the scheduler active view.

By default, the following scale collections are displayed in the RangeControl when an end-user changes a view within the SchedulerControl, if the SchedulerOptionsRangeControl.AutoAdjustMode property is set to true:

Scheduler View	RangeControl scales
Day View, Work-Week View	The Day and Week scales
Week View, Month View	The Week and Month scales
Timeline View, Gantt View	Scales that are currently visible in the scheduler view

Example

This example demonstrates how to customize the auto-adjusting settings before they are applied to the RangeControl when an end-user switches the scheduler to the Work-Week or Month view.

1. Set the SchedulerOptionsRangeControl.AutoAdjustMode option to true.

2. Handle the SchedulerControl.RangeControlAutoAdjusting event. In this event handler, specify the RangeControl scales and range to be set when the Work-Week or Month view becomes active in the following way:

   • Work-Week

     By default, if the AutoAdjustMode option is enabled and an end-user switches the scheduler view to Work-Week, the RangeControl’s collection of scales (the RangeControlAdjustEventArgs.Scales property) includes all default scales (Year, Quarter, Month, Week, Day, Hour, 15 Minutes), and the Week and Day scales are visible.

     Leave this collection unchanged, but customize TimeScale.DisplayFormat and TimeScale.Width of the Day scale. To apply the specified format, disable the ScaleBasedRangeControlClientOptions.AutoFormatScaleCaptions option.

   • Month

     By default, if the AutoAdjustMode option is enabled and an end-user switches the scheduler view to Month, the RangeControl’s collection of scales (the RangeControlAdjustEventArgs.Scales property) includes all default scales (Year, Quarter, Month, Week, Day, Hour, 15 Minutes), and the Month and Week scales are visible.

     Clear the RangeControlAdjustEventArgs.Scales collection and specify new scales to be displayed in the RangeControl for the scheduler Month view. For example, add the TimeScaleMonth scale with the specified TimeScale.DisplayFormat and implement your own custom scale with a two-week interval and scale headers showing week numbers by inheriting it from the TimeScaleFixedInterval class. To apply the specified formats for scale headers, disable the ScaleBasedRangeControlClientOptions.AutoFormatScaleCaptions option.

     Set the RangeControlAdjustEventArgs.RangeMinimum and RangeControlAdjustEventArgs.RangeMaximum properties so that RangeControl’s range will be the whole year including the month that is visible in the scheduler.

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Native;

namespace WindowsFormsApplication1 {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void schedulerControl1_RangeControlAutoAdjusting(object sender,
                                                                RangeControlAdjustEventArgs e) {
            schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = true;
            SchedulerViewType activeViewType = schedulerControl.ActiveViewType;

            if (activeViewType == SchedulerViewType.WorkWeek) {
                schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = false;
                e.Scales[4].DisplayFormat = "dddd";
                e.Scales[4].Width = 70;
            }

            if (activeViewType == SchedulerViewType.Month) {
                schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = false;

                e.Scales.Clear();

                TimeScaleMonth monthScale = new TimeScaleMonth();
                monthScale.DisplayFormat = "MMMM yyyy";
                e.Scales.Add(monthScale);

                TwoWeekTimeScale twoWeekTimeScale = new TwoWeekTimeScale();
                twoWeekTimeScale.Width = 120;
                e.Scales.Add(twoWeekTimeScale);

                e.RangeMinimum = new DateTime(e.RangeMinimum.Year, 1, 1);
                e.RangeMaximum = e.RangeMinimum.AddYears(1);
            }
        }
    }

    public class TwoWeekTimeScale : TimeScaleFixedInterval {
        public TwoWeekTimeScale()
            : base(TimeSpan.FromDays(14)) {
        }
        public override DateTime Floor(DateTime date) {
            DateTime startOfWeeek = DateTimeHelper.GetStartOfWeekUI(date,
                                                                    DateTimeHelper.FirstDayOfWeek);
            if (DateTimeHelper.GetWeekOfYear(date) % 2 == 0)
                return startOfWeeek.AddDays(-7);

            return startOfWeeek;
        }
        public override string FormatCaption(DateTime start, DateTime end) {
            string dateString = "Week {0} - Week {1}";
            return String.Format(dateString, DateTimeHelper.GetWeekOfYear(start),
                                 DateTimeHelper.GetWeekOfYear(end.AddTicks(-1)));
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Native

Namespace WindowsFormsApplication1
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub schedulerControl1_RangeControlAutoAdjusting(ByVal sender As Object, _
                                                                ByVal e As RangeControlAdjustEventArgs) _
                                                            Handles schedulerControl.RangeControlAutoAdjusting
            schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = True
            Dim activeViewType As SchedulerViewType = schedulerControl.ActiveViewType

            If activeViewType = SchedulerViewType.WorkWeek Then
                schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = False
                e.Scales(4).DisplayFormat = "dddd"
                e.Scales(4).Width = 70
            End If

            If activeViewType = SchedulerViewType.Month Then
                schedulerControl.OptionsRangeControl.AutoFormatScaleCaptions = False

                e.Scales.Clear()

                Dim monthScale As New TimeScaleMonth()
                monthScale.DisplayFormat = "MMMM yyyy"
                e.Scales.Add(monthScale)

                Dim twoWeekTimeScale As New TwoWeekTimeScale()
                twoWeekTimeScale.Width = 120
                e.Scales.Add(twoWeekTimeScale)

                e.RangeMinimum = New DateTime(e.RangeMinimum.Year, 1, 1)
                e.RangeMaximum = e.RangeMinimum.AddYears(1)
            End If
        End Sub
    End Class

    Public Class TwoWeekTimeScale
        Inherits TimeScaleFixedInterval
        Public Sub New()
            MyBase.New(TimeSpan.FromDays(14))
        End Sub
        Public Overrides Overloads Function Floor(ByVal [date] As DateTime) As DateTime
            Dim startOfWeeek As DateTime = DateTimeHelper.GetStartOfWeekUI([date], DateTimeHelper.FirstDayOfWeek)
            If DateTimeHelper.GetWeekOfYear([date]) Mod 2 = 0 Then
                Return startOfWeeek.AddDays(-7)
            End If

            Return startOfWeeek
        End Function
        Public Overrides Function FormatCaption(ByVal start As DateTime, ByVal [end] As DateTime) As String
            Dim dateString As String = "Week {0} - Week {1}"
            Return String.Format(dateString, DateTimeHelper.GetWeekOfYear(start), _
                                 DateTimeHelper.GetWeekOfYear([end].AddTicks(-1)))
        End Function
    End Class
End Namespace