Loading...

Class SchedulerElementProvider

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.

Inheritance
System.Object
SchedulerElementProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

public class SchedulerElementProvider

Constructors

SchedulerElementProvider(RadScheduler)

Declaration
public SchedulerElementProvider(RadScheduler scheduler)
Parameters
RadScheduler scheduler

Properties

AllowCache

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

Declaration
public bool AllowCache { get; set; }
Property Value
System.Boolean

Scheduler

The scheduler that owns this provider.

Declaration
public RadScheduler Scheduler { get; }
Property Value
RadScheduler

Methods

CacheElement(ISchedulerRecyclableElement)

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

Declaration
public virtual bool CacheElement(ISchedulerRecyclableElement element)
Parameters
ISchedulerRecyclableElement element

Returns
System.Boolean

CanCache(ISchedulerRecyclableElement)

Indicates whether an element can be added to the cache.

Declaration
protected virtual bool CanCache(ISchedulerRecyclableElement element)
Parameters
ISchedulerRecyclableElement element

The element that is trying to get cached.
Returns
System.Boolean

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

ClearCache()

Removes all cached elements from the cache.

Declaration
public virtual void ClearCache()

CreateElement<T>(SchedulerView, Object)

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

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

The view that should be associated with the element.
System.Object context

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

The newly created element.
Type Parameters
T

The type of the element to be created.

CreateResourceSeparatorElement(SchedulerView)

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

Declaration
public virtual SchedulerVisualElement CreateResourceSeparatorElement(SchedulerView view)
Parameters
SchedulerView view

The view to create the element with.
Returns
SchedulerVisualElement

The newly created element.

CreateRulerPrimitive(DayViewAppointmentsArea, SchedulerTimeZone)

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

Declaration
public virtual RulerPrimitive CreateRulerPrimitive(DayViewAppointmentsArea area, SchedulerTimeZone timeZone)
Parameters
DayViewAppointmentsArea area

The owner DayViewAppointmentsArea

SchedulerTimeZone timeZone

The timezone for this ruler.

Returns
RulerPrimitive

The newly created ruler primitive.

GetElement<T>(SchedulerView, Object)

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

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

The SchedulerView which will be associated with the retrieved element.
System.Object context

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

An element of the requested type
Type Parameters
T

The type of the requested element.

GetElement<T>(SchedulerView, String, Object)

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.

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

The SchedulerView which will be associated with the retrieved element.
System.String elementClass

The Class of the requested element.
System.Object context

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

An element of the requested type
Type Parameters
T

The type of the requested element.

TryGetCachedElement<T>(out T, String, SchedulerView, Object)

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

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

The result of the lookup.
System.String elementClass

The Class of the requested element.
SchedulerView view

The SchedulerView which will be associated with the retrieved element.
System.Object context

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

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

The type of the requested element.

Extension Methods