ClassRadTimeBar
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:
Inherited Members
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 ActualSelectionEndPropertyField Value
DependencyProperty
ActualSelectionStartProperty
Identifies the ActualSelectionStart dependency property.
Declaration
public static readonly DependencyProperty ActualSelectionStartPropertyField Value
DependencyProperty
EnableSparklineVirtualizationProperty
Identifies the EnableSparklineVirtualization dependency property.
Declaration
public static readonly DependencyProperty EnableSparklineVirtualizationPropertyField Value
DependencyProperty
HoveredPeriodChangedEvent
Identifies the HoveredPeriodChanged routed event.
Declaration
public static readonly RoutedEvent HoveredPeriodChangedEventField Value
RoutedEvent
HoveredPeriodProperty
Identifies the HoveredPeriod dependency property.
Declaration
public static readonly DependencyProperty HoveredPeriodPropertyField Value
DependencyProperty
IsSnapToIntervalEnabledProperty
Identifies the IsSnapToIntervalEnabled dependency property.
Declaration
public static readonly DependencyProperty IsSnapToIntervalEnabledPropertyField Value
DependencyProperty
LeftSelectionIndicatorVisibilityProperty
Identifies the LeftSelectionIndicatorVisibility dependency property.
Declaration
public static readonly DependencyProperty LeftSelectionIndicatorVisibilityPropertyField Value
DependencyProperty
MaxSelectionRangeProperty
Identifies the MaxSelectionRange dependency property.
Declaration
public static readonly DependencyProperty MaxSelectionRangePropertyField Value
DependencyProperty
MinSelectionRangeProperty
Identifies the MinSelectionRange dependency property.
Declaration
public static readonly DependencyProperty MinSelectionRangePropertyField Value
DependencyProperty
RightSelectionIndicatorVisibilityProperty
Identifies the RightSelectionIndicatorVisibility dependency property.
Declaration
public static readonly DependencyProperty RightSelectionIndicatorVisibilityPropertyField Value
DependencyProperty
SelectionChangedEvent
Identifies the SelectionChanged routed event.
Declaration
public static readonly RoutedEvent SelectionChangedEventField Value
RoutedEvent
SelectionEndProperty
Identifies the SelectionEnd dependency property.
Declaration
public static readonly DependencyProperty SelectionEndPropertyField Value
DependencyProperty
SelectionProperty
Identifies the Selection dependency property.
Declaration
public static readonly DependencyProperty SelectionPropertyField Value
DependencyProperty
SelectionStartProperty
Identifies the SelectionStart dependency property.
Declaration
public static readonly DependencyProperty SelectionStartPropertyField Value
DependencyProperty
SelectionThumbStyleProperty
Identifies the SelectionThumbStyle dependency property.
Declaration
public static readonly DependencyProperty SelectionThumbStylePropertyField Value
DependencyProperty
SelectionTitleFormatStringProperty
Identifies the SelectionTitleFormatString dependency property.
Declaration
public static readonly DependencyProperty SelectionTitleFormatStringPropertyField Value
DependencyProperty
SelectionVisibilityIndicatorStyleProperty
Identifies the SelectionVisibilityIndicatorStyle dependency property.
Declaration
public static readonly DependencyProperty SelectionVisibilityIndicatorStylePropertyField Value
DependencyProperty
Properties
ActualSelectionEnd
Gets the actual SelectionEnd.
Declaration
[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
Gets the actual SelectionStart.
Declaration
[Browsable(false)]
public DateTime ActualSelectionStart { get; }Property Value
The actual SelectionStart. 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.
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 DateTime. Data virtualization requires the data for the sparkline to be chronologically sorted.
Declaration
public bool EnableSparklineVirtualization { get; set; }Property Value
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
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
A value that indicates whether snapping to intervals is enabled.
MaxSelectionRange
Gets or sets the maximum possible Selection of the RadTimeBar.
MinSelectionRange
Gets or sets the minimum possible Selection of the RadTimeBar.
Declaration
public TimeSpan MinSelectionRange { get; set; }Property Value
The minimum possible Selection of the RadTimeBar. The default value is Zero
Selection
Gets or sets the selected period in the RadTimeBar.
Declaration
public SelectionRange<DateTime> Selection { get; set; }Property Value
The selected period.
Implements
SelectionEnd
Gets or sets the end of the selected period.
Declaration
[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime SelectionEnd { get; set; }Property Value
The end of the selected period.
Implements
SelectionStart
Gets or sets the start of the selected period.
Declaration
[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime SelectionStart { get; set; }Property Value
The start of the selected period.
Implements
SelectionThumbStyle
Gets or sets the of the SelectionThumb.
Declaration
public Style SelectionThumbStyle { get; set; }Property Value
Style
The of the SelectionThumb.
SelectionTitleFormatString
Gets or sets the format string for the selection title.
Declaration
public string SelectionTitleFormatString { get; set; }Property Value
The format string for the selection title.
SelectionVisibilityIndicatorStyle
Gets or sets the of both SelectionVisibilityIndicators.
Declaration
public Style SelectionVisibilityIndicatorStyle { get; set; }Property Value
Style
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.
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
The type-specific AutomationPeer implementation.
OnHoveredPeriodChanged(SelectionRange<DateTime>?)
Raises the HoveredPeriodChangedEvent. This method is invoked whenever HoveredPeriod changes.
Declaration
protected virtual void OnHoveredPeriodChanged(SelectionRange<DateTime>? hoveredPeriod)Parameters
hoveredPeriod
The new value of HoveredPeriod.
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The 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 ActualSelectionChangedEvent Value
HoveredPeriodChanged
Occurs when the HoveredPeriod changes.
Declaration
public event EventHandler<HoveredPeriodEventArgs> HoveredPeriodChangedEvent Value
SelectionChanged
Occurs when the Selection changes.
Declaration
public event RadRoutedEventHandler SelectionChangedEvent Value
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.