Class Run
Represents a single run of text within a text content element.
Implements
Inherited Members
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Run : ParentElement, IDrawContainer, ITextContainerInline formatting inside a paragraph, a span of text that all shares one font, color, and weight, lives on Run. It is the unit a developer edits when part of a line should look different from the rest, such as a bold phrase or a colored term within an otherwise plain sentence. A run holds text, images, and shapes that flow inline, so it is the level at which character-level styling and inline content are applied.
A paragraph owns its runs: a Paragraph exposes its Runs as a List<Run> and grows with AddRun, so a developer obtains a run by adding one to a paragraph or by reading the runs already there. This places Run one level below the paragraph in the document model, between the paragraph and the individual TextContent, ImageContent, and ShapeContent items it carries.
Character styling sits on the properties: FontName, FontSize, Color, IsBold, and IsItalic set the look directly, while Font and Style apply a fuller font or named style, and Index reports the run's position. The methods divide into three jobs. For text, AddText appends a string or a TextContent, FindText locates a phrase, ReplaceText swaps one string for another, ExtractText reads the run's text back, and Remove deletes a TextContent. For images, the AddImage overloads accept a file path, a Stream, an AnyBitmap, or an ImageContent, and ExtractImages returns the inline images. For shapes, AddShape inserts a ShapeContent and ExtractShapes reads them back. Set the styling properties before or after adding content; they apply to everything the run carries.
using IronWord.Models;
var run = new Run();
run.IsBold = true;
run.FontSize = 14;
run.AddText("Quarterly Report");The add text how-to covers placing text, the style text how-to walks through formatting it, and the edit text how-to demonstrates finding and replacing.
Constructors
Run()
Initializes a new instance of the Run class.
Declaration
public Run()Run(ImageContent[])
Initializes a new instance of the Run class with the specified child elements.
Declaration
public Run(params ImageContent[] children)Parameters
| Type | Name | Description |
|---|---|---|
| ImageContent[] | children | The child elements to be added. |
Run(ShapeContent[])
Initializes a new instance of the Run class with the specified child elements.
Declaration
public Run(params ShapeContent[] children)Parameters
| Type | Name | Description |
|---|---|---|
| ShapeContent[] | children | The child elements to be added. |
Run(TextContent[])
Initializes a new instance of the Run class with the specified child elements.
Declaration
public Run(params TextContent[] children)Parameters
| Type | Name | Description |
|---|---|---|
| TextContent[] | children | The child elements to be added. |
Run(TextStyle)
Initializes a new instance of the Run class with a text style.
Declaration
public Run(TextStyle style)Parameters
| Type | Name | Description |
|---|---|---|
| TextStyle | style | The style of the text to set for the run. |
Properties
Color
The color of the text contents in the run.
Declaration
public Color Color { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
Font
The font of the text contents in the run.
Declaration
public Font Font { get; set; }Property Value
| Type | Description |
|---|---|
| Font |
FontName
The name of the font of the text contents in the run.
Declaration
public string FontName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
FontSize
The size of the font in points.
Declaration
public float FontSize { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Index
Gets the index of this Run within the parent's list of children.
Declaration
public int Index { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsBold
Whether the text contents in the run are bold or not.
Declaration
public bool IsBold { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsItalic
Whether the text contents in the run are italic or not.
Declaration
public bool IsItalic { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Style
Gets or sets the style of this run.
Declaration
public TextStyle Style { get; set; }Property Value
| Type | Description |
|---|---|
| TextStyle |
Methods
AddImage(AnyBitmap)
Adds an image to this Run.
Declaration
public ImageContent AddImage(AnyBitmap anyBitmap)Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.AnyBitmap | anyBitmap |
Returns
| Type | Description |
|---|---|
| ImageContent |
AddImage(ImageContent)
Adds an Image element to this Run.
Declaration
public ImageContent AddImage(ImageContent imageContent)Parameters
| Type | Name | Description |
|---|---|---|
| ImageContent | imageContent | The Image element to add. |
Returns
| Type | Description |
|---|---|
| ImageContent |
AddImage(Stream)
Adds an Image element to this Run using a stream containing the image data.
Declaration
public ImageContent AddImage(Stream imageStream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | imageStream | The Stream containing the image data. |
Returns
| Type | Description |
|---|---|
| ImageContent |
AddImage(String)
Adds an Image element to this Run using an image path.
Declaration
public ImageContent AddImage(string imagePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | imagePath | The path to the image file. |
Returns
| Type | Description |
|---|---|
| ImageContent |
AddShape(ShapeContent)
Adds an Image element to this Run.
Declaration
public ShapeContent AddShape(ShapeContent shapeContent)Parameters
| Type | Name | Description |
|---|---|---|
| ShapeContent | shapeContent | The Shape element to add. |
Returns
| Type | Description |
|---|---|
| ShapeContent |
AddText(TextContent)
Adds an Text element to this Run.
Declaration
public TextContent AddText(TextContent textContent)Parameters
| Type | Name | Description |
|---|---|---|
| TextContent | textContent | The Text element to add. |
Returns
| Type | Description |
|---|---|
| TextContent |
AddText(String)
Adds an text content to this Run.
Declaration
public TextContent AddText(string text)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | text | The text content to add. |
Returns
| Type | Description |
|---|---|
| TextContent |
ExtractImages()
Extract all images from this container
Declaration
public List<ImageContent> ExtractImages()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ImageContent> | List of images |
ExtractShapes()
Extract all shapes from this container
Declaration
public List<ShapeContent> ExtractShapes()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ShapeContent> | List of path segment collections |
ExtractText()
Extract all text from the container
Declaration
public string ExtractText()Returns
| Type | Description |
|---|---|
| System.String | Extracted text |
FindText(String)
Find the first text element which contains the specified text
Declaration
public TextContent FindText(string find)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | find | Text to find |
Returns
| Type | Description |
|---|---|
| TextContent | Text element containing the specified text |
Remove(TextContent)
Remove the specified text element
Declaration
public bool Remove(TextContent element)Parameters
| Type | Name | Description |
|---|---|---|
| TextContent | element | Text element to remove |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the element was found and removed, False otherwise |
ReplaceText(String, String)
Replace all instances of the specified text
Declaration
public void ReplaceText(string find, string replace)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | find | Text to replace |
| System.String | replace | Replacement text |