DocumentableItem.Documentation Property
Gets or sets the text documentation for the instance of the DocumentableItem.
[Visual Basic] Public Property Documentation As String [C#] public string Documentation {get; set;} [C++] public: __property String* get_Documentation(); public: __property void set_Documentation(String*); [JScript] public function get Documentation() : String; public function set Documentation(String);
Property Value
A string representing the documentation for the DocumentableItem.
Remarks
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 ("").
Example
[Visual Basic, C#, C++] The following example demonstrates a typical usage of the Documentation property.
[Visual Basic] Imports System Imports System.Web.Services.Description Imports Microsoft.VisualBasic Class DocumentableItemSample Public Shared Sub Main() Dim myServiceDescription As ServiceDescription = _ ServiceDescription.Read("MathService_vb.wsdl") Console.WriteLine("Documentation Element for type is ") PrintDocumentation(myServiceDescription.Types) Dim myPortType As PortType For Each myPortType In myServiceDescription.PortTypes Console.WriteLine("Documentation Element for Port Type {0} is ", myPortType.Name) PrintDocumentation(myPortType) Next myPortType Dim myBinding As Binding For Each myBinding In myServiceDescription.Bindings Console.WriteLine("Documentation Element for Port Type {0} is ", myBinding.Name) PrintDocumentation(myBinding) Next myBinding End Sub 'Main ' Prints documentation associated with a wsdl element. Public Shared Sub PrintDocumentation(myItem As DocumentableItem) Console.WriteLine(ControlChars.Tab + myItem.Documentation) End Sub 'PrintDocumentation End Class 'DocumentableItemSample [C#] 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 "); PrintDocumentation(myServiceDescription.Types); foreach(PortType myPortType in myServiceDescription.PortTypes) { Console.WriteLine("Documentation Element for Port Type {0} is ",myPortType.Name); PrintDocumentation(myPortType); } foreach(Binding myBinding in myServiceDescription.Bindings) { Console.WriteLine("Documentation Element for Port Type {0} is ",myBinding.Name); PrintDocumentation(myBinding); } } // Prints documentation associated with a wsdl element. public static void PrintDocumentation(DocumentableItem myItem) { Console.WriteLine("\t" + myItem.Documentation); } } [C++] #using <mscorlib.dll> #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(S"\t {0}", myItem -> Documentation); } int main() { ServiceDescription * myServiceDescription = ServiceDescription::Read(S"MathService_cs.wsdl"); Console::WriteLine(S"Documentation Element for type is "); PrintDocumentation(myServiceDescription->Types); IEnumerator* myEnum = myServiceDescription->PortTypes->GetEnumerator(); while (myEnum->MoveNext()) { PortType* myPortType = __try_cast<PortType*>(myEnum->Current); Console::WriteLine(S"Documentation Element for Port Type {0} is ", myPortType -> Name); PrintDocumentation(myPortType); } myEnum = myServiceDescription->Bindings->GetEnumerator(); while (myEnum->MoveNext()) { Binding* myBinding = __try_cast<Binding*>(myEnum->Current); Console::WriteLine(S"Documentation Element for Port Type {0} is ", myBinding -> Name); PrintDocumentation(myBinding); } }
[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family
See Also
DocumentableItem Class | DocumentableItem Members | System.Web.Services.Description Namespace