PageLayout.Description - Propriété

Obtient ou définit le texte descriptif pour cet objet PageLayout .

Espace de noms :  Microsoft.SharePoint.Publishing
Assembly :  Microsoft.SharePoint.Publishing (dans Microsoft.SharePoint.Publishing.dll)

Syntaxe

'Déclaration
Public Property Description As String
    Get
    Set
'Utilisation
Dim instance As PageLayout
Dim value As String

value = instance.Description

instance.Description = value

public string Description { get; set; }

Valeur de propriété

Type : System.String
Texte décrivant cet objet PageLayout .
La valeur de Description peut être une chaîne vide. Une valeur de une référence Null (Rien dans Visual Basic) est également traitée comme une chaîne vide.

Exceptions

Exception	Condition
ArgumentException	Une valeur de propriété n'est pas valide.
UnauthorizedAccessException	L'utilisateur actuel ne dispose pas des autorisations suffisantes pour effectuer cette action.

Remarques

Vous devez appeler Update après la définition de cette propriété pour enregistrer les modifications.

L'utilisateur doit disposer des autorisations de modification sur l'objet PageLayout pour définir cette valeur. L'utilisateur doit disposer des autorisations d'affichage sur l'objet PageLayout pour récupérer initialement et obtenir une des valeurs de ses propriétés.

Si la valeur de cette propriété est utilisée dans le code HTML et est rendue dans un navigateur Web, vous devez coder la valeur de la propriété pour éviter les risques d'attaques de script.

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.

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

Voir aussi

Référence

PageLayout classe

PageLayout - Membres

Microsoft.SharePoint.Publishing - Espace de noms