class/System.Web.Services/System.Web.Services.Description/DocumentableItem.cs

   1 //
   2 // System.Web.Services.Description.DocumentableItem.cs
   3 //
   4 // Author:
   5 //   Tim Coleman (tim@timcoleman.com)
   6 //
   7 // Copyright (C) Tim Coleman, 2002
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30
  31 using System.ComponentModel;
  32 using System.Runtime.InteropServices;
  33 using System.Xml.Serialization;
  34 using System.Xml;
  35
  36 namespace System.Web.Services.Description {
  37         public abstract class DocumentableItem {
  38
  39                 #region Fields
  40
  41                 XmlElement docElement;
  42
  43 #if NET_2_0
  44                 XmlAttribute [] extAttributes;
  45                 XmlSerializerNamespaces namespaces;
  46 #endif
  47
  48                 #endregion // Fields
  49
  50                 #region Constructors
  51
  52                 protected DocumentableItem ()
  53                 {
  54                 }
  55
  56                 #endregion // Constructors
  57
  58                 #region Properties
  59
  60                 [XmlIgnore]
  61                 public string Documentation {
  62                         get {
  63                                 return docElement != null ? docElement.InnerText : "";
  64                         }
  65
  66                         set {
  67                                 if (value == null || value.Length == 0)
  68                                         docElement = null;
  69                                 else {
  70                                         XmlDocument doc = new XmlDocument ();
  71                                         docElement = doc.CreateElement ("wsdl", "documentation", "http://schemas.xmlsoap.org/wsdl/");
  72                                         docElement.InnerText = value;
  73                                 }
  74                         }
  75                 }
  76
  77                 [ComVisible (false)]
  78                 [XmlAnyElement (Name="documentation", Namespace="http://schemas.xmlsoap.org/wsdl/")]
  79                 public XmlElement DocumentationElement
  80                 {
  81                         get { return docElement; }
  82                         set { docElement = value; }
  83                 }
  84
  85 #if NET_2_0
  86                 [XmlAnyAttribute]
  87                 public XmlAttribute [] ExtensibleAttributes {
  88                         get { return extAttributes; }
  89                         set { extAttributes = value; }
  90                 }
  91
  92                 [XmlIgnore]
  93                 public abstract ServiceDescriptionFormatExtensionCollection Extensions {
  94                         get;
  95                 }
  96
  97                 [XmlNamespaceDeclarations]
  98                 public XmlSerializerNamespaces Namespaces {
  99                         get {
 100                                 if (namespaces == null)
 101                                         namespaces = new XmlSerializerNamespaces ();
 102                                 return namespaces;
 103                         }
 104                         set { namespaces = value; }
 105                 }
 106 #endif
 107
 108                 #endregion // Properties
 109         }
 110 }