Open sandboxFocus

Class HtmlCodeWriterOptions

Options influencing the HTML writing behavior of the test framework.

Inheritance
HtmlCodeWriterOptions
Namespace: Metalama.Framework.Engine.Formatting
Assembly: Metalama.Framework.Sdk.dll
Syntax
public sealed record HtmlCodeWriterOptions : IEquatable<HtmlCodeWriterOptions>

Constructors

Name Description
HtmlCodeWriterOptions(string, string, bool, string?, string?)

Options influencing the HTML writing behavior of the test framework.

Properties

Name Description
AddSymbols

Gets a value indicating whether to add, to each identifier, the documentation comment id of the symbol it declares (data-def attribute) or references (data-ref attribute), and to each overriding member the id of the overridden member (data-overrides attribute). Locals, parameters, type parameters and local functions have no documentation id, so their identifiers get a key that is unique in the document (data-local-def and data-local-ref attributes).

AddTitles

Whether to add titles to HTML elements.

Epilogue

Optional HTML epilogue content.

ProjectPath

The path to the project file. Required by WriteAllDiffAsync(IPartialCompilation, IPartialCompilation, HtmlCodeWriterOptions, IEnumerable<Diagnostic>?, Func<Diagnostic, Compilation, bool>?, CancellationToken).

Prolog

Optional HTML prolog content.

TargetFramework

The target framework. Required by WriteAllDiffAsync(IPartialCompilation, IPartialCompilation, HtmlCodeWriterOptions, IEnumerable<Diagnostic>?, Func<Diagnostic, Compilation, bool>?, CancellationToken).

Methods

Name Description
Deconstruct(out string, out string, out bool, out string?, out string?)
Equals(HtmlCodeWriterOptions?)
Equals(object?)
GetHashCode()
ToString()

Operators

Name Description
operator ==(HtmlCodeWriterOptions?, HtmlCodeWriterOptions?)
operator !=(HtmlCodeWriterOptions?, HtmlCodeWriterOptions?)

Extension Methods