Anthem.CheckBox Class Reference

Displays an updatable check box that allows the user to select a true or false condition. Uses callbacks if AutoCallBack is true. More...

Inheritance diagram for Anthem.CheckBox:

Anthem.IUpdatableControl Anthem.ICallBackControl List of all members.

Public Member Functions

override void RenderControl (HtmlTextWriter writer)
 Forces the server control to output content and trace information.

Protected Member Functions

override void OnPreRender (EventArgs e)
 Use OnPreRender with CheckBox. AddAttributesToRender is not called in ASP.NET 1.1.
override void Render (HtmlTextWriter writer)
 Renders the server control wrapped in an additional element so that the element.innerHTML can be updated after a callback.
override void OnLoad (EventArgs e)
 Raises the System.Web.UI.Control.Load event and registers the control with Anthem.Manager.

Properties

[DefaultValue(false)] bool AutoCallBack [get, set]
 Gets or sets a value indicating whether the Checkbox state automatically calls back to the server when clicked. Mimics the AutoPostBack property.
[Category("Anthem")][DefaultValue("")][Description("The javascript
function to call on the client
if the callback is cancelled.")]
virtual string 
CallBackCancelledFunction [get, set]
 Gets or sets the javascript function to execute on the client if the callback is cancelled. See PreCallBackFunction.
[Category("Anthem")][DefaultValue(true)][Description("True
if this control uses callbacks
instead of postbacks to post
data to the server.")] virtual
bool 
EnableCallBack [get, set]
 Gets or sets a value indicating whether the control uses callbacks instead of postbacks to post data to the server.
[Category("Anthem")][DefaultValue(true)][Description("True
if this control is enabled
on the client during callbacks.")]
virtual bool 
EnabledDuringCallBack [get, set]
 Gets or sets a value indicating whether the control is enabled on the client during callbacks.
[Category("Anthem")][DefaultValue("")][Description("The javascript
function to call on the client
after the callback response
is received.")] virtual string 
PostCallBackFunction [get, set]
 Gets or sets the javascript function to execute on the client after the callback response is received.
[Category("Anthem")][DefaultValue("")][Description("The javascript
function to call on the client
before the callback is made.")]
virtual string 
PreCallBackFunction [get, set]
 Gets or sets the javascript function to execute on the client before the callback is made.
[Category("Anthem")][DefaultValue("")][Description("The text
to display during the callback.")]
virtual string 
TextDuringCallBack [get, set]
 Gets or sets the text to display on the client during the callback.
[Category("Anthem")][DefaultValue(false)][Description("True
if this control should be
updated after each callback.")]
virtual bool 
AutoUpdateAfterCallBack [get, set]
 Gets or sets a value indicating whether the control should be updated after each callback. Also see UpdateAfterCallBack.
[Browsable(false)][DefaultValue(false)] virtual bool UpdateAfterCallBack [get, set]
 Gets or sets a value which indicates whether the control should be updated after the current callback. Also see AutoUpdateAfterCallBack.
override bool Visible [get, set]
 Overrides the Visible property so that Anthem.Manager can track the visibility.

Detailed Description

Displays an updatable check box that allows the user to select a true or false condition. Uses callbacks if AutoCallBack is true.

Definition at line 14 of file CheckBox.cs.


Member Function Documentation

override void Anthem.CheckBox.OnPreRender ( EventArgs  e  )  [protected]

Use OnPreRender with CheckBox. AddAttributesToRender is not called in ASP.NET 1.1.

Parameters:
e 

Definition at line 40 of file CheckBox.cs.

override void Anthem.CheckBox.Render ( HtmlTextWriter  writer  )  [protected]

Renders the server control wrapped in an additional element so that the element.innerHTML can be updated after a callback.

Definition at line 67 of file CheckBox.cs.

override void Anthem.CheckBox.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 328 of file CheckBox.cs.

override void Anthem.CheckBox.RenderControl ( HtmlTextWriter  writer  ) 

Forces the server control to output content and trace information.

Definition at line 338 of file CheckBox.cs.


Property Documentation

[DefaultValue(false)] bool Anthem.CheckBox.AutoCallBack [get, set]

Gets or sets a value indicating whether the Checkbox state automatically calls back to the server when clicked. Mimics the AutoPostBack property.

Definition at line 24 of file CheckBox.cs.

Referenced by Anthem.CheckBox.OnPreRender().

[Category("Anthem")][DefaultValue("")][Description("The javascript function to call on the client if the callback is cancelled.")] virtual string Anthem.CheckBox.CallBackCancelledFunction [get, set]

Gets or sets the javascript function to execute on the client if the callback is cancelled. See PreCallBackFunction.

Implements Anthem.ICallBackControl.

Definition at line 99 of file CheckBox.cs.

[Category("Anthem")][DefaultValue(true)][Description("True if this control uses callbacks instead of postbacks to post data to the server.")] virtual bool Anthem.CheckBox.EnableCallBack [get, set]

Gets or sets a value indicating whether the control uses callbacks instead of postbacks to post data to the server.

true if the the control uses callbacks; otherwise, false. The default is true.

Implements Anthem.ICallBackControl.

Definition at line 125 of file CheckBox.cs.

[Category("Anthem")][DefaultValue(true)][Description("True if this control is enabled on the client during callbacks.")] virtual bool Anthem.CheckBox.EnabledDuringCallBack [get, set]

Gets or sets a value indicating whether the control is enabled on the client during callbacks.

true if the the control is enabled; otherwise, false. The default is true.

Not all HTML elements support this property.

Implements Anthem.ICallBackControl.

Definition at line 152 of file CheckBox.cs.

[Category("Anthem")][DefaultValue("")][Description("The javascript function to call on the client after the callback response is received.")] virtual string Anthem.CheckBox.PostCallBackFunction [get, set]

Gets or sets the javascript function to execute on the client after the callback response is received.

The callback response is passed into the PostCallBackFunction as the one and only parameter.

            function AfterCallBack(result) {
              if (result.error != null && result.error.length > 0) {
                alert(result.error);
              }
            }

Implements Anthem.ICallBackControl.

Definition at line 189 of file CheckBox.cs.

[Category("Anthem")][DefaultValue("")][Description("The javascript function to call on the client before the callback is made.")] virtual string Anthem.CheckBox.PreCallBackFunction [get, set]

Gets or sets the javascript function to execute on the client before the callback is made.

The function should return false on the client to cancel the callback.

Implements Anthem.ICallBackControl.

Definition at line 214 of file CheckBox.cs.

[Category("Anthem")][DefaultValue("")][Description("The text to display during the callback.")] virtual string Anthem.CheckBox.TextDuringCallBack [get, set]

Gets or sets the text to display on the client during the callback.

If the HTML element that invoked the callback has a text value (such as <input type="button" value="Run">) then the text of the element is updated during the callback, otherwise the associated <label> text is updated during the callback. If the element does not have a text value, and if there is no associated <label>, then this property is ignored.

Implements Anthem.ICallBackControl.

Definition at line 242 of file CheckBox.cs.

[Category("Anthem")][DefaultValue(false)][Description("True if this control should be updated after each callback.")] virtual bool Anthem.CheckBox.AutoUpdateAfterCallBack [get, set]

Gets or sets a value indicating whether the control should be updated after each callback. Also see UpdateAfterCallBack.

true if the the control should be updated; otherwise, false. The default is false.

            &lt;anthem:Label id="label" runat="server" AutoUpdateAfterCallBack="true" /&gt;

Implements Anthem.IUpdatableControl.

Definition at line 279 of file CheckBox.cs.

[Browsable(false)][DefaultValue(false)] virtual bool Anthem.CheckBox.UpdateAfterCallBack [get, set]

Gets or sets a value which indicates whether the control should be updated after the current callback. Also see AutoUpdateAfterCallBack.

true if the the control should be updated; otherwise, false. The default is false.

            this.Label = "Count = " + count;
            this.Label.UpdateAfterCallBack = true;

Implements Anthem.IUpdatableControl.

Definition at line 314 of file CheckBox.cs.

override bool Anthem.CheckBox.Visible [get, set]

Overrides the Visible property so that Anthem.Manager can track the visibility.

true if the control is rendered on the client; otherwise false. The default is true.

Definition at line 353 of file CheckBox.cs.

Referenced by Anthem.CheckBox.Render().


The documentation for this class was generated from the following file:
Generated on Wed Mar 14 23:50:40 2007 for Anthem by  doxygen 1.5.1-p1