SchedulerControl.CustomDrawNavigationButton Event

Enables navigation buttons to be painted manually.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public event CustomDrawObjectEventHandler CustomDrawNavigationButton

VB.NET

Public Event CustomDrawNavigationButton As CustomDrawObjectEventHandler

Event Data

The CustomDrawNavigationButton event's data class is CustomDrawObjectEventArgs. The following properties provide information specific to this event:

Property	Description
Bounds	Returns the bounding rectangle of the drawing area.
Cache	Gets an object which specifies the storage for the pens, fonts and brushes. Use it for custom painting in Scheduler Reports.
Graphics	Gets an object used for painting.
Handled	Gets or sets whether an event was handled. If it was handled, the default actions are not required.
ObjectInfo	Gets information on the painted element.

The event data class exposes the following methods:

Method	Description
DrawDefault()	Renders the element using the default drawing mechanism.

Remarks

The CustomDrawNavigationButton event occurs before a navigation button is painted. The event parameter’s CustomDrawObjectEventArgs.ObjectInfo property provides information sufficient to paint a navigation button.

Example

This code example modifies the caption of the navigation button to display the number of appointments located within the discoverable time interval of a navigation button. This interval is specified by the SchedulerNavigationButtonOptions.AppointmentSearchInterval property. When one or more appointments fall in this interval, the navigation button becomes active and navigates to the nearest appointment. The navigation button is disabled if there are no appointments in that interval.

Note

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

CustomDraw.cs

public static void scheduler_CustomDrawNavigationButton(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e)
{
    NavigationButtonNext navButton = e.ObjectInfo as NavigationButtonNext;
    SchedulerControl scheduler = sender as SchedulerControl;
    SchedulerStorage storage = scheduler.Storage as SchedulerStorage;
    // Do not count by resources.
    if (scheduler.GroupType != SchedulerGroupType.None) return;

    if (navButton != null && scheduler != null && storage != null)
    {
        // Count appointments within the interval used by the Next navigation button.
        AppointmentBaseCollection apts = scheduler.Storage.Appointments.Items;
        TimeSpan aptSearchInterval = scheduler.OptionsView.NavigationButtons.AppointmentSearchInterval;
        DateTime lastVisibleTime = scheduler.ActiveView.GetVisibleIntervals().Last().End;
        int aptCount = apts.Where(a => (a.Start > lastVisibleTime) && (a.Start < lastVisibleTime.Add(aptSearchInterval))).Count();
        navButton.DisplayTextItem.Text = String.Format("Next {0} appointments", aptCount);
    }
}

CustomDraw.vb

Public Shared Sub scheduler_CustomDrawNavigationButton(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
    Dim navButton As NavigationButtonNext = TryCast(e.ObjectInfo, NavigationButtonNext)
    Dim scheduler As SchedulerControl = TryCast(sender, SchedulerControl)
    Dim storage As SchedulerStorage = TryCast(scheduler.Storage, SchedulerStorage)
    ' Do not count by resources.
    If scheduler.GroupType <> SchedulerGroupType.None Then
        Return
    End If

    If navButton IsNot Nothing AndAlso scheduler IsNot Nothing AndAlso storage IsNot Nothing Then
        ' Count appointments within the interval used by the Next navigation button.
        Dim apts As AppointmentBaseCollection = scheduler.Storage.Appointments.Items
        Dim aptSearchInterval As TimeSpan = scheduler.OptionsView.NavigationButtons.AppointmentSearchInterval
        Dim lastVisibleTime As Date = scheduler.ActiveView.GetVisibleIntervals().Last().End
        Dim aptCount As Integer = apts.Where(Function(a) (a.Start > lastVisibleTime) AndAlso (a.Start < lastVisibleTime.Add(aptSearchInterval))).Count()
        navButton.DisplayTextItem.Text = String.Format("Next {0} appointments", aptCount)
    End If
End Sub

Related GitHub Examples

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

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#

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

#region #CustomDrawNavigationButtonEvent
scheduler.CustomDrawNavigationButton += scheduler_CustomDrawNavigationButton;
scheduler.Services.DateTimeNavigation.NavigateBackward();

VB.NET

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

'            #Region "#CustomDrawNavigationButtonEvent"
AddHandler scheduler.CustomDrawNavigationButton, AddressOf scheduler_CustomDrawNavigationButton
scheduler.Services.DateTimeNavigation.NavigateBackward()