API Reference

Struct

FormattedRun

Namespace OfficeIMO.Word.FormattingHelper
Assembly OfficeIMO.Word
Base ValueType
Modifiers sealed

Represents a run of text or image with associated formatting flags.

Inheritance

  • ValueType
  • FormattedRun

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

Constructors

public FormattedRun(String text, WordImage image, Boolean bold, Boolean italic, Boolean underline, Boolean strike, Boolean superscript, Boolean subscript, Boolean code, String hyperlink) #

Initializes a new instance of the FormattedRun struct.

Parameters

text System.String requiredposition: 0
Text content of the run.
image OfficeIMO.Word.WordImage requiredposition: 1
Embedded image for the run.
bold System.Boolean requiredposition: 2
Indicates whether bold formatting is applied.
italic System.Boolean requiredposition: 3
Indicates whether italic formatting is applied.
underline System.Boolean requiredposition: 4
Indicates whether underline formatting is applied.
strike System.Boolean requiredposition: 5
Indicates whether strike-through formatting is applied.
superscript System.Boolean requiredposition: 6
Indicates whether superscript formatting is applied.
subscript System.Boolean requiredposition: 7
Indicates whether subscript formatting is applied.
code System.Boolean requiredposition: 8
Indicates whether monospace formatting is applied.
hyperlink System.String requiredposition: 9
Hyperlink target associated with the run.

Properties

public String Text { get; } #

Text content of the run, if any.

public WordImage Image { get; } #

Embedded image for the run, when present.

public Boolean Bold { get; } #

Indicates whether bold formatting is applied.

public Boolean Italic { get; } #

Indicates whether italic formatting is applied.

public Boolean Underline { get; } #

Indicates whether underline formatting is applied.

public Boolean Strike { get; } #

Indicates whether strike-through formatting is applied.

public Boolean Superscript { get; } #

Indicates whether superscript formatting is applied.

public Boolean Subscript { get; } #

Indicates whether subscript formatting is applied.

public Boolean Code { get; } #

Indicates whether the run should be rendered with monospace formatting.