Anthem.Timer Class Reference

Creates an updatable timer control. More...

List of all members.

Public Member Functions
[Anthem.Method] void	DoTick ()
	This method is called by the Timer control each time the timer expires.
void	StartTimer ()
	Starts the timer.
void	StopTimer ()
	Stops the timer.
Public Attributes
event EventHandler	Tick
	Occurs when the timer expires.
Protected Member Functions
virtual void	OnTick (EventArgs e)
	Raises the Tick event.
override void	OnPreRender (EventArgs e)
	Registers the client side script for the control.
override void	OnLoad (EventArgs e)
	Raises the System.Web.UI.Control.Load event and registers the control with Anthem.Manager.
Properties
[DefaultValue(false)] bool	Enabled [get, set]
	True if the timer is enabled on the client. The timer will continue to call the DoTick method while it is enabled.
[DefaultValue(1000)] int	Interval [get, set]
	The number of milliseconds between each call to DoTick.
[Browsable(false)] override bool	Visible [get, set]
	Visible is inherited from Control, but ignored by Timer.

---

Detailed Description

Creates an updatable timer control.

Definition at line 11 of file Timer.cs.

---

Member Function Documentation

[Anthem.Method] void Anthem.Timer.DoTick

(

)

This method is called by the Timer control each time the timer expires.

Definition at line 62 of file Timer.cs.

void Anthem.Timer.StartTimer

(

)

Starts the timer.

Definition at line 70 of file Timer.cs.

void Anthem.Timer.StopTimer

(

)

Stops the timer.

Definition at line 79 of file Timer.cs.

virtual void Anthem.Timer.OnTick

(

EventArgs

e

)

[protected, virtual]

Raises the Tick event.

Definition at line 93 of file Timer.cs.

Referenced by Anthem.Timer.DoTick().

override void Anthem.Timer.OnPreRender

(

EventArgs

e

)

[protected]

Registers the client side script for the control.

Definition at line 105 of file Timer.cs.

override void Anthem.Timer.OnLoad

(

EventArgs

e

)

[protected]

Raises the System.Web.UI.Control.Load event and registers the control with Anthem.Manager.

Parameters:

e

A System.EventArgs.

Definition at line 168 of file Timer.cs.

---

Member Data Documentation

event EventHandler Anthem.Timer.Tick

Occurs when the timer expires.

Definition at line 88 of file Timer.cs.

Referenced by Anthem.Timer.OnTick().

---

Property Documentation

[DefaultValue(false)] bool Anthem.Timer.Enabled [get, set]

True if the timer is enabled on the client. The timer will continue to call the DoTick method while it is enabled.

Definition at line 28 of file Timer.cs.

Referenced by Anthem.Timer.OnPreRender(), and Anthem.Timer.OnTick().

[DefaultValue(1000)] int Anthem.Timer.Interval [get, set]

The number of milliseconds between each call to DoTick.

Definition at line 47 of file Timer.cs.

[Browsable(false)] override bool Anthem.Timer.Visible [get, set]

Visible is inherited from Control, but ignored by Timer.

Definition at line 151 of file Timer.cs.

---

The documentation for this class was generated from the following file:

• D:/Projects/Anthem/Anthem/Timer.cs

---