| <html dir="LTR"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" /> |
| <meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" /> |
| <title>AnsiColorTerminalAppender Class</title> |
| <xml> |
| </xml> |
| <link rel="stylesheet" type="text/css" href="MSDN.css" /> |
| </head> |
| <body id="bodyID" class="dtBODY"> |
| <div id="nsbanner"> |
| <div id="bannerrow1"> |
| <table class="bannerparthead" cellspacing="0"> |
| <tr id="hdr"> |
| <td class="runninghead">Apache log4net� SDK Documentation - Microsoft .NET Framework 4.0</td> |
| <td class="product"> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div id="TitleRow"> |
| <h1 class="dtH1">AnsiColorTerminalAppender Class</h1> |
| </div> |
| </div> |
| <div id="nstext"> |
| <p> Appends logging events to the terminal using ANSI color escape sequences. </p> |
| <p>For a list of all members of this type, see <a href="log4net.Appender.AnsiColorTerminalAppenderMembers.html">AnsiColorTerminalAppender Members</a>.</p> |
| <p> |
| <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">System.Object</a> |
| <br />���<a href="log4net.Appender.AppenderSkeleton.html">log4net.Appender.AppenderSkeleton</a><br />������<b>log4net.Appender.AnsiColorTerminalAppender</b></p> |
| <div class="syntax"> |
| <span class="lang">[Visual�Basic]</span> |
| <br />Public�Class�AnsiColorTerminalAppender<div>����Inherits�<a href="log4net.Appender.AppenderSkeleton.html">AppenderSkeleton</a></div></div> |
| <div class="syntax"> |
| <span class="lang">[C#]</span> |
| <div>public�class�AnsiColorTerminalAppender<b> : <a href="log4net.Appender.AppenderSkeleton.html">AppenderSkeleton</a></b></div> |
| </div> |
| <H4 class="dtH4">Thread Safety</H4> |
| <P>Public static (<b>Shared</b> in Visual Basic) members of this type are |
| safe for multithreaded operations. Instance members are <b>not</b> guaranteed to be |
| thread-safe.</P> |
| <h4 class="dtH4">Remarks</h4> |
| <p> AnsiColorTerminalAppender appends log events to the standard output stream or the error output stream using a layout specified by the user. It also allows the color of a specific level of message to be set. </p> |
| <blockquote class="dtBlock"><b>Note</b>��� This appender expects the terminal to understand the VT100 control set in order to interpret the color codes. If the terminal or console does not understand the control codes the behavior is not defined. </blockquote> |
| <p> By default, all output is written to the console's standard output stream. The <a href="log4net.Appender.AnsiColorTerminalAppender.Target.html">Target</a> property can be set to direct the output to the error stream. </p> |
| <p> NOTE: This appender writes each message to the <code>System.Console.Out</code> or <code>System.Console.Error</code> that is set at the time the event is appended. Therefore it is possible to programmatically redirect the output of this appender (for example NUnit does this to capture program output). While this is the desired behavior of this appender it may have security implications in your application. </p> |
| <p> When configuring the ANSI colored terminal appender, a mapping should be specified to map a logging level to a color. For example: </p> |
| <pre class="code" escaped="true"><span class="lang">[XML] |
| </span><mapping> |
| <level value="ERROR" /> |
| <foreColor value="White" /> |
| <backColor value="Red" /> |
| <attributes value="Bright,Underscore" /> |
| </mapping> |
| <mapping> |
| <level value="DEBUG" /> |
| <backColor value="Green" /> |
| </mapping> |
| </pre> |
| <p> The Level is the standard log4net logging level and ForeColor and BackColor can be any of the following values: <ul type="disc"><li><b>Blue - </b></li><li><b>Green - </b></li><li><b>Red - </b></li><li><b>White - </b></li><li><b>Yellow - </b></li><li><b>Purple - </b></li><li><b>Cyan - </b></li></ul> These color values cannot be combined together to make new colors. </p> |
| <p> The attributes can be any combination of the following: <ul type="disc"><li><b>Bright - </b>foreground is brighter</li><li><b>Dim - </b>foreground is dimmer</li><li><b>Underscore - </b>message is underlined</li><li><b>Blink - </b>foreground is blinking (does not work on all terminals)</li><li><b>Reverse - </b>foreground and background are reversed</li><li><b>Hidden - </b>output is hidden</li><li><b>Strikethrough - </b>message has a line through it</li></ul> While any of these attributes may be combined together not all combinations work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes no sense. </p> |
| <h4 class="dtH4">Requirements</h4><p><b>Namespace: </b><a href="log4net.Appender.html">log4net.Appender</a></p><p><b>Assembly: </b>log4net (in log4net.dll) |
| </p><h4 class="dtH4">See Also</h4><p><a href="log4net.Appender.AnsiColorTerminalAppenderMembers.html">AnsiColorTerminalAppender Members</a> | <a href="log4net.Appender.html">log4net.Appender Namespace</a></p><object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;"><param name="Keyword" value="AnsiColorTerminalAppender class, about AnsiColorTerminalAppender class"></param></object><hr /><div id="footer"><a href='http://logging.apache.org/log4net/'>Copyright 2004-2011 The Apache Software Foundation.</a><br></br>Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.</div></div> |
| </body> |
| </html> |
