del constructor PageLayout
La clase SPListItem se utiliza para construir un objeto de elemento de la lista de PageLayout en una biblioteca de documentos.
Espacio de nombres: Microsoft.SharePoint.Publishing
Ensamblado: Microsoft.SharePoint.Publishing (en Microsoft.SharePoint.Publishing.dll)
Sintaxis
'Declaración
Public Sub New ( _
listItem As SPListItem _
)
'Uso
Dim listItem As SPListItem
Dim instance As New PageLayout(listItem)
public PageLayout(
SPListItem listItem
)
Parámetros
listItem
Tipo: Microsoft.SharePoint.SPListItemEl objeto SPListItem que se construye.
Excepciones
Excepción | Condición |
---|---|
ArgumentNullException | El listItem es una referencia null (Nothing en Visual Basic), que no es válido. |
Comentarios
Utilice este método para crear una instancia de PageLayout que ajusta un objeto SPListItem que se recuperan. El SPListItem debe ser un elemento de la Galería de páginas maestras de la colección de sitios.
El listItem debe ser una instancia de SPListItem y no puede ser una referencia null (Nothing en Visual Basic).
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.
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.
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 object.
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.
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 object.
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