|
| 1 | +--- |
| 2 | +title: Telerik.Web.UI.RadTimeline |
| 3 | +page_title: Telerik.Web.UI.RadTimeline |
| 4 | +description: Telerik.Web.UI.RadTimeline |
| 5 | +--- |
| 6 | + |
| 7 | +# Telerik.Web.UI.RadTimeline |
| 8 | + |
| 9 | +## Inheritance Hierarchy |
| 10 | + |
| 11 | +* System.Object |
| 12 | +* System.Web.UI.Control |
| 13 | +* System.Web.UI.WebControls.WebControl |
| 14 | +* System.Web.UI.WebControls.BaseDataBoundControl |
| 15 | +* System.Web.UI.WebControls.DataBoundControl |
| 16 | +* Telerik.Web.UI.RadDataBoundControl : IControl, IControlResolver, IFeatureGroup, IPostBackDataHandler, IScriptControl, ISkinnableControl |
| 17 | +* Telerik.Web.UI.RadTimeline : INamingContainer |
| 18 | + |
| 19 | +## Properties |
| 20 | + |
| 21 | +### AlternatingMode `Boolean` |
| 22 | + |
| 23 | +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. |
| 24 | + |
| 25 | +### ClientDataSourceID `String` |
| 26 | + |
| 27 | +Gets or sets ID of ClientDataSource control that is used for client side binding |
| 28 | + |
| 29 | +### ClientEvents `TimelineClientEvents` |
| 30 | + |
| 31 | +Defines the client events handlers. |
| 32 | + |
| 33 | +### ClientIDMode `ClientIDMode` |
| 34 | + |
| 35 | +This property is overridden in order to support controls which implement INamingContainer. |
| 36 | + The default value is changed to "AutoID". |
| 37 | + |
| 38 | +### CollapsibleEvents `Boolean` |
| 39 | + |
| 40 | +Enables the events in the Kendo UI Timeline to be expandable or collapsible. When enabled initially all events are collapsed. |
| 41 | + |
| 42 | +### CssClassFormatString `String` |
| 43 | + |
| 44 | +The CssClass property will now be used instead of the former Skin |
| 45 | + and will be modified in AddAttributesToRender() |
| 46 | + |
| 47 | +### DataActionsField `String` |
| 48 | + |
| 49 | +Sets the field of the data item that provides the actions information for the event. |
| 50 | + |
| 51 | +### DataDateField `String` |
| 52 | + |
| 53 | +Sets the field of the data item that provides information when the given event happened in time. |
| 54 | + |
| 55 | +### DataDescriptionField `String` |
| 56 | + |
| 57 | +Sets the field of the data item that provides the description information for the event. |
| 58 | + |
| 59 | +### DataImagesField `String` |
| 60 | + |
| 61 | +Sets the field of the data item that provides the images information for the event. |
| 62 | + |
| 63 | +### DataKeyNames `String[]` |
| 64 | + |
| 65 | +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. |
| 66 | + |
| 67 | +#### Remarks |
| 68 | +Note: The dataItem's properties declared in the template should be with lower case. |
| 69 | + |
| 70 | +### DataSubtitleField `String` |
| 71 | + |
| 72 | +Sets the field of the data item that provides the subtitle information for the event. |
| 73 | + |
| 74 | +### DataTitleField `String` |
| 75 | + |
| 76 | +Sets the field of the data item that provides the title information for the event. |
| 77 | + |
| 78 | +### DateFormat `String` |
| 79 | + |
| 80 | +Sets the date format used to display the date in the event's label |
| 81 | + |
| 82 | +### EnableAjaxSkinRendering `String` |
| 83 | + |
| 84 | +Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests |
| 85 | + |
| 86 | +#### Remarks |
| 87 | +If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax. |
| 88 | + |
| 89 | +### EnableEmbeddedBaseStylesheet `Boolean` |
| 90 | + |
| 91 | +Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not. |
| 92 | + |
| 93 | +#### Remarks |
| 94 | +If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand. |
| 95 | + |
| 96 | +### EnableEmbeddedScripts `Boolean` |
| 97 | + |
| 98 | +Gets or sets the value, indicating whether to render script references to the embedded scripts or not. |
| 99 | + |
| 100 | +#### Remarks |
| 101 | +If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand. |
| 102 | + |
| 103 | +### EnableEmbeddedSkins `String` |
| 104 | + |
| 105 | +Gets or sets the value, indicating whether to render links to the embedded skins or not. |
| 106 | + |
| 107 | +#### Remarks |
| 108 | +If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand. |
| 109 | + |
| 110 | +### EnableRippleEffect `Boolean` |
| 111 | + |
| 112 | +Returns true if ripple effect should be added |
| 113 | + |
| 114 | +### EventHeight `Double` |
| 115 | + |
| 116 | +Sets specific height for the event in horizontal mode. |
| 117 | + |
| 118 | +### EventTemplate `String` |
| 119 | + |
| 120 | +Specifies the template used to render the event details. |
| 121 | + |
| 122 | +### EventWidth `Double` |
| 123 | + |
| 124 | +Sets specific width for the event in vertical mode. |
| 125 | + |
| 126 | +### IsSkinSet `String` |
| 127 | + |
| 128 | +For internal use. |
| 129 | + |
| 130 | +### ODataDataSourceID `String` |
| 131 | + |
| 132 | +Gets or sets the ODataDataSource used for data binding. |
| 133 | + |
| 134 | +### Orientation `RadTimelineOrientation` |
| 135 | + |
| 136 | +Sets the orienation of the timeline axis. The widget expects "horizontal" or "vertical" |
| 137 | + |
| 138 | +### PostBackUrl `String` |
| 139 | + |
| 140 | +Gets or sets the URL of the page to post to from the current page when a tab |
| 141 | + from the tabstrip is clicked. |
| 142 | + |
| 143 | +### RegisterWithScriptManager `Boolean` |
| 144 | + |
| 145 | +Gets or sets the value, indicating whether to register with the ScriptManager control on the page. |
| 146 | + |
| 147 | +#### Remarks |
| 148 | +If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods. |
| 149 | + |
| 150 | +### RenderMode `RenderMode` |
| 151 | + |
| 152 | +Specifies the rendering mode of the control. Setting the mode to Lightweight will yield |
| 153 | + HTML 5/CSS 3 html and css. If the set value is Auto use ResolvedRenderMode to receive the actual RenderMode |
| 154 | + with respect to the user angent of the current request. |
| 155 | + |
| 156 | +#### Remarks |
| 157 | +Lightweight rendering mode might change the outlook of the component in some older browsers |
| 158 | + that don't support CSS3/HTML5. |
| 159 | + |
| 160 | +### ResolvedRenderMode `RenderMode` |
| 161 | + |
| 162 | +Returns resolved RenderMode should the original value was Auto |
| 163 | + |
| 164 | +### RuntimeSkin `String` |
| 165 | + |
| 166 | +Gets the real skin name for the control user interface. If Skin is not set, returns |
| 167 | + "Default", otherwise returns Skin. |
| 168 | + |
| 169 | +### ShowDateLabels `Boolean` |
| 170 | + |
| 171 | +If set to false, the event's date label will be hidden. |
| 172 | + |
| 173 | +### Skin `String` |
| 174 | + |
| 175 | +Gets or sets the skin name for the control user interface. |
| 176 | + |
| 177 | +#### Remarks |
| 178 | +If this property is not set, the control will render using the skin named "Default". |
| 179 | + If EnableEmbeddedSkins is set to false, the control will not render skin. |
| 180 | + |
| 181 | +### WebServiceClientDataSource `WebServiceClientDataSource` |
| 182 | + |
| 183 | +Gets the RadClientDataSource instance of the Timeline control. |
| 184 | + |
| 185 | +## Methods |
| 186 | + |
| 187 | +### ApplyConditionalRendering |
| 188 | + |
| 189 | +Use this from RenderContents of the inheritor |
| 190 | + |
| 191 | +#### Returns |
| 192 | + |
| 193 | +`System.Void` |
| 194 | + |
| 195 | +### ControlPreRender |
| 196 | + |
| 197 | +Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason |
| 198 | + |
| 199 | +#### Returns |
| 200 | + |
| 201 | +`System.Void` |
| 202 | + |
| 203 | +### DescribeRenderingMode |
| 204 | + |
| 205 | +Should be used by inheritors |
| 206 | + |
| 207 | +#### Returns |
| 208 | + |
| 209 | +`System.Void` |
| 210 | + |
| 211 | +### GetEmbeddedSkinNames |
| 212 | + |
| 213 | +Returns the names of all embedded skins. Used by Telerik.Web.Examples. |
| 214 | + |
| 215 | +#### Returns |
| 216 | + |
| 217 | +`System.Collections.Generic.List`1` |
| 218 | + |
| 219 | +### LoadClientState |
| 220 | + |
| 221 | +Loads the client state data |
| 222 | + |
| 223 | +#### Parameters |
| 224 | + |
| 225 | +#### clientState `System.Collections.Generic.Dictionary{System.String,System.Object}` |
| 226 | + |
| 227 | +#### Returns |
| 228 | + |
| 229 | +`System.Void` |
| 230 | + |
| 231 | +### LoadPostData |
| 232 | + |
| 233 | +Loads the posted content of the list control, if it is different from the last posting. |
| 234 | + |
| 235 | +#### Parameters |
| 236 | + |
| 237 | +#### postDataKey `System.String` |
| 238 | + |
| 239 | +The key identifier for the control, used to index the postCollection. |
| 240 | + |
| 241 | +#### postCollection `System.Collections.Specialized.NameValueCollection` |
| 242 | + |
| 243 | +A that contains value information indexed by control identifiers. |
| 244 | + |
| 245 | +#### Returns |
| 246 | + |
| 247 | +`System.Boolean` true if the posted content is different from the last posting; otherwise, false. |
| 248 | + |
| 249 | +### LoadPostData |
| 250 | + |
| 251 | +Executed when post data is loaded from the request |
| 252 | + |
| 253 | +#### Parameters |
| 254 | + |
| 255 | +#### postDataKey `System.String` |
| 256 | + |
| 257 | +#### postCollection `System.Collections.Specialized.NameValueCollection` |
| 258 | + |
| 259 | +#### Returns |
| 260 | + |
| 261 | +`System.Boolean` |
| 262 | + |
| 263 | +### RaisePostDataChangedEvent |
| 264 | + |
| 265 | +Executed when post data changes should invoke a changed event |
| 266 | + |
| 267 | +#### Returns |
| 268 | + |
| 269 | +`System.Void` |
| 270 | + |
| 271 | +### RegisterCssReferences |
| 272 | + |
| 273 | +Registers the CSS references |
| 274 | + |
| 275 | +#### Returns |
| 276 | + |
| 277 | +`System.Void` |
| 278 | + |
| 279 | +### RegisterScriptControl |
| 280 | + |
| 281 | +Registers the control with the ScriptManager |
| 282 | + |
| 283 | +#### Returns |
| 284 | + |
| 285 | +`System.Void` |
| 286 | + |
| 287 | +### SaveClientState |
| 288 | + |
| 289 | +Saves the client state data |
| 290 | + |
| 291 | +#### Returns |
| 292 | + |
| 293 | +`System.String` |
| 294 | + |
0 commit comments