Class TimeBarBase

A base class for RadTimeBar and RadTimeline.

Inheritance

System.Object

TimeBarBase

RadTimeBar

RadTimeline

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

[TelerikToolboxCategory("Data Visualization")]
public abstract class TimeBarBase : ContentControl, ISupportInitialize

Constructors

TimeBarBase()

Initializes a new instance of the TimeBarBase class.

Declaration

protected TimeBarBase()

Fields

ActualVisiblePeriodRangeProperty

Identifies the ActualVisiblePeriodRange dependency property.

Declaration

public static readonly DependencyProperty ActualVisiblePeriodRangeProperty

Field Value

System.Windows.DependencyProperty

GroupPeriodHeaderStyleProperty

Identifies the GroupPeriodHeaderStyle dependency property.

Declaration

public static readonly DependencyProperty GroupPeriodHeaderStyleProperty

Field Value

System.Windows.DependencyProperty

Properties

By default, the size of the content element is restricted to 30000 pixels. This restriction is enforced by specifying a minimum zoom range using the ActualMinZoomRange property. In case MinZoomRange is specified, that is, its value is not System.TimeSpan.Zero, its value is set to the ActualMinZoomRange property and the default behavior is overwritten. However, in Silverlight, due to a limitation in the framework, the 30000 pixel restriction is respected even in case a small value is specified for the MinZoomRange property.

ActualVisiblePeriodRange

Gets the actual visible period range.

Declaration

public SelectionRange<DateTime> ActualVisiblePeriodRange { get; }

Property Value

SelectionRange<System.DateTime>

The actual visible period range.

Remarks

When the user is dragging one of the slider thumbs, the VisiblePeriodStart and VisiblePeriodEnd properties are updated once the user releases the slider thumb. On the other hand, the ActualVisiblePeriodRange property is updated while the slider thumbs are moving.

CurrentGroupInterval

Gets the current group interval.

Declaration

public IntervalBase CurrentGroupInterval { get; }

Property Value

IntervalBase

The current group interval.

CurrentItemInterval

Gets the current item interval.

Declaration

public IntervalBase CurrentItemInterval { get; }

Property Value

IntervalBase

The current item interval.

GroupPeriodHeaderStyle

Gets or sets the HeaderStyle for every group period item.

Declaration

public Style GroupPeriodHeaderStyle { get; set; }

Property Value

System.Windows.Style

The HeaderStyle for every group period item.

IntervalGroups

Gets a collection of PeriodSpans used to generate the group period items.

Declaration

public IEnumerable<PeriodSpan> IntervalGroups { get; }

Property Value

System.Collections.Generic.IEnumerable<PeriodSpan>

A collection of PeriodSpans used to generate the group period items.

Remarks

This property is for internal use only.

IntervalItems

Gets a collection of PeriodSpans used to generate the period items.

Declaration

public IEnumerable<PeriodSpan> IntervalItems { get; }

Property Value

System.Collections.Generic.IEnumerable<PeriodSpan>

A collection of PeriodSpans used to generate the period items.

Remarks

This property is for internal use only.

Intervals

Gets a collection of intervals used by the control.

Declaration

public IntervalCollection Intervals { get; }

Property Value

IntervalCollection

A collection of intervals used by the control.

LargeChange

Gets or sets the System.TimeSpan value to add to or subtract from VisiblePeriodStart when the user clicks on the track of the slider.

Declaration

public TimeSpan LargeChange { get; set; }

Property Value

System.TimeSpan

The System.TimeSpan value to add to or subtract from VisiblePeriodStart when the user clicks on the track of the slider.

Remarks

This property is for internal use only.

MaxZoomRange

Gets or sets the maximum System.TimeSpan that the control can zoom out to.

Declaration

public TimeSpan MaxZoomRange { get; set; }

Property Value

System.TimeSpan

The maximum System.TimeSpan that the control can zoom out to.

Remarks

The MaxZoomRange value must be greater than or equal to the value of MinZoomRange.

MinZoomRange

Gets or sets the minimum System.TimeSpan that the control can zoom in to.

Declaration

public TimeSpan MinZoomRange { get; set; }

Property Value

System.TimeSpan

The minimum System.TimeSpan that the control can zoom in to.

Remarks

PeriodEnd

Gets or sets the end of the period that the control visualizes. The PeriodEnd value itself is excluded from the period.

Declaration

public DateTime PeriodEnd { get; set; }

Property Value

System.DateTime

The end of the period that the control visualizes.

Remarks

The PeriodStart value must be less than or equal to the value of PeriodEnd.

PeriodHeaderStyle

Gets or sets the HeaderStyle for every period item.

Declaration

public Style PeriodHeaderStyle { get; set; }

Property Value

System.Windows.Style

The HeaderStyle for every period item.

PeriodStart

Gets or sets the start of the period that the control visualizes.

Declaration

public DateTime PeriodStart { get; set; }

Property Value

System.DateTime

The start of the period that the control visualizes.

Remarks

The PeriodStart value must be less than or equal to the value of PeriodEnd.

ScrollMode

Gets or sets a value that determines how manipulation input influences the horizontal scrolling and zooming behavior of the control.

Declaration

public ScrollMode ScrollMode { get; set; }

Property Value

ScrollMode

A value that determines how manipulation input influences the horizontal scrolling and zooming behavior of the control. The default is ScrollMode.ScrollAndZoom.

SliderStyle

Gets or sets the System.Windows.FrameworkElement.Style of the RadSlider.

Declaration

public Style SliderStyle { get; set; }

Property Value

System.Windows.Style

The System.Windows.FrameworkElement.Style of the RadSlider.

SmallChange

Gets or sets the System.TimeSpan value to add to or subtract from VisiblePeriodStart when the user clicks on the increase or decrease handles of the slider. The SmallChange also determines the zoom step.

Declaration

public TimeSpan SmallChange { get; set; }

Property Value

System.TimeSpan

The System.TimeSpan value to add to or subtract from VisiblePeriodStart when the user clicks on the increase or decrease handles of the slider. The SmallChange also determines the zoom step.

Remarks

This property is for internal use only.

SpecialSlots

Gets a collection of IPeriodSpans used to generate the special slots.

Declaration

public IEnumerable<IPeriodSpan> SpecialSlots { get; }

Property Value

System.Collections.Generic.IEnumerable<IPeriodSpan>

A collection of IPeriodSpans used to generate the special slots.

Remarks

This property is for internal use only.

SpecialSlotsGenerator

Gets or sets an ITimeRangeGenerator instance that generates special IPeriodSpan slots for the current VisiblePeriod.

Declaration

public ITimeRangeGenerator SpecialSlotsGenerator { get; set; }

Property Value

ITimeRangeGenerator

An ITimeRangeGenerator instance that generates the special IPeriodSpan slots for the current VisiblePeriod. By default, no special slots are generated.

VisiblePeriod

Gets or sets the visible period.

Declaration

public SelectionRange<DateTime> VisiblePeriod { get; set; }

Property Value

SelectionRange<System.DateTime>

The visible period.

VisiblePeriodEnd

Gets or sets the end of the visible period.

Declaration

public DateTime VisiblePeriodEnd { get; set; }

Property Value

System.DateTime

The end of the visible period.

Remarks

The VisiblePeriodStart value must be less than or equal to the value of VisiblePeriodEnd. Additionally, both VisiblePeriodStart and VisiblePeriodEnd must be within the period, defined by the PeriodStart and PeriodEnd properties.

VisiblePeriodStart

Gets or sets the start of the visible period.

Declaration

public DateTime VisiblePeriodStart { get; set; }

Property Value

System.DateTime

The start of the visible period.

Remarks

Methods

add_VisiblePeriodChanged(RadRoutedEventHandler)

Declaration

public void add_VisiblePeriodChanged(RadRoutedEventHandler value)

Parameters

RadRoutedEventHandler value

ConvertPointToDateTime(Point)

Converts a point inside the control to a DateTime value relative to the timeline.

Declaration

public DateTime ConvertPointToDateTime(Point coordinates)

Parameters

System.Windows.Point coordinates

Position inside the control.

Returns

System.DateTime

The DateTime value relative to the timeline.

EndInit()

Indicates that the initialization process for the element is complete.

Declaration

public override void EndInit()

Exceptions

System.InvalidOperationException

System.Windows.FrameworkElement.EndInit was called without System.Windows.FrameworkElement.BeginInit having previously been called on the element.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnGroupIntervalChanged(IntervalBase, IntervalBase)

Called when the CurrentGroupInterval changes.

Declaration

protected virtual void OnGroupIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)

Parameters

IntervalBase oldInterval

The old interval.

IntervalBase newInterval

The new interval.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnItemIntervalChanged(IntervalBase, IntervalBase)

Called when the CurrentItemInterval changes.

Declaration

protected virtual void OnItemIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)

Parameters

IntervalBase oldInterval

The old interval.

IntervalBase newInterval

The new interval.

OnMouseWheel(MouseWheelEventArgs)

Raises the MouseWheel event.

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

System.Windows.Input.MouseWheelEventArgs e

The System.Windows.Input.MouseWheelEventArgs instance containing the event data.

OnSliderSelectionChanged(Object, RadRoutedEventArgs)

Called when the Selection of the RadSlider changes.

Declaration

protected virtual void OnSliderSelectionChanged(object sender, RadRoutedEventArgs e)

Parameters

System.Object sender

The RadSlider instance.

RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

OnVisiblePeriodChanged()

Called when the VisiblePeriodStart or the VisiblePeriodEnd change.

Declaration

protected virtual void OnVisiblePeriodChanged()

RegisterCommand(ICommand, ExecutedRoutedEventHandler, CanExecuteRoutedEventHandler)

Registers an System.Windows.Input.ICommand with the TimeBarBase type.

Declaration

protected static void RegisterCommand(ICommand command, ExecutedRoutedEventHandler executed, CanExecuteRoutedEventHandler canExecute)

Parameters

System.Windows.Input.ICommand command

The System.Windows.Input.ICommand to register.

System.Windows.Input.ExecutedRoutedEventHandler executed

The handler for the System.Windows.Input.CommandBinding.Executed event on the new System.Windows.Input.RoutedCommand.

System.Windows.Input.CanExecuteRoutedEventHandler canExecute

The handler for the System.Windows.Input.CommandBinding.CanExecute event on the new System.Windows.Input.RoutedCommand.

remove_VisiblePeriodChanged(RadRoutedEventHandler)

Declaration

public void remove_VisiblePeriodChanged(RadRoutedEventHandler value)

Parameters

RadRoutedEventHandler value

Events

ActualVisiblePeriodRangeChanged

Occurs when the actual visible period range changes.

Declaration

public event EventHandler ActualVisiblePeriodRangeChanged

Event Type

System.EventHandler

GroupIntervalChanged

Occurs when the CurrentGroupInterval changes.

Declaration

public event EventHandler<DrillEventArgs> GroupIntervalChanged

Event Type

System.EventHandler<DrillEventArgs>

ItemIntervalChanged

Occurs when the CurrentItemInterval changes.

Declaration

public event EventHandler<DrillEventArgs> ItemIntervalChanged

Event Type

System.EventHandler<DrillEventArgs>

VisiblePeriodChanged

Occurs when the VisiblePeriodStart or the VisiblePeriodEnd change.

Declaration

public event RadRoutedEventHandler VisiblePeriodChanged

Event Type

RadRoutedEventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)