Class SelectionThumb
Allows selection of a time span in the RadTimeBar control. It is positioned according to the SelectionStart and SelectionEnd properties of the RadTimeBar.
Inherited Members
Namespace: Telerik.Windows.Controls.TimeBar
Assembly: Telerik.Windows.Controls.DataVisualization.dll
Syntax
public class SelectionThumb : PeriodSpanControlAdapter, IPeriodSpan, IRangeSelector<DateTime>
Constructors
SelectionThumb()
Fields
IntervalGroupsProperty
Identifies the IntervalGroups dependency property.
Declaration
public static readonly DependencyProperty IntervalGroupsProperty
Field Value
System.Windows.DependencyProperty
|
IntervalItemsProperty
Identifies the IntervalItems dependency property.
Declaration
public static readonly DependencyProperty IntervalItemsProperty
Field Value
System.Windows.DependencyProperty
|
IsSnapToIntervalEnabledProperty
Identifies the IsSnapToIntervalEnabled dependency property.
Declaration
public static readonly DependencyProperty IsSnapToIntervalEnabledProperty
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
|
PeriodEndProperty
Identifies the PeriodEnd dependency property.
Declaration
public static readonly DependencyProperty PeriodEndProperty
Field Value
System.Windows.DependencyProperty
|
PeriodStartProperty
Identifies the PeriodStart dependency property.
Declaration
public static readonly DependencyProperty PeriodStartProperty
Field Value
System.Windows.DependencyProperty
|
ScrollCompletedEvent
Identifies the ScrollCompleted routed event.
Declaration
public static readonly RoutedEvent ScrollCompletedEvent
Field Value
RoutedEvent
|
ScrollStartedEvent
Identifies the ScrollStarted routed event.
Declaration
public static readonly RoutedEvent ScrollStartedEvent
Field Value
RoutedEvent
|
SelectionChangedEvent
Identifies the SelectionChanged routed event.
Declaration
public static readonly RoutedEvent SelectionChangedEvent
Field Value
RoutedEvent
|
SelectionEndProperty
Identifies the SelectionEnd dependency property.
Declaration
public static readonly DependencyProperty SelectionEndProperty
Field Value
System.Windows.DependencyProperty
|
SelectionPreviewControlProperty
Identifies the SelectionPreviewControl dependency property.
Declaration
public static readonly DependencyProperty SelectionPreviewControlProperty
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
|
TitleFormatStringProperty
Identifies the TitleFormatString dependency property.
Declaration
public static readonly DependencyProperty TitleFormatStringProperty
Field Value
System.Windows.DependencyProperty
|
TitleProperty
Identifies the Title dependency property.
Declaration
public static readonly DependencyProperty TitleProperty
Field Value
System.Windows.DependencyProperty
|
VisiblePeriodRangeProperty
Identifies the VisiblePeriodRange dependency property.
Declaration
public static readonly DependencyProperty VisiblePeriodRangeProperty
Field Value
System.Windows.DependencyProperty
|
Properties
IntervalGroups
Gets or sets a collection of PeriodSpans used to generate the group period items.
Declaration
public IEnumerable<PeriodSpan> IntervalGroups { get; set; }
Property Value
System.Collections.Generic.IEnumerable<PeriodSpan>
A collection of PeriodSpans used to generate the group period items. |
Remarks
This property is for internal use only.
IntervalItems
Gets or sets a collection of PeriodSpans used to generate the period items.
Declaration
public IEnumerable<PeriodSpan> IntervalItems { get; set; }
Property Value
System.Collections.Generic.IEnumerable<PeriodSpan>
A collection of PeriodSpans used to generate the period items. |
Remarks
This property is for internal use only.
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. |
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 |
PeriodEnd
Gets or sets the end of the period that the RadTimeBar control visualizes. The PeriodEnd value itself is excluded from the period.
Declaration
public DateTime PeriodEnd { get; set; }
Property Value
System.DateTime
The end of the period that the control visualizes. |
Remarks
The PeriodStart value must be less than or equal to the value of PeriodEnd.
PeriodStart
Gets or sets the start of the period that the RadTimeBar control visualizes.
Declaration
public DateTime PeriodStart { get; set; }
Property Value
System.DateTime
The start of the period that the control visualizes. |
Remarks
The PeriodStart value must be less than or equal to the value of PeriodEnd.
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
SelectionPreviewControl
Gets or sets the SelectionThumbPreview control.
Declaration
public SelectionThumbPreview SelectionPreviewControl { get; set; }
Property Value
SelectionThumbPreview
The SelectionThumbPreview control. |
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
Title
Gets the title of the selection.
Declaration
public string Title { get; }
Property Value
System.String
The title of the selection. |
TitleFormatString
Gets or sets the format string for the selection title.
Declaration
public string TitleFormatString { get; set; }
Property Value
System.String
The format string for the selection title. |
VisiblePeriodRange
Gets or sets the visible period range.
Declaration
public SelectionRange<DateTime> VisiblePeriodRange { get; set; }
Property Value
SelectionRange<System.DateTime>
The visible period range. |
Methods
add_ScrollCompleted(RadRoutedEventHandler)
Declaration
public void add_ScrollCompleted(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
add_ScrollStarted(RadRoutedEventHandler)
Declaration
public void add_ScrollStarted(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
add_SelectionChanged(RadRoutedEventHandler)
Declaration
public void add_SelectionChanged(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
Implements
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
OnCenterHandleDragCompleted(Object, DragCompletedEventArgs)
Called when the center selection System.Windows.Controls.Primitives.Thumb control loses mouse capture.
Declaration
protected void OnCenterHandleDragCompleted(object sender, DragCompletedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragCompletedEventArgs
e
The System.Windows.Controls.Primitives.DragCompletedEventArgs instance containing the event data. |
OnCenterHandleDragDelta(Object, DragDeltaEventArgs)
Called one or more times as the mouse changes position when the center selection System.Windows.Controls.Primitives.Thumb has logical focus and mouse capture.
Declaration
protected virtual void OnCenterHandleDragDelta(object sender, DragDeltaEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragDeltaEventArgs
e
The System.Windows.Controls.Primitives.DragDeltaEventArgs instance containing the event data. |
OnCenterHandleDragStarted(Object, DragStartedEventArgs)
Called when the center selection System.Windows.Controls.Primitives.Thumb receives logical focus and mouse capture.
Declaration
protected void OnCenterHandleDragStarted(object sender, DragStartedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragStartedEventArgs
e
The System.Windows.Controls.Primitives.DragStartedEventArgs instance containing the event data. |
OnIntervalChanged()
OnLeftHandleDragCompleted(Object, DragCompletedEventArgs)
Called when the left selection System.Windows.Controls.Primitives.Thumb control loses mouse capture.
Declaration
protected void OnLeftHandleDragCompleted(object sender, DragCompletedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragCompletedEventArgs
e
The System.Windows.Controls.Primitives.DragCompletedEventArgs instance containing the event data. |
OnLeftHandleDragDelta(Object, DragDeltaEventArgs)
Called one or more times as the mouse changes position when the left selection System.Windows.Controls.Primitives.Thumb has logical focus and mouse capture.
Declaration
protected virtual void OnLeftHandleDragDelta(object sender, DragDeltaEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragDeltaEventArgs
e
The System.Windows.Controls.Primitives.DragDeltaEventArgs instance containing the event data. |
OnLeftHandleDragStarted(Object, DragStartedEventArgs)
Called when the left selection System.Windows.Controls.Primitives.Thumb receives logical focus and mouse capture.
Declaration
protected void OnLeftHandleDragStarted(object sender, DragStartedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragStartedEventArgs
e
The System.Windows.Controls.Primitives.DragStartedEventArgs instance containing the event data. |
OnMouseLeave(MouseEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs
e
The System.Windows.Input.MouseEventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs
e
The System.Windows.Input.MouseEventArgs that contains the event data. |
OnRightHandleDragCompleted(Object, DragCompletedEventArgs)
Called when the right selection System.Windows.Controls.Primitives.Thumb control loses mouse capture.
Declaration
protected void OnRightHandleDragCompleted(object sender, DragCompletedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragCompletedEventArgs
e
The System.Windows.Controls.Primitives.DragCompletedEventArgs instance containing the event data. |
OnRightHandleDragDelta(Object, DragDeltaEventArgs)
Called one or more times as the mouse changes position when the center selection System.Windows.Controls.Primitives.Thumb has logical focus and mouse capture.
Declaration
protected virtual void OnRightHandleDragDelta(object sender, DragDeltaEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragDeltaEventArgs
e
The System.Windows.Controls.Primitives.DragDeltaEventArgs instance containing the event data. |
OnRightHandleDragStarted(Object, DragStartedEventArgs)
Called when the right selection System.Windows.Controls.Primitives.Thumb receives logical focus and mouse capture.
Declaration
protected void OnRightHandleDragStarted(object sender, DragStartedEventArgs e)
Parameters
System.Object
sender
The sender. |
System.Windows.Controls.Primitives.DragStartedEventArgs
e
The System.Windows.Controls.Primitives.DragStartedEventArgs instance containing the event data. |
OnScrollCompleted()
OnScrollStarted()
OnSelectionChanged()
remove_ScrollCompleted(RadRoutedEventHandler)
Declaration
public void remove_ScrollCompleted(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
remove_ScrollStarted(RadRoutedEventHandler)
Declaration
public void remove_ScrollStarted(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
remove_SelectionChanged(RadRoutedEventHandler)
Declaration
public void remove_SelectionChanged(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
Implements
Events
ScrollCompleted
Occurs when the SelectionThumb stops moving.
Declaration
public event RadRoutedEventHandler ScrollCompleted
Event Type
RadRoutedEventHandler
|
ScrollStarted
Occurs when the SelectionThumb starts moving.
Declaration
public event RadRoutedEventHandler ScrollStarted
Event Type
RadRoutedEventHandler
|
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.