# RtfNote

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

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfNote.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L7)

**Implements**

`IRtfCloneable`

**Modifiers**

sealed

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

## Inheritance

- object
- RtfNote

## Usage

Explore 6 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 4

- Method [RtfDocument.AddNote](/api/rtf/officeimo-rtf-rtfdocument/#method-addnote-officeimo-rtf-rtfnotekind)
- Property [RtfDocument.Notes](/api/rtf/officeimo-rtf-rtfdocument/#property-notes)
- Property [RtfGeneratedText.Note](/api/rtf/officeimo-rtf-rtfgeneratedtext/#property-note)
- Property [RtfRun.Note](/api/rtf/officeimo-rtf-rtfrun/#property-note)

### Accepted by parameters 2

- Method [RtfParagraph.AddNoteReference](/api/rtf/officeimo-rtf-rtfparagraph/#method-addnotereference-officeimo-rtf-rtfnote-string) parameter `note`
- Method [RtfRun.SetNote](/api/rtf/officeimo-rtf-rtfrun/#method-setnote-officeimo-rtf-rtfnote) parameter `note`

Filter members 

Show inherited

## Constructors

`public RtfNote(RtfNoteKind kind)` [#](#constructor-ctor-officeimo-rtf-rtfnotekind)

[RtfNote.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L7)

Creates a note with the specified kind.

Parameters

**kind OfficeIMO.Rtf.RtfNoteKind required**

## Methods

`public RtfParagraph AddParagraph(string? text = null)` [#](#method-addparagraph-string)

[RtfNote.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L31)

Adds a paragraph to this note.

Parameters

**text string? = null optional**

Returns

`RtfParagraph`

`public string ToPlainText()` [#](#method-toplaintext)

[RtfNote.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L42)

Returns note text with paragraphs separated by new lines.

Returns

`string`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public RtfNoteKind Kind { get; }` [#](#property-kind)

[RtfNote.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L15)

Note destination kind.

`public string? Id { get; set; }` [#](#property-id)

[RtfNote.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L18)

Optional note identifier from annotation metadata.

`public string? Author { get; set; }` [#](#property-author)

[RtfNote.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L21)

Optional annotation author.

`public DateTime? Created { get; set; }` [#](#property-created)

[RtfNote.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L24)

Optional annotation creation time.

`public IReadOnlyList<RtfParagraph> Paragraphs { get; }` [#](#property-paragraphs)

[RtfNote.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfNote.cs#L27)

Paragraphs contained by this note.

<!-- PowerForge markdown artifact sha256:218523DAB2432D99323D1C4735928DA31756B9556B289B68FB84CB0082A39810 -->
