Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfGeneratedText

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
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

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 requiredposition: 0
fallbackText System.String = null optionalposition: 1

Methods

public String ToPlainText() #
Returns: String

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

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.