CsvLayout Class

A specialized layout that renders CSV-formatted events.

Inheritance Hierarchy

SystemObject
  NLog.LayoutsLayout
    NLog.LayoutsLayoutWithHeaderAndFooter
      NLog.LayoutsCsvLayout

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

Syntax

public class CsvLayout : LayoutWithHeaderAndFooter

Public Class CsvLayout
	Inherits LayoutWithHeaderAndFooter

Dim instance As CsvLayout

type CsvLayout =  
    class
        inherit LayoutWithHeaderAndFooter
    end

The CsvLayout type exposes the following members.

Constructors

	Name	Description
	CsvLayout	Initializes a new instance of the CsvLayout class.

Properties

	Name	Description
	Columns	Gets the array of parameters to be passed.
	CustomColumnDelimiter	Gets or sets the custom column delimiter value (valid when Delimiter is set to Custom).
	Delimiter	Gets or sets the column delimiter.
	Footer	Gets or sets the footer layout. (Inherited from LayoutWithHeaderAndFooter.)
	Header	Gets or sets the header layout. (Inherited from LayoutWithHeaderAndFooter.)
	Layout	Gets or sets the body layout (can be repeated multiple times). (Inherited from LayoutWithHeaderAndFooter.)
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from Layout.)
	QuoteChar	Gets or sets the quote Character.
	Quoting	Gets or sets the quoting mode.
	WithHeader	Gets or sets a value indicating whether CSV should include header.

Methods

	Name	Description
	CloseLayout	Closes the layout. (Overrides LayoutCloseLayout.)
	GetFormattedMessage	Renders formatted output using the log event as context. (Overrides LayoutWithHeaderAndFooterGetFormattedMessage(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. Skips context capture when Layout have [ThreadAgnostic], and only contains layouts with [ThreadAgnostic]. (Inherited from Layout.)
	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 LayoutWithHeaderAndFooterRenderFormattedMessage(LogEventInfo, StringBuilder).)
	ResolveServiceT	Resolve from DI ServiceRepository (Inherited from Layout.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Remarks

If Header is set, then the header generation with column names will be disabled.