Extraire le contenu entre les nœuds d'un document
Lorsque vous travaillez avec des documents, il est important de pouvoir extraire facilement le contenu d’une plage spécifique au sein d’un document. Cependant, le contenu peut être constitué d’éléments complexes tels que des paragraphes, des tableaux, des images, etc.
Quel que soit le contenu à extraire, la méthode d’extraction de ce contenu sera toujours déterminée par les nœuds sélectionnés pour extraire le contenu. Il peut s’agir de corps de texte entiers ou de simples passages de texte.
Il existe de nombreuses situations possibles et donc de nombreux types de nœuds différents à prendre en compte lors de l’extraction de contenu. Par exemple, vous souhaiterez peut-être extraire du contenu entre:
- Deux paragraphes spécifiques
- Des séquences de texte spécifiques
- Champs de différents types, tels que les champs de fusion
- Plages de début et de fin d’un signet ou d’un commentaire
- Divers corps de texte contenus dans des sections distinctes
Dans certaines situations, vous devrez peut-être même combiner différents types de nœuds, comme extraire du contenu entre un paragraphe et un champ, ou entre une exécution et un signet.
Cet article fournit l’implémentation du code pour extraire du texte entre différents nœuds, ainsi que des exemples de scénarios courants.
Pourquoi extraire du contenu
Souvent, l’objectif de l’extraction du contenu est de le dupliquer ou de l’enregistrer séparément dans un nouveau document. Par exemple, vous pouvez extraire du contenu et:
- Copiez-le dans un document séparé
- Convertir une partie spécifique d’un document en PDF ou en image
- Dupliquer le contenu du document plusieurs fois
- Travailler avec du contenu extrait séparé du reste du document
Cela peut être facilement réalisé en utilisant Aspose.Words et l’implémentation du code ci-dessous.
Algorithme d’extraction de contenu
Le code de cette section aborde toutes les situations possibles décrites ci-dessus avec une méthode généralisée et réutilisable. Les grandes lignes de cette technique impliquent:
- Rassembler les nœuds qui dictent la zone de contenu qui sera extraite de votre document. La récupération de ces nœuds est gérée par l’utilisateur dans son code, en fonction de ce qu’il souhaite extraire.
- Passer ces nœuds à la méthode ExtractContent fournie ci-dessous. Vous devez également passer un paramètre booléen qui indique si ces nœuds, faisant office de marqueurs, doivent être inclus ou non dans l’extraction.
- Récupération d’une liste de contenu cloné (nœuds copiés) spécifié pour être extrait. Vous pouvez utiliser cette liste de nœuds de n’importe quelle manière applicable, par exemple en créant un nouveau document contenant uniquement le contenu sélectionné.
Comment extraire du contenu
Pour extraire le contenu de votre document, vous devez appeler la méthode ExtractContent ci-dessous et transmettre les paramètres appropriés. La base sous-jacente de cette méthode consiste à rechercher des nœuds au niveau des blocs (paragraphes et tableaux) et à les cloner pour créer des copies identiques. Si les nœuds marqueurs transmis sont au niveau du bloc, la méthode peut simplement copier le contenu à ce niveau et l’ajouter au tableau.
Cependant, si les nœuds marqueurs sont en ligne (un enfant d’un paragraphe), la situation devient alors plus complexe, car il est nécessaire de diviser le paragraphe au niveau du nœud en ligne, qu’il s’agisse d’une exécution, de champs de signet, etc. Le contenu des nœuds parents clonés n’est pas présent entre les marqueurs est supprimé. Ce processus est utilisé pour garantir que les nœuds en ligne conserveront toujours la mise en forme du paragraphe parent. La méthode exécutera également des vérifications sur les nœuds passés en paramètres et lèvera une exception si l’un des nœuds n’est pas valide. Les paramètres à passer à cette méthode sont:
- StartNode et EndNode. Les deux premiers paramètres sont les nœuds qui définissent respectivement où l’extraction du contenu doit commencer et se terminer. Ces nœuds peuvent être à la fois au niveau bloc (Paragraph, Table) ou au niveau en ligne (par exemple Run, FieldStart, BookmarkStart etc.):
- Pour transmettre un champ, vous devez transmettre l’objet FieldStart correspondant
- Pour transmettre les signets, les nœuds BookmarkStart et BookmarkEnd doivent être transmis
- Pour transmettre des commentaires, les nœuds CommentRangeStart et CommentRangeEnd doivent être utilisés
- IsInclusive. Définit si les marqueurs sont inclus dans l’extraction ou non. Si cette option est définie sur false et que le même nœud ou des nœuds consécutifs sont transmis, alors une liste vide sera renvoyée:
- Si un nœud FieldStart est transmis, cette option définit si tout le champ doit être inclus ou exclu
- Si un nœud BookmarkStart ou BookmarkEnd est passé, cette option définit si le signet est inclus ou simplement le contenu entre la plage du signet.
- Si un nœud CommentRangeStart ou CommentRangeEnd est transmis, cette option définit si le commentaire lui-même doit être inclus ou uniquement le contenu de la plage de commentaires.
La mise en œuvre de la méthode ExtractContent, vous pouvez trouver sur Aspose.Words GitHub. Cette méthode sera évoquée dans les scénarios de cet article.
Nous définirons également une méthode personnalisée pour générer facilement un document à partir des nœuds extraits. Cette méthode est utilisée dans de nombreux scénarios ci-dessous et crée simplement un nouveau document et y importe le contenu extrait.
L’exemple de code suivant montre comment prendre une liste de nœuds et les insérer dans un nouveau document:
Extraire le contenu entre les paragraphes
Cela montre comment utiliser la méthode ci-dessus pour extraire le contenu entre des paragraphes spécifiques. Dans ce cas, nous souhaitons extraire le corps de la lettre trouvée dans la première moitié du document. Nous pouvons dire que cela se situe entre le 7ème et le 11ème paragraphe.
Le code ci-dessous accomplit cette tâche. Les paragraphes appropriés sont extraits à l’aide de la méthode GetChild sur le document et en passant les indices spécifiés. Nous transmettons ensuite ces nœuds à la méthode ExtractContent et déclarons qu’ils doivent être inclus dans l’extraction. Cette méthode renverra le contenu copié entre ces nœuds qui sera ensuite inséré dans un nouveau document.
L’exemple de code suivant montre comment extraire le contenu entre des paragraphes spécifiques à l’aide de la méthode ExtractContent ci-dessus:
Extraire du contenu entre différents types de nœuds
Nous pouvons extraire du contenu entre n’importe quelle combinaison de niveaux de bloc ou de nœuds en ligne. Dans ce scénario ci-dessous, nous extrairons le contenu entre le premier paragraphe et le tableau de la deuxième section inclusivement. Nous obtenons les nœuds marqueurs en appelant les méthodes FirstParagraph et GetChild sur la deuxième section du document pour récupérer les nœuds Paragraph et Table appropriés. Pour une légère variation, dupliquons plutôt le contenu et insérons-le sous l’original.
L’exemple de code suivant montre comment extraire le contenu entre un paragraphe et un tableau à l’aide de la méthode ExtractContent:
Extraire le contenu entre les paragraphes en fonction du style
Vous devrez peut-être extraire le contenu entre des paragraphes de style identique ou différent, par exemple entre des paragraphes marqués de styles de titre. Le code ci-dessous montre comment y parvenir. Il s’agit d’un exemple simple qui extraira le contenu entre la première instance des styles “Titre 1” et “En-tête 3” sans extraire également les titres. Pour ce faire, nous définissons le dernier paramètre sur false, qui spécifie que les nœuds marqueurs ne doivent pas être inclus.
Dans une implémentation appropriée, cela doit être exécuté en boucle pour extraire le contenu entre tous les paragraphes de ces styles du document. Le contenu extrait est copié dans un nouveau document.
L’exemple de code suivant montre comment extraire le contenu entre des paragraphes avec des styles spécifiques à l’aide de la méthode ExtractContent:
Extraire le contenu entre des exécutions spécifiques
Vous pouvez également extraire du contenu entre des nœuds en ligne tels qu’un Run. Les Runs de différents paragraphes peuvent être transmis comme marqueurs. Le code ci-dessous montre comment extraire un texte spécifique entre le même nœud Paragraph.
L’exemple de code suivant montre comment extraire le contenu entre des exécutions spécifiques du même paragraphe à l’aide de la méthode ExtractContent:
Extraire du contenu à l’aide d’un champ
Pour utiliser un champ comme marqueur, il faut passer le nœud FieldStart. Le dernier paramètre de la méthode ExtractContent définira si l’intégralité du champ doit être inclus ou non. Extrayons le contenu entre le champ de fusion “FullName” et un paragraphe du document. Nous utilisons la méthode MoveToMergeField de la classe DocumentBuilder. Cela renverra le nœud FieldStart à partir du nom du champ de fusion qui lui a été transmis.
Dans notre cas, définissons le dernier paramètre passé à la méthode ExtractContent sur false pour exclure le champ de l’extraction. Nous rendrons le contenu extrait au format PDF.
L’exemple de code suivant montre comment extraire le contenu entre un champ et un paragraphe spécifiques du document à l’aide de la méthode ExtractContent:
Extraire le contenu d’un signet
Dans un document, le contenu défini dans un signet est encapsulé par les nœuds BookmarkStart et BookmarkEnd. Le contenu trouvé entre ces deux nœuds constitue le signet. Vous pouvez transmettre l’un ou l’autre de ces nœuds comme n’importe quel marqueur, même ceux provenant de différents signets, à condition que le marqueur de début apparaisse avant le marqueur de fin dans le document. Nous allons extraire ce contenu dans un nouveau document en utilisant le code ci-dessous. L’option du paramètre IsInclusive montre comment conserver ou supprimer le signet.
L’exemple de code suivant montre comment extraire le contenu référencé par un signet à l’aide de la méthode ExtractContent:
Extraire le contenu d’un commentaire
Un commentaire est composé des nœuds CommentRangeStart, CommentRangeEnd et Comment. Tous ces nœuds sont en ligne. Les deux premiers nœuds encapsulent le contenu du document référencé par le commentaire, comme le montre la capture d’écran ci-dessous.
Le nœud Comment lui-même est un InlineStory qui peut contenir des paragraphes et des séquences. Il représente le message du commentaire tel qu’il apparaît sous la forme d’une bulle de commentaire dans le volet de révision. Comme ce nœud est en ligne et descendant d’un corps, vous pouvez également extraire le contenu de ce message.
Le commentaire résume le titre, le premier paragraphe et le tableau de la deuxième section. Extrayons ce commentaire dans un nouveau document. L’option IsInclusive indique si le commentaire lui-même est conservé ou supprimé.
L’exemple de code suivant montre comment procéder:
Comment extraire du contenu à l’aide de DocumentVisitor
Utilisez la classe DocumentVisitor pour implémenter ce scénario d’utilisation. Cette classe correspond au modèle de conception Visiteur bien connu. Avec DocumentVisitor ,, vous pouvez définir et exécuter des opérations personnalisées qui nécessitent une énumération dans l’arborescence du document.
DocumentVisitor fournit un ensemble de méthodes VisitXXX qui sont invoquées lorsqu’un élément de document (nœud) particulier est rencontré. Par exemple, VisitParagraphStart est appelé lorsque le début d’un paragraphe de texte est trouvé et VisitParagraphEnd est appelé lorsque la fin d’un paragraphe de texte est trouvée. Chaque méthode DocumentVisitor.VisitXXX accepte l’objet correspondant qu’elle rencontre afin que vous puissiez l’utiliser selon vos besoins (par exemple, récupérer le formatage), par exemple, DocumentVisitor.VisitParagraphStart et DocumentVisitor.VisitParagraphEnd acceptent un objet Paragraph.
Chaque méthode DocumentVisitor.VisitXXX renvoie une valeur VisitorAction qui contrôle l’énumération des nœuds. Vous pouvez demander soit de continuer l’énumération, soit d’ignorer le nœud actuel (mais de continuer l’énumération), soit d’arrêter l’énumération des nœuds.
Voici les étapes à suivre pour déterminer et extraire par programme différentes parties d’un document:
- Créer une classe dérivée de DocumentVisitor
- Remplacer et fournir des implémentations pour tout ou partie des méthodes DocumentVisitor.VisitXXX pour effectuer certaines opérations personnalisées
- Appelez Node.Accept sur le nœud à partir duquel vous souhaitez démarrer l’énumération, par exemple, si vous souhaitez énumérer l’ensemble du document, utilisez Document.Accept
DocumentVisitor fournit des implémentations par défaut pour toutes les méthodes DocumentVisitor.VisitXXX. Cela facilite la création de nouveaux visiteurs de documents, car seules les méthodes requises pour le visiteur particulier doivent être remplacées. Il n’est pas nécessaire de remplacer toutes les méthodes du visiteur.
L’exemple suivant montre comment utiliser le modèle Visiteur pour ajouter de nouvelles opérations au modèle objet Aspose.Words. Dans ce cas, nous créons un simple convertisseur de document au format texte:
Comment extraire du texte uniquement
Les façons de récupérer le texte du document sont les suivantes:
- Utilisez Document.Save avec SaveFormat.Text pour enregistrer sous forme de texte brut dans un fichier ou un flux
- Utilisez Node.ToString et transmettez le paramètre SaveFormat.Text. En interne, cela appelle l’enregistrement en tant que texte dans un flux mémoire et renvoie la chaîne résultante
- Utilisez Node.GetText pour récupérer le texte avec tous les caractères de contrôle Microsoft Word, y compris les codes de champ
- Implémenter un DocumentVisitor personnalisé pour effectuer une extraction personnalisée
Utiliser Node.GetText et Node.ToString
Un document Word peut contenir des caractères de contrôle qui désignent des éléments spéciaux tels qu’un champ, une fin de cellule, une fin de section, etc. La liste complète des caractères de contrôle Word possibles est définie dans la classe ControlChar. La méthode Node.GetText renvoie du texte avec tous les caractères de contrôle présents dans le nœud.
L’appel de ToString renvoie la représentation en texte brut du document uniquement sans caractères de contrôle. Pour plus d’informations sur l’exportation en texte brut, voir la section suivante “Utilisation de SaveFormat.Text”.
L’exemple de code suivant montre la différence entre l’appel des méthodes GetText et ToString sur un nœud:
Utiliser SaveFormat.Text
Cet exemple enregistre le document comme suit:
- Filtre les caractères de champ et les codes de champ, les références de forme, de note de bas de page, de note de fin et de commentaire
- Remplace les caractères ControlChar.Cr de fin de paragraphe par des combinaisons ControlChar.CrLf
- Utilise l’encodage UTF8
L’exemple de code suivant montre comment enregistrer un document au format TXT:
Extraire des images de formes
Vous devrez peut-être extraire des images de documents pour effectuer certaines tâches. Aspose.Words vous permet également de le faire.
L’exemple de code suivant montre comment extraire des images d’un document: