| <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>PatternLayoutConverter Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="PatternLayoutConverter class" /><meta name="System.Keywords" content="log4net.Layout.Pattern.PatternLayoutConverter class" /><meta name="System.Keywords" content="PatternLayoutConverter class, about PatternLayoutConverter class" /><meta name="Microsoft.Help.F1" content="log4net.Layout.Pattern.PatternLayoutConverter" /><meta name="Microsoft.Help.Id" content="T:log4net.Layout.Pattern.PatternLayoutConverter" /><meta name="Description" content="Abstract class that provides the formatting functionality that derived classes need." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Layout.Pattern" /><meta name="file" content="T_log4net_Layout_Pattern_PatternLayoutConverter" /><meta name="guid" content="T_log4net_Layout_Pattern_PatternLayoutConverter" /></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">PatternLayoutConverter 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"> |
| Abstract class that provides the formatting functionality that |
| derived classes need. |
| </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="LST3A4A9573_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3A4A9573_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br /> <a href="T_log4net_Util_PatternConverter.htm">log4net.Util<span id="LST3A4A9573_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3A4A9573_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>PatternConverter</a><br /> <span class="selflink">log4net.Layout.Pattern<span id="LST3A4A9573_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3A4A9573_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>PatternLayoutConverter</span><br /> <a href="T_log4net_Layout_Pattern_NamedPatternConverter.htm">log4net.Layout.Pattern<span id="LST3A4A9573_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3A4A9573_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>NamedPatternConverter</a><br /><p> </p><strong>Namespace:</strong> <a href="N_log4net_Layout_Pattern.htm">log4net.Layout.Pattern</a><br /><strong>Assembly:</strong> log4net (in log4net.dll) Version: 2.0.8.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">abstract</span> <span class="keyword">class</span> <span class="identifier">PatternLayoutConverter</span> : <span class="identifier">PatternConverter</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">MustInherit</span> <span class="keyword">Class</span> <span class="identifier">PatternLayoutConverter</span> |
| <span class="keyword">Inherits</span> <span class="identifier">PatternConverter</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">PatternLayoutConverter</span> <span class="keyword">abstract</span> : <span class="keyword">public</span> <span class="identifier">PatternConverter</span></pre></div><div id="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve">[<<span class="identifier">AbstractClassAttribute</span>>] |
| <span class="keyword">type</span> <span class="identifier">PatternLayoutConverter</span> = |
| <span class="keyword">class</span> |
| <span class="keyword">inherit</span> <span class="identifier">PatternConverter</span> |
| <span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">PatternLayoutConverter</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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Layout_Pattern_PatternLayoutConverter__ctor.htm">PatternLayoutConverter</a></td><td><div class="summary"> |
| Initializes a new instance of the <span class="selflink">PatternLayoutConverter</span> class. |
| </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;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Util_PatternConverter_FormattingInfo.htm">FormattingInfo</a></td><td><div class="summary"> |
| Gets or sets the formatting info for this converter |
| </div> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</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_Pattern_PatternLayoutConverter_IgnoresException.htm">IgnoresException</a></td><td><div class="summary"> |
| Flag indicating if this converter handles the logging event exception |
| </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_Util_PatternConverter_Next.htm">Next</a></td><td><div class="summary"> |
| Get the next pattern converter in the chain |
| </div> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</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_Util_PatternConverter_Option.htm">Option</a></td><td><div class="summary"> |
| Gets or sets the option value for this converter |
| </div> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</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_Util_PatternConverter_Properties.htm">Properties</a></td><td><div class="summary" /> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</a>.)</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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Layout_Pattern_PatternLayoutConverter_Convert.htm">Convert(TextWriter, LoggingEvent)</a></td><td><div class="summary"> |
| Derived pattern converters must override this method in order to |
| convert conversion specifiers in the correct way. |
| </div></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_Pattern_PatternLayoutConverter_Convert_1.htm">Convert(TextWriter, Object)</a></td><td><div class="summary"> |
| Derived pattern converters must override this method in order to |
| convert conversion specifiers in the correct way. |
| </div> (Overrides <a href="M_log4net_Util_PatternConverter_Convert.htm">PatternConverter<span id="LST3A4A9573_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3A4A9573_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Convert(TextWriter, 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/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_Util_PatternConverter_Format.htm">Format</a></td><td><div class="summary"> |
| Write the pattern converter to the writer with appropriate formatting |
| </div> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</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="M_log4net_Util_PatternConverter_SetNext.htm">SetNext</a></td><td><div class="summary"> |
| Set the next pattern converter in the chains |
| </div> (Inherited from <a href="T_log4net_Util_PatternConverter.htm">PatternConverter</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> |
| Conversion specifiers in a conversion patterns are parsed to |
| individual PatternConverters. Each of which is responsible for |
| converting a logging event in a converter specific manner. |
| <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_Pattern.htm">log4net.Layout.Pattern 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-2017 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> |
