Class LayoutOptions
Options for laying out a Document<T>.
Inheritance
- Object
- LayoutOptions
Implements
Declaration
public class LayoutOptions : Object
Constructors
LayoutOptions(LayoutOptions)
Declaration
protected LayoutOptions(LayoutOptions original)
Parameters
Type | Name | Description |
---|---|---|
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 |
---|---|---|
PageWidth |
The configured page width. Null for unlimited page width |
|
LayoutMode |
The layout mode |
|
DefaultNesting |
The default indentation level for calls to Nested() |
|
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 |
---|---|
DefaultNesting
The default indentation level for calls to Nested()
Declaration
public int DefaultNesting { get; set; }
Property Value
Type | Description |
---|---|
EqualityContract
Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type | Description |
---|---|
LayoutMode
The layout mode
Declaration
public LayoutMode LayoutMode { get; set; }
Property Value
Type | Description |
---|---|
PageWidth
The configured page width. Null for unlimited page width
Declaration
public PageWidthOptions PageWidth { get; set; }
Property Value
Type | Description |
---|---|
StripTrailingWhitespace
Whether to strip whitespace from the end of each line
Declaration
public bool StripTrailingWhitespace { get; set; }
Property Value
Type | Description |
---|---|
Methods
<Clone>$()
Declaration
public virtual LayoutOptions <Clone>$()
Returns
Type | Description |
---|---|
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 |
---|---|---|
PageWidth |
||
LayoutMode |
||
DefaultNesting |
||
StripTrailingWhitespace |
Equals(LayoutOptions)
Declaration
public virtual bool Equals(LayoutOptions other)
Parameters
Type | Name | Description |
---|---|---|
other |
Returns
Type | Description |
---|---|
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
obj |
Returns
Type | Description |
---|---|
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
PrintMembers(StringBuilder)
Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type | Name | Description |
---|---|---|
builder |
Returns
Type | Description |
---|---|
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
Operators
Equality(LayoutOptions, LayoutOptions)
Declaration
public static bool operator ==(LayoutOptions left, LayoutOptions right)
Parameters
Type | Name | Description |
---|---|---|
left |
||
right |
Returns
Type | Description |
---|---|
Inequality(LayoutOptions, LayoutOptions)
Declaration
public static bool operator !=(LayoutOptions left, LayoutOptions right)
Parameters
Type | Name | Description |
---|---|---|
left |
||
right |
Returns
Type | Description |
---|---|