Click to Rate and Give Feedback
MSDN
MSDN Library
Open Specifications
Windows Protocols
3 Protocol Details
 3.1.4.15.16 WebParts Metadata, Pers...
3.1.4.15.16 WebParts Metadata, Personalized Result Set

The Web Parts Metadata, Personalized Result Set contains the core metadata about the Web parts appearing on the specified document, personalized for the user specified in @UserId.

The Web Parts Metadata, Personalized Result Set is part of a series of result sets describing view Web page-related metadata. It MUST return ONLY if the input @PageView is NOT 0.

The Web Parts Metadata, Personalized Result Set will NOT return if proc_FetchDocForHttpGet returns a code of 1271, indicating that the site collection was locked.

The Web Parts Metadata, Personalized Result Set MUST contain one row per Web part.

      tp_Id                          uniqueidentifier,
      {tp_ZoneID}                    nvarchar(64),
      tp_WebPartTypeId               uniqueidentifier,
      {tp_IsIncluded}                bit,
      {tp_FrameState}                tinyint,
      tp_AllUsersProperties          image,
      {tp_PerUsersProperties}        image,
      {tp_PartOrder}                 int,
      {tp_Flags}                     int,
      {AllUsers}                     int,
      tp_Cache                       image,
      {Per_tp_Cache}                 image,
      {tp_ListId}                    nvarchar(38),
      tp_Type                        tinyint,
      tp_Source                      ntext,
      tp_View                        ntext;

tp_Id: The Web Part Identifier of the Web part. This value MUST NOT be NULL.

{tp_ZoneId}: The name of a Web part zone. This value can be NULL.

tp_WebPartTypeId: A 16-byte value uniquely identifying the type of the Web part. MUST NOT be NULL.

{tp_IsIncluded}: If 1, this indicates that the Web part is visible. This value MUST be 1 or 0.

{tp_FrameState}: A value that indicates the frame state of the Web part. FrameState is obsolete and is equivalent to ChromeState. This value MUST be one of the following.

Value

Description

0

Normal. The Web part is displayed in its normal state, with title, content, and placement within the page.

1

Minimized. The Web part is collapsed so that only the title portion of the frame appears.

tp_AllUsersProperties: Properties specified for all users. This value can be NULL.

{tp_PerUsersProperties}: Properties specified for per-user basis. This value can be NULL.

{tp_PartOrder}: Ordinal number that indicates the location of the Web part in relation to other Web parts in the same zone. This value can be NULL.

{tp_Flags}: A View Flags value that specifies view-related settings for this Web part. This value can be equal to 0.

{AllUsers}: A flag that indicates whether customization or personalization is in effect on this Web parts page. This value MUST be one of the following.

Value

Description

1

User not specified; changes apply to all users of this Web part instance. Same indicates customization mode.

2

Personalization is in effect; changes apply to the tp_UserId in the Personalization Table.

3

Personalization is in effect; changes apply to the tp_UserId in the Web Parts Table.

tp_Cache: Private data cache for the Web part. This value can be NULL.

{Per_tp_Cache}: Private data cache for documents at the published level; otherwise, this value MUST be NULL.

{tp_ListId}: The List Identifier of the list to which this Web part refers, enclosed in braces. If not referencing a list, this value MUST be NULL.

tp_Type: The Page Type of this Web part. This value can be NULL.

tp_Source: Properties of the Web part, as specified by a Windows SharePoint Services-compatible HTML editor. This value can be NULL.

tp_View: An ntext value that contains implementation-specific XML used when processing this Web part. If this Web part is not a view, this MUST be NULL.

© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker