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:
property String^ Documentation {
	String^ get ();
	void set (String^ value);
}
/** @property */
public String get_Documentation ()

/** @property */
public void set_Documentation (String value)

public function get Documentation () : String

public function set Documentation (value : String)

Not applicable.

Property Value

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.dll>
#using <System.Xml.dll>
#using <System.Web.Services.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Web::Services::Description;
using namespace System::Collections;

// Prints documentation associated with a wsdl element.
void PrintDocumentation( DocumentableItem^ myItem )
{
   Console::WriteLine( "\t {0}", myItem->Documentation );
}

int main()
{
   ServiceDescription^ myServiceDescription = ServiceDescription::Read( "MathService_cpp.wsdl" );
   Console::WriteLine( "Documentation Element for type is " );
   PrintDocumentation( myServiceDescription->Types );
   IEnumerator^ myEnum = myServiceDescription->PortTypes->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      PortType^ myPortType = safe_cast<PortType^>(myEnum->Current);
      Console::WriteLine( "Documentation Element for Port Type {0} is ", myPortType->Name );
      PrintDocumentation( myPortType );
   }

   myEnum = myServiceDescription->Bindings->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Binding^ myBinding = safe_cast<Binding^>(myEnum->Current);
      Console::WriteLine( "Documentation Element for Port Type {0} is ", myBinding->Name );
      PrintDocumentation( myBinding );
   }
}

import System.*;
import System.Web.Services.Description.*;

class DocumentableItemSample
{
    public static void main(String[] args)
    {
        ServiceDescription myServiceDescription = 
            ServiceDescription.Read("MathService_jsl.wsdl");

        Console.WriteLine("Documentation Element for type is ");
        PrintDocumentation(myServiceDescription.get_Types());
        PortType myPortType = null;
        for (int iCtr=0; iCtr< myServiceDescription.get_PortTypes().
            get_Count(); iCtr++ ) {
            myPortType = myServiceDescription.get_PortTypes().get_Item(iCtr);
            Console.WriteLine("Documentation Element for Port Type {0} is ",
                myPortType.get_Name());
            PrintDocumentation(myPortType);
        }
        Binding myBinding = null;
        for (int iCtr=0; iCtr< myServiceDescription.get_Bindings().
            get_Count(); iCtr++ ) {
            myBinding = myServiceDescription.get_Bindings().get_Item(iCtr);
            Console.WriteLine("Documentation Element for Port Type {0} is ",
                myBinding.get_Name());
            PrintDocumentation(myBinding);
        }
    } //main

    // Prints documentation associated with a wsdl element.
    public static void PrintDocumentation(DocumentableItem myItem)
    {
        Console.WriteLine("\t" + myItem.get_Documentation());
    } //PrintDocumentation
} //DocumentableItemSample

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: