Documentation

Class RadTimeline

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

Inheritance

System.Object

TimeBarBase

RadTimeline

Inherited Members

TimeBarBase.VisiblePeriodChangedEvent

TimeBarBase.GroupIntervalChangedEvent

TimeBarBase.ItemIntervalChangedEvent

TimeBarBase.ActualVisiblePeriodRangeProperty

TimeBarBase.ActualMinZoomRangeProperty

TimeBarBase.PeriodEndProperty

TimeBarBase.PeriodStartProperty

TimeBarBase.VisiblePeriodProperty

TimeBarBase.VisiblePeriodEndProperty

TimeBarBase.VisiblePeriodStartProperty

TimeBarBase.LargeChangeProperty

TimeBarBase.SmallChangeProperty

TimeBarBase.MinZoomRangeProperty

TimeBarBase.MaxZoomRangeProperty

TimeBarBase.ScrollModeProperty

TimeBarBase.SpecialSlotsGeneratorProperty

TimeBarBase.SliderStyleProperty

TimeBarBase.PeriodHeaderStyleProperty

TimeBarBase.GroupPeriodHeaderStyleProperty

TimeBarBase.IntervalsProperty

TimeBarBase.IntervalGroupsProperty

TimeBarBase.IntervalItemsProperty

TimeBarBase.CurrentGroupIntervalProperty

TimeBarBase.CurrentItemIntervalProperty

TimeBarBase.SpecialSlotsProperty

TimeBarBase.add_VisiblePeriodChanged(RadRoutedEventHandler)

TimeBarBase.remove_VisiblePeriodChanged(RadRoutedEventHandler)

TimeBarBase.EndInit()

TimeBarBase.ConvertPointToDateTime(Point)

TimeBarBase.RegisterCommand(ICommand, ExecutedRoutedEventHandler, CanExecuteRoutedEventHandler)

TimeBarBase.OnMouseWheel(MouseWheelEventArgs)

TimeBarBase.OnVisiblePeriodChanged()

TimeBarBase.OnGroupIntervalChanged(IntervalBase, IntervalBase)

TimeBarBase.OnItemIntervalChanged(IntervalBase, IntervalBase)

TimeBarBase.OnSliderSelectionChanged(Object, RadRoutedEventArgs)

TimeBarBase.ActualVisiblePeriodRange

TimeBarBase.ActualMinZoomRange

TimeBarBase.PeriodEnd

TimeBarBase.PeriodStart

TimeBarBase.VisiblePeriod

TimeBarBase.VisiblePeriodEnd

TimeBarBase.VisiblePeriodStart

TimeBarBase.LargeChange

TimeBarBase.SmallChange

TimeBarBase.MinZoomRange

TimeBarBase.MaxZoomRange

TimeBarBase.ScrollMode

TimeBarBase.SpecialSlotsGenerator

TimeBarBase.SliderStyle

TimeBarBase.PeriodHeaderStyle

TimeBarBase.GroupPeriodHeaderStyle

TimeBarBase.Intervals

TimeBarBase.IntervalGroups

TimeBarBase.IntervalItems

TimeBarBase.CurrentGroupInterval

TimeBarBase.CurrentItemInterval

TimeBarBase.SpecialSlots

TimeBarBase.VisiblePeriodChanged

TimeBarBase.ActualVisiblePeriodRangeChanged

TimeBarBase.GroupIntervalChanged

TimeBarBase.ItemIntervalChanged

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

[TelerikToolboxCategory("Data Visualization")]
public class RadTimeline : TimeBarBase, ISupportInitialize

Constructors

RadTimeline()

Initializes a new instance of the RadTimeline class.

Declaration

public RadTimeline()

Fields

AnnotationContentPathProperty

Identifies the AnnotationContentPath dependency property.

Declaration

public static readonly DependencyProperty AnnotationContentPathProperty

Field Value

System.Windows.DependencyProperty

AnnotationContentTemplateProperty

Identifies the AnnotationContentTemplate dependency property.

Declaration

public static readonly DependencyProperty AnnotationContentTemplateProperty

Field Value

System.Windows.DependencyProperty

AnnotationDurationPathProperty

Identifies the AnnotationDurationPath dependency property.

Declaration

public static readonly DependencyProperty AnnotationDurationPathProperty

Field Value

System.Windows.DependencyProperty

AnnotationsProperty

Identifies the Annotations dependency property.

Declaration

public static readonly DependencyProperty AnnotationsProperty

Field Value

System.Windows.DependencyProperty

AnnotationsSourceProperty

Identifies the AnnotationsSource dependency property.

Declaration

public static readonly DependencyProperty AnnotationsSourceProperty

Field Value

System.Windows.DependencyProperty

AnnotationStartPathProperty

Identifies the AnnotationStartPath dependency property.

Declaration

public static readonly DependencyProperty AnnotationStartPathProperty

Field Value

System.Windows.DependencyProperty

AnnotationZIndexPathProperty

Identifies the AnnotationZIndexPath dependency property.

Declaration

public static readonly DependencyProperty AnnotationZIndexPathProperty

Field Value

System.Windows.DependencyProperty

AutoSortProperty

Identifies the AutoSort dependency property.

Declaration

public static readonly DependencyProperty AutoSortProperty

Field Value

System.Windows.DependencyProperty

DataGroupsProperty

Identifies the DataGroups dependency property.

Declaration

public static readonly DependencyProperty DataGroupsProperty

Field Value

System.Windows.DependencyProperty

DataItemsProperty

Identifies the DataItems dependency property.

Declaration

public static readonly DependencyProperty DataItemsProperty

Field Value

System.Windows.DependencyProperty

DurationPathProperty

Identifies the DurationPath dependency property.

Declaration

public static readonly DependencyProperty DurationPathProperty

Field Value

System.Windows.DependencyProperty

GroupedDataItemsProperty

Identifies the GroupedDataItems dependency property.

Declaration

public static readonly DependencyProperty GroupedDataItemsProperty

Field Value

System.Windows.DependencyProperty

GroupExpandModeProperty

Identifies the GroupExpandMode dependency property.

Declaration

public static readonly DependencyProperty GroupExpandModeProperty

Field Value

System.Windows.DependencyProperty

GroupPathProperty

Identifies the GroupPath dependency property.

Declaration

public static readonly DependencyProperty GroupPathProperty

Field Value

System.Windows.DependencyProperty

IsSelectionEnabledProperty

Identifies the IsSelectionEnabled dependency property.

Declaration

public static readonly DependencyProperty IsSelectionEnabledProperty

Field Value

System.Windows.DependencyProperty

ItemRowIndexGeneratorProperty

Identifies the ItemRowIndexGenerator dependency property.

Declaration

public static readonly DependencyProperty ItemRowIndexGeneratorProperty

Field Value

System.Windows.DependencyProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

System.Windows.DependencyProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty ItemTemplateSelectorProperty

Field Value

System.Windows.DependencyProperty

MinimumItemGapProperty

Identifies the MinimumItemGap dependency property.

Declaration

public static readonly DependencyProperty MinimumItemGapProperty

Field Value

System.Windows.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

System.Windows.DependencyProperty

SelectedItemsProperty

Identifies the SelectedItems dependency property.

Declaration

public static readonly DependencyProperty SelectedItemsProperty

Field Value

System.Windows.DependencyProperty

SelectionChangedEvent

Identifies the SelectionChanged routed event.

Declaration

public static readonly RoutedEvent SelectionChangedEvent

Field Value

System.Windows.RoutedEvent

SelectionModeProperty

Identifies the SelectionMode dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

System.Windows.DependencyProperty

StartPathProperty

Identifies the StartPath dependency property.

Declaration

public static readonly DependencyProperty StartPathProperty

Field Value

System.Windows.DependencyProperty

TimelineInstantItemTemplateProperty

Identifies the TimelineInstantItemTemplate dependency property.

Declaration

public static readonly DependencyProperty TimelineInstantItemTemplateProperty

Field Value

System.Windows.DependencyProperty

TimelineItemTemplateProperty

Identifies the TimelineItemTemplate dependency property.

Declaration

public static readonly DependencyProperty TimelineItemTemplateProperty

Field Value

System.Windows.DependencyProperty

ToolTipFormatProperty

Identifies the ToolTipFormat dependency property.

Declaration

public static readonly DependencyProperty ToolTipFormatProperty

Field Value

System.Windows.DependencyProperty

ToolTipPathProperty

Identifies the ToolTipPath dependency property.

Declaration

public static readonly DependencyProperty ToolTipPathProperty

Field Value

System.Windows.DependencyProperty

ToolTipTemplateProperty

Identifies the ToolTipTemplate dependency property.

Declaration

public static readonly DependencyProperty ToolTipTemplateProperty

Field Value

System.Windows.DependencyProperty

VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility dependency property.

Declaration

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty

Field Value

System.Windows.DependencyProperty

Properties

AnnotationContentPath

Gets or sets the annotation content path.

Declaration

public string AnnotationContentPath { get; set; }

Property Value

System.String The annotation content path.

AnnotationContentTemplate

Gets or sets the annotation content template.

Declaration

public DataTemplate AnnotationContentTemplate { get; set; }

Property Value

System.Windows.DataTemplate The annotation content template.

AnnotationDurationPath

Gets or sets the annotation duration path.

Declaration

public string AnnotationDurationPath { get; set; }

Property Value

System.String The annotation duration path.

Annotations

Gets the annotations.

Declaration

public TimelineAnnotationCollection Annotations { get; }

Property Value

TimelineAnnotationCollection The annotations.

AnnotationsSource

Gets or sets the annotations source property.

Declaration

public IEnumerable AnnotationsSource { get; set; }

Property Value

System.Collections.IEnumerable

AnnotationStartPath

Gets or sets the annotation start path.

Declaration

public string AnnotationStartPath { get; set; }

Property Value

System.String The annotation start path.

AnnotationZIndexPath

Gets or sets the annotation z-index path.

Declaration

public string AnnotationZIndexPath { get; set; }

Property Value

System.String The annotation z-index path.

AutoSort

Gets or sets a value indicating if the timeline items will be ordered automatically by Start and Duration.

Declaration

public bool AutoSort { get; set; }

Property Value

System.Boolean The value indicating if the timeline items will be ordered automatically by Start and Duration.

DataGroups

Gets the groups of non intersecting items.

Declaration

public List<TimelineGroupData> DataGroups { get; }

Property Value

System.Collections.Generic.List<TimelineGroupData> The groups.

DataItems

Gets the items.

Declaration

public IEnumerable<TimelineDataItem> DataItems { get; }

Property Value

System.Collections.Generic.IEnumerable<TimelineDataItem> The items.

DurationPath

Gets or sets the duration path.

Declaration

public string DurationPath { get; set; }

Property Value

System.String The duration path.

GroupedDataItems

Gets the grouped items.

Declaration

public IEnumerable<TimelineDataItemGroup> GroupedDataItems { get; }

Property Value

System.Collections.Generic.IEnumerable<TimelineDataItemGroup> The grouped items.

GroupExpandMode

Gets or sets the group expand mode.

Declaration

public GroupExpandMode GroupExpandMode { get; set; }

Property Value

GroupExpandMode The group expand mode.

GroupPath

Gets or sets the group path.

Declaration

public string GroupPath { get; set; }

Property Value

System.String The group path.

IsSelectionEnabled

Gets or sets a value indicating if selection is enabled.

Declaration

public bool IsSelectionEnabled { get; set; }

Property Value

System.Boolean The value indicating if selection is enabled.

ItemRowIndexGenerator

Gets or sets an IItemRowIndexGenerator instance that generates row indexes for the items based on custom logic."/>.

Declaration

public IItemRowIndexGenerator ItemRowIndexGenerator { get; set; }

Property Value

IItemRowIndexGenerator An IItemRowIndexGenerator instance that generates a row index for each item. By default, the original indexes are used.

ItemsSource

Gets or sets the items source property.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

System.Collections.IEnumerable

ItemTemplateSelector

Gets or sets the custom logic for choosing a template used to display each item. This is a dependency property.

Declaration

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

System.Windows.Controls.DataTemplateSelector A custom System.Windows.Controls.DataTemplateSelector object that provides logic and returns a System.Windows.DataTemplate. The default is null.

MinimumItemGap

Gets or sets the minimum gap between two items on the same row.

Declaration

public TimeSpan MinimumItemGap { get; set; }

Property Value

System.TimeSpan The minimum gap between two items on the same row.

SelectedItem

Gets the selected item.

Declaration

public object SelectedItem { get; set; }

Property Value

System.Object The selected item.

SelectedItems

Gets the selected items property.

Declaration

public IList SelectedItems { get; }

Property Value

System.Collections.IList

SelectionMode

Gets or sets the selection mode.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

System.Windows.Controls.SelectionMode The selection mode.

StartPath

Gets or sets the start path.

Declaration

public string StartPath { get; set; }

Property Value

System.String The start path.

TimelineInstantItemTemplate

Gets or sets the instant event template.

Declaration

public DataTemplate TimelineInstantItemTemplate { get; set; }

Property Value

System.Windows.DataTemplate The instant event template.

TimelineItemTemplate

Gets or sets the event template.

Declaration

public DataTemplate TimelineItemTemplate { get; set; }

Property Value

System.Windows.DataTemplate The event template.

ToolTipFormat

Gets or sets the tooltip format.

Declaration

public string ToolTipFormat { get; set; }

Property Value

System.String The tooltip format.

ToolTipPath

Gets or sets the tooltip path.

Declaration

public string ToolTipPath { get; set; }

Property Value

System.String The tooltip path.

ToolTipTemplate

Gets or sets the tooltip template.

Declaration

public DataTemplate ToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate The tooltip template.

VerticalScrollBarVisibility

Gets or sets a value that indicates whether a vertical scrollBar should be displayed.

Declaration

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

System.Windows.Controls.ScrollBarVisibility A System.Windows.Controls.ScrollBarVisibility value that indicates whether a vertical scrollBar should be displayed. The default is ScrollBarVisibility.Disabled.

Methods

CollapseAll()

Collapses all groups of timeline items.

Declaration

public void CollapseAll()

Remarks

No group is collapsed in case GroupExpandMode equals None.

ExpandAll()

Expands all groups of timeline items.

Declaration

public void ExpandAll()

Remarks

Expands only the first group of timeline items in case GroupExpandMode equals Single.

GetGroupByGroupHeader(Object)

Returns a group of timeline items with the specified group header.

Declaration

public TimelineItemGroupControl GetGroupByGroupHeader(object groupHeader)

Parameters

System.Object groupHeader The group header.

Returns

TimelineItemGroupControl A TimelineItemGroupControl with the specified group header.

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()

Overrides

TimeBarBase.OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e The System.Windows.RoutedEventArgs that contains the event data.

Overrides

TimeBarBase.OnInitialized(EventArgs)

Events

SelectionChanged

Occurs when the selection is changed.

Declaration

public event EventHandler<SelectionChangeEventArgs> SelectionChanged

Event Type

System.EventHandler<SelectionChangeEventArgs>

Extension Methods

RadTimelineExtensions.ContainerFromItem(RadTimeline, Object)

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)