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

RadTimeBar

Class

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

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

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

Inheritance: objectTimeBarBaseRadTimeBar

Implements: IRangeSelector<DateTime>ISupportInitialize

Constructors

RadTimeBar()

Initializes a new instance of the RadTimeBar class.

public RadTimeBar()

Fields

ActualSelectionEndProperty

DependencyProperty

Identifies the ActualSelectionEnd dependency property.

public static readonly DependencyProperty ActualSelectionEndProperty

ActualSelectionStartProperty

DependencyProperty

Identifies the ActualSelectionStart dependency property.

public static readonly DependencyProperty ActualSelectionStartProperty

EnableSparklineVirtualizationProperty

DependencyProperty

Identifies the EnableSparklineVirtualization dependency property.

public static readonly DependencyProperty EnableSparklineVirtualizationProperty

HoveredPeriodChangedEvent

RoutedEvent

Identifies the HoveredPeriodChanged routed event.

public static readonly RoutedEvent HoveredPeriodChangedEvent

HoveredPeriodProperty

DependencyProperty

Identifies the HoveredPeriod dependency property.

public static readonly DependencyProperty HoveredPeriodProperty

IsSnapToIntervalEnabledProperty

DependencyProperty

Identifies the IsSnapToIntervalEnabled dependency property.

public static readonly DependencyProperty IsSnapToIntervalEnabledProperty

LeftSelectionIndicatorVisibilityProperty

DependencyProperty

Identifies the LeftSelectionIndicatorVisibility dependency property.

public static readonly DependencyProperty LeftSelectionIndicatorVisibilityProperty

MaxSelectionRangeProperty

DependencyProperty

Identifies the MaxSelectionRange dependency property.

public static readonly DependencyProperty MaxSelectionRangeProperty

MinSelectionRangeProperty

DependencyProperty

Identifies the MinSelectionRange dependency property.

public static readonly DependencyProperty MinSelectionRangeProperty

RightSelectionIndicatorVisibilityProperty

DependencyProperty

Identifies the RightSelectionIndicatorVisibility dependency property.

public static readonly DependencyProperty RightSelectionIndicatorVisibilityProperty

SelectionChangedEvent

RoutedEvent

Identifies the SelectionChanged routed event.

public static readonly RoutedEvent SelectionChangedEvent

SelectionEndProperty

DependencyProperty

Identifies the SelectionEnd dependency property.

public static readonly DependencyProperty SelectionEndProperty

SelectionProperty

DependencyProperty

Identifies the Selection dependency property.

public static readonly DependencyProperty SelectionProperty

SelectionStartProperty

DependencyProperty

Identifies the SelectionStart dependency property.

public static readonly DependencyProperty SelectionStartProperty

SelectionThumbStyleProperty

DependencyProperty

Identifies the SelectionThumbStyle dependency property.

public static readonly DependencyProperty SelectionThumbStyleProperty

SelectionTitleFormatStringProperty

DependencyProperty

Identifies the SelectionTitleFormatString dependency property.

public static readonly DependencyProperty SelectionTitleFormatStringProperty

SelectionVisibilityIndicatorStyleProperty

DependencyProperty

Identifies the SelectionVisibilityIndicatorStyle dependency property.

public static readonly DependencyProperty SelectionVisibilityIndicatorStyleProperty

Properties

ActualSelectionEnd

DateTime

Gets the actual SelectionEnd.

[Browsable(false)]
public DateTime ActualSelectionEnd { get; }

Property Value:

The actual SelectionEnd. The default value is 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

DateTime

Gets the actual SelectionStart.

[Browsable(false)]
public DateTime ActualSelectionStart { get; }

Property Value:

The actual SelectionStart. The default value is MinValue.

Remarks:

EnableSparklineVirtualization

bool

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 DateTime. Data virtualization requires the data for the sparkline to be chronologically sorted.

public bool EnableSparklineVirtualization { get; set; }

Property Value:

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

HoveredPeriod

SelectionRange<DateTime>?

Gets the hovered period in the RadTimeBar.

public SelectionRange<DateTime>? HoveredPeriod { get; }

Property Value:

The hovered period. The default value is null.

IsSnapToIntervalEnabled

bool

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

public bool IsSnapToIntervalEnabled { get; set; }

Property Value:

A value that indicates whether snapping to intervals is enabled.

MaxSelectionRange

TimeSpan

Gets or sets the maximum possible Selection of the RadTimeBar.

public TimeSpan MaxSelectionRange { get; set; }

Property Value:

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

Remarks:

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

MinSelectionRange

TimeSpan

Gets or sets the minimum possible Selection of the RadTimeBar.

public TimeSpan MinSelectionRange { get; set; }

Property Value:

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

Selection

SelectionRange<DateTime>

Gets or sets the selected period in the RadTimeBar.

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

Property Value:

The selected period.

Implements: IRangeSelector<DateTime>.Selection

SelectionEnd

DateTime

Gets or sets the end of the selected period.

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

Property Value:

The end of the selected period.

Implements: IRangeSelector<DateTime>.SelectionEnd

SelectionStart

DateTime

Gets or sets the start of the selected period.

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

Property Value:

The start of the selected period.

Implements: IRangeSelector<DateTime>.SelectionStart

SelectionThumbStyle

Style

Gets or sets the of the SelectionThumb.

public Style SelectionThumbStyle { get; set; }

Property Value:

The of the SelectionThumb.

SelectionTitleFormatString

string

Gets or sets the format string for the selection title.

public string SelectionTitleFormatString { get; set; }

Property Value:

The format string for the selection title.

SelectionVisibilityIndicatorStyle

Style

Gets or sets the of both SelectionVisibilityIndicators.

public Style SelectionVisibilityIndicatorStyle { get; set; }

Property Value:

The 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 property changes.

protected override void OnContentChanged(object oldContent, object newContent)

Parameters:oldContentobject

The old value of the property.

newContentobject

The new value of the property.

OnCreateAutomationPeer()

AutomationPeer

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

protected override AutomationPeer OnCreateAutomationPeer()

Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

OnHoveredPeriodChanged(SelectionRange<DateTime>?)

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

protected virtual void OnHoveredPeriodChanged(SelectionRange<DateTime>? hoveredPeriod)

Parameters:hoveredPeriodSelectionRange<DateTime>?

The new value of HoveredPeriod.

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.

Overrides: TimeBarBase.OnInitialized(EventArgs)

OnSelectionChanged()

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

protected virtual void OnSelectionChanged()

Events

ActualSelectionChanged

EventHandler

Occurs when the ActualSelectionStart or the ActualSelectionEnd change.

public event EventHandler ActualSelectionChanged

HoveredPeriodChanged

EventHandler<HoveredPeriodEventArgs>

Occurs when the HoveredPeriod changes.

public event EventHandler<HoveredPeriodEventArgs> HoveredPeriodChanged

SelectionChanged

RadRoutedEventHandler

Occurs when the Selection changes.

public event RadRoutedEventHandler SelectionChanged

Implements: IRangeSelector<DateTime>.SelectionChanged

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.