AspNetHttpContextItemLayoutRenderer Class

ASP.NET HttpContext Items Dictionary Value.

Inheritance Hierarchy

SystemObject
  NLog.LayoutRenderersLayoutRenderer
    NLog.Web.LayoutRenderersAspNetLayoutRendererBase
      NLog.Web.LayoutRenderersAspNetHttpContextItemLayoutRenderer

Namespace: NLog.Web.LayoutRenderers
Assemblies: NLog.Web.AspNetCore (in NLog.Web.AspNetCore.dll) Version: 6.0.0+59339f2811712b446adf6dcd8a6bad39ad9f2ba1
NLog.Web (in NLog.Web.dll) Version: 6.0.0+59339f2811712b446adf6dcd8a6bad39ad9f2ba1

Syntax

Copy

public class AspNetHttpContextItemLayoutRenderer : AspNetLayoutRendererBase

Public Class AspNetHttpContextItemLayoutRenderer
	Inherits AspNetLayoutRendererBase

Dim instance As AspNetHttpContextItemLayoutRenderer

type AspNetHttpContextItemLayoutRenderer =  
    class
        inherit AspNetLayoutRendererBase
    end

The AspNetHttpContextItemLayoutRenderer type exposes the following members.

Constructors

	Name	Description
	AspNetHttpContextItemLayoutRenderer	Initializes a new instance of the AspNetHttpContextItemLayoutRenderer class

Top

Properties

	Name	Description
	Culture	Gets or sets the culture used for rendering.
	Format	Format string for conversion from object to string.
	HttpContextAccessor	Provides access to the current request HttpContext. (Inherited from AspNetLayoutRendererBase.)
	Item	Gets or sets the item variable name.
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from LayoutRenderer.)
	ObjectPath	Gets or sets the object-property-navigation-path for lookup of nested property. In this case the Item should have have any dot notation, as the nested properties path is in this variable Example: Item="person"; ObjectPath="Name.First" This will emit the First Name property of the object in HttpContext.Items woith the key of 'person' in the collection
	ValueFormatter	Value formatter (Inherited from LayoutRenderer.)
	Variable	Obsolete. Gets or sets the item variable name.

Top

Methods

	Name	Description
	Append	Renders the value of layout renderer in the context of the specified log event into StringBuilder. (Overrides AspNetLayoutRendererBaseAppend(StringBuilder, LogEventInfo).)
	CloseLayoutRenderer	Closes the layout renderer. (Inherited from AspNetLayoutRendererBase.)
	DoAppend	Obsolete. Renders the value of layout renderer in the context of the specified log event into StringBuilder. (Inherited from AspNetLayoutRendererBase.)
	GetCulture	Get the CultureInfo for rendering the messages to a String (Inherited from LayoutRenderer.)
	GetFormatProvider	Get the IFormatProvider for rendering the messages to a String (Inherited from LayoutRenderer.)
	InitializeLayoutRenderer	Initializes the layout renderer. (Overrides LayoutRendererInitializeLayoutRenderer.)
	Render	Renders the value of layout renderer in the context of the specified log event. (Inherited from LayoutRenderer.)
	ResolveServiceT	Resolves the interface service-type from the service-repository (Inherited from LayoutRenderer.)
	ToString	Returns a string that represents the current object. (Inherited from LayoutRenderer.)

Top

Remarks

Copy

1${aspnet-httpcontext-item:myKey} - produces "123"
2${aspnet-httpcontext-item:anotherKey} - produces "01/01/2006 00:00:00"
3${aspnet-httpcontext-item:anotherKey:culture=pl-PL} - produces "2006-01-01 00:00:00"
4${aspnet-httpcontext-item:myKey:padding=5} - produces "  123"
5${aspnet-httpcontext-item:myKey:padding=-5} - produces "123  "
6${aspnet-httpcontext-item:stringKey:upperCase=true} - produces "AAA BBB"

Examples

You can set the value of an ASP.NET Item variable by using the following code:

Copy

1HttpContext.Current.Items["myKey"] = 123;
2HttpContext.Current.Items["stringKey"] = "aaa BBB";
3HttpContext.Current.Items["anotherKey"] = DateTime.Now;

Reference

NLog.Web.LayoutRenderers Namespace

Other Resources

Documentation on NLog Wiki