Documentation Property
Collapse the table of content
Expand the table of content
This documentation is archived and is not being maintained.

DocumentableItem.Documentation Property

Gets or sets the text documentation for the instance of the DocumentableItem.

Namespace:  System.Web.Services.Description
Assembly:  System.Web.Services (in System.Web.Services.dll)

public string Documentation { get; set; }

Property Value

Type: System.String
A string that represents the documentation for the DocumentableItem.

In a derived class, this property represents the text comments added to an element of the XML Web service. The default implementation is an empty string ("").

The following code example demonstrates a typical usage of the Documentation property.

using System;
using System.Web.Services.Description;

class DocumentableItemSample
   public static void Main()
      ServiceDescription myServiceDescription = ServiceDescription.Read("MathService_cs.wsdl");
      Console.WriteLine("Documentation Element for type is ");
      foreach(PortType myPortType in myServiceDescription.PortTypes)
         Console.WriteLine("Documentation Element for Port Type {0} is ",myPortType.Name);
      foreach(Binding myBinding in myServiceDescription.Bindings)
         Console.WriteLine("Documentation Element for Port Type {0} is ",myBinding.Name);
   // Prints documentation associated with a wsdl element.
   public static void PrintDocumentation(DocumentableItem myItem)
      Console.WriteLine("\t" + myItem.Documentation);

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
© 2016 Microsoft