Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

YamlFormatOptions

OfficeIMO.Yaml

Namespace
OfficeIMO.Yaml
Assembly
OfficeIMO.Yaml
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Layout settings for YamlFormatter. Every setting left at its default follows the document's own conventions, so formatting with default options only removes inconsistencies.

Inheritance

  • object
  • YamlFormatOptions

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

Constructors

public YamlFormatOptions() #

Properties

public int? IndentWidth { get; set; } #

Gets or sets how far nested mapping keys are indented from their parent key, or null (the default) for the width the document uses. 1 to 9.

public YamlSequenceIndentation SequenceIndentation { get; set; } #

Gets or sets how sequences under a key are indented. Defaults to YamlSequenceIndentation.Preserve.

public YamlQuoteStyle Quotes { get; set; } #

Gets or sets the quotes of quoted strings. Defaults to YamlQuoteStyle.Preserve. Plain scalars stay plain, and strings that would read as another type stay quoted.

public YamlLineEnding LineEnding { get; set; } #

Gets or sets the line break. Defaults to YamlLineEnding.Preserve.

public bool FinalNewline { get; set; } #

Gets or sets whether the text ends with a line break. Defaults to true. With false the final break is left out unless a block scalar at the end needs it for its value.