Click or drag to resize

XmlLayout Class

A specialized layout that renders XML-formatted events.
Inheritance Hierarchy
SystemObject
  NLog.LayoutsLayout
    NLog.LayoutsXmlElementBase
      NLog.LayoutsXmlLayout

Namespace:  NLog.Layouts
Assembly:  NLog (in NLog.dll) Version: 5.3.1+cf6675da40ccfd4c8c526a3b2bdbeed3442910a1
Syntax
public class XmlLayout : XmlElementBase

The XmlLayout type exposes the following members.

Constructors
  NameDescription
Public methodXmlLayout
Initializes a new instance of the XmlLayout class.
Public methodXmlLayout(String, Layout)
Initializes a new instance of the XmlLayout class.
Top
Properties
  NameDescription
Public propertyAttributes
Gets the array of 'attributes' configurations for the element
(Inherited from XmlElementBase.)
Public propertyElementEncode
Determines whether or not this attribute will be Xml encoded.
Public propertyElementName
Name of the root XML element
Public propertyElements
Gets the array of xml 'elements' configurations.
(Inherited from XmlElementBase.)
Public propertyElementValue
Value inside the root XML element
Public propertyExcludeProperties
List of property names to exclude when IncludeAllProperties is true
(Inherited from XmlElementBase.)
Public propertyIncludeEmptyValue
Gets or sets whether a ElementValue with empty value should be included in the output
(Inherited from XmlElementBase.)
Public propertyIncludeEventProperties
Gets or sets the option to include all properties from the log event (as XML)
(Inherited from XmlElementBase.)
Public propertyIncludeScopeProperties
Gets or sets whether to include the contents of the ScopeContext dictionary.
(Inherited from XmlElementBase.)
Public propertyIndentXml
Auto indent and create new lines
(Inherited from XmlElementBase.)
Protected propertyLoggingConfiguration
Gets the logging configuration this target is part of.
(Inherited from Layout.)
Public propertyMaxRecursionLimit
How far should the XML serializer follow object references before backing off
(Inherited from XmlElementBase.)
Public propertyPropertiesCollectionItemName
XML element name to use for rendering IList-collections items
(Inherited from XmlElementBase.)
Public propertyPropertiesElementKeyAttribute
XML attribute name to use when rendering property-key When null (or empty) then key-attribute is not included
(Inherited from XmlElementBase.)
Public propertyPropertiesElementName
XML element name to use when rendering properties
(Inherited from XmlElementBase.)
Public propertyPropertiesElementValueAttribute
XML attribute name to use when rendering property-value When null (or empty) then value-attribute is not included and value is formatted as XML-element-value
(Inherited from XmlElementBase.)
Top
Methods
  NameDescription
Protected methodCloseLayout
Closes the layout.
(Inherited from XmlElementBase.)
Protected methodGetFormattedMessage
Renders formatted output using the log event as context.
(Inherited from XmlElementBase.)
Protected methodInitializeLayout
Initializes the layout.
(Inherited from XmlElementBase.)
Public methodPrecalculate
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].
(Inherited from Layout.)
Public methodRender(LogEventInfo)
Renders formatted output using the log event as context.
(Inherited from Layout.)
Public methodRender(LogEventInfo, StringBuilder)
Optimized version of Render(LogEventInfo) that works best when override of RenderFormattedMessage(LogEventInfo, StringBuilder) is available.
(Inherited from Layout.)
Protected methodRenderFormattedMessage
Renders formatted output using the log event as context.
(Inherited from XmlElementBase.)
Protected methodResolveServiceT
Resolve from DI ServiceRepository
(Inherited from Layout.)
Public methodToString
Returns a string that represents the current object.
(Inherited from XmlElementBase.)
Top
Remarks
See Also