Gutenberg

Class LayoutOptions

Options for laying out a Document<T>.

Inheritance
Implements
Declaration
public class LayoutOptions : Object

Constructors

LayoutOptions(LayoutOptions)

Declaration
protected LayoutOptions(LayoutOptions original)
Parameters
Type Name Description

LayoutOptions

original

LayoutOptions(PageWidthOptions, LayoutMode, Int32, Boolean)

Options for laying out a Document<T>.

Declaration
public LayoutOptions(PageWidthOptions PageWidth, LayoutMode LayoutMode, int DefaultNesting, bool StripTrailingWhitespace)
Parameters
Type Name Description

PageWidthOptions

PageWidth

The configured page width. Null for unlimited page width

LayoutMode

LayoutMode

The layout mode

Int32

DefaultNesting

The default indentation level for calls to Nested()

Boolean

StripTrailingWhitespace

Whether to strip whitespace from the end of each line

Properties

Default

The default LayoutOptions.

Declaration
public static LayoutOptions Default { get; }
Property Value
Type Description

LayoutOptions

DefaultNesting

The default indentation level for calls to Nested()

Declaration
public int DefaultNesting { get; set; }
Property Value
Type Description

Int32

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description

Type

LayoutMode

The layout mode

Declaration
public LayoutMode LayoutMode { get; set; }
Property Value
Type Description

LayoutMode

PageWidth

The configured page width. Null for unlimited page width

Declaration
public PageWidthOptions PageWidth { get; set; }
Property Value
Type Description

PageWidthOptions

StripTrailingWhitespace

Whether to strip whitespace from the end of each line

Declaration
public bool StripTrailingWhitespace { get; set; }
Property Value
Type Description

Boolean

Methods

<Clone>$()

Declaration
public virtual LayoutOptions <Clone>$()
Returns
Type Description

LayoutOptions

Deconstruct(out PageWidthOptions, out LayoutMode, out Int32, out Boolean)

Declaration
public void Deconstruct(out PageWidthOptions PageWidth, out LayoutMode LayoutMode, out int DefaultNesting, out bool StripTrailingWhitespace)
Parameters
Type Name Description

PageWidthOptions

PageWidth

LayoutMode

LayoutMode

Int32

DefaultNesting

Boolean

StripTrailingWhitespace

Equals(LayoutOptions)

Declaration
public virtual bool Equals(LayoutOptions other)
Parameters
Type Name Description

LayoutOptions

other

Returns
Type Description

Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description

Object

obj

Returns
Type Description

Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description

Int32

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description

StringBuilder

builder

Returns
Type Description

Boolean

ToString()

Declaration
public override string ToString()
Returns
Type Description

String

Operators

Equality(LayoutOptions, LayoutOptions)

Declaration
public static bool operator ==(LayoutOptions left, LayoutOptions right)
Parameters
Type Name Description

LayoutOptions

left

LayoutOptions

right

Returns
Type Description

Boolean

Inequality(LayoutOptions, LayoutOptions)

Declaration
public static bool operator !=(LayoutOptions left, LayoutOptions right)
Parameters
Type Name Description

LayoutOptions

left

LayoutOptions

right

Returns
Type Description

Boolean

Implements

System.IEquatable<T>