Class SchedulerView

Inheritance
System.Object
SchedulerView
SchedulerAgendaView
SchedulerDayViewBase
SchedulerMonthView
SchedulerTimelineView
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 abstract class SchedulerView : INotifyPropertyChanged

Constructors

SchedulerView()

Declaration
public SchedulerView()

Fields

nullableStartDate

Declaration
protected DateTime? nullableStartDate
Field Value
System.Nullable<System.DateTime>

Properties

AllowAppointmentMove

Enables or disables appointment moving

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

AllowAppointmentResize

Enables or disables appointment resizing

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

AllowResourcesScrolling

Gets or sets whether the horizontal scrollbar when the scheduler is grouped by resources is shown.

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

AllowToolTips

Gets or sets whether tool tips are displayed for this speciffic control.

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

Appointments

Gets the appointments for that view.

Declaration
public SchedulerObservableCollection Appointments { get; }
Property Value
SchedulerObservableCollection

The appointments for that view.

AppointmentTitleFormat

Gets or sets the appointment title format.

Declaration
public string AppointmentTitleFormat { get; set; }
Property Value
System.String

The appointment title format.

CellToolTipFormat

Gets or sets the format string that is applied to the days cells tooltip.

Declaration
public string CellToolTipFormat { get; set; }
Property Value
System.String

Remarks

The property should contain either a format specifier character or a custom format pattern. For more information, see the summary page for System.Globalization.DateTimeFormatInfo.

By default this property uses formatting string of 'dddd, MMMM dd, yyyy'. Valid formats are all supported by the .NET Framework.

Example:

  • "d" is the standard short date pattern.
  • "%d" returns the day of the month; "%d" is a custom pattern.
  • "d " returns the day of the month followed by a white-space character; "d " is a custom pattern.

CurrentCulture

Gets or sets the current culture that is used by this SchedulerView.

Declaration
public CultureInfo CurrentCulture { get; set; }
Property Value
System.Globalization.CultureInfo

The current culture.

CurrentDate

Gets or sets a DateTime value specifying the starting date for the period handled by a SchedulerView instance.

Declaration
protected virtual DateTime? CurrentDate { get; set; }
Property Value
System.Nullable<System.DateTime>

DefaultTimeZone

Gets or sets the offset time span.

Declaration
public virtual SchedulerTimeZone DefaultTimeZone { get; set; }
Property Value
SchedulerTimeZone

The offset time span.

EndDate

Declaration
public virtual DateTime EndDate { get; }
Property Value
System.DateTime

GroupSeparatorWidth

Gets or sets the separator width between different groups

Declaration
public int GroupSeparatorWidth { get; set; }
Property Value
System.Int32

Name

Gets or sets the name of the view.

Declaration
public virtual string Name { get; set; }
Property Value
System.String

OffsetTimeSpan

Gets or sets the offset time span.

Declaration
public virtual TimeSpan OffsetTimeSpan { get; set; }
Property Value
System.TimeSpan

The offset time span.

ReadOnly

Gets or sets a value indicating whether the view is in read-only mode.

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

ResourcesPerView

Gets or sets the resources shown in the current view.

Declaration
public int ResourcesPerView { get; set; }
Property Value
System.Int32

Scheduler

Gets the parent RadScheduler that the current view is assigned to.

Declaration
public RadScheduler Scheduler { get; }
Property Value
RadScheduler

ShowHeader

Gets or sets whether a single SchedulerView object will display a header row.

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

StartDate

Gets or sets a DateTime value specifying the starting date for the period handled by a SchedulerView instance.

Declaration
public virtual DateTime StartDate { get; set; }
Property Value
System.DateTime

ViewType

Declaration
public abstract SchedulerViewType ViewType { get; }
Property Value
SchedulerViewType

Visible

Gets or sets a value indicating whether the view is visible or partially visible.

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

Methods

AddAppointment(IEvent)

Adds the appointment.

Declaration
protected virtual void AddAppointment(IEvent appointment)
Parameters
IEvent appointment

The appointment.

AddResources(SchedulerResourceCollection)

Declaration
protected virtual void AddResources(SchedulerResourceCollection resources)
Parameters
SchedulerResourceCollection resources

AppointmentChanged(IEvent, String)

Declaration
protected virtual void AppointmentChanged(IEvent appointment, string propertyName)
Parameters
IEvent appointment

System.String propertyName

CalculateNextDate(IEnumerable<IEvent>, ref DateTime)

Declaration
protected DateTime CalculateNextDate(IEnumerable<IEvent> appointments, ref DateTime endDate)
Parameters
System.Collections.Generic.IEnumerable<IEvent> appointments

System.DateTime endDate

Returns
System.DateTime

CalculatePreviousView(IEnumerable<IEvent>, DateTime)

Declaration
protected virtual SchedulerView CalculatePreviousView(IEnumerable<IEvent> appointments, DateTime startDate)
Parameters
System.Collections.Generic.IEnumerable<IEvent> appointments

System.DateTime startDate

Returns
SchedulerView

CopyPropertiesToView(SchedulerView)

Declaration
protected virtual void CopyPropertiesToView(SchedulerView other)
Parameters
SchedulerView other

CreateView(SchedulerViewType)

Creates a SchedulerView given the desired type.

Declaration
public static SchedulerView CreateView(SchedulerViewType value)
Parameters
SchedulerViewType value

The view type.
Returns
SchedulerView

CreateViewWithStartDate(DateTime)

Declaration
protected abstract SchedulerView CreateViewWithStartDate(DateTime startDate)
Parameters
System.DateTime startDate

Returns
SchedulerView

GetEndDate(DateTime)

Gets the end date for that SchedulerView given a start date.

Declaration
protected abstract DateTime GetEndDate(DateTime startDate)
Parameters
System.DateTime startDate

The start date.
Returns
System.DateTime

GetFirstAppointment()

Gets the first appointment in this view, if any.

Declaration
public IEvent GetFirstAppointment()
Returns
IEvent

The first appointment in this view, or null of there are no appointments.

GetLastAppointment()

Gets the last appointment in this view, if any.

Declaration
public IEvent GetLastAppointment()
Returns
IEvent

The last appointment in this view, or null of there are no appointments.

GetNextView()

Gets the next view.

Declaration
public SchedulerView GetNextView()
Returns
SchedulerView

GetNextView(Int32)

Gets the next view.

Declaration
public abstract SchedulerView GetNextView(int offset)
Parameters
System.Int32 offset

The offset.
Returns
SchedulerView

GetNextView(NavigationStepTypes, Int32)

Gets the next view.

Declaration
public abstract SchedulerView GetNextView(NavigationStepTypes navigationStepType, int navigationStep)
Parameters
NavigationStepTypes navigationStepType

The navigation step type.
System.Int32 navigationStep

The navigation step.
Returns
SchedulerView

GetNextViewWithAppointments(IEnumerable<IEvent>)

Gets the next view containing any of the given appointments.

Declaration
public virtual SchedulerView GetNextViewWithAppointments(IEnumerable<IEvent> appointments)
Parameters
System.Collections.Generic.IEnumerable<IEvent> appointments

Returns
SchedulerView

GetPreviousView()

Gets the previous view.

Declaration
public SchedulerView GetPreviousView()
Returns
SchedulerView

GetPreviousView(Int32)

Gets the previous view.

Declaration
public abstract SchedulerView GetPreviousView(int offset)
Parameters
System.Int32 offset

The offset.
Returns
SchedulerView

GetPreviousView(NavigationStepTypes, Int32)

Gets the previous view.

Declaration
public abstract SchedulerView GetPreviousView(NavigationStepTypes navigationStepType, int navigationStep)
Parameters
NavigationStepTypes navigationStepType

The navigation step type.
System.Int32 navigationStep

The navigation step.
Returns
SchedulerView

GetPreviousViewWithAppointments(IEnumerable<IEvent>)

Gets the previous view containing any of the given appointments.

Declaration
public virtual SchedulerView GetPreviousViewWithAppointments(IEnumerable<IEvent> appointments)
Parameters
System.Collections.Generic.IEnumerable<IEvent> appointments

Returns
SchedulerView

GetResource()

Declaration
public virtual IResource GetResource()
Returns
IResource

GetResourceId()

Declaration
public virtual EventId GetResourceId()
Returns
EventId

GetResources()

Declaration
public virtual SchedulerResourceCollection GetResources()
Returns
SchedulerResourceCollection

GetViewContainingDate(DateTime)

Gets the view containing date.

Declaration
public abstract SchedulerView GetViewContainingDate(DateTime date)
Parameters
System.DateTime date

The date.
Returns
SchedulerView

GetViewContainingDate(DateTime, Int32)

Declaration
protected virtual SchedulerView GetViewContainingDate(DateTime date, int viewDayCount)
Parameters
System.DateTime date

System.Int32 viewDayCount

Returns
SchedulerView

IsAllDayEvent(IEvent)

Determines whether the specified event is all day

Declaration
public virtual bool IsAllDayEvent(IEvent appointment)
Parameters
IEvent appointment

The event
Returns
System.Boolean

true if the specified event is all day; otherwise, false.

IsAppointmentInView(IEvent)

Determines whether a given appointment intersects with this view..

Declaration
public virtual bool IsAppointmentInView(IEvent appointment)
Parameters
IEvent appointment

The appointment.
Returns
System.Boolean

true if a given appointment intersects with this view; otherwise, false.

IsDateInView(DateTime)

Determines if a DateTime object belongs to the dates range managed by a particular SchedulerView.

Declaration
public virtual bool IsDateInView(DateTime date)
Parameters
System.DateTime date

The DateTime object to be tested.
Returns
System.Boolean

True if the DateTime object belongs to the dates range managed by a particular SchedulerView; False otherwise.

IsResourceIntersectsWithViewResources(IEvent)

Declaration
protected virtual bool IsResourceIntersectsWithViewResources(IEvent appointment)
Parameters
IEvent appointment

Returns
System.Boolean

IsViewInAccessibleInterval(DateTime)

Declaration
protected virtual bool IsViewInAccessibleInterval(DateTime startDate)
Parameters
System.DateTime startDate

Returns
System.Boolean

OffsetView(Int32)

Offsets the view.

Declaration
public virtual SchedulerView OffsetView(int offset)
Parameters
System.Int32 offset

The offset.
Returns
SchedulerView

OnPropertyChanged(String[])

Declaration
protected virtual void OnPropertyChanged(params string[] propertyNames)
Parameters
System.String[] propertyNames

RemoveAppointment(IEvent)

Declaration
protected virtual void RemoveAppointment(IEvent appointment)
Parameters
IEvent appointment

SetDefaultTimeZone(SchedulerTimeZone)

Declaration
protected virtual void SetDefaultTimeZone(SchedulerTimeZone defaultTimeZone)
Parameters
SchedulerTimeZone defaultTimeZone

SetStartDate(DateTime)

Declaration
protected virtual bool SetStartDate(DateTime value)
Parameters
System.DateTime value

Returns
System.Boolean

UpdateAppointments(ObservableCollection<IEvent>)

Updates the appointments for that view.

Declaration
public virtual void UpdateAppointments(ObservableCollection<IEvent> appointments)
Parameters
ObservableCollection<IEvent> appointments

The appointments for that view.

UpdateOnPropertyChange(String)

Declaration
protected virtual void UpdateOnPropertyChange(string propertyName)
Parameters
System.String propertyName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Extension Methods