2 // System.Web.UI.TemplateControl.cs
5 // Duncan Mak (duncan@ximian.com)
6 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
7 // Andreas Nahr (ClassDevelopment@A-SoftTech.com)
9 // (C) 2002 Ximian, Inc. (http://www.ximian.com)
10 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Collections;
33 using System.ComponentModel;
34 using System.Reflection;
35 using System.Security.Permissions;
36 using System.Web.Compilation;
37 using System.Web.Util;
40 namespace System.Web.UI {
43 [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
44 [AspNetHostingPermission (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
46 public abstract class TemplateControl : Control, INamingContainer, IFilterResolutionService {
48 public abstract class TemplateControl : Control, INamingContainer {
50 static readonly Assembly _System_Web_Assembly = typeof (TemplateControl).Assembly;
51 static object abortTransaction = new object ();
52 static object commitTransaction = new object ();
53 static object error = new object ();
54 static string [] methodNames = { "Page_Init",
59 "Page_PreRenderComplete",
60 "Page_SaveStateComplete",
69 "Page_AbortTransaction",
70 "Page_CommitTransaction"};
72 const BindingFlags bflags = BindingFlags.Public |
73 BindingFlags.NonPublic |
74 BindingFlags.Instance;
77 string _appRelativeVirtualPath;
81 protected TemplateControl ()
84 TemplateControl = this;
92 [EditorBrowsable (EditorBrowsableState.Never)]
96 protected virtual int AutoHandlers {
101 [EditorBrowsable (EditorBrowsableState.Never)]
102 protected virtual bool SupportAutoEvents {
107 public string AppRelativeVirtualPath {
108 get { return _appRelativeVirtualPath; }
109 set { _appRelativeVirtualPath = value; }
117 protected virtual void Construct ()
121 [MonoTODO ("Not implemented")]
122 protected LiteralControl CreateResourceBasedLiteralControl (int offset,
129 internal void WireupAutomaticEvents ()
131 if (!SupportAutoEvents || !AutoEventWireup)
134 foreach (string methodName in methodNames) {
135 MethodInfo method = null;
137 for (type = GetType (); type.Assembly != _System_Web_Assembly; type = type.BaseType) {
138 method = type.GetMethod (methodName, bflags);
145 if (method.DeclaringType != type) {
146 if (!method.IsPublic && !method.IsFamilyOrAssembly &&
147 !method.IsFamilyAndAssembly && !method.IsFamily)
151 if (method.ReturnType != typeof (void))
154 ParameterInfo [] parms = method.GetParameters ();
155 int length = parms.Length;
156 bool noParams = (length == 0);
157 if (!noParams && (length != 2 ||
158 parms [0].ParameterType != typeof (object) ||
159 parms [1].ParameterType != typeof (EventArgs)))
162 int pos = methodName.IndexOf ("_");
163 string eventName = methodName.Substring (pos + 1);
164 EventInfo evt = type.GetEvent (eventName);
166 /* This should never happen */
171 NoParamsInvoker npi = new NoParamsInvoker (this, method);
172 evt.AddEventHandler (this, npi.FakeDelegate);
174 evt.AddEventHandler (this, Delegate.CreateDelegate (
176 typeof (EventHandler), this, method));
178 typeof (EventHandler), this, methodName));
184 [EditorBrowsable (EditorBrowsableState.Never)]
185 protected virtual void FrameworkInitialize ()
189 Type GetTypeFromControlPath (string virtualPath)
191 if (virtualPath == null)
192 throw new ArgumentNullException ("virtualPath");
194 string vpath = UrlUtils.Combine (TemplateSourceDirectory, virtualPath);
195 string realpath = Context.Request.MapPath (vpath);
196 return UserControlParser.GetCompiledType (vpath, realpath, Context);
199 public Control LoadControl (string virtualPath)
202 if (virtualPath == null)
203 throw new ArgumentNullException ("virtualPath");
205 if (virtualPath == null)
206 throw new HttpException ("virtualPath is null");
208 Type type = GetTypeFromControlPath (virtualPath);
209 return LoadControl (type, null);
212 public Control LoadControl (Type type, object[] parameters)
214 object [] attrs = type.GetCustomAttributes (typeof (PartialCachingAttribute), true);
215 if (attrs != null && attrs.Length == 1) {
216 PartialCachingAttribute attr = (PartialCachingAttribute) attrs [0];
217 PartialCachingControl ctrl = new PartialCachingControl (type, parameters);
218 ctrl.VaryByParams = attr.VaryByParams;
219 ctrl.VaryByControls = attr.VaryByControls;
220 ctrl.VaryByCustom = attr.VaryByCustom;
224 object control = Activator.CreateInstance (type, parameters);
225 if (control is UserControl)
226 ((UserControl) control).InitializeAsUserControl (Page);
228 return (Control) control;
231 public ITemplate LoadTemplate (string virtualPath)
234 if (virtualPath == null)
235 throw new ArgumentNullException ("virtualPath");
237 if (virtualPath == null)
238 throw new HttpException ("virtualPath is null");
240 Type t = GetTypeFromControlPath (virtualPath);
241 return new SimpleTemplate (t);
244 protected virtual void OnAbortTransaction (EventArgs e)
246 EventHandler eh = Events [abortTransaction] as EventHandler;
251 protected virtual void OnCommitTransaction (EventArgs e)
253 EventHandler eh = Events [commitTransaction] as EventHandler;
258 protected virtual void OnError (EventArgs e)
260 EventHandler eh = Events [error] as EventHandler;
265 [MonoTODO ("Not implemented, always returns null")]
266 public Control ParseControl (string content)
269 throw new ArgumentNullException ("content");
274 [EditorBrowsable (EditorBrowsableState.Never)]
279 object ReadStringResource ()
281 throw new NotSupportedException ();
285 protected object GetGlobalResourceObject (string className, string resourceKey)
287 return HttpContext.GetGlobalResourceObject (className, resourceKey);
290 protected object GetGlobalResourceObject (string className, string resourceKey, Type objType, string propName)
292 if (String.IsNullOrEmpty (resourceKey) || String.IsNullOrEmpty (propName) ||
293 String.IsNullOrEmpty (className) || objType == null)
296 object globalObject = GetGlobalResourceObject (className, resourceKey);
297 if (globalObject == null)
300 TypeConverter converter = TypeDescriptor.GetProperties (objType) [propName].Converter;
301 if (converter == null || !converter.CanConvertFrom (globalObject.GetType ()))
304 return converter.ConvertFrom (globalObject);
307 protected object GetLocalResourceObject (string resourceKey)
309 return HttpContext.GetLocalResourceObject (VirtualPathUtility.ToAbsolute (this.AppRelativeVirtualPath),
313 protected object GetLocalResourceObject (string resourceKey, Type objType, string propName)
315 if (String.IsNullOrEmpty (resourceKey) || String.IsNullOrEmpty (propName) || objType == null)
318 object localObject = GetLocalResourceObject (resourceKey);
319 if (localObject == null)
322 TypeConverter converter = TypeDescriptor.GetProperties (objType) [propName].Converter;
323 if (converter == null || !converter.CanConvertFrom (localObject.GetType ()))
326 return converter.ConvertFrom (localObject);
330 [EditorBrowsable (EditorBrowsableState.Never)]
331 public static object ReadStringResource (Type t)
333 throw new NotSupportedException ();
336 [MonoTODO ("Not implemented, does nothing")]
337 [EditorBrowsable (EditorBrowsableState.Never)]
338 protected void SetStringResourcePointer (object stringResourcePointer,
339 int maxResourceOffset)
343 [MonoTODO ("Not implemented, does nothing")]
344 [EditorBrowsable (EditorBrowsableState.Never)]
345 protected void WriteUTF8ResourceString (HtmlTextWriter output, int offset,
346 int size, bool fAsciiOnly)
354 [WebSysDescription ("Raised when the user aborts a transaction.")]
355 public event EventHandler AbortTransaction {
356 add { Events.AddHandler (abortTransaction, value); }
357 remove { Events.RemoveHandler (abortTransaction, value); }
360 [WebSysDescription ("Raised when the user initiates a transaction.")]
361 public event EventHandler CommitTransaction {
362 add { Events.AddHandler (commitTransaction, value); }
363 remove { Events.RemoveHandler (commitTransaction, value); }
366 [WebSysDescription ("Raised when an exception occurs that cannot be handled.")]
367 public event EventHandler Error {
368 add { Events.AddHandler (error, value); }
369 remove { Events.RemoveHandler (error, value); }
374 class SimpleTemplate : ITemplate
378 public SimpleTemplate (Type type)
383 public void InstantiateIn (Control control)
385 Control template = Activator.CreateInstance (type) as Control;
386 template.SetBindingContainer (false);
387 control.Controls.Add (template);
392 protected internal object Eval (string expression)
394 return DataBinder.Eval (Page.GetDataItem(), expression);
397 protected internal string Eval (string expression, string format)
399 return DataBinder.Eval (Page.GetDataItem(), expression, format);
402 protected internal object XPath (string xpathexpression)
404 return XPathBinder.Eval (Page.GetDataItem(), xpathexpression);
407 protected internal object XPath (string xpathexpression, IXmlNamespaceResolver resolver)
409 return XPathBinder.Eval (Page.GetDataItem (), xpathexpression, null, resolver);
412 protected internal string XPath (string xpathexpression, string format)
414 return XPathBinder.Eval (Page.GetDataItem(), xpathexpression, format);
417 protected internal string XPath (string xpathexpression, string format, IXmlNamespaceResolver resolver)
419 return XPathBinder.Eval (Page.GetDataItem (), xpathexpression, format, resolver);
422 protected internal IEnumerable XPathSelect (string xpathexpression)
424 return XPathBinder.Select (Page.GetDataItem(), xpathexpression);
427 protected internal IEnumerable XPathSelect (string xpathexpression, IXmlNamespaceResolver resolver)
429 return XPathBinder.Select (Page.GetDataItem (), xpathexpression, resolver);
432 // IFilterResolutionService
434 [MonoTODO ("Not implemented")]
435 int IFilterResolutionService.CompareFilters (string filter1, string filter2)
437 throw new NotImplementedException ();
440 [MonoTODO ("Not implemented")]
441 bool IFilterResolutionService.EvaluateFilter (string filterName)
443 throw new NotImplementedException ();