ParagraphProperties Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Propriedades do parágrafo.

Essa classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, seu nome qualificado é w:pPr.

public class ParagraphProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type ParagraphProperties = class
    inherit OpenXmlCompositeElement

Public Class ParagraphProperties
Inherits OpenXmlCompositeElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

ParagraphProperties

Exemplos

O exemplo a seguir abre um documento de processamento de palavras existente, pesquisa um parágrafo com estilo Heading1 e insere um descendente de contorno antes desse parágrafo.

using System;  
using System.Collections.Generic;  
using System.Linq;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace ParagraphPropertiesEx  
{  
    class Program  
    {  
        // Search all paragraphs of the specified style and make an outline descendant.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\ParagraphPropertiesEx.docx";  
            using (WordprocessingDocument wordprocessingDocument =   
                WordprocessingDocument.Open(fileName, true))  
            {  
                // Get the body element.  
                var body = wordprocessingDocument.MainDocumentPart.Document.Body;  

                //Define a list to store outline Paragraphs  
                var paragraphs = new List<Paragraph>();  

                // Search all Paragraphs that is "Heading1" style.  
                foreach (Paragraph para in body.Descendants<Paragraph>().  
                    Where(e => e.ParagraphProperties != null  
                        && e.ParagraphProperties.ParagraphStyleId != null  
                        && e.ParagraphProperties.ParagraphStyleId.Val == "Heading1"))  
                {  
                    paragraphs.Add(new Paragraph(new Run(new Text(para.InnerText))));  
                }  

                // Need to find whether first child is null, if so, add the paragragh collections to Body.  
                if (body.FirstChild == null)  
                {  
                    body.Append(paragraphs.ToArray());  
                }  

                // Else, get first child and always insert before it.  
                else  
                {  
                    OpenXmlElement first = body.FirstChild;  
                    foreach (Paragraph p in paragraphs)  
                    {  
                        first.InsertBeforeSelf<Paragraph>(p);  
                    }  
                }  
            }  
            Console.WriteLine("All done. Press a key");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System.Collections.Generic  
Imports System.Linq  
Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    ' Search all paragraphs of the specified style and make an outline descendant.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\Users\Public\Documents\ParagraphPropertiesEx.docx"  
        Using wordprocessingDocument As WordprocessingDocument = wordprocessingDocument.Open(fileName, True)  
            ' Get the body element.  
            Dim body = wordprocessingDocument.MainDocumentPart.Document.Body  
            'Define a list to store outline Paragraphs  
            Dim paragraphs = New List(Of Paragraph)()  

            ' Search all Paragraphs that is "Heading1" style.  
            For Each para As Paragraph In body.Descendants(Of Paragraph)().Where(Function(e) e.ParagraphProperties IsNot Nothing AndAlso e.ParagraphProperties.ParagraphStyleId IsNot Nothing AndAlso e.ParagraphProperties.ParagraphStyleId.Val = "Heading1")  
                paragraphs.Add(New Paragraph(New Run(New Text(para.InnerText))))  
            Next  

            ' Need to find whether first child is null, if so, add the paragragh collections to Body.  
            If body.FirstChild Is Nothing Then  
                body.Append(paragraphs.ToArray())  
            Else  
                ' Else, get first child and always insert before it.  
                Dim first As OpenXmlElement = body.FirstChild  
                For Each p As Paragraph In paragraphs  
                    first.InsertBeforeSelf(Of Paragraph)(p)  
                Next  
            End If  
        End Using  
        Console.WriteLine("All done. Press a key")  
        Console.ReadKey()  
    End Sub  
End Module  

Comentários

[ISO/IEC 29500-1 1st Edition]

pPr (propriedades do parágrafo)

Esse elemento especifica um conjunto de propriedades de parágrafo que devem ser aplicadas ao conteúdo do parágrafo pai depois que todas as propriedades de estilo/numeração/tabela tiverem sido aplicadas ao texto. Essas propriedades são definidas como formatação direta, pois são aplicadas diretamente ao parágrafo e substituem qualquer formatação de estilos.

[Exemplo: considere um parágrafo que deve ter um conjunto de propriedades de formatação de parágrafo. Esse conjunto de propriedades é especificado nas propriedades do parágrafo da seguinte maneira:

<w:p>  
  <w:pPr>  
    <w:pBdr>  
      <w:bottom w:val="single" w:sz="8" w:space="4" w:color="4F81BD" />   
    </w:pBdr>  
    <w:spacing w:after="300" />   
    <w:contextualSpacing />   
  </w:pPr>  
</w:p>  

O elemento pPr especifica as propriedades que são aplicadas ao parágrafo atual – nesse caso, uma borda de parágrafo inferior usando o elemento inferior (§17.3.1.7), espaçamento após o parágrafo usando o elemento espaçamento (§17.3.1.33) e esse espaçamento deve ser ignorado para parágrafos acima/abaixo do mesmo estilo usando o elemento contextualSpacing (§17.3.1.9). exemplo final]

Elementos pai
p (§17.3.1.22)

Elementos filho	Subclause
adjustRightInd (ajustar automaticamente o recuo direito ao usar a grade de documentos)	§17.3.1.1
autoSpaceDE (ajustar automaticamente o espaçamento do texto latino e leste asiático)	§17.3.1.2
autoSpaceDN (ajustar automaticamente o espaçamento de texto e números do Leste Asiático)	§17.3.1.3
bidi (layout do parágrafo da direita para a esquerda)	§17.3.1.6
cnfStyle (formatação condicional do parágrafo)	§17.3.1.8
contextualSpacing (ignorar espaçamento acima e abaixo ao usar estilos idênticos)	§17.3.1.9
divId (ID de div html associada)	§17.3.1.10
framePr (propriedades do quadro de texto)	§17.3.1.11
ind (recuo do parágrafo)	§17.3.1.12
jc (Alinhamento de Parágrafo)	§17.3.1.13
keepLines (manter todas as linhas em uma página)	§17.3.1.14
keepNext (manter parágrafo com o próximo parágrafo)	§17.3.1.15
kinsoku (use regras de tipografia do leste asiático para primeiro e último caractere por linha)	§17.3.1.16
mirrorIndents (use recuos esquerdo/direito como recuos internos/externos)	§17.3.1.18
numPr (referência de instância de definição de numeração)	§17.3.1.19
outlineLvl (nível de contorno associado)	§17.3.1.20
overflowPunct (permitir que a pontuação estenda extensões de texto passadas)	§17.3.1.21
pageBreakBefore (parágrafo iniciar na próxima página)	§17.3.1.23
pBdr (bordas do parágrafo)	§17.3.1.24
pPrChange (Informações de revisão para propriedades do parágrafo)	§17.13.5.29
pStyle (estilo de parágrafo referenciado)	§17.3.1.27
rPr (Executar propriedades para a marca de parágrafo)	§17.3.1.29
sectPr (Propriedades da Seção)	§17.6.18
shd (Sombreamento de Parágrafo)	§17.3.1.31
snapToGrid (usar configurações de grade de documento para espaçamento de parágrafo Inter-Line)	§17.3.1.32
espaçamento (espaçamento entre linhas e parágrafo acima/abaixo)	§17.3.1.33
suppressAutoHyphens (suprimir hifenização para parágrafo)	§17.3.1.34
suppressLineNumbers (Suprimir números de linha para parágrafo)	§17.3.1.35
suppressOverlap (impedir que quadros de texto se sobreponham)	§17.3.1.36
guias (Conjunto de paradas de guias personalizadas)	§17.3.1.38
textAlignment (Alinhamento vertical de caracteres na linha)	§17.3.1.39
textboxTightWrap (permitir que parágrafos circundantes envoltórios apertados para conteúdo da caixa de texto)	§17.3.1.40
textDirection (direção de fluxo de texto do parágrafo)	§17.3.1.41
topLinePunct (Pontuação de compressão no início de uma linha)	§17.3.1.43
widowControl (permitir que a primeira/última linha seja exibida em uma página separada)	§17.3.1.44
wordWrap (permitir quebra de linha no nível do caractere)	§17.3.1.45

[Observação: a definição de Esquema XML do W3C do modelo de conteúdo desse elemento (CT_PPr) está localizada em §A.1. nota final]

ISO/IEC29500: 2008.

Construtores

ParagraphProperties()	Inicializa uma nova instância da classe ParagraphProperties.
ParagraphProperties(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe ParagraphProperties com os elementos filho especificados.
ParagraphProperties(OpenXmlElement[])	Inicializa uma nova instância da classe ParagraphProperties com os elementos filho especificados.
ParagraphProperties(String)	Inicializa uma nova instância da classe ParagraphProperties do XML externo.

Propriedades

AdjustRightIndent	AdjustRightIndent. Representa a seguinte marca de elemento no esquema: w:adjustRightInd.
AutoSpaceDE	AutoSpaceDE. Representa a seguinte marca de elemento no esquema: w:autoSpaceDE.
AutoSpaceDN	AutoSpaceDN. Representa a seguinte marca de elemento no esquema: w:autoSpaceDN.
BiDi	Bidi. Representa a seguinte marca de elemento no esquema: w:bidi.
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
ConditionalFormatStyle	ConditionalFormatStyle. Representa a seguinte marca de elemento no esquema: w:cnfStyle.
ContextualSpacing	ContextualSpacing. Representa a seguinte marca de elemento no esquema: w:contextualSpacing.
DivId	DivId. Representa a seguinte marca de elemento no esquema: w:divId.
ExtendedAttributes	Obtém todos os atributos estendidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Essa coleção de recursos será somente leitura, mas herdará recursos de sua parte pai e pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro filho do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
FrameProperties	FrameProperties. Representa a seguinte marca de elemento no esquema: w:framePr.
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos filho. (Herdado de OpenXmlCompositeElement)
Indentation	Recuo. Representa a seguinte marca de elemento no esquema: w:ind.
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os seus filhos. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós filho do nó atual. (Herdado de OpenXmlCompositeElement)
Justification	Justificação. Representa a seguinte marca de elemento no esquema: w:jc.
KeepLines	KeepLines. Representa a seguinte marca de elemento no esquema: w:keepLines.
KeepNext	KeepNext. Representa a seguinte marca de elemento no esquema: w:keepNext.
Kinsoku	Kinsoku. Representa a seguinte marca de elemento no esquema: w:kinsoku.
LastChild	Obtém o último filho do elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MCAttributes	Obtém ou define os atributos de compatibilidade de marcação. Retorna nulo se nenhum atributo de compatibilidade de marcação for definido para o elemento atual. (Herdado de OpenXmlElement)
MirrorIndents	MirrorIndents. Representa a seguinte marca de elemento no esquema: w:mirrorIndents.
NamespaceDeclarations	Obtém todas as declarações de namespace definidas no elemento atual. Retornará um enumerador vazio se não houver nenhuma declaração de namespace. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do namespace do elemento atual. (Herdado de OpenXmlElement)
NumberingProperties	NumberingProperties. Representa a seguinte marca de elemento no esquema: w:numPr.
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os seus elementos filho. (Herdado de OpenXmlElement)
OutlineLevel	OutlineLevel. Representa a seguinte marca de elemento no esquema: w:outlineLvl.
OverflowPunctuation	OverflowPunctuation. Representa a seguinte marca de elemento no esquema: w:overflowPunct.
PageBreakBefore	PageBreakBefore. Representa a seguinte marca de elemento no esquema: w:pageBreakBefore.
ParagraphBorders	ParagraphBorders. Representa a seguinte marca de elemento no esquema: w:pBdr.
ParagraphMarkRunProperties	Execute propriedades para a marca de parágrafo. Representa a seguinte marca de elemento no esquema: w:rPr.
ParagraphPropertiesChange	ParagraphPropertiesChange. Representa a seguinte marca de elemento no esquema: w:pPrChange.
ParagraphStyleId	ParagraphStyleId. Representa a seguinte marca de elemento no esquema: w:pStyle.
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo namespace do elemento atual. (Herdado de OpenXmlElement)
SectionProperties	Propriedades da seção. Representa a seguinte marca de elemento no esquema: w:sectPr.
Shading	Sombreamento. Representa a seguinte marca de elemento no esquema: w:shd.
SnapToGrid	Snaptogrid. Representa a seguinte marca de elemento no esquema: w:snapToGrid.
SpacingBetweenLines	EspaçamentoBetweenLines. Representa a seguinte marca de elemento no esquema: w:espaçamento.
SuppressAutoHyphens	SuppressAutoHyphens. Representa a seguinte marca de elemento no esquema: w:suppressAutoHyphens.
SuppressLineNumbers	SuppressLineNumbers. Representa a seguinte marca de elemento no esquema: w:suppressLineNumbers.
SuppressOverlap	SuppressOverlap. Representa a seguinte marca de elemento no esquema: w:suppressOverlap.
Tabs	Guias. Representa a seguinte marca de elemento no esquema: w:tabs.
TextAlignment	Textalignment. Representa a seguinte marca de elemento no esquema: w:textAlignment.
TextBoxTightWrap	TextBoxTightWrap. Representa a seguinte marca de elemento no esquema: w:textboxTightWrap.
TextDirection	Textdirection. Representa a seguinte marca de elemento no esquema: w:textDirection.
TopLinePunctuation	TopLinePunctuation. Representa a seguinte marca de elemento no esquema: w:topLinePunct.
WidowControl	WidowControl. Representa a seguinte marca de elemento no esquema: w:widowControl.
WordWrap	Wordwrap. Representa a seguinte marca de elemento no esquema: w:wordWrap.
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se ele for uma criança conhecida. Isso adiciona o elemento no local correto de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de namespace ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os ancestrais do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os ancestrais do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos até o final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao final da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos estendidos. (Herdado de OpenXmlElement)
Clone()	Cria uma duplicata do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria uma duplicata desse nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumera todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os filhos do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os filhos do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos irmãos que seguem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos irmãos que precedem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da marca e o URI do namespace especificados. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento filho no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos filhos do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual é exibido após um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual é exibido antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
LookupNamespace(String)	Resolve o prefixo namespace no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um uri de namespace no escopo do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum próximo elemento OpenXmlElement. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver o próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic ) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Remove()	Remove o elemento atual de seu pai. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos filho do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos filho do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento filho especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace do prefixo especificado. Não removerá nada se não houver nenhum prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos filho do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo será definido. Se o atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define uma série de atributos para o elemento. Se um atributo for um atributo conhecido, o valor do atributo será definido. Se um atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Salva o nó atual no XmlWriter especificado. (Herdado de OpenXmlElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Propriedades do parágrafo. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:pPr. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)