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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

C#
public abstract class SchedulerView : INotifyPropertyChanged

Inheritance: objectSchedulerView

Derived Classes: SchedulerAgendaViewSchedulerDayViewBaseSchedulerMonthViewSchedulerTimelineView

Implements: INotifyPropertyChanged

Constructors

C#
public SchedulerView()

Fields

C#
protected DateTime? nullableStartDate

Properties

Enables or disables appointment moving

C#
public virtual bool AllowAppointmentMove { get; set; }

Enables or disables appointment resizing

C#
public virtual bool AllowAppointmentResize { get; set; }

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

C#
public bool AllowResourcesScrolling { get; set; }

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

C#
public virtual bool AllowToolTips { get; set; }

Gets the appointments for that view.

C#
public SchedulerObservableCollection Appointments { get; }
Property Value:

The appointments for that view.

Gets or sets the appointment title format.

C#
public string AppointmentTitleFormat { get; set; }
Property Value:

The appointment title format.

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

C#
public string CellToolTipFormat { get; set; }
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.

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

C#
protected virtual DateTime? CurrentDate { get; set; }

Gets or sets the offset time span.

C#
[Browsable(false)]
public virtual SchedulerTimeZone DefaultTimeZone { get; set; }
Property Value:

The offset time span.

C#
public virtual DateTime EndDate { get; }

Gets or sets the separator width between different groups

C#
public int GroupSeparatorWidth { get; set; }

Gets or sets the name of the view.

C#
public virtual string Name { get; set; }

Gets or sets the offset time span.

C#
[Browsable(false)]
public virtual TimeSpan OffsetTimeSpan { get; set; }
Property Value:

The offset time span.

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

C#
public virtual bool ReadOnly { get; set; }

Gets or sets the resources shown in the current view.

C#
public int ResourcesPerView { get; set; }

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

C#
[Browsable(false)]
public RadScheduler Scheduler { get; }

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

C#
public virtual bool ShowHeader { get; set; }

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

C#
public virtual DateTime StartDate { get; set; }
C#
public abstract SchedulerViewType ViewType { get; }

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

C#
[Browsable(false)]
public bool Visible { get; set; }

Methods

Adds the appointment.

C#
protected virtual void AddAppointment(IEvent appointment)
Parameters:appointmentIEvent

The appointment.

C#
protected virtual void AddResources(SchedulerResourceCollection resources)
Parameters:resourcesSchedulerResourceCollection
C#
protected virtual void AppointmentChanged(IEvent appointment, string propertyName)
Parameters:appointmentIEventpropertyNamestring
C#
protected DateTime CalculateNextDate(IEnumerable<IEvent> appointments, ref DateTime endDate)
Parameters:appointmentsIEnumerable<IEvent>endDateDateTimeReturns:

DateTime

C#
protected virtual SchedulerView CalculatePreviousView(IEnumerable<IEvent> appointments, DateTime startDate)
Parameters:appointmentsIEnumerable<IEvent>startDateDateTimeReturns:

SchedulerView

C#
protected virtual void CopyPropertiesToView(SchedulerView other)
Parameters:otherSchedulerView

Creates a SchedulerView given the desired type.

C#
public static SchedulerView CreateView(SchedulerViewType value)
Parameters:valueSchedulerViewType

The view type.

Returns:

SchedulerView

C#
protected abstract SchedulerView CreateViewWithStartDate(DateTime startDate)
Parameters:startDateDateTimeReturns:

SchedulerView

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

C#
protected abstract DateTime GetEndDate(DateTime startDate)
Parameters:startDateDateTime

The start date.

Returns:

DateTime

Gets the first appointment in this view, if any.

C#
public IEvent GetFirstAppointment()
Returns:

IEvent

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

Gets the last appointment in this view, if any.

C#
public IEvent GetLastAppointment()
Returns:

IEvent

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

Gets the next view.

C#
public SchedulerView GetNextView()
Returns:

SchedulerView

Gets the next view.

C#
public abstract SchedulerView GetNextView(int offset)
Parameters:offsetint

The offset.

Returns:

SchedulerView

Gets the next view.

C#
public abstract SchedulerView GetNextView(NavigationStepTypes navigationStepType, int navigationStep)
Parameters:navigationStepTypeNavigationStepTypes

The navigation step type.

navigationStepint

The navigation step.

Returns:

SchedulerView

Gets the next view containing any of the given appointments.

C#
public virtual SchedulerView GetNextViewWithAppointments(IEnumerable<IEvent> appointments)
Parameters:appointmentsIEnumerable<IEvent>Returns:

SchedulerView

Gets the previous view.

C#
public SchedulerView GetPreviousView()
Returns:

SchedulerView

Gets the previous view.

C#
public abstract SchedulerView GetPreviousView(int offset)
Parameters:offsetint

The offset.

Returns:

SchedulerView

Gets the previous view.

C#
public abstract SchedulerView GetPreviousView(NavigationStepTypes navigationStepType, int navigationStep)
Parameters:navigationStepTypeNavigationStepTypes

The navigation step type.

navigationStepint

The navigation step.

Returns:

SchedulerView

Gets the previous view containing any of the given appointments.

C#
public virtual SchedulerView GetPreviousViewWithAppointments(IEnumerable<IEvent> appointments)
Parameters:appointmentsIEnumerable<IEvent>Returns:

SchedulerView

C#
public virtual IResource GetResource()
Returns:

IResource

C#
public virtual EventId GetResourceId()
Returns:

EventId

C#
public virtual SchedulerResourceCollection GetResources()
Returns:

SchedulerResourceCollection

C#
protected virtual SchedulerView GetViewContainingDate(DateTime date, int viewDayCount)
Parameters:dateDateTimeviewDayCountintReturns:

SchedulerView

Gets the view containing date.

C#
public abstract SchedulerView GetViewContainingDate(DateTime date)
Parameters:dateDateTime

The date.

Returns:

SchedulerView

Determines whether the specified event is all day

C#
public virtual bool IsAllDayEvent(IEvent appointment)
Parameters:appointmentIEvent

The event

Returns:

bool

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

Determines whether a given appointment intersects with this view..

C#
public virtual bool IsAppointmentInView(IEvent appointment)
Parameters:appointmentIEvent

The appointment.

Returns:

bool

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

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

C#
public virtual bool IsDateInView(DateTime date)
Parameters:dateDateTime

The DateTime object to be tested.

Returns:

bool

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

C#
protected virtual bool IsResourceIntersectsWithViewResources(IEvent appointment)
Parameters:appointmentIEventReturns:

bool

C#
protected virtual bool IsViewInAccessibleInterval(DateTime startDate)
Parameters:startDateDateTimeReturns:

bool

Offsets the view.

C#
public virtual SchedulerView OffsetView(int offset)
Parameters:offsetint

The offset.

Returns:

SchedulerView

C#
protected virtual void OnPropertyChanged(params string[] propertyNames)
Parameters:propertyNamesstring[]
C#
protected virtual void RemoveAppointment(IEvent appointment)
Parameters:appointmentIEvent
C#
protected virtual void SetDefaultTimeZone(SchedulerTimeZone defaultTimeZone)
Parameters:defaultTimeZoneSchedulerTimeZone
C#
protected virtual bool SetStartDate(DateTime value)
Parameters:valueDateTimeReturns:

bool

Updates the appointments for that view.

C#
public virtual void UpdateAppointments(ObservableCollection<IEvent> appointments)
Parameters:appointmentsObservableCollection<IEvent>

The appointments for that view.

C#
protected virtual void UpdateOnPropertyChange(string propertyName)
Parameters:propertyNamestring

Events

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged