PublishingPage Class

Definition

Provides publishing-related behavior for an .aspx page that is stored in a PublishingWeb object.

public ref class PublishingPage sealed : Microsoft::SharePoint::Publishing::ScheduledItem
[Microsoft.SharePoint.Client.ClientCallableType(ClientLibraryTargets=Microsoft.SharePoint.Client.ClientLibraryTargets.NonRESTful, FactoryType=typeof(Microsoft.SharePoint.Publishing.Internal.PublishingClientObjectFactory), ObjectIdentityPropertyName="CanonicalId", ServerTypeId="E361280D-01DC-431a-9823-4AFACD06418B")]
public sealed class PublishingPage : Microsoft.SharePoint.Publishing.ScheduledItem
type PublishingPage = class
    inherit ScheduledItem
Public NotInheritable Class PublishingPage
Inherits ScheduledItem
Inheritance
PublishingPage
Attributes
ClientCallableTypeAttribute

Remarks

A PublishingPage object is stored as a document library item in a designated document library of a PublishingWeb object. It contains references to the parts that define the .aspx page, such as the PageLayout class, the SPContentType class, resources, and other parts. It contains PublishingPage content as field values in the document library item.

Many publishing pages may share common references such as page layout and resources. The server automatically updates these references in the PublishingPage object if the referenced items are renamed or moved within the system.

A schedule is associated with each PublishingPage object. The page is visible on the published site only between the scheduled start date (StartDate property) and end date (EndDate property). The scheduling behavior is part of the PublishingPage base class, ScheduledItem.

The PublishingPage class wraps the SPListItem class. It also directly exposes the underlying SPListItem (ListItem property) so that it can more easily access additional SPListItem and File functionality.

You can instantiate the PublishingPage class by using the static GetPublishingPage(SPListItem) method, or by retrieving it from a PublishingPageCollection object.

Fields

DisconnectedPublishingPageUrl

Specifies a value that indicates whether the publishing page is disconnected.

Properties

Audience

Gets or sets a value that represents the audience that this PublishingPage is targeted to.

Contact

Gets or sets the user who currently owns this PublishingPage object.

ContentType

Gets the content that is available to this PublishingPage object.

CreatedBy

Gets an SPUser object that indicates who created this PublishingPage object.

CreatedDate

Gets the Coordinated Universal Time (UTC) when this PublishingPage object was created.

Description

Gets or sets descriptive text for this PublishingPage object.

EndDate

Gets or sets the Coordinated Universal Time (UTC) at which this ScheduledItem class ends and is no longer visible on the published site.

(Inherited from ScheduledItem)
Fields

Gets the underlying SPField object definitions for this PublishingPage object.

IncludeInCurrentNavigation

Gets or sets a value that indicates whether the PublishingPage object is included by PortalSitemapProviders that have NavigationType set to "Current".

IncludeInGlobalNavigation

Gets or sets a value that indicates whether this Microsoft.SharePoint.PublishingPage object is included by the dynamic portion of the PortalSitemapProvider in the GlobalNavigation mode.

IsDisconnected

Gets a Boolean value that indicates whether this PublishingPage object is disconnected from its PageLayout object.

Label

Gets the VariationLabel object in whose hierarchy this PublishingWeb object is situated.

LastModifiedBy

Gets the SPUser object that represents the user who last modified this PublishingPage object.

LastModifiedDate

Gets the Coordinated Universal Time (UTC) when this PublishingPage object was last modified.

Layout

Gets and sets the PageLayout for this PublishingPage object.

ListItem

Gets the underlying SPListItem object that is wrapped by the ScheduledItem object.

(Inherited from ScheduledItem)
LocalContactEmail

Gets or sets the e-mail address of the local contact for this PublishingPage object.

LocalContactImage

Gets or sets a URL that refers to an image that is associated with the local contact for the PublishingPage object.

LocalContactName

Gets or sets a name that identifies the local contact of this PublishingPage object.

Name

Gets the URL name for this PublishingPage object.

PublishingWeb

Gets the PublishingWeb object that contains this ScheduledItem object.

(Inherited from ScheduledItem)
RequiresRouting

Gets or sets a Boolean value that indicates whether the PublishingPage object needs to be routed by using the content organizer rules.

ReviewRequestInterval

Gets or sets the interval between content review request notifications.

ReviewRequestIntervalUnit

Gets or sets the unit of time used by the content review request notification interval.

ReviewRequestTimeSpan

Gets the span of time between content review request notifications.

ScheduleEndNotificationInterval

Gets or sets the interval of time before end-of-schedule notifications are sent.

ScheduleEndNotificationIntervalUnit

Gets or sets the unit of time used for the EndDate schedule notification interval.

ScheduleEndNotificationTimeSpan

Gets the span of time prior to the PublishingPage object's EndDate that the end-of-schedule e-mail notification is sent.

StartDate

Gets or sets the Coordinated Universal Time (UTC) at which this ScheduledItem object becomes a visible part of the published Web site.

(Inherited from ScheduledItem)
Title

Gets or sets the title that is displayed for this PublishingPage object.

Uri

Gets the Uniform Resource Identifier (URI) for this PublishingPage object.

Url

Gets the web-relative URL for PublishingPage object.

VariationPageUrls

Gets a StringCollection object of URLs that point to Variation peer PublishingPage objects associated with this PublishingPage object.

Methods

AddFriendlyUrl(String, NavigationTermSetItem, Boolean)

Adds a user-friendly URL for this PublishingPage object.

CheckIn(String)

Checks in this PublishingPage object.

CheckOut()

Checks out this PublishingPage instance for editing.

GetEffectiveAnonymousPageCacheProfileId()

Returns the current cache profile identifier (ID) that this page uses if output is cached for an anonymous user.

GetEffectiveAuthenticatedPageCacheProfileId()

Getsthe current cache profile identifier (ID) that this page uses if output is cached for an authenticated user.

GetPublishingPage(SPListItem)

Gets a PublishingPage object instance that wraps the given SPListItem object.

GetVariation(VariationLabel)

Get the peer VariationPublishingPage object that belongs to this PublishingPage object for the specified Label.

IsPublishingPage(SPListItem)

Confirms that an SPListItem is compatible with the PublishingPage object.

QuickDeploy()

Deploys this PublishingPage object by using the QuickDeploy method.

Route(PublishingPage)

Routes a PublishingPage object by using the content organizer rules.

Route(PublishingPage, String)

Routes a PublishingPage object by using the content organizer rules.

Schedule()

Schedules an instance of the SPListItem class to be automatically approved (start) and to be unpublished (end) on specified dates.

(Inherited from ScheduledItem)
Schedule(String)

Schedules an SPListItem object to automatically be approved (start) and be unpublished (end) on specified dates.

(Inherited from ScheduledItem)
Update()

Commits changes to this PublishingPage object.

UpdateContentFromSourceDocument(PageConversionPriority)
Obsolete.

Updates a Microsoft.SharePoint.PublishingPageobject created by converting a document and reruns the conversion.

Applies to