API Reference

Class

WordParagraphStyle

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Modifiers static

Provides helper methods for working with paragraph styles.

Inheritance

  • Object
  • WordParagraphStyle

Methods

public static WordParagraphStyleDefinition CreateFontStyle(String styleId, String fontName, String styleName = null) #
Returns: WordParagraphStyleDefinition

Creates a simple paragraph style that uses the specified font.

Parameters

styleId System.String requiredposition: 0
Identifier of the style.
fontName System.String requiredposition: 1
Font family to apply to runs.
styleName System.String = null optionalposition: 2
Optional friendly style name.

Returns

The created style.

public static WordParagraphStyles GetStyle(String style) #
Returns: WordParagraphStyles

Converts a style name string to its enumeration value.

Parameters

style System.String requiredposition: 0
public static WordParagraphStyleDefinition GetStyleDefinition(WordParagraphStyles style) #
Returns: WordParagraphStyleDefinition

Returns an OfficeIMO-owned definition for the specified style.

Parameters

style OfficeIMO.Word.WordParagraphStyles requiredposition: 0
public static Void OverrideBuiltInStyle(WordParagraphStyles style, WordParagraphStyleDefinition styleDefinition) #
Returns: Void

Replaces a built-in style definition with a custom one.

Parameters

style OfficeIMO.Word.WordParagraphStyles requiredposition: 0
styleDefinition OfficeIMO.Word.WordParagraphStyleDefinition requiredposition: 1
public static Void RegisterCustomStyle(String styleId, WordParagraphStyleDefinition styleDefinition) #
Returns: Void

Registers a custom paragraph style for later retrieval.

Parameters

styleId System.String requiredposition: 0
The style identifier used by paragraphs.
styleDefinition OfficeIMO.Word.WordParagraphStyleDefinition requiredposition: 1
The OfficeIMO style definition to register.

Examples


WordParagraphStyleDefinition style = new("MyStyle") {
    FontName = "Aptos",
    Bold = true
};

WordParagraphStyle.RegisterCustomStyle("MyStyle", style);

using WordDocument document = WordDocument.Create(filePath);
document.AddParagraph("Hello world").SetStyleId("MyStyle");
document.Save();
            
public static Void RegisterFontStyle(String styleId, String fontName, String styleName = null) #
Returns: Void

Registers a paragraph style that applies the specified font to all runs.

Parameters

styleId System.String requiredposition: 0
fontName System.String requiredposition: 1
styleName System.String = null optionalposition: 2
public static String ToStringStyle(WordParagraphStyles style) #
Returns: String

Converts an enumeration value to its style name string.

Parameters

style OfficeIMO.Word.WordParagraphStyles requiredposition: 0