mcs/class/System.Web.Extensions/System.Web.UI/ExtenderControl.cs

   1 //
   2 // ExtenderControl.cs
   3 //
   4 // Author:
   5 //   Igor Zelmanovich <igorz@mainsoft.com>
   6 //
   7 // (C) 2007 Mainsoft, Inc.  http://www.mainsoft.com
   8 //
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29
  30 using System;
  31 using System.Collections.Generic;
  32 using System.Text;
  33 using System.ComponentModel;
  34
  35 namespace System.Web.UI
  36 {
  37         [DefaultProperty ("TargetControlID")]
  38         [ParseChildren (true)]
  39         [NonVisualControl]
  40         [PersistChildren (false)]
  41         public abstract class ExtenderControl : Control, IExtenderControl
  42         {
  43                 ScriptManager _scriptManager;
  44                 string _targetControlID;
  45
  46                 protected ExtenderControl () { }
  47
  48                 [DefaultValue ("")]
  49                 [IDReferenceProperty]
  50                 [Category ("Behavior")]
  51                 public string TargetControlID {
  52                         get {
  53                                 if (_targetControlID == null)
  54                                         return String.Empty;
  55                                 return _targetControlID;
  56                         }
  57                         set { _targetControlID = value; }
  58                 }
  59
  60                 [Browsable (false)]
  61                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
  62                 [EditorBrowsable (EditorBrowsableState.Never)]
  63                 public override bool Visible {
  64                         get {
  65                                 return base.Visible;
  66                         }
  67                         set {
  68                                 throw new NotImplementedException ();
  69                         }
  70                 }
  71
  72                 ScriptManager ScriptManager {
  73                         get {
  74                                 if (_scriptManager == null) {
  75                                         _scriptManager = ScriptManager.GetCurrent (Page);
  76                                         if (_scriptManager == null)
  77                                                 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));
  78                                 }
  79                                 return _scriptManager;
  80                         }
  81                 }
  82
  83                 protected abstract IEnumerable<ScriptDescriptor> GetScriptDescriptors (Control targetControl);
  84
  85                 protected abstract IEnumerable<ScriptReference> GetScriptReferences ();
  86
  87                 protected internal override void OnPreRender (EventArgs e) {
  88                         base.OnPreRender (e);
  89
  90                         if (String.IsNullOrEmpty (TargetControlID))
  91                                 throw new InvalidOperationException (String.Format ("The TargetControlID of '{0}' is not valid. The value cannot be null or empty.", ID));
  92                         Control c = FindControl (TargetControlID);
  93                         if (c == null)
  94                                 throw new InvalidOperationException (String.Format ("The TargetControlID of '{0}' is not valid. A control with ID '{1}' could not be found.", ID, TargetControlID));
  95
  96                         ScriptManager.RegisterExtenderControl (this, c);
  97                 }
  98
  99                 protected internal override void Render (HtmlTextWriter writer) {
 100                         ScriptManager.RegisterScriptDescriptors (this);
 101                         base.Render (writer);
 102                 }
 103
 104                 #region IExtenderControl Members
 105
 106                 IEnumerable<ScriptDescriptor> IExtenderControl.GetScriptDescriptors (Control targetControl) {
 107                         return GetScriptDescriptors (targetControl);
 108                 }
 109
 110                 IEnumerable<ScriptReference> IExtenderControl.GetScriptReferences () {
 111                         return GetScriptReferences ();
 112                 }
 113
 114                 #endregion
 115         }
 116 }