RecurrenceInfo.GetDescription(Appointment, DayOfWeek) Method

Returns a human readable description of the recurrence pattern for the specified appointment.

Namespace: DevExpress.XtraScheduler

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

Declaration

public static string GetDescription(
    Appointment apt,
    DayOfWeek firstDayOfWeek
)
Public Shared Function GetDescription(
    apt As Appointment,
    firstDayOfWeek As DayOfWeek
) As String

Parameters

Name Type Description
apt Appointment

An Appointment object that specifies the appointment whose recurrence pattern is to be converted into a human readable description.

firstDayOfWeek DayOfWeek

A DayOfWeek enumeration value which specifies the day of the week that is considered to be the first when calculating the recurrence pattern for the appointment. The current setting for the first day of the week can be obtained via the SchedulerControl.FirstDayOfWeek property.

Returns

Type Description
String

A String, which is a human readable description of the appointment's recurrence pattern. Localizable.

Remarks

The GetDescription method uses SchedulerStringId values for abbreviations and format strings. Use the SchedulerLocalizer class to localize the string returned by the GetDescription method.

See Also