blob: 528ddd3c5be642011f7087886cbe1ad206cb8f67 [file] [log] [blame]
<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>XmlLayout 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">XmlLayout Class</h1>
</div>
</div>
<div id="nstext">
<p> Layout that formats the log events as XML elements. </p>
<p>For a list of all members of this type, see <a href="log4net.Layout.XmlLayoutMembers.html">XmlLayout Members</a>.</p>
<p>
<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">System.Object</a>
<br />���<a href="log4net.Layout.LayoutSkeleton.html">log4net.Layout.LayoutSkeleton</a><br />������<a href="log4net.Layout.XmlLayoutBase.html">log4net.Layout.XmlLayoutBase</a><br />���������<b>log4net.Layout.XmlLayout</b></p>
<div class="syntax">
<span class="lang">[Visual�Basic]</span>
<br />Public�Class�XmlLayout<div>����Inherits�<a href="log4net.Layout.XmlLayoutBase.html">XmlLayoutBase</a></div></div>
<div class="syntax">
<span class="lang">[C#]</span>
<div>public�class�XmlLayout<b> : <a href="log4net.Layout.XmlLayoutBase.html">XmlLayoutBase</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> The output of the <b>XmlLayout</b> consists of a series of log4net:event elements. It does not output a complete well-formed XML file. The output is designed to be included as an <em>external entity</em> in a separate file to form a correct XML file. </p>
<p> For example, if <code>abc</code> is the name of the file where the <b>XmlLayout</b> output goes, then a well-formed XML file would be: </p>
<pre class="code"><span class="lang">[XML]
</span> &lt;?xml version="1.0" ?&gt;
&lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
&lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
&amp;data;
&lt;/log4net:events&gt;
</pre>
<p> This approach enforces the independence of the <b>XmlLayout</b> and the appender where it is embedded. </p>
<p> The <code>version</code> attribute helps components to correctly interpret output generated by <b>XmlLayout</b>. The value of this attribute should be "1.2" for release 1.2 and later. </p>
<p> Alternatively the <code>Header</code> and <code>Footer</code> properties can be configured to output the correct XML header, open tag and close tag. When setting the <code>Header</code> and <code>Footer</code> properties it is essential that the underlying data store not be appendable otherwise the data will become invalid XML. </p>
<h4 class="dtH4">Requirements</h4><p><b>Namespace: </b><a href="log4net.Layout.html">log4net.Layout</a></p><p><b>Assembly: </b>log4net (in log4net.dll)
</p><h4 class="dtH4">See Also</h4><p><a href="log4net.Layout.XmlLayoutMembers.html">XmlLayout Members</a> | <a href="log4net.Layout.html">log4net.Layout Namespace</a></p><object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;"><param name="Keyword" value="XmlLayout class, about XmlLayout 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>