DiscoveryClientProtocol.Documents Property
Gets a collection of discovery documents.
[Visual Basic] Public ReadOnly Property Documents As _ DiscoveryClientDocumentCollection [C#] public DiscoveryClientDocumentCollection Documents {get;} [C++] public: __property DiscoveryClientDocumentCollection* get_Documents(); [JScript] public function get Documents() : DiscoveryClientDocumentCollection;
Property Value
A DiscoveryClientDocumentCollection representing the collection of discovery documents found.
Remarks
The Documents collection is populated during invocations to the Discover, DiscoverAny, ResolveAll and ResolveOneLevel methods. During invocations to the Discover and DiscoverAny methods, if the supplied URL is a valid discovery document, that document is added to the Documents collection. During invocations to the ResolveAll and ResolveOneLevel methods, valid discovery document references in the References collection are added to the Documents collection.
Example
[Visual Basic, C#] The following code example is a Web Form that populates a DataGrid with the details about the documents in the Documents property discovered during XML Web services discovery. The PopulateGrid method fills the DataGrid with the results from a DiscoverAny invocation followed by a call to ResolveAll.
[Visual Basic] <%@ Page Language="VB" Debug="true" %> <%@ Import Namespace="System.IO" %> <%@ Import Namespace="System.Web.Services.Discovery" %> <%@ Import Namespace="System.Net" %> <%@ Import Namespace="System.Data" %> <HTML> <HEAD> <SCRIPT RUNAT="SERVER"> Public Sub Discover_Click(Source As Object, e as EventArgs ) ' Specify the URL to discover. Dim sourceUrl as String = DiscoURL.Text ' Specify the URL to save discovery results to or read from. Dim outputDirectory As String = DiscoDir.Text Dim client as DiscoveryClientProtocol = new DiscoveryClientProtocol() ' Use default credentials to access the URL being discovered. client.Credentials = CredentialCache.DefaultCredentials Try Dim doc As DiscoveryDocument ' Discover the URL for any discoverable documents. doc = client.DiscoverAny(sourceUrl) ' Resolve all possible references from the supplied URL. client.ResolveAll() Catch e2 As Exception DiscoveryResultsGrid.Columns.Clear() Status.Text = e2.Message End Try ' If documents were discovered, display the results in a data grid. If (client.Documents.Count > 0) Then 'populate our Grid with the discovery results PopulateGrid(client) End If ' Save the discovery results to disk. Dim results As DiscoveryClientResultCollection results = client.WriteAll(outputDirectory, "results.discomap") Status.Text = "The following file holds the links to each of the discovery results: <b>" + _ Path.Combine(outputDirectory,"results.discomap") + "</b>" End Sub Public Sub PopulateGrid(client As DiscoveryClientProtocol) Dim dt As DataTable = new DataTable() Dim dr AS DataRow dt.Columns.Add(new DataColumn("Discovery Document") ) dt.Columns.Add(new DataColumn("References") ) dt.Columns.Add(new DataColumn("Type") ) Dim entry As DictionaryEntry 'Iterate over the discovered documents, displaying their types and any associated references. For Each entry in client.Documents dr = dt.NewRow() dr(0) = entry.Key dr(2) = entry.Value.GetType() dt.Rows.Add(dr) ' If the discovered document is a discovery document, iterate over its references. If TypeOf entry.Value Is DiscoveryDocument Then Dim discoDoc As DiscoveryDocument = entry.Value Dim discoref As DiscoveryReference For Each discoref in discoDoc.References dr = dt.NewRow() dr(1) = discoref.Url dr(2) = discoref.GetType() dt.Rows.Add(dr) Next End If Next Dim dv As DataView = new DataView(dt) DiscoveryResultsGrid.DataSource = dv DiscoveryResultsGrid.DataBind() End Sub </SCRIPT> </HEAD> <BODY> <H3> <p align="center"> Discovery Class Sample </p> </H3> <FORM RUNAT="SERVER"> <hr> Enter the URL to discover: <asp:textbox id=DiscoURL Columns=60 runat="SERVER" /><p> Enter the directory to Read/Save the Discovery results: <asp:textbox id=DiscoDir runat="SERVER" /> <p> <p align="center"> <asp:Button id=Discover Text="Discover!" onClick="Discover_Click" runat="SERVER"/> </p><p> <hr> <asp:label id="Status" runat="SERVER" /><p> <asp:DataGrid id="DiscoveryResultsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="true" runat="server"> <HeaderStyle BackColor="DarkBlue" ForeColor="White"> </HeaderStyle> <AlternatingItemStyle BackColor="LightYellow"> </AlternatingItemStyle> </asp:DataGrid> </FORM> </BODY> [C#] <%@ Page Language="C#" Debug="true" %> <%@ Import Namespace="System.Web.Services.Discovery" %> <%@ Import Namespace="System.IO" %> <%@ Import Namespace="System.Net" %> <%@ Import Namespace="System.Data" %> <HTML> <HEAD> <SCRIPT RUNAT="SERVER"> protected void Discover_Click(object Source, EventArgs e) { // Specify the URL to discover. string sourceUrl = DiscoURL.Text; // Specify the URL to save discovery results to or read from. string outputDirectory = DiscoDir.Text; DiscoveryClientProtocol client = new DiscoveryClientProtocol(); // Use default credentials to access the URL being discovered. client.Credentials = CredentialCache.DefaultCredentials; try { DiscoveryDocument doc; // Discover the URL for any discoverable documents. doc = client.DiscoverAny(sourceUrl); // Resolve all possible references from the supplied URL. client.ResolveAll(); } catch ( Exception e2) { DiscoveryResultsGrid.Columns.Clear(); Status.Text = e2.Message; } // If documents were discovered, display the results in a data grid. if (client.Documents.Count > 0) PopulateGrid(client); // Save the discovery results to disk. DiscoveryClientResultCollection results = client.WriteAll(outputDirectory, "results.discomap"); Status.Text = "The following file holds the links to each of the discovery results: <b>" + Path.Combine(outputDirectory,"results.discomap") + "</b>"; } protected void PopulateGrid(DiscoveryClientProtocol client) { DataTable dt = new DataTable(); DataRow dr; dt.Columns.Add(new DataColumn("Discovery Document") ); dt.Columns.Add(new DataColumn("References") ); dt.Columns.Add(new DataColumn("Type") ); // Iterate over the discovered documents, displaying their types and any associated references. foreach (DictionaryEntry entry in client.Documents) { dr = dt.NewRow(); dr[0] = (string) entry.Key; dr[2] = entry.Value.GetType(); dt.Rows.Add(dr); // If the discovered document is a discovery document, iterate over its references. if (entry.Value is DiscoveryDocument) { DiscoveryDocument discoDoc = (DiscoveryDocument) entry.Value; foreach (DiscoveryReference discoref in discoDoc.References) { dr = dt.NewRow(); dr[1] = discoref.Url; dr[2] = discoref.GetType(); dt.Rows.Add(dr); } } } DataView dv = new DataView(dt); DiscoveryResultsGrid.DataSource = (ICollection) dv; DiscoveryResultsGrid.DataBind(); } </SCRIPT> </HEAD> <BODY> <H3> <p align="center"> Discovery Class Sample </p> </H3> <FORM RUNAT="SERVER"> <hr> Enter the URL to discover: <asp:textbox id=DiscoURL Columns=60 runat="SERVER" /><p> Enter the directory to Read/Save the Discovery results: <asp:textbox id=DiscoDir runat="SERVER" /> <p> <p align="center"> <asp:Button id=Discover Text="Discover!" onClick="Discover_Click" runat="SERVER"/> </p><p> <hr> <asp:label id="Status" runat="SERVER" /><p> <asp:DataGrid id="DiscoveryResultsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="true" runat="server"> <HeaderStyle BackColor="DarkBlue" ForeColor="White"> </HeaderStyle> <AlternatingItemStyle BackColor="LightYellow"> </AlternatingItemStyle> </asp:DataGrid> </FORM> </BODY>
[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic 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
DiscoveryClientProtocol Class | DiscoveryClientProtocol Members | System.Web.Services.Discovery Namespace | DiscoveryClientDocumentCollection | DiscoverAny | Discover | ResolveOneLevel | ResolveAll