ClassSchedulerView
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
public abstract class SchedulerView : INotifyPropertyChangedInheritance: objectSchedulerView
Derived Classes:
Implements:
Constructors
SchedulerView()
Declaration
public SchedulerView()Fields
Properties
AllowAppointmentMove
Enables or disables appointment moving
Declaration
public virtual bool AllowAppointmentMove { get; set; }Property Value
AllowAppointmentResize
Enables or disables appointment resizing
Declaration
public virtual bool AllowAppointmentResize { get; set; }Property Value
AllowResourcesScrolling
Gets or sets whether the horizontal scrollbar when the scheduler is grouped by resources is shown.
AllowToolTips
Gets or sets whether tool tips are displayed for this speciffic control.
AppointmentTitleFormat
Gets or sets the appointment title format.
Declaration
public string AppointmentTitleFormat { get; set; }Property Value
The appointment title format.
Appointments
Gets the appointments for that view.
Declaration
public SchedulerObservableCollection Appointments { get; }Property Value
The appointments for that view.
CellToolTipFormat
Gets or sets the format string that is applied to the days cells tooltip.
Declaration
public string CellToolTipFormat { get; set; }Property Value
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.
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
DefaultTimeZone
Gets or sets the offset time span.
Declaration
[Browsable(false)]
public virtual SchedulerTimeZone DefaultTimeZone { get; set; }Property Value
The offset time span.
GroupSeparatorWidth
Gets or sets the separator width between different groups
Name
Gets or sets the name of the view.
OffsetTimeSpan
Gets or sets the offset time span.
Declaration
[Browsable(false)]
public virtual TimeSpan OffsetTimeSpan { get; set; }Property Value
The offset time span.
ReadOnly
Gets or sets a value indicating whether the view is in read-only mode.
ResourcesPerView
Gets or sets the resources shown in the current view.
Scheduler
Gets the parent RadScheduler that the current view is assigned to.
Declaration
[Browsable(false)]
public RadScheduler Scheduler { get; }Property Value
ShowHeader
Gets or sets whether a single SchedulerView object will display a header row.
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
ViewType
Declaration
public abstract SchedulerViewType ViewType { get; }Property Value
Methods
AddAppointment(IEvent)
Adds the appointment.
Declaration
protected virtual void AddAppointment(IEvent appointment)Parameters
appointment
The appointment.
AddResources(SchedulerResourceCollection)
Declaration
protected virtual void AddResources(SchedulerResourceCollection resources)Parameters
resources
CalculatePreviousView(IEnumerable<IEvent>, DateTime)
Declaration
protected virtual SchedulerView CalculatePreviousView(IEnumerable<IEvent> appointments, DateTime startDate)Parameters
appointments
IEnumerable<IEvent>
startDate
Returns
CopyPropertiesToView(SchedulerView)
Declaration
protected virtual void CopyPropertiesToView(SchedulerView other)Parameters
other
CreateView(SchedulerViewType)
Creates a SchedulerView given the desired type.
Declaration
public static SchedulerView CreateView(SchedulerViewType value)Parameters
value
The view type.
Returns
CreateViewWithStartDate(DateTime)
Declaration
protected abstract SchedulerView CreateViewWithStartDate(DateTime startDate)Parameters
startDate
Returns
GetEndDate(DateTime)
Gets the end date for that SchedulerView given a start date.
GetFirstAppointment()
Gets the first appointment in this view, if any.
Declaration
public IEvent GetFirstAppointment()Returns
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
The last appointment in this view, or null of there are no appointments.
GetNextView()
Gets the next view.
GetNextView(NavigationStepTypes, int)
Gets the next view.
Declaration
public abstract SchedulerView GetNextView(NavigationStepTypes navigationStepType, int navigationStep)Parameters
navigationStepType
The navigation step type.
navigationStep
The navigation step.
Returns
GetNextView(int)
Gets the next view.
Declaration
public abstract SchedulerView GetNextView(int offset)Parameters
offset
The offset.
Returns
GetNextViewWithAppointments(IEnumerable<IEvent>)
Gets the next view containing any of the given appointments.
Declaration
public virtual SchedulerView GetNextViewWithAppointments(IEnumerable<IEvent> appointments)Parameters
appointments
IEnumerable<IEvent>
Returns
GetPreviousView()
Gets the previous view.
GetPreviousView(NavigationStepTypes, int)
Gets the previous view.
Declaration
public abstract SchedulerView GetPreviousView(NavigationStepTypes navigationStepType, int navigationStep)Parameters
navigationStepType
The navigation step type.
navigationStep
The navigation step.
Returns
GetPreviousView(int)
Gets the previous view.
Declaration
public abstract SchedulerView GetPreviousView(int offset)Parameters
offset
The offset.
Returns
GetPreviousViewWithAppointments(IEnumerable<IEvent>)
Gets the previous view containing any of the given appointments.
Declaration
public virtual SchedulerView GetPreviousViewWithAppointments(IEnumerable<IEvent> appointments)Parameters
appointments
IEnumerable<IEvent>
Returns
GetResources()
Declaration
public virtual SchedulerResourceCollection GetResources()Returns
GetViewContainingDate(DateTime)
Gets the view containing date.
Declaration
public abstract SchedulerView GetViewContainingDate(DateTime date)Parameters
date
The date.
Returns
GetViewContainingDate(DateTime, int)
Declaration
protected virtual SchedulerView GetViewContainingDate(DateTime date, int viewDayCount)Parameters
date
viewDayCount
Returns
IsAllDayEvent(IEvent)
Determines whether the specified event is all day
IsAppointmentInView(IEvent)
Determines whether a given appointment intersects with this view..
IsDateInView(DateTime)
Determines if a DateTime object belongs to the dates range managed by a particular SchedulerView.
OffsetView(int)
Offsets the view.
Declaration
public virtual SchedulerView OffsetView(int offset)Parameters
offset
The offset.
Returns
OnPropertyChanged(params string[])
Declaration
protected virtual void OnPropertyChanged(params string[] propertyNames)Parameters
propertyNames
string[]
RemoveAppointment(IEvent)
Declaration
protected virtual void RemoveAppointment(IEvent appointment)Parameters
appointment
SetDefaultTimeZone(SchedulerTimeZone)
Declaration
protected virtual void SetDefaultTimeZone(SchedulerTimeZone defaultTimeZone)Parameters
defaultTimeZone
UpdateAppointments(ObservableCollection<IEvent>)
Updates the appointments for that view.
Declaration
public virtual void UpdateAppointments(ObservableCollection<IEvent> appointments)Parameters
appointments
The appointments for that view.
UpdateOnPropertyChange(string)
Declaration
protected virtual void UpdateOnPropertyChange(string propertyName)Parameters
propertyName
Events
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChangedEvent Value
Implements