| <html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp"><head><link rel="SHORTCUT ICON" href="./../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { backgroundImageName: tabLeftBG.gif; }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { backgroundImageName: tabRightBG.gif; }.OH_footer { backgroundImageName: footer_slice.gif; background-position: top; background-repeat: repeat-x; }</style><link rel="stylesheet" type="text/css" href="./../styles/branding.css" /><link rel="stylesheet" type="text/css" href="./../styles/branding-en-US.css" /><style type="text/css"> |
| body |
| { |
| border-left:5px solid #e6e6e6; |
| overflow-x:scroll; |
| overflow-y:scroll; |
| } |
| </style><script src="./../scripts/branding.js" type="text/javascript"><!----></script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XmlLayout Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="XmlLayout class" /><meta name="System.Keywords" content="log4net.Layout.XmlLayout class" /><meta name="System.Keywords" content="XmlLayout class, about XmlLayout class" /><meta name="Microsoft.Help.F1" content="log4net.Layout.XmlLayout" /><meta name="Microsoft.Help.Id" content="T:log4net.Layout.XmlLayout" /><meta name="Description" content="Layout that formats the log events as XML elements." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="'true'" /><meta name="container" content="log4net.Layout" /><meta name="file" content="T_log4net_Layout_XmlLayout" /><meta name="guid" content="T_log4net_Layout_XmlLayout" /><link type="text/css" rel="stylesheet" href="ms-help://Hx/HxRuntime/HxLink.css" /><link type="text/css" rel="stylesheet" href="./../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"><!----></script><meta name="SelfBranded" content="true" /></head><body onload="onLoad()" class="primary-mtps-offline-document"><div class="OH_outerDiv"><div class="OH_outerContent"><table class="TitleTable"><tr><td class="OH_tdTitleColumn">XmlLayout Class</td><td class="OH_tdRunningTitleColumn">Apache log4net™ SDK Documentation</td></tr></table><div id="mainSection"><div id="mainBody"><span class="introStyle"></span><div class="summary"> |
| Layout that formats the log events as XML elements. |
| </div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Inheritance Hierarchy</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="ID0EBKNAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBKNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>Object</a><br /> <a href="T_log4net_Layout_LayoutSkeleton.htm" target="">log4net.Layout<span id="ID0EBHNAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBHNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>LayoutSkeleton</a><br /> <a href="T_log4net_Layout_XmlLayoutBase.htm" target="">log4net.Layout<span id="ID0EBENAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBENAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>XmlLayoutBase</a><br /> <span class="selflink">log4net.Layout<span id="ID0EBBNAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBBNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>XmlLayout</span><br /><p></p><b>Namespace:</b> <a href="N_log4net_Layout.htm" target="">log4net.Layout</a><br /><b>Assembly:</b> <span sdata="assembly">log4net</span> (in log4net.dll) Version: 1.2.15.0 (1.2.15.0)<div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Syntax</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><div id="snippetGroup_Syntax" class="code"><div id="ID0ECADAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0ECADAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeftActive" id="ID0ECADAAAAA_tabimgleft"></div><div id="ID0ECADAAAAA_tab1" class="OH_CodeSnippetContainerTabActive" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','C#','1','4');return false;">C#</a></div><div id="ID0ECADAAAAA_tab2" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','Visual Basic','2','4');return false;">VB</a></div><div id="ID0ECADAAAAA_tab3" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','Visual C++','3','4');return false;">C++</a></div><div id="ID0ECADAAAAA_tab4" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0ECADAAAAA_tabimgright"></div></div><div id="ID0ECADAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0ECADAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0ECADAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0ECADAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0ECADAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0ECADAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0ECADAAAAA','4')" title="Print">Print</a></div></div><div id="ID0ECADAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">XmlLayout</span> : <span class="identifier">XmlLayoutBase</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public class XmlLayout : XmlLayoutBase</pre></div><div id="ID0ECADAAAAA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">XmlLayout</span> |
| <span class="keyword">Inherits</span> <span class="identifier">XmlLayoutBase</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre>Public Class XmlLayout |
| Inherits XmlLayoutBase</pre></div><div id="ID0ECADAAAAA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">XmlLayout</span> : <span class="keyword">public</span> <span class="identifier">XmlLayoutBase</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public ref class XmlLayout : public XmlLayoutBase</pre></div><div id="ID0ECADAAAAA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0ECADAAAAA_code_Plain_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div></div></div><script>addSpecificTextLanguageTagSet('ID0ECADAAAAA');</script></div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Remarks</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><p> |
| The output of the <span class="selflink">XmlLayout</span> 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 <span class="code">abc</span> is the name of the file where |
| the <span class="selflink">XmlLayout</span> output goes, then a well-formed XML file would |
| be: |
| </p><div id="ID0EDCAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0EDCAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeft" id="ID0EDCAAAAA_tabimgleft"></div><div id="ID0EDCAAAAA_tab1" class="OH_CodeSnippetContainerTabSolo" EnableCopyCode="true"><a xmlns="">XML</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EDCAAAAA_tabimgright"></div></div><div id="ID0EDCAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EDCAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0EDCAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0EDCAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0EDCAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0EDCAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0EDCAAAAA','4')" title="Print">Print</a></div></div><div id="ID0EDCAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre><span class="highlight-xml-bracket"><?</span><span class="highlight-xml-tag">xml</span> <span class="highlight-xml-attribute-name">version</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"1.0"</span> <span class="highlight-xml-bracket">?></span> |
| |
| <span class="highlight-xml-bracket"><!</span><span class="highlight-xml-attribute-value">DOCTYPE</span> <span class="highlight-xml-attribute-value">log4net</span>:<span class="highlight-xml-attribute-value">events</span> <span class="highlight-xml-attribute-value">SYSTEM</span> <span class="highlight-xml-attribute-value">"log4net-events.dtd"</span> [<span class="highlight-xml-bracket"><!</span><span class="highlight-xml-attribute-value">ENTITY</span> <span class="highlight-xml-attribute-value">data</span> <span class="highlight-xml-attribute-value">SYSTEM</span> <span class="highlight-xml-attribute-value">"abc"</span><span class="highlight-xml-bracket">></span>]<span class="highlight-xml-bracket">></span> |
| |
| <span class="highlight-xml-bracket"><</span><span class="highlight-xml-tag">log4net:events</span> <span class="highlight-xml-attribute-name">version</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"1.2"</span> <span class="highlight-xml-attribute-name">xmlns:log4net</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">http</span>://<span class="highlight-xml-attribute-name">logging.apache.org</span><span class="highlight-xml-attribute-value">log4net</span>/<span class="highlight-xml-attribute-name">schemas</span><span class="highlight-xml-attribute-value">log4net-events-1.2</span><span class="highlight-xml-bracket">></span> |
| &data; |
| <span class="highlight-xml-bracket"></</span><span class="highlight-xml-tag">log4net:events</span><span class="highlight-xml-bracket">></span></pre></div><div id="ID0EDCAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre><?xml version="1.0" ?> |
| |
| <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> |
| |
| <log4net:events version="1.2" xmlns:log4net=http://logging.apache.orglog4net/schemaslog4net-events-1.2> |
| &data; |
| </log4net:events></pre></div></div></div><script>addSpecificTextLanguageTagSet('ID0EDCAAAAA');</script><p> |
| This approach enforces the independence of the <span class="selflink">XmlLayout</span> |
| and the appender where it is embedded. |
| </p><p> |
| The <span class="code">version</span> attribute helps components to correctly |
| interpret output generated by <span class="selflink">XmlLayout</span>. The value of |
| this attribute should be "1.2" for release 1.2 and later. |
| </p><p> |
| Alternatively the <span class="code">Header</span> and <span class="code">Footer</span> properties can be |
| configured to output the correct XML header, open tag and close tag. |
| When setting the <span class="code">Header</span> and <span class="code">Footer</span> properties it is essential |
| that the underlying data store not be appendable otherwise the data |
| will become invalid XML. |
| </p><a name="seeAlsoSection"><!----></a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><div class="seeAlsoStyle"><a href="AllMembers_T_log4net_Layout_XmlLayout.htm" target="">XmlLayout Members</a></div><div class="seeAlsoStyle"><a href="N_log4net_Layout.htm" target="">log4net.Layout Namespace</a></div></div></div></div></div><div id="OH_footer" class="OH_footer"><p>Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.</p><p><a href="http://logging.apache.org/log4net/" target="_blank"><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /> |
| Copyright 2004-2015 The Apache Software Foundation (http://logging.apache.org/log4net/)</a></p><div class="OH_feedbacklink"><a href="mailto:http://logging.apache.org/log4net/mail-lists.html?subject=Apache+log4net%e2%84%a2+SDK+Documentation+XmlLayout+Class+100+EN-US&body=Your%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report%2c%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed%2c%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.">Send Feedback</a> on this topic to http://logging.apache.org/log4net/mail-lists.html.</div></div></body></html> |