WorkdaysOptions.Workdays Property

Specifies which days of the week are the workdays.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraSerializableProperty]
public Weekday Workdays { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property Workdays As Weekday

Property Value

Type	Description
Weekday	A Weekday enumeration value(s), specifying the workdays for the week.

Available values:

Name	Description
None	Weekday is not specified.
Sunday	Identifies Sunday.
Monday	Identifies Monday.
Tuesday	Identifies Tuesday.
Wednesday	Identifies Wednesday.
Thursday	Identifies Thursday.
Friday	Identifies Friday.
Saturday	Identifies Saturday.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Workdays
DateTimeScaleOptions	.WorkdaysOptions .Workdays

Remarks

Apart from specifying the workdays within the week, you can define strict workdays (which have priority over the WorkdaysOptions.Holidays property setting), via the WorkdaysOptions.ExactWorkdays property.

For more information, refer to Data Aggregation.

Example

This example demonstates how to exclude non-working days (weekdays and holidays) from an axis range, via the AxisBase.WorkdaysOnly and AxisBase.WorkdaysOptions properties.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-chart-exclude-weekends-and-holidays-from-the-axis-range

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraCharts;
// ...
AxisX axisX = ((XYDiagram)chartControl1.Diagram).AxisX;

// Exclude holidays from the axis scale.
axisX.WorkdaysOnly = true;

// Specify custom working days.
axisX.WorkdaysOptions.Workdays = Weekday.Sunday | Weekday.Monday | Weekday.Tuesday |
    Weekday.Wednesday | Weekday.Thursday | Weekday.Friday;

// Specify holidays
axisX.WorkdaysOptions.Holidays.AddRange(new KnownDate[] {
    new KnownDate("Custom Holiday 1", new DateTime(1994, 3, 2, 0, 0, 0, 0)),
    new KnownDate("Custom Holiday 2", new DateTime(1994, 4, 2, 0, 0, 0, 0))});

// Specify strict working days.
// Thay will have a priority over the holidays specified.
axisX.WorkdaysOptions.ExactWorkdays.Add(
    new KnownDate("Community Work Day", new DateTime(1994, 3, 2, 0, 0, 0, 0)));

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraCharts
' ...
Dim axisX As AxisX = (CType(chartControl1.Diagram, XYDiagram)).AxisX

' Exclude holidays from the axis scale.
axisX.WorkdaysOnly = True

' Specify custom working days.
axisX.WorkdaysOptions.Workdays = Weekday.Sunday Or Weekday.Monday Or _ 
    Weekday.Tuesday Or Weekday.Wednesday Or Weekday.Thursday Or Weekday.Friday

' Specify holidays
axisX.WorkdaysOptions.Holidays.AddRange(New KnownDate() { _ 
    New KnownDate("Custom Holiday 1", New DateTime(1994, 3, 2, 0, 0, 0, 0)), _ 
    New KnownDate("Custom Holiday 2", New DateTime(1994, 4, 2, 0, 0, 0, 0))})

' Specify strict working days.
' Thay will have a priority over the holidays specified.
axisX.WorkdaysOptions.ExactWorkdays.Add(New KnownDate _ 
    ("Community Work Day", New DateTime(1994, 3, 2, 0, 0, 0, 0)))

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Workdays property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

winforms-chart-exclude-weekends-and-holidays-from-the-axis-range/VB/WeekendsExclusion/Form1.vb#L32

' In this example, Sunday is a work day and Saturday is a day off.
dateTimeScaleOptions.WorkdaysOptions.Workdays = Weekday.Sunday Or Weekday.Monday Or Weekday.Tuesday Or Weekday.Wednesday Or Weekday.Thursday Or Weekday.Friday
' Specifies custom holidays.