AppointmentDisplayTextEventArgs.Description Property

Gets or sets the text that will be displayed as an appointment’s description.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

public string Description { get; set; }

VB.NET

Public Property Description As String

Property Value

Type	Description
String	A String value which represents the description displayed for the appointment.

Remarks

Handle the SchedulerControl.InitAppointmentDisplayText event and then use the Description property to customize the description of the appointment before it’s displayed. To change the displayed text of the appointment (its subject and location together) the AppointmentDisplayTextEventArgs.Text property should be used.

Note

The current appointment to be displayed is accessed via the AppointmentEventArgs.Appointment property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Description 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#

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomizingVisualElements.cs#L24

e.Text += "------\r\n";
if(e.Description != String.Empty) {
    e.Description = string.Empty;

how-to-resize-an-appointment-without-snapping-it-to-time-cells-e2341/CS/WindowsApplication1/Form1.cs#L138

{
    e.Text = e.Description;
    e.Description = "";

how-to-export-appointments-with-custom-fields-to-vcalendar-format-e638/CS/VCalendarCustomFields/Form1.cs#L69

    CustomObject obj = e.Appointment.CustomFields[CustomFieldName] as CustomObject;
    e.Description = (obj != null) ? obj.ToString() : "(no custom info)";
}

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/CS/iCalendarExportImport/Form1.cs#L160

CustomObject obj = e.Appointment.CustomFields[CustomFieldName] as CustomObject;
e.Description = (obj != null) ? obj.ToString() : "(no custom info)";

how-to-extend-text-properties-of-appointments-exported-to-icalendar-format-e2437/CS/Form1.cs#L50

    string attendees = "\r\nRequired Attendees: " + Convert.ToString(e.Appointment.CustomFields[RecipientsDataColumn]);
    e.Description = e.Description + attendees;
}

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/LabelsAndStatuses.vb#L23

    Dim label As IAppointmentLabel = scheduler.DataStorage.Appointments.Labels.GetById(e.Appointment.LabelKey)
    e.Description = String.Format("Label Info:" & ControlChars.Lf & "DisplayName = '{0}'" & ControlChars.Lf & "ID = '{1}'", label.DisplayName, label.Id.ToString())
End Sub

how-to-resize-an-appointment-without-snapping-it-to-time-cells-e2341/VB/WindowsApplication1/Form1.vb#L126

Private Sub schedulerControl1_InitAppointmentDisplayText(ByVal sender As Object, ByVal e As AppointmentDisplayTextEventArgs) Handles schedulerControl1.InitAppointmentDisplayText
    e.Text = e.Description
    e.Description = ""

how-to-export-appointments-with-custom-fields-to-vcalendar-format-e638/VB/VCalendarCustomFields/Form1.vb#L75

    Dim obj As CustomObject = TryCast(e.Appointment.CustomFields(CustomFieldName), CustomObject)
    e.Description = If(obj IsNot Nothing, obj.ToString(), "(no custom info)")
End Sub

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/VB/iCalendarExportImport/Form1.vb#L159

Dim obj As CustomObject = TryCast(e.Appointment.CustomFields(CustomFieldName), CustomObject)
e.Description = If(obj IsNot Nothing, obj.ToString(), "(no custom info)")

how-to-extend-text-properties-of-appointments-exported-to-icalendar-format-e2437/VB/Form1.vb#L52

    Dim attendees As String = ControlChars.CrLf & "Required Attendees: " & Convert.ToString(e.Appointment.CustomFields(RecipientsDataColumn))
    e.Description = e.Description & attendees
End Sub