Get Started

API Reference

Class

TextBuilder

Edit on GitHub
Namespace OfficeIMO.Word.Fluent
Assembly OfficeIMO.Word
Source OfficeIMO.Word/Fluent/TextBuilder.cs:23

Provides helpers for styling text fragments.

Inheritance

  • Object
  • TextBuilder

Usage

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

Returned or exposed by

Accepted by parameters

Methods

public TextBuilder BoldOn() #
OfficeIMO.Word/Fluent/TextBuilder.cs:23
Returns: TextBuilder

Applies bold formatting to the current run.

public TextBuilder CapsStyle(CapsStyle capsStyle) #
OfficeIMO.Word/Fluent/TextBuilder.cs:122
Returns: TextBuilder

Applies capitalization style to the current run.

Parameters

capsStyle OfficeIMO.Word.CapsStyle requiredposition: 0
Capitalization style.
public TextBuilder Color(String hex) #
OfficeIMO.Word/Fluent/TextBuilder.cs:40
Returns: TextBuilder

Sets the text color using a hexadecimal value.

Parameters

hex System.String requiredposition: 0
Color in hexadecimal format.
public TextBuilder DoubleStrike(Boolean isDoubleStrike = true) #
OfficeIMO.Word/Fluent/TextBuilder.cs:70
Returns: TextBuilder

Applies double strikethrough formatting to the current run.

Parameters

isDoubleStrike System.Boolean = true optionalposition: 0
Whether to apply double strikethrough.
public TextBuilder Emboss() #
OfficeIMO.Word/Fluent/TextBuilder.cs:146
Returns: TextBuilder

Applies emboss formatting to the current run.

public TextBuilder FontFamily(String fontFamily) #
OfficeIMO.Word/Fluent/TextBuilder.cs:88
Returns: TextBuilder

Sets the font family for the current run.

Parameters

fontFamily System.String requiredposition: 0
Font family name.
public TextBuilder FontSize(Int32 fontSize) #
OfficeIMO.Word/Fluent/TextBuilder.cs:79
Returns: TextBuilder

Sets the font size for the current run.

Parameters

fontSize System.Int32 requiredposition: 0
Font size in points.
public TextBuilder Highlight(HighlightColorValues highlight) #
OfficeIMO.Word/Fluent/TextBuilder.cs:97
Returns: TextBuilder

Applies a highlight color to the current run.

Parameters

highlight DocumentFormat.OpenXml.Wordprocessing.HighlightColorValues requiredposition: 0
Highlight color.
public TextBuilder ItalicOn() #
OfficeIMO.Word/Fluent/TextBuilder.cs:31
Returns: TextBuilder

Applies italic formatting to the current run.

public TextBuilder Outline() #
OfficeIMO.Word/Fluent/TextBuilder.cs:130
Returns: TextBuilder

Applies outline formatting to the current run.

public TextBuilder Shadow() #
OfficeIMO.Word/Fluent/TextBuilder.cs:138
Returns: TextBuilder

Applies shadow formatting to the current run.

public TextBuilder SmallCaps() #
OfficeIMO.Word/Fluent/TextBuilder.cs:154
Returns: TextBuilder

Applies small caps formatting to the current run.

public TextBuilder Strike(Boolean isStrike = true) #
OfficeIMO.Word/Fluent/TextBuilder.cs:61
Returns: TextBuilder

Applies single strikethrough formatting to the current run.

Parameters

isStrike System.Boolean = true optionalposition: 0
Whether to apply strikethrough.
public TextBuilder SubScript() #
OfficeIMO.Word/Fluent/TextBuilder.cs:105
Returns: TextBuilder

Sets the text as subscript.

public TextBuilder SuperScript() #
OfficeIMO.Word/Fluent/TextBuilder.cs:113
Returns: TextBuilder

Sets the text as superscript.

public TextBuilder Underline(UnderlineValues underline) #
OfficeIMO.Word/Fluent/TextBuilder.cs:52
Returns: TextBuilder

Applies underline formatting to the current run.

Parameters

underline DocumentFormat.OpenXml.Wordprocessing.UnderlineValues requiredposition: 0
Underline style.

Properties

public WordParagraph Paragraph { get; } #
OfficeIMO.Word/Fluent/TextBuilder.cs:17

Gets the paragraph associated with this builder.