Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfNote

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
Implements
IRtfCloneable
Modifiers sealed

Footnote, endnote, or annotation content in an RTF document.

Inheritance

  • Object
  • RtfNote

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

Accepted by parameters

Constructors

public RtfNote(RtfNoteKind kind) #

Creates a note with the specified kind.

Parameters

kind OfficeIMO.Rtf.RtfNoteKind requiredposition: 0

Methods

public RtfParagraph AddParagraph(String text = null) #
Returns: RtfParagraph

Adds a paragraph to this note.

Parameters

text System.String = null optionalposition: 0
public String ToPlainText() #
Returns: String

Returns note text with paragraphs separated by new lines.

Properties

public RtfNoteKind Kind { get; } #

Note destination kind.

public String Id { get; set; } #

Optional note identifier from annotation metadata.

public String Author { get; set; } #

Optional annotation author.

public Nullable<DateTime> Created { get; set; } #

Optional annotation creation time.

public IReadOnlyList<RtfParagraph> Paragraphs { get; } #

Paragraphs contained by this note.