Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

WordParagraph

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source revision 4b341e8b9bfb with working tree changes
Source WordParagraph.cs:290
Base WordElement
Implements
IEquatable<WordParagraph>

Represents a paragraph within a Word document.

Inheritance

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Paragraphs and formatting Guide
  • Word Documents Guide

    Overview of the OfficeIMO.Word package for creating and manipulating Microsoft Word documents. Includes examples and API links.

  • Meeting minutes and actions Sample

    Generate Word meeting minutes in C# with a running header, decisions, action owners, and due dates. Download the editable record and PDF preview.

  • An editable decision record Sample

    Create a Word decision record in C# with context, alternatives, trade-offs, and a revisit condition. Compare the editable DOCX with its PDF preview.

  • A concise policy brief Sample

    Create a Word policy brief in C# with styled headings, a rules table, a shaded reminder, and bullet lists. Download the source, DOCX, and PDF.

  • Employee onboarding checklist Sample

    Build a Word onboarding checklist in C# with tasks grouped by stage, named owners, and completion status. Inspect the PDF and download the DOCX.

Usage

Explore 252 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 209

Accepted by parameters 43

Constructors

public WordParagraph(WordDocument? document = null, Boolean newParagraph = true, Boolean newRun = true) #
WordParagraph.cs:290

Initializes a new paragraph.

Parameters

document OfficeIMO.Word.WordDocument? = null optionalposition: 0
Parent document.
newParagraph System.Boolean = true optionalposition: 1
Create a new paragraph element.
newRun System.Boolean = true optionalposition: 2
Create a new run inside the paragraph.

Methods

public WordParagraph AddBookmark(String bookmarkName) #
WordParagraph.PublicMethods.References.cs:66
Returns: WordParagraph

Add bookmark to a word document proceeding from the paragraph this was called on.

Parameters

bookmarkName System.String requiredposition: 0
The name of the bookmark.

Returns

The paragraph that this was called on.

public WordParagraph AddBreak(WordBreakType? breakType = null) #
WordParagraph.PublicMethods.Structure.cs:23
Returns: WordParagraph

Add Break to the paragraph. By default it adds soft break (SHIFT+ENTER)

Parameters

breakType OfficeIMO.Word.WordBreakType? = null optionalposition: 0
Optional argument to add a specific type of break.

Returns

The new WordParagraph that this method creates.

AddChart 2 overloads
public WordChart AddChart(String title = "", Boolean roundedCorners = false, Int32 width = 600, Int32 height = 600) #
WordParagraph.PublicMethods.Objects.cs:119
Returns: WordChart

Adds the chart to the document. The type of chart is determined by the type of data passed in. You can use multiple: .AddBar() to add a bar chart .AddLine() to add a line chart .AddPie() to add a pie chart .AddArea() to add an area chart .AddScatter() to add a scatter chart .AddRadar() to add a radar chart .AddBar3D() to add a 3-D bar chart. .AddPie3D() to add a 3-D pie chart. .AddLine3D() to add a 3-D line chart. You can't mix and match the types of charts, except bar and line which can coexist in a combo chart.

Parameters

title System.String = "" optionalposition: 0
The title.
roundedCorners System.Boolean = false optionalposition: 1
if set to true [rounded corners].
width System.Int32 = 600 optionalposition: 2
The width.
height System.Int32 = 600 optionalposition: 3
The height.

Returns

WordChart

public WordChart AddChart(OfficeChartKind chartKind, OfficeChartData data, String title = "", Boolean roundedCorners = false, Int32 width = 600, Int32 height = 600) #
WordParagraph.SharedCharts.cs:17
Returns: WordChart

Inserts an editable chart with an embedded worksheet after this paragraph.

Parameters

chartKind OfficeIMO.Drawing.OfficeChartKind requiredposition: 0
Default chart family for series without their own render kind.
data OfficeIMO.Drawing.OfficeChartData requiredposition: 1
Shared chart categories, series, and appearance.
title System.String = "" optionalposition: 2
Optional chart title.
roundedCorners System.Boolean = false optionalposition: 3
Whether the chart frame has rounded corners.
width System.Int32 = 600 optionalposition: 4
Drawing width in pixels.
height System.Int32 = 600 optionalposition: 5
Drawing height in pixels.

Returns

The created chart.

public WordCheckBox AddCheckBox(Boolean isChecked = false, String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:57
Returns: WordCheckBox

Adds a checkbox content control to the paragraph.

Parameters

isChecked System.Boolean = false optionalposition: 0
Initial checked state.
alias System.String? = null optionalposition: 1
Optional alias for the control.
tag System.String? = null optionalposition: 2
Optional tag for the control.

Returns

The created WordCheckBox instance.

public WordParagraph AddCitation(String sourceTag) #
WordParagraph.PublicMethods.References.cs:87
Returns: WordParagraph

Adds a citation field referencing the specified source tag.

Parameters

sourceTag System.String requiredposition: 0
Tag of the bibliographic source.

Returns

The paragraph that this was called on.

public WordComboBox AddComboBox(IEnumerable<String> items, String? alias = null, String? tag = null, String? defaultValue = null) #
WordParagraph.PublicMethods.ContentControls.cs:204
Returns: WordComboBox

Adds a combo box content control to the paragraph.

Parameters

items System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
Items to include in the combo box.
alias System.String? = null optionalposition: 1
Optional alias for the control.
tag System.String? = null optionalposition: 2
Optional tag for the control.
defaultValue System.String? = null optionalposition: 3
Optional default value to display; must match one of the provided items.

Returns

The created WordComboBox instance.

public WordChart AddComboChart(String title = "", Boolean roundedCorners = false, Int32 width = 600, Int32 height = 600) #
WordParagraph.PublicMethods.Objects.cs:132
Returns: WordChart

Creates a chart ready for combining bar and line series. Use WordChart.AddChartAxisX to supply category labels and then call WordChart.AddBar or WordChart.AddLine to add data. AddChartAxisX must be called before adding any series so that both chart types share the same axes.

Parameters

title System.String = "" optionalposition: 0
roundedCorners System.Boolean = false optionalposition: 1
width System.Int32 = 600 optionalposition: 2
height System.Int32 = 600 optionalposition: 3
public Void AddComment(String author, String initials, String comment) #
WordParagraph.PublicMethods.References.cs:24
Returns: Void

Add a comment to paragraph

Parameters

author System.String requiredposition: 0
The name of the commenting author
initials System.String requiredposition: 1
The initials of the commenting author
comment System.String requiredposition: 2
The comment text
public WordParagraph AddCrossReference(String referenceId, WordCrossReferenceType type) #
WordParagraph.PublicMethods.References.cs:77
Returns: WordParagraph

Adds a cross reference field to the paragraph.

Parameters

referenceId System.String requiredposition: 0
Bookmark or heading identifier.
type OfficeIMO.Word.WordCrossReferenceType requiredposition: 1
Type of reference.

Returns

The paragraph that this was called on.

public WordDatePicker AddDatePicker(DateTime? date = null, String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:129
Returns: WordDatePicker

Adds a date picker content control to the paragraph.

Parameters

date System.DateTime? = null optionalposition: 0
Initial date value.
alias System.String? = null optionalposition: 1
Optional alias for the control.
tag System.String? = null optionalposition: 2
Optional tag for the control.

Returns

The created WordDatePicker instance.

public WordParagraph AddDeletedText(String text, String author, DateTime? date = null) #
WordParagraph.Revisions.cs:33
Returns: WordParagraph

Inserts revision text marked as deleted.

Parameters

text System.String requiredposition: 0
Text to delete.
author System.String requiredposition: 1
Revision author.
date System.DateTime? = null optionalposition: 2
Revision date. Uses current date when null.

Returns

The current WordParagraph instance.

public WordDropDownList AddDropDownList(IEnumerable<String> items, String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:165
Returns: WordDropDownList

Adds a dropdown list content control to the paragraph.

Parameters

items System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
Items to include in the list.
alias System.String? = null optionalposition: 1
Optional alias for the control.
tag System.String? = null optionalposition: 2
Optional tag for the control.

Returns

The created WordDropDownList instance.

AddEmbeddedObject 2 overloads
public WordParagraph AddEmbeddedObject(String filePath, String imageFilePath, Double? width = null, Double? height = null) #
WordParagraph.PublicMethods.Objects.cs:48
Returns: WordParagraph

Embeds an object with a preview image.

Parameters

filePath System.String requiredposition: 0
Path to the object file.
imageFilePath System.String requiredposition: 1
Preview image path.
width System.Double? = null optionalposition: 2
Optional width in points.
height System.Double? = null optionalposition: 3
Optional height in points.

Returns

The paragraph containing the embedded object.

public WordParagraph AddEmbeddedObject(String filePath, WordEmbeddedObjectOptions options) #
WordParagraph.PublicMethods.Objects.cs:59
Returns: WordParagraph

Embeds an object with custom options.

Parameters

filePath System.String requiredposition: 0
Path to the object file.
options OfficeIMO.Word.WordEmbeddedObjectOptions requiredposition: 1
Embedding options.

Returns

The paragraph containing the embedded object.

public WordParagraph AddEndNote(String text) #
WordParagraph.PublicMethods.Objects.cs:165
Returns: WordParagraph

Add an end note to the document for this paragraph.

Parameters

text System.String requiredposition: 0
The text of the end note.

Returns

The end note.

AddEquation 2 overloads
public WordParagraph AddEquation(OfficeMathExpression expression) #
WordParagraph.Math.cs:7
Returns: WordParagraph

Adds an inline editable Word equation authored with the reusable OfficeIMO math model.

Parameters

expression OfficeIMO.Drawing.OfficeMathExpression requiredposition: 0
public WordParagraph AddEquation(String omml) #
WordParagraph.PublicMethods.References.cs:154
Returns: WordParagraph

Adds a mathematical equation represented as OMML XML.

Parameters

omml System.String requiredposition: 0
Office Math Markup Language (OMML) fragment.

Returns

The paragraph that this was called on.

AddField 3 overloads
public WordParagraph AddField(WordFieldType wordFieldType, WordFieldFormat? wordFieldFormat = null, String? customFormat = null, Boolean advanced = false, List<String>? parameters = null) #
WordParagraph.PublicMethods.References.cs:104
Returns: WordParagraph

Add fields to a word document proceeding from the paragraph this is called on.

Parameters

wordFieldType OfficeIMO.Word.WordFieldType requiredposition: 0
The type of field to add.
wordFieldFormat OfficeIMO.Word.WordFieldFormat? = null optionalposition: 1
The format of the field to add.
customFormat System.String? = null optionalposition: 2
Custom format string for date or time fields.
advanced System.Boolean = false optionalposition: 3
Use advanced field representation.
parameters System.Collections.Generic.List<System.String>? = null optionalposition: 4
Usages like parameters = new List< String>{ @"\d 'Default'", @"\c" }; Also see available List of switches per field code: https://support.microsoft.com/en-us/office/list-of-field-codes-in-word-1ad6d91a-55a7-4a8d-b535-cf7888659a51

Returns

The paragraph that this was called on.

public WordParagraph AddField(WordFieldCode fieldCode, WordFieldFormat? wordFieldFormat = null, String? customFormat = null, Boolean advanced = false) #
WordParagraph.PublicMethods.References.cs:117
Returns: WordParagraph

Add a field represented by a WordFieldCode.

Parameters

fieldCode OfficeIMO.Word.WordFieldCode requiredposition: 0
Field code instance describing instructions and switches.
wordFieldFormat OfficeIMO.Word.WordFieldFormat? = null optionalposition: 1
Optional field format.
customFormat System.String? = null optionalposition: 2
Custom format string for date or time fields.
advanced System.Boolean = false optionalposition: 3
Use advanced field representation.

Returns

The paragraph that this was called on.

public WordParagraph AddField(WordFieldBuilder builder, Boolean advanced = false) #
WordParagraph.PublicMethods.References.cs:128
Returns: WordParagraph

Adds a field constructed using WordFieldBuilder.

Parameters

builder OfficeIMO.Word.WordFieldBuilder requiredposition: 0
Field builder instance.
advanced System.Boolean = false optionalposition: 1
Use advanced field representation.

Returns

The paragraph that this was called on.

public WordParagraph AddFootNote(String text) #
WordParagraph.PublicMethods.Objects.cs:151
Returns: WordParagraph

Add a foot note for the current paragraph.

Parameters

text System.String requiredposition: 0
The text of the note.

Returns

The footnote.

public WordParagraph AddFormattedText(String text, Boolean bold = false, Boolean italic = false, WordUnderlineStyle? underline = null) #
WordParagraph.PublicMethods.cs:39
Returns: WordParagraph

Adds formatted text to the paragraph and applies basic run properties.

Parameters

text System.String requiredposition: 0
Text to insert.
bold System.Boolean = false optionalposition: 1
Whether the text should be bold.
italic System.Boolean = false optionalposition: 2
Whether the text should be italic.
underline OfficeIMO.Word.WordUnderlineStyle? = null optionalposition: 3
Optional underline style.

Returns

The run containing the formatted text.

public WordParagraph AddHorizontalLine(WordBorderStyle? lineType = null, OfficeColor? color = null, UInt32 size = 12, UInt32 space = 1) #
WordParagraph.PublicMethods.References.cs:47
Returns: WordParagraph

Add horizontal line (sometimes known as horizontal rule) to document proceeding from the paragraph that this is called on.

Parameters

lineType OfficeIMO.Word.WordBorderStyle? = null optionalposition: 0
The type of the line.
color OfficeIMO.Drawing.OfficeColor? = null optionalposition: 1
The color of the line
size System.UInt32 = 12 optionalposition: 2
The size of the line.
space System.UInt32 = 1 optionalposition: 3
The space the line takes up.

Returns

The new Paragraph after the line.

AddHyperLink 2 overloads
AddImage 3 overloads
public WordParagraph AddImage(String filePathImage, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:27
Returns: WordParagraph

Add image from file with ability to provide width and height of the image The image will be resized given new dimensions

Parameters

filePathImage System.String requiredposition: 0
Path to file to import to Word Document
width System.Double? = null optionalposition: 1
Optional width of the image. If not given the actual image width will be used.
height System.Double? = null optionalposition: 2
Optional height of the image. If not given the actual image height will be used.
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 3
Optional text wrapping rule. If not given the image will be inserted inline to the text.
description System.String = "" optionalposition: 4
The description for this image.

Returns

The WordParagraph that AddImage was called on.

public WordParagraph AddImage(Stream imageStream, String fileName, Double? width, Double? height, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:57
Returns: WordParagraph

Add image from Stream with ability to provide width and height of the image The image will be resized given new dimensions

Parameters

imageStream System.IO.Stream requiredposition: 0
The stream to load the image from.
fileName System.String requiredposition: 1
The name of the file.
width System.Double? requiredposition: 2
Optional width of the image. If not given the actual image width will be used.
height System.Double? requiredposition: 3
Optional height of the image. If not give the actual image height will be used.
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
Optional text wrapping rule. If not given the image will be inserted inline to the text.
description System.String = "" optionalposition: 5
The description for this image.

Returns

The WordParagraph that AddImage was called on.

public WordParagraph AddImage(Uri imageUri, Double width, Double height, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:78
Returns: WordParagraph

Add an image that is stored outside the package.

Parameters

imageUri System.Uri requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 3
description System.String = "" optionalposition: 4
public WordParagraph AddImageFromBase64(String base64String, String fileName, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:108
Returns: WordParagraph

Add image from a Base64 encoded string.

Parameters

base64String System.String requiredposition: 0
fileName System.String requiredposition: 1
width System.Double? = null optionalposition: 2
height System.Double? = null optionalposition: 3
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
description System.String = "" optionalposition: 5
public WordParagraph AddImageFromResource(Assembly assembly, String resourceName, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:136
Returns: WordParagraph

Add image from an embedded resource.

Parameters

assembly System.Reflection.Assembly requiredposition: 0
Assembly that contains the resource.
resourceName System.String requiredposition: 1
Full name of the embedded resource.
width System.Double? = null optionalposition: 2
Optional width of the image.
height System.Double? = null optionalposition: 3
Optional height of the image.
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
Optional text wrapping rule.
description System.String = "" optionalposition: 5
The description for this image.

Returns

The WordParagraph that AddImage was called on.

public WordParagraph AddImageVml(String filePathImage, Double? width = null, Double? height = null) #
WordParagraph.PublicMethods.Shapes.cs:20
Returns: WordParagraph

Adds a legacy VML image to the paragraph.

Parameters

filePathImage System.String requiredposition: 0
width System.Double? = null optionalposition: 1
height System.Double? = null optionalposition: 2
public WordParagraph AddInsertedText(String text, String author, DateTime? date = null) #
WordParagraph.Revisions.cs:14
Returns: WordParagraph

Inserts revision text marked as added.

Parameters

text System.String requiredposition: 0
Text to insert.
author System.String requiredposition: 1
Revision author.
date System.DateTime? = null optionalposition: 2
Revision date. Uses current date when null.

Returns

The current WordParagraph instance.

AddLine 2 overloads
public WordLine AddLine(Double startXPt, Double startYPt, Double endXPt, Double endYPt, String color = "#000000", Double strokeWeightPt = 1) #
WordParagraph.PublicMethods.Shapes.cs:145
Returns: WordLine

Add a line shape to the paragraph.

Parameters

startXPt System.Double requiredposition: 0
Start X position in points.
startYPt System.Double requiredposition: 1
Start Y position in points.
endXPt System.Double requiredposition: 2
End X position in points.
endYPt System.Double requiredposition: 3
End Y position in points.
color System.String = "#000000" optionalposition: 4
Stroke color in hex format.
strokeWeightPt System.Double = 1 optionalposition: 5
Stroke weight in points.
public WordLine AddLine(Double startXPt, Double startYPt, Double endXPt, Double endYPt, OfficeColor color, Double strokeWeightPt = 1) #
WordParagraph.PublicMethods.Shapes.cs:155
Returns: WordLine

Add a line shape to the paragraph using OfficeColor.

Parameters

startXPt System.Double requiredposition: 0
startYPt System.Double requiredposition: 1
endXPt System.Double requiredposition: 2
endYPt System.Double requiredposition: 3
color OfficeIMO.Drawing.OfficeColor requiredposition: 4
strokeWeightPt System.Double = 1 optionalposition: 5
public WordList AddList(WordListStyle style) #
WordParagraph.PublicMethods.Objects.cs:94
Returns: WordList

Add a list after this paragraph.

Parameters

style OfficeIMO.Word.WordListStyle requiredposition: 0
The style of this list.

Returns

The new list.

public WordParagraph AddPageNumber(Boolean includeTotalPages = false, WordFieldFormat? format = null, String separator = " of ") #
WordParagraph.PublicMethods.References.cs:140
Returns: WordParagraph

Adds a page number field to the paragraph.

Parameters

includeTotalPages System.Boolean = false optionalposition: 0
If true adds a NUMPAGES field preceded by text " of ".
format OfficeIMO.Word.WordFieldFormat? = null optionalposition: 1
Optional field format to apply.
separator System.String = " of " optionalposition: 2
Text inserted between the current page and total pages fields.

Returns

The paragraph that this was called on.

AddParagraph 2 overloads
public WordParagraph AddParagraph(WordParagraph? wordParagraph = null) #
WordParagraph.PublicMethods.Structure.cs:111
Returns: WordParagraph

Add paragraph right after existing paragraph. This can be useful to add empty lines, or moving cursor to next line

Parameters

wordParagraph OfficeIMO.Word.WordParagraph? = null optionalposition: 0
Optional WordParagraph to insert after the given WordParagraph instead of at the end of the document.

Returns

The inserted WordParagraph.

public WordParagraph AddParagraph(String text) #
WordParagraph.PublicMethods.Structure.cs:131
Returns: WordParagraph

Add a paragraph with the given text to the end of the document.

Parameters

text System.String requiredposition: 0
The text to fill the paragraph with.

Returns

The appended WordParagraph.

AddParagraphAfterSelf 2 overloads
public WordParagraph AddParagraphAfterSelf() #
WordParagraph.PublicMethods.Structure.cs:144
Returns: WordParagraph

Insert a new paragraph after the WordParagraph AddParagraphAfterSelf is called on in the document.

Returns

The inserted WordParagraph

public WordParagraph AddParagraphAfterSelf(WordSection section, WordParagraph? paragraph = null) #
WordParagraph.PublicMethods.Structure.cs:157
Returns: WordParagraph

Add paragraph after self but by allowing to specify section

Parameters

section OfficeIMO.Word.WordSection requiredposition: 0
The section to add the paragraph to. When paragraph is given this has no effect.
paragraph OfficeIMO.Word.WordParagraph? = null optionalposition: 1
The optional paragraph to add the paragraph to.

Returns

The new WordParagraph

public WordParagraph AddParagraphBeforeSelf() #
WordParagraph.PublicMethods.Structure.cs:354
Returns: WordParagraph

Add a paragraph before the paragraph that AddParagraphBeforeSelf was called on.

Returns

The inserted paragraph

public WordPictureControl AddPictureControl(String filePath, Double? width = null, Double? height = null, String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:261
Returns: WordPictureControl

Adds a picture content control containing an image to the paragraph.

Parameters

filePath System.String requiredposition: 0
Image file path.
width System.Double? = null optionalposition: 1
Optional width of the image.
height System.Double? = null optionalposition: 2
Optional height of the image.
alias System.String? = null optionalposition: 3
Optional alias for the control.
tag System.String? = null optionalposition: 4
Optional tag for the control.

Returns

The created WordPictureControl instance.

public WordRepeatingSection AddRepeatingSection(String? sectionTitle = null, String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:296
Returns: WordRepeatingSection

Adds a repeating section content control to the paragraph.

Parameters

sectionTitle System.String? = null optionalposition: 0
Optional title of the repeating section.
alias System.String? = null optionalposition: 1
Optional alias for the control.
tag System.String? = null optionalposition: 2
Optional tag for the control.

Returns

The created WordRepeatingSection instance.

AddShape 4 overloads
public WordShape AddShape(Double widthPt, Double heightPt, String fillColor = "#FFFFFF") #
WordParagraph.PublicMethods.Shapes.cs:58
Returns: WordShape

Add a rectangle shape to the paragraph.

Parameters

widthPt System.Double requiredposition: 0
Width in points.
heightPt System.Double requiredposition: 1
Height in points.
fillColor System.String = "#FFFFFF" optionalposition: 2
Fill color in hex format.
public WordShape AddShape(Double widthPt, Double heightPt, OfficeColor fillColor) #
WordParagraph.PublicMethods.Shapes.cs:66
Returns: WordShape

Add a rectangle shape to the paragraph using OfficeColor.

Parameters

widthPt System.Double requiredposition: 0
heightPt System.Double requiredposition: 1
fillColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
public WordShape AddShape(WordShapeType shapeType, Double widthPt, Double heightPt, String fillColor = "#FFFFFF", String strokeColor = "#000000", Double strokeWeightPt = 1, Double arcSize = 0.25) #
WordParagraph.PublicMethods.Shapes.cs:84
Returns: WordShape

Adds a basic shape to the paragraph.

Parameters

shapeType OfficeIMO.Word.WordShapeType requiredposition: 0
Type of shape to create.
widthPt System.Double requiredposition: 1
Width in points or line end X.
heightPt System.Double requiredposition: 2
Height in points or line end Y.
fillColor System.String = "#FFFFFF" optionalposition: 3
Fill color in hex format.
strokeColor System.String = "#000000" optionalposition: 4
Stroke color in hex format.
strokeWeightPt System.Double = 1 optionalposition: 5
Stroke weight in points.
arcSize System.Double = 0.25 optionalposition: 6
Corner roundness fraction for rounded rectangles.
public WordShape AddShape(WordShapeType shapeType, Double widthPt, Double heightPt, OfficeColor fillColor, OfficeColor strokeColor, Double strokeWeightPt = 1, Double arcSize = 0.25) #
WordParagraph.PublicMethods.Shapes.cs:110
Returns: WordShape

Adds a basic shape to the paragraph using OfficeColor values.

Parameters

shapeType OfficeIMO.Word.WordShapeType requiredposition: 0
widthPt System.Double requiredposition: 1
heightPt System.Double requiredposition: 2
fillColor OfficeIMO.Drawing.OfficeColor requiredposition: 3
strokeColor OfficeIMO.Drawing.OfficeColor requiredposition: 4
strokeWeightPt System.Double = 1 optionalposition: 5
arcSize System.Double = 0.25 optionalposition: 6
AddShapeDrawing 2 overloads
public WordShape AddShapeDrawing(WordShapeType shapeType, Double widthPt, Double heightPt) #
WordParagraph.PublicMethods.Shapes.cs:120
Returns: WordShape

Adds a DrawingML shape to the paragraph.

Parameters

shapeType OfficeIMO.Word.WordShapeType requiredposition: 0
Type of shape to create.
widthPt System.Double requiredposition: 1
Width in points.
heightPt System.Double requiredposition: 2
Height in points.
public WordShape AddShapeDrawing(WordShapeType shapeType, Double widthPt, Double heightPt, Double leftPt, Double topPt) #
WordParagraph.PublicMethods.Shapes.cs:132
Returns: WordShape

Adds a DrawingML shape anchored at an absolute position on the page.

Parameters

shapeType OfficeIMO.Word.WordShapeType requiredposition: 0
Type of shape to create.
widthPt System.Double requiredposition: 1
Width in points.
heightPt System.Double requiredposition: 2
Height in points.
leftPt System.Double requiredposition: 3
Left offset from page in points.
topPt System.Double requiredposition: 4
Top offset from page in points.
AddShapeGroup 2 overloads
public WordShapeGroup AddShapeGroup(IEnumerable<WordShapeGroupItem> items) #
WordParagraph.ShapeGroups.cs:26
Returns: WordShapeGroup

Adds an inline native DrawingML group of bounded preset shapes.

Parameters

items System.Collections.Generic.IEnumerable<OfficeIMO.Word.WordShapeGroupItem> requiredposition: 0
public WordShapeGroup AddShapeGroup(IEnumerable<WordShapeGroupItem> items, Double leftPt, Double topPt) #
WordParagraph.ShapeGroups.cs:30
Returns: WordShapeGroup

Adds a native DrawingML shape group anchored at page-relative point offsets.

Parameters

items System.Collections.Generic.IEnumerable<OfficeIMO.Word.WordShapeGroupItem> requiredposition: 0
leftPt System.Double requiredposition: 1
topPt System.Double requiredposition: 2
public WordSmartArt AddSmartArt(WordSmartArtType type) #
WordParagraph.PublicMethods.Objects.cs:141
Returns: WordSmartArt

Inserts a SmartArt diagram at the current position.

Parameters

type OfficeIMO.Word.WordSmartArtType requiredposition: 0
Layout of SmartArt to create.

Returns

The created WordSmartArt.

public WordStructuredDocumentTag AddStructuredDocumentTag(String text = "", String? alias = null, String? tag = null) #
WordParagraph.PublicMethods.ContentControls.cs:24
Returns: WordStructuredDocumentTag

Adds a simple content control (structured document tag) to the paragraph.

Parameters

text System.String = "" optionalposition: 0
Initial text of the control.
alias System.String? = null optionalposition: 1
Optional alias for the content control.
tag System.String? = null optionalposition: 2
Optional tag for the content control.

Returns

The created WordStructuredDocumentTag instance.

public WordParagraph AddTab() #
WordParagraph.PublicMethods.Objects.cs:84
Returns: WordParagraph

Adds a Tab to a paragraph

Returns

The paragraph this is called on.

public WordTable AddTableAfter(Int32 rows, Int32 columns, WordTableStyle tableStyle = TableGrid) #
WordParagraph.PublicMethods.Objects.cs:24
Returns: WordTable

Add a table after this paragraph and return the table.

Parameters

rows System.Int32 requiredposition: 0
The number of rows in the table.
columns System.Int32 requiredposition: 1
The number of columns in the table.
tableStyle OfficeIMO.Word.WordTableStyle = TableGrid optionalposition: 2
The optional style to be applied to the new table, defaults to TableGrid.

Returns

The new added table.

public WordTable AddTableBefore(Int32 rows, Int32 columns, WordTableStyle tableStyle = TableGrid) #
WordParagraph.PublicMethods.Objects.cs:36
Returns: WordTable

Add a table before this paragraph and return the table.

Parameters

rows System.Int32 requiredposition: 0
The number of rows in this table
columns System.Int32 requiredposition: 1
The number of columns in this table
tableStyle OfficeIMO.Word.WordTableStyle = TableGrid optionalposition: 2
The style of the table being added.

Returns

The new added table.

public WordTabStop AddTabStop(Int32 position, WordTabAlignment? alignment = null, WordTabLeader? leader = null) #
WordParagraph.PublicMethods.Objects.cs:72
Returns: WordTabStop

Provides ability for configuration of Tabs in a paragraph by adding one or more TabStops

Parameters

position System.Int32 requiredposition: 0
The position of the tabs in the paragraph.
alignment OfficeIMO.Word.WordTabAlignment? = null optionalposition: 1
The optional alignment for the tabs.
leader OfficeIMO.Word.WordTabLeader? = null optionalposition: 2
The optional rune to use before the tabs.

Returns

The added tabs.

public WordParagraph AddText(String? text) #
WordParagraph.PublicMethods.cs:23
Returns: WordParagraph

Add a text to existing paragraph

Parameters

text System.String? requiredposition: 0
The text to be added to the paragraph.

Returns

The paragraph containing the new text.

public WordTextBox AddTextBox(String text, WordImageTextWrapping wrapTextImage) #
WordParagraph.PublicMethods.Objects.cs:179
Returns: WordTextBox

Add a text box to the document.

Parameters

text System.String requiredposition: 0
The text inside the text box.
wrapTextImage OfficeIMO.Word.WordImageTextWrapping requiredposition: 1
The text image wrapping settings.
public WordTextBox AddTextBoxVml(String text) #
WordParagraph.PublicMethods.Objects.cs:187
Returns: WordTextBox

Adds a legacy VML text box to the paragraph.

Parameters

text System.String requiredposition: 0
public WordParagraph ClearTabStops() #
WordParagraph.TabStopOperations.cs:7
Returns: WordParagraph

Removes this paragraph's explicit tab stops, leaving inherited defaults unchanged.

Equals 2 overloads
public Boolean Equals(WordParagraph? other) #
WordParagraph.Equality.cs:10
Returns: Boolean

Determines whether the specified WordParagraph is equal to the current instance.

Parameters

other OfficeIMO.Word.WordParagraph? requiredposition: 0
The paragraph to compare with the current instance.

Returns

true if the paragraphs are equal; otherwise, false.

public override Boolean Equals(Object? obj) #
WordParagraph.Equality.cs:29
Returns: Boolean

Determines whether the specified object is equal to the current instance.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current instance.

Returns

true if the objects are equal; otherwise, false.

public Double GetContentWidthPoints() #
WordParagraph.ContentWidth.cs:22
Returns: Double

Estimates the authored content width available to an inline drawing in this paragraph, in points.

Returns

A positive width after the containing cell or section geometry and direct paragraph indents.

Exceptions

  • InvalidOperationException – The paragraph is detached, belongs to an unsupported text box, has ambiguous story geometry, or its margins and indents leave no positive content width.
public IEnumerable<WordFormattedRun> GetFormattedRuns() #
WordParagraph.PublicMethods.FormattedRuns.cs:9
Returns: IEnumerable<WordFormattedRun>

Enumerates this paragraph's text and image runs with reader-facing formatting metadata.

Returns

Formatted runs in document order.

public override Int32 GetHashCode() #
WordParagraph.Equality.cs:38
Returns: Int32

Serves as the default hash function.

Returns

A hash code for the current object.

public WordListStyle? GetListStyle() #
WordParagraph.cs:223
Returns: WordListStyle?

Gets the list style when this paragraph is part of a list.

public IEnumerable<WordParagraph> GetRuns() #
Returns: IEnumerable<WordParagraph>

Enumerates visible runs in paragraph order, including cached simple-field results and hyperlink runs.

InsertImage 3 overloads
public WordImage InsertImage(String filePathImage, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:40
Returns: WordImage

Inserts an image and returns the created WordImage for immediate configuration. This is a convenience alternative to WordParagraph.AddImage when you want to set properties on the inserted image without accessing WordParagraph.Image.

Parameters

filePathImage System.String requiredposition: 0
width System.Double? = null optionalposition: 1
height System.Double? = null optionalposition: 2
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 3
description System.String = "" optionalposition: 4
public WordImage InsertImage(Stream imageStream, String fileName, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:68
Returns: WordImage

Inserts an image from a stream and returns the created WordImage.

Parameters

imageStream System.IO.Stream requiredposition: 0
fileName System.String requiredposition: 1
width System.Double? = null optionalposition: 2
height System.Double? = null optionalposition: 3
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
description System.String = "" optionalposition: 5
public WordImage InsertImage(Uri imageUri, Double width, Double height, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:98
Returns: WordImage

Inserts an external image (by URI) and returns the created WordImage.

Parameters

imageUri System.Uri requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 3
description System.String = "" optionalposition: 4
public WordImage InsertImageFromBase64(String base64String, String fileName, Double? width = null, Double? height = null, WordImageTextWrapping wrapImageText = InLineWithText, String description = "") #
WordParagraph.PublicMethods.Images.cs:119
Returns: WordImage

Inserts an image from a Base64 payload and returns the created WordImage.

Parameters

base64String System.String requiredposition: 0
fileName System.String requiredposition: 1
width System.Double? = null optionalposition: 2
height System.Double? = null optionalposition: 3
wrapImageText OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
description System.String = "" optionalposition: 5
public static Boolean op_Equality(WordParagraph? left, WordParagraph? right) #
WordParagraph.Equality.cs:54
Returns: Boolean

Determines whether two WordParagraph instances are equal.

Parameters

left OfficeIMO.Word.WordParagraph? requiredposition: 0
The left-hand instance.
right OfficeIMO.Word.WordParagraph? requiredposition: 1
The right-hand instance.

Returns

true if the instances are equal; otherwise, false.

public static Boolean op_Inequality(WordParagraph? left, WordParagraph? right) #
WordParagraph.Equality.cs:65
Returns: Boolean

Determines whether two WordParagraph instances are not equal.

Parameters

left OfficeIMO.Word.WordParagraph? requiredposition: 0
The left-hand instance.
right OfficeIMO.Word.WordParagraph? requiredposition: 1
The right-hand instance.

Returns

true if the instances are not equal; otherwise, false.

public Void Remove() #
WordParagraph.PublicMethods.Structure.cs:37
Returns: Void

Remove the paragraph from WordDocument

Exceptions

  • InvalidOperationException
public Void RemoveCheckBox() #
WordParagraph.PublicMethods.ContentControls.cs:109
Returns: Void

Removes the checkbox from the paragraph.

public WordParagraph SetAlignment(WordParagraphAlignment alignment) #
WordParagraph.RunPropertiesMethods.cs:154
Returns: WordParagraph

Sets the paragraph alignment.

Parameters

alignment OfficeIMO.Word.WordParagraphAlignment requiredposition: 0
Alignment value.

Returns

The current paragraph instance.

public WordParagraph SetBold(Boolean isBold = true) #
WordParagraph.RunPropertiesMethods.cs:15
Returns: WordParagraph

Sets the WordParagraph.Bold property.

Parameters

isBold System.Boolean = true optionalposition: 0
Whether the text should be bold.

Returns

The current paragraph instance.

public WordParagraph SetCapsStyle(WordCapsStyle capsStyle) #
WordParagraph.RunPropertiesMethods.cs:173
Returns: WordParagraph

Sets the capitalization style for the text.

Parameters

capsStyle OfficeIMO.Word.WordCapsStyle requiredposition: 0
Capitalization style.

Returns

The current paragraph instance.

public WordParagraph SetCharacterStyle(WordCharacterStyles style) #
WordParagraph.RunPropertiesMethods.cs:293
Returns: WordParagraph

Sets the character style for the run.

Parameters

style OfficeIMO.Word.WordCharacterStyles requiredposition: 0
Character style to apply.

Returns

The current paragraph instance.

public WordParagraph SetCharacterStyleId(String styleId) #
WordParagraph.RunPropertiesMethods.cs:303
Returns: WordParagraph

Sets the character style by identifier.

Parameters

styleId System.String requiredposition: 0
The style identifier.

Returns

The current paragraph instance.

public Void SetCheckBoxValue(Boolean value) #
WordParagraph.PublicMethods.ContentControls.cs:117
Returns: Void

Sets the checked state of the paragraph's checkbox.

Parameters

value System.Boolean requiredposition: 0
New checked state.
public WordParagraph SetColor(OfficeColor color) #
WordParagraph.RunPropertiesMethods.cs:145
Returns: WordParagraph

Sets the text color using OfficeColor.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0
The color to apply.

Returns

The current paragraph instance.

public WordParagraph SetColorHex(String color) #
WordParagraph.RunPropertiesMethods.cs:136
Returns: WordParagraph

Sets the text color using a hexadecimal value.

Parameters

color System.String requiredposition: 0
Color in hexadecimal format.

Returns

The current paragraph instance.

public WordParagraph SetDoubleStrike(Boolean isDoubleStrike = true) #
WordParagraph.RunPropertiesMethods.cs:60
Returns: WordParagraph

Enables or disables double strikethrough on the text.

Parameters

isDoubleStrike System.Boolean = true optionalposition: 0
Whether the text should be double struck.

Returns

The current paragraph instance.

public WordParagraph SetEmboss(Boolean isEmboss = true) #
WordParagraph.RunPropertiesMethods.cs:90
Returns: WordParagraph

Enables or disables emboss effect on the text.

Parameters

isEmboss System.Boolean = true optionalposition: 0
Whether the text should be embossed.

Returns

The current paragraph instance.

public WordParagraph SetFontFamily(String fontFamily) #
WordParagraph.RunPropertiesMethods.cs:118
Returns: WordParagraph

Sets the font family for the text.

Parameters

fontFamily System.String requiredposition: 0
Name of the font family.

Returns

The current paragraph instance.

public WordParagraph SetFontSize(Int32 fontSize) #
WordParagraph.RunPropertiesMethods.cs:109
Returns: WordParagraph

Sets the font size for the text.

Parameters

fontSize System.Int32 requiredposition: 0
Font size in points.

Returns

The current paragraph instance.

public WordParagraph SetHighlight(WordHighlightColor highlight) #
WordParagraph.RunPropertiesMethods.cs:164
Returns: WordParagraph

Sets the highlight color for the text.

Parameters

highlight OfficeIMO.Word.WordHighlightColor requiredposition: 0
Highlight color.

Returns

The current paragraph instance.

public WordParagraph SetItalic(Boolean isItalic = true) #
WordParagraph.RunPropertiesMethods.cs:24
Returns: WordParagraph

Sets the WordParagraph.Italic property.

Parameters

isItalic System.Boolean = true optionalposition: 0
Whether the text should be italic.

Returns

The current paragraph instance.

public WordParagraph SetLanguage(String language) #
WordParagraph.RunPropertiesMethods.cs:127
Returns: WordParagraph

Sets the language for the text run.

Parameters

language System.String requiredposition: 0
Language tag, such as en-US or pl-PL.

Returns

The current paragraph instance.

public WordParagraph SetOutline(Boolean isOutline = true) #
WordParagraph.RunPropertiesMethods.cs:70
Returns: WordParagraph

Enables or disables outline effect on the text.

Parameters

isOutline System.Boolean = true optionalposition: 0
Whether the text should be outlined.

Returns

The current paragraph instance.

public WordParagraph SetRunShadingFillColorHex(String color) #
WordParagraph.RunShading.cs:70
Returns: WordParagraph

Applies an exact hexadecimal fill color to the current text run.

Parameters

color System.String requiredposition: 0
Color in hexadecimal format.

Returns

The current paragraph or run wrapper.

public WordParagraph SetShadow(Boolean isShadow = true) #
WordParagraph.RunPropertiesMethods.cs:80
Returns: WordParagraph

Enables or disables shadow effect on the text.

Parameters

isShadow System.Boolean = true optionalposition: 0
Whether the text should have a shadow.

Returns

The current paragraph instance.

public WordParagraph SetSmallCaps(Boolean isSmallCaps = true) #
WordParagraph.RunPropertiesMethods.cs:100
Returns: WordParagraph

Enables or disables small caps formatting on the text.

Parameters

isSmallCaps System.Boolean = true optionalposition: 0
Whether the text should use small caps.

Returns

The current paragraph instance.

public WordParagraph SetSpacing(Int32 spacing) #
WordParagraph.RunPropertiesMethods.cs:42
Returns: WordParagraph

Sets the character spacing for the text.

Parameters

spacing System.Int32 requiredposition: 0
Spacing value in twentieths of a point.

Returns

The current paragraph instance.

public WordParagraph SetStrike(Boolean isStrike = true) #
WordParagraph.RunPropertiesMethods.cs:51
Returns: WordParagraph

Enables or disables single strikethrough on the text.

Parameters

isStrike System.Boolean = true optionalposition: 0
Whether the text should be struck through.

Returns

The current paragraph instance.

public WordParagraph SetStyle(WordParagraphStyles style) #
WordParagraph.RunPropertiesMethods.cs:253
Returns: WordParagraph

Sets the paragraph style.

Parameters

style OfficeIMO.Word.WordParagraphStyles requiredposition: 0
The style to apply.

Returns

The current paragraph instance.

public WordParagraph SetStyleId(String styleId) #
WordParagraph.RunPropertiesMethods.cs:276
Returns: WordParagraph

Sets the paragraph style by identifier.

Parameters

styleId System.String requiredposition: 0
The style identifier.

Returns

The current paragraph instance.

Examples


Style style = new() {
    Type = StyleValues.Paragraph,
    StyleId = "MyStyle"
};

WordParagraphStyle.RegisterCustomStyle("MyStyle", style);
document.AddParagraph("Hello world").SetStyleId("MyStyle");
public WordParagraph SetSubScript() #
WordParagraph.RunPropertiesMethods.cs:322
Returns: WordParagraph

Set the text as subscript

public WordParagraph SetSuperScript() #
WordParagraph.RunPropertiesMethods.cs:331
Returns: WordParagraph

Set the text as superscript

public WordParagraph SetText(String text) #
WordParagraph.RunPropertiesMethods.cs:182
Returns: WordParagraph

Sets the paragraph text.

Parameters

text System.String requiredposition: 0
The text content.

Returns

The current paragraph instance.

public WordParagraph SetUnderline(WordUnderlineStyle underline) #
WordParagraph.RunPropertiesMethods.cs:33
Returns: WordParagraph

Sets the underline style for the text.

Parameters

underline OfficeIMO.Word.WordUnderlineStyle requiredposition: 0
Underline style.

Returns

The current paragraph instance.

public WordParagraph SetVerticalTextAlignment(WordVerticalTextPosition? verticalPositionValue) #
WordParagraph.RunPropertiesMethods.cs:313
Returns: WordParagraph

Set the vertical text alignment

Parameters

verticalPositionValue OfficeIMO.Word.WordVerticalTextPosition? requiredposition: 0
public WordParagraph TransformTextCase(OfficeTextCase textCase, CultureInfo? culture = null) #
WordParagraph.RunPropertiesMethods.cs:193
Returns: WordParagraph

Changes the stored run text casing while preserving run formatting.

Parameters

textCase OfficeIMO.Drawing.OfficeTextCase requiredposition: 0
Casing transformation to apply.
culture System.Globalization.CultureInfo? = null optionalposition: 1
Culture used for casing. The current culture is used when omitted.

Returns

The current paragraph instance.

Properties

public WordBreak? PageBreak { get; } #
WordParagraph.BreaksTabs.cs:29

Get PageBreaks within Paragraph

public WordBreak? Break { get; } #
WordParagraph.BreaksTabs.cs:45

Get Breaks within Paragraph

public WordTabChar? Tab { get; } #
WordParagraph.BreaksTabs.cs:61

Gets the WordTabChar representing a tab character in the current run, or null if none is present.

public Boolean IsTab { get; } #
WordParagraph.BreaksTabs.cs:74

Gets a value indicating whether the run within the paragraph contains a tab character.

public List<WordTabStop> TabStops { get; } #
WordParagraph.BreaksTabs.cs:80

Gets all tab stops defined on the paragraph.

public Int32? CharacterScale { get; set; } #
WordParagraph.CharacterScale.cs:12

Gets or sets the directly authored character width as a percentage between 1 and 600. A value of 100 restores normal width; null removes the direct value and restores style inheritance. Character height and character spacing are independent of this setting.

public WordStructuredDocumentTag? StructuredDocumentTag { get; } #
WordParagraph.ContentControls.cs:29

Gets the structured document tag contained in this paragraph, if present.

public WordCheckBox? CheckBox { get; } #
WordParagraph.ContentControls.cs:42

Gets the checkbox contained in this paragraph, if present.

public WordDatePicker? DatePicker { get; } #
WordParagraph.ContentControls.cs:56

Gets the date picker contained in this paragraph, if present.

public WordDropDownList? DropDownList { get; } #
WordParagraph.ContentControls.cs:69

Gets the dropdown list contained in this paragraph, if present.

public WordComboBox? ComboBox { get; } #
WordParagraph.ContentControls.cs:82

Gets the combo box contained in this paragraph, if present.

public WordPictureControl? PictureControl { get; } #
WordParagraph.ContentControls.cs:95

Gets the picture content control contained in this paragraph, if present.

public WordRepeatingSection? RepeatingSection { get; } #
WordParagraph.ContentControls.cs:107

Gets the repeating section contained in this paragraph, if present.

public Boolean IsStructuredDocumentTag { get; } #
WordParagraph.ContentControls.cs:113

Gets a value indicating whether the paragraph holds a structured document tag.

public Boolean IsCheckBox { get; } #
WordParagraph.ContentControls.cs:118

Gets a value indicating whether the paragraph contains a checkbox control.

public Boolean IsDatePicker { get; } #
WordParagraph.ContentControls.cs:124

Gets a value indicating whether the paragraph contains a date picker control.

public Boolean IsDropDownList { get; } #
WordParagraph.ContentControls.cs:129

Gets a value indicating whether the paragraph contains a dropdown list control.

public Boolean IsComboBox { get; } #
WordParagraph.ContentControls.cs:134

Gets a value indicating whether the paragraph contains a combo box control.

public Boolean IsPictureControl { get; } #
WordParagraph.ContentControls.cs:139

Gets a value indicating whether the paragraph contains a picture control.

public Boolean IsRepeatingSection { get; } #
WordParagraph.ContentControls.cs:144

Gets a value indicating whether the paragraph contains a repeating section control.

public Object? Parent { get; internal set; } #
WordParagraph.cs:38

Gets the parent object that owns this paragraph (for example a table cell, header, footer or section).

public Boolean IsLastRun { get; } #
WordParagraph.cs:108

Gets a value indicating whether this run is the last run within its parent container.

public Boolean IsFirstRun { get; } #
WordParagraph.cs:124

Gets a value indicating whether this run is the first run within its parent container.

public Boolean IsListItem { get; } #
WordParagraph.cs:178

Gets a value indicating whether this paragraph is part of a numbered or bulleted list.

public Int32? ListItemLevel { get; set; } #
WordParagraph.cs:187

Gets or sets the indentation level for the paragraph when it belongs to a list.

public WordListStyle? ListStyle { get; } #
WordParagraph.cs:237

Gets the list style when this paragraph is part of a list.

public WordParagraphStyles? Style { get; set; } #
WordParagraph.cs:247

Gets or sets the paragraph style. Updating this to a heading style will flag the document to update the table of contents on open.

public WordImage? Image { get; } #
WordParagraph.DrawingMedia.cs:30

Gets the first independent image associated with this run, if any. Group-owned images remain part of their group.

public WordEmbeddedObject? EmbeddedObject { get; } #
WordParagraph.DrawingMedia.cs:94

Gets the embedded object associated with this run, if any.

public WordChart? Chart { get; } #
WordParagraph.DrawingMedia.cs:109

Gets the chart contained in this paragraph, if present.

public WordSmartArt? SmartArt { get; } #
WordParagraph.DrawingMedia.cs:129

Gets the SmartArt diagram contained in this paragraph, if present.

public Boolean IsImage { get; } #
WordParagraph.DrawingMedia.cs:144

Gets a value indicating whether an image is found in the paragraph.

public Boolean IsEmbeddedObject { get; } #
WordParagraph.DrawingMedia.cs:149

Gets a value indicating whether the paragraph has an embedded object.

public Boolean IsChart { get; } #
WordParagraph.DrawingMedia.cs:153

Gets a value indicating whether a chart is associated with the paragraph.

public Boolean IsSmartArt { get; } #
WordParagraph.DrawingMedia.cs:158

Gets a value indicating whether SmartArt is present in the paragraph.

public WordTextBox? TextBox { get; } #
WordParagraph.DrawingMedia.cs:162

Gets the WordTextBox contained within the paragraph, if any.

public WordShape? Shape { get; } #
WordParagraph.DrawingMedia.cs:185

Returns a WordShape instance when the paragraph contains shapes.

public WordLine? Line { get; } #
WordParagraph.DrawingMedia.cs:227

Gets the line shape contained in this paragraph, if present.

public Boolean IsTextBox { get; } #
WordParagraph.DrawingMedia.cs:240

Gets a value indicating whether the paragraph contains a text box.

public Boolean IsShape { get; } #
WordParagraph.DrawingMedia.cs:245

Gets a value indicating whether the paragraph contains a shape.

public Boolean IsLine { get; } #
WordParagraph.DrawingMedia.cs:250

Gets a value indicating whether the paragraph contains a VML line shape.

public Boolean? PageBreakBeforeOverride { get; set; } #
WordParagraph.FormattingOverrides.cs:8

Gets or sets directly authored page-break-before formatting. Null restores style inheritance; false overrides an enabled style.

public Boolean? KeepWithNextOverride { get; set; } #
WordParagraph.FormattingOverrides.cs:14

Gets or sets directly authored keep-with-next formatting. Null restores style inheritance; false overrides an enabled style.

public Boolean? KeepLinesTogetherOverride { get; set; } #
WordParagraph.FormattingOverrides.cs:20

Gets or sets directly authored keep-lines-together formatting. Null restores style inheritance; false overrides an enabled style.

public Boolean? AvoidWidowAndOrphanOverride { get; set; } #
WordParagraph.FormattingOverrides.cs:26

Gets or sets directly authored widow/orphan control. Null restores style inheritance; false disables the control.

public Boolean? ContextualSpacing { get; set; } #
WordParagraph.FormattingOverrides.cs:32

Gets or sets suppression of spacing between paragraphs of the same style. Null restores style inheritance.

public Boolean? SuppressLineNumbers { get; set; } #
WordParagraph.FormattingOverrides.cs:38

Gets or sets paragraph line-number suppression. Null restores style inheritance. This preserves the Word setting and does not enable line-number rendering in PDF.

public Boolean? SuppressAutoHyphens { get; set; } #
WordParagraph.FormattingOverrides.cs:44

Gets or sets paragraph automatic-hyphenation suppression. Null restores style inheritance. Automatic Word hyphenation is not supplied by this property.

public Boolean? MirrorIndents { get; set; } #
WordParagraph.FormattingOverrides.cs:50

Gets or sets use of left/right indents as inside/outside indents. Null restores style inheritance. Fixed-layout exporters have their own mirrored-layout support limits.

public Int32? OutlineLevel { get; set; } #
WordParagraph.FormattingOverrides.cs:56

Gets or sets the directly authored outline level: 0-8 for heading levels 1-9, 9 for body text, or null to inherit. Word uses the built-in heading level for Heading1-Heading9 styles regardless of this authored value.

public Boolean? Hidden { get; set; } #
WordParagraph.Hidden.cs:13

Gets or sets directly authored hidden formatting on this run. True hides the run, false overrides an inherited hidden setting, and null restores style inheritance. The getter reports direct formatting, not the effective style.

public Double? KerningMinimumFontSizePoints { get; set; } #
WordParagraph.Kerning.cs:11

Gets or sets the minimum font size, in points, at which this run uses kerning. Null inherits the threshold; zero disables kerning. Values from zero to 1638 are rounded to Word's half-point precision and are preserved in DOCX and native DOC.

public WordParagraphBorders Borders { get; } #
WordParagraph.ParagraphProperties.cs:11

Provides access to the borders applied to this paragraph.

public String? StyleId { get; } #
WordParagraph.ParagraphProperties.cs:20

Gets the identifier of the paragraph style, if any.

public WordParagraphAlignment? ParagraphAlignment { get; set; } #
WordParagraph.ParagraphProperties.cs:34

Alignment aka Paragraph Alignment. This element specifies the paragraph alignment which shall be applied to text in this paragraph. If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e.that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then no alignment is applied to the paragraph. Setting this property to null removes direct alignment and restores style inheritance.

public WordVerticalCharacterAlignment? VerticalCharacterAlignmentOnLine { get; set; } #
WordParagraph.ParagraphProperties.cs:60

Text Alignment aka Vertical Character Alignment on Line. This element specifies the vertical alignment of all text on each line displayed within a paragraph. If the line height (before any added spacing) is larger than one or more characters on the line, all characters are aligned to each other as specified by this element. If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e.that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then the vertical alignment of all characters on the line shall be automatically determined by the consumer. Setting this property to null removes direct alignment and restores style inheritance.

public Int32? IndentationBefore { get; set; } #
WordParagraph.ParagraphProperties.cs:81

Gets or sets the indentation before the paragraph in twips (1/20 of a point).

public Double? IndentationBeforePoints { get; set; } #
WordParagraph.ParagraphProperties.cs:103

Gets or sets the indentation before in points.

public Int32? IndentationAfter { get; set; } #
WordParagraph.ParagraphProperties.cs:119

Gets or sets the indentation after the paragraph in twips (1/20 of a point).

public Double? IndentationAfterPoints { get; set; } #
WordParagraph.ParagraphProperties.cs:141

Gets or sets the indentation after in points.

public Boolean PageBreakBefore { get; set; } #
WordParagraph.ParagraphProperties.cs:156

Gets or sets a directly authored page-break-before value; this does not resolve inherited paragraph styles.

public Boolean KeepWithNext { get; set; } #
WordParagraph.ParagraphProperties.cs:173

Gets or sets directly authored keep-with-next formatting without resolving paragraph styles.

public Boolean KeepLinesTogether { get; set; } #
WordParagraph.ParagraphProperties.cs:191

Gets or sets directly authored keep-lines-together formatting without resolving paragraph styles.

public Boolean AvoidWidowAndOrphan { get; set; } #
WordParagraph.ParagraphProperties.cs:209

Gets or sets directly authored widow and orphan control without resolving paragraph styles.

public Int32? IndentationFirstLine { get; set; } #
WordParagraph.ParagraphProperties.cs:229

Gets or sets the first line indentation in twips (1/20 of a point).

public Double? IndentationFirstLinePoints { get; set; } #
WordParagraph.ParagraphProperties.cs:251

Gets or sets the first line indentation in points.

public Int32? IndentationHanging { get; set; } #
WordParagraph.ParagraphProperties.cs:267

Gets or sets the hanging indentation in twips (1/20 of a point).

public Double? IndentationHangingPoints { get; set; } #
WordParagraph.ParagraphProperties.cs:289

Gets or sets the hanging indentation in points.

public WordTextDirection? TextDirection { get; set; } #
WordParagraph.ParagraphProperties.cs:305

Gets or sets the text flow direction for the paragraph.

public Boolean BiDi { get; set; } #
WordParagraph.ParagraphProperties.cs:324

Gets or sets directly authored right-to-left layout without resolving paragraph styles.

public WordLineSpacingRule? LineSpacingRule { get; set; } #
WordParagraph.ParagraphProperties.cs:352

Gets or sets the rule used to calculate line spacing for the paragraph.

public Int32? LineSpacing { get; set; } #
WordParagraph.ParagraphProperties.cs:372

Gets or sets the authored line-spacing value. Automatic spacing uses 240ths of a line; exact and minimum spacing use twips (1/20 of a point).

public Double? LineSpacingPoints { get; set; } #
WordParagraph.ParagraphProperties.cs:398

Gets or sets the authored line-spacing value converted from twips to points. Setting a point value selects exact spacing when no rule is declared. With automatic spacing, use WordParagraph.LineSpacing for the line multiplier.

public Int32? LineSpacingBefore { get; set; } #
WordParagraph.ParagraphProperties.cs:417

Gets or sets the spacing before the paragraph in twips (1/20 of a point).

public Double? LineSpacingBeforePoints { get; set; } #
WordParagraph.ParagraphProperties.cs:439

Gets or sets the line spacing before in points.

public Int32? LineSpacingAfter { get; set; } #
WordParagraph.ParagraphProperties.cs:455

Gets or sets the spacing after the paragraph in twips (1/20 of a point).

public Double? LineSpacingAfterPoints { get; set; } #
WordParagraph.ParagraphProperties.cs:477

Gets or sets the line spacing after in points.

public WordVerticalTextPosition? VerticalTextAlignment { get; set; } #
WordParagraph.ParagraphProperties.cs:494

Gets or sets the vertical text alignment - the alignment of the text in the paragraph with respect to the line height.

public WordBookmark? Bookmark { get; } #
WordParagraph.References.cs:29

Gets the bookmark associated with this paragraph, if present.

public WordEquation? Equation { get; } #
WordParagraph.References.cs:36

Gets the mathematical equation contained in this paragraph, if any.

public WordField? Field { get; } #
WordParagraph.References.cs:57

Gets the field contained in this paragraph, if any.

public WordFootNote? FootNote { get; } #
WordParagraph.References.cs:69

Gets the footnote associated with this paragraph, if any.

public WordEndNote? EndNote { get; } #
WordParagraph.References.cs:84

Gets the endnote associated with this paragraph, if any.

public Boolean IsField { get; } #
WordParagraph.References.cs:104

Gets a value indicating whether the paragraph hosts a field code.

public Boolean IsBookmark { get; } #
WordParagraph.References.cs:114

Gets a value indicating whether the paragraph includes a bookmark start tag.

public Boolean IsEquation { get; } #
WordParagraph.References.cs:122

Gets a value indicating whether the paragraph contains an equation.

public Boolean IsEndNote { get; } #
WordParagraph.References.cs:126

Gets a value indicating whether an endnote reference is present in the paragraph.

public Boolean IsFootNote { get; } #
WordParagraph.References.cs:131

Gets a value indicating whether a footnote reference is present in the paragraph.

public Boolean IsEmpty { get; } #
WordParagraph.Run.cs:9

Gets a value indicating whether the paragraph contains no run element.

public Boolean IsPageBreak { get; } #
WordParagraph.Run.cs:21

Gets a value indicating whether the paragraph contains a page break.

public Boolean IsColumnBreak { get; } #
WordParagraph.Run.cs:34

Gets a value indicating whether the paragraph contains a column break.

public Boolean IsBreak { get; } #
WordParagraph.Run.cs:43

Gets a value indicating whether the paragraph contains a break element.

public Boolean Bold { get; set; } #
WordParagraph.RunProperties.cs:18

Gets or sets a value indicating whether the run is bold.

public Boolean Italic { get; set; } #
WordParagraph.RunProperties.cs:49

Gets or sets a value indicating whether the run is italic.

public WordUnderlineStyle? Underline { get; set; } #
WordParagraph.RunProperties.cs:73

Gets or sets the underline style for the run.

public Boolean DoNotCheckSpellingOrGrammar { get; set; } #
WordParagraph.RunProperties.cs:104

Gets or sets a value indicating whether spelling and grammar checks are disabled.

public Int32? Spacing { get; set; } #
WordParagraph.RunProperties.cs:128

Gets or sets the character spacing value in twentieths of a point.

public Boolean Strike { get; set; } #
WordParagraph.RunProperties.cs:157

Gets or sets a value indicating whether the run is struck through.

public Boolean DoubleStrike { get; set; } #
WordParagraph.RunProperties.cs:181

Gets or sets a value indicating whether the run has a double strikethrough.

public Boolean Outline { get; set; } #
WordParagraph.RunProperties.cs:205

Gets or sets a value indicating whether the run text is outlined.

public Boolean Shadow { get; set; } #
WordParagraph.RunProperties.cs:229

Gets or sets a value indicating whether the run has a shadow effect.

public Boolean Emboss { get; set; } #
WordParagraph.RunProperties.cs:253

Gets or sets a value indicating whether the run is embossed.

public Int32? FontSize { get; set; } #
WordParagraph.RunProperties.cs:277

Gets or sets the font size in points.

public Double? FontSizePoints { get; set; } #
WordParagraph.RunProperties.cs:289

Gets or sets the font size in points with Word's native half-point precision. Values finer than half a point are rounded away from zero to the nearest representable size.

public OfficeColor? Color { get; set; } #
WordParagraph.RunProperties.cs:324

Gets or sets the text color using OfficeColor.

public String ColorHex { get; set; } #
WordParagraph.RunProperties.cs:341

Gets or sets the text color as a hexadecimal string.

public WordThemeColor? ThemeColor { get; set; } #
WordParagraph.RunProperties.cs:370

Gets or sets the theme color applied to the run.

public WordHighlightColor? Highlight { get; set; } #
WordParagraph.RunProperties.cs:402

Gets or sets the highlight color applied to the run.

public WordCapsStyle CapsStyle { get; set; } #
WordParagraph.RunProperties.cs:434

Gets or sets the capitalization style for the run.

public String? FontFamily { get; set; } #
WordParagraph.RunProperties.cs:474

FontFamily gets and sets the FontFamily of a WordParagraph. To make sure that FontFamily works correctly on special characters we change the RunFonts.Ascii and RunFonts.HighAnsi, EastAsia and ComplexScript properties If you want to set different FontFamily for HighAnsi, EastAsia and ComplexScript please use FontFamilyHighAnsi, FontFamilyEastAsia or FontFamilyComplexScript in proper order (to overwrite given FontFamily)

public String? FontFamilyHighAnsi { get; set; } #
WordParagraph.RunProperties.cs:511

Gets or sets the HighAnsi font family.

public String? FontFamilyEastAsia { get; set; } #
WordParagraph.RunProperties.cs:542

Gets or sets the East Asia font family.

public String? FontFamilyComplexScript { get; set; } #
WordParagraph.RunProperties.cs:573

Gets or sets the complex script font family.

public String? Language { get; set; } #
WordParagraph.RunProperties.cs:604

Gets or sets the language applied to the run.

public WordCharacterStyles? CharacterStyle { get; set; } #
WordParagraph.RunProperties.cs:634

Gets or sets the character style applied to the run.

public String? CharacterStyleId { get; set; } #
WordParagraph.RunProperties.cs:666

Gets or sets the style identifier applied to the run.

public String RunShadingFillColorHex { get; set; } #
WordParagraph.RunShading.cs:15

Gets or sets the exact fill color applied to the current text run.

public OfficeColor? RunShadingFillColor { get; set; } #
WordParagraph.RunShading.cs:55

Gets or sets the exact fill color applied to the current text run.

public String ShadingFillColorHex { get; set; } #
WordParagraph.Shading.cs:11

Get or set the paragraph shading fill color using hexadecimal value.

public OfficeColor? ShadingFillColor { get; set; } #
WordParagraph.Shading.cs:32

Get or set the paragraph shading fill color.

public WordShadingPattern? ShadingPattern { get; set; } #
WordParagraph.Shading.cs:50

Get or set the paragraph shading pattern.

public WordShapeGroup? ShapeGroup { get; } #
WordParagraph.ShapeGroups.cs:13

Gets the native DrawingML shape group hosted by this paragraph, when present.

public Boolean IsShapeGroup { get; } #
WordParagraph.ShapeGroups.cs:22

Gets whether this paragraph hosts a native DrawingML shape group.

public String Text { get; set; } #
WordParagraph.Text.cs:66

Gets or sets the text for this run. Text-wrapping breaks (null or BreakValues.TextWrapping) are surfaced as "\n" in the returned string so callers receive the same representation on every platform. The setter accepts any mix of "\r\n", "\r", or "\n" and normalizes them to "\n" before updating the OpenXML elements. Non text-wrapping breaks—such as page or column breaks—are represented using the Unicode line separator character ('\u2028') so that text operations (for example find/replace) can preserve their positions. When the text is modified those breaks are re-inserted at their original locations. Imported text nodes honor xml:space: insignificant XML whitespace at either edge is omitted unless the node declares preserve. Reading text preserves source XML.

Extension Methods

public static String ToXml(WordParagraph paragraph) #
WordXmlExtensions.cs:14
Returns: String

Returns the raw Open XML string representing the paragraph.

Parameters

paragraph OfficeIMO.Word.WordParagraph requiredposition: 0
Paragraph to convert.

Returns

Outer XML of the underlying Open XML element.