Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfGeneratedText

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Implements
IRtfCloneable IRtfInline
Modifiers
sealed

Dynamic text generated by an RTF reader or renderer, such as page number or current date.

Inheritance

  • object
  • RtfGeneratedText

Usage

Explore 8 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.

Constructors

public RtfGeneratedText(RtfGeneratedTextKind kind, string? fallbackText = null) #

Creates a generated text marker.

Parameters

kind OfficeIMO.Rtf.RtfGeneratedTextKind required
fallbackText string? = null optional

Methods

public string ToPlainText() #

Returns the optional fallback text, or an empty string when the value must be generated by a renderer.

Returns

string

Properties

public RtfGeneratedTextKind Kind { get; set; } #

Kind of generated text represented by this marker.

public string? FallbackText { get; set; } #

Optional text used by semantic conversions that cannot evaluate the generated value.

public RtfNote? Note { get; set; } #

Optional note attached to this generated marker, such as an automatic footnote reference.