Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Formatting Namespace / IValueFormatter Interface / Format Method
The value to format into a human-readable representation
An object to write the textual representation to.
Contains additional information that the implementation should take into account.
Allows the formatter to recursively format any child objects.
In This Topic
    Format Method (IValueFormatter)
    In This Topic
    Returns a human-readable representation of value.
    Syntax
    void Format( 
   object value,
   FormattedObjectGraph formattedGraph,
   FormattingContext context,
   FormatChild formatChild
)

    Parameters

    value
    The value to format into a human-readable representation
    formattedGraph
    An object to write the textual representation to.
    context
    Contains additional information that the implementation should take into account.
    formatChild
    Allows the formatter to recursively format any child objects.
    Remarks
    DO NOT CALL Formatter.ToString directly, but use formatChild instead. This will ensure cyclic dependencies are properly detected. Also, the FormattedObjectGraph may throw an MaxLinesExceededException that must be ignored by implementations of this interface.
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    IValueFormatter Interface
    IValueFormatter Members
    ToString(Object,FormattingOptions) Method
    FormattedObjectGraph Class
    MaxLinesExceededException Class

    Send Feedback