ClassTimeBarBase
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, ISupportInitializeInheritance: objectTimeBarBase
Derived Classes:
Implements:
Constructors
TimeBarBase()
Initializes a new instance of the TimeBarBase class.
Declaration
protected TimeBarBase()Fields
ActualMinZoomRangeProperty
Identifies the ActualMinZoomRange dependency property.
Declaration
public static readonly DependencyProperty ActualMinZoomRangePropertyField Value
DependencyProperty
ActualVisiblePeriodRangeProperty
Identifies the ActualVisiblePeriodRange dependency property.
Declaration
public static readonly DependencyProperty ActualVisiblePeriodRangePropertyField Value
DependencyProperty
CurrentGroupIntervalProperty
Identifies the CurrentGroupInterval dependency property.
Declaration
public static readonly DependencyProperty CurrentGroupIntervalPropertyField Value
DependencyProperty
CurrentItemIntervalProperty
Identifies the CurrentItemInterval dependency property.
Declaration
public static readonly DependencyProperty CurrentItemIntervalPropertyField Value
DependencyProperty
GroupIntervalChangedEvent
Identifies the GroupIntervalChanged routed event.
Declaration
public static readonly RoutedEvent GroupIntervalChangedEventField Value
RoutedEvent
GroupPeriodHeaderStyleProperty
Identifies the GroupPeriodHeaderStyle dependency property.
Declaration
public static readonly DependencyProperty GroupPeriodHeaderStylePropertyField Value
DependencyProperty
IntervalGroupsProperty
Identifies the IntervalGroups dependency property.
Declaration
public static readonly DependencyProperty IntervalGroupsPropertyField Value
DependencyProperty
IntervalItemsProperty
Identifies the IntervalItems dependency property.
Declaration
public static readonly DependencyProperty IntervalItemsPropertyField Value
DependencyProperty
IntervalsProperty
Identifies the Intervals dependency property.
Declaration
public static readonly DependencyProperty IntervalsPropertyField Value
DependencyProperty
ItemIntervalChangedEvent
Identifies the ItemIntervalChanged routed event.
Declaration
public static readonly RoutedEvent ItemIntervalChangedEventField Value
RoutedEvent
LargeChangeProperty
Identifies the LargeChange dependency property.
Declaration
public static readonly DependencyProperty LargeChangePropertyField Value
DependencyProperty
MaxZoomRangeProperty
Identifies the MaxZoomRange dependency property.
Declaration
public static readonly DependencyProperty MaxZoomRangePropertyField Value
DependencyProperty
MinZoomRangeProperty
Identifies the MinZoomRange dependency property.
Declaration
public static readonly DependencyProperty MinZoomRangePropertyField Value
DependencyProperty
PeriodEndProperty
Identifies the PeriodEnd dependency property.
Declaration
public static readonly DependencyProperty PeriodEndPropertyField Value
DependencyProperty
PeriodHeaderStyleProperty
Identifies the PeriodHeaderStyle dependency property.
Declaration
public static readonly DependencyProperty PeriodHeaderStylePropertyField Value
DependencyProperty
PeriodStartProperty
Identifies the PeriodStart dependency property.
Declaration
public static readonly DependencyProperty PeriodStartPropertyField Value
DependencyProperty
ScrollModeProperty
Identifies the ScrollMode dependency property.
Declaration
public static readonly DependencyProperty ScrollModePropertyField Value
DependencyProperty
SliderStyleProperty
Identifies the SliderStyle dependency property.
Declaration
public static readonly DependencyProperty SliderStylePropertyField Value
DependencyProperty
SmallChangeProperty
Identifies the SmallChange dependency property.
Declaration
public static readonly DependencyProperty SmallChangePropertyField Value
DependencyProperty
SpecialSlotsGeneratorProperty
Identifies the SpecialSlotsGenerator dependency property.
Declaration
public static readonly DependencyProperty SpecialSlotsGeneratorPropertyField Value
DependencyProperty
SpecialSlotsProperty
Identifies the SpecialSlots dependency property.
Declaration
public static readonly DependencyProperty SpecialSlotsPropertyField Value
DependencyProperty
VisiblePeriodChangedEvent
Identifies the VisiblePeriodChanged routed event.
Declaration
public static readonly RoutedEvent VisiblePeriodChangedEventField Value
RoutedEvent
VisiblePeriodEndProperty
Identifies the VisiblePeriodEnd dependency property.
Declaration
public static readonly DependencyProperty VisiblePeriodEndPropertyField Value
DependencyProperty
VisiblePeriodProperty
Identifies the VisiblePeriod dependency property.
Declaration
public static readonly DependencyProperty VisiblePeriodPropertyField Value
DependencyProperty
VisiblePeriodStartProperty
Identifies the VisiblePeriodStart dependency property.
Declaration
public static readonly DependencyProperty VisiblePeriodStartPropertyField Value
DependencyProperty
Properties
ActualVisiblePeriodRange
Gets the actual visible period range.
Declaration
[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
Gets the current group interval.
Declaration
public IntervalBase CurrentGroupInterval { get; }Property Value
The current group interval.
CurrentItemInterval
Gets the current item interval.
Declaration
public IntervalBase CurrentItemInterval { get; }Property Value
The current item interval.
GroupPeriodHeaderStyle
Gets or sets the HeaderStyle for every group period item.
Declaration
public Style GroupPeriodHeaderStyle { get; set; }Property Value
Style
The HeaderStyle for every group period item.
Intervals
Gets a collection of intervals used by the control.
Declaration
public IntervalCollection Intervals { get; }Property Value
A collection of intervals used by the control.
MaxZoomRange
Gets or sets the maximum TimeSpan that the control can zoom out to.
Declaration
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
Gets or sets the minimum TimeSpan that the control can zoom in to.
Declaration
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
Gets or sets the end of the period that the control visualizes. The PeriodEnd value itself is excluded from the period.
Declaration
[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
Gets or sets the HeaderStyle for every period item.
Declaration
public Style PeriodHeaderStyle { get; set; }Property Value
Style
The HeaderStyle for every period item.
PeriodStart
Gets or sets the start of the period that the control visualizes.
Declaration
[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.
Declaration
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
Gets or sets the of the RadSlider.
Declaration
public Style SliderStyle { get; set; }Property Value
Style
The of the RadSlider.
SpecialSlotsGenerator
Gets or sets an ITimeRangeGenerator instance that generates special IPeriodSpan slots for the current VisiblePeriod.
Declaration
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
Gets or sets the visible period.
Declaration
public SelectionRange<DateTime> VisiblePeriod { get; set; }Property Value
The visible period.
VisiblePeriodEnd
Gets or sets the end of the visible period.
Declaration
[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
Gets or sets the start of the visible period.
Declaration
[TypeConverter(typeof(DateTimeTypeConverter))]
public DateTime VisiblePeriodStart { get; set; }Property Value
The start 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.
Methods
ConvertPointToDateTime(Point)
Converts a point inside the control to a DateTime value relative to the timeline.
Declaration
public DateTime ConvertPointToDateTime(Point coordinates)Parameters
coordinates
Point
Position inside the control.
Returns
The DateTime value relative to the timeline.
EndInit()
Indicates that the initialization process for the element is complete.
Declaration
public override void EndInit()Exceptions
was called without having previously been called on the element.
Implements
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call .
Declaration
public override void OnApplyTemplate()OnGroupIntervalChanged(IntervalBase, IntervalBase)
Called when the CurrentGroupInterval changes.
Declaration
protected virtual void OnGroupIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)Parameters
oldInterval
The old interval.
newInterval
The new interval.
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.
OnItemIntervalChanged(IntervalBase, IntervalBase)
Called when the CurrentItemInterval changes.
Declaration
protected virtual void OnItemIntervalChanged(IntervalBase oldInterval, IntervalBase newInterval)Parameters
oldInterval
The old interval.
newInterval
The new interval.
OnMouseWheel(MouseWheelEventArgs)
Raises the event.
Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)Parameters
e
MouseWheelEventArgs
The MouseWheelEventArgs instance containing the event data.
OnSliderSelectionChanged(object, RadRoutedEventArgs)
Declaration
protected virtual void OnSliderSelectionChanged(object sender, RadRoutedEventArgs e)Parameters
sender
The RadSlider instance.
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 ICommand with the TimeBarBase type.
Declaration
protected static void RegisterCommand(ICommand command, ExecutedRoutedEventHandler executed, CanExecuteRoutedEventHandler canExecute)Parameters
command
The ICommand to register.
executed
ExecutedRoutedEventHandler
The handler for the event on the new RoutedCommand.
canExecute
CanExecuteRoutedEventHandler
The handler for the event on the new RoutedCommand.
Events
ActualVisiblePeriodRangeChanged
Occurs when the actual visible period range changes.
Declaration
public event EventHandler ActualVisiblePeriodRangeChangedEvent Value
GroupIntervalChanged
Occurs when the CurrentGroupInterval changes.
Declaration
public event EventHandler<DrillEventArgs> GroupIntervalChangedEvent Value
ItemIntervalChanged
Occurs when the CurrentItemInterval changes.
Declaration
public event EventHandler<DrillEventArgs> ItemIntervalChangedEvent Value
VisiblePeriodChanged
Occurs when the VisiblePeriodStart or the VisiblePeriodEnd change.
Declaration
public event RadRoutedEventHandler VisiblePeriodChangedEvent Value