リスト アイテムを返す

このプログラミング タスクでは、Lists Web サービスの GetListItems メソッドを使用して、リストにあるアイテムを返す Windows フォームを作成する方法を示します。

手順

始める前に、「Visual Studio で SharePoint Web サイトのプログラムによるカスタマイズ作業を開始する」で示された Windows アプリケーションを作成します。Windows SharePoint Services の Web サービスへの Web 参照を設定する方法については、「Windows SharePoint Services Web サービスの紹介」を参照してください。

リスト アイテムのコレクションを表示するコードを追加するには

1. Windows Application プロジェクトを作成して Web 参照を追加した後、[フォーム 1] をデザイン ビューで開き、[ツールボックス] を開きます。次に、Label コントロールと Button コントロールをフォームにドラッグします。

2. Label1 コントロールを右クリックし、[プロパティ] をクリックして、コントロールの Text プロパティから [ラベル 1] を削除します。

3. ボタンをダブルクリックしてコード エディタを表示し、以下のコード行を Click イベント ハンドラに追加します。

   'Declare and initialize a variable for the Lists Web service.
   Dim listService As New Web_Reference.Lists()
   
   'Authenticate the current user by passing their default 
   'credentials to the Web service from the system credential cache.
   listService.Credentials = System.Net.CredentialCache.DefaultCredentials
   
   'Set the Url property of the service for the path to a subsite.
   listService.Url = "http://Server_Name/Subsite_Name/_vti_bin/Lists.asmx"
   
   'Instantiate an XmlDocument object.
   Dim xmlDoc As New System.Xml.XmlDocument()
   
   'Assign values to the string parameters of the GetListItems method, 'using GUIDs for the listName and viewName variables. For listName, 'using the list display name will also work, but using the list GUID 
   'is recommended. For viewName, only the view GUID can be used. 
   'Using an empty string for viewName causes the default view 
   'to be used.
   Dim listName As String = "{17991794-81BB-494F-9910-CFBF1093A7CF}"
   Dim viewName As String = "{7137FFF8-48FF-4C69-8C76-0E3BBD1EA7F9}"
   Dim rowLimit As String = "150"
   
   'Use the CreateElement method of the document object to create 'elements for the parameters that use XML.
   Dim query As System.Xml.XmlElement = xmlDoc.CreateElement("Query")
   Dim viewFields As System.Xml.XmlElement = xmlDoc.CreateElement("ViewFields")
   Dim queryOptions As System.Xml.XmlElement = xmlDoc.CreateElement("QueryOptions")
   
   'To specify values for the parameter elements (optional), assign CAML fragments to the InnerXml property of each element.
   query.InnerXml = "<Where><Gt><FieldRef Name=""ID"" />" + "<Value Type=""Counter"">3</Value></Gt></Where>"
   viewFields.InnerXml = "<FieldRef Name=""Title"" />"
   queryOptions.InnerXml = ""
   
   'Declare an XmlNode object and initialize it with the XML response 'from the GetListItems method. The last parameter specifies 
   'the GUID of the Web site containing the list. Setting it to 
   'Nothing causes the Web site specified by the Url property 
   'to be used.
   Dim nodeListItems As System.Xml.XmlNode = listService.GetListItems(listName, viewName, query, viewFields, rowLimit, queryOptions, Nothing)
   
   'Loop through each node in the XML response and display each item.
   Dim listItem As System.Xml.XmlNode
   For Each listItem In  nodeListItems
      label1.Text += listItem.OuterXml
   Next listItem
   

   /*Declare and initialize a variable for the Lists Web service.*/
   Web_Reference.Lists listService = new Web_Reference.Lists();
   
   /*Authenticate the current user by passing their default 
   credentials to the Web service from the system credential cache.*/
   listService.Credentials = 
       System.Net.CredentialCache.DefaultCredentials;
   
   /*Set the Url property of the service for the path to a subsite.*/
   listService.Url = 
       "http://Server_Name/Subsite_Name/_vti_bin/Lists.asmx";
   
   // Instantiate an XmlDocument object
   System.Xml.XmlDocument xmlDoc = new System.Xml.XmlDocument();
   
   /* Assign values to the string parameters of the GetListItems method, using GUIDs for the listName and viewName variables. For listName, using the list display name will also work, but using the list GUID is recommended. For viewName, only the view GUID can be used. Using an empty string for viewName causes the default view 
   to be used.*/
   string listName = "{17991794-81BB-494F-9910-CFBF1093A7CF}";
   string viewName = "{7137FFF8-48FF-4C69-8C76-0E3BBD1EA7F9}";
   string rowLimit = "150";
   
   /*Use the CreateElement method of the document object to create elements for the parameters that use XML.*/
   System.Xml.XmlElement query = xmlDoc.CreateElement("Query");
   System.Xml.XmlElement viewFields = 
       xmlDoc.CreateElement("ViewFields");
   System.Xml.XmlElement queryOptions = 
       xmlDoc.CreateElement("QueryOptions");
   
   /*To specify values for the parameter elements (optional), assign CAML fragments to the InnerXml property of each element.*/
   query.InnerXml = "<Where><Gt><FieldRef Name=\"ID\" />" +
       "<Value Type=\"Counter\">3</Value></Gt></Where>";
   viewFields.InnerXml = "<FieldRef Name=\"Title\" />";
   queryOptions.InnerXml = "";
   
   /* Declare an XmlNode object and initialize it with the XML response from the GetListItems method. The last parameter specifies the GUID of the Web site containing the list. Setting it to null causes the Web site specified by the Url property to be used.*/
   System.Xml.XmlNode nodeListItems = 
       listService.GetListItems
       (listName, viewName,query,viewFields,rowLimit,queryOptions,null);
   
   /*Loop through each node in the XML response and display each item.*/
   foreach (System.Xml.XmlNode listItem in nodeListItems)
   {
       label1.Text += listItem.OuterXml;
   }
   

   注意

   この例で使用されている listName、viewName、および rowLimit 変数に対し、独自の値を指定する必要があります。

4. [デバッグ] メニューの [開始] をクリックして、フォームをテストします。[ボタン 1] をクリックして、指定したリストのリスト項目を表示します。