IAppointmentViewInfo Interface

Defines options and characteristics used to display an appointment in a view.

Namespace: DevExpress.XtraScheduler.Drawing

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

Declaration

C#

public interface IAppointmentViewInfo :
    IAppointmentView

VB.NET

Public Interface IAppointmentViewInfo
    Inherits IAppointmentView

Related API Members

The following members accept/return IAppointmentViewInfo objects:

Library	Related API Members
Cross-Platform Class Library	AppointmentDisplayTextEventArgs.ViewInfo
WinForms Controls	AppointmentImagesEventArgs.ViewInfo
ASP.NET Core Bootstrap Controls	IBootstrapSchedulerAppointmentDisplayTextEventArgs.ViewInfo
ASP.NET Web Forms Controls	AppointmentImagesEventArgs.ViewInfo

Remarks

This interface can be used to determine the resource of the displayed appointment, and to provide access to the AppointmentViewInfoOptions object that allows specifying whether start or end times are displayed, the recurrence symbol is shown etc.

Handle the SchedulerControl.InitAppointmentDisplayText and SchedulerControl.InitAppointmentImages events to get access to the IAppointmentViewInfo interface for the appointment being displayed. Use the ViewInfo properties of the event arguments for this purpose.

In Scheduler Reporting, the TimeCellsControlBase.InitAppointmentDisplayText and the TimeCellsControlBase.InitAppointmentImages provide access to the IAppointmentViewInfo interface via event arguments.

Related GitHub Examples

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

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-customize-visual-elements-using-scheduler-services-e1006/CS/CustomFormats/Code/Services.cs#L41

}
public override string GetVerticalAppointmentStartFormat(IAppointmentViewInfo aptViewInfo) {
    return "{0: HHmm:ss}";

formatting-services-an-example-of-use-e507/CS/FormattingServicesExample/Form1.cs#L116

#region IAppointmentFormatStringService Members
public override string GetVerticalAppointmentStartFormat(IAppointmentViewInfo aptViewInfo) {
    return "{0: HHmm:ss}";

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/Services.cs#L28

public override string GetVerticalAppointmentStartFormat(
    IAppointmentViewInfo aptViewInfo)
{

VB.NET

how-to-customize-visual-elements-using-scheduler-services-e1006/VB/CustomFormats/Code/Services.vb#L45

End Sub
Public Overrides Function GetVerticalAppointmentStartFormat(ByVal aptViewInfo As IAppointmentViewInfo) As String
    Return "{0: HHmm:ss}"

formatting-services-an-example-of-use-e507/VB/FormattingServicesExample/Form1.vb#L120

#Region "IAppointmentFormatStringService Members"
Public Overrides Function GetVerticalAppointmentStartFormat(ByVal aptViewInfo As IAppointmentViewInfo) As String
    Return "{0: HHmm:ss}"

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/Services.vb#L26

End Sub
Public Overrides Function GetVerticalAppointmentStartFormat(ByVal aptViewInfo As IAppointmentViewInfo) As String
    Return "{0: HHmm:ss - 'VerticalAppointmentStart'}"