Class RadTimeBar

The RadTimeBar is a time bound DataVisualization control. Its chief purpose is to allow lightweight scrolling and navigation through large periods of time.

Inheritance
System.Object
TimeBarBase
RadTimeBar
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

[TelerikToolboxCategory("Data Visualization")]
public class RadTimeBar : TimeBarBase, ISupportInitialize, IRangeSelector<DateTime>

Constructors

RadTimeBar()

Initializes a new instance of the RadTimeBar class.

Declaration
public RadTimeBar()

Fields

ActualSelectionEndProperty

Identifies the ActualSelectionEnd dependency property.

Declaration
public static readonly DependencyProperty ActualSelectionEndProperty
Field Value
System.Windows.DependencyProperty

ActualSelectionStartProperty

Identifies the ActualSelectionStart dependency property.

Declaration
public static readonly DependencyProperty ActualSelectionStartProperty
Field Value
System.Windows.DependencyProperty

EnableSparklineVirtualizationProperty

Identifies the EnableSparklineVirtualization dependency property.

Declaration
public static readonly DependencyProperty EnableSparklineVirtualizationProperty
Field Value
System.Windows.DependencyProperty

HoveredPeriodChangedEvent

Identifies the HoveredPeriodChanged routed event.

Declaration
public static readonly RoutedEvent HoveredPeriodChangedEvent
Field Value
System.Windows.RoutedEvent

HoveredPeriodProperty

Identifies the HoveredPeriod dependency property.

Declaration
public static readonly DependencyProperty HoveredPeriodProperty
Field Value
System.Windows.DependencyProperty

IsSnapToIntervalEnabledProperty

Identifies the IsSnapToIntervalEnabled dependency property.

Declaration
public static readonly DependencyProperty IsSnapToIntervalEnabledProperty
Field Value
System.Windows.DependencyProperty

LeftSelectionIndicatorVisibilityProperty

Identifies the LeftSelectionIndicatorVisibility dependency property.

Declaration
public static readonly DependencyProperty LeftSelectionIndicatorVisibilityProperty
Field Value
System.Windows.DependencyProperty

MaxSelectionRangeProperty

Identifies the MaxSelectionRange dependency property.

Declaration
public static readonly DependencyProperty MaxSelectionRangeProperty
Field Value
System.Windows.DependencyProperty

MinSelectionRangeProperty

Identifies the MinSelectionRange dependency property.

Declaration
public static readonly DependencyProperty MinSelectionRangeProperty
Field Value
System.Windows.DependencyProperty

RightSelectionIndicatorVisibilityProperty

Identifies the RightSelectionIndicatorVisibility dependency property.

Declaration
public static readonly DependencyProperty RightSelectionIndicatorVisibilityProperty
Field Value
System.Windows.DependencyProperty

SelectionChangedEvent

Identifies the SelectionChanged routed event.

Declaration
public static readonly RoutedEvent SelectionChangedEvent
Field Value
System.Windows.RoutedEvent

SelectionEndProperty

Identifies the SelectionEnd dependency property.

Declaration
public static readonly DependencyProperty SelectionEndProperty
Field Value
System.Windows.DependencyProperty

SelectionProperty

Identifies the Selection dependency property.

Declaration
public static readonly DependencyProperty SelectionProperty
Field Value
System.Windows.DependencyProperty

SelectionStartProperty

Identifies the SelectionStart dependency property.

Declaration
public static readonly DependencyProperty SelectionStartProperty
Field Value
System.Windows.DependencyProperty

SelectionThumbStyleProperty

Identifies the SelectionThumbStyle dependency property.

Declaration
public static readonly DependencyProperty SelectionThumbStyleProperty
Field Value
System.Windows.DependencyProperty

SelectionTitleFormatStringProperty

Identifies the SelectionTitleFormatString dependency property.

Declaration
public static readonly DependencyProperty SelectionTitleFormatStringProperty
Field Value
System.Windows.DependencyProperty

SelectionVisibilityIndicatorStyleProperty

Identifies the SelectionVisibilityIndicatorStyle dependency property.

Declaration
public static readonly DependencyProperty SelectionVisibilityIndicatorStyleProperty
Field Value
System.Windows.DependencyProperty

Properties

ActualSelectionEnd

Gets the actual SelectionEnd.

Declaration
public DateTime ActualSelectionEnd { get; }
Property Value
System.DateTime

The actual SelectionEnd. The default value is System.DateTime.MinValue.
Remarks

When the user is dragging one of the selection thumbs, the SelectionStart and SelectionEnd properties are updated once the user releases the selection thumb. On the other hand, the ActualSelectionStart and ActualSelectionEnd properties are updated while the selection thumbs are moving.

ActualSelectionStart

Gets the actual SelectionStart.

Declaration
public DateTime ActualSelectionStart { get; }
Property Value
System.DateTime

The actual SelectionStart. The default value is System.DateTime.MinValue.
Remarks

When the user is dragging one of the selection thumbs, the SelectionStart and SelectionEnd properties are updated once the user releases the selection thumb. On the other hand, the ActualSelectionStart and ActualSelectionEnd properties are updated while the selection thumbs are moving.

EnableSparklineVirtualization

Gets or sets a value indicating whether data virtualization is enabled for the child sparkline, provided the RadTimeBar has a single sparkline child and that child sparkline has data points with values on the x-axis of type System.DateTime. Data virtualization requires the data for the sparkline to be chronologically sorted.

Declaration
public bool EnableSparklineVirtualization { get; set; }
Property Value
System.Boolean

A value that indicates whether data virtualization is enabled for the child sparkline.

HoveredPeriod

Gets the hovered period in the RadTimeBar.

Declaration
public SelectionRange<DateTime>? HoveredPeriod { get; }
Property Value
System.Nullable<SelectionRange<System.DateTime>>

The hovered period. The default value is null.

IsSnapToIntervalEnabled

Gets or sets a value that indicates whether snapping to intervals is enabled.

Declaration
public bool IsSnapToIntervalEnabled { get; set; }
Property Value
System.Boolean

A value that indicates whether snapping to intervals is enabled.

LeftSelectionIndicatorVisibility

Gets the System.Windows.UIElement.Visibility of the left SelectionVisibilityIndicator.

Declaration
public Visibility LeftSelectionIndicatorVisibility { get; }
Property Value
System.Windows.Visibility

The System.Windows.UIElement.Visibility of the left SelectionVisibilityIndicator.

MaxSelectionRange

Gets or sets the maximum possible Selection of the RadTimeBar.

Declaration
public TimeSpan MaxSelectionRange { get; set; }
Property Value
System.TimeSpan

The maximum possible Selection of the RadTimeBar. The default value is System.TimeSpan.Zero
Remarks

The System.TimeSpan.Zero value indicates that there is no maximum Selection constraint.

MinSelectionRange

Gets or sets the minimum possible Selection of the RadTimeBar.

Declaration
public TimeSpan MinSelectionRange { get; set; }
Property Value
System.TimeSpan

The minimum possible Selection of the RadTimeBar. The default value is System.TimeSpan.Zero

RightSelectionIndicatorVisibility

Gets the System.Windows.UIElement.Visibility of the right SelectionVisibilityIndicator.

Declaration
public Visibility RightSelectionIndicatorVisibility { get; }
Property Value
System.Windows.Visibility

The System.Windows.UIElement.Visibility of the right SelectionVisibilityIndicator.

Selection

Gets or sets the selected period in the RadTimeBar.

Declaration
public SelectionRange<DateTime> Selection { get; set; }
Property Value
SelectionRange<System.DateTime>

The selected period.
Implements

SelectionEnd

Gets or sets the end of the selected period.

Declaration
public DateTime SelectionEnd { get; set; }
Property Value
System.DateTime

The end of the selected period.
Implements

SelectionStart

Gets or sets the start of the selected period.

Declaration
public DateTime SelectionStart { get; set; }
Property Value
System.DateTime

The start of the selected period.
Implements

SelectionThumbStyle

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

Declaration
public Style SelectionThumbStyle { get; set; }
Property Value
System.Windows.Style

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

SelectionTitleFormatString

Gets or sets the format string for the selection title.

Declaration
public string SelectionTitleFormatString { get; set; }
Property Value
System.String

The format string for the selection title.

SelectionVisibilityIndicatorStyle

Gets or sets the System.Windows.FrameworkElement.Style of both SelectionVisibilityIndicators.

Declaration
public Style SelectionVisibilityIndicatorStyle { get; set; }
Property Value
System.Windows.Style

The System.Windows.FrameworkElement.Style of both SelectionVisibilityIndicators.
Remarks

The SelectionVisibilityIndicatorStyle is applied both to the right and left SelectionVisibilityIndicators. However, by default, the left SelectionVisibilityIndicator is rotated by an angle of 180 degrees about its center point.

Methods

OnContentChanged(Object, Object)

Called when the System.Windows.Controls.ContentControl.Content property changes.

Declaration
protected override void OnContentChanged(object oldContent, object newContent)
Parameters
System.Object oldContent

The old value of the System.Windows.Controls.ContentControl.Content property.
System.Object newContent

The new value of the System.Windows.Controls.ContentControl.Content property.

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnHoveredPeriodChanged(Nullable<SelectionRange<DateTime>>)

Raises the HoveredPeriodChangedEvent. This method is invoked whenever HoveredPeriod changes.

Declaration
protected virtual void OnHoveredPeriodChanged(SelectionRange<DateTime>? hoveredPeriod)
Parameters
System.Nullable<SelectionRange<System.DateTime>> hoveredPeriod

The new value of HoveredPeriod.

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

OnSelectionChanged()

Raises the SelectionChangedEvent. This method is invoked whenever Selection changes.

Declaration
protected virtual void OnSelectionChanged()

Events

ActualSelectionChanged

Occurs when the ActualSelectionStart or the ActualSelectionEnd change.

Declaration
public event EventHandler ActualSelectionChanged
Event Type
System.EventHandler

HoveredPeriodChanged

Occurs when the HoveredPeriod changes.

Declaration
public event EventHandler<HoveredPeriodEventArgs> HoveredPeriodChanged
Event Type
System.EventHandler<HoveredPeriodEventArgs>

SelectionChanged

Occurs when the Selection changes.

Declaration
public event RadRoutedEventHandler SelectionChanged
Event Type
RadRoutedEventHandler

Implements
Remarks

This event occurs whenever there is a change to the selection. The selection can be changed not only by user interaction but also by binding as well as other set values.

Extension Methods