DynamicPatternLayout Class | Apache log4net™ SDK Documentation

A flexible layout configurable with pattern string that re-evaluates on each call.
Inheritance Hierarchy

System
Object
log4net.Layout
LayoutSkeleton
log4net.Layout
PatternLayout
log4net.Layout
DynamicPatternLayout

Namespace: log4net.Layout
Assembly: log4net (in log4net.dll) Version: 2.0.8.0-.NET 4.0
Syntax

C#
VB
C++
F#
Copy

    public class DynamicPatternLayout : PatternLayout

    Public Class DynamicPatternLayout
    	Inherits PatternLayout

    public ref class DynamicPatternLayout : public PatternLayout

    type DynamicPatternLayout =
        class
            inherit PatternLayout
        end

The DynamicPatternLayout type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| DynamicPatternLayout | Constructs a DynamicPatternLayout using the DefaultConversionPattern
| DynamicPatternLayout(String) | Constructs a DynamicPatternLayout using the supplied conversion pattern

Top
Properties

| Name | Description
--- | --- | ---
| ContentType | The content type output by this layout. (Inherited from LayoutSkeleton.)
| ConversionPattern | The pattern formatting string (Inherited from PatternLayout.)
| Footer | The footer for the layout format. (Overrides LayoutSkeleton Footer.)
| Header | The header for the layout format. (Overrides LayoutSkeleton Header.)
| IgnoresException | Flag indicating if this layout handles exceptions (Inherited from LayoutSkeleton.)

Top
Methods

| Name | Description
--- | --- | ---
| ActivateOptions | Initialize layout options (Inherited from PatternLayout.)
| AddConverter(ConverterInfo) | Add a converter to this PatternLayout (Inherited from PatternLayout.)
| AddConverter(String, Type) | Add a converter to this PatternLayout (Inherited from PatternLayout.)
| CreatePatternParser | Create the pattern parser instance (Inherited from PatternLayout.)
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
| Format(LoggingEvent) | Convenience method for easily formatting the logging event into a string variable. (Inherited from LayoutSkeleton.)
| Format(TextWriter, LoggingEvent) | Produces a formatted string as specified by the conversion pattern. (Inherited from PatternLayout.)
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.)
| GetType | Gets the Type of the current instance. (Inherited from Object.)
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.)
| ToString | Returns a String that represents the current Object. (Inherited from Object.)

Top
Remarks

This class is built on PatternLayout and provides all the features and capabilities of PatternLayout. PatternLayout is a 'static' class in that its layout is done once at configuration time. This class will recreate the layout on each reference.

One important difference between PatternLayout and DynamicPatternLayout is the treatment of the Header and Footer parameters in the configuration. The Header and Footer parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, but should not be marked as type log4net.Util.PatternString. Doing so causes the pattern to be statically converted at configuration time and causes DynamicPatternLayout to perform the same as PatternLayout.

Please see PatternLayout for complete documentation.

Examples

<layout type="log4net.Layout.DynamicPatternLayout"> <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> </layout>
See Also

#### Reference

log4net.Layout Namespace