API Reference

Class

TextRun

Edit on GitHub

Namespace OfficeIMO.Pdf

Assembly OfficeIMO.Pdf

Source OfficeIMO.Pdf/Model/TextRun.cs:59

Modifiers sealed

Inline text segment with basic styling.

Inheritance

Object
TextRun

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

Property FooterSegment.StyledRun
Method PdfEmbeddedFontFallbackSet.PlanTextRuns
Property PdfKeyValueRow.KeyRuns
Property PdfKeyValueRow.ValueRuns
Property PdfListItem.Runs
Property PdfTableCell.Runs
Method PdfTextFallbackPlan.ToTextRuns
Method PdfTextFallbackPlan.ToTextRuns
Method TextRun.Bolded
Method TextRun.BoldItalic
Method TextRun.BoldUnderlined
Method TextRun.Inline
Method TextRun.Italicized
Method TextRun.LineBreak
Method TextRun.Link
Method TextRun.LinkToBookmark
Method TextRun.Normal
Method TextRun.Strikethrough
Method TextRun.Subscript
Method TextRun.Superscript
Method TextRun.Tab
Method TextRun.Underlined

Accepted by parameters

Method FooterSegment.PageNumber parameter style
Method FooterSegment.RichText parameter run
Method FooterSegment.TotalPages parameter style
Method FooterTextBuilder.CurrentPage parameter style
Method FooterTextBuilder.Run parameter run
Method FooterTextBuilder.TotalPages parameter style
Method HeaderTextBuilder.CurrentPage parameter style
Method HeaderTextBuilder.Run parameter run
Method HeaderTextBuilder.TotalPages parameter style
Method PdfEmbeddedFontFallbackSet.PlanTextRuns parameter styleTemplate
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter runs
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter styleTemplate
Constructor PdfKeyValueRow.PdfKeyValueRow parameter keyRuns
Constructor PdfKeyValueRow.PdfKeyValueRow parameter valueRuns
Method PdfKeyValueRow.Rich parameter keyRuns
Method PdfKeyValueRow.Rich parameter valueRuns
Constructor PdfListItem.PdfListItem parameter runs
Method PdfListItem.Rich parameter runs
Method PdfPageCanvas.Text parameter runs
Method PdfPageCanvas.Text parameter runs
Method PdfPageCanvas.TextBox parameter runs
Method PdfPageCanvas.TextBox parameter runs
Method PdfPageCanvas.TextBox parameter runs
Method PdfParagraphBuilder.Runs parameter runs
Constructor PdfTableCell.PdfTableCell parameter runs
Method PdfTableCell.Merge parameter runs
Method PdfTableCell.RichTextCell parameter runs
Method PdfTableCell.Span parameter runs
Method PdfTableCell.WithCheckBoxes parameter runs
Method PdfTableCell.WithFormFields parameter runs
Method PdfTableCell.WithImages parameter runs
Method PdfTextFallbackPlan.ToTextRuns parameter styleTemplate
Method PdfTextFallbackPlan.ToTextRuns parameter styleTemplate

Constructors

public TextRun(String text, Boolean bold = false, Boolean underline = false, Nullable<PdfColor> color = null, Boolean italic = false, Boolean strike = false, Nullable<Double> fontSize = null, Nullable<PdfStandardFont> font = null, String linkUri = null, String linkContents = null, PdfTextBaseline baseline = Normal, String linkDestinationName = null, PdfTabLeaderStyle tabLeader = None, PdfTabAlignment tabAlignment = Left, Nullable<PdfColor> backgroundColor = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:59

Create a new run with the specified styles.

Parameters

text System.String requiredposition: 0: Run text.
bold System.Boolean = false optionalposition: 1: Whether to render bold.
underline System.Boolean = false optionalposition: 2: Whether to underline.
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3: Run color or null to use defaults.
italic System.Boolean = false optionalposition: 4: Whether to render italic.
strike System.Boolean = false optionalposition: 5: Whether to render strikethrough.
fontSize System.Nullable{System.Double} = null optionalposition: 6: Optional run font size in points.
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 7: Optional standard PDF font for this run.
linkUri System.String = null optionalposition: 8: Optional absolute URI or catalog-base-relative URI for link annotation.
linkContents System.String = null optionalposition: 9: Optional link annotation contents; defaults to the run text when omitted.
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optionalposition: 10: Baseline placement for this run.
linkDestinationName System.String = null optionalposition: 11: Optional named destination for an internal document link annotation.
tabLeader OfficeIMO.Pdf.PdfTabLeaderStyle = None optionalposition: 12: Leader fill to render when the run text is a tab character.
tabAlignment OfficeIMO.Pdf.PdfTabAlignment = Left optionalposition: 13: Alignment to use when the run text is a tab character.
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 14: Optional run background color.
fontFamily System.String = null optionalposition: 15: Optional registered embedded family name. font is used as its fallback.

Methods

public static TextRun Bolded(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:133

Returns: TextRun

Create a bold run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun BoldItalic(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:141

Returns: TextRun

Create a bold and italic run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun BoldUnderlined(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:139

Returns: TextRun

Create a bold and underlined run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun Inline(PdfInlineElement element) #

OfficeIMO.Pdf/Model/TextRun.cs:131

Returns: TextRun

Create a fixed-size inline visual run.

Parameters

element OfficeIMO.Pdf.PdfInlineElement requiredposition: 0

public static TextRun Italicized(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:137

Returns: TextRun

Create an italic run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun LineBreak() #

OfficeIMO.Pdf/Model/TextRun.cs:127

Returns: TextRun

Create an explicit line-break run.

public static TextRun Link(String text, String uri, Nullable<PdfColor> color = null, Boolean underline = true, String contents = null, PdfTextBaseline baseline = Normal, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:160

Returns: TextRun

Create a hyperlink run that points to a URI.

Parameters

text System.String requiredposition: 0: Link text.
uri System.String requiredposition: 1: Absolute URI or catalog-base-relative URI.
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 2: Optional link color.
underline System.Boolean = true optionalposition: 3: Whether to underline the link text.
contents System.String = null optionalposition: 4: Optional link annotation contents.
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optionalposition: 5: Baseline placement for this run.
fontSize System.Nullable{System.Double} = null optionalposition: 6: Optional run font size in points.
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7: Optional run background color.
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 8: Optional standard font family for this run.
fontFamily System.String = null optionalposition: 9: Optional registered embedded family name. font remains its fallback.

public static TextRun LinkToBookmark(String text, String bookmarkName, Nullable<PdfColor> color = null, Boolean underline = true, String contents = null, PdfTextBaseline baseline = Normal, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:175

Returns: TextRun

Create a hyperlink run that points to a document bookmark.

Parameters

text System.String requiredposition: 0: Link text.
bookmarkName System.String requiredposition: 1: Named destination created with String).
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 2: Optional link color.
underline System.Boolean = true optionalposition: 3: Whether to underline the link text.
contents System.String = null optionalposition: 4: Optional link annotation contents.
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optionalposition: 5: Baseline placement for this run.
fontSize System.Nullable{System.Double} = null optionalposition: 6: Optional run font size in points.
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7: Optional run background color.
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 8: Optional standard font family for this run.
fontFamily System.String = null optionalposition: 9: Optional registered embedded family name. font remains its fallback.

public static TextRun Normal(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:125

Returns: TextRun

Create a normal (unstyled) run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun Strikethrough(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:143

Returns: TextRun

Create a strikethrough run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun Subscript(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:147

Returns: TextRun

Create a subscript run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun Superscript(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:145

Returns: TextRun

Create a superscript run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

public static TextRun Tab(PdfTabLeaderStyle leader = None, PdfTabAlignment alignment = Left) #

OfficeIMO.Pdf/Model/TextRun.cs:129

Returns: TextRun

Create an explicit paragraph tab run.

Parameters

leader OfficeIMO.Pdf.PdfTabLeaderStyle = None optionalposition: 0
alignment OfficeIMO.Pdf.PdfTabAlignment = Left optionalposition: 1

public static TextRun Underlined(String text, Nullable<PdfColor> color = null, Nullable<Double> fontSize = null, Nullable<PdfColor> backgroundColor = null, Nullable<PdfStandardFont> font = null, String fontFamily = null)

OfficeIMO.Pdf/Model/TextRun.cs:135

Returns: TextRun

Create an underlined run.

Parameters

text System.String requiredposition: 0
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
fontSize System.Nullable{System.Double} = null optionalposition: 2
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 4
fontFamily System.String = null optionalposition: 5

Inherited Methods

Properties

public String Text { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:8

Text content of this run.

public Boolean Bold { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:10

True when bold style is applied.

public Boolean Underline { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:12

True when underline is applied.

public Boolean Strike { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:14

True when strikethrough is applied.

public Boolean Italic { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:16

True when italic style is applied.

public Nullable<PdfColor> Color { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:18

Run foreground color (if any).

public Nullable<PdfColor> BackgroundColor { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:20

Optional run background color, useful for highlights.

public Nullable<Double> FontSize { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:22

Optional font size for this run. When null, the paragraph font size is used.

public Nullable<PdfStandardFont> Font { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:24

Optional standard PDF font for this run. When null, the paragraph/document font is used.

public String FontFamily { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:26

Optional registered embedded font family for this run. This does not consume a standard-font compatibility slot; Font remains the fallback when the family is unavailable.

public String LinkUri { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:28

Optional hyperlink URI associated with this run.

public String LinkDestinationName { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:30

Optional named destination associated with this run.

public String LinkContents { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:32

Optional hyperlink annotation contents, used by readers as link metadata.

public PdfTextBaseline Baseline { get; } #

OfficeIMO.Pdf/Model/TextRun.cs:34

Baseline placement for this run.