Utilisation des séquences

Article
11/16/2023

Cette rubrique décrit la classe Run du Kit de développement logiciel (SDK) Open XML et sa relation avec le schéma WordprocessingML au format de fichier Open XML.

Séquences dans WordprocessingML

Le texte suivant de la spécification ISO/IEC 29500 présente l’élément d’exécution WordprocessingML Open XML.

Le niveau suivant dans la hiérarchie du document [en dessous du paragraphe] est la séquence, qui définit une région de texte ayant un ensemble commun de propriétés. Une séquence est représentée par un élément r, qui permet au producteur de combiner des ruptures, des styles ou des propriétés de mise en forme, qui s’appliquent à toutes les parties de la séquence.

Tout comme un paragraphe, une séquence peut avoir des propriétés. Tous les éléments à l’intérieur d’un élément r peuvent avoir leurs propriétés contrôlées par un élément correspondant facultatif rPr, qui doit être le premier enfant de l’élément r. À son tour, l’élément rPr est conteneur d’un ensemble d’éléments propriété qui sont appliqués au reste des enfants de l’élément r. Les éléments à l’intérieur du conteneur rPr permettent au consommateur de contrôler si le texte dans les éléments t suivant est en gras, souligné ou visible, par exemple. Voici des exemples de propriétés de séquence : gras, bordure, style de caractères, couleur, police, taille de police, italique, crénage, désactiver la vérification de l’orthographe ou de la grammaire, ombrage, petites majuscules, barré, orientation du texte et souligné.

Le tableau suivant répertorie les classes Open XML SDK les plus courantes utilisées lors du travail avec les séquences.

Élément XML	Classe du Kit de développement logiciel (SDK) Open XML
p	Paragraphe
Rpr	Runproperties
t	Texte

Classe Run

La classeRun du Kit de développement logiciel (SDK) Open XML représente l’élément run (<r>) défini dans le schéma de format de fichier Open XML pour les documents WordprocessingML, comme indiqué ci-dessus. Utilisez un objet Run pour manipuler un élément r> individuel < dans un document WordprocessingML.

Classe RunProperties

Dans WordprocessingML, les propriétés d’un élément run sont spécifiées à l’aide de l’élément run properties (<rPr>). Voici des exemples de propriétés de séquence : gras, bordure, style de caractères, couleur, police, taille de police, italique, crénage, désactiver la vérification de l’orthographe ou de la grammaire, ombrage, petites majuscules, barré, orientation du texte et souligné. Utilisez un objet RunProperties pour définir les propriétés d’une exécution dans un document WordprocessingML.

Objet Text

Avec l’élément <r> , l’élément text (<t>) est le conteneur du texte qui compose le contenu du document. La classe Text du Kit de développement logiciel (SDK) OXML représente l’élément <t> . Utilisez un objet Text pour placer du texte dans un document Wordprocessing.

Exemple de code du Kit de développement logiciel (SDK) Open XML

Le code suivant ajoute du texte de surface au document principal du document WordprocessingML spécifié. Un objet Run démarque une région de texte à l’intérieur du paragraphe, puis un objet RunProperties est utilisé pour appliquer une mise en forme gras à la séquence.

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

À l’exécution de ce code, le code XML suivant est écrit dans le document WordprocessingML spécifié dans le code précédent.

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

Voir aussi

À propos du Kit de développement logiciel (SDK) Open XML pour Office

Utilisation des paragraphes

Appliquer un style à un paragraphe dans un document de traitement de texte

Procédure : Ouvrir et ajouter du texte à un document de traitement de texte

Partager via