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: 5.3.1+cf6675da40ccfd4c8c526a3b2bdbeed3442910a1

Syntax

public class SimpleLayout : Layout, 
	IUsesStackTrace

Public Class SimpleLayout
	Inherits Layout
	Implements IUsesStackTrace

Dim instance As SimpleLayout

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 true
	IsFixedText	Is the message fixed? (no Layout renderers used)
	LayoutRenderers	Gets a collection of LayoutRenderer objects that make up this layout.
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from Layout.)
	OriginalText	Original text before compile to 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.

Methods

	Name	Description
	CloseLayout	Closes the layout. (Inherited from Layout.)
	Escape	Escapes the passed text so that it can be used literally in all places where layout is normally expected without being treated as layout.
	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.
	GetFormattedMessage	Renders formatted output using the log event as context. (Overrides LayoutGetFormattedMessage(LogEventInfo).)
	InitializeLayout	Initializes the layout. (Overrides LayoutInitializeLayout.)
	Precalculate	Precalculates the layout for the specified log event and stores the result in per-log event cache. Only if the layout doesn't have [ThreadAgnostic] and doesn't contain 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.)
	RenderFormattedMessage	Renders formatted output using the log event as context. (Overrides LayoutRenderFormattedMessage(LogEventInfo, StringBuilder).)
	ResolveServiceT	Resolve from DI ServiceRepository (Inherited from Layout.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Operators

	Name	Description
	(String to SimpleLayout)	Converts a text to a simple layout.

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.