Class
SchedulerTimelineView

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

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

Declaration

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

Declaration

cs-api-definition
public SchedulerTimescale CurrentScale { get; }

Property Value

SchedulerTimescale

DisplayedCellsCount

Declaration

cs-api-definition
public int DisplayedCellsCount { get; }

Property Value

int

Duration

Gets TimelineView's duration.

Declaration

cs-api-definition
public TimeSpan Duration { get; }

Property Value

TimeSpan

OffsetTimeSpan

Gets or sets the offset time span.

Declaration

cs-api-definition
public override TimeSpan OffsetTimeSpan { get; set; }

Property Value

TimeSpan

The offset time span.

Overrides SchedulerView.OffsetTimeSpan

RangeEndDate

Gets or sets the TimelineView's RangeEndDate.

Declaration

cs-api-definition
public DateTime RangeEndDate { get; set; }

Property Value

DateTime

RangeStartDate

Gets or sets the TimelineView's RangeStartDate.

Declaration

cs-api-definition
public DateTime RangeStartDate { get; set; }

Property Value

DateTime

SchedulerTimescales

Gets or sets the TimeScales

Declaration

cs-api-definition
public ObservableCollection<SchedulerTimescale> SchedulerTimescales { get; set; }

Property Value

ObservableCollection<SchedulerTimescale>

ShowNavigationElement

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

Declaration

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

Property Value

bool

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.

Declaration

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

Property Value

bool

StartDate

Gets or sets the start date.

Declaration

cs-api-definition
public override DateTime StartDate { get; set; }

Property Value

DateTime

Overrides SchedulerView.StartDate

ViewType

Gets the view tipe.

Declaration

cs-api-definition
public override SchedulerViewType ViewType { get; }

Property Value

SchedulerViewType

Overrides SchedulerView.ViewType

Methods

CopyPropertiesToView(SchedulerView)

Copies the properties from the current view.

Declaration

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

Parameters

other

SchedulerView

Overrides SchedulerView.CopyPropertiesToView(SchedulerView)

CreateViewWithStartDate(DateTime)

Creates a view which has a specific start date.

Declaration

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

Parameters

startDate

DateTime

Returns

SchedulerView

Overrides SchedulerView.CreateViewWithStartDate(DateTime)

GetDaysTimescales()

Gets a list with the days time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetDaysTimescales()

Returns

List<SchedulerTimescale>

GetDefaultFormats()

Gets the list with default supported formats.

Declaration

cs-api-definition
public List<string> GetDefaultFormats()

Returns

List<string>

GetEndDate(DateTime)

Gets the view's end date.

Declaration

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

Parameters

startDate

DateTime

Returns

DateTime

Overrides SchedulerView.GetEndDate(DateTime)

GetHalfHourTimescales()

Gets a list with the half hour time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetHalfHourTimescales()

Returns

List<SchedulerTimescale>

GetHoursTimescales()

Gets a list with the hours time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetHoursTimescales()

Returns

List<SchedulerTimescale>

GetMinutesTimescales()

Gets a list with the minutes time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetMinutesTimescales()

Returns

List<SchedulerTimescale>

GetMonthsTimescales()

Gets a list with the months time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetMonthsTimescales()

Returns

List<SchedulerTimescale>

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 view with offset from the current view.

Declaration

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

Parameters

offset

int

Returns

SchedulerView

Overrides SchedulerView.GetNextView(int)

GetNextViewWithAppointments(IEnumerable<IEvent>)

Gets the next view containing any of the given appointments.

Declaration

cs-api-definition
public override SchedulerView GetNextViewWithAppointments(IEnumerable<IEvent> appointments)

Parameters

appointments

IEnumerable<IEvent>

Returns

SchedulerView

Overrides SchedulerView.GetNextViewWithAppointments(IEnumerable<IEvent>)

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

Returns

SchedulerView

Overrides SchedulerView.GetPreviousView(int)

GetPreviousViewWithAppointments(IEnumerable<IEvent>)

Gets the previous view containing any of the given appointments.

Declaration

cs-api-definition
public override SchedulerView GetPreviousViewWithAppointments(IEnumerable<IEvent> appointments)

Parameters

appointments

IEnumerable<IEvent>

Returns

SchedulerView

Overrides SchedulerView.GetPreviousViewWithAppointments(IEnumerable<IEvent>)

GetScaling()

Gets the TimelineView's scaling.

Declaration

cs-api-definition
public SchedulerTimescale GetScaling()

Returns

SchedulerTimescale

GetScalingMinutes(DateTime)

Declaration

cs-api-definition
public int GetScalingMinutes(DateTime date)

Parameters

date

DateTime

Returns

int

GetScalingMinutes(SchedulerTimescale)

Declaration

cs-api-definition
public int GetScalingMinutes(SchedulerTimescale scale)

Parameters

scale

SchedulerTimescale

Returns

int

GetStartDateForScale(DateTime, SchedulerTimescale)

Declaration

cs-api-definition
protected virtual DateTime GetStartDateForScale(DateTime date, SchedulerTimescale timeScale)

Parameters

date

DateTime

timeScale

SchedulerTimescale

Returns

DateTime

GetTimescale(Timescales)

Gets a SchedulerTimescale by a passed as a parameter scale.

Declaration

cs-api-definition
public SchedulerTimescale GetTimescale(Timescales scale)

Parameters

scale

Timescales

Returns

SchedulerTimescale

GetTimescale(int)

Gets a Timescale by index.

Declaration

cs-api-definition
public Timescales GetTimescale(int index)

Parameters

index

int

Returns

Timescales

GetViewContainingDate(DateTime)

Gets the view which contains a specific date.

Declaration

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

Parameters

date

DateTime

Returns

SchedulerView

Overrides SchedulerView.GetViewContainingDate(DateTime)

GetVisibleTimescales(Timescales)

Gets a list with the visible time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetVisibleTimescales(Timescales scale)

Parameters

scale

Timescales

Returns

List<SchedulerTimescale>

GetWeeksTimescales()

Gets a list with the weeks time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetWeeksTimescales()

Returns

List<SchedulerTimescale>

GetYearsTimescales()

Gets a list with the years time scales.

Declaration

cs-api-definition
public List<SchedulerTimescale> GetYearsTimescales()

Returns

List<SchedulerTimescale>

IsAppointmentInView(IEvent)

Determines whether a given appointment intersects with this view..

Declaration

cs-api-definition
public override bool IsAppointmentInView(IEvent appointment)

Parameters

appointment

IEvent

The appointment.

Returns

bool

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

Overrides SchedulerView.IsAppointmentInView(IEvent)

OnRefreshNeeded()

Fires the RefreshNeeded event.

Declaration

cs-api-definition
protected virtual void OnRefreshNeeded()

SetStartDate(DateTime)

Sets view's start date.

Declaration

cs-api-definition
protected override bool SetStartDate(DateTime value)

Parameters

value

DateTime

Returns

bool

Overrides SchedulerView.SetStartDate(DateTime)

ShowTimescale(SchedulerTimescale)

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

Declaration

cs-api-definition
public void ShowTimescale(SchedulerTimescale timeScale)

Parameters

timeScale

SchedulerTimescale

The scale to show.

ShowTimescale(Timescales)

Shows the timescale with the specified type.

Declaration

cs-api-definition
public void ShowTimescale(Timescales scale)

Parameters

scale

Timescales

The type of the scale to show.

UpdateOnPropertyChange(string)

Declaration

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

Parameters

propertyName

string

Overrides SchedulerView.UpdateOnPropertyChange(string)

Events

RefreshNeeded

Occurs when a Refresh is necessary.

Declaration

cs-api-definition
public event EventHandler RefreshNeeded

Event Value

EventHandler