CustomAppointmentBackgroundEventArgs.Background Property

Gets or sets a background color for the appointment.

Namespace: DevExpress.Xpf.Scheduling

Assembly: DevExpress.Xpf.Scheduling.v18.2.dll

Declaration

C#

public Brush Background { get; set; }

VB.NET

Public Property Background As Brush

Property Value

Type	Description
Brush	A Brush descendant used to paint the appointment background.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-handle-the-customappointmentbackground-event-to-change-the-appointments-background-t584687.

MainWindow.xaml.vb

Private Sub SchedulerControl_CustomAppointmentBackground(ByVal sender As Object, ByVal e As CustomAppointmentBackgroundEventArgs)
    'Change the recurrent appointments' background to blanched almond color,
    'and other appointments - to rosy brown 
    e.Background = If(e.AppointmentItem.Type = AppointmentType.Occurrence, New SolidColorBrush(Colors.BlanchedAlmond), New SolidColorBrush(Colors.RosyBrown))

    'Change all-day appointments' background:
    e.Background = If(e.AppointmentItem.AllDay = True, New SolidColorBrush(Colors.Tomato), e.Background)
End Sub

MainWindow.xaml

<dxsch:SchedulerControl x:Name="scheduler" CommandBarStyle="Ribbon" 
                        GroupType="Resource" 
                        FirstDayOfWeek="Monday"                                 
                        ActiveViewIndex="0" CustomAppointmentBackground="SchedulerControl_CustomAppointmentBackground">

MainWindow.xaml.cs

private void SchedulerControl_CustomAppointmentBackground(object sender, CustomAppointmentBackgroundEventArgs e)
{
    //Change the recurrent appointments' background to blanched almond color,
    //and other appointments - to rosy brown 
    e.Background = (e.AppointmentItem.Type == AppointmentType.Occurrence) ?
    new SolidColorBrush(Colors.BlanchedAlmond) : new SolidColorBrush(Colors.RosyBrown);

    //Change all-day appointments' background:
    e.Background = (e.AppointmentItem.AllDay == true) ? new SolidColorBrush(Colors.Tomato) : e.Background;
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Background 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.

C#

how-to-handle-the-customappointmentbackground-event-to-change-the-appointments-background-t584687/CS/CustomAppointmentBackground/MainWindow.xaml.cs#L35

//and other appointments - to rosy brown
e.Background = (e.AppointmentItem.Type == AppointmentType.Occurrence) ?
new SolidColorBrush(Colors.BlanchedAlmond) : new SolidColorBrush(Colors.RosyBrown);

VB.NET

how-to-handle-the-customappointmentbackground-event-to-change-the-appointments-background-t584687/VB/CustomAppointmentBackground/MainWindow.xaml.vb#L33

'and other appointments - to rosy brown
e.Background = If(e.AppointmentItem.Type = AppointmentType.Occurrence, New SolidColorBrush(Colors.BlanchedAlmond), New SolidColorBrush(Colors.RosyBrown))