Views.UpdateViewHtml2 Method

Article
07/14/2010

Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.

Web Service: ViewsWeb Reference: http://<Site>/_vti_bin/Views.asmx

Syntax

<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/UpdateViewHtml2", RequestNamespace:="http://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace:="http://schemas.microsoft.com/sharepoint/soap/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function UpdateViewHtml2 ( _
    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, _
    openApplicationExtension As String _
) 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 openApplicationExtension As String
Dim returnValue As XmlNode

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

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/UpdateViewHtml2", RequestNamespace="http://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace="http://schemas.microsoft.com/sharepoint/soap/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public XmlNode UpdateViewHtml2 (
    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,
    string openApplicationExtension
)

Parameters

listName
A string that contains the internal name of the list.

viewName
A string that contains the GUID for the view.

viewProperties
An XML fragment that contains all view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.

toolbar
A Toolbar element that sets the HTML used to render the toolbar in a view and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<Toolbar Type="Standard">
  <IfEqual>
    <Expr1>
      <GetVar Name="SearchString" />
    </Expr1>
    <Expr2 />
    <Then>
    ...
</Toolbar>
```

viewHeader
A ViewHeader element that sets the HTML used to render the header of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<ViewHeader>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]>
  </HTML>
  ...
</ViewHeader>
```

viewBody
A ViewBody element that sets the HTML used to render the body of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<ViewBody>
  <HTML>
    <![CDATA[ <TR>]]>
  </HTML>
  <Fields>
    <HTML>
      <![CDATA[ <TD Class=" ]]> 
    </HTML>
    ...
</ViewBody>
```

viewFooter
A ViewFooter element that sets the HTML used to render the footer of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<ViewFooter>
  <HTML>
    <![CDATA[ </TABLE> ]]>
  </HTML>
  <IfEqual>
  ...
</ViewFooter>
```

viewEmpty
A ViewEmpty element that contains the HTML used to render the page if the query returns no items and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<ViewEmpty>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]>
  </HTML>
  ...
</ViewEmpty>
```

rowLimitExceeded
A RowLimitExceeded element that specifies alternate rendering for when the specified row limit is exceeded and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<RowLimitExceeded>
  <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows>
  ...
    </td></tr></table> ]]>
  </HTML>
</RowLimitExceeded>
```

query
A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles:
```
<Query>
  <Where>
    <Lt>
      <FieldRef Name="ID" />
      <Value Type="Counter">3</Value>
    </Lt>
  </Where>
  <OrderBy>
    <FieldRef Name="Title" />
  </OrderBy>
</Query>
```

viewFields
A ViewFields element that specifies which fields to return in the query and in what order, and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<ViewFields>
  <FieldRef Name="ID" />
  <FieldRef Name="Title" />
</ViewFields>
```

aggregations
An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example:
```
<Aggregations Value="On">
  <FieldRef Name="Title" Type="Count">
  <FieldRef Name="Number" Type="Sum">
</Aggregations>
```

formats
A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example:

<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
A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page:
```
<RowLimit Paged="True">100</RowLimit>
```

openApplicationExtension

Return Value

A CAML fragment in the following form that contains the view schema and that can be assigned to a System.Xml.XmlNode object.

<View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B}" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="http://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>

Remarks

To modify only the query and field definitions in a view, use the UpdateView method.

Views.UpdateViewHtml2 Method

Syntax

Parameters

Return Value

Remarks

See Also

Reference

Additional resources