PublishingWeb.GetPublishingPages - Méthode

Obtient une collection d'objets PublishingPage contenus dans cet objet PublishingWeb .

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

Syntaxe

'Déclaration
Public Function GetPublishingPages As PublishingPageCollection
'Utilisation
Dim instance As PublishingWeb
Dim returnValue As PublishingPageCollection

returnValue = instance.GetPublishingPages()

public PublishingPageCollection GetPublishingPages()

Valeur renvoyée

Type : Microsoft.SharePoint.Publishing.PublishingPageCollection
Une collection PublishingPageCollection qui contient des objets PublishingPage dans cet objet PublishingWeb .

Exceptions

Exception	Condition
[Microsoft.SharePoint.Publishing.InvalidPublishingWebException]	Le site n'est pas valide. La bibliothèque de documents Pages est manquante.

Remarques

Cette méthode extrait tous les objets de PublishingPage pour cet objet PublishingWeb . Pour une grande collection, vous pouvez utiliser la pagination de données avec les autres méthodes GetPublishingPage() pour récupérer de cette collection en sous-ensembles plus petits.

Pour appliquer le tri ou le filtrage, utilisez une méthode [M:Microsoft.SharePoint.Publishing.PublishingWeb.GetPublishingPages(Microsoft.SharePoint.SPQuery] qui prend SPQuery, String, ou UInt32 pour créer une requête de langage CAML (Collaborative Application Markup Language) qui précise que le tri et conditions d'adhésion de collection.

Exemples

Cet exemple crée un nouveau PublishingPage dans une PublishingWeb.

Avant de compiler et d'exécuter cet exemple, vérifiez qu'un SPWeb qui est un site de publication existe et qu'il est passé comme le paramètre Web. La PageLayout à utiliser pour la création de la page doit également être passé.

using SPWeb = Microsoft.SharePoint.SPWeb;
using PublishingWeb = Microsoft.SharePoint.Publishing.PublishingWeb;
using PageLayout = Microsoft.SharePoint.Publishing.PageLayout;
using PublishingPageCollection = Microsoft.SharePoint.Publishing.PublishingPageCollection;
using PublishingPage = Microsoft.SharePoint.Publishing.PublishingPage;

namespace Microsoft.SDK.SharePointServer.Samples
{
    public static class PublishingPageCollectionCodeSamples
    {
        
       
        public static void CreateNewPage( SPWeb web, PageLayout pageLayout )
        {
// Replace these variable values with your own values.
string newPageName = "Contoso.aspx";    // the URL name of the new page
string checkInComment = "Your check in comments";  // the comment to set when the page is checked in

// Validate the input parameters.
if (null == web)
{
    throw new System.ArgumentNullException("web");
}
if (null == pageLayout)
{
    throw new System.ArgumentNullException("pageLayout");
}

// Get the PublishingWeb wrapper for the SPWeb that was passed in.
PublishingWeb publishingWeb = null;
if (PublishingWeb.IsPublishingWeb(web))
{
    publishingWeb = PublishingWeb.GetPublishingWeb(web);
}
else
{
    throw new System.ArgumentException("The SPWeb must be a PublishingWeb", "web");
}
           
// Create the new page in the PublishingWeb.
PublishingPageCollection pages = publishingWeb.GetPublishingPages();
PublishingPage newPage = pages.Add(newPageName, pageLayout);

// Check in the new page so that others can work on it.
newPage.CheckIn(checkInComment);          
        }
    }
}

Imports SPWeb = Microsoft.SharePoint.SPWeb
Imports PublishingWeb = Microsoft.SharePoint.Publishing.PublishingWeb
Imports PageLayout = Microsoft.SharePoint.Publishing.PageLayout
Imports PublishingPageCollection = Microsoft.SharePoint.Publishing.PublishingPageCollection
Imports PublishingPage = Microsoft.SharePoint.Publishing.PublishingPage

Namespace Microsoft.SDK.SharePointServer.Samples
    Public NotInheritable Class PublishingPageCollectionCodeSamples


        Private Sub New()
        End Sub
        Public Shared Sub CreateNewPage(ByVal web As SPWeb, ByVal pageLayout As PageLayout)
' Replace these variable values with your own values.
Dim newPageName As String = "Contoso.aspx" ' the URL name of the new page
Dim checkInComment As String = "Your check in comments" ' the comment to set when the page is checked in

' Validate the input parameters.
If Nothing Is web Then
    Throw New System.ArgumentNullException("web")
End If
If Nothing Is pageLayout Then
    Throw New System.ArgumentNullException("pageLayout")
End If

' Get the PublishingWeb wrapper for the SPWeb that was passed in.
Dim publishingWeb As PublishingWeb = Nothing
If PublishingWeb.IsPublishingWeb(web) Then
    publishingWeb = PublishingWeb.GetPublishingWeb(web)
Else
    Throw New System.ArgumentException("The SPWeb must be a PublishingWeb", "web")
End If

' Create the new page in the PublishingWeb.
Dim pages As PublishingPageCollection = publishingWeb.GetPublishingPages()
Dim newPage As PublishingPage = pages.Add(newPageName, pageLayout)

' Check in the new page so that others can work on it.
newPage.CheckIn(checkInComment)
        End Sub
    End Class
End Namespace

Voir aussi

Référence

PublishingWeb classe

PublishingWeb - Membres

GetPublishingPages - Surcharge

Microsoft.SharePoint.Publishing - Espace de noms