Files
mono/mcs/class/System.Web.Extensions/System.Web.UI/UpdatePanel.cs
T
Marek Habersack b0ef88b86f 2009-04-11 Marek Habersack <[email protected]>
* UpdatePanel.cs: implemented SingleChildControlCollection to be
	used in CreateControlCollection ().
	RequiresUpdate not only checks the update mode and explicit update
	requests, but also looks if any triggers fired.
	Initialize () initializes triggers only if partial rendering is
	supported by the ScriptManager.
	IsInPartialRendering property no longer returns the value of
	ScriptManager.IsInPartialRendering. Instead, it relies on the
	value of instance field which can be set using new internal
	SetInPartialRendering () method (called from
	ScriptManager.RenderPageCallback ())
	Simplified the logic in RenderChildren ().

	* ScriptManager.cs: no need to register panels for refresh in
	OnPreRenderComplete, this is now done in RenderPageCallback.
	Modified HasBeenRendered () so that it doesn't query whether the
	panel has been explicitly updated by the user, but checks whether
	panel is in the list of panels to refresh.
	RaisePostDataChangedEvent () doesn't update the panel whose id is
	named in the POST request for refresh. This is handled in
	RenderPageCallback.
	Reverted the changes to WriteCallbackPanel and RenderFormCallback
	committed in r129774.
	RenderPageCallback now correctly detects panels to be refreshed
	(and thus included in the async response).

	* AsyncPostBackTrigger.cs, PostBackTrigger.cs: implemented
	HasTriggered ().

svn path=/trunk/mcs/; revision=131511
2009-04-11 13:36:46 +00:00

294 lines
8.2 KiB
C#

//
// UpdatePanel.cs
//
// Author:
// Igor Zelmanovich <[email protected]>
//
// (C) 2007 Mainsoft, Inc. http://www.mainsoft.com
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel;
using System.Security.Permissions;
using System.IO;
namespace System.Web.UI
{
[DesignerAttribute ("System.Web.UI.Design.UpdatePanelDesigner, System.Web.Extensions.Design, Version=1.0.61025.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")]
[DefaultPropertyAttribute ("Triggers")]
[ParseChildrenAttribute (true)]
[PersistChildrenAttribute (false)]
[AspNetHostingPermissionAttribute (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class UpdatePanel : Control
{
sealed class SingleChildControlCollection : ControlCollection
{
public SingleChildControlCollection (Control owner)
: base (owner)
{}
internal void AddInternal (Control child)
{
base.Add (child);
}
public override void Add (Control child)
{
throw GetNoChildrenException ();
}
public override void AddAt (int index, Control child)
{
throw GetNoChildrenException ();
}
public override void Clear ()
{
throw GetNoChildrenException ();
}
public override void Remove (Control value)
{
throw GetNoChildrenException ();
}
public override void RemoveAt (int index)
{
throw GetNoChildrenException ();
}
InvalidOperationException GetNoChildrenException ()
{
return new InvalidOperationException ("The Controls property of UpdatePanel with ID '" + Owner.ID + "' cannot be modified directly. To change the contents of the UpdatePanel modify the child controls of the ContentTemplateContainer property.");
}
}
ITemplate _contentTemplate;
Control _contentTemplateContainer;
UpdatePanelUpdateMode _updateMode = UpdatePanelUpdateMode.Always;
bool _childrenAsTriggers = true;
bool _requiresUpdate;
bool _inPartialRendering;
UpdatePanelTriggerCollection _triggers;
UpdatePanelRenderMode _renderMode = UpdatePanelRenderMode.Block;
ScriptManager _scriptManager;
[Category ("Behavior")]
[DefaultValue (true)]
public bool ChildrenAsTriggers {
get {
return _childrenAsTriggers;
}
set {
_childrenAsTriggers = value;
}
}
[TemplateInstance (TemplateInstance.Single)]
[PersistenceMode (PersistenceMode.InnerProperty)]
[Browsable (false)]
public ITemplate ContentTemplate {
get {
return _contentTemplate;
}
set {
_contentTemplate = value;
}
}
[Browsable (false)]
public Control ContentTemplateContainer {
get {
if (_contentTemplateContainer == null) {
_contentTemplateContainer = CreateContentTemplateContainer ();
((SingleChildControlCollection) Controls).AddInternal (_contentTemplateContainer);
}
return _contentTemplateContainer;
}
}
public override sealed ControlCollection Controls {
get { return base.Controls; }
}
[Browsable (false)]
public bool IsInPartialRendering {
get { return _inPartialRendering; }
}
[Category ("Layout")]
public UpdatePanelRenderMode RenderMode {
get {
return _renderMode;
}
set {
_renderMode = value;
}
}
protected internal virtual bool RequiresUpdate {
get {
return UpdateMode == UpdatePanelUpdateMode.Always || _requiresUpdate || AnyTriggersFired ();
}
}
internal ScriptManager ScriptManager {
get {
if (_scriptManager == null) {
_scriptManager = ScriptManager.GetCurrent (Page);
if (_scriptManager == null)
throw new InvalidOperationException (String.Format ("The control with ID '{0}' requires a ScriptManager on the page. The ScriptManager must appear before any controls that need it.", ID));
}
return _scriptManager;
}
}
[MergableProperty (false)]
[DefaultValue ("")]
[PersistenceMode (PersistenceMode.InnerProperty)]
[Category ("Behavior")]
public UpdatePanelTriggerCollection Triggers {
get {
if (_triggers == null)
_triggers = new UpdatePanelTriggerCollection (this);
return _triggers;
}
}
bool AnyTriggersFired ()
{
if (_triggers == null || _triggers.Count == 0)
return false;
foreach (UpdatePanelTrigger trigger in _triggers)
if (trigger.HasTriggered ())
return true;
return false;
}
[Category ("Behavior")]
[DefaultValueAttribute (UpdatePanelUpdateMode.Always)]
public UpdatePanelUpdateMode UpdateMode {
get {
return _updateMode;
}
set {
_updateMode = value;
}
}
protected virtual Control CreateContentTemplateContainer ()
{
return new Control ();
}
protected override sealed ControlCollection CreateControlCollection ()
{
return new SingleChildControlCollection (this);
}
protected internal virtual void Initialize ()
{
int tcount = _triggers != null ? _triggers.Count : 0;
if (tcount == 0 || !ScriptManager.SupportsPartialRendering)
return;
for (int i = 0; i < tcount; i++)
_triggers [i].Initialize ();
}
protected override void OnInit (EventArgs e) {
base.OnInit (e);
ScriptManager.RegisterUpdatePanel (this);
if (ContentTemplate != null)
ContentTemplate.InstantiateIn (ContentTemplateContainer);
}
protected override void OnLoad (EventArgs e) {
base.OnLoad (e);
Initialize ();
}
protected override void OnPreRender (EventArgs e) {
base.OnPreRender (e);
if (UpdateMode == UpdatePanelUpdateMode.Always && !ChildrenAsTriggers)
throw new InvalidOperationException (String.Format ("ChildrenAsTriggers cannot be set to false when UpdateMode is set to Always on UpdatePanel '{0}'", ID));
}
protected override void OnUnload (EventArgs e) {
base.OnUnload (e);
}
protected override void Render (HtmlTextWriter writer) {
writer.AddAttribute (HtmlTextWriterAttribute.Id, ClientID);
if (RenderMode == UpdatePanelRenderMode.Block)
writer.RenderBeginTag (HtmlTextWriterTag.Div);
else
writer.RenderBeginTag (HtmlTextWriterTag.Span);
RenderChildren (writer);
writer.RenderEndTag ();
}
protected override void RenderChildren (HtmlTextWriter writer)
{
if (IsInPartialRendering) {
ScriptManager.AlternativeHtmlTextWriter altWriter = writer as ScriptManager.AlternativeHtmlTextWriter;
if (altWriter == null)
altWriter = writer.InnerWriter as ScriptManager.AlternativeHtmlTextWriter;
if (altWriter == null)
throw new InvalidOperationException ("Internal error. Invalid writer object.");
HtmlTextWriter responseOutput = altWriter.ResponseOutput;
StringBuilder sb = new StringBuilder ();
HtmlTextWriter w = new HtmlTextWriter (new StringWriter (sb));
base.RenderChildren (w);
w.Flush ();
ScriptManager.WriteCallbackPanel (responseOutput, this, sb);
} else
base.RenderChildren (writer);
}
internal void SetInPartialRendering (bool setting)
{
_inPartialRendering = setting;
}
public void Update ()
{
if (UpdateMode == UpdatePanelUpdateMode.Always)
throw new InvalidOperationException ("The Update method can only be called on UpdatePanel with ID '" + ID + "' when UpdateMode is set to Conditional.");
_requiresUpdate = true;
}
}
}