PageLayout.ListItem - Propriété
Obtient l'objet SPListItem sur laquelle est basée cette classe PageLayout .
Espace de noms : Microsoft.SharePoint.Publishing
Assembly : Microsoft.SharePoint.Publishing (dans Microsoft.SharePoint.Publishing.dll)
Syntaxe
'Déclaration
Public ReadOnly Property ListItem As SPListItem
Get
'Utilisation
Dim instance As PageLayout
Dim value As SPListItem
value = instance.ListItem
public SPListItem ListItem { get; }
Valeur de propriété
Type : Microsoft.SharePoint.SPListItem
L'objet SPListItem sous-jacent sur lequel est basée cette classe.
Remarques
La valeur de ListItem est initialisée lorsqu'une instance de PageLayout est créée et ne peut pas être modifiée.
Notes
L'utilisateur doit avoir l'autorisation d'afficher les éléments de la liste dans cette liste pour récupérer initialement la liste et obtenir une de ses valeurs de propriété.
Cette propriété est utile pour accéder à la SPListItem et SPListItem.File propriétés et méthodes supplémentaires qui n'ont pas été encapsulés par la classe PageLayout .
Exemples
Avant de compiler et d'exécuter cet exemple, vérifiez que l'objet SPListItem est un élément de liste pour une mise en page qui se trouve dans la galerie de pages maîtres sur le site Web de niveau supérieur.
Cet exemple suppose que la galerie de page maître qui contient l'objet SPListItem nécessite l'approbation de contenu.
N'utilisez pas cette propriété pour accéder aux champs arbitraires de la SPListItem. ListItem s'applique uniquement les champs suivants :
AnonymousCacheProfile()
AuthenticatedCacheProfile()
Author()
ContentTypeId()
Created()
FSObjType()
FileDirRef()
FileLeafRef()
FileRef()
Id()
MasterPageDescription()
PublishingAssociatedContentType()
PublishingAssociatedVariations()
PublishingPreviewImage()
ScopeId()
Title()
S'il existe un besoin d'accéder aux autres champs, utilisez SPQuery pour créer une nouvelle instance de SPListItem pour une utilisation à d'autres champs.
using PageLayout = Microsoft.SharePoint.Publishing.PageLayout;
using SPListItem = Microsoft.SharePoint.SPListItem;
using SPFile = Microsoft.SharePoint.SPFile;
namespace Microsoft.SDK.SharePointServer.Samples
{
public static class PageLayoutCodeSamples
{
// This method sets some properties on a PageLayout object,
// saves the new values, and publishes the PageLayout.
public static void SetPageLayoutPropertiesAndApprove(SPListItem layoutListItem)
{
// Replace these variable values and input
// parameters with your own values.
// New PageLayout.Title value
string newTitle = "your Title";
// New PageLayout.Description value
string newDescription = "your Description";
// The comment to set when the layout is checked in,
// published, and approved.
string checkInComment = "your comments";
// Validate the input parameters.
if (null == layoutListItem)
{
throw new System.ArgumentNullException("layoutListItem");
}
// Get the PageLayout wrapper for the SPListItem
// that is passed in.
PageLayout pageLayout = new PageLayout(layoutListItem);
// Check out the PageLayout if it is not checked out yet.
if (pageLayout.ListItem.File.CheckOutStatus ==
SPFile.SPCheckOutStatus.None)
{
pageLayout.ListItem.File.CheckOut();
}
// Set and save some properties on the PageLayout.
pageLayout.Title = newTitle;
pageLayout.Description = newDescription;
pageLayout.Update();
// Publish the PageLayout and Approve it so that the
// updated values are available on the published Web site.
pageLayout.ListItem.File.CheckIn(checkInComment);
SPFile layoutFile = pageLayout.ListItem.File;
layoutFile.Publish(checkInComment);
layoutFile.Approve(checkInComment);
}
}
}
Imports PageLayout = Microsoft.SharePoint.Publishing.PageLayout
Imports SPListItem = Microsoft.SharePoint.SPListItem
Imports SPFile = Microsoft.SharePoint.SPFile
Namespace Microsoft.SDK.SharePointServer.Samples
Public NotInheritable Class PageLayoutCodeSamples
' This method sets some properties on a PageLayout object,
' saves the new values, and publishes the PageLayout.
Private Sub New()
End Sub
Public Shared Sub SetPageLayoutPropertiesAndApprove(ByVal layoutListItem As SPListItem)
' Replace these variable values and input
' parameters with your own values.
' New PageLayout.Title value
Dim newTitle As String = "your Title"
' New PageLayout.Description value
Dim newDescription As String = "your Description"
' The comment to set when the layout is checked in,
' published, and approved.
Dim checkInComment As String = "your comments"
' Validate the input parameters.
If Nothing Is layoutListItem Then
Throw New System.ArgumentNullException("layoutListItem")
End If
' Get the PageLayout wrapper for the SPListItem
' that is passed in.
Dim pageLayout As New PageLayout(layoutListItem)
' Check out the PageLayout if it is not checked out yet.
If pageLayout.ListItem.File.CheckOutStatus = SPFile.SPCheckOutStatus.None Then
pageLayout.ListItem.File.CheckOut()
End If
' Set and save some properties on the PageLayout.
pageLayout.Title = newTitle
pageLayout.Description = newDescription
pageLayout.Update()
' Publish the PageLayout and Approve it so that the
' updated values are available on the published Web site.
pageLayout.ListItem.File.CheckIn(checkInComment)
Dim layoutFile As SPFile = pageLayout.ListItem.File
layoutFile.Publish(checkInComment)
layoutFile.Approve(checkInComment)
End Sub
End Class
End Namespace