Back to all docs
API Reference / Telerik.WinControls.UI / SchedulerDayViewBase

Class
SchedulerDayViewBase

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:
cs-api-definition
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.

Declaration

cs-api-definition
public SchedulerDayViewBase()

Properties

AutoScrollToWorkTime

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

Declaration

cs-api-definition
public bool AutoScrollToWorkTime { get; set; }

Property Value

bool

CanSetDayCount

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

Declaration

cs-api-definition
public virtual bool CanSetDayCount { get; }

Property Value

bool

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

CurrentTime

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

Declaration

cs-api-definition
protected TimeSpan CurrentTime { get; set; }

Property Value

TimeSpan

DayCount

Gets or sets the day count.

Declaration

cs-api-definition
public abstract int DayCount { get; set; }

Property Value

int

The day count.

DefaultTimeZone

Gets or sets the offset time span.

Declaration

cs-api-definition
public override SchedulerTimeZone DefaultTimeZone { get; set; }

Property Value

SchedulerTimeZone

The offset time span.

Overrides SchedulerView.DefaultTimeZone

RangeFactor

Gets or sets the range factor.

Declaration

cs-api-definition
public ScaleRange RangeFactor { get; set; }

Property Value

ScaleRange

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.

Declaration

cs-api-definition
public int RulerEndScale { get; set; }

Property Value

int

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.

Declaration

cs-api-definition
public int RulerEndScaleMinutes { get; set; }

Property Value

int

RulerFormatStrings

Gets or sets the ruler time format.

Declaration

cs-api-definition
public virtual RulerFormatStrings RulerFormatStrings { get; set; }

Property Value

RulerFormatStrings

The ruler time format.

RulerScaleSize

Gets or sets the size of the ruler scale.

Declaration

cs-api-definition
public virtual int RulerScaleSize { get; set; }

Property Value

int

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.

Declaration

cs-api-definition
public int RulerStartScale { get; set; }

Property Value

int

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.

Declaration

cs-api-definition
public int RulerStartScaleMinutes { get; set; }

Property Value

int

RulerWidth

Gets or sets the width of the ruler.

Declaration

cs-api-definition
public int RulerWidth { get; set; }

Property Value

int

The width of the ruler.

ShowAllDayArea

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

Declaration

cs-api-definition
public virtual bool ShowAllDayArea { get; set; }

Property Value

bool

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

ShowRuler

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

Declaration

cs-api-definition
public virtual bool ShowRuler { get; set; }

Property Value

bool

true if the ruler is shown; otherwise, false.

TimeZones

Gets the time zones collection.

Declaration

cs-api-definition
public SchedulerTimeZoneCollection TimeZones { get; }

Property Value

SchedulerTimeZoneCollection

The time zones collection.

WorkTime

Gets or sets the work time.

Declaration

cs-api-definition
public virtual TimeInterval WorkTime { get; set; }

Property Value

TimeInterval

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.

Declaration

cs-api-definition
public ItemObservableCollection<WorkTimeExceptionRule> WorkTimeExceptions { get; }

Property Value

ItemObservableCollection<WorkTimeExceptionRule>

WorkWeekEnd

Gets or sets the last day of the working week.

Declaration

cs-api-definition
public DayOfWeek WorkWeekEnd { get; set; }

Property Value

DayOfWeek

WorkWeekStart

Gets or sets the first day of the working week.

Declaration

cs-api-definition
public DayOfWeek WorkWeekStart { get; set; }

Property Value

DayOfWeek

Methods

CopyPropertiesToView(SchedulerView)

Copies the properties to view.

Declaration

cs-api-definition
protected override void CopyPropertiesToView(SchedulerView other)

Parameters

other

SchedulerView

The other.

Overrides SchedulerView.CopyPropertiesToView(SchedulerView)

CreateViewWithStartDate(DateTime)

Creates the view with start date.

Declaration

cs-api-definition
protected override SchedulerView CreateViewWithStartDate(DateTime startDate)

Parameters

startDate

DateTime

The start date.

Returns

SchedulerView

Overrides SchedulerView.CreateViewWithStartDate(DateTime)

Dispose()

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

GetColumnForDate(DateTime)

Gets the column index corresponding to a given date.

Declaration

cs-api-definition
public virtual int GetColumnForDate(DateTime dateTime)

Parameters

dateTime

DateTime

The date.

Returns

int

The corresponding index.

GetDateForCell(int, int)

Gets the date that corresponds to a cell.

Declaration

cs-api-definition
public virtual DateTime GetDateForCell(int row, int column)

Parameters

row

int

The row index of the cell.

column

int

The column index of the cell.

Returns

DateTime

The corresponding date.

GetDateForCell(int, int, RadScheduler)

Gets the date that corresponds to a cell.

Declaration

cs-api-definition
public virtual DateTime GetDateForCell(int row, int column, RadScheduler scheduler)

Parameters

row

int

The row index of the cell.

column

int

The column index of the cell.

scheduler

RadScheduler

The scheduler

Returns

DateTime

The corresponding date.

GetDateForColumn(int)

Gets the date that corresponds to a column.

Declaration

cs-api-definition
public virtual DateTime GetDateForColumn(int column)

Parameters

column

int

The column index.

Returns

DateTime

The corresponding date.

GetDateForColumn(int, RadScheduler)

Gets the date that corresponds to a column.

Declaration

cs-api-definition
public virtual DateTime GetDateForColumn(int column, RadScheduler scheduler)

Parameters

column

int

The column index.

scheduler

RadScheduler

The scheduler

Returns

DateTime

The corresponding date.

GetEndDate(DateTime)

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

Declaration

cs-api-definition
protected override DateTime GetEndDate(DateTime startDate)

Parameters

startDate

DateTime

The start date.

Returns

DateTime

Overrides SchedulerView.GetEndDate(DateTime)

GetNextView(NavigationStepTypes, int)

Gets the next view.

Declaration

cs-api-definition
public override SchedulerView GetNextView(NavigationStepTypes navigationStepType, int navigationStep)

Parameters

navigationStepType

NavigationStepTypes

The navigation step type.

navigationStep

int

The navigation step.

Returns

SchedulerView

Overrides SchedulerView.GetNextView(NavigationStepTypes, int)

GetNextView(int)

Gets the next view.

Declaration

cs-api-definition
public override SchedulerView GetNextView(int offset)

Parameters

offset

int

The offset.

Returns

SchedulerView

Overrides SchedulerView.GetNextView(int)

GetNumberOfCellsPerHour()

Gets the number of cells per hour.

Declaration

cs-api-definition
public int GetNumberOfCellsPerHour()

Returns

int

GetPreviousView(NavigationStepTypes, int)

Gets the previous view.

Declaration

cs-api-definition
public override SchedulerView GetPreviousView(NavigationStepTypes navigationStepType, int navigationStep)

Parameters

navigationStepType

NavigationStepTypes

The navigation step type.

navigationStep

int

The navigation step.

Returns

SchedulerView

Overrides SchedulerView.GetPreviousView(NavigationStepTypes, int)

GetPreviousView(int)

Gets the previous view.

Declaration

cs-api-definition
public override SchedulerView GetPreviousView(int offset)

Parameters

offset

int

The offset.

Returns

SchedulerView

Overrides SchedulerView.GetPreviousView(int)

GetRowsCount()

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

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
public override SchedulerView GetViewContainingDate(DateTime date)

Parameters

date

DateTime

DateTime object that is used to create the Scheduler View.

Returns

SchedulerView

The created Scheduler View object.

Overrides SchedulerView.GetViewContainingDate(DateTime)

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.

Declaration

cs-api-definition
public virtual bool IsWorkTime(DateTime cellDate)

Parameters

cellDate

DateTime

The date.

Returns

bool

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

IsWorkingDay(DayOfWeek)

Checks if a given week day is a working day.

Declaration

cs-api-definition
public bool IsWorkingDay(DayOfWeek dayOfWeek)

Parameters

dayOfWeek

DayOfWeek

The week day.

Returns

bool

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

UpdateOnPropertyChange(string)

Called when a property is changed.

Declaration

cs-api-definition
protected override void UpdateOnPropertyChange(string propertyName)

Parameters

propertyName

string

Name of the property.

Overrides SchedulerView.UpdateOnPropertyChange(string)

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