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

Selects and translates the title templates used to render appointment information in Scheduler views.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

C#
public class AppointmentTitleFormatter

Inheritance: objectAppointmentTitleFormatter

Derived Classes: DayViewAppointmentTitleFormatterMonthViewAppointmentTitleFormatterTimelineViewAppointmentTitleFormatter

Constructors

C#
public AppointmentTitleFormatter()

Methods

Gets the default title template, using the Scheduler culture's short time pattern for appointment times. If scheduler is null, returns the most recently generated template, or an empty string if none has been generated.

C#
public string GetDefaultTitleFormat(RadScheduler scheduler)
Parameters:schedulerRadScheduler

The Scheduler whose culture supplies the time pattern.

Returns:

string

A template containing the default summary, location, and time placeholders.

Gets the title template for an appointment element, using its override before the view and Scheduler templates. Derived formatters can adjust the selected template for a specific view layout.

C#
public virtual string GetTitleFormat(AppointmentElement appointmentElement, SchedulerView schedulerView, RadScheduler scheduler)
Parameters:appointmentElementAppointmentElement

The element whose title override and appointment data are used.

schedulerViewSchedulerView

The view whose title template is used when the element has no override.

schedulerRadScheduler

The Scheduler whose title template or culture-based default is used as a fallback.

Returns:

string

The selected and translated title template.

Selects a title template and translates its named placeholders into the indexed items used when an appointment title is formatted. Tokens such as {{start:format}}, {{end:format}}, {{summary}}, and {{location}} map to appointment values.

C#
public string GetTitleFormat(string elementTitleFormat, SchedulerView schedulerView, RadScheduler scheduler)
Parameters:elementTitleFormatstring

The appointment element's override, if present.

schedulerViewSchedulerView

The view whose template is considered after the element's override.

schedulerRadScheduler

The Scheduler whose template and culture provide the final configured and default choices.

Returns:

string

The selected template with recognized named placeholders translated to indexed format items.

Selects the first non-empty template in appointment, view, and Scheduler precedence order, then falls back to the default template.

C#
public string SelectTitleFormat(string elementTitleFormat, SchedulerView schedulerView, RadScheduler scheduler)
Parameters:elementTitleFormatstring

The appointment element's override, if present.

schedulerViewSchedulerView

The view whose template is considered after the element's override.

schedulerRadScheduler

The Scheduler whose template and culture provide the final configured and default choices.

Returns:

string

The selected template before named placeholders are translated.