Class ParagraphBorders

Represents the borders of a paragraph.

Inheritance
System.Object
ParagraphBorders
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class ParagraphBorders : Object

When a paragraph needs a box, a rule above or below it, or a side bar, ParagraphBorders holds those edge settings. It groups the individual border definitions that surround a paragraph so a style can frame a callout, underline a heading, or set off a quotation from the body.

These borders are reached through a paragraph's style: ParagraphStyle exposes a Borders property of this type, so a developer configures the edges once on the style and every paragraph carrying that style inherits the framing. That keeps border formatting with the rest of a paragraph's look rather than scattering it across individual lines.

Each edge is a separate property. TopBorder and BottomBorder set the rules above and below the paragraph, while LeftBorder and RightBorder set the vertical edges, together forming a full box when all four are present. BetweenBorder draws the rule in the space between columns in a multi-column paragraph, and BarBorder adds the vertical bar down the left side often used to mark revised or quoted text. Each property takes a BorderStyle that defines that edge's appearance, including its width, color, and line pattern, and an edge left unset simply does not draw. Assign only the edges you want, then apply the owning ParagraphStyle to the paragraphs that should show them. Because the borders live on the style rather than the paragraph, every paragraph sharing that style picks up the same framing, which keeps a run of callouts or quotations consistent without repeating the configuration on each line.

var borders = new ParagraphBorders();
borders.BottomBorder = new BorderStyle();
paragraphStyle.Borders = borders;

The add style text how-to covers paragraph styling, the add style text example shows styled output, and the document element tutorial explains how styles attach to paragraphs.

Constructors

ParagraphBorders()

Declaration
public ParagraphBorders()

Properties

BarBorder

Gets or sets the border style for a vertical bar on the left side of the paragraph.

Declaration
public BorderStyle BarBorder { get; set; }
Property Value
Type Description
BorderStyle

BetweenBorder

Gets or sets the border style for the space between columns in a paragraph with multiple columns.

Declaration
public BorderStyle BetweenBorder { get; set; }
Property Value
Type Description
BorderStyle

BottomBorder

Gets or sets the bottom border style.

Declaration
public BorderStyle BottomBorder { get; set; }
Property Value
Type Description
BorderStyle

LeftBorder

Gets or sets the left border style.

Declaration
public BorderStyle LeftBorder { get; set; }
Property Value
Type Description
BorderStyle

RightBorder

Gets or sets the right border style.

Declaration
public BorderStyle RightBorder { get; set; }
Property Value
Type Description
BorderStyle

TopBorder

Gets or sets the top border style.

Declaration
public BorderStyle TopBorder { get; set; }
Property Value
Type Description
BorderStyle