IntervalLoadRatioCalculator.Calculate() Method

Calculates the ratio of the time occupied by appointments to the entire time interval.

Namespace: DevExpress.XtraScheduler.Tools

Assembly: DevExpress.XtraScheduler.v18.2.Core.dll

Declaration

C#

public virtual float Calculate()

VB.NET

Public Overridable Function Calculate As Single

Returns

Type	Description
Single	A Single value that is the time occupancy ratio.

Remarks

This example uses the All-Day Area to display a worktime load, which is the ratio of the time occupied by appointments to the entire time interval. To calculate this parameter, the IntervalLoadRatioCalculator class instance is used.

Visual elements are painted using methods of the GraphicsCache object, available by the CustomDrawObjectEventArgs.Cache property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044

CustomDraw.cs

public static void scheduler_CustomDrawDayViewAllDayArea(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e)
{
    AllDayAreaCell cell = (AllDayAreaCell)e.ObjectInfo;
    Resource resource = cell.Resource;
    TimeInterval interval = cell.Interval;
    AppointmentBaseCollection apts = ((SchedulerControl)sender).Storage.GetAppointments(interval);
    // Specify what precentage of the appointment duration should be painted.
    float percent = CalcCurrentWorkTimeLoad(apts, interval, resource);
    Brush brush;
    // Select the brush color.
    if (percent == 0.0)
        brush = Brushes.LightYellow;
    else if (percent < 0.5)
        brush = Brushes.LightBlue;
    else brush = Brushes.LightCoral;
    // Paint the area with the selected color.
    e.Cache.FillRectangle(brush, e.Bounds);
    // Draw the percentage text. 
    StringFormat format = new StringFormat();
    format.LineAlignment = StringAlignment.Center;
    format.Alignment = StringAlignment.Center;
    e.Cache.DrawString(string.Format("{0:P}", percent), cell.Appearance.Font, Brushes.Black, e.Bounds, format);
    e.Handled = true;
}
private static float CalcCurrentWorkTimeLoad(AppointmentBaseCollection apts, TimeInterval interval, Resource resource)
{
    AppointmentBaseCollection aptsByResource = new AppointmentBaseCollection();
    var aptQuery = apts.Where(a => a.ResourceId.Equals(resource.Id));
    aptsByResource.AddRange(aptQuery.ToList());

    DevExpress.XtraScheduler.Tools.IntervalLoadRatioCalculator calc =
        new DevExpress.XtraScheduler.Tools.IntervalLoadRatioCalculator(interval, aptsByResource);
    return calc.Calculate();
}

CustomDraw.vb

Public Shared Sub scheduler_CustomDrawDayViewAllDayArea(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
    Dim cell As AllDayAreaCell = CType(e.ObjectInfo, AllDayAreaCell)
    Dim resource As Resource = cell.Resource
    Dim interval As TimeInterval = cell.Interval
    Dim apts As AppointmentBaseCollection = DirectCast(sender, SchedulerControl).Storage.GetAppointments(interval)
    ' Specify what percentage of the appointment duration should be painted.
    Dim percent As Single = CalcCurrentWorkTimeLoad(apts, interval, resource)
    Dim brush As Brush
    ' Select the brush color.
    If percent = 0.0 Then
        brush = Brushes.LightYellow
    ElseIf percent < 0.5 Then
        brush = Brushes.LightBlue
    Else
        brush = Brushes.LightCoral
    End If
    ' Paint the area with the selected color.
    e.Cache.FillRectangle(brush, e.Bounds)
    ' Draw the percentage text. 
    Dim format As New StringFormat()
    format.LineAlignment = StringAlignment.Center
    format.Alignment = StringAlignment.Center
    e.Cache.DrawString(String.Format("{0:P}", percent), cell.Appearance.Font, Brushes.Black, e.Bounds, format)
    e.Handled = True
End Sub
Private Shared Function CalcCurrentWorkTimeLoad(ByVal apts As AppointmentBaseCollection, ByVal interval As TimeInterval, ByVal resource As Resource) As Single
    Dim aptsByResource As New AppointmentBaseCollection()
    Dim aptQuery As IEnumerable(Of Appointment)
    aptQuery = apts.Where(Function(a) a.ResourceId.Equals(resource.Id))
    aptsByResource.AddRange(aptQuery.ToList())

    Dim calc As New DevExpress.XtraScheduler.Tools.IntervalLoadRatioCalculator(interval, aptsByResource)
    Return calc.Calculate()
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Calculate() method.

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.

C#

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/CS/Form1.cs#L59

    IntervalLoadRatioCalculator calc = new IntervalLoadRatioCalculator(interval, aptsByResource);
    return calc.Calculate();
}

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomDraw.cs#L201

        new DevExpress.XtraScheduler.Tools.IntervalLoadRatioCalculator(interval, aptsByResource);
    return calc.Calculate();
}

VB.NET

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/VB/Form1.vb#L57

    Dim calc As New IntervalLoadRatioCalculator(interval, aptsByResource)
    Return calc.Calculate()
End Function

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/CustomDraw.vb#L193

    Dim calc As New DevExpress.XtraScheduler.Tools.IntervalLoadRatioCalculator(interval, aptsByResource)
    Return calc.Calculate()
End Function