New to Telerik UI for WinForms? Start a free 30-day trial

Exposes appointment data as bindable values for the Scheduler navigator's search-results grid.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

C#
public class AppointmentWrapper : INotifyPropertyChanged

Inheritance: objectAppointmentWrapper

Derived Classes: AgendaAppointmentWrapper

Implements: INotifyPropertyChanged

Constructors

Creates a binding wrapper for an appointment and subscribes to its property-change notifications.

C#
public AppointmentWrapper(Appointment appointment, RadScheduler schedulerData)
Parameters:appointmentAppointment

The appointment whose values will be exposed.

schedulerDataRadScheduler

The Scheduler that provides resource and background data.

Fields

The appointment whose values are exposed by this wrapper.

C#
protected Appointment appointment

The Scheduler used to resolve the appointment's resource and background information.

C#
protected RadScheduler schedulerData

Properties

Gets a representative color for the appointment background. Gradient backgrounds use the midpoint of their two colors; missing or unassigned backgrounds produce Transparent.

C#
public Color Background { get; }

Gets or sets the appointment description displayed in the search results.

C#
public string Description { get; set; }

Gets the appointment end time for display in the search results.

C#
public virtual DateTime End { get; }

Gets the appointment location displayed in the search results.

C#
public string Location { get; }

Gets the localized recurrence frequency label for the appointment, using its master event's rule when needed. Minutely and hourly rules both use the hourly label; an absent or unsupported rule uses the BackgroundNone label.

C#
public string Recurrence { get; }

Gets the localized text for the appointment's reminder interval.

C#
public string Reminder { get; }

Gets the name of the appointment's assigned resource, or an empty string when it has no resource.

C#
public string Resource { get; }

Gets the appointment start time for display in the search results.

C#
public virtual DateTime Start { get; }

Gets or sets the appointment subject displayed in the search results.

C#
public string Summary { get; set; }

Methods

Gets the representative color used for the appointment's background in the search results. Solid backgrounds use their first color; supported gradients use the RGB midpoint of their two colors. Returns Transparent when the Scheduler, appointment, or assigned background is unavailable.

C#
public Color GetColor()
Returns:

Color

Gets the display name of the appointment's assigned background, or an empty string when none is assigned.

C#
public string GetDisplayName()
Returns:

string

Formats a reminder interval using the Scheduler's localized unit strings. Exact one-week intervals use the one-week label; longer exact week multiples use the day suffix with the week count. Null, zero, and intervals not matched by a supported unit branch use the no-reminder label.

C#
protected virtual string ParseTimeSpan(TimeSpan? time)
Parameters:timeTimeSpan?

The reminder interval to format, or null when no interval is set.

Returns:

string

The localized reminder text.

Events

Occurs when a property of the wrapped appointment changes. The event arguments contain the property name reported by the appointment.

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged