Class PropertyFilter

Namespace

log4net.Filter

Assembly

log4net.dll

Simple filter to match a string an event property

public class PropertyFilter : StringMatchFilter, IFilter, IOptionHandler

Inheritance

object

FilterSkeleton

StringMatchFilter

PropertyFilter

Implements

IFilter

IOptionHandler

Derived

MdcFilter

NdcFilter

Inherited Members

StringMatchFilter.m_acceptOnMatch

StringMatchFilter.m_stringToMatch

StringMatchFilter.m_stringRegexToMatch

StringMatchFilter.m_regexToMatch

StringMatchFilter.ActivateOptions()

StringMatchFilter.AcceptOnMatch

StringMatchFilter.StringToMatch

StringMatchFilter.RegexToMatch

FilterSkeleton.Next

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Simple filter to match a string in the value for a specific event property

Constructors

PropertyFilter()

Default constructor

public PropertyFilter()

Properties

Key

The key to lookup in the event properties and then match against.

public string Key { get; set; }

Property Value

string

Remarks

The key name to use to lookup in the properties map of the LoggingEvent. The match will be performed against the value of this property if it exists.

Methods

Decide(LoggingEvent)

Check if this filter should allow the event to be logged

public override FilterDecision Decide(LoggingEvent loggingEvent)

Parameters

loggingEvent LoggingEvent

the event being logged

Returns

FilterDecision

see remarks

Remarks

The event property for the Key is matched against the StringToMatch. If the StringToMatch occurs as a substring within the property value then a match will have occurred. If no match occurs this function will return Neutral allowing other filters to check the event. If a match occurs then the value of AcceptOnMatch is checked. If it is true then Accept is returned otherwise Deny is returned.