New to Telerik UI for WinFormsStart a free 30-day trial

A provider that is used to creating most of the visual elements of RadScheduler. Extend this class and replace the instance in ElementProvider to replace any of the visual elements with custom implementations.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

C#
public class SchedulerElementProvider

Inheritance: objectSchedulerElementProvider

Constructors

C#
public SchedulerElementProvider(RadScheduler scheduler)
Parameters:schedulerRadScheduler

Properties

Gets or sets a value indicating whether caching and recycling of elements is allowed.

C#
public bool AllowCache { get; set; }

The scheduler that owns this provider.

C#
public RadScheduler Scheduler { get; }

Methods

Adds an element to the cache if this is CanCache(ISchedulerRecyclableElement) allows this.

C#
public virtual bool CacheElement(ISchedulerRecyclableElement element)
Parameters:elementISchedulerRecyclableElementReturns:

bool

Indicates whether an element can be added to the cache.

C#
protected virtual bool CanCache(ISchedulerRecyclableElement element)
Parameters:elementISchedulerRecyclableElement

The element that is trying to get cached.

Returns:

bool

[true] if the element can be added to the cache and reused later, [false] otherwise.

Removes all cached elements from the cache.

C#
public virtual void ClearCache()

Creates a new instance of type T with the specified view for the specified context. Override to provide custom elements.

C#
protected virtual T CreateElement<T>(SchedulerView view, object context) where T : SchedulerVisualElement
Parameters:viewSchedulerView

The view that should be associated with the element.

contextobject

The context that requests the element (usually the future parent of the element).

Returns:

T

The newly created element.

Creates a SchedulerVisualElement which represents will be place inbetween the view elements when grouping by resource.

C#
public virtual SchedulerVisualElement CreateResourceSeparatorElement(SchedulerView view)
Parameters:viewSchedulerView

The view to create the element with.

Returns:

SchedulerVisualElement

The newly created element.

Creates a RulerPrimitive instance which will be used in the DayViewAppointmentsArea of DayView and WeekView.

C#
public virtual RulerPrimitive CreateRulerPrimitive(DayViewAppointmentsArea area, SchedulerTimeZone timeZone)
Parameters:areaDayViewAppointmentsArea

The owner DayViewAppointmentsArea

timeZoneSchedulerTimeZone

The timezone for this ruler.

Returns:

RulerPrimitive

The newly created ruler primitive.

Gets an element of type T from the cache or creates a new one if such is not found.

C#
public T GetElement<T>(SchedulerView view, object context) where T : SchedulerVisualElement
Parameters:viewSchedulerView

The SchedulerView which will be associated with the retrieved element.

contextobject

The context that requests the element (usually the future parent of the element).

Returns:

T

An element of the requested type

Gets an element of type T and a specified Class from the cache or creates a new one if such is not found. The method finds all cached elements of type T and tries to find one that matches the specified Class. If a match is not found, returns any of the found elements of type T. If there are no cached elements of type T, creates a new element.

C#
public T GetElement<T>(SchedulerView view, string elementClass, object context) where T : SchedulerVisualElement
Parameters:viewSchedulerView

The SchedulerView which will be associated with the retrieved element.

elementClassstring

The Class of the requested element.

contextobject

The context that requests the element (usually the future parent of the element).

Returns:

T

An element of the requested type

Tries to get an element with type T and a specified Class from the cache.

C#
protected virtual bool TryGetCachedElement<T>(out T element, string elementClass, SchedulerView view, object context) where T : SchedulerVisualElement
Parameters:elementT

The result of the lookup.

elementClassstring

The Class of the requested element.

viewSchedulerView

The SchedulerView which will be associated with the retrieved element.

contextobject

The context that requests the element (usually the future parent of the element).

Returns:

bool

[true] if a cached element was found, [false] otherwise.