C# Document Element Tutorial
IronWord est une puissante bibliothèque de documents Word conçue pour aider les développeurs .NET C# à intégrer les fonctionnalités de création, de lecture et de modification de documents Word et DOCX dans leurs applications. Dans le contexte d'un document Word, les éléments du document sont les composants de base qui constituent le contenu.
Démarrage rapide : Créer un TextRun stylisé et y intégrer une image
Voici comment utiliser IronWord pour ajouter du contenu enrichi : en combinant du texte stylisé et une image intégrée dans un document. Cet exemple démontre le modèle d'encapsulation Run pour le texte stylisé.
-
Installez IronWord avec le Gestionnaire de Packages NuGet
PM > Install-Package IronWord -
Copiez et exécutez cet extrait de code.
using IronWord; using IronWord.Models; // Create document WordDocument doc = new WordDocument(); // Create styled Run Run textRun = new Run(new TextContent("Hello IronWord!")); textRun.Style = new TextStyle() { IsBold = true, Color = Color.Blue }; // Create paragraph and add Run Paragraph paragraph = new Paragraph(); paragraph.AddChild(textRun); paragraph.AddImage(new ImageContent("pic.png")); // Add to document and save doc.AddParagraph(paragraph); doc.SaveAs("output.docx"); -
Déployez pour tester sur votre environnement de production.
Commencez à utiliser IronWord dans votre projet dès aujourd'hui avec un essai gratuit
Table des matières
- Ajouter du texte
- Contenu textuel (Ajouter, ajouter et diviser)
- Définir le style (police et taille, couleur, gras et italique, barré, souligné, exposant et indice)
- Intégrer des images
- Ajouter des images
- Charger une image (Fichier et FileStream)
- Activer le retour à la ligne automatique
- Définir les dimensions (Largeur & Hauteur)
- Définir le décalage de position
- Définir la distance par rapport aux coins
Concepts Clés
Hiérarchie des documents
IronWord suit une hiérarchie de documents structurée : Document → Paragraphe → Run → TextContent . Comprendre cette hiérarchie est essentiel pour travailler avec du texte stylisé :
WordDocument: Le conteneur de niveau supérieur représentant l'ensemble du documentParagraph: Un bloc de contenu à l'intérieur du documentRun: Un objet d'encapsulation qui contientTextContentet auquel un style peut être appliquéTextContent: La chaîne de texte réelle
Ajouter du contenu aux paragraphes
IronWord propose deux méthodes pour ajouter du contenu aux paragraphes :
AddText(TextContent): Utilisez pour le texte brut non stylisé. Ajoute directementTextContentau paragraphe.AddChild(Run): Utilisez pour le texte stylisé. Ajoute un objetRun(qui encapsuleTextContentet contient le style) au paragraphe.
Lorsque vous devez appliquer un style comme la taille de la police, la couleur ou le formatage en gras, créez un objet Run, assignez un TextStyle au Run, et utilisez AddChild pour l'ajouter au paragraphe.
Ajouter des TextRuns
Contenu textuel
La méthode Split est utilisée pour diviser l'exécution de texte en une liste de plus petites exécutions de texte, basée sur un délimiteur spécifié. Cela permet d'organiser et de manipuler les informations textuelles au sein du document.
:path=/static-assets/word/content-code-examples/tutorials/add-textrun-text-content.cs
using IronWord;
using IronWord.Models;
WordDocument doc = new WordDocument();
// Add text
TextContent addText = new TextContent("Add text using IronWord");
doc.AddParagraph(new Paragraph(addText));
// Append text
TextContent appendText = new TextContent("The first text.");
appendText.Append(new TextContent("The second text."));
doc.AddParagraph(new Paragraph(appendText));
// Split text
TextContent splitText = new TextContent("Use split to split the sentence.");
splitText.Split(" ");
doc.AddParagraph(new Paragraph(splitText));
// Export docx
doc.SaveAs("textrun.docx");
Imports IronWord
Imports IronWord.Models
Private doc As New WordDocument()
' Add text
Private addText As New TextContent("Add text using IronWord")
doc.AddParagraph(New Paragraph(addText))
' Append text
Dim appendText As New TextContent("The first text.")
appendText.Append(New TextContent("The second text."))
doc.AddParagraph(New Paragraph(appendText))
' Split text
Dim splitText As New TextContent("Use split to split the sentence.")
splitText.Split(" ")
doc.AddParagraph(New Paragraph(splitText))
' Export docx
doc.SaveAs("textrun.docx")
Définir le style
Définir le style pour le texte nécessite l'utilisation du modèle d'encapsulation Run. Créez un objet Run contenant TextContent, puis assignez un TextStyle au Run (pas au TextContent). Le TextStyle vous permet de définir des attributs visuels tels que FontSize, couleur, gras, italique, barré, souligné, exposant et indice.
Notez que FontSize est configuré au niveau TextStyle, tandis que FontFamily est défini à l'intérieur de la propriété TextFont. Une fois stylisé, utilisez AddChild pour ajouter Run à un paragraphe. Cela suit la hiérarchie du document : Document → Paragraphe → Run → TextContent.
:path=/static-assets/word/content-code-examples/tutorials/add-textrun-set-styling.cs
using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;
// Load docx
WordDocument doc = new WordDocument("document.docx");
// Configure text
Run textRun = new Run(new TextContent("Add text using IronWord"));
textRun.Style = new TextStyle()
{
FontSize = 72,
TextFont = new Font()
{
FontFamily = "Caveat"
},
Color = Color.Red,
IsBold = true,
IsItalic = true,
Underline = new Underline(),
Strike = StrikeValue.Strike,
};
Paragraph paragraph = new Paragraph();
// Add text
paragraph.AddChild(textRun);
// Add paragraph
doc.AddParagraph(paragraph);
// Export docx
doc.SaveAs("save_document.docx");
Imports IronWord
Imports IronWord.Models
Imports IronWord.Models.Enums
' Load docx
Dim doc As New WordDocument("document.docx")
' Configure text
Dim textRun As New Run(New TextContent("Add text using IronWord"))
textRun.Style = New TextStyle() With {
.FontSize = 72,
.TextFont = New Font() With {
.FontFamily = "Caveat"
},
.Color = Color.Red,
.IsBold = True,
.IsItalic = True,
.Underline = New Underline(),
.Strike = StrikeValue.Strike
}
Dim paragraph As New Paragraph()
' Add text
paragraph.AddChild(textRun)
' Add paragraph
doc.AddParagraph(paragraph)
' Export docx
doc.SaveAs("save_document.docx")
Obtenir la couleur de remplissage du texte
Outre la possibilité de définir le style, IronWord vous offre un moyen d'obtenir la valeur de couleur RGBA à partir de documents existants afin de garantir la cohérence du style.
:path=/static-assets/word/content-code-examples/tutorials/rgba-color-value.cs
using IronWord;
using IronWord.Models;
using System;
// Open existing Word
WordDocument doc = new WordDocument("Accent1TextThemcolor.docx");
TextContent content = doc.Paragraphs[0].Texts[0];
// This will show the R G B A of the themecolor
var filledColor = content.Color;
// Print the filled color variable to the console
Console.WriteLine(filledColor);
Imports IronWord
Imports IronWord.Models
Imports System
' Open existing Word
Dim doc As New WordDocument("Accent1TextThemcolor.docx")
Dim content As TextContent = doc.Paragraphs(0).Texts(0)
' This will show the R G B A of the themecolor
Dim filledColor = content.Color
' Print the filled color variable to the console
Console.WriteLine(filledColor)
Pour récupérer les valeurs de couleur, chargez le document en utilisant WordDocument, puis accédez à la collection Paragraphs et au tableau Texts pour obtenir l'objet TextContent. La propriété Color de TextContent renvoie la valeur RGBA de la couleur existante du texte, vous permettant de maintenir un style cohérent dans l'ensemble de votre document.
Intégrer des images
Cette fonctionnalité vous permet d'intégrer facilement des images au sein du contenu, améliorant ainsi l'attrait visuel global et la force de communication du document.
:path=/static-assets/word/content-code-examples/tutorials/add-textrun-embed-images.cs
using IronWord;
using IronWord.Models;
// Load docx
WordDocument doc = new WordDocument();
// Configure image
ImageContent image = new ImageContent("image.jpg");
image.Width = 200; // In unit pixel
image.Height = 200; // In unit pixel
TextContent textRun = new TextContent();
// Add image
Paragraph para = new Paragraph(textRun);
para.AddImage(image);
// Add paragraph
doc.AddParagraph(new Paragraph(textRun));
// Export docx
doc.SaveAs("save_document.docx");
Imports IronWord
Imports IronWord.Models
' Load docx
Private doc As New WordDocument()
' Configure image
Private image As New ImageContent("image.jpg")
image.Width = 200 ' In unit pixel
image.Height = 200 ' In unit pixel
Dim textRun As New TextContent()
' Add image
Dim para As New Paragraph(textRun)
para.AddImage(image)
' Add paragraph
doc.AddParagraph(New Paragraph(textRun))
' Export docx
doc.SaveAs("save_document.docx")
Ajouter des images
Charger l'image
Le chargement des images est un processus crucial. Cela implique d'intégrer des fichiers image externes au document. La possibilité de charger des images facilite l'inclusion d'éléments visuels pertinents, contribuant ainsi à un document plus attrayant et informatif.
:path=/static-assets/word/content-code-examples/tutorials/add-image-load-image.cs
using IronWord;
using IronWord.Models;
// Load docx
WordDocument doc = new WordDocument();
Paragraph paragraph = new Paragraph();
// Add image
paragraph.AddImage("image.jpg");
// Add paragraph
doc.AddParagraph(paragraph);
// Export docx
doc.SaveAs("document.docx");
Imports IronWord
Imports IronWord.Models
' Load docx
Private doc As New WordDocument()
Private paragraph As New Paragraph()
' Add image
paragraph.AddImage("image.jpg")
' Add paragraph
doc.AddParagraph(paragraph)
' Export docx
doc.SaveAs("document.docx")
Configurer l'image
Optimisez les images grâce à des paramètres configurables. Cela inclut la configuration de propriétés telles que le retour à la ligne automatique, les dimensions, la position et la distance par rapport aux coins. Une configuration correcte garantit que les images s'affichent de manière visuellement agréable et contextuellement appropriée.
:path=/static-assets/word/content-code-examples/tutorials/add-image-configure-image.cs
using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;
using IronSoftware.Abstractions.Word;
// Load docx
WordDocument doc = new WordDocument();
// Configure image
ImageContent image = new ImageContent("image.jpg");
image.TextWrapBehavior = new TextWrapSquare();
image.Width = 100;
image.Height = 100;
image.DistanceFromTop = 50;
var position = new ElementPosition();
position.X = 50;
position.Y = 50;
image.Position = position;
Paragraph paragraph = new Paragraph();
// Add image
paragraph.AddImage(image);
// Add paragraph
doc.AddParagraph(paragraph);
// Export docx
doc.SaveAs("document.docx");
Imports IronWord
Imports IronWord.Models
Imports IronWord.Models.Enums
Imports IronSoftware.Abstractions.Word
' Load docx
Dim doc As New WordDocument()
' Configure image
Dim image As New ImageContent("image.jpg")
image.TextWrapBehavior = New TextWrapSquare()
image.Width = 100
image.Height = 100
image.DistanceFromTop = 50
Dim position As New ElementPosition()
position.X = 50
position.Y = 50
image.Position = position
Dim paragraph As New Paragraph()
' Add image
paragraph.AddImage(image)
' Add paragraph
doc.AddParagraph(paragraph)
' Export docx
doc.SaveAs("document.docx")
Questions Fréquemment Posées
Comment puis-je ajouter du texte à un document Word en C# ?
Vous pouvez ajouter du texte à un document Word en utilisant IronWord pour créer une instance d'une séquence de texte, qui peut ensuite être ajoutée à un paragraphe dans le document.
Quelle est la méthode pour diviser le texte dans un document Word ?
IronWord fournit la méthode Split, qui vous permet de diviser une séquence de texte en segments plus petits basés sur un délimiteur spécifié, facilitant ainsi la manipulation du texte.
Comment puis-je styliser du texte dans un document Word en utilisant IronWord ?
Vous pouvez styliser le texte en utilisant IronWord en définissant divers attributs tels que la taille de la police, la couleur et les styles comme gras, italique, barré, souligné, exposant et indice.
Comment puis-je intégrer des images dans un document Word avec C# ?
Pour intégrer des images dans un document Word en utilisant IronWord, vous pouvez charger une image à partir d'un fichier et l'ajouter comme image en ligne dans un paragraphe du document.
Quelles sont les étapes pour charger une image dans un document Word ?
Avec IronWord, vous pouvez charger une image soit à partir d'un fichier soit à partir d'un flux de fichiers, ce qui vous permet d'incorporer du contenu visuel dans un document Word.
Comment puis-je configurer les propriétés de l'image dans un document Word ?
En utilisant IronWord, vous pouvez configurer les propriétés de l'image telles que l'habillage du texte, les dimensions, le décalage de position et la distance par rapport aux coins pour assurer un affichage approprié de l'image dans le document.
Puis-je récupérer la valeur de couleur RGBA du texte dans un document Word ?
Oui, IronWord vous permet d'obtenir la valeur de couleur RGBA du texte existant dans un document pour maintenir une cohérence dans le style.
Comment puis-je commencer à utiliser IronWord pour la manipulation de documents Word ?
Pour commencer avec IronWord, vous pouvez l'intégrer dans votre application .NET C# pour créer, lire et modifier des documents Word, en tirant parti de ses fonctionnalités de bibliothèque complètes.

