C# Document Element Tutorial

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 document
• Paragraph: Un bloc de contenu à l'intérieur du document
• Run: Un objet d'encapsulation qui contient TextContent et 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 directement TextContent au paragraphe.
• AddChild(Run): Utilisez pour le texte stylisé. Ajoute un objet Run (qui encapsule TextContent et 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.

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");

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");

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);

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");

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");

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");