de la propiedad PageLayout.ListItem
Obtiene el objeto SPListItem en que se basa esta clase PageLayout .
Espacio de nombres: Microsoft.SharePoint.Publishing
Ensamblado: Microsoft.SharePoint.Publishing (en Microsoft.SharePoint.Publishing.dll)
Sintaxis
'Declaración
Public ReadOnly Property ListItem As SPListItem
Get
'Uso
Dim instance As PageLayout
Dim value As SPListItem
value = instance.ListItem
public SPListItem ListItem { get; }
Valor de propiedad
Tipo: Microsoft.SharePoint.SPListItem
El objeto subyacente de SPListItem en que se basa esta clase.
Comentarios
El valor de ListItem se inicializa cuando se crea una instancia de PageLayout y se no se puede modificar.
Nota
El usuario debe tener permiso para ver elementos de la lista en esta lista para recuperar al principio de la lista y obtener cualquiera de sus valores de propiedad.
Esta propiedad es útil para tener acceso a las propiedades SPListItem y SPListItem.File adicionales y métodos que no se han ajustado por la clase PageLayout .
Ejemplos
Antes de compilar y ejecutar este ejemplo, compruebe que el objeto SPListItem es un elemento de lista de un diseño de página que se encuentra en la Galería de páginas maestras en el sitio Web de nivel superior.
En este ejemplo se supone que la Galería de páginas maestras que contiene el objeto SPListItem requiere aprobación de contenido.
No utilice esta propiedad para obtener acceso a campos arbitrarios de la SPListItem. ListItem se aplica sólo a los siguientes campos:
AnonymousCacheProfile()
AuthenticatedCacheProfile()
Author()
ContentTypeId()
Created()
FSObjType()
FileDirRef()
FileLeafRef()
FileRef()
Id()
MasterPageDescription()
PublishingAssociatedContentType()
PublishingAssociatedVariations()
PublishingPreviewImage()
ScopeId()
Title()
Si hay una necesidad de obtener acceso a otros campos, utilice SPQuery para crear una nueva instancia de SPListItem para su uso con otros campos.
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