Class ParagraphStyle

Represents the style properties applied to a paragraph in a Word document.

Inheritance
System.Object
ParagraphStyle
Implements
IronSoftware.Abstractions.Word.IParagraphStyle
IronSoftware.Abstractions.Word.IDerivedStyle
IronSoftware.Abstractions.Word.IStyle
IronSoftware.Abstractions.Word.IWordDocumentObjectProperty
IronSoftware.Abstractions.IDocumentObjectProperty
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class ParagraphStyle : Object, IParagraphStyle, IDerivedStyle

Reach for ParagraphStyle to define the look of a paragraph once and reuse it across a document, the spacing, alignment, borders, indentation, and pagination behavior that travel together as a named style. It gathers paragraph-level formatting into a single object so a developer sets it up once and applies it wherever that look is needed.

A style attaches to a paragraph through Paragraph.Style, or the shortcut SetStyle, and a paragraph with no explicit style inherits the document's default. Building one style on top of another is supported through BaseStyle, which records the style a derived style is based on, so a heading style can extend a body style and override only what differs.

Its properties fall into groups. Composition: Borders holds a ParagraphBorders for the edges, and Indentation holds a ParagraphIndentation for the indents, each its own configurable object. Alignment and spacing: Justification, TextAlignment, and LineSpacing control horizontal placement and line height, while ContextualSpacing suppresses extra space between same-styled paragraphs. Pagination and flow: KeepLinesOnPage prevents a paragraph splitting across pages, KeepWithNextParagraph ties it to the following one, PageBreakBefore forces a break ahead of it, and OutlineLevel sets its rank for navigation and tables of contents. Direction and wrapping: RightToLeft, WordWrap, MirrorIndents, and AdjustRightIndent handle bidirectional text and edge behavior, which matters for documents that mix scripts or print double-sided. Status reports the style's state. Setting these properties once on a shared style and reusing it keeps a document consistent and makes a global change a single edit, rather than touching every paragraph in turn.

var style = new ParagraphStyle();
style.KeepWithNextParagraph = true;
paragraph.SetStyle(style);

The add style text how-to walks through styling paragraphs, the add style text example shows the result, and the document element tutorial covers how styles fit the document model.

Constructors

ParagraphStyle()

Create a new paragraph style

Declaration
public ParagraphStyle()

Properties

AdjustRightIndent

Declaration
public Nullable<bool> AdjustRightIndent { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

AutoSpaceEastAndNumbers

Declaration
public Nullable<bool> AutoSpaceEastAndNumbers { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

AutoSpaceLatinAndEast

Declaration
public Nullable<bool> AutoSpaceLatinAndEast { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

BaseStyle

The original base style definition a style is based off of.

Declaration
public IBaseStyle BaseStyle { get; }
Property Value
Type Description
IBaseStyle

Borders

Border settings for the paragraph.

Declaration
public ParagraphBorders Borders { get; set; }
Property Value
Type Description
ParagraphBorders

ContextualSpacing

Declaration
public Nullable<bool> ContextualSpacing { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

DefaultStyle

The default paragraph style.

Declaration
public IParagraphStyle DefaultStyle { get; }
Property Value
Type Description
IParagraphStyle

Indentation

Indentation settings for the paragraph.

Declaration
public ParagraphIndentation Indentation { get; set; }
Property Value
Type Description
ParagraphIndentation

Justification

Declaration
public Nullable<JustificationValues> Justification { get; set; }
Property Value
Type Description
System.Nullable<IronSoftware.Abstractions.Word.JustificationValues>

KeepLinesOnPage

Declaration
public Nullable<bool> KeepLinesOnPage { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

KeepWithNextParagraph

Declaration
public Nullable<bool> KeepWithNextParagraph { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Kinsoku

Declaration
public Nullable<bool> Kinsoku { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LineSpacing

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

MirrorIndents

Declaration
public Nullable<bool> MirrorIndents { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

OutlineLevel

Declaration
public Nullable<int> OutlineLevel { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

OverflowPunctuation

Declaration
public Nullable<bool> OverflowPunctuation { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

PageBreakBefore

Declaration
public Nullable<bool> PageBreakBefore { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

RightToLeft

Declaration
public Nullable<bool> RightToLeft { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Status

Status of the element.

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

TextAlignment

Declaration
public Nullable<VerticalTextAlignmentValues> TextAlignment { get; set; }
Property Value
Type Description
System.Nullable<IronSoftware.Abstractions.Word.VerticalTextAlignmentValues>

WordWrap

Declaration
public Nullable<bool> WordWrap { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Implements

IronSoftware.Abstractions.Word.IParagraphStyle
IronSoftware.Abstractions.Word.IDerivedStyle
IronSoftware.Abstractions.Word.IStyle
IronSoftware.Abstractions.Word.IWordDocumentObjectProperty
IronSoftware.Abstractions.IDocumentObjectProperty