PublishingPage.ContentType property
Gets the content that is available to this PublishingPage object.
Namespace: Microsoft.SharePoint.Publishing
Assembly: Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)
Syntax
'Declaration
Public ReadOnly Property ContentType As SPContentType
Get
'Usage
Dim instance As PublishingPage
Dim value As SPContentType
value = instance.ContentType
public SPContentType ContentType { get; }
Property value
Type: Microsoft.SharePoint.SPContentType
The ContentType property gets the SPContentType for this PublishingPage.
Remarks
The Layout property that provides rendering information to the PublishingPage matches the ContentTypeproperty(). The PageLayout object supports rendering the pieces of content that are associated with the SPContentType.
The ContentType property value is initialized when you create a PublishingPage; this value is based on the AssociatedContentType and cannot be modified.
The user must have View permissions on the PublishingPage to retrieve it and to return its property values.
Examples
This example replaces the PageLayout object for all PublishingPage objects in a Web to a new PageLayout that renders the same type of content.
Before compiling and running this example, verify that the oldPageLayout and newPageLayout render the same content. They should use the same AssociatedContentType value.
using PublishingPage = Microsoft.SharePoint.Publishing.PublishingPage;
using SPListItem = Microsoft.SharePoint.SPListItem;
using SPFile = Microsoft.SharePoint.SPFile;
using SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType;
using PublishingWeb = Microsoft.SharePoint.Publishing.PublishingWeb;
using SPUser = Microsoft.SharePoint.SPUser;
using PageLayout = Microsoft.SharePoint.Publishing.PageLayout;
using PublishingPageCollection = Microsoft.SharePoint.Publishing.PublishingPageCollection;
namespace Microsoft.SDK.SharePointServer.Samples
{
public static class PublishingPageCodeSamples
{
public static void SwapPageLayout(PublishingWeb publishingWeb, PageLayout oldPageLayout, PageLayout newPageLayout)
{
// Replace these variable values and input parameters
// with your own values.
//
// The comment to set when the page is checked in, published, and
// approved.
string checkInComment = "Your comments";
//
// Validate the input parameters.
if (null == publishingWeb)
{
throw new System.ArgumentNullException("publishingWeb");
}
if (null == oldPageLayout)
{
throw new System.ArgumentNullException("oldPageLayout");
}
if (null == newPageLayout)
{
throw new System.ArgumentNullException("newPageLayout");
}
// Confirm that the oldPageLayout and newPageLayout are compatible.
if (oldPageLayout.AssociatedContentType.Id != newPageLayout.AssociatedContentType.Id)
{
throw new System.ArgumentException(
"The page layouts must render the same type of content",
"newPageLayout");
}
System.Guid oldPageLayoutId = oldPageLayout.ListItem.File.UniqueId;
// Set the new PageLayout for all pages that use the old PageLayout.
PublishingPageCollection publishingPages = publishingWeb.GetPublishingPages();
foreach (PublishingPage publishingPage in publishingPages)
{
if (publishingPage.Layout.ListItem.UniqueId == oldPageLayoutId)
{
if (publishingPage.ListItem.File.CheckOutStatus == SPFile.SPCheckOutStatus.None)
{
publishingPage.CheckOut();
}
publishingPage.Layout = newPageLayout;
publishingPage.Update();
// The PublishingPage has the same SPContentType as its PageLayout.
System.Diagnostics.Debug.Assert(
publishingPage.ContentType.Parent.Id ==
newPageLayout.AssociatedContentType.Id);
publishingPage.CheckIn(checkInComment);
}
}
}
}
}
Imports PublishingPage = Microsoft.SharePoint.Publishing.PublishingPage
Imports SPListItem = Microsoft.SharePoint.SPListItem
Imports SPFile = Microsoft.SharePoint.SPFile
Imports SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType
Imports PublishingWeb = Microsoft.SharePoint.Publishing.PublishingWeb
Imports SPUser = Microsoft.SharePoint.SPUser
Imports PageLayout = Microsoft.SharePoint.Publishing.PageLayout
Imports PublishingPageCollection = Microsoft.SharePoint.Publishing.PublishingPageCollection
Namespace Microsoft.SDK.SharePointServer.Samples
Public NotInheritable Class PublishingPageCodeSamples
Private Sub New()
End Sub
Public Shared Sub SwapPageLayout(ByVal publishingWeb As PublishingWeb, ByVal oldPageLayout As PageLayout, ByVal newPageLayout As PageLayout)
' Replace these variable values and input parameters
' with your own values.
'
' The comment to set when the page is checked in, published, and
' approved.
Dim checkInComment As String = "Your comments"
'
' Validate the input parameters.
If Nothing Is publishingWeb Then
Throw New System.ArgumentNullException("publishingWeb")
End If
If Nothing Is oldPageLayout Then
Throw New System.ArgumentNullException("oldPageLayout")
End If
If Nothing Is newPageLayout Then
Throw New System.ArgumentNullException("newPageLayout")
End If
' Confirm that the oldPageLayout and newPageLayout are compatible.
If oldPageLayout.AssociatedContentType.Id <> newPageLayout.AssociatedContentType.Id Then
Throw New System.ArgumentException("The page layouts must render the same type of content", "newPageLayout")
End If
Dim oldPageLayoutId As System.Guid = oldPageLayout.ListItem.File.UniqueId
' Set the new PageLayout for all pages that use the old PageLayout.
Dim publishingPages As PublishingPageCollection = publishingWeb.GetPublishingPages()
For Each publishingPage As PublishingPage In publishingPages
If publishingPage.Layout.ListItem.UniqueId = oldPageLayoutId Then
If publishingPage.ListItem.File.CheckOutStatus = SPFile.SPCheckOutStatus.None Then
publishingPage.CheckOut()
End If
publishingPage.Layout = newPageLayout
publishingPage.Update()
' The PublishingPage has the same SPContentType as its PageLayout.
System.Diagnostics.Debug.Assert(publishingPage.ContentType.Parent.Id = newPageLayout.AssociatedContentType.Id)
publishingPage.CheckIn(checkInComment)
End If
Next publishingPage
End Sub
End Class
End Namespace