CK-Text CK-Text
    Show / Hide Table of Contents

    Class ActivityMonitor.SourceFilter

    Manages source filtering. This default implementation (DefaultFilter(ref String, ref Int32)) handles file scope only.

    Inheritance
    Object
    ActivityMonitor.SourceFilter
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: CK.Core
    Assembly: CK.ActivityMonitor.dll
    Syntax
    public static class SourceFilter

    Fields

    | Improve this Doc View Source

    FilterSource

    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 Source

    ClearAll()

    Clears all existing filters.

    Declaration
    public static void ClearAll()
    | Improve this Doc View Source

    ClearMinimals()

    Clears all existing Minimal filters.

    Declaration
    public static void ClearMinimals()
    | Improve this Doc View Source

    ClearOverrides()

    Clears all existing Override filters.

    Declaration
    public static void ClearOverrides()
    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    SetMinimalFilter(LogFilter, String)

    Sets a minimal LogFilter for a given file. Use Undefined to clear it.

    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.

    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    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.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2015-2017 Invenietis
    Generated by DocFX