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

SchedulerTimelineView

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:
C#
public class SchedulerTimelineView : SchedulerView, INotifyPropertyChanged

Inheritance: objectSchedulerViewSchedulerTimelineView

Implements: INotifyPropertyChanged

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.IsDateInView(DateTime)SchedulerView.IsResourceIntersectsWithViewResources(IEvent)SchedulerView.AddResources(SchedulerResourceCollection)SchedulerView.GetResources()SchedulerView.GetResource()SchedulerView.GetResourceId()SchedulerView.OffsetView(int)SchedulerView.GetViewContainingDate(DateTime, int)SchedulerView.GetPreviousView()SchedulerView.GetNextView()SchedulerView.CalculatePreviousView(IEnumerable<IEvent>, DateTime)SchedulerView.CalculateNextDate(IEnumerable<IEvent>, ref DateTime)SchedulerView.GetFirstAppointment()SchedulerView.GetLastAppointment()SchedulerView.SetDefaultTimeZone(SchedulerTimeZone)SchedulerView.OnPropertyChanged(params string[])SchedulerView.DefaultTimeZoneSchedulerView.CurrentDateSchedulerView.NameSchedulerView.VisibleSchedulerView.ReadOnlySchedulerView.GroupSeparatorWidthSchedulerView.AllowResourcesScrollingSchedulerView.ResourcesPerViewSchedulerView.SchedulerSchedulerView.AppointmentsSchedulerView.AppointmentTitleFormatSchedulerView.EndDateSchedulerView.ShowHeaderSchedulerView.AllowToolTipsSchedulerView.AllowAppointmentResizeSchedulerView.AllowAppointmentMoveSchedulerView.CellToolTipFormatSchedulerView.PropertyChanged...

Constructors

SchedulerTimelineView()

Initializes a new instance of the SchedulerTimelineView class.

C#
public SchedulerTimelineView()

Properties

CurrentScale

Gets the time scale that was last shown by the ShowTimescale method. If the method was not called, returns null. Use the GetScaling() method to get the scale that is in active use.

C#
public SchedulerTimescale CurrentScale { get; }

DisplayedCellsCount

C#
public int DisplayedCellsCount { get; }

Duration

Gets TimelineView's duration.

C#
public TimeSpan Duration { get; }

OffsetTimeSpan

Gets or sets the offset time span.

C#
public override TimeSpan OffsetTimeSpan { get; set; }
Property Value:

The offset time span.

Overrides: SchedulerView.OffsetTimeSpan

RangeEndDate

Gets or sets the TimelineView's RangeEndDate.

C#
public DateTime RangeEndDate { get; set; }

RangeStartDate

Gets or sets the TimelineView's RangeStartDate.

C#
public DateTime RangeStartDate { get; set; }

SchedulerTimescales

Gets or sets the TimeScales

C#
public ObservableCollection<SchedulerTimescale> SchedulerTimescales { get; set; }

ShowNavigationElement

Gets or sets a value indicating whether to show the horizontal scrollbar in SchedulerTimelineView which stands for navigation through dates.

C#
public bool ShowNavigationElement { get; set; }

ShowVerticalScrollBar

Gets or sets a value indicating whether to show the vertical scrollbar in SchedulerTimelineView which stands scrolling through the appointments when a cell overflows.

C#
public bool ShowVerticalScrollBar { get; set; }

StartDate

Gets or sets the start date.

C#
public override DateTime StartDate { get; set; }

Overrides: SchedulerView.StartDate

ViewType

Gets the view tipe.

C#
public override SchedulerViewType ViewType { get; }

Overrides: SchedulerView.ViewType

Methods

CopyPropertiesToView(SchedulerView)

Copies the properties from the current view.

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

Overrides: SchedulerView.CopyPropertiesToView(SchedulerView)

CreateViewWithStartDate(DateTime)

Creates a view which has a specific start date.

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

SchedulerView

Overrides: SchedulerView.CreateViewWithStartDate(DateTime)

GetDaysTimescales()

Gets a list with the days time scales.

C#
public List<SchedulerTimescale> GetDaysTimescales()
Returns:

List<SchedulerTimescale>

GetDefaultFormats()

Gets the list with default supported formats.

C#
public List<string> GetDefaultFormats()
Returns:

List<string>

GetEndDate(DateTime)

Gets the view's end date.

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

DateTime

Overrides: SchedulerView.GetEndDate(DateTime)

GetHalfHourTimescales()

Gets a list with the half hour time scales.

C#
public List<SchedulerTimescale> GetHalfHourTimescales()
Returns:

List<SchedulerTimescale>

GetHoursTimescales()

Gets a list with the hours time scales.

C#
public List<SchedulerTimescale> GetHoursTimescales()
Returns:

List<SchedulerTimescale>

GetMinutesTimescales()

Gets a list with the minutes time scales.

C#
public List<SchedulerTimescale> GetMinutesTimescales()
Returns:

List<SchedulerTimescale>

GetMonthsTimescales()

Gets a list with the months time scales.

C#
public List<SchedulerTimescale> GetMonthsTimescales()
Returns:

List<SchedulerTimescale>

GetNextView(int)

Gets the view with offset from the current view.

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

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)

GetNextViewWithAppointments(IEnumerable<IEvent>)

Gets the next view containing any of the given appointments.

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

SchedulerView

Overrides: SchedulerView.GetNextViewWithAppointments(IEnumerable<IEvent>)

GetPreviousView(int)

Gets the previous view.

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

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)

GetPreviousViewWithAppointments(IEnumerable<IEvent>)

Gets the previous view containing any of the given appointments.

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

SchedulerView

Overrides: SchedulerView.GetPreviousViewWithAppointments(IEnumerable<IEvent>)

GetScaling()

Gets the TimelineView's scaling.

C#
public SchedulerTimescale GetScaling()
Returns:

SchedulerTimescale

GetScalingMinutes(DateTime)

C#
public int GetScalingMinutes(DateTime date)
Parameters:dateDateTimeReturns:

int

GetScalingMinutes(SchedulerTimescale)

C#
public int GetScalingMinutes(SchedulerTimescale scale)
Parameters:scaleSchedulerTimescaleReturns:

int

GetStartDateForScale(DateTime, SchedulerTimescale)

C#
protected virtual DateTime GetStartDateForScale(DateTime date, SchedulerTimescale timeScale)
Parameters:dateDateTimetimeScaleSchedulerTimescaleReturns:

DateTime

GetTimescale(int)

Gets a Timescale by index.

C#
public Timescales GetTimescale(int index)
Parameters:indexintReturns:

Timescales

GetTimescale(Timescales)

Gets a SchedulerTimescale by a passed as a parameter scale.

C#
public SchedulerTimescale GetTimescale(Timescales scale)
Parameters:scaleTimescalesReturns:

SchedulerTimescale

GetViewContainingDate(DateTime)

Gets the view which contains a specific date.

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

SchedulerView

Overrides: SchedulerView.GetViewContainingDate(DateTime)

GetVisibleTimescales(Timescales)

Gets a list with the visible time scales.

C#
public List<SchedulerTimescale> GetVisibleTimescales(Timescales scale)
Parameters:scaleTimescalesReturns:

List<SchedulerTimescale>

GetWeeksTimescales()

Gets a list with the weeks time scales.

C#
public List<SchedulerTimescale> GetWeeksTimescales()
Returns:

List<SchedulerTimescale>

GetYearsTimescales()

Gets a list with the years time scales.

C#
public List<SchedulerTimescale> GetYearsTimescales()
Returns:

List<SchedulerTimescale>

IsAppointmentInView(IEvent)

Determines whether a given appointment intersects with this view..

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

The appointment.

Returns:

bool

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

Overrides: SchedulerView.IsAppointmentInView(IEvent)

OnRefreshNeeded()

Fires the RefreshNeeded event.

C#
protected virtual void OnRefreshNeeded()

SetStartDate(DateTime)

Sets view's start date.

C#
protected override bool SetStartDate(DateTime value)
Parameters:valueDateTimeReturns:

bool

Overrides: SchedulerView.SetStartDate(DateTime)

ShowTimescale(SchedulerTimescale)

Shows a timescale. The specified scale must be present in the SchedulerTimescales collection.

C#
public void ShowTimescale(SchedulerTimescale timeScale)
Parameters:timeScaleSchedulerTimescale

The scale to show.

ShowTimescale(Timescales)

Shows the timescale with the specified type.

C#
public void ShowTimescale(Timescales scale)
Parameters:scaleTimescales

The type of the scale to show.

UpdateOnPropertyChange(string)

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

Overrides: SchedulerView.UpdateOnPropertyChange(string)

Events

RefreshNeeded

Occurs when a Refresh is necessary.

C#
public event EventHandler RefreshNeeded
In this article
DefinitionConstructorsSchedulerTimelineView()PropertiesCurrentScaleDisplayedCellsCountDurationOffsetTimeSpanRangeEndDateRangeStartDateSchedulerTimescalesShowNavigationElementShowVerticalScrollBarStartDateViewTypeMethodsCopyPropertiesToView(SchedulerView)CreateViewWithStartDate(DateTime)GetDaysTimescales()GetDefaultFormats()GetEndDate(DateTime)GetHalfHourTimescales()GetHoursTimescales()GetMinutesTimescales()GetMonthsTimescales()GetNextView(int)GetNextView(NavigationStepTypes, int)GetNextViewWithAppointments(IEnumerable<IEvent>)GetPreviousView(int)GetPreviousView(NavigationStepTypes, int)GetPreviousViewWithAppointments(IEnumerable<IEvent>)GetScaling()GetScalingMinutes(DateTime)GetScalingMinutes(SchedulerTimescale)GetStartDateForScale(DateTime, SchedulerTimescale)GetTimescale(int)GetTimescale(Timescales)GetViewContainingDate(DateTime)GetVisibleTimescales(Timescales)GetWeeksTimescales()GetYearsTimescales()IsAppointmentInView(IEvent)OnRefreshNeeded()SetStartDate(DateTime)ShowTimescale(SchedulerTimescale)ShowTimescale(Timescales)UpdateOnPropertyChange(string)EventsRefreshNeeded
Not finding the help you need?
Contact Support