SchedulerControl.GetAppointments(DateTimeRange, Boolean) Method

Returns the collection of appointments for the specified time interval.

Namespace: DevExpress.Xpf.Scheduling

Assembly: DevExpress.Xpf.Scheduling.v20.1.dll

Declaration

public List<AppointmentItem> GetAppointments(
    DateTimeRange interval,
    bool visibleResourcesOnly = true
)
Public Function GetAppointments(
    interval As DateTimeRange,
    visibleResourcesOnly As Boolean = True
) As List(Of AppointmentItem)

Parameters

Name Type Description
interval DateTimeRange

A DevExpress.Mvvm.DateTimeRange value that is the time interval for which to get appointments.

Optional Parameters

Name Type Default Description
visibleResourcesOnly Boolean

True

true, to return appointments available in the current view; otherwise, false.

Returns

Type
List<AppointmentItem>

Remarks

If the visibleResourcesOnly parameter is set to false, the collection returned by the GetAppointments method includes appointments of the AppointmentType.Pattern type that are not shown to the user. The GetPattern method allows you to obtain the Pattern appointment for the specified recurrence.

TIP

The collection returned by the GetAppointments method does not include appointments of the AppointmentType.Occurrence type. Appointments of this type are generated dynamically at runtime.

The DataSource.AppointmentsSource property specifies the data source of appointments.

Appointments are created when the SchedulerControl is visually initialized. If you call the GetAppointments method before the initialization, it returns an empty collection.

See Also