Como trabalhar com execuções

Artigo
11/16/2023

Este tópico discute a classe Open XML SDK Run e como ela se relaciona com o esquema WordprocessingML do Formato de Arquivo XML Aberto.

Execuções no WordprocessingML

O texto a seguir da especificação ISO/IEC 29500 apresenta o elemento de execução Open XML WordprocessingML.

O próximo nível da hierarquia do documento [após o parágrafo] é a execução, que define uma região de texto com um conjunto comum de propriedades. Uma execução é representada por um elemento r, que permite ao produtor combinar quebras, estilos ou propriedades de formatação, aplicando as mesmas informações a todas as partes da execução.

Assim como um parágrafo pode ter propriedades, uma execução também pode ser executada. Todos os elementos dentro de um elemento r têm suas propriedades controladas por um elemento de propriedades de execução rPr opcional correspondente, que deve ser o primeiro filho do elemento r. Por sua vez, o elemento rPr é um contêiner para um conjunto de elementos de propriedade que são aplicados ao restante dos filhos do elemento r. Os elementos dentro do elemento de contêiner rPr permitem que o consumidor controle se o texto nos seguintes elementos t é negrito, sublinhado ou visível, por exemplo. Alguns exemplos de propriedades de execução são negrito, borda, estilo de caractere, cor, fonte, tamanho da fonte, itálico, kerning, disable spelling/grammar marcar, sombreamento, small caps, strikethrough, direção de texto e sublinhado.

A tabela a seguir lista as classes de SDK Open XML mais comuns usadas ao trabalhar com execuções.

Elemento XML	Classe SDK Open XML
p	Paragraph
Rpr	RunProperties
T	Texto

Classe Run

A classe Open XML SDKRun representa o elemento run (<r>) definido no esquema Open XML File Format para documentos WordprocessingML, conforme discutido acima. Use um objeto Run para manipular um elemento r> individual < em um documento wordprocessingML.

Classe RunProperties

No WordprocessingML, as propriedades de um elemento de execução são especificadas usando o elemento rPr> (<propriedades de execução). Alguns exemplos de propriedades de execução são negrito, borda, estilo de caractere, cor, fonte, tamanho da fonte, itálico, kerning, disable spelling/grammar marcar, sombreamento, small caps, strikethrough, direção de texto e sublinhado. Use um objeto RunProperties para definir as propriedades para uma execução em um documento WordprocessingML.

Objeto Text

Com o < elemento r>, o elemento de texto (<t>) é o contêiner para o texto que compõe o conteúdo do documento. A classe de texto SDK OXML representa o < elemento t>. Use um objeto Text para colocar texto em um documento de processamento do Word.

Abrir o exemplo de código do SDK XML

O código a seguir adiciona texto à superfície do documento main do documento WordprocessingML especificado. Um objeto Run demarca uma região de texto no parágrafo e, em seguida, um objeto RunProperties é usado para aplicar a formatação em negrito à execução.

C#
Visual Basic

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;

WriteToWordDoc(args[0], args[1]);

static void WriteToWordDoc(string filepath, string txt)
{
    // Open a WordprocessingDocument for editing using the filepath.
    using (WordprocessingDocument wordprocessingDocument = WordprocessingDocument.Open(filepath, true))
    {
        // Assign a reference to the existing document body.
        MainDocumentPart mainDocumentPart = wordprocessingDocument.MainDocumentPart ?? wordprocessingDocument.AddMainDocumentPart();
        mainDocumentPart.Document ??= new Document();
        Body body = mainDocumentPart.Document.Body ?? mainDocumentPart.Document.AppendChild(new Body());

        // Add new text.
        Paragraph para = body.AppendChild(new Paragraph());
        Run run = para.AppendChild(new Run());

        // Apply bold formatting to the run.
        RunProperties runProperties = run.AppendChild(new RunProperties(new Bold()));
        run.AppendChild(new Text(txt));
    }
}

Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Wordprocessing

Module MyModule

    Sub Main(args As String())
    End Sub

    Public Sub WriteToWordDoc(ByVal filepath As String, ByVal txt As String)
        ' Open a WordprocessingDocument for editing using the filepath.
        Using wordprocessingDocument As WordprocessingDocument =
            WordprocessingDocument.Open(filepath, True)
            ' Assign a reference to the existing document body.
            Dim body As Body = wordprocessingDocument.MainDocumentPart.Document.Body

            ' Add new text.
            Dim para As Paragraph = body.AppendChild(New Paragraph())
            Dim run As Run = para.AppendChild(New Run())

            ' Apply bold formatting to the run.
            Dim runProperties As RunProperties = run.AppendChild(New RunProperties(New Bold()))
            run.AppendChild(New Text(txt))
        End Using
    End Sub
End Module

Quando esse código é executado, o XML a seguir é gravado no documento WordprocessingML especificado no código anterior.

    <w:p>
      <w:r>
        <w:rPr>
          <w:b />
        </w:rPr>
        <w:t>String from WriteToWordDoc method.</w:t>
      </w:r>
    </w:p>

Confira também

Sobre o SDK do Open XML para Office

Como trabalhar com parágrafos

Como aplicar um estilo a um parágrafo em um documento de processamento de palavras

Como abrir e adicionar texto a um documento de processamento de palavras

Compartilhar via