Interface IActivityLogGroup

Exposes all the relevant information for a currently opened group. Groups are linked together from the current one to the very first one thanks to the Parent property.

Namespace: CK.Core

Assembly: CK.ActivityMonitor.dll

Syntax

public interface IActivityLogGroup

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

DateTimeStamp CloseLogTime { get; }

Property Value

Type	Description
CK.Core.DateTimeStamp

| Improve this Doc View Source

Depth

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

Declaration

int Depth { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Exception

Gets the associated Exception if it exists.

Declaration

Exception Exception { get; }

Property Value

Type	Description
Exception

| 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

CKExceptionData ExceptionData { get; }

Property Value

Type	Description
CK.Core.CKExceptionData

| Improve this Doc View Source

FileName

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

Declaration

string FileName { get; }

Property Value

Type	Description
String

| 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

LogLevel GroupLevel { get; }

Property Value

Type	Description
LogLevel

| Improve this Doc View Source

GroupTags

Gets the tags for the log group.

Declaration

CKTrait GroupTags { get; }

Property Value

Type	Description
CK.Core.CKTrait

| Improve this Doc View Source

GroupText

Gets the text associated to this group.

Declaration

string GroupText { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

IsGroupTextTheExceptionMessage

Gets whether the GroupText is actually the Exception message.

Declaration

bool IsGroupTextTheExceptionMessage { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

LineNumber

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

Declaration

int LineNumber { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

LogTime

Gets the log time for the log.

Declaration

DateTimeStamp LogTime { get; }

Property Value

Type	Description
CK.Core.DateTimeStamp

| Improve this Doc View Source

MaskedGroupLevel

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

Declaration

LogLevel MaskedGroupLevel { get; }

Property Value

Type	Description
LogLevel

| Improve this Doc View Source

Parent

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

Declaration

IActivityLogGroup Parent { get; }

Property Value

Type	Description
IActivityLogGroup

| Improve this Doc View Source

SavedMonitorFilter

Gets 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

LogFilter SavedMonitorFilter { get; }

Property Value

Type	Description
LogFilter

| Improve this Doc View Source

SavedMonitorTags

Gets 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

CKTrait SavedMonitorTags { get; }

Property Value

Type	Description
CK.Core.CKTrait

Methods

| Improve this Doc View Source

EnsureExceptionData()

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

Declaration

CKExceptionData EnsureExceptionData()

Returns

Type	Description
CK.Core.CKExceptionData