3.1.5.19.18 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_Assembly                    nvarchar(255),
       tp_Class                       nvarchar(255),
       tp_SolutionId                  uniqueidentifier,
       Hash                           nvarchar(50),
       ValidatorsHash                  nvarchar(64),
       ValidationErrorUrl,             nvarchar(4000),
       ValidationErrorMessage,         nvarchar(4000),
       {tp_IsIncluded}                bit,
       {tp_FrameState}                tinyint,
       tp_AllUsersProperties          varbinary(max),
       {tp_PerUsersProperties}        varbinary(max),
       {tp_PartOrder}                 int,
       {tp_Flags}                     int,
       {AllUsers}                     int,
       tp_Version                     int,
       tp_Cache                       varbinary(max),
       {Per_tp_Cache}                 varbinary(max),
       {tp_ListId}                    nvarchar(38),
       tp_Type                        tinyint,
       tp_Source                      nvarchar(max),
       Tp_BaseViewId                  int,
       tp_View                        nvarchar(max);

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_Assembly: The assembly name of the implementation of the Web Part.

tp_Class: The fully qualified class name of the implementation of the Web Part.

SolutionId: The solution identifier of the solution. MUST be NULL if there is no solution associated with the Web Part.

Hash: The implementation-specific hash of the content of the sandboxed solution. This value MUST be NULL if there is no solution associated with the Web Part.

ValidatorsHash: The implementation-specific hash of the sandboxed solution validators that validated the sandboxed solution. This value MUST be NULL if there is no solution associated with the Web Part.

ValidationErrorUrl: The URL to render if the sandboxed solution validator failed validation. This value MUST be NULL if there is no solution associated with the Web Part.

ValidationErrorMessage: The error message string to render if the sandboxed solution validator failed validation. This value MUST be NULL if there is no solution associated with the Web Part.

{tp_IsIncluded}: If this bit flag is set to 1, it indicates that the Web Part is visible. Otherwise, it MUST be 0.

{tp_FrameState}: A value that indicates the frame state of the Web Part. 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.

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

{tp_PerUsersProperties}: Web Part 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. Also 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_Version: A counter incremented any time a change is made to the schema or other properties of this list and used for internal conflict detection.

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

{Per_tp_Cache}: Contains the private data cache for documents with a checkout level of 'published'. Otherwise, this 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, then 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 compatible HTML editor. This value can be NULL.

tp_BaseViewId: the id of the base view for the list view Web Part. This value can be NULL.

tp_View: Contains implementation-specific XML used when processing this Web Part. If this Web Part is not a view, then this MUST be NULL.