次の方法で共有

Views.UpdateViewHtml メソッド (websvcViews)

  • [アーティクル]

指定したプロパティおよび値 (CAML (Collaborative Application Markup Language) の概要 および HTML の表示プロパティを含む) で、指定したビューを更新します。

名前空間: websvcViews
アセンブリ: STSSOAP (stssoap.dll 内)

構文

'宣言
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/UpdateViewHtml", RequestNamespace:="https://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace:="https://schemas.microsoft.com/sharepoint/soap/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function UpdateViewHtml ( _
    listName As String, _
    viewName As String, _
    viewProperties As XmlNode, _
    toolbar As XmlNode, _
    viewHeader As XmlNode, _
    viewBody As XmlNode, _
    viewFooter As XmlNode, _
    viewEmpty As XmlNode, _
    rowLimitExceeded As XmlNode, _
    query As XmlNode, _
    viewFields As XmlNode, _
    aggregations As XmlNode, _
    formats As XmlNode, _
    rowLimit As XmlNode _
) As XmlNode
'使用
Dim instance As Views
Dim listName As String
Dim viewName As String
Dim viewProperties As XmlNode
Dim toolbar As XmlNode
Dim viewHeader As XmlNode
Dim viewBody As XmlNode
Dim viewFooter As XmlNode
Dim viewEmpty As XmlNode
Dim rowLimitExceeded As XmlNode
Dim query As XmlNode
Dim viewFields As XmlNode
Dim aggregations As XmlNode
Dim formats As XmlNode
Dim rowLimit As XmlNode
Dim returnValue As XmlNode

returnValue = instance.UpdateViewHtml(listName, viewName, viewProperties, toolbar, viewHeader, viewBody, viewFooter, viewEmpty, rowLimitExceeded, query, viewFields, aggregations, formats, rowLimit)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/UpdateViewHtml", RequestNamespace="https://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace="https://schemas.microsoft.com/sharepoint/soap/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public XmlNode UpdateViewHtml (
    string listName,
    string viewName,
    XmlNode viewProperties,
    XmlNode toolbar,
    XmlNode viewHeader,
    XmlNode viewBody,
    XmlNode viewFooter,
    XmlNode viewEmpty,
    XmlNode rowLimitExceeded,
    XmlNode query,
    XmlNode viewFields,
    XmlNode aggregations,
    XmlNode formats,
    XmlNode rowLimit
)

パラメータ

  • listName
    リストの内部名を含む文字列。
  • viewName
    ビューの GUID を含む文字列。
  • viewProperties
    すべてのビューレベルのプロパティを属性として含む XML フラグメント。Editor、Hidden、ReadOnly、Title など。

  • toolbar
    以下の例のような、ビュー内でのツール バーのレンダリングに使用される HTML を設定し、System.Xml.XmlNode オブジェクトに割り当てることができる Toolbar 要素。

    <Toolbar Type="Standard">
  <IfEqual>
    <Expr1>
      <GetVar Name="SearchString" />
    </Expr1>
    <Expr2 />
    <Then>
    ...
</Toolbar>

  • viewHeader
    以下の例のような、ビューのヘッダーのレンダリングに使用される HTML を設定し、System.Xml.XmlNode オブジェクトに割り当てることができる ViewHeader 要素。

    <ViewHeader>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]>
  </HTML>
  ...
</ViewHeader>

  • viewBody
    以下の例のような、ビューの本文のレンダリングに使用される HTML を設定し、System.Xml.XmlNode オブジェクトに割り当てることができる ViewBody 要素。

    <ViewBody>
  <HTML>
    <![CDATA[ <TR>]]>
  </HTML>
  <Fields>
    <HTML>
      <![CDATA[ <TD Class=" ]]> 
    </HTML>
    ...
</ViewBody>

  • viewFooter
    以下の例のような、ビューのフッターのレンダリングに使用される HTML を設定し、System.Xml.XmlNode オブジェクトに割り当てることができる ViewFooter 要素。

    <ViewFooter>
  <HTML>
    <![CDATA[ </TABLE> ]]>
  </HTML>
  <IfEqual>
  ...
</ViewFooter>

  • viewEmpty
    以下の例のような、クエリがアイテムを返さない場合にページのレンダリングに使用される HTML を含む、System.Xml.XmlNode オブジェクトに割り当てることができる ViewEmpty 要素。

    <ViewEmpty>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]>
  </HTML>
  ...
</ViewEmpty>

  • rowLimitExceeded
    以下の例のような、指定した行数の上限を超える場合の代替レンダリングを指定し、System.Xml.XmlNode オブジェクトに割り当てることができる RowLimitExceeded 要素。

    <RowLimitExceeded>
  <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows>
  ...
    </td></tr></table> ]]>
  </HTML>
</RowLimitExceeded>

  • query
    返すレコードとその順序を決定するクエリを含む、System.Xml.XmlNode オブジェクトに割り当てることができる Query 要素。以下の例では、ID フィールドが 3 より小さい場合にクエリを実行し、アイテムをそのタイトル順に表示します。

    <Query>
  <Where>
    <Lt>
      <FieldRef Name="ID" />
      <Value Type="Counter">3</Value>
    </Lt>
  </Where>
  <OrderBy>
    <FieldRef Name="Title" />
  </OrderBy>
</Query>

  • viewFields
    以下の例のような、クエリで返すフィールドとその順序を指定し、System.Xml.XmlNode オブジェクトに割り当てることができる ViewFields 要素。

    <ViewFields>
  <FieldRef Name="ID" />
  <FieldRef Name="Title" />
</ViewFields>

  • aggregations
    以下の例のような、集約するフィールドを指定し、System.Xml.XmlNode オブジェクトに割り当てることができる Aggregations 要素。

    <Aggregations Value="On">
  <FieldRef Name="Title" Type="Count">
  <FieldRef Name="Number" Type="Sum">
</Aggregations>

  • formats
    以下の例のような、列のグリッド書式設定を定義し、System.Xml.XmlNode オブジェクトに割り当てることができる Formats 要素。

    <Formats>
  <FormatDef Type="RowHeight" Value="67" />
  <Format Name="Attachments">
    <FormatDef Type="ColWidth" Value="75" />
  </Format>
  <Format Name="LinkTitle">
    <FormatDef Type="WrapText" Value="1" />
    <FormatDef Type="ColWidth" Value="236" />
  </Format>
  ...
</Formats>

  • rowLimit
    ページングが開始される前にページ上に表示するアイテム数または行を指定する、System.Xml.XmlNode オブジェクトに割り当てることができる RowLimit 要素。フラグメントに Paged 属性を含めて、ビューがページ内のリスト アイテムを返すことを指定することができます。以下の例では、ページあたりのアイテム数の上限を 100 に設定します。

    <RowLimit Paged="True">100</RowLimit>

戻り値

以下の形式の、ビュー スキーマを含む、System.Xml.XmlNode オブジェクトに割り当てることができる CAML フラグメント。

<View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B}" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="https://schemas.microsoft.com/sharepoint/soap/">
  <ViewFields>
    <FieldRef Name="Attachments" />
    <FieldRef Name="LinkTitle" />
    <FieldRef Name="ID" />
    <FieldRef Name="Created" />
  </ViewFields>
  <Query>
  ...
  </Query>
  <ViewEmpty>
  ...
  </ViewEmpty>
  <GroupByHeader>
  ...
  </GroupByHeader>
  <GroupByFooter>
  ...
  </GroupByFooter>
  <ViewHeader>
  ...
  </ViewHeader>
  <ViewBody>
  ...
  </ViewBody>
  <ViewFooter>
  ...
  </ViewFooter>
  <PagedRowset>
  ...
  </PagedRowset>
  <PagedRecurrenceRowset>
  ...
  </PagedRecurrenceRowset>
  <RowLimit Paged="TRUE">100</RowLimit>
  <ViewBidiHeader>
  ...
  </ViewBidiHeader>
  <Toolbar Type="Standard">
  ...
  </Toolbar>
</View>

備考

ビュー内のクエリおよびフィールド定義のみを変更するには、UpdateView メソッドを使用します。

例

以下のコード例では、ビュー内の [フッターの表示] 領域を変更し、テキストおよび現在のサイト内のお知らせリストへのハイパーリンクを追加します。

Dim viewService As New Web_Reference_Folder.Views()
viewService.Credentials = System.Net.CredentialCache.DefaultCredentials

Dim xmlDoc = New System.Xml.XmlDocument()

Dim strViewEmpty As String = "<HTML><![CDATA[" + _
    "<TABLE width="100%" cellspacing=0 cellpadding=0 border=0>" + _
    "<tr><td>]]></HTML>" + _
    "<HTML><![CDATA[" + _
    "<TABLE ID=onetidDoclibViewTbl0 width="100%" Summary="]]>" + _
    "</HTML><ListProperty Select="Title" HTMLEncode="TRUE" />" + _
    "<HTML><![CDATA[" ]]></HTML>" + _
    "<HTML><![CDATA[border=0 rules=rows><TR>]]>" + _
    "</HTML><Fields><Switch><Expr>" + _
    "<Property Select="Name" /></Expr><Case Value="Attachments">" + _
    "<HTML><![CDATA[<TH class="ms-vh-icon">]]></HTML>" + _
    "<Field /><HTML><![CDATA[</TH>]]></HTML>" + _
    "</Case><Default><Switch><Expr>" + _
    "<Property Select="HeaderImage" /></Expr><Case Value="">" + _
    "<HTML><![CDATA[<TH class="ms-vh">]]></HTML>" + _
    "<Field /><HTML><![CDATA[</TH>]]></HTML>" + _
    "</Case><Default><HTML>" + _
    "<![CDATA[<TH class="ms-vh-icon">]]></HTML><Field />" + _
    "<HTML><![CDATA[</TH>]]></HTML></Default></Switch>" + _
    "</Default></Switch></Fields>" + _
    "<HTML><![CDATA[</TR>]]></HTML>" + _
    "<HTML><![CDATA[</TABLE>]]></HTML>" + _
    "<HTML><![CDATA[</td></tr>]]></HTML>" + _
    "<HTML><![CDATA[<tr><td>]]></HTML>" + _
    "<HTML><![CDATA[<TABLE ]]></HTML>" + _ 
    "<HTML><![CDATA[ width=100% ]]></HTML>" + _
    "<HTML><![CDATA[ border=0 rules=rows><TR>]]></HTML>" + _
    "<IfEqual><Expr1>" + _
    "<GetVar Name="SearchString" /></Expr1><Expr2 /><Then><HTML>" + _
    "<![CDATA[<TD Class="ms-vb"> ]]></HTML>" + _ 
    "<HTML>All work items in the "</HTML>" + _
    "<ListProperty Select="Title" HTMLEncode="TRUE" />" + _
    "<HTML>" list have been completed. See </HTML>" + _
    "<HTML><![CDATA[<A HREF="]]></HTML>" + _ 
    "<HttpVDir URLEncode="TRUE"/>" + _
    "<HTML><![CDATA[/Lists/Announcements/AllItems.aspx">]]></HTML>" + _
    "<HTML>Announcements</HTML><HTML><![CDATA[</A>]]></HTML>" + _
    "<HTML> for details.</HTML>" + _
    "<HTML><![CDATA[</TD>]]></HTML></Then>" + _
    "<Else><HTML><![CDATA[<TD class="ms-vb"><B>]]></HTML>" + _
    "<HTML>No records were found matching your query.</HTML>" + _
    "<HTML><![CDATA[</B></TD>]]></HTML></Else></IfEqual>" + _
    "<HTML><![CDATA[</TR></TABLE>]]></HTML>" + _
    "<HTML><![CDATA[</td></tr></TABLE>]]></HTML>"

Dim ndViewEmpty As XmlNode = xmlDoc.CreateNode(XmlNodeType.Element, "ViewEmpty", "")

ndViewEmpty.InnerXml = strViewEmpty

viewService.UpdateViewHtml("List_Name", "9781bd25-1f68-481f-81d3-1e4f3f9216dd", Nothing, Nothing, Nothing, Nothing, Nothing, _ ndViewEmpty, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing)

Web_Reference_Folder.Views viewService = new Web_Reference_Folder.Views();
viewService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlDocument xmlDoc = new System.Xml.XmlDocument();

string strViewEmpty = "<HTML><![CDATA[" + 
   "<TABLE width=\"100%\" cellspacing=0 cellpadding=0 border=0>" + 
   "<tr><td>]]></HTML><HTML><![CDATA[" +
   "<TABLE ID=onetidDoclibViewTbl0 width=\"100%\" Summary=\"]]>" + 
   "</HTML><ListProperty Select=\"Title\" HTMLEncode=\"TRUE\" />" +
   "<HTML><![CDATA[\" ]]></HTML>" + 
   "<HTML><![CDATA[border=0 rules=rows><TR>]]></HTML>" +
   "<Fields><Switch><Expr>" + 
   "<Property Select=\"Name\" /></Expr><Case Value=\"Attachments\">" + 
   "<HTML><![CDATA[<TH class=\"ms-vh-icon\">]]></HTML>" +
   "<Field /><HTML><![CDATA[</TH>]]></HTML>" + 
   "</Case><Default><Switch><Expr>" + 
   "<Property Select=\"HeaderImage\" /></Expr><Case Value=\"\">" + 
   "<HTML><![CDATA[<TH class=\"ms-vh\">]]></HTML>" + 
   "<Field /><HTML><![CDATA[</TH>]]></HTML>" + 
   "</Case><Default><HTML><![CDATA[" + 
   "<TH class=\"ms-vh-icon\">]]></HTML><Field />" + 
   "<HTML><![CDATA[</TH>]]></HTML>" +
   "</Default></Switch></Default></Switch></Fields>" + 
   "<HTML><![CDATA[</TR>]]></HTML><HTML><![CDATA[</TABLE>]]></HTML>" + 
   "<HTML><![CDATA[</td></tr>]]></HTML>" +
   "<HTML><![CDATA[<tr><td>]]></HTML>" + 
   "<HTML><![CDATA[<TABLE ]]></HTML>" + 
   "<HTML><![CDATA[ width=100% ]]></HTML>" + 
   "<HTML><![CDATA[ border=0 rules=rows><TR>]]></HTML>" +
   "<IfEqual><Expr1>" + 
   "<GetVar Name=\"SearchString\" /></Expr1><Expr2 /><Then><HTML>" + 
   "<![CDATA[<TD Class=\"ms-vb\"> ]]></HTML>" +
   "<HTML>All work items in the \"</HTML>" +
   "<ListProperty Select=\"Title\" HTMLEncode=\"TRUE\" />" +
   "<HTML>\" list have been completed. See </HTML>" + 
   "<HTML><![CDATA[<A HREF=\"]]></HTML>" +
   "<HttpVDir URLEncode=\"TRUE\"/>" +
   "<HTML><![CDATA[/Lists/Announcements/AllItems.aspx\">]]></HTML>" + 
   "<HTML>Announcements</HTML><HTML><![CDATA[</A>]]></HTML>" +
   "<HTML> for details.</HTML>" + 
   "<HTML><![CDATA[</TD>]]></HTML></Then><Else>" +
   "<HTML><![CDATA[<TD class=\"ms-vb\"><B>]]></HTML>" + 
   "<HTML>No records were found matching your query.</HTML>" +
   "<HTML><![CDATA[</B></TD>]]></HTML>" +
   "</Else></IfEqual><HTML><![CDATA[</TR></TABLE>]]></HTML>" +
   "<HTML><![CDATA[</td></tr></TABLE>]]></HTML>";

XmlNode ndViewEmpty = xmlDoc.CreateNode(XmlNodeType.Element,"ViewEmpty","");

ndViewEmpty.InnerXml = strViewEmpty;

viewService.UpdateViewHtml("List_Name", "9781bd25-1f68-481f-81d3-1e4f3f9216dd", null, null, null, null, null, ndViewEmpty, null, null, null, null, null, null);

関連項目

参照

Views クラス
Views メンバ
websvcViews 名前空間
UpdateViewHtml2