Anthem.DataGrid Class Reference

Creates an updatable data bound list control that displays the items from data source in a table. The DataGrid control allows you to select, sort, and edit these items using callbacks. More...

Inheritance diagram for Anthem.DataGrid:

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	OnCancelCommand (System.Web.UI.WebControls.DataGridCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnCancelCommand, then sets UpdateAfterCallBack to true.
override void	OnDeleteCommand (System.Web.UI.WebControls.DataGridCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnDeleteCommand, then sets UpdateAfterCallBack to true.
override void	OnEditCommand (System.Web.UI.WebControls.DataGridCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnEditCommand, then sets UpdateAfterCallBack to true.
override void	OnItemCommand (System.Web.UI.WebControls.DataGridCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnItemCommand, then sets UpdateAfterCallBack to true.
override void	OnPageIndexChanged (System.Web.UI.WebControls.DataGridPageChangedEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnPageIndexChanged, then sets UpdateAfterCallBack to true.
override void	OnSelectedIndexChanged (EventArgs e)
	Excecutes System.Web.UI.WebControls.BaseDataList.OnSelectedIndexChanged, then sets UpdateAfterCallBack to true.
override void	OnSortCommand (System.Web.UI.WebControls.DataGridSortCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnSortCommand, then sets UpdateAfterCallBack to true.
override void	OnUpdateCommand (System.Web.UI.WebControls.DataGridCommandEventArgs e)
	Excecutes System.Web.UI.WebControls.DataGrid.OnUpdateCommand, then sets UpdateAfterCallBack to true.
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
[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(true)][Description("True if this control should convert child control postbacks into callbacks.")] virtual bool	AddCallBacks `[get, set]`
	Gets or sets a value indicating whether the control should convert child control postbacks into callbacks.
[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

Creates an updatable data bound list control that displays the items from data source in a table. The DataGrid control allows you to select, sort, and edit these items using callbacks.

Definition at line 13 of file DataGrid.cs.

Member Function Documentation

override void Anthem.DataGrid.OnCancelCommand ( System.Web.UI.WebControls.DataGridCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnCancelCommand, then sets UpdateAfterCallBack to true.

Definition at line 21 of file DataGrid.cs.

override void Anthem.DataGrid.OnDeleteCommand ( System.Web.UI.WebControls.DataGridCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnDeleteCommand, then sets UpdateAfterCallBack to true.

Definition at line 31 of file DataGrid.cs.

override void Anthem.DataGrid.OnEditCommand ( System.Web.UI.WebControls.DataGridCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnEditCommand, then sets UpdateAfterCallBack to true.

Definition at line 41 of file DataGrid.cs.

override void Anthem.DataGrid.OnItemCommand ( System.Web.UI.WebControls.DataGridCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnItemCommand, then sets UpdateAfterCallBack to true.

Definition at line 51 of file DataGrid.cs.

override void Anthem.DataGrid.OnPageIndexChanged ( System.Web.UI.WebControls.DataGridPageChangedEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnPageIndexChanged, then sets UpdateAfterCallBack to true.

Definition at line 61 of file DataGrid.cs.

override void Anthem.DataGrid.OnSelectedIndexChanged ( EventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.BaseDataList.OnSelectedIndexChanged, then sets UpdateAfterCallBack to true.

Definition at line 71 of file DataGrid.cs.

override void Anthem.DataGrid.OnSortCommand ( System.Web.UI.WebControls.DataGridSortCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnSortCommand, then sets UpdateAfterCallBack to true.

Definition at line 81 of file DataGrid.cs.

override void Anthem.DataGrid.OnUpdateCommand ( System.Web.UI.WebControls.DataGridCommandEventArgs e ) [protected]

Excecutes System.Web.UI.WebControls.DataGrid.OnUpdateCommand, then sets UpdateAfterCallBack to true.

Definition at line 91 of file DataGrid.cs.

override void Anthem.DataGrid.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 102 of file DataGrid.cs.

override void Anthem.DataGrid.OnLoad ( EventArgs e ) [protected]

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

Parameters:

A System.EventArgs.

Definition at line 404 of file DataGrid.cs.

override void Anthem.DataGrid.RenderControl ( HtmlTextWriter writer )

Forces the server control to output content and trace information.

Definition at line 414 of file DataGrid.cs.

Property Documentation

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

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

Definition at line 141 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue(true)][Description("True if this control uses callbacks instead of postbacks to post data to the server.")] virtual bool Anthem.DataGrid.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.

Definition at line 167 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue(true)][Description("True if this control is enabled on the client during callbacks.")] virtual bool Anthem.DataGrid.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.

Definition at line 194 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue("")][Description("The javascript function to call on the client after the callback response is received.")] virtual string Anthem.DataGrid.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 &amp;&amp; result.error.length &gt; 0) {
                alert(result.error);
              }
            }

Definition at line 231 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue("")][Description("The javascript function to call on the client before the callback is made.")] virtual string Anthem.DataGrid.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.

Definition at line 256 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue("")][Description("The text to display during the callback.")] virtual string Anthem.DataGrid.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.

Definition at line 284 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue(true)][Description("True if this control should convert child control postbacks into callbacks.")] virtual bool Anthem.DataGrid.AddCallBacks [get, set]

Gets or sets a value indicating whether the control should convert child control postbacks into callbacks.

true if the control should convert child control postbacks to callbacks; otherwise, false. The default is true.

Only controls that Anthem.Manager recognizes will be converted.

Implements Anthem.ICallBackContainerControl.

Definition at line 319 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

[Category("Anthem")][DefaultValue(false)][Description("True if this control should be updated after each callback.")] virtual bool Anthem.DataGrid.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 355 of file DataGrid.cs.

[Browsable(false)][DefaultValue(false)] virtual bool Anthem.DataGrid.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 390 of file DataGrid.cs.

override bool Anthem.DataGrid.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 429 of file DataGrid.cs.

Referenced by Anthem.DataGrid.Render().

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

D:/Projects/Anthem/Anthem/DataGrid.cs

Generated on Wed Mar 14 23:50:40 2007 for Anthem by

1.5.1-p1

Anthem.DataGrid Class Reference

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation