# YamlReadOptions

Options for YAML adapter behavior.

Class 

`OfficeIMO.Reader.Yaml`

**Namespace**

`OfficeIMO.Reader.Yaml`

**Assembly**

`OfficeIMO.Reader.Yaml`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[YamlReadOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Yaml/YamlReadOptions.cs#L10)

**Modifiers**

sealed

Options for YAML adapter behavior.

## Inheritance

- object
- YamlReadOptions

## Usage

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

### Accepted by parameters 1

- Method [OfficeDocumentReaderBuilderYamlExtensions.AddYamlHandler](/api/reader-yaml/officeimo-reader-yaml-officedocumentreaderbuilderyamlextensions/#method-addyamlhandler-officeimo-reader-officedocumentreaderbuilder-officeimo-reader-yaml-yamlreadoptions-boolean) parameter `yamlOptions`

Filter members 

Show inherited

## Constructors

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

[YamlReadOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Yaml/YamlReadOptions.cs#L10)

## 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 int ChunkRows { get; set; }` [#](#property-chunkrows)

[YamlReadOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Yaml/YamlReadOptions.cs#L10)

Rows per emitted chunk. Each document of a multi-document stream starts a new chunk.

`public bool IncludeMarkdown { get; set; }` [#](#property-includemarkdown)

[YamlReadOptions.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Yaml/YamlReadOptions.cs#L15)

Include markdown table previews in emitted chunks.

`public YamlLoadOptions? LoadOptions { get; set; }` [#](#property-loadoptions)

[YamlReadOptions.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Yaml/YamlReadOptions.cs#L22)

Load settings for the YAML engine: schema, duplicate-key policy and the depth, node, alias-expansion, scalar length and input-size limits. null uses the YamlLoadOptions defaults. ReaderOptions.MaxInputBytes still applies and wins when it is lower.

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