PageLayout Class

Definition

Represents a Microsoft SharePoint Server 2010 page layout. This class cannot be inherited.

public ref class PageLayout sealed
public sealed class PageLayout
type PageLayout = class
Public NotInheritable Class PageLayout
Inheritance
PageLayout

Remarks

The PageLayout class provides publishing-related behavior for page layouts within a site collection's master page gallery, where it is stored as a document list item. It defines the common look and feel for how PublishingPage objects appear in the site.

The PageLayout class wraps the SPListItem class. It also exposes the underlying SPListItem directly through the ListItem property so that additional SPListItem and File functionality can be accessed easily.

You can use the public constructor Microsoft.SharePoint.Publishing.PageLayout(SPListItemlistItem) to create an instance of a PageLayout object. You can also instantiate a PageLayout object by retrieving it from a PageLayoutCollection collection.

Constructors

PageLayout(SPListItem)

Uses the SPListItem class to construct a PageLayout list item object in a document library.

Properties

AnonymousCacheProfileId

Gets the identifier of the anonymous cache profile in the Cache Profiles list.

AssociatedContentType

Gets or sets the associated SPContentType object that is used when creating a Microsoft.SharePoint.PublishingPage object with this PageLayout object.

AuthenticatedCacheProfileId

Gets the identifier of the authenticated cache profile in the Cache Profiles list.

CreatedBy

Gets the SPUser object that represents the user who created this PageLayout object.

CreatedDate

Gets the DateTime when this PageLayout object was created.

Description

Gets or sets descriptive text for this PageLayout object.

Folder

Gets the SPFolder object in which this PageLayout object is located.

ListItem

Gets the SPListItem object upon which this PageLayout class is based.

Name

Gets the name of this PageLayout object.

PreviewImageUrl

Gets or sets the fully qualified, or absolute, URL of an associated preview image for this PageLayout object.

ServerRelativeUrl

Gets the server-relative URL of this PageLayout object.

Title

Gets or sets the display title for this PageLayout object.

Methods

Update()

Saves changes to this PageLayout object.

Applies to