API Reference

Class

PdfTextRun

Edit on GitHub

Namespace OfficeIMO.Pdf

Assembly OfficeIMO.Pdf

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

Modifiers sealed

Inline text segment with basic styling.

Inheritance

Object
PdfTextRun

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
Method PdfEmbeddedFontFallbackSet.PlanTextRuns
Property PdfKeyValueRow.KeyRuns
Property PdfKeyValueRow.ValueRuns
Property PdfListItem.Runs
Property PdfTableCell.Runs
Method PdfTextFallbackPlan.ToNamedTextRuns
Method PdfTextFallbackPlan.ToTextRuns
Method PdfTextFallbackPlan.ToTextRuns
Method PdfTextRun.Bolded
Method PdfTextRun.BoldItalic
Method PdfTextRun.BoldUnderlined
Method PdfTextRun.Inline
Method PdfTextRun.Italicized
Method PdfTextRun.LineBreak
Method PdfTextRun.Link
Method PdfTextRun.LinkToBookmark
Method PdfTextRun.Normal
Method PdfTextRun.Strikethrough
Method PdfTextRun.Subscript
Method PdfTextRun.Superscript
Method PdfTextRun.Tab
Method PdfTextRun.Tab
Method PdfTextRun.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.PlanTextRuns parameter styleTemplate
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter runs
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter runs
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter styleTemplate
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.ToNamedTextRuns parameter styleTemplate
Method PdfTextFallbackPlan.ToTextRuns parameter styleTemplate
Method PdfTextFallbackPlan.ToTextRuns parameter styleTemplate

Constructors

PdfTextRun 2 overloads

public PdfTextRun(String text, Boolean bold, Boolean underline, Nullable<PdfColor> color, Boolean italic, Boolean strike, Nullable<Double> fontSize, Nullable<PdfStandardFont> font, String linkUri, String linkContents, PdfTextBaseline baseline, String linkDestinationName, PdfTabLeaderStyle tabLeader, Nullable<PdfColor> backgroundColor, String fontFamily)

OfficeIMO.Pdf/Model/PdfTextRun.cs:59

Create a new run with the specified styles.

Parameters

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

public PdfTextRun(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/PdfTextRun.cs:63

Create a new run with the specified styles and tab alignment.

Parameters

text System.String requiredposition: 0
bold System.Boolean = false optionalposition: 1
underline System.Boolean = false optionalposition: 2
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
italic System.Boolean = false optionalposition: 4
strike System.Boolean = false optionalposition: 5
fontSize System.Nullable{System.Double} = null optionalposition: 6
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 7
linkUri System.String = null optionalposition: 8
linkContents System.String = null optionalposition: 9
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optionalposition: 10
linkDestinationName System.String = null optionalposition: 11
tabLeader OfficeIMO.Pdf.PdfTabLeaderStyle = None optionalposition: 12
tabAlignment OfficeIMO.Pdf.PdfTabAlignment = Left optionalposition: 13
backgroundColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 14
fontFamily System.String = null optionalposition: 15

Methods

public static PdfTextRun 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/PdfTextRun.cs:139

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:147

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:145

Returns: PdfTextRun

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 PdfTextRun Inline(PdfInlineElement element) #

OfficeIMO.Pdf/Model/PdfTextRun.cs:137

Returns: PdfTextRun

Create a fixed-size inline visual run.

Parameters

element OfficeIMO.Pdf.PdfInlineElement requiredposition: 0

public static PdfTextRun 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/PdfTextRun.cs:143

Returns: PdfTextRun

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 PdfTextRun LineBreak() #

OfficeIMO.Pdf/Model/PdfTextRun.cs:131

Returns: PdfTextRun

Create an explicit line-break run.

public static PdfTextRun 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/PdfTextRun.cs:166

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:181

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:129

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:149

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:153

Returns: PdfTextRun

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 PdfTextRun 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/PdfTextRun.cs:151

Returns: PdfTextRun

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

Tab 2 overloads

public static PdfTextRun Tab(PdfTabLeaderStyle leader) #

OfficeIMO.Pdf/Model/PdfTextRun.cs:133

Returns: PdfTextRun

Create an explicit paragraph tab run.

Parameters

leader OfficeIMO.Pdf.PdfTabLeaderStyle requiredposition: 0

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

OfficeIMO.Pdf/Model/PdfTextRun.cs:135

Returns: PdfTextRun

Create an explicit paragraph tab run with alignment.

Parameters

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

public static PdfTextRun 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/PdfTextRun.cs:141

Returns: PdfTextRun

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/PdfTextRun.cs:8

Text content of this run.

public Boolean Bold { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:10

True when bold style is applied.

public Boolean Underline { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:12

True when underline is applied.

public Boolean Strike { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:14

True when strikethrough is applied.

public Boolean Italic { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:16

True when italic style is applied.

public Nullable<PdfColor> Color { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:18

Run foreground color (if any).

public Nullable<PdfColor> BackgroundColor { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:20

Optional run background color, useful for highlights.

public Nullable<Double> FontSize { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:22

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

public Nullable<PdfStandardFont> Font { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:24

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

public String FontFamily { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.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/PdfTextRun.cs:28

Optional hyperlink URI associated with this run.

public String LinkDestinationName { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:30

Optional named destination associated with this run.

public String LinkContents { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:32

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

public PdfTextBaseline Baseline { get; } #

OfficeIMO.Pdf/Model/PdfTextRun.cs:34

Baseline placement for this run.