PublishingWeb.GetPublishingPages método (String, UInt32)

Artigo
03/15/2016

Obtém uma coleção de objetos PublishingPage que estão contidos no objeto PublishingWeb .

Namespace: Microsoft.SharePoint.Publishing
Assembly: Microsoft.SharePoint.Publishing (em Microsoft.SharePoint.Publishing.dll)

Sintaxe

'Declaração
Public Function GetPublishingPages ( _
    camlQueryXml As String, _
    rowLimit As UInteger _
) As PublishingPageCollection
'Uso
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
)

Parâmetros

camlQueryXml
Tipo: System.String

A consulta CAML XML que é usada para determinar a ordem de classificação, filtragem e outras propriedades da coleção PublishingPageCollection .

rowLimit
Tipo: System.UInt32

O número máximo de itens (linhas) para retornar toda vez que o PublishingPageCollection é recuperado.

Valor retornado

Tipo: Microsoft.SharePoint.Publishing.PublishingPageCollection
Um PublishingPageCollection que contém os objetos dePublishingPage de nprimeiro esta PublishingWebclass, onde n é o valor de rowLimit classificada e filtrada com base no argumento camlQueryXml .

Exceções

Exceção	Condição
[Microsoft.SharePoint.SPException]	Falha na recuperação da coleção. A consulta CAML pode ser inválida.
[Microsoft.SharePoint.Publishing.InvalidPublishingWebException]	O site não é válido. A biblioteca de documentos páginas está ausente.

Comentários

Esse método obtém os objetos de PublishingPage para esta classe de PublishingWeb com base nas informações de consulta fornecidas no argumento camlQueryXml . Ele retorna somente o primeiro nPublishingPage objetos neste PublishingWeb onde n é o valor de rowLimit .

O argumento camlQueryXml passado por esse método é equivalente à propriedade Query em Microsoft SharePoint Foundation.O argumento rowLimit é equivalente à propriedade RowLimit em SharePoint Foundation.

Você pode usar o método QueryNext() da coleção retornada para recuperar os itens n próximo da coleção onde n é o valor do argumento rowLimit . A propriedade QueryNext() retorna o valor rowLimit definido aqui.

Se o valor de rowLimit for zero, todos os objetos de PublishingPage para a classe PublishingWeb são recuperados quando o PublishingPageCollection é criado. O mesmo é verdadeiro se o rowLimit excede o número máximo de objetos de PublishingPage na classe PublishingWeb .

Exemplos

Você pode usar a marca> deOrderByde <CAML para classificar a coleção. Por exemplo, para solicitar uma coleção em ordem crescente com base no título, use esta consulta CAML.

<br/>
<OrderBy>
<FieldRef Name="Title" Ascending="TRUE">
</FieldRef>
</OrderBy>
<br/>

Você pode usar a marca> deWherede <CAML para filtrar a coleção. Por exemplo, para filtrar uma coleção com base no título que coincidam com o valor "abc", use esta consulta CAML.

<br/>
<Where>
<Eq>
<FieldRef Name="Title">
</FieldRef>
<Value Type="Text">abc</Value>
</Eq>
</Where>

Ver também

Referência

PublishingWeb classe

PublishingWeb membros

GetPublishingPages em sobrecarga

Microsoft.SharePoint.Publishing namespace

GetPublishingPages

Compartilhar via