RadTimeline
A control that displays a series of events in chronological order along a timeline.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
[ToolboxBitmap(typeof(RadTimeline), "Toolbox.Icons.Timeline.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5Timeline))]
[ClientScriptResource("Telerik.Web.UI.RadTimeline", "Telerik.Web.UI.Timeline.Scripts.RadTimeline.js")]
[EmbeddedSkin("Timeline", typeof(RadTimeline))]
[EmbeddedSkin("Timeline", "Default", typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Classic, typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Mobile, typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadTimeline))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadTimeline))]
public class RadTimeline : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadTimeline...
Implements:
Inherited Members
Constructors
public RadTimeline()Properties
Indicates whether events should be positioned on both sides of the timeline axis. By default all events are displayed on the right side of the timeline axis.
public bool AlternatingMode { get; set; }Gets or sets a value indicating whether the RadTimeline control should automatically post back to the server when the user interacts with it.
[Bindable(false)]
public bool AutoPostBack { get; set; }Defines the client events handlers.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TimelineClientEvents ClientEvents { get; }Enables the events in the Kendo UI Timeline to be expandable or collapsible. When enabled initially all events are collapsed.
public bool CollapsibleEvents { get; set; }The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
Sets the field of the data item that provides the actions information for the event.
public string DataActionsField { get; set; }Sets the field of the data item that provides information when the given event happened in time.
public string DataDateField { get; set; }Sets the field of the data item that provides the description information for the event.
public string DataDescriptionField { get; set; }Sets the field of the data item that provides the images information for the event.
public string DataImagesField { get; set; }Gets or sets an array of data-field names that will be used to populate the Timeline's DataItem property which is used to populated the control's template. The field declared in the Columns are added by default.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
public virtual string[] DataKeyNames { get; set; }An array that contains the names of the fields contained in the Timeline's DataItem property.
Note: The dataItem's properties declared in the template should be with lower case.
Sets the field of the data item that provides the subtitle information for the event.
public string DataSubtitleField { get; set; }Sets the field of the data item that provides the title information for the event.
public string DataTitleField { get; set; }Sets the date format used to display the date in the event's label
public string DateFormat { get; set; }Sets specific height for the event in horizontal mode.
public double EventHeight { get; set; }Specifies the template used to render the event details.
[Browsable(true)]
[Bindable(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public string EventTemplate { get; set; }Sets specific width for the event in vertical mode.
public double EventWidth { get; set; }Gets the collection of timeline items displayed in the RadTimeline control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TimelineItemCollection Items { get; }Navigate the widget using the keyboard. Setting it to true will enable the keyaboard navigation for the component.
public bool Navigatable { get; set; }Sets the orienation of the timeline axis. The widget expects "horizontal" or "vertical"
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("orientation")]
public RadTimelineOrientation Orientation { get; set; }Gets or sets the URL of the page to post to from the current page when a tab from the tabstrip is clicked.
[Themeable(false)]
public virtual string PostBackUrl { get; set; }The URL of the Web page to post to from the current page when a tab from the tabstrip control is clicked. The default value is an empty string (""), which causes the page to post back to itself.
If set to false, the event's date label will be hidden.
public bool ShowDateLabels { get; set; }protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets the RadClientDataSource instance of the Timeline control.
[Browsable(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual WebServiceClientDataSource WebServiceClientDataSource { get; }Methods
protected virtual void BindItems(IEnumerable<TimelineItem> items)protected override void CreateChildControls()Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
protected virtual void DescribeItems(IScriptDescriptor descriptor)Loads the posted content of the list control, if it is different from the last posting.
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)The key identifier for the control, used to index the postCollection.
postCollectionNameValueCollectionA NameValueCollection that contains value information indexed by control identifiers.
Returns:true if the posted content is different from the last posting; otherwise, false.
Overrides:
protected virtual void OnChildrenCreated()protected override void PerformDataBinding(IEnumerable data)Overrides:
Events
Occurs after an item is data bound to the RadTimeline control.
public event RadTimelineItemEventHandler ItemDataBoundThis event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.