Click or drag to resize

ConsoleTarget Class

Writes log messages to the console.
Inheritance Hierarchy
SystemObject
  NLog.TargetsTarget
    NLog.TargetsTargetWithLayout
      NLog.TargetsTargetWithLayoutHeaderAndFooter
        NLog.TargetsConsoleTarget

Namespace:  NLog.Targets
Assembly:  NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
Syntax
public sealed class ConsoleTarget : TargetWithLayoutHeaderAndFooter

The ConsoleTarget type exposes the following members.

Constructors
  NameDescription
Public methodConsoleTarget
Initializes a new instance of the ConsoleTarget class.
Public methodConsoleTarget(String)
Initializes a new instance of the ConsoleTarget class.
Top
Properties
  NameDescription
Public propertyAutoFlush
Gets or sets a value indicating whether to auto-flush after WriteLine
Public propertyDetectConsoleAvailable
Gets or sets a value indicating whether to auto-check if the console is available - Disables console writing if Environment.UserInteractive = False (Windows Service) - Disables console writing if Console Standard Input is not available (Non-Console-App)
Public propertyEncoding
The encoding for writing messages to the Console.
Public propertyFooter
Gets or sets the footer.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Public propertyHeader
Gets or sets the header.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Public propertyLayout
Gets or sets the text to be rendered.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Public propertyStdErr
Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output.
Public propertyWriteBuffer
Gets or sets whether to activate internal buffering to allow batch writing, instead of using WriteLine
Top
Methods
  NameDescription
Public methodDispose
Closes the target.
(Inherited from Target.)
Public methodFlush
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.)
Public methodPrecalculateVolatileLayouts
Calls the Precalculate(LogEventInfo) on each volatile layout used by this target. This method won't prerender if all layouts in this target are thread-agnostic.
(Inherited from Target.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Target.)
Public methodWriteAsyncLogEvent
Writes the log to the target.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(AsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(IListAsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Top
Remarks
Examples

To set up the target in the configuration file, use the following syntax:

XML
 1<?xml version="1.0" ?>
 2<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
 3      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 4    <targets>
 5        <target name="console" xsi:type="Console" layout="${date:format=HH\:MM\:ss} ${logger} ${message}" />
 6    </targets>
 7
 8    <rules>
 9        <logger name="*" minlevel="Info" writeTo="console" />
10    </rules>
11</nlog>

To set up the log target programmatically use code like this:

C#
 1using NLog;
 2using NLog.Targets;
 3
 4class Example
 5{
 6    static void Main(string[] args)
 7    {
 8        ConsoleTarget target = new ConsoleTarget();
 9        target.Layout = "${date:format=HH\\:MM\\:ss} ${logger} ${message}";
10
11        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug);
12
13        Logger logger = LogManager.GetLogger("Example");
14        logger.Debug("log message");
15    }
16}
See Also