Class Paragraph

Represents a paragraph element within the document.

Inheritance
System.Object
ContentElement
ParentElement
Paragraph
Implements
IronSoftware.Abstractions.Word.IParagraph
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<IronSoftware.Abstractions.Word.IWordDocumentObjectCollection, IronSoftware.Abstractions.Word.IWordDocumentObject>
Inherited Members
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Paragraph : ParentElement, ITextContainer, IDrawContainer

A Paragraph is the block of text you hold whenever you write a line, a heading, or a body passage into a Word document. It owns the runs of styled text on that line and the paragraph-level formatting (alignment, spacing, and style) applied to them, making it the everyday building block of document content.

You create one and fill it, then add it to a WordDocument with AddParagraph; the document's Paragraphs property holds the paragraphs already placed, and a table cell or section can hold paragraphs too. A paragraph reads as the unit between line breaks, so a developer building a document from text spends most of their time assembling and styling paragraphs.

Composing content is the first job: AddText appends text (a string or a TextContent), AddRun adds a prepared Run of styled characters, and AddImage and AddShape place a picture or drawing inline. The Runs property exposes the styled spans the paragraph already contains. Editing within a paragraph uses FindText to locate a string, ReplaceText to swap one for another, and ExtractText to read the plain text back. Formatting is applied through Style (a ParagraphStyle) or the shortcut SetStyle, with Alignment and SetAlignment for justification and SpacingBefore, SpacingAfter, and LineSpacing for vertical rhythm; TextStyle sets the default run style for the line, and Index reports the paragraph's position among its siblings. A paragraph with no explicit style inherits the document's current default, so set a style only where a line should differ from the body.

var paragraph = new Paragraph();
paragraph.AddText("Quarterly summary");
paragraph.SetAlignment(TextAlignment.Center);
document.AddParagraph(paragraph);

The add paragraph example builds one from scratch, the add text how-to covers writing content, and the edit text how-to demonstrates find and replace.

Constructors

Paragraph()

Initializes a new instance of the Paragraph class.

Declaration
public Paragraph()

Paragraph(ContentElement[])

Initializes a new instance of the Paragraph class with the specified child elements.

Declaration
public Paragraph(params ContentElement[] children)
Parameters
Type Name Description
ContentElement[] children

The child elements to be added.

Properties

Alignment

Gets or sets the alignment and layout settings for this paragraph.

Declaration
public TextAlignment Alignment { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Word.TextAlignment

DefaultFontIsBold

The default bold setting if child elements do not specify.

Declaration
public bool DefaultFontIsBold { get; }
Property Value
Type Description
System.Boolean

DefaultFontIsItalic

The default italic setting if child elements do not specify.

Declaration
public bool DefaultFontIsItalic { get; }
Property Value
Type Description
System.Boolean

DefaultFontName

The default font name if child elements do not specify.

Declaration
public string DefaultFontName { get; }
Property Value
Type Description
System.String

DefaultFontSize

The default font size if child elements do not specify.

Declaration
public float DefaultFontSize { get; }
Property Value
Type Description
System.Single

FirstLineIndentation

Declaration
public float FirstLineIndentation { get; set; }
Property Value
Type Description
System.Single

HorizontalContentAlignment

Declaration
public HorizontalAlignments HorizontalContentAlignment { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Styling.HorizontalAlignments

Index

Gets the index of this paragraph within the parent's list of children.

Declaration
public int Index { get; set; }
Property Value
Type Description
System.Int32

LineSpacing

Declaration
public LineSpacing LineSpacing { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Word.LineSpacing

Runs

A list of all runs within this paragraph.

Declaration
public List<Run> Runs { get; }
Property Value
Type Description
System.Collections.Generic.List<Run>

SpacingAfter

Declaration
public float SpacingAfter { get; set; }
Property Value
Type Description
System.Single

SpacingBefore

Declaration
public float SpacingBefore { get; set; }
Property Value
Type Description
System.Single

SpacingBetweenLines

Declaration
public int SpacingBetweenLines { get; set; }
Property Value
Type Description
System.Int32

Style

Gets or sets the style of this paragraph. If not specified, it inherits the Document's current/default style.

Declaration
public ParagraphStyle Style { get; set; }
Property Value
Type Description
ParagraphStyle

TextStyle

Gets or sets the default text style of this paragraph.

Declaration
public TextStyle TextStyle { get; set; }
Property Value
Type Description
TextStyle

Methods

AddChild(IWordDocumentObject[])

Adds one or more child content elements to the current content element.

Declaration
public override void AddChild(params IWordDocumentObject[] children)
Parameters
Type Name Description
IronSoftware.Abstractions.Word.IWordDocumentObject[] children

The content elements to be added as children.
Overrides

AddImage(AnyBitmap)

Adds an image to this paragraph.

Declaration
public ImageContent AddImage(AnyBitmap anyBitmap)
Parameters
Type Name Description
IronSoftware.Drawing.AnyBitmap anyBitmap
Returns
Type Description
ImageContent

AddImage(ImageContent)

Adds an image to this paragraph.

Declaration
public ImageContent AddImage(ImageContent imageContent)
Parameters
Type Name Description
ImageContent imageContent
Returns
Type Description
ImageContent

AddImage(Stream)

Adds an image to this paragraph from a stream.

Declaration
public ImageContent AddImage(Stream imageStream)
Parameters
Type Name Description
System.IO.Stream imageStream
Returns
Type Description
ImageContent

AddImage(String)

Adds an image to this paragraph from a file path.

Declaration
public ImageContent AddImage(string imagePath)
Parameters
Type Name Description
System.String imagePath
Returns
Type Description
ImageContent

AddRun(Run)

Adds a new run to this paragraph.

Declaration
public Run AddRun(Run run)
Parameters
Type Name Description
Run run

The run to be added.
Returns
Type Description
Run

AddShape(ShapeContent)

Adds a shape to this paragraph.

Declaration
public ShapeContent AddShape(ShapeContent shapeContent)
Parameters
Type Name Description
ShapeContent shapeContent
Returns
Type Description
ShapeContent

AddText(TextContent)

Adds a new Run to this paragraph.

Declaration
public TextContent AddText(TextContent textContent)
Parameters
Type Name Description
TextContent textContent
Returns
Type Description
TextContent

AddText(String)

Adds a new Text to this paragraph.

Declaration
public TextContent AddText(string text)
Parameters
Type Name Description
System.String text
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

SetAlignment(TextAlignment)

Sets the alignment for this paragraph.

Declaration
public Paragraph SetAlignment(TextAlignment alignment)
Parameters
Type Name Description
IronSoftware.Abstractions.Word.TextAlignment alignment
Returns
Type Description
Paragraph

SetStyle(ParagraphStyle)

Sets the style for this paragraph.

Declaration
public Paragraph SetStyle(ParagraphStyle style)
Parameters
Type Name Description
ParagraphStyle style
Returns
Type Description
Paragraph

Implements

IronSoftware.Abstractions.Word.IParagraph
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<, >

Inherited members

InsertChildToIndex(Int32, IWordDocumentObject[])
Remove()
RemoveChildren(IWordDocumentObject[])
RemoveAllChildren()
ExtractElements<T>()
GetChildByIndex<T>(Int32)
Clone()
CloneObject()
LogObjectTree()
Texts
Tables
Children
Replace(IWordDocumentObject)
GetIndex<T>()
Parent
Status