Class ActivityMonitor.Group

Groups are bound to an ActivityMonitor and are linked together from the current one to the very first one (a kind of stack).

Inheritance
Object
ActivityMonitor.Group
Inherited Members
Namespace: CK.Core
Assembly: CK.ActivityMonitor.dll
Syntax
protected sealed class Group : IActivityLogGroup, IDisposableGroup, IDisposable

Fields

| Improve this Doc View Source

Index

The raw index of the group.

Declaration
public readonly int Index
Field Value
Type Description
Int32
| Improve this Doc View Source

Monitor

The monitor that owns this group.

Declaration
public readonly ActivityMonitor Monitor
Field Value
Type Description
ActivityMonitor

Properties

| Improve this Doc View Source

CloseLogTime

Gets the log time of the group closing. It is CK.Core.DateTimeStamp.MinValue when the group is not closed yet.

Declaration
public DateTimeStamp CloseLogTime { get; }
Property Value
Type Description
CK.Core.DateTimeStamp
Implements
| Improve this Doc View Source

Depth

Gets the depth of this group in its origin monitor (1 for top level groups).

Declaration
public int Depth { get; }
Property Value
Type Description
Int32
Implements
| Improve this Doc View Source

Exception

Gets the associated Exception if it exists.

Declaration
public Exception Exception { get; }
Property Value
Type Description
Exception
Implements
| Improve this Doc View Source

ExceptionData

Gets the CK.Core.CKExceptionData that captures exception information if it exists. Returns null if no Exception exists.

Declaration
public CKExceptionData ExceptionData { get; }
Property Value
Type Description
CK.Core.CKExceptionData
Implements
| Improve this Doc View Source

FileName

Gets the file name of the source code that issued the log.

Declaration
public string FileName { get; }
Property Value
Type Description
String
Implements
| Improve this Doc View Source

GroupLevel

Gets the level associated to this group. The IsFiltered can be set here: use MaskedGroupLevel to get the actual level from Trace to Fatal.

Declaration
public LogLevel GroupLevel { get; }
Property Value
Type Description
LogLevel
Implements
| Improve this Doc View Source

GroupTags

Gets the tags for the log group.

Declaration
public CKTrait GroupTags { get; }
Property Value
Type Description
CK.Core.CKTrait
Implements
| Improve this Doc View Source

GroupText

Gets the text with which this group has been opened. Null if and only if the group is closed.

Declaration
public string GroupText { get; }
Property Value
Type Description
String
Implements
| Improve this Doc View Source

IsGroupTextTheExceptionMessage

Gets whether the GroupText is actually the Exception message.

Declaration
public bool IsGroupTextTheExceptionMessage { get; }
Property Value
Type Description
Boolean
Implements
| Improve this Doc View Source

IsRejectedGroup

Gets whether the group is rejected.

Declaration
public bool IsRejectedGroup { get; }
Property Value
Type Description
Boolean
Implements
| Improve this Doc View Source

LineNumber

Gets the line number of the FileName that issued the log.

Declaration
public int LineNumber { get; }
Property Value
Type Description
Int32
Implements
| Improve this Doc View Source

LogTime

Gets the log time for the log.

Declaration
public DateTimeStamp LogTime { get; }
Property Value
Type Description
CK.Core.DateTimeStamp
Implements
| Improve this Doc View Source

MaskedGroupLevel

Gets the actual level (from Trace to Fatal) associated to this group without IsFiltered bit.

Declaration
public LogLevel MaskedGroupLevel { get; }
Property Value
Type Description
LogLevel
Implements
| Improve this Doc View Source

Parent

Get the previous group in its origin monitor. Null if this group is a top level group.

Declaration
public IActivityLogGroup Parent { get; }
Property Value
Type Description
IActivityLogGroup
Implements
| Improve this Doc View Source

SavedMonitorFilter

Gets or sets the MinimalFilter that will be restored when group will be closed. Initialized with the current value of IActivityMonitor.Filter when the group has been opened.

Declaration
public LogFilter SavedMonitorFilter { get; }
Property Value
Type Description
LogFilter
Implements
| Improve this Doc View Source

SavedMonitorTags

Gets or sets the AutoTags that will be restored when group will be closed. Initialized with the current value of IActivityMonitor.Tags when the group has been opened.

Declaration
public CKTrait SavedMonitorTags { get; }
Property Value
Type Description
CK.Core.CKTrait
Implements

Methods

| Improve this Doc View Source

EnsureExceptionData()

Gets or creates the CK.Core.CKExceptionData that captures exception information. If Exception is null, this returns null.

Declaration
public CKExceptionData EnsureExceptionData()
Returns
Type Description
CK.Core.CKExceptionData
Implements

Explicit Interface Implementations

| Improve this Doc View Source

IDisposableGroup.ConcludeWith(Func<String>)

Declaration
IDisposable IDisposableGroup.ConcludeWith(Func<string> getConclusionText)
Parameters
Type Name Description
Func<String> getConclusionText
Returns
Type Description
IDisposable
Implements
| Improve this Doc View Source

IDisposable.Dispose()

Ensures that any groups opened after this one are closed before closing this one.

Declaration
void IDisposable.Dispose()
Implements