New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadTicker

Class

RadTicker control

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[TelerikToolboxCategory("Visualization")]
[ToolboxBitmap(typeof(RadTicker), "Toolbox.Icons.Ticker.png")]
[ClientScriptResource("Telerik.Web.UI.RadTicker", "Telerik.Web.UI.Rotator.RadTicker.js")]
public class RadTicker : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainer

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadTicker...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupINamingContainerIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Constructors

RadTicker()

public RadTicker()

Properties

AppendDataBoundItems

bool

public bool AppendDataBoundItems { get; set; }

AutoAdvance

bool

Specifies whether RadTicker will begin ticking the next tickerline (if any) after it has finished ticking the current one.

[ClientControlProperty]
public bool AutoAdvance { get; set; }

Property Value:

Default: True

If you set the AutoAdvance property to false, then you will have to use a client API Call ticker_id.tickNextLine()

AutoPostBack

bool

Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.

public virtual bool AutoPostBack { get; set; }

Property Value:

The default value is false.

Setting this property to true will make Telerik RadTicker postback to the server on item click.

AutoStart

bool

Specifies whether the ticker begins ticking automatically.

[ClientControlProperty]
public bool AutoStart { get; set; }

Property Value:

Default: False

You should leave this set to false if you are using the ticker within a RadTicker If you use the ticker independently and leave this setting to false you should use the client API call ticker_id.startTicker() to start it.

DataNavigateUrlField

string

public string DataNavigateUrlField { get; set; }

DataTextField

string

Gets or sets the field of the data source that provides the value of the ticker lines.

public string DataTextField { get; set; }

Property Value:

A string that specifies the field of the data source that provides the value of the ticker lines. The default value is an empty string.

Use the DataTextField property to specify the field of the data source (in most cases the name of the database column) which provides the values for the Text property of databound ticker items. The DataTextField property is taken into account only during data binding. If the DataTextField property is not set and your datasource is not a list of strings, the RadTicker control will throw an exception.

Example:

cs-api-definition
DataTable data = new DataTable();
data.Columns.Add("MyID");
data.Columns.Add("MyValue");

data.Rows.Add(new object[] {"1", "ticker item text 1"});
data.Rows.Add(new object[] {"2", "ticker item text 2"});

RadTicker1.DataSource = data;
RadTicker1.DataTextField = "MyValue";    //"MyValue" column provides values for the Text property of databound ticker items
RadTicker1.DataBind();
cs-api-definition.skip-repl
Dim data As new DataTable();
data.Columns.Add("MyID")
data.Columns.Add("MyValue")

data.Rows.Add(New Object() {"1", "ticker item text 1"})
data.Rows.Add(New Object() {"2", "ticker item text 2"})

RadTicker1.DataSource = data
RadTicker1.DataTextField = "MyValue"    '"MyValue" column provides values for the Text property of databound ticker items
RadTicker1.DataBind()

EnableEmbeddedBaseStylesheet

bool

Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.

public override bool EnableEmbeddedBaseStylesheet { get; }

Overrides: RadDataBoundControl.EnableEmbeddedBaseStylesheet

If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.

EnableEmbeddedSkins

bool

Gets or sets the value, indicating whether to render links to the embedded skins or not.

public override bool EnableEmbeddedSkins { get; }

Overrides: RadDataBoundControl.EnableEmbeddedSkins

If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.

Items

RadTickerItemCollection

The collection that holds all RadTickerItem objects.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public RadTickerItemCollection Items { get; }

LineDuration

int

Specifies in milliseconds the pause RadTicker makes before starting to tick the next line (if AutoAdvance=True).

[ClientControlProperty]
public int LineDuration { get; set; }

Property Value:

Default: 2000ms

Loop

bool

Specifies whether RadTicker will repeat the first tickerline after displaying the last one.

[ClientControlProperty]
public bool Loop { get; set; }

Property Value:

Default: False

If you set this property to true RadTicker will never finish ticking. This may have possible implications when having more than one RadTicker instance in a RadRotator. This way RadRotator works is that when the first ticker on a frame has finished ticking it will start ticking the next ticker on the frame. If a RadTicker instance is ticking (has Loop=true) it will never finish and the next ticker on the frame will not get started.

PostBackUrl

string

[Themeable(false)]
public string PostBackUrl { get; set; }

TickSpeed

int

Specifies the duration in milliseconds between ticking each character of a tickerline. The lower the value the faster a line will finish ticking.

[ClientControlProperty]
public int TickSpeed { get; set; }

Property Value:

Default: 20ms

Methods

BindToEnumerableData(IEnumerable)

Binds the ticker to a IEnumerable data source

public void BindToEnumerableData(IEnumerable dataSource)

Parameters:dataSourceIEnumerable

IEnumerable data source

DescribeClientEvents(IScriptDescriptor)

protected override void DescribeClientEvents(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientEvents(IScriptDescriptor)

DescribeClientProperties(IScriptDescriptor)

protected override void DescribeClientProperties(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientProperties(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeComponent(IScriptDescriptor)

GetPostbackEventReference()

protected virtual string GetPostbackEventReference()

Returns:

string

InitializeItem(RadTickerItem)

protected virtual void InitializeItem(RadTickerItem item)

Parameters:itemRadTickerItem

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: DataBoundControl.LoadViewState(object)

PerformDataBinding(IEnumerable)

protected override void PerformDataBinding(IEnumerable data)

Parameters:dataIEnumerable

Overrides: DataBoundControl.PerformDataBinding(IEnumerable)

PrepareForDataBinding()

protected void PrepareForDataBinding()

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: DataBoundControl.SaveViewState()

TrackViewState()

protected override void TrackViewState()

Overrides: DataBoundControl.TrackViewState()