Share via


WebPart Element (DeploymentManifest)

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Represents an instance of a Windows SharePoint Services top-level Web Part object (SPWebPart).

DECLARATION
<xs:element name="WebPart" 
        type="SPWebPart" 
        minOccurs="1" maxOccurs="unbounded" 
/>

USAGE
<SPWebPart>
      <xs:sequence>
            <xs:choice minOccurs="0" maxOccurs="25">
                  <xs:element name="Script" />
                  <xs:element name="PagedRowset" />
                  <xs:element name="PagedClientCallbackRowset" 
                  <xs:element name="PagedRecurrenceRowset" />
                  <xs:element name="ViewFields" type="SPFieldLinkCollection" />
                  <xs:element name="ViewData" />
                  <xs:element name="Query" />
                  <xs:element name="RowLimit" />
                  <xs:element name="RowLimitExceeded" />
                  <xs:element name="Toolbar" />
                  <xs:element name="Formats" />
                  <xs:element name="Aggregations" />
                  <xs:element name="ViewStyle" 
                  <xs:element name="ViewBody" />
                  <xs:element name="ViewEmpty" />
                  <xs:element name="ViewFooter" />
                  <xs:element name="ViewHeader" />
                  <xs:element name="ViewBidiHeader"/>
                  <xs:element name="GroupByFooter" 
                  <xs:element name="GroupByHeader" />
                  <xs:element name="CalendarViewStyles" />
                  <xs:element name="ListFormBody" />
            </xs:choice>
      </xs:sequence>

      <xs:attribute name="Name" />
      <xs:attribute name="ListId />
      <xs:attribute name="ListRootFolderUrl" />
      <xs:attribute name="Type" />
      <xs:attribute name="UserId" />
      <xs:attribute name="DisplayName" />
      <xs:attribute name="WebPartTypeId" />
      <xs:attribute name="Version" />
      <xs:attribute name="BaseViewID" />
      <xs:attribute name="WebPartZoneID" />
      <xs:attribute name="IsIncluded" />
      <xs:attribute name="WebPartOrder" />
      <xs:attribute name="FrameState" />
      <xs:attribute name="Source" />
      <xs:attribute name="AllUsersProperties" />
      <xs:attribute name="PerUserProperties" />
      <xs:attribute name="ContentTypeId" />
            <!-- For files (major [default] or minor) -->
      <xs:attribute name="Level" />
            <!-- Flags -->
      <xs:attribute name="Flags" />
      <xs:attribute name="Scope" />
      <xs:attribute name="Hidden" />
      <xs:attribute name="Threaded" />
      <xs:attribute name="ReadOnly" />
      <xs:attribute name="RecurrenceRowset" />
      <xs:attribute name="FPModified" />
      <xs:attribute name="ModerationType" />
      <xs:attribute name="Personal" />
      <xs:attribute name="OrderedView" />
</WebPart>

Type

WebPart

Attributes

Attribute

Type

Description

AllUsersProperties

xs:string

This value is generated by the Web Part and should not be changed.

BaseViewID

xs:string

Optional.

ContentTypeId

xs:string

Specifies the content type by identifier.

DisplayName

xs:string

A representation of the Web Part name as it is displayed in the title bar of the Web Part.

Flags

xs:string

Optional flag.

FPModified

xs:boolean

Optional flag.

FrameState

xs:string

Optional. Specifies the initial state of the Web Part frame; the frame can be normal (expanded) or minimized.

Hidden

xs:boolean

Optional flag. Specifies whether the Web Part control is displayed on a Web page.The value is true if the control is hidden; the default is false.

IsIncluded

xs:string

Optional.

Level

xs:string

Optional. Indicates whether the specified file is of the "major" or "minor" level. The default value is "major".

ListId

Guid Simple Type (DeploymentManifest)

Optional. Unique identifier of the Web Part list.

ListRootFolderUrl

xs:string

Optional. The URL to the root folder that contains the list.

ModerationType

xs:string

Optional flag.

Name

Guid Simple Type (DeploymentManifest)

Required. Unique identifier of the Web Part.

OrderedView

xs:boolean

Optional flag.

Personal

xs:boolean

Optional flag.

PerUserProperties

xs:string

This value is generated by the Web Parts on a per-user basis and should not be changed.

ReadOnly

xs:boolean

Optional flag. Specifies whether contents of the Web Part are read only; true if read only, otherwise false.

RecurrenceRowset

xs:boolean

Optional flag.

Scope

xs:string

Optional flag.

Source

xs:string

Optional.

Threaded

xs:boolean

Optional flag.

Type

xs:string

Optional. Specifies the type of the Web Part.

UserId

Guid Simple Type (DeploymentManifest)

Optional.

Version

xs:string

Optional. Specifies the version of the Web Part.

WebPartOrder

xs:string

Optional. Specifies the ordering of contents in the Web Part.

WebPartTypeId

xs:string

Optional. Specifies the identifier of the Web Part type.

WebPartZoneID

xs:string

Optional. Specifies the identifier of the Web Part zone.

Child Elements

Script Element (DeploymentManifest - SPWebPart)

PagedRowset Element (DeploymentManifest - SPWebPart)

PagedClientCallbackRowset Element (DeploymentManifest - SPWebPart)

PagedRecurrenceRowset Element (DeploymentManifest - SPWebPart)

ViewFields Element (DeploymentManifest - SPWebPart)

ViewData Element (DeploymentManifest - SPWebPart)

Query Element (DeploymentManifest - SPWebPart)

RowLimit Element (DeploymentManifest - SPWebPart)

RowLimitExceeded Element (DeploymentManifest - SPWebPart)

Toolbar Element (DeploymentManifest - SPWebPart)

Formats Element (DeploymentManifest - SPWebPart)

Aggregations Element (DeploymentManifest - SPWebPart)

ViewStyle Element (DeploymentManifest - SPWebPart)

View Body Element (DeploymentManifest - SPWebPart)

ViewEmpty Element (DeploymentManifest - SPWebPart)

ViewFooter Element (DeploymentManifest - SPWebPart)

ViewHeader Element (DeploymentManifest - SPWebPart)

ViewBidiHeader Element (DeploymentManifest - SPWebPart)

GroupByFooter Element (DeploymentManifest - SPWebPart)

GroupByHeader (DeploymentManifest - SPWebPart)

CalendarViewStyles Element (DeploymentManifest - SPWebPart)

ListFormBody Element (DeploymentManifest - SPWebPart)

Parent Elements

WebParts Element (DeploymentManifest)

Remarks

Web Parts can derive from either of two base classes - an ASP.NET Web Part (WebPart), or a Windows SharePoint Services Web Part (WebPart).

See Also

Reference

WebPart

WebPart

Concepts

DeploymentManifest Schema