Class ActivityMonitor.SourceFilter
Manages source filtering. This default implementation (DefaultFilter(ref String, ref Int32)) handles file scope only.
Inherited Members
Namespace: CK.Core
Assembly: CK.ActivityMonitor.dll
Syntax
public static class SourceFilter
Fields
| Improve this Doc View SourceFilterSource
Holds a ActivityMonitor.SourceFilter.FilterSourceDelegate that can override filter configuration and/or alter source file name. It can be changed at any time and application is immediate. It is set by default to DefaultFilter(ref String, ref Int32).
Declaration
public static ActivityMonitor.SourceFilter.FilterSourceDelegate FilterSource
Field Value
| Type | Description |
|---|---|
| ActivityMonitor.SourceFilter.FilterSourceDelegate |
Methods
| Improve this Doc View SourceClearAll()
Clears all existing filters.
Declaration
public static void ClearAll()
ClearMinimals()
Clears all existing Minimal filters.
Declaration
public static void ClearMinimals()
ClearOverrides()
Clears all existing Override filters.
Declaration
public static void ClearOverrides()
DefaultFilter(ref String, ref Int32)
Default filter, challenging file names added by SetFilter(SourceLogFilter, String) method.
Declaration
public static SourceLogFilter DefaultFilter(ref string fileName, ref int lineNumber)
Parameters
| Type | Name | Description |
|---|---|---|
| String | fileName | The file name. |
| Int32 | lineNumber | The line number. |
Returns
| Type | Description |
|---|---|
| SourceLogFilter | Defaults to Undefined. |
SetFilter(SourceLogFilter, String)
Sets a SourceLogFilter for a given file. Use Undefined to clear any existing configuration for the file.
Declaration
public static void SetFilter(SourceLogFilter filter, string fileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| SourceLogFilter | filter | The filter to set for the file. |
| String | fileName | The file name: do not specify it to inject the path of your source file. |
SetMinimalFilter(LogFilter, String)
Declaration
public static void SetMinimalFilter(LogFilter minimalFilter, string fileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| LogFilter | minimalFilter | The minimal filter to set for the file. |
| String | fileName | The file name: do not specify it to inject the path of your source file. |
SetOverrideFilter(LogFilter, String)
Sets an override LogFilter for a given file: when not Undefined this takes precedence over ActualFilter. Use Undefined to clear it.
Declaration
public static void SetOverrideFilter(LogFilter overrideFilter, string fileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| LogFilter | overrideFilter | The override filter to set for the file. |
| String | fileName | The file name: do not specify it to inject the path of your source file. |
Update(Func<String, SourceLogFilter, SourceLogFilter>)
Updates (or simply scans) all existing filters.
Declaration
public static void Update(Func<string, SourceLogFilter, SourceLogFilter> mapper)
Parameters
| Type | Name | Description |
|---|---|---|
| Func<String, SourceLogFilter, SourceLogFilter> | mapper | Function that takes the file name, the existing filter and maps it to a new filter. |
Remarks
When the mapper returns Undefined, the file configuration is removed.