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.

Definition

Namespace:Telerik.Windows.Controls.TimeBar

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

cs-api-definition
public class SelectionThumb : PeriodSpanControlAdapter, IPeriodSpan, IRangeSelector<DateTime>

Inheritance: objectPeriodSpanControlAdapterSelectionThumb

Implements: IPeriodSpanIRangeSelector<DateTime>

Inherited Members PeriodSpanControlAdapter.EndDatePropertyPeriodSpanControlAdapter.StartDatePropertyPeriodSpanControlAdapter.EndDatePeriodSpanControlAdapter.StartDatePeriodSpanControlAdapter.Interval

Constructors

SelectionThumb()

Initializes a new instance of the SelectionThumb class.

Declaration

cs-api-definition
public SelectionThumb()

Fields

IntervalGroupsProperty

Identifies the IntervalGroups dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IntervalGroupsProperty

Field Value

DependencyProperty

IntervalItemsProperty

Identifies the IntervalItems dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IntervalItemsProperty

Field Value

DependencyProperty

IsSnapToIntervalEnabledProperty

Identifies the IsSnapToIntervalEnabled dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSnapToIntervalEnabledProperty

Field Value

DependencyProperty

MaxSelectionRangeProperty

Identifies the MaxSelectionRange dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MaxSelectionRangeProperty

Field Value

DependencyProperty

MinSelectionRangeProperty

Identifies the MinSelectionRange dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MinSelectionRangeProperty

Field Value

DependencyProperty

PeriodEndProperty

Identifies the PeriodEnd dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PeriodEndProperty

Field Value

DependencyProperty

PeriodStartProperty

Identifies the PeriodStart dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PeriodStartProperty

Field Value

DependencyProperty

ScrollCompletedEvent

Identifies the ScrollCompleted routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent ScrollCompletedEvent

Field Value

RoutedEvent

ScrollStartedEvent

Identifies the ScrollStarted routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent ScrollStartedEvent

Field Value

RoutedEvent

SelectionChangedEvent

Identifies the SelectionChanged routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent SelectionChangedEvent

Field Value

RoutedEvent

SelectionEndProperty

Identifies the SelectionEnd dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionEndProperty

Field Value

DependencyProperty

SelectionPreviewControlProperty

Identifies the SelectionPreviewControl dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionPreviewControlProperty

Field Value

DependencyProperty

SelectionProperty

Identifies the Selection dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionProperty

Field Value

DependencyProperty

SelectionStartProperty

Identifies the SelectionStart dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionStartProperty

Field Value

DependencyProperty

TitleFormatStringProperty

Identifies the TitleFormatString dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleFormatStringProperty

Field Value

DependencyProperty

TitleProperty

Identifies the Title dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

VisiblePeriodRangeProperty

Identifies the VisiblePeriodRange dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty VisiblePeriodRangeProperty

Field Value

DependencyProperty

Properties

IntervalGroups

Gets or sets a collection of PeriodSpans used to generate the group period items.

Declaration

cs-api-definition
public IEnumerable<PeriodSpan> IntervalGroups { get; set; }

Property Value

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

cs-api-definition
public IEnumerable<PeriodSpan> IntervalItems { get; set; }

Property Value

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

cs-api-definition
public bool IsSnapToIntervalEnabled { get; set; }

Property Value

bool

A value that indicates whether snapping to intervals is enabled.

MaxSelectionRange

Gets or sets the maximum possible Selection of the RadTimeBar.

Declaration

cs-api-definition
public TimeSpan MaxSelectionRange { get; set; }

Property Value

TimeSpan

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

Gets or sets the minimum possible Selection of the RadTimeBar.

Declaration

cs-api-definition
public TimeSpan MinSelectionRange { get; set; }

Property Value

TimeSpan

The minimum possible Selection of the RadTimeBar. The default value is 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

cs-api-definition
public DateTime PeriodEnd { get; set; }

Property Value

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

cs-api-definition
public DateTime PeriodStart { get; set; }

Property Value

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

cs-api-definition
public SelectionRange<DateTime> Selection { get; set; }

Property Value

SelectionRange<DateTime>

The selected period.

Implements IRangeSelector<DateTime>.Selection

SelectionEnd

Gets or sets the end of the selected period.

Declaration

cs-api-definition
public DateTime SelectionEnd { get; set; }

Property Value

DateTime

The end of the selected period.

Implements IRangeSelector<DateTime>.SelectionEnd

SelectionPreviewControl

Gets or sets the SelectionThumbPreview control.

Declaration

cs-api-definition
public SelectionThumbPreview SelectionPreviewControl { get; set; }

Property Value

SelectionThumbPreview

The SelectionThumbPreview control.

SelectionStart

Gets or sets the start of the selected period.

Declaration

cs-api-definition
public DateTime SelectionStart { get; set; }

Property Value

DateTime

The start of the selected period.

Implements IRangeSelector<DateTime>.SelectionStart

Title

Gets the title of the selection.

Declaration

cs-api-definition
public string Title { get; }

Property Value

string

The title of the selection.

TitleFormatString

Gets or sets the format string for the selection title.

Declaration

cs-api-definition
public string TitleFormatString { get; set; }

Property Value

string

The format string for the selection title.

VisiblePeriodRange

Gets or sets the visible period range.

Declaration

cs-api-definition
public SelectionRange<DateTime> VisiblePeriodRange { get; set; }

Property Value

SelectionRange<DateTime>

The visible period range.

Methods

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call .

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCenterHandleDragCompleted(object, DragCompletedEventArgs)

Called when the center selection control loses mouse capture.

Declaration

cs-api-definition
protected void OnCenterHandleDragCompleted(object sender, DragCompletedEventArgs e)

Parameters

sender

object

The sender.

e

DragCompletedEventArgs

The DragCompletedEventArgs instance containing the event data.

OnCenterHandleDragDelta(object, DragDeltaEventArgs)

Called one or more times as the mouse changes position when the center selection has logical focus and mouse capture.

Declaration

cs-api-definition
protected virtual void OnCenterHandleDragDelta(object sender, DragDeltaEventArgs e)

Parameters

sender

object

The sender.

e

DragDeltaEventArgs

The DragDeltaEventArgs instance containing the event data.

OnCenterHandleDragStarted(object, DragStartedEventArgs)

Called when the center selection receives logical focus and mouse capture.

Declaration

cs-api-definition
protected void OnCenterHandleDragStarted(object sender, DragStartedEventArgs e)

Parameters

sender

object

The sender.

e

DragStartedEventArgs

The DragStartedEventArgs instance containing the event data.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnIntervalChanged()

Called when the Interval changes.

Declaration

cs-api-definition
protected override void OnIntervalChanged()

Overrides PeriodSpanControlAdapter.OnIntervalChanged()

OnLeftHandleDragCompleted(object, DragCompletedEventArgs)

Called when the left selection control loses mouse capture.

Declaration

cs-api-definition
protected void OnLeftHandleDragCompleted(object sender, DragCompletedEventArgs e)

Parameters

sender

object

The sender.

e

DragCompletedEventArgs

The DragCompletedEventArgs instance containing the event data.

OnLeftHandleDragDelta(object, DragDeltaEventArgs)

Called one or more times as the mouse changes position when the left selection has logical focus and mouse capture.

Declaration

cs-api-definition
protected virtual void OnLeftHandleDragDelta(object sender, DragDeltaEventArgs e)

Parameters

sender

object

The sender.

e

DragDeltaEventArgs

The DragDeltaEventArgs instance containing the event data.

OnLeftHandleDragStarted(object, DragStartedEventArgs)

Called when the left selection receives logical focus and mouse capture.

Declaration

cs-api-definition
protected void OnLeftHandleDragStarted(object sender, DragStartedEventArgs e)

Parameters

sender

object

The sender.

e

DragStartedEventArgs

The DragStartedEventArgs instance containing the event data.

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled  attached event is raised on this element. Implement this method to add class handling for this event.

Declaration

cs-api-definition
protected override void OnMouseLeave(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Invoked when an unhandled  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

cs-api-definition
protected override void OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs that contains the event data.

OnRightHandleDragCompleted(object, DragCompletedEventArgs)

Called when the right selection control loses mouse capture.

Declaration

cs-api-definition
protected void OnRightHandleDragCompleted(object sender, DragCompletedEventArgs e)

Parameters

sender

object

The sender.

e

DragCompletedEventArgs

The DragCompletedEventArgs instance containing the event data.

OnRightHandleDragDelta(object, DragDeltaEventArgs)

Called one or more times as the mouse changes position when the center selection has logical focus and mouse capture.

Declaration

cs-api-definition
protected virtual void OnRightHandleDragDelta(object sender, DragDeltaEventArgs e)

Parameters

sender

object

The sender.

e

DragDeltaEventArgs

The DragDeltaEventArgs instance containing the event data.

OnRightHandleDragStarted(object, DragStartedEventArgs)

Called when the right selection receives logical focus and mouse capture.

Declaration

cs-api-definition
protected void OnRightHandleDragStarted(object sender, DragStartedEventArgs e)

Parameters

sender

object

The sender.

e

DragStartedEventArgs

The DragStartedEventArgs instance containing the event data.

OnScrollCompleted()

Called when the SelectionThumb stops moving.

Declaration

cs-api-definition
protected virtual void OnScrollCompleted()

OnScrollStarted()

Called when the SelectionThumb starts moving.

Declaration

cs-api-definition
protected virtual void OnScrollStarted()

OnSelectionChanged()

Called when the Selection changes.

Declaration

cs-api-definition
protected virtual void OnSelectionChanged()

Events

ScrollCompleted

Occurs when the SelectionThumb stops moving.

Declaration

cs-api-definition
public event RadRoutedEventHandler ScrollCompleted

Event Value

RadRoutedEventHandler

ScrollStarted

Occurs when the SelectionThumb starts moving.

Declaration

cs-api-definition
public event RadRoutedEventHandler ScrollStarted

Event Value

RadRoutedEventHandler

SelectionChanged

Occurs when the Selection changes.

Declaration

cs-api-definition
public event RadRoutedEventHandler SelectionChanged

Event Value

RadRoutedEventHandler

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.