New to Telerik UI for WPF? Start a free 30-day trial

TimeBarBase

Class

A base class for RadTimeBar and RadTimeline.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

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

Inheritance: objectTimeBarBase

Derived Classes: RadTimeBarRadTimeline

Implements: ISupportInitialize

Constructors

TimeBarBase()

Initializes a new instance of the TimeBarBase class.

protected TimeBarBase()

Fields

ActualMinZoomRangeProperty

DependencyProperty

Identifies the ActualMinZoomRange dependency property.

public static readonly DependencyProperty ActualMinZoomRangeProperty

ActualVisiblePeriodRangeProperty

DependencyProperty

Identifies the ActualVisiblePeriodRange dependency property.

public static readonly DependencyProperty ActualVisiblePeriodRangeProperty

CurrentGroupIntervalProperty

DependencyProperty

Identifies the CurrentGroupInterval dependency property.

public static readonly DependencyProperty CurrentGroupIntervalProperty

CurrentItemIntervalProperty

DependencyProperty

Identifies the CurrentItemInterval dependency property.

public static readonly DependencyProperty CurrentItemIntervalProperty

GroupIntervalChangedEvent

RoutedEvent

Identifies the GroupIntervalChanged routed event.

public static readonly RoutedEvent GroupIntervalChangedEvent

GroupPeriodHeaderStyleProperty

DependencyProperty

Identifies the GroupPeriodHeaderStyle dependency property.

public static readonly DependencyProperty GroupPeriodHeaderStyleProperty

IntervalGroupsProperty

DependencyProperty

Identifies the IntervalGroups dependency property.

public static readonly DependencyProperty IntervalGroupsProperty

IntervalItemsProperty

DependencyProperty

Identifies the IntervalItems dependency property.

public static readonly DependencyProperty IntervalItemsProperty

IntervalsProperty

DependencyProperty

Identifies the Intervals dependency property.

public static readonly DependencyProperty IntervalsProperty

ItemIntervalChangedEvent

RoutedEvent

Identifies the ItemIntervalChanged routed event.

public static readonly RoutedEvent ItemIntervalChangedEvent

LargeChangeProperty

DependencyProperty

Identifies the LargeChange dependency property.

public static readonly DependencyProperty LargeChangeProperty

MaxZoomRangeProperty

DependencyProperty

Identifies the MaxZoomRange dependency property.

public static readonly DependencyProperty MaxZoomRangeProperty

MinZoomRangeProperty

DependencyProperty

Identifies the MinZoomRange dependency property.

public static readonly DependencyProperty MinZoomRangeProperty

PeriodEndProperty

DependencyProperty

Identifies the PeriodEnd dependency property.

public static readonly DependencyProperty PeriodEndProperty

PeriodHeaderStyleProperty

DependencyProperty

Identifies the PeriodHeaderStyle dependency property.

public static readonly DependencyProperty PeriodHeaderStyleProperty

PeriodStartProperty

DependencyProperty

Identifies the PeriodStart dependency property.

public static readonly DependencyProperty PeriodStartProperty

ScrollModeProperty

DependencyProperty

Identifies the ScrollMode dependency property.

public static readonly DependencyProperty ScrollModeProperty

SliderStyleProperty

DependencyProperty

Identifies the SliderStyle dependency property.

public static readonly DependencyProperty SliderStyleProperty

SmallChangeProperty

DependencyProperty

Identifies the SmallChange dependency property.

public static readonly DependencyProperty SmallChangeProperty

SpecialSlotsGeneratorProperty

DependencyProperty

Identifies the SpecialSlotsGenerator dependency property.

public static readonly DependencyProperty SpecialSlotsGeneratorProperty

SpecialSlotsProperty

DependencyProperty

Identifies the SpecialSlots dependency property.

public static readonly DependencyProperty SpecialSlotsProperty

VisiblePeriodChangedEvent

RoutedEvent

Identifies the VisiblePeriodChanged routed event.

public static readonly RoutedEvent VisiblePeriodChangedEvent

VisiblePeriodEndProperty

DependencyProperty

Identifies the VisiblePeriodEnd dependency property.

public static readonly DependencyProperty VisiblePeriodEndProperty

VisiblePeriodProperty

DependencyProperty

Identifies the VisiblePeriod dependency property.

public static readonly DependencyProperty VisiblePeriodProperty

VisiblePeriodStartProperty

DependencyProperty

Identifies the VisiblePeriodStart dependency property.

public static readonly DependencyProperty VisiblePeriodStartProperty

Properties

ActualVisiblePeriodRange

SelectionRange<DateTime>

Gets the actual visible period range.

[Browsable(false)]
public SelectionRange<DateTime> ActualVisiblePeriodRange { get; }

Property Value:

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

IntervalBase

Gets the current group interval.

public IntervalBase CurrentGroupInterval { get; }

Property Value:

The current group interval.

CurrentItemInterval

IntervalBase

Gets the current item interval.

public IntervalBase CurrentItemInterval { get; }

Property Value:

The current item interval.

GroupPeriodHeaderStyle

Style

Gets or sets the HeaderStyle for every group period item.

public Style GroupPeriodHeaderStyle { get; set; }

Property Value:

The HeaderStyle for every group period item.

Intervals

IntervalCollection

Gets a collection of intervals used by the control.

public IntervalCollection Intervals { get; }

Property Value:

A collection of intervals used by the control.

MaxZoomRange

TimeSpan

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

public TimeSpan MaxZoomRange { get; set; }

Property Value:

The maximum TimeSpan that the control can zoom out to.

Remarks:

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

MinZoomRange

TimeSpan

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

public TimeSpan MinZoomRange { get; set; }

Property Value:

The minimum TimeSpan that the control can zoom in to.

Remarks:

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 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.

PeriodEnd

DateTime

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

[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime PeriodEnd { get; set; }

Property Value:

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

Style

Gets or sets the HeaderStyle for every period item.

public Style PeriodHeaderStyle { get; set; }

Property Value:

The HeaderStyle for every period item.

PeriodStart

DateTime

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

[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime PeriodStart { get; set; }

Property Value:

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.

public ScrollMode ScrollMode { get; set; }

Property Value:

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

SliderStyle

Style

Gets or sets the of the RadSlider.

public Style SliderStyle { get; set; }

Property Value:

The of the RadSlider.

SpecialSlotsGenerator

ITimeRangeGenerator

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

public ITimeRangeGenerator SpecialSlotsGenerator { get; set; }

Property Value:

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

VisiblePeriod

SelectionRange<DateTime>

Gets or sets the visible period.

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

Property Value:

The visible period.

VisiblePeriodEnd

DateTime

Gets or sets the end of the visible period.

[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime VisiblePeriodEnd { get; set; }

Property Value:

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

DateTime

Gets or sets the start of the visible period.

[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime VisiblePeriodStart { get; set; }

Property Value:

The start of the visible period.

Remarks:

Methods

ConvertPointToDateTime(Point)

DateTime

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

public DateTime ConvertPointToDateTime(Point coordinates)

Parameters:coordinatesPoint

Position inside the control.

Returns:

DateTime

The DateTime value relative to the timeline.

EndInit()

Indicates that the initialization process for the element is complete.

public override void EndInit()

Exceptions:

InvalidOperationException

was called without having previously been called on the element.

Implements: ISupportInitialize.EndInit()

OnApplyTemplate()

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

public override void OnApplyTemplate()

OnGroupIntervalChanged(IntervalBase, IntervalBase)

Called when the CurrentGroupInterval changes.

protected virtual void OnGroupIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)

Parameters:oldIntervalIntervalBase

The old interval.

newIntervalIntervalBase

The new interval.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnItemIntervalChanged(IntervalBase, IntervalBase)

Called when the CurrentItemInterval changes.

protected virtual void OnItemIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)

Parameters:oldIntervalIntervalBase

The old interval.

newIntervalIntervalBase

The new interval.

OnMouseWheel(MouseWheelEventArgs)

Raises the event.

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters:eMouseWheelEventArgs

The MouseWheelEventArgs instance containing the event data.

OnSliderSelectionChanged(object, RadRoutedEventArgs)

Called when the Selection of the RadSlider changes.

protected virtual void OnSliderSelectionChanged(object sender, RadRoutedEventArgs e)

Parameters:senderobject

The RadSlider instance.

eRadRoutedEventArgs

The RadRoutedEventArgs instance containing the event data.

OnVisiblePeriodChanged()

Called when the VisiblePeriodStart or the VisiblePeriodEnd change.

protected virtual void OnVisiblePeriodChanged()

RegisterCommand(ICommand, ExecutedRoutedEventHandler, CanExecuteRoutedEventHandler)

Registers an ICommand with the TimeBarBase type.

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

Parameters:commandICommand

The ICommand to register.

executedExecutedRoutedEventHandler

The handler for the event on the new RoutedCommand.

canExecuteCanExecuteRoutedEventHandler

The handler for the event on the new RoutedCommand.

Events

ActualVisiblePeriodRangeChanged

EventHandler

Occurs when the actual visible period range changes.

public event EventHandler ActualVisiblePeriodRangeChanged

GroupIntervalChanged

EventHandler<DrillEventArgs>

Occurs when the CurrentGroupInterval changes.

public event EventHandler<DrillEventArgs> GroupIntervalChanged

ItemIntervalChanged

EventHandler<DrillEventArgs>

Occurs when the CurrentItemInterval changes.

public event EventHandler<DrillEventArgs> ItemIntervalChanged

VisiblePeriodChanged

RadRoutedEventHandler

Occurs when the VisiblePeriodStart or the VisiblePeriodEnd change.

public event RadRoutedEventHandler VisiblePeriodChanged