PublishingWeb.GetPublishingPages - Méthode (String, UInt32)
Obtient une collection d'objets PublishingPage qui sont 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 ( _
camlQueryXml As String, _
rowLimit As UInteger _
) As PublishingPageCollection
'Utilisation
Dim instance As PublishingWeb
Dim camlQueryXml As String
Dim rowLimit As UInteger
Dim returnValue As PublishingPageCollection
returnValue = instance.GetPublishingPages(camlQueryXml, _
rowLimit)
public PublishingPageCollection GetPublishingPages(
string camlQueryXml,
uint rowLimit
)
Paramètres
camlQueryXml
Type : System.StringRequête CAML XML qui est utilisée pour déterminer l'ordre de tri, de filtrage et d'autres propriétés pour la collection PublishingPageCollection .
rowLimit
Type : System.UInt32Le nombre maximal d'éléments (lignes) à renvoyer chaque fois que le PublishingPageCollection est extrait.
Valeur renvoyée
Type : Microsoft.SharePoint.Publishing.PublishingPageCollection
PublishingPageCollection qui contient les objets dePublishingPage de npremière dans ce PublishingWebclass, où n est la valeur de rowLimit , trié et filtré basé sur l'argument camlQueryXml .
Exceptions
Exception | Condition |
---|---|
[Microsoft.SharePoint.SPException] | Échec de la récupération de la collection. La requête CAML peut être non valide. |
[Microsoft.SharePoint.Publishing.InvalidPublishingWebException] | Le site n'est pas valide. La bibliothèque de documents Pages est manquante. |
Remarques
Cette méthode obtient les PublishingPage les objets de cette classe de PublishingWeb basé sur les informations de requête fournies dans l'argument camlQueryXml . Il renvoie uniquement le premier nPublishingPage objets dans ce PublishingWeb où n est la valeur de rowLimit .
L'argument camlQueryXml passé par cette méthode est équivalente à la propriété Query dans Microsoft SharePoint Foundation.L'argument rowLimit est équivalente à la propriété RowLimit dans SharePoint Foundation.
Vous pouvez utiliser la méthode QueryNext() de la collection retournée pour récupérer les éléments n suivant dans la collection où n est la valeur de l'argument rowLimit . La propriété QueryNext() renvoie la valeur rowLimit définie ici.
Si la valeur de rowLimit est égale à zéro, tous les objets PublishingPage pour la classe PublishingWeb sont récupérées lors de la création de la PublishingPageCollection . Il en est de même si le rowLimit dépasse le nombre maximal d'objets PublishingPage dans la classe PublishingWeb .
Exemples
Vous pouvez utiliser la balise CAML <OrderBy> de tri de la collection. Par exemple, pour trier une collection dans l'ordre croissant selon le titre, utilisez cette requête CAML.
<br/>
<OrderBy>
<FieldRef Name="Title" Ascending="TRUE">
</FieldRef>
</OrderBy>
<br/>
Vous pouvez utiliser la balise CAML <Where> pour filtrer la collection. Par exemple, pour filtrer une collection basée sur le titre correspondant à la valeur « abc », utilisez cette requête CAML.
<br/>
<Where>
<Eq>
<FieldRef Name="Title">
</FieldRef>
<Value Type="Text">abc</Value>
</Eq>
</Where>
Voir aussi
Référence
GetPublishingPages - Surcharge