﻿<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { }.OH_footer { }</style><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </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="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><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><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST251C970A_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_log4net_Layout_LayoutSkeleton.htm">log4net.Layout<span id="LST251C970A_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LayoutSkeleton</a><br />    <a href="T_log4net_Layout_XmlLayoutBase.htm">log4net.Layout<span id="LST251C970A_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>XmlLayoutBase</a><br />      <span class="selflink">log4net.Layout<span id="LST251C970A_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>XmlLayout</span><br /><p> </p><strong>Namespace:</strong> <a href="N_log4net_Layout.htm">log4net.Layout</a><br /><strong>Assembly:</strong> log4net (in log4net.dll) Version: 2.0.6.0-.NET 4.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 class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs"><div class="OH_CodeSnippetContainerTabLeft" id="ID0EDCA_tabimgleft"> </div><div id="ID0EDCA_tab1" class="OH_CodeSnippetContainerTabFirst"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EDCA_tabimgright"> </div></div><div class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">XmlLayout</span> : <span class="identifier">XmlLayoutBase</span></pre></div><div id="ID0EDCA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><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="ID0EDCA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><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="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">XmlLayout</span> =  
    <span class="keyword">class</span>
        <span class="keyword">inherit</span> <span class="identifier">XmlLayoutBase</span>
    <span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">XmlLayout</span> type exposes the following members.</p><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Constructors</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
								 
							</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Layout_XmlLayout__ctor.htm">XmlLayout<span id="LST251C970A_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_4?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a></td><td><div class="summary">
            Constructs an XmlLayout
            </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Layout_XmlLayout__ctor_1.htm">XmlLayout(Boolean)</a></td><td><div class="summary">
            Constructs an XmlLayout.
            </div></td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Properties</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
								 
							</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayout_Base64EncodeMessage.htm">Base64EncodeMessage</a></td><td><div class="summary">
            Set whether or not to base64 encode the message.
            </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayout_Base64EncodeProperties.htm">Base64EncodeProperties</a></td><td><div class="summary">
            Set whether or not to base64 encode the property values.
            </div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayoutBase_ContentType.htm">ContentType</a></td><td><div class="summary">
            Gets the content type output by this layout. 
            </div> (Inherited from <a href="T_log4net_Layout_XmlLayoutBase.htm">XmlLayoutBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_LayoutSkeleton_Footer.htm">Footer</a></td><td><div class="summary">
            The footer for the layout format.
            </div> (Inherited from <a href="T_log4net_Layout_LayoutSkeleton.htm">LayoutSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_LayoutSkeleton_Header.htm">Header</a></td><td><div class="summary">
            The header for the layout format.
            </div> (Inherited from <a href="T_log4net_Layout_LayoutSkeleton.htm">LayoutSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_LayoutSkeleton_IgnoresException.htm">IgnoresException</a></td><td><div class="summary">
            Flag indicating if this layout handles exceptions
            </div> (Inherited from <a href="T_log4net_Layout_LayoutSkeleton.htm">LayoutSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayoutBase_InvalidCharReplacement.htm">InvalidCharReplacement</a></td><td><div class="summary">
            The string to replace characters that can not be expressed in XML with.
            <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>
            Not all characters may be expressed in XML. This property contains the
            string to replace those that can not with. This defaults to a ?. Set it
            to the empty string to simply remove offending characters. For more
            details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
            Character replacement will occur in  the log message, the property names 
            and the property values.
            </p></div> (Inherited from <a href="T_log4net_Layout_XmlLayoutBase.htm">XmlLayoutBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayoutBase_LocationInfo.htm">LocationInfo</a></td><td><div class="summary">
            Gets a value indicating whether to include location information in 
            the XML events.
            </div> (Inherited from <a href="T_log4net_Layout_XmlLayoutBase.htm">XmlLayoutBase</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Layout_XmlLayout_Prefix.htm">Prefix</a></td><td><div class="summary">
            The prefix to use for all element names
            </div></td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Methods</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
								 
							</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Layout_XmlLayout_ActivateOptions.htm">ActivateOptions</a></td><td><div class="summary">
            Initialize layout options
            </div> (Overrides <a href="M_log4net_Layout_XmlLayoutBase_ActivateOptions.htm">XmlLayoutBase<span id="LST251C970A_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ActivateOptions<span id="LST251C970A_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_6?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">
                    Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">
                    Allows an <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> to attempt to free resources and perform other cleanup operations before the <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is reclaimed by garbage collection.
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Layout_LayoutSkeleton_Format.htm">Format(LoggingEvent)</a></td><td><div class="summary">
            Convenience method for easily formatting the logging event into a string variable.
            </div> (Inherited from <a href="T_log4net_Layout_LayoutSkeleton.htm">LayoutSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Layout_XmlLayoutBase_Format.htm">Format(TextWriter, LoggingEvent)</a></td><td><div class="summary">
            Produces a formatted string.
            </div> (Inherited from <a href="T_log4net_Layout_XmlLayoutBase.htm">XmlLayoutBase</a>.)</td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Layout_XmlLayout_FormatXml.htm">FormatXml</a></td><td><div class="summary">
            Does the actual writing of the XML.
            </div> (Overrides <a href="M_log4net_Layout_XmlLayoutBase_FormatXml.htm">XmlLayoutBase<span id="LST251C970A_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST251C970A_7?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>FormatXml(XmlWriter, LoggingEvent)</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">
                    Serves as a hash function for a particular type. 
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">
                    Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">
                    Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">
                    Returns a <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a> that represents the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
                </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#mainBody">Top</a><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 class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EADCBA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EADCBA');return false;" title="Copy">Copy</a></div></div><div id="ID0EADCBA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="highlight-xml-bracket">&lt;?</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">?&gt;</span>

<span class="highlight-xml-bracket">&lt;!</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">&lt;!</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">&gt;</span>]<span class="highlight-xml-bracket">&gt;</span>

<span class="highlight-xml-bracket">&lt;</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">&gt;</span>
    &amp;data;
<span class="highlight-xml-bracket">&lt;/</span><span class="highlight-xml-tag">log4net:events</span><span class="highlight-xml-bracket">&gt;</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EADCBA");</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><div class="OH_CollapsibleAreaRegion" id="seeAlsoSection"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_log4net_Layout.htm">log4net.Layout Namespace</a></div></div></div></div></div><div id="OH_footer" class="OH_footer">Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.<p><a href="http://logging.apache.org/log4net/" target="_blank">Copyright 2004-2016 The Apache Software Foundation</a></p><div class="OH_feedbacklink">Send comments on this topic to
        <a id="HT_MailLink" href="mailto:http%3A%2F%2Flogging.apache.org%2Flog4net%2Fmail-lists.html?Subject=Apache log4net™ SDK Documentation">http://logging.apache.org/log4net/mail-lists.html</a></div><script type="text/javascript">
        var HT_mailLink = document.getElementById("HT_MailLink");
        var HT_mailLinkText = HT_mailLink.innerHTML;
        HT_mailLink.href += ": " + document.title + "\u0026body=" + encodeURIComponent("Your feedback is used to improve the documentation and the product. Your e-mail address will not be used for any other purpose and is disposed of after the issue you report is resolved. While working to resolve the issue that you report, you may be contacted via e-mail to get further details or clarification on the feedback you sent. After the issue you report has been addressed, you may receive an e-mail to let you know that your feedback has been addressed.");
        HT_mailLink.innerHTML = HT_mailLinkText;
        </script> </div></body></html>