SimpleLayout Class

Represents a string with embedded placeholders that can render contextual information.

Inheritance Hierarchy

SystemObject
NLog.LayoutsLayout
NLog.LayoutsSimpleLayout

Namespace: NLog.Layouts
Assembly: NLog (in NLog.dll) Version: 6.0.0+cfb73701cda54e2410b006f649f072e90daef707

Syntax

public sealed class SimpleLayout : Layout, 
	IUsesStackTrace

Public NotInheritable Class SimpleLayout
	Inherits Layout
	Implements IUsesStackTrace

Dim instance As SimpleLayout

[<SealedAttribute>]
type SimpleLayout =  
    class
        inherit Layout
        interface IUsesStackTrace
    end

The SimpleLayout type exposes the following members.

Constructors

	Name	Description
	SimpleLayout	Initializes a new instance of the SimpleLayout class.
	SimpleLayout(String)	Initializes a new instance of the SimpleLayout class.
	SimpleLayout(String, ConfigurationItemFactory)	Initializes a new instance of the SimpleLayout class.

Properties

	Name	Description
	FixedText	Get the fixed text. Only set when IsFixedText is
	IsFixedText	Is the message fixed? (no Layout renderers used)
	LayoutRenderers	Gets a collection of LayoutRenderer objects that make up this layout.
	OriginalText	Original text before parsing as Layout renderes.
	Renderers	Gets a collection of LayoutRenderer objects that make up this layout.
	StackTraceUsage	Gets the level of stack trace information required for rendering.
	Text	Gets or sets the layout text that could be parsed.

Methods

	Name	Description
	Evaluate(String)	Evaluates the specified text by expanding all layout renderers in new LogEventInfo context.
	Evaluate(String, LogEventInfo)	Evaluates the specified text by expanding all layout renderers.
	Precalculate	Precalculates the layout for the specified log event and stores the result in per-log event cache. Skips context capture when Layout have [ThreadAgnostic], and only contains layouts with [ThreadAgnostic]. (Overrides LayoutPrecalculate(LogEventInfo).)
	Render(LogEventInfo)	Renders formatted output using the log event as context. (Inherited from Layout.)
	Render(LogEventInfo, StringBuilder)	Optimized version of Render(LogEventInfo) that works best when override of RenderFormattedMessage(LogEventInfo, StringBuilder) is available. (Inherited from Layout.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Operators

	Name	Description
	(String to SimpleLayout)	Implicitly converts the specified string as LayoutRenderer-expression into a SimpleLayout.

Remarks

This layout is not meant to be used explicitly. Instead you can just use a string containing layout renderers everywhere the layout is required.