Back to all docs
API Reference / Telerik.WinControls.UI / SchedulerDayViewBase
New to Telerik UI for WinForms? Start a free 30-day trial

SchedulerDayViewBase

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:
C#
public abstract class SchedulerDayViewBase : SchedulerView, INotifyPropertyChanged, IDisposable

Inheritance: objectSchedulerViewSchedulerDayViewBase

Derived Classes: SchedulerDayViewSchedulerMultiDayViewSchedulerWeekView

Implements: IDisposableINotifyPropertyChanged

Inherited Members SchedulerView.nullableStartDateSchedulerView.IsAllDayEvent(IEvent)SchedulerView.CreateView(SchedulerViewType)SchedulerView.UpdateAppointments(ObservableCollection<IEvent>)SchedulerView.AddAppointment(IEvent)SchedulerView.RemoveAppointment(IEvent)SchedulerView.AppointmentChanged(IEvent, string)SchedulerView.IsViewInAccessibleInterval(DateTime)SchedulerView.SetStartDate(DateTime)SchedulerView.IsDateInView(DateTime)SchedulerView.IsAppointmentInView(IEvent)SchedulerView.IsResourceIntersectsWithViewResources(IEvent)SchedulerView.AddResources(SchedulerResourceCollection)SchedulerView.GetResources()SchedulerView.GetResource()SchedulerView.GetResourceId()SchedulerView.OffsetView(int)SchedulerView.GetViewContainingDate(DateTime, int)SchedulerView.GetPreviousView()SchedulerView.GetNextView()SchedulerView.GetPreviousViewWithAppointments(IEnumerable<IEvent>)SchedulerView.CalculatePreviousView(IEnumerable<IEvent>, DateTime)SchedulerView.GetNextViewWithAppointments(IEnumerable<IEvent>)SchedulerView.CalculateNextDate(IEnumerable<IEvent>, ref DateTime)SchedulerView.GetFirstAppointment()SchedulerView.GetLastAppointment()SchedulerView.SetDefaultTimeZone(SchedulerTimeZone)SchedulerView.OnPropertyChanged(params string[])SchedulerView.OffsetTimeSpanSchedulerView.StartDateSchedulerView.CurrentDateSchedulerView.NameSchedulerView.VisibleSchedulerView.ReadOnlySchedulerView.ViewTypeSchedulerView.GroupSeparatorWidthSchedulerView.AllowResourcesScrollingSchedulerView.ResourcesPerViewSchedulerView.SchedulerSchedulerView.AppointmentsSchedulerView.AppointmentTitleFormatSchedulerView.EndDateSchedulerView.ShowHeaderSchedulerView.AllowToolTipsSchedulerView.AllowAppointmentResizeSchedulerView.AllowAppointmentMoveSchedulerView.CellToolTipFormatSchedulerView.PropertyChanged...

Constructors

SchedulerDayViewBase()

Initializes a new instance of the SchedulerDayViewBase class.

C#
public SchedulerDayViewBase()

Properties

AutoScrollToWorkTime

Gets or sets a value indicating whether to automatically scroll to the work time.

C#
public bool AutoScrollToWorkTime { get; set; }

CanSetDayCount

Gets a value indicating whether this instance can set day count.

C#
public virtual bool CanSetDayCount { get; }
Property Value:

true if this instance can set day count; otherwise, false.

CurrentTime

Gets or sets a value indicating to what the view is scrolled.

C#
protected TimeSpan CurrentTime { get; set; }

DayCount

Gets or sets the day count.

C#
public abstract int DayCount { get; set; }
Property Value:

The day count.

DefaultTimeZone

Gets or sets the offset time span.

C#
public override SchedulerTimeZone DefaultTimeZone { get; set; }
Property Value:

The offset time span.

Overrides: SchedulerView.DefaultTimeZone

RangeFactor

Gets or sets the range factor.

C#
public ScaleRange RangeFactor { get; set; }
Property Value:

The range factor.

RulerEndScale

Gets or sets the last hour which the ruler in day view should display. To set minutes use the RulerEndScaleMinutes property.

C#
public int RulerEndScale { get; set; }

RulerEndScaleMinutes

Gets or sets the minutes in addition to the RulerEndScale. Together these properties allow changing the default end of the ruler scale on the left side of day view. The value of this property will snap to the nearest multiple of the RangeFactor.

C#
public int RulerEndScaleMinutes { get; set; }

RulerFormatStrings

Gets or sets the ruler time format.

C#
public virtual RulerFormatStrings RulerFormatStrings { get; set; }
Property Value:

The ruler time format.

RulerScaleSize

Gets or sets the size of the ruler scale.

C#
public virtual int RulerScaleSize { get; set; }
Property Value:

The size of the ruler scale.

RulerStartScale

Gets or sets the first hour which the ruler in day view should display. To set minutes use the RulerStartScaleMinutes property.

C#
public int RulerStartScale { get; set; }

RulerStartScaleMinutes

Gets or sets the minutes in addition to the RulerStartScale. Together these properties allow changing the default start of the ruler scale on the left side of day view. The value of this property will snap to the nearest multiple of the RangeFactor.

C#
public int RulerStartScaleMinutes { get; set; }

RulerWidth

Gets or sets the width of the ruler.

C#
public int RulerWidth { get; set; }
Property Value:

The width of the ruler.

ShowAllDayArea

Gets or sets a value indicating whether the all day area is shown.

C#
public virtual bool ShowAllDayArea { get; set; }
Property Value:

true if the all day area is shown; otherwise, false.

ShowRuler

Gets or sets a value indicating whether the ruler is shown.

C#
public virtual bool ShowRuler { get; set; }
Property Value:

true if the ruler is shown; otherwise, false.

TimeZones

Gets the time zones collection.

C#
public SchedulerTimeZoneCollection TimeZones { get; }
Property Value:

The time zones collection.

WorkTime

Gets or sets the work time.

C#
public virtual TimeInterval WorkTime { get; set; }
Property Value:

The work time.

WorkTimeExceptions

A collection of WorkTimeExceptionRule rules which define exceptions to the general work time provided by the WorkTime property. The rules in this collection are checked in an increasing order of their indices and therefore if a date matches a number of rules, the one with the greatest index overrides the others.

C#
public ItemObservableCollection<WorkTimeExceptionRule> WorkTimeExceptions { get; }

WorkWeekEnd

Gets or sets the last day of the working week.

C#
public DayOfWeek WorkWeekEnd { get; set; }

WorkWeekStart

Gets or sets the first day of the working week.

C#
public DayOfWeek WorkWeekStart { get; set; }

Methods

CopyPropertiesToView(SchedulerView)

Copies the properties to view.

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

The other.

Overrides: SchedulerView.CopyPropertiesToView(SchedulerView)

CreateViewWithStartDate(DateTime)

Creates the view with start date.

C#
protected override SchedulerView CreateViewWithStartDate(DateTime startDate)
Parameters:startDateDateTime

The start date.

Returns:

SchedulerView

Overrides: SchedulerView.CreateViewWithStartDate(DateTime)

Dispose()

C#
public void Dispose()

Implements: IDisposable.Dispose()

GetColumnForDate(DateTime)

Gets the column index corresponding to a given date.

C#
public virtual int GetColumnForDate(DateTime dateTime)
Parameters:dateTimeDateTime

The date.

Returns:

int

The corresponding index.

GetDateForCell(int, int, RadScheduler)

Gets the date that corresponds to a cell.

C#
public virtual DateTime GetDateForCell(int row, int column, RadScheduler scheduler)
Parameters:rowint

The row index of the cell.

columnint

The column index of the cell.

schedulerRadScheduler

The scheduler

Returns:

DateTime

The corresponding date.

GetDateForCell(int, int)

Gets the date that corresponds to a cell.

C#
public virtual DateTime GetDateForCell(int row, int column)
Parameters:rowint

The row index of the cell.

columnint

The column index of the cell.

Returns:

DateTime

The corresponding date.

GetDateForColumn(int, RadScheduler)

Gets the date that corresponds to a column.

C#
public virtual DateTime GetDateForColumn(int column, RadScheduler scheduler)
Parameters:columnint

The column index.

schedulerRadScheduler

The scheduler

Returns:

DateTime

The corresponding date.

GetDateForColumn(int)

Gets the date that corresponds to a column.

C#
public virtual DateTime GetDateForColumn(int column)
Parameters:columnint

The column index.

Returns:

DateTime

The corresponding date.

GetEndDate(DateTime)

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

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

The start date.

Returns:

DateTime

Overrides: SchedulerView.GetEndDate(DateTime)

GetNextView(int)

Gets the next view.

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

The offset.

Returns:

SchedulerView

Overrides: SchedulerView.GetNextView(int)

GetNextView(NavigationStepTypes, int)

Gets the next view.

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

The navigation step type.

navigationStepint

The navigation step.

Returns:

SchedulerView

Overrides: SchedulerView.GetNextView(NavigationStepTypes, int)

GetNumberOfCellsPerHour()

Gets the number of cells per hour.

C#
public int GetNumberOfCellsPerHour()
Returns:

int

GetPreviousView(int)

Gets the previous view.

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

The offset.

Returns:

SchedulerView

Overrides: SchedulerView.GetPreviousView(int)

GetPreviousView(NavigationStepTypes, int)

Gets the previous view.

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

The navigation step type.

navigationStepint

The navigation step.

Returns:

SchedulerView

Overrides: SchedulerView.GetPreviousView(NavigationStepTypes, int)

GetRowsCount()

Gets the calculated number of rows according to the RulerStartScale, RulerStartScaleMinutes, RulerEndScale and RulerEndScaleMinutes properties.

C#
public int GetRowsCount()
Returns:

int

The number of rows that need to be displayed.

GetViewContainingDate(DateTime)

Creates a Scheduler View object based on the logic implemented by the Scheduler View instance that implements the method.

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

DateTime object that is used to create the Scheduler View.

Returns:

SchedulerView

The created Scheduler View object.

Overrides: SchedulerView.GetViewContainingDate(DateTime)

IsWorkingDay(DayOfWeek)

Checks if a given week day is a working day.

C#
public bool IsWorkingDay(DayOfWeek dayOfWeek)
Parameters:dayOfWeekDayOfWeek

The week day.

Returns:

bool

[true] if the week day is a working day, [false] otherwise.

IsWorkTime(DateTime)

Checks if a given date is work time by checking the WorkWeekStart, WorkWeekEnd, WorkTime properties and then by checking the exceptions defined in the WorkTimeExceptions collections.

C#
public virtual bool IsWorkTime(DateTime cellDate)
Parameters:cellDateDateTime

The date.

Returns:

bool

[true] if the date is work time, [false] otherwise.

UpdateOnPropertyChange(string)

Called when a property is changed.

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

Name of the property.

Overrides: SchedulerView.UpdateOnPropertyChange(string)

In this article
DefinitionConstructorsSchedulerDayViewBase()PropertiesAutoScrollToWorkTimeCanSetDayCountCurrentTimeDayCountDefaultTimeZoneRangeFactorRulerEndScaleRulerEndScaleMinutesRulerFormatStringsRulerScaleSizeRulerStartScaleRulerStartScaleMinutesRulerWidthShowAllDayAreaShowRulerTimeZonesWorkTimeWorkTimeExceptionsWorkWeekEndWorkWeekStartMethodsCopyPropertiesToView(SchedulerView)CreateViewWithStartDate(DateTime)Dispose()GetColumnForDate(DateTime)GetDateForCell(int, int, RadScheduler)GetDateForCell(int, int)GetDateForColumn(int, RadScheduler)GetDateForColumn(int)GetEndDate(DateTime)GetNextView(int)GetNextView(NavigationStepTypes, int)GetNumberOfCellsPerHour()GetPreviousView(int)GetPreviousView(NavigationStepTypes, int)GetRowsCount()GetViewContainingDate(DateTime)IsWorkingDay(DayOfWeek)IsWorkTime(DateTime)UpdateOnPropertyChange(string)
Not finding the help you need?
Contact Support