Class PageWidthOptions
Information about the available width for layout
Inheritance
- object
- PageWidthOptions
Implements
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
Declaration
public record PageWidthOptions : IEquatable<PageWidthOptions>Constructors
PageWidthOptions(PageWidthOptions)
Information about the available width for layout
Declaration
protected PageWidthOptions(PageWidthOptions original)Parameters
| Type | Name | Description |
|---|---|---|
original |
PageWidthOptions(int, double)
Information about the available width for layout
Declaration
public PageWidthOptions(int PageWidth = 80, double PrintableRatio = 1)Parameters
| Type | Name | Description |
|---|---|---|
PageWidth |
The total width of the page in characters |
|
PrintableRatio |
The percentage of the total page width that can have printed (non-indentation) characters on it. Also known as the ribbon width. |
Properties
EqualityContract
Information about the available width for layout
Declaration
protected virtual Type EqualityContract { get; }Property Value
| Type | Description |
|---|---|
PageWidth
The total width of the page in characters
Declaration
public int PageWidth { get; init; }Property Value
| Type | Description |
|---|---|
PrintableRatio
The percentage of the total page width that can have printed (non-indentation) characters on it. Also known as the ribbon width.
Declaration
public double PrintableRatio { get; init; }Property Value
| Type | Description |
|---|---|
Methods
Deconstruct(out int, out double)
Information about the available width for layout
Declaration
public void Deconstruct(out int PageWidth, out double PrintableRatio)Parameters
| Type | Name | Description |
|---|---|---|
PageWidth |
||
PrintableRatio |
Equals(PageWidthOptions?)
Information about the available width for layout
Declaration
public virtual bool Equals(PageWidthOptions? other)Parameters
| Type | Name | Description |
|---|---|---|
other |
Returns
| Type | Description |
|---|---|
Equals(object?)
Information about the available width for layout
Declaration
public override bool Equals(object? obj)Parameters
| Type | Name | Description |
|---|---|---|
obj |
Returns
| Type | Description |
|---|---|
Overrides
GetHashCode()
Information about the available width for layout
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
Overrides
PrintMembers(StringBuilder)
Information about the available width for layout
Declaration
protected virtual bool PrintMembers(StringBuilder builder)Parameters
| Type | Name | Description |
|---|---|---|
builder |
Returns
| Type | Description |
|---|---|
ToString()
Information about the available width for layout
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
Overrides
<Clone>$()
Information about the available width for layout
Declaration
public virtual PageWidthOptions <Clone>$()Returns
| Type | Description |
|---|---|
Operators
operator ==(PageWidthOptions?, PageWidthOptions?)
Information about the available width for layout
Declaration
public static bool operator ==(PageWidthOptions? left, PageWidthOptions? right)Parameters
| Type | Name | Description |
|---|---|---|
left |
||
right |
Returns
| Type | Description |
|---|---|
operator !=(PageWidthOptions?, PageWidthOptions?)
Information about the available width for layout
Declaration
public static bool operator !=(PageWidthOptions? left, PageWidthOptions? right)Parameters
| Type | Name | Description |
|---|---|---|
left |
||
right |
Returns
| Type | Description |
|---|---|