AppointmentViewInfo Class

Provides information on the visual representation of the appointment.

Namespace: DevExpress.XtraScheduler.Drawing

Assembly: DevExpress.XtraScheduler.v18.1.dll

Declaration

C#

public abstract class AppointmentViewInfo :
    ViewInfoItemContainer,
    IAppointmentViewInfo,
    IAppointmentView,
    IGanttAppointmentViewInfo,
    ISchedulerSupportContextItems

VB.NET

Public MustInherit Class AppointmentViewInfo
    Inherits ViewInfoItemContainer
    Implements IAppointmentViewInfo,
               IAppointmentView,
               IGanttAppointmentViewInfo,
               ISchedulerSupportContextItems

Related API Members

The following members accept/return AppointmentViewInfo objects:

• AppointmentViewInfoCustomizingEventArgs.ViewInfo
• DependencyViewInfo.EndAppointmentViewInfo
• DependencyViewInfo.StartAppointmentViewInfo
• SchedulerInplaceEditorEventArgs.ViewInfo

Remarks

The AppointmentViewInfo object contains information used to render an appointment or appointment part, and provides properties that can be used to customize the appointment appearance. You can access the AppointmentViewInfo instance within the following event handlers.

Event	Notation
SchedulerControl.AppointmentViewInfoCustomizing	e.ViewInfo
SchedulerControl.CustomDrawAppointment, SchedulerControl.CustomDrawAppointmentBackground	Cast explicitly e.ObjectInfo to the AppointmentViewInfo type
SchedulerControl.InplaceEditorShowing	e.SchedulerInplaceEditorEventArgs.ViewInfo

The AppointmentViewInfo is also obtained during hit testing using the SchedulerHitInfo.ViewInfo property when appointment’s visual objects are being clicked.

Use the AppointmentViewInfo object to get the required information when changing appointment appearance or redrawing the appointment manually.

Related GitHub Examples

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

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#L22

if(((SchedulerControl)sender).ActiveView is DayView) {
    AppointmentViewInfo viewInfo = e.ObjectInfo as AppointmentViewInfo;
    // Get DevExpress images.

how-to-implement-precise-drag-and-drop-and-resizing-of-appointments-in-day-work-week-view-e4497/CS/OneMinuteDragDrop/Handlers/SchedulerMoveEventHandler.cs#L20

}
protected internal AppointmentViewInfo AppointmentViewInfo {
    get { return GetAppointmentViewInfo(); }

how-to-display-custom-tooltips-for-appointments-resource-headers-and-day-headers-e4137/CS/Form1.cs#L21

private void toolTipController1_BeforeShow(object sender, DevExpress.Utils.ToolTipControllerShowEventArgs e) {
    if (toolTipController1.ActiveObject is AppointmentViewInfo) {
        Appointment apt = ((AppointmentViewInfo)toolTipController1.ActiveObject).Appointment;

scheduler-reporting-custom-painting-using-customdraw-events-e2758/CS/SchedulerReportCustomDraw/XtraSchedulerReport1.cs#L125

e.DrawDefault();
AppointmentViewInfo vi = (AppointmentViewInfo)e.ObjectInfo;
Rectangle rect = vi.Bounds;

how-to-paint-a-special-time-area-for-an-appointment-and-interact-with-it-t246714/CS/T246714/Form1.cs#L81

if(scheduler.ActiveViewType == SchedulerViewType.Day) {
    AppointmentViewInfo aptViewInfo = (AppointmentViewInfo)e.ObjectInfo;
    if(aptViewInfo.Selected) {

VB.NET

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

If TypeOf CType(sender, SchedulerControl).ActiveView Is DayView Then
    Dim viewInfo As AppointmentViewInfo = TryCast(e.ObjectInfo, AppointmentViewInfo)

how-to-implement-precise-drag-and-drop-and-resizing-of-appointments-in-day-work-week-view-e4497/VB/OneMinuteDragDrop/Handlers/SchedulerMoveEventHandler.vb#L24

End Property
Protected Friend ReadOnly Property AppointmentViewInfo() As AppointmentViewInfo
    Get

how-to-display-custom-tooltips-for-appointments-resource-headers-and-day-headers-e4137/VB/Form1.vb#L23

Private Sub toolTipController1_BeforeShow(ByVal sender As Object, ByVal e As DevExpress.Utils.ToolTipControllerShowEventArgs) Handles toolTipController1.BeforeShow
    If TypeOf toolTipController1.ActiveObject Is AppointmentViewInfo Then
        Dim apt As Appointment = (CType(toolTipController1.ActiveObject, AppointmentViewInfo)).Appointment

scheduler-reporting-custom-painting-using-customdraw-events-e2758/VB/SchedulerReportCustomDraw/XtraSchedulerReport1.vb#L106

e.DrawDefault()
Dim vi As AppointmentViewInfo = CType(e.ObjectInfo, AppointmentViewInfo)
Dim rect As Rectangle = vi.Bounds

how-to-paint-a-special-time-area-for-an-appointment-and-interact-with-it-t246714/VB/T246714/Form1.vb#L83

If scheduler.ActiveViewType = SchedulerViewType.Day Then
    Dim aptViewInfo As AppointmentViewInfo = CType(e.ObjectInfo, AppointmentViewInfo)
    If aptViewInfo.Selected Then

Inheritance

Object

DevExpress.Utils.Drawing.GraphicsInfoArgs

DevExpress.Utils.Drawing.ObjectInfoArgs

DevExpress.XtraScheduler.Drawing.SelectableIntervalViewInfo

DevExpress.XtraScheduler.Drawing.BorderObjectViewInfo

DevExpress.XtraScheduler.Drawing.ViewInfoItemContainer

AppointmentViewInfo