Obtenir le contenu d’un composant de document à partir d’un package

Article
11/16/2023

Cette rubrique montre comment utiliser les classes du Kit de développement logiciel (SDK) Open XML pour Office afin de récupérer le contenu d’un composant de document dans un document Wordprocessing par programmation.

Packages et parties de documents

Un document Open XML est stocké en tant que package, dont le format est défini par la norme ISO/IEC 29500-2. Le package peut contenir plusieurs parties avec des relations entre elles. La relation entre les parties détermine la catégorie du document. Un document peut être défini comme un document de traitement de texte si son élément de relation de package contient une relation avec une partie principale de document. Si son élément de relation de package contient une relation avec une partie de présentation, il peut être défini comme un document de présentation. Si son élément de relation de package contient une relation avec une partie de classeur, il est défini en tant que feuille de calcul. Dans cette rubrique, vous utiliserez un package de documents de traitement de texte.

Obtention d’un objet WordprocessingDocument

Le code commence par l’ouverture d’un fichier de package en passant un nom de fichier à l’une des méthodes Open() surchargées (méthode partagée Visual Basic .NET ou méthode statique C#) de la classe WordprocessingDocument qui prend une chaîne et une valeur booléenne qui spécifie si le fichier doit être ouvert en mode lecture/écriture ou non. Dans le cas présent, la valeur booléenne est false, spécifiant que le fichier doit être ouvert en mode lecture seule pour éviter les modifications accidentelles.

C#
Visual Basic

    // Open a Wordprocessing document for editing.
    using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, false))
    {
          // Insert other code here.
    }

    ' Open a Wordprocessing document for editing.
    Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, False)
        ' Insert other code here.
    End Using

L'instruction using fournit une alternative recommandée à la séquence .Create, .Save, .Close habituelle. Elle garantit que la méthode Dispose (méthode interne utilisée par le kit de développement Open XML pour nettoyer les ressources) est automatiquement appelée lorsque l'accolade de fermeture est atteinte. Le bloc qui suit l’instruction using établit une étendue pour l’objet créé ou nommé dans l’instruction using, dans le cas présent wordDoc. Étant donné que la classe WordprocessingDocument dans le Kit de développement logiciel (SDK) Open XML enregistre et ferme automatiquement l’objet dans le cadre de son implémentation System.IDisposable , et que la méthode Dispose est automatiquement appelée lorsque vous quittez le bloc ; vous n’avez pas besoin d’appeler explicitement Enregistrer et Fermer, tant que vous utilisez l’utilisation.

Structure d’un document WordProcessingML

La structure de base d’un document WordProcessingML se compose des éléments document et body , suivis d’un ou plusieurs éléments de niveau bloc tels que p, qui représente un paragraphe. Un paragraphe contient un ou plusieurs éléments r. Le r signifie « run » (exécution), qui est une zone de texte avec un ensemble de propriétés courant, comme par exemple la mise en forme. Une exécution contient un ou plusieurs éléments t. L'élément t contient une plage de texte. L’exemple de code suivant montre le balisage WordprocessingML pour un document qui contient le texte « Exemple de texte ».

    <w:document xmlns:w="https://schemas.openxmlformats.org/wordprocessingml/2006/main">
      <w:body>
        <w:p>
          <w:r>
            <w:t>Example text.</w:t>
          </w:r>
        </w:p>
      </w:body>
    </w:document>

À l’aide du Kit de développement logiciel (SDK) Open XML, vous pouvez créer une structure de document et du contenu à l’aide de classes fortement typées qui correspondent à des éléments WordprocessingML . Vous trouverez ces classes dans l'espace de noms DocumentFormat.OpenXml.Wordprocessing . Le tableau suivant répertorie les noms des classes qui correspondent aux éléments document, body, p, r et t.

Élément WordprocessingML	Classe du Kit de développement logiciel (SDK) Open XML	Description
document	Document	Élément racine de la partie principale du document.
body	Body	Conteneur des structures de niveau bloc, telles que paragraphs, tables, annotations et autres structures décrites dans la spécification ISO/IEC 29500.
p	Paragraph	Paragraphe.
r	Run	Exécution.
t	Text	Plage de texte.

Pour plus d’informations sur la structure globale des parties et éléments d’un document WordprocessingML, consultez Structure d’un document WordprocessingML.

Élément comments

Dans cette rubrique de procédure, vous allez travailler avec des commentaires. Par conséquent, il est utile de vous familiariser avec la structure de l’élément <comments> . Les informations suivantes de la spécification ISO/IEC 29500 peuvent être utiles lors de l’utilisation de cet élément.

Cet élément spécifie tous les commentaires définis dans le document actuel. Il s’agit de l’élément racine de la partie commentaires d’un document WordprocessingML. Considérez le fragment WordprocessingML suivant pour le contenu d’un composant de commentaires dans un document WordprocessingML :

    <w:comments>
      <w:comment … >
        …
      </w:comment>
    </w:comments>

L’élément comments contient le commentaire spécifié par ce document dans cet exemple.

Le fragment de schéma XML suivant définit le contenu de cet élément.

    <complexType name="CT_Comments">
       <sequence>
           <element name="comment" type="CT_Comment" minOccurs="0" maxOccurs="unbounded"/>
       </sequence>
    </complexType>

Fonctionnement de l’exemple de code

Après avoir ouvert le fichier source en lecture, vous créez un objet mainPart en instanciant le MainDocumentPart. Ensuite, vous créez une référence au composant WordprocessingCommentsPart du document.

C#
Visual Basic

    // To get the contents of a document part.
    public static string GetCommentsFromDocument(string document)
    {
        string comments = null;

        using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
        {
            MainDocumentPart mainPart = wordDoc.MainDocumentPart;
            WordprocessingCommentsPart WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart;

    ' To get the contents of a document part.
    Public Shared Function GetCommentsFromDocument(ByVal document As String) As String
        Dim comments As String = Nothing

        Using wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, True)
            Dim mainPart As MainDocumentPart = wordDoc.MainDocumentPart
            Dim WordprocessingCommentsPart As WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart

Vous pouvez utiliser un objet StreamReader pour lire le contenu du composant WordprocessingCommentsPart du document et retourner son contenu.

C#
Visual Basic

    using (StreamReader streamReader = new StreamReader(WordprocessingCommentsPart.GetStream()))
            {
                comments = streamReader.ReadToEnd();
            }
        }
        return comments;

    Using streamReader As New StreamReader(WordprocessingCommentsPart.GetStream())
    comments = streamReader.ReadToEnd()
    End Using
    Return comments

Exemple de code

L’exemple de code suivant extrait le contenu d’un composant WordprocessingCommentsPart contenu dans un package de document WordProcessing. Vous pouvez exécuter le programme en appelant la méthode GetCommentsFromDocument comme le montre l’exemple suivant.

C#
Visual Basic

    string document = @"C:\Users\Public\Documents\MyPkg5.docx";
    GetCommentsFromDocument(document);

    Dim document As String = "C:\Users\Public\Documents\MyPkg5.docx"
    GetCommentsFromDocument(document)

Voici l'exemple de code complet en C# et Visual Basic.

C#
Visual Basic


using DocumentFormat.OpenXml.Packaging;
using System;
using System.IO;

GetCommentsFromDocument(args[0]);

// To get the contents of a document part.
static string GetCommentsFromDocument(string document)
{
    string? comments = null;

    using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, false))
    {
        if (wordDoc is null)
        {
            throw new ArgumentNullException(nameof(wordDoc));
        }

        MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();
        WordprocessingCommentsPart WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart ?? mainPart.AddNewPart<WordprocessingCommentsPart>();

        using (StreamReader streamReader = new StreamReader(WordprocessingCommentsPart.GetStream()))
        {
            comments = streamReader.ReadToEnd();
        }
    }

    return comments;
}

Imports System.IO
Imports DocumentFormat.OpenXml.Packaging


Module MyModule

    Sub Main(args As String())
    End Sub

    ' To get the contents of a document part.
    Public Function GetCommentsFromDocument(ByVal document As String) As String
        Dim comments As String = Nothing
        Dim wordDoc As WordprocessingDocument = WordprocessingDocument.Open(document, False)
        Dim mainPart As MainDocumentPart = wordDoc.MainDocumentPart
        Dim WordprocessingCommentsPart As WordprocessingCommentsPart = mainPart.WordprocessingCommentsPart
        Dim streamReader As StreamReader = New StreamReader(WordprocessingCommentsPart.GetStream)
        comments = streamReader.ReadToEnd
        Return comments
    End Function
End Module

Voir aussi

Informations de référence sur la bibliothèque de classes du Kit de développement logiciel (SDK) Open XML

Partager via