SchedulerControl.CustomizeDateNavigationBarCaption Event

Handle this event to specify the caption of the Date Navigation Bar control.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.2.dll

Declaration

C#

public event EventHandler<CustomizeDateNavigationBarCaptionEventArgs> CustomizeDateNavigationBarCaption

VB.NET

Public Event CustomizeDateNavigationBarCaption As EventHandler(Of CustomizeDateNavigationBarCaptionEventArgs)

Event Data

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

Property	Description
Caption	Gets or sets a text displayed as a caption in the SchedulerDateNavigationBar control.
Interval	Gets the visible date interval of the SchedulerControl which should be indicated in the Date Navigation Bar control.

Example

The image illustrates how the text in the Date Navigation Bar control is changed by handling the SchedulerControl.CustomizeDateNavigationBarCaption event.

Note

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

CustomizingVisualElements.cs

    scheduler.CustomizeDateNavigationBarCaption += scheduler_CustomizeDateNavigationBarCaption;
    scheduler.ActiveView.LayoutChanged();
public static void scheduler_CustomizeDateNavigationBarCaption(object sender, CustomizeDateNavigationBarCaptionEventArgs e) {
    e.Caption = String.Format("Displaying dates from {0:D} to {1:D}", e.Interval.Start.Date, e.Interval.End.Date);
}

CustomizingVisualElements.vb

    AddHandler scheduler.CustomizeDateNavigationBarCaption, AddressOf scheduler_CustomizeDateNavigationBarCaption
    scheduler.ActiveView.LayoutChanged()
Public Shared Sub scheduler_CustomizeDateNavigationBarCaption(ByVal sender As Object, ByVal e As CustomizeDateNavigationBarCaptionEventArgs)
    e.Caption = String.Format("Displaying dates from {0:D} to {1:D}", e.Interval.Start.Date, e.Interval.End.Date)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomizeDateNavigationBarCaption 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/CustomizingVisualElements.cs#L99

#region #CustomizeDateNavigationBarCaptionEvent
scheduler.CustomizeDateNavigationBarCaption += scheduler_CustomizeDateNavigationBarCaption;
scheduler.ActiveView.LayoutChanged();

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/CustomizingVisualElements.vb#L83

'            #Region "#CustomizeDateNavigationBarCaptionEvent"
AddHandler scheduler.CustomizeDateNavigationBarCaption, AddressOf scheduler_CustomizeDateNavigationBarCaption
scheduler.ActiveView.LayoutChanged()