# ReaderRtfOptions

Options for RTF ingestion through the OfficeIMO.Reader adapter.

Class 

`OfficeIMO.Reader.Rtf`

**Namespace**

`OfficeIMO.Reader.Rtf`

**Assembly**

`OfficeIMO.Reader.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ReaderRtfOptions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L23)

**Modifiers**

sealed

Options for RTF ingestion through the OfficeIMO.Reader adapter.

## Inheritance

- object
- ReaderRtfOptions

## Usage

Explore 5 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 3

- Method [ReaderRtfOptions.Clone](/api/reader-rtf/officeimo-reader-rtf-readerrtfoptions/#method-clone)
- Method [ReaderRtfOptions.CreateOfficeIMOProfile](/api/reader-rtf/officeimo-reader-rtf-readerrtfoptions/#method-createofficeimoprofile)
- Method [ReaderRtfOptions.CreateTrustedProfile](/api/reader-rtf/officeimo-reader-rtf-readerrtfoptions/#method-createtrustedprofile)

### Accepted by parameters 2

- Method [OfficeDocumentReaderBuilderRtfExtensions.AddRtfHandler](/api/reader-rtf/officeimo-reader-rtf-officedocumentreaderbuilderrtfextensions/#method-addrtfhandler-officeimo-reader-officedocumentreaderbuilder-officeimo-reader-rtf-readerrtfoptions-boolean) parameter `rtfOptions`
- Method [RtfReadResultReaderExtensions.ReadDocument](/api/reader-rtf/officeimo-reader-rtf-rtfreadresultreaderextensions/#method-readdocument-officeimo-rtf-rtfreadresult-string-officeimo-reader-readeroptions-officeimo-reader-rtf-readerrtfoptions-threading-cancellationtoken) parameter `formatOptions`

Filter members 

Show inherited

## Constructors

`public ReaderRtfOptions()` [#](#constructor-ctor)

[ReaderRtfOptions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L23)

Creates bounded Reader RTF options.

## Methods

`public ReaderRtfOptions Clone()` [#](#method-clone)

[ReaderRtfOptions.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L61)

Creates a defensive copy for handler registration reuse.

Returns

`ReaderRtfOptions`

`public static ReaderRtfOptions CreateOfficeIMOProfile()` [#](#method-createofficeimoprofile)

[ReaderRtfOptions.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L13)

Creates the default RTF reader profile.

Returns

`ReaderRtfOptions`

`public static ReaderRtfOptions CreateTrustedProfile()` [#](#method-createtrustedprofile)

[ReaderRtfOptions.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L16)

Creates an explicitly trusted compatibility profile without core resource ceilings.

Returns

`ReaderRtfOptions`

## 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 RtfLoadOptions? RtfLoadOptions { get; set; }` [#](#property-rtfloadoptions)

[ReaderRtfOptions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L23)

Options passed to the shared RTF parser and semantic binder.

`public bool ChunkByBlock { get; set; }` [#](#property-chunkbyblock)

[ReaderRtfOptions.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L28)

When true, emits one or more chunks per top-level RTF block. Default: true.

`public bool IncludeHeadersAndFooters { get; set; }` [#](#property-includeheadersandfooters)

[ReaderRtfOptions.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L33)

When true, includes parsed header and footer text after body blocks.

`public bool IncludeNotes { get; set; }` [#](#property-includenotes)

[ReaderRtfOptions.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L38)

When true, includes detached note text after body blocks.

`public bool IncludeImagePlaceholders { get; set; }` [#](#property-includeimageplaceholders)

[ReaderRtfOptions.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L43)

When true, emits deterministic placeholders for images that appear as top-level blocks.

`public bool IncludeDiagnostics { get; set; }` [#](#property-includediagnostics)

[ReaderRtfOptions.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L48)

When true, maps RTF parser and binder diagnostics into chunk warnings.

`public bool IncludePageLocations { get; set; }` [#](#property-includepagelocations)

[ReaderRtfOptions.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Rtf/ReaderRtfOptions.cs#L54)

When true, reconstructs page membership from explicit page and section breaks. Automatic text overflow is not calculated. Default: false.

<!-- PowerForge markdown artifact sha256:FEA24F8C393E8EAD82B73DBBC0AE9D16EC0072EDAF50D384ED32463257AEC993 -->
