Arbeiten mit Läufen

In diesem Thema wird die Open XML SDK-Klasse Run und ihre Beziehung zum WordprocessingML-Schema des Open XML-Dateiformats erläutert.

Läufe in WordprocessingML

Im folgenden Text aus der Spezifikation ISO/IEC 29500 wird das Open XML WordprocessingML-Laufelement eingeführt.

The next level of the document hierarchy [after the paragraph] is the run, which defines a region of text with a common set of properties. A run is represented by an r element, which allows the producer to combine breaks, styles, or formatting properties, applying the same information to all the parts of the run.

Just as a paragraph can have properties, so too can a run. All of the elements inside an r element have their properties controlled by a corresponding optional rPr run properties element, which must be the first child of the r element. In turn, the rPr element is a container for a set of property elements that are applied to the rest of the children of the r element. The elements inside the rPr container element allow the consumer to control whether the text in the following t elements is bold, underlined, or visible, for example. Beispiele für Laufeigenschaften sind etwa Fett, Rahmen, Zeichenformatvorlage, Farbe, Schriftart, Schriftgrad, Kursiv, Kerning, Rechtschreib- und Grammatikprüfung deaktivieren, Schattierung, Kapitälchen, Durchgestrichen, Textrichtung und Unterstrichen.

© ISO/IEC 29500: 2016

In der folgenden Tabelle sind die Open XML SDK-Klassen aufgeführt, die beim Arbeiten mit Läufen am häufigsten verwendet werden.

Run-Klasse

Die Open XML SDK-Klasse Run stellt das run-Element <r> dar, das wie oben beschrieben im Open XML-Dateiformatschema für WordprocessingML-Dokumente definiert ist. Verwenden Sie ein Run-Objekt , um ein einzelnes <r> Element in einem WordprocessingML-Dokument zu bearbeiten.

RunProperties-Klasse

In WordprocessingML werden die Eigenschaften für ein Run-Element mithilfe des Run Properties-Elements <rPr> angegeben. Beispiele für Laufeigenschaften sind etwa Fett, Rahmen, Zeichenformatvorlage, Farbe, Schriftart, Schriftgrad, Kursiv, Kerning, Rechtschreib- und Grammatikprüfung deaktivieren, Schattierung, Kapitälchen, Durchgestrichen, Textrichtung und Unterstrichen. Verwenden Sie ein RunProperties -Objekt, um die Eigenschaften für eine Ausführung in einem WordprocessingML-Dokument festzulegen.

Text-Objekt

<r> Beim -Element ist das Textelement (<t>) der Container für den Text, aus dem der Dokumentinhalt besteht. Die OXML SDK-Klasse Text stellt das <t> -Element dar. Verwenden Sie ein Text-Objekt zum Platzieren von Text in einem Wordprocessing-Dokument.

Open XML SDK-Codebeispiel

Der folgende Code fügt der Standard Dokumentoberfläche des angegebenen WordprocessingML-Dokuments Text hinzu. Ein Run-Objekt grenzt einen Textbereich innerhalb des Absatzes ab, und dann wird ein RunProperties-Objekt verwendet, um fett formatiert auf die Ausführung anzuwenden.

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

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())
        WriteToWordDoc(args(0), args(1))
    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

Bei Ausführung des Codes wird folgende XML in das im vorherigen Code angegebene WordprocessingML-Dokument geschrieben.

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

Siehe auch

Informationen zum Open XML SDK für Office

Arbeiten mit Absätzen

Vorgehensweise: Anwenden einer Formatvorlage auf einen Absatz in einem Dokument aus einem Textverarbeitungsprogramm

Vorgehensweise: Öffnen und Hinzufügen von Text in einem Textverarbeitungsdokument