Class

PdfTextRun

OfficeIMO.Pdf

Edit on GitHub

Namespace: OfficeIMO.Pdf
Assembly: OfficeIMO.Pdf
Source revision: ac7e6e1bad8a with working tree changes
Source: PdfTextRun.cs:140
Modifiers: sealed

Inline text segment with basic styling.

Inheritance

object
PdfTextRun

Usage

Explore 83 API references to this type

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

Returned or exposed by 50

Method PdfEmbeddedFontFallbackSet.PlanTextRuns
Property PdfFooterSegment.StyledRun
Property PdfKeyValueRow.KeyRuns
Property PdfKeyValueRow.ValueRuns
Property PdfListItem.Runs
Method PdfParagraph.AddBookmarkLink
Method PdfParagraph.AddInline
Method PdfParagraph.AddInlineBox
Method PdfParagraph.AddInlineImage
Method PdfParagraph.AddLineBreak
Method PdfParagraph.AddLink
Method PdfParagraph.AddTab
Method PdfParagraph.AddText
Property PdfParagraph.Runs
Property PdfTableCell.Runs
Method PdfTextFallbackPlan.ToNamedTextRuns
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.SetBackgroundColor
Method PdfTextRun.SetBaseline
Method PdfTextRun.SetBold
Method PdfTextRun.SetCharacterSpacing
Method PdfTextRun.SetColor
Method PdfTextRun.SetFontFamily
Method PdfTextRun.SetFontSize
Method PdfTextRun.SetHorizontalTextScaling
Method PdfTextRun.SetItalic
Method PdfTextRun.SetStandardFont
Method PdfTextRun.SetStrikethrough
Method PdfTextRun.SetSubscript
Method PdfTextRun.SetSuperscript
Method PdfTextRun.SetUnderline
Method PdfTextRun.Strikethrough
Method PdfTextRun.Subscript
Method PdfTextRun.Superscript
Method PdfTextRun.Tab
Method PdfTextRun.Underlined
Method PdfTextRun.WithCharacterSpacing
Method PdfTextRun.WithFeatureSettings
Method PdfTextRun.WithFootnoteReference
Method PdfTextRun.WithHorizontalTextScaling
Method PdfTextRun.WithTextCase

Accepted by parameters 33

Method PdfEmbeddedFontFallbackSet.PlanTextRuns parameter styleTemplate
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter runs
Method PdfEmbeddedFontFallbackSet.TryPlanTextRuns parameter styleTemplate
Method PdfFooterSegment.DocumentPages parameter style
Method PdfFooterSegment.PageNumber parameter style
Method PdfFooterSegment.RichText parameter run
Method PdfFooterSegment.TotalPages parameter style
Method PdfFooterTextBuilder.CurrentPage parameter style
Method PdfFooterTextBuilder.DocumentPages parameter style
Method PdfFooterTextBuilder.Run parameter run
Method PdfFooterTextBuilder.TotalPages parameter style
Method PdfHeaderTextBuilder.CurrentPage parameter style
Method PdfHeaderTextBuilder.DocumentPages parameter style
Method PdfHeaderTextBuilder.Run parameter run
Method PdfHeaderTextBuilder.TotalPages parameter style
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.TextBox parameter runs
Method PdfParagraph.AddRuns 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

Constructors

public PdfTextRun(string text, bool bold = false, bool underline = false, OfficeColor? color = null, bool italic = false, bool strike = false, OfficeLength? fontSize = null, PdfStandardFont? standardFont = null, string? linkUri = null, string? linkContents = null, PdfTextBaseline baseline = Normal, string? linkDestinationName = null, PdfTabLeaderStyle tabLeader = None, PdfTabAlignment tabAlignment = Left, OfficeColor? backgroundColor = null, string? fontFamily = null, OfficeTextDecorationStyle underlineStyle = None, OfficeTextDecorationStyle strikeStyle = None, OfficeColor? decorationColor = null)

PdfTextRun.LineMetrics.cs:6

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

Parameters

text string required
bold bool = false optional
underline bool = false optional
color OfficeIMO.OfficeColor? = null optional
italic bool = false optional
strike bool = false optional
fontSize OfficeIMO.OfficeLength? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
linkUri string? = null optional
linkContents string? = null optional
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optional
linkDestinationName string? = null optional
tabLeader OfficeIMO.Pdf.PdfTabLeaderStyle = None optional
tabAlignment OfficeIMO.Pdf.PdfTabAlignment = Left optional
backgroundColor OfficeIMO.OfficeColor? = null optional
fontFamily string? = null optional
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional
strikeStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional
decorationColor OfficeIMO.OfficeColor? = null optional

Methods

public static PdfTextRun Bolded(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:148

Create a bold run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun BoldItalic(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:156

Create a bold and italic run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun BoldUnderlined(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:154

Create a bold and underlined run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun Inline(PdfInlineElement element) #

PdfTextRun.cs:146

Create an inline visual run.

Parameters

element OfficeIMO.Pdf.PdfInlineElement required

Returns

PdfTextRun

public static PdfTextRun Italicized(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:152

Create an italic run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun LineBreak() #

PdfTextRun.cs:142

Create an explicit line-break run.

Returns

PdfTextRun

public static PdfTextRun Link(string text, string uri, OfficeColor? color = null, bool underline = true, string? contents = null, PdfTextBaseline baseline = Normal, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null, OfficeTextDecorationStyle underlineStyle = None, OfficeTextDecorationStyle strikeStyle = None)

PdfTextRun.cs:238

Create a hyperlink run with native decoration styles.

Parameters

text string required: Link text.
uri string required: Absolute URI or catalog-base-relative URI.
color OfficeIMO.OfficeColor? = null optional: Optional link color.
underline bool = true optional: Whether to underline the link text.
contents string? = null optional: Optional link annotation contents.
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optional: Baseline placement for this run.
fontSize OfficeIMO.OfficeLength? = null optional: Optional physical run font size.
backgroundColor OfficeIMO.OfficeColor? = null optional: Optional run background color.
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional: Optional standard font for this run.
fontFamily string? = null optional: Optional registered embedded family name. standardFont remains its fallback.
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional: Optional underline pattern.
strikeStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional: Optional strikethrough pattern.

Returns

PdfTextRun

public static PdfTextRun LinkToBookmark(string text, string bookmarkName, OfficeColor? color = null, bool underline = true, string? contents = null, PdfTextBaseline baseline = Normal, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null, OfficeTextDecorationStyle underlineStyle = None, OfficeTextDecorationStyle strikeStyle = None)

PdfTextRun.cs:255

Create a hyperlink run that points to a document bookmark with native decoration styles.

Parameters

text string required: Link text.
bookmarkName string required: Named destination created with PdfDocument.Bookmark.
color OfficeIMO.OfficeColor? = null optional: Optional link color.
underline bool = true optional: Whether to underline the link text.
contents string? = null optional: Optional link annotation contents.
baseline OfficeIMO.Pdf.PdfTextBaseline = Normal optional: Baseline placement for this run.
fontSize OfficeIMO.OfficeLength? = null optional: Optional physical run font size.
backgroundColor OfficeIMO.OfficeColor? = null optional: Optional run background color.
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional: Optional standard font for this run.
fontFamily string? = null optional: Optional registered embedded family name. standardFont remains its fallback.
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional: Optional underline pattern.
strikeStyle OfficeIMO.Drawing.OfficeTextDecorationStyle = None optional: Optional strikethrough pattern.

Returns

PdfTextRun

public static PdfTextRun Normal(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:140

Create a normal (unstyled) run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public PdfTextRun SetBackgroundColor(OfficeColor color) #

PdfTextRun.Formatting.cs:27

Sets the background (highlight) colour of this run.

Parameters

color OfficeIMO.OfficeColor required

Returns

PdfTextRun

public PdfTextRun SetBaseline(PdfTextBaseline baseline) #

PdfTextRun.Formatting.cs:43

Sets the baseline placement of this run.

Parameters

baseline OfficeIMO.Pdf.PdfTextBaseline required

Returns

PdfTextRun

public PdfTextRun SetBold(bool bold = true) #

PdfTextRun.Formatting.cs:6

Makes this run bold or regular weight.

Parameters

bold bool = true optional

Returns

PdfTextRun

public PdfTextRun SetCharacterSpacing(OfficeLength spacing) #

PdfTextRun.Formatting.cs:60

Sets the additional advance after each glyph of this text run. Zero is normal spacing.

Parameters

spacing OfficeIMO.OfficeLength required

Returns

PdfTextRun

public PdfTextRun SetColor(OfficeColor color) #

PdfTextRun.Formatting.cs:24

Sets the foreground colour of this run.

Parameters

color OfficeIMO.OfficeColor required

Returns

PdfTextRun

public PdfTextRun SetFontFamily(string fontFamily) #

PdfTextRun.Formatting.cs:33

Sets the registered embedded font family of this run. PdfTextRun.StandardFont remains its fallback.

Parameters

fontFamily string required

Returns

PdfTextRun

public PdfTextRun SetFontSize(OfficeLength fontSize) #

PdfTextRun.Formatting.cs:30

Sets the font size of this run.

Parameters

fontSize OfficeIMO.OfficeLength required

Returns

PdfTextRun

public PdfTextRun SetHorizontalTextScaling(double percentage) #

PdfTextRun.Formatting.cs:53

Sets the horizontal glyph width percentage of this text run. 100 is normal width.

Parameters

percentage double required

Returns

PdfTextRun

public PdfTextRun SetItalic(bool italic = true) #

PdfTextRun.Formatting.cs:9

Makes this run italic or upright.

Parameters

italic bool = true optional

Returns

PdfTextRun

public PdfTextRun SetStandardFont(PdfStandardFont standardFont) #

PdfTextRun.Formatting.cs:37

Sets the standard PDF font of this run.

Parameters

standardFont OfficeIMO.Pdf.PdfStandardFont required

Returns

PdfTextRun

SetStrikethrough 2 overloads

public PdfTextRun SetStrikethrough(bool strikethrough = true) #

PdfTextRun.Formatting.cs:18

Adds a single strikethrough to this run, or removes its strikethrough.

Parameters

strikethrough bool = true optional

Returns

PdfTextRun

public PdfTextRun SetStrikethrough(OfficeTextDecorationStyle style) #

PdfTextRun.Formatting.cs:21

Sets the strikethrough pattern of this run. OfficeTextDecorationStyle.None removes it.

Parameters

style OfficeIMO.Drawing.OfficeTextDecorationStyle required

Returns

PdfTextRun

public PdfTextRun SetSubscript() #

PdfTextRun.Formatting.cs:49

Lowers this run to subscript.

Returns

PdfTextRun

public PdfTextRun SetSuperscript() #

PdfTextRun.Formatting.cs:46

Raises this run to superscript.

Returns

PdfTextRun

SetUnderline 2 overloads

public PdfTextRun SetUnderline(bool underline = true) #

PdfTextRun.Formatting.cs:12

Adds a single underline to this run, or removes its underline.

Parameters

underline bool = true optional

Returns

PdfTextRun

public PdfTextRun SetUnderline(OfficeTextDecorationStyle style) #

PdfTextRun.Formatting.cs:15

Sets the underline pattern of this run. OfficeTextDecorationStyle.None removes it.

Parameters

style OfficeIMO.Drawing.OfficeTextDecorationStyle required

Returns

PdfTextRun

public static PdfTextRun Strikethrough(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:158

Create a strikethrough run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun Subscript(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:162

Create a subscript run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public static PdfTextRun Superscript(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:160

Create a superscript run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

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

PdfTextRun.cs:144

Create an explicit paragraph tab run with alignment.

Parameters

leader OfficeIMO.Pdf.PdfTabLeaderStyle = None optional
alignment OfficeIMO.Pdf.PdfTabAlignment = Left optional

Returns

PdfTextRun

public static PdfTextRun Underlined(string text, OfficeColor? color = null, OfficeLength? fontSize = null, OfficeColor? backgroundColor = null, PdfStandardFont? standardFont = null, string? fontFamily = null)

PdfTextRun.cs:150

Create an underlined run.

Parameters

text string required
color OfficeIMO.OfficeColor? = null optional
fontSize OfficeIMO.OfficeLength? = null optional
backgroundColor OfficeIMO.OfficeColor? = null optional
standardFont OfficeIMO.Pdf.PdfStandardFont? = null optional
fontFamily string? = null optional

Returns

PdfTextRun

public PdfTextRun WithCharacterSpacing(OfficeLength spacing) #

PdfTextRun.Spacing.cs:23

Creates a copy with additional advance after each rendered glyph, as a physical length.

Parameters

spacing OfficeIMO.OfficeLength required: Finite positive or negative spacing. Negative values condense the glyph advances.

Returns

PdfTextRun

public PdfTextRun WithFeatureSettings(OfficeTextFeatureSettings featureSettings) #

PdfTextRun.cs:173

Creates a copy with explicit OpenType feature selections.

Parameters

featureSettings OfficeIMO.Drawing.OfficeTextFeatureSettings required

Returns

PdfTextRun

public PdfTextRun WithFootnoteReference(PdfFootnoteDefinition definition) #

PdfTextRun.Footnotes.cs:10

Creates a copy associated with a footnote while retaining text, typography, spacing, and links.

Parameters

definition OfficeIMO.Pdf.PdfFootnoteDefinition required

Returns

PdfTextRun

public PdfTextRun WithHorizontalTextScaling(double percentage) #

PdfTextRun.Spacing.cs:13

Creates a copy with a positive horizontal glyph width percentage, preserving font height and other formatting.

Parameters

percentage double required

Returns

PdfTextRun

public PdfTextRun WithTextCase(OfficeTextCase textCase, CultureInfo? culture = null) #

PdfTextRun.cs:165

Create a copy with transformed text casing while preserving all run formatting and link metadata.

Parameters

textCase OfficeIMO.Drawing.OfficeTextCase required
culture System.Globalization.CultureInfo? = null optional

Returns

PdfTextRun

Inherited Methods

Properties

public string Text { get; } #

PdfTextRun.cs:8

Text content of this run.

public bool Bold { get; private set; } #

PdfTextRun.cs:10

True when bold style is applied.

public bool Underline { get; } #

PdfTextRun.cs:12

True when underline is applied.

public OfficeTextDecorationStyle UnderlineStyle { get; private set; } #

PdfTextRun.cs:14

Underline pattern rendered by the PDF writer.

public bool Strike { get; } #

PdfTextRun.cs:16

True when strikethrough is applied.

public OfficeTextDecorationStyle StrikeStyle { get; private set; } #

PdfTextRun.cs:18

Strikethrough pattern rendered by the PDF writer.

public OfficeColor? DecorationColor { get; } #

PdfTextRun.cs:20

Optional underline and strikethrough color. Null uses the run foreground color.

public bool Italic { get; private set; } #

PdfTextRun.cs:22

True when italic style is applied.

public OfficeColor? Color { get; private set; } #

PdfTextRun.cs:24

Run foreground color (if any).

public OfficeColor? BackgroundColor { get; private set; } #

PdfTextRun.cs:26

Optional run background color, useful for highlights.

public OfficeLength? FontSize { get; private set; } #

PdfTextRun.cs:28

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

public PdfStandardFont? StandardFont { get; private set; } #

PdfTextRun.cs:30

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

public string? FontFamily { get; private set; } #

PdfTextRun.cs:32

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

public string? LinkUri { get; } #

PdfTextRun.cs:34

Optional hyperlink URI associated with this run.

public string? LinkDestinationName { get; } #

PdfTextRun.cs:36

Optional named destination associated with this run.

public string? LinkContents { get; } #

PdfTextRun.cs:38

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

public PdfTextBaseline Baseline { get; private set; } #

PdfTextRun.cs:40

Baseline placement for this run.