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

    Class ActivityMonitorTextHelperClient

    Base class for IActivityMonitorClient that tracks groups and level changes in order to ease text-based renderer.

    Inheritance
    Object
    ActivityMonitorTextHelperClient
    ActivityMonitorTextWriterClient
    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 abstract class ActivityMonitorTextHelperClient : IActivityMonitorBoundClient, IActivityMonitorClient

    Constructors

    | Improve this Doc View Source

    ActivityMonitorTextHelperClient()

    Initialize a new ActivityMonitorTextHelperClient.

    Declaration
    protected ActivityMonitorTextHelperClient()
    | Improve this Doc View Source

    ActivityMonitorTextHelperClient(LogFilter)

    Initialize a new ActivityMonitorTextHelperClient with a filter.

    Declaration
    protected ActivityMonitorTextHelperClient(LogFilter filter)
    Parameters
    Type Name Description
    LogFilter filter

    Properties

    | Improve this Doc View Source

    Filter

    Gets or sets the filter for this client.

    Declaration
    public LogFilter Filter { get; set; }
    Property Value
    Type Description
    LogFilter

    Methods

    | Improve this Doc View Source

    OnContinueOnSameLevel(ActivityMonitorLogData)

    Called for text with the same LogLevel as the previous ones.

    Declaration
    protected abstract void OnContinueOnSameLevel(ActivityMonitorLogData data)
    Parameters
    Type Name Description
    ActivityMonitorLogData data

    Log data.

    | Improve this Doc View Source

    OnEnterLevel(ActivityMonitorLogData)

    Called for the first text of a LogLevel.

    Declaration
    protected abstract void OnEnterLevel(ActivityMonitorLogData data)
    Parameters
    Type Name Description
    ActivityMonitorLogData data

    Log data.

    | Improve this Doc View Source

    OnGroupClose(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)

    Called when the group is actually closed.

    Declaration
    protected abstract void OnGroupClose(IActivityLogGroup group, IReadOnlyList<ActivityLogGroupConclusion> conclusions)
    Parameters
    Type Name Description
    IActivityLogGroup group

    The closing group.

    IReadOnlyList<ActivityLogGroupConclusion> conclusions

    Texts that concludes the group. Never null but can be empty.

    | Improve this Doc View Source

    OnGroupOpen(IActivityLogGroup)

    Called whenever a group is opened.

    Declaration
    protected abstract void OnGroupOpen(IActivityLogGroup group)
    Parameters
    Type Name Description
    IActivityLogGroup group

    The newly opened group.

    | Improve this Doc View Source

    OnLeaveLevel(LogLevel)

    Called when current log level changes.

    Declaration
    protected abstract void OnLeaveLevel(LogLevel level)
    Parameters
    Type Name Description
    LogLevel level

    The previous log level (without IsFiltered).

    Explicit Interface Implementations

    | Improve this Doc View Source

    IActivityMonitorBoundClient.IsDead

    Declaration
    bool IActivityMonitorBoundClient.IsDead { get; }
    Returns
    Type Description
    Boolean
    Implements
    IActivityMonitorBoundClient.IsDead
    | Improve this Doc View Source

    IActivityMonitorBoundClient.MinimalFilter

    Declaration
    LogFilter IActivityMonitorBoundClient.MinimalFilter { get; }
    Returns
    Type Description
    LogFilter
    Implements
    IActivityMonitorBoundClient.MinimalFilter
    | Improve this Doc View Source

    IActivityMonitorBoundClient.SetMonitor(IActivityMonitorImpl, Boolean)

    Declaration
    void IActivityMonitorBoundClient.SetMonitor(IActivityMonitorImpl source, bool forceBuggyRemove)
    Parameters
    Type Name Description
    IActivityMonitorImpl source
    Boolean forceBuggyRemove
    Implements
    IActivityMonitorBoundClient.SetMonitor(IActivityMonitorImpl, Boolean)
    | Improve this Doc View Source

    IActivityMonitorClient.OnAutoTagsChanged(CKTrait)

    Declaration
    void IActivityMonitorClient.OnAutoTagsChanged(CKTrait newTrait)
    Parameters
    Type Name Description
    CK.Core.CKTrait newTrait
    Implements
    IActivityMonitorClient.OnAutoTagsChanged(CKTrait)
    | Improve this Doc View Source

    IActivityMonitorClient.OnGroupClosed(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)

    Declaration
    void IActivityMonitorClient.OnGroupClosed(IActivityLogGroup group, IReadOnlyList<ActivityLogGroupConclusion> conclusions)
    Parameters
    Type Name Description
    IActivityLogGroup group
    IReadOnlyList<ActivityLogGroupConclusion> conclusions
    Implements
    IActivityMonitorClient.OnGroupClosed(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)
    | Improve this Doc View Source

    IActivityMonitorClient.OnGroupClosing(IActivityLogGroup, ref List<ActivityLogGroupConclusion>)

    Declaration
    void IActivityMonitorClient.OnGroupClosing(IActivityLogGroup group, ref List<ActivityLogGroupConclusion> conclusions)
    Parameters
    Type Name Description
    IActivityLogGroup group
    List<ActivityLogGroupConclusion> conclusions
    Implements
    IActivityMonitorClient.OnGroupClosing(IActivityLogGroup, ref List<ActivityLogGroupConclusion>)
    | Improve this Doc View Source

    IActivityMonitorClient.OnOpenGroup(IActivityLogGroup)

    Declaration
    void IActivityMonitorClient.OnOpenGroup(IActivityLogGroup group)
    Parameters
    Type Name Description
    IActivityLogGroup group
    Implements
    IActivityMonitorClient.OnOpenGroup(IActivityLogGroup)
    | Improve this Doc View Source

    IActivityMonitorClient.OnTopicChanged(String, String, Int32)

    Declaration
    void IActivityMonitorClient.OnTopicChanged(string newTopic, string fileName, int lineNumber)
    Parameters
    Type Name Description
    String newTopic
    String fileName
    Int32 lineNumber
    Implements
    IActivityMonitorClient.OnTopicChanged(String, String, Int32)
    | Improve this Doc View Source

    IActivityMonitorClient.OnUnfilteredLog(ActivityMonitorLogData)

    Declaration
    void IActivityMonitorClient.OnUnfilteredLog(ActivityMonitorLogData data)
    Parameters
    Type Name Description
    ActivityMonitorLogData data
    Implements
    IActivityMonitorClient.OnUnfilteredLog(ActivityMonitorLogData)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2015-2017 Invenietis
    Generated by DocFX