Class BaseStyle

A style definition.

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

BaseStyle collects the formatting a Word document reuses by name, so paragraphs, runs, tables, and cells can share one consistent look instead of carrying inline formatting each. A developer building branded reports or applying a house style defines the appearance once on a BaseStyle and points content at it, which keeps a long document uniform and easy to restyle later.

A style is identified and applied through the document's style collection, where StyleId and StyleName give it the key and display name that content references. From there it nests the per-aspect style objects that actually carry the formatting, so one named style can govern several kinds of element at once.

The members fall into clear groups. For **identity and state**, StyleId and StyleName name the style, StyleType records the kind, IsDefaultStyle marks the document default, and Status (read-only) reports the change state of the style. For **inheritance**, InheritedStyle points at the style this one is based on and NextParagraphStyle names the style to apply to the following paragraph, the mechanism behind a heading that flows into body text. For the **formatting payload**, ParagraphStyle, TextStyle, TableStyle, and TableCellStyle hold the actual paragraph, run, table, and cell appearance, so a single named style can govern text and table formatting at once.

Set the few aspects a style needs and leave the rest, since a style only overrides what it specifies and inherits everything else from the style named by InheritedStyle. A paragraph style typically fills in ParagraphStyle and TextStyle, while a table style adds TableStyle and TableCellStyle. Reuse one BaseStyle across many paragraphs and cells rather than repeating inline formatting, which keeps a long document consistent and makes a later restyle a single edit.

using IronWord.Models;

var style = new BaseStyle();
style.StyleName = "Heading 1";
style.TextStyle = new TextStyle();

The add styled text how-to walks through applying formatting, the add table how-to shows table and cell styling, and the document element tutorial shows where styles sit in the object model.

Constructors

BaseStyle()

Declaration
public BaseStyle()

Properties

InheritedStyle

The base style object this style inherits from.

Declaration
public IBaseStyle InheritedStyle { get; set; }
Property Value
Type Description
IBaseStyle

IsDefaultStyle

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

NextParagraphStyle

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

ParagraphStyle

The paragraph style to be applied by default.

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

Status

Gets or sets the status of the Style, indicating whether it is new, updated, or deleted.

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

StyleId

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

StyleName

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

StyleType

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

TableCellStyle

The table cell style to be applied by default.

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

TableStyle

The table style to be applied by default.

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

TextStyle

The text style to be applied by default.

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

Methods

SetNoChangeStatusAsUpdated()

Set the element status as updated if it was originally set as IronSoftware.Abstractions.Word.ElementStatus.NoChange.

Declaration
protected void SetNoChangeStatusAsUpdated()

Implements

IronSoftware.Abstractions.Word.IBaseStyle
IronSoftware.Abstractions.Word.IStyle
IronSoftware.Abstractions.Word.IWordDocumentObjectProperty
IronSoftware.Abstractions.IDocumentObjectProperty