StauffConsulting.Essentials.

IProgressReporter

C#:  
public interface IProgressReporter

VB:  
Public Interface IProgressReporter
End Interface

Type Ancestry:  IProgressReporter

Generic interface for reporting progress.

Summary Info

Constructor Summary

Field Summary

Property Summary

int ErrorCount The number of errors encountered.
int WarningCount The number of warnings encountered.

Method Summary

Clear Clears the progress report.
Indent Increase indentation by 1 level
Log Log text (without an implicit newline).
LogError Log an error.
LogException Log an exception.
LogException Log an exception.
LogLine Log a line of text.
LogWarning Log a warning.
Outdent Decrease indentation by 1 level
OutdentAll Remove all indentation levels.

Miscellany Summary

Property Details

ErrorCount

C#:  
int ErrorCount

VB:  
Property ErrorCount() As Integer

Accessors:   get and set

The number of errors encountered.

WarningCount

C#:  
int WarningCount

VB:  
Property WarningCount() As Integer

Accessors:   get and set

The number of warnings encountered.

Method Details

Clear

C#:  
static Void Clear()

VB:  
Shared Function Clear() As Void

Clears the progress report.

Indent

C#:  
static Void Indent()

VB:  
Shared Function Indent() As Void

Increase indentation by 1 level

Log

C#:  
static Void Log(string text)

VB:  
Shared Function Log(ByVal text As String) As Void

Log text (without an implicit newline).

Parameters

text  

LogError

C#:  
static Void LogError(string descr)

VB:  
Shared Function LogError(ByVal descr As String) As Void

Log an error. The implementation of this method should add any appropriate prefix such as "*** ERROR: "; callers of this method should not.

Parameters

descr  

LogException

C#:  
static Void LogException(System.Exception x,
    string context)

VB:  
Shared Function LogException(ByVal x As System.Exception, ByVal context As String) As Void

Log an exception. The implementation of this method should add any appropriate prefix such as "*** EXCEPTION: "; callers of this method should not.

Parameters

x  
context   descriptive info about where the exception occurred

LogException

C#:  
static Void LogException(System.Exception x)

VB:  
Shared Function LogException(ByVal x As System.Exception) As Void

Log an exception. The implementation of this method should add any appropriate prefix such as "*** EXCEPTION: "; callers of this method should not.

Parameters

x  

LogLine

C#:  
static Void LogLine(string descr)

VB:  
Shared Function LogLine(ByVal descr As String) As Void

Log a line of text.

Parameters

descr  

LogWarning

C#:  
static Void LogWarning(string descr)

VB:  
Shared Function LogWarning(ByVal descr As String) As Void

Log a warning. The implementation of this method should add any appropriate prefix such as "* WARNING: "; callers of this method should not.

Parameters

descr  

Outdent

C#:  
static Void Outdent()

VB:  
Shared Function Outdent() As Void

Decrease indentation by 1 level

OutdentAll

C#:  
static Void OutdentAll()

VB:  
Shared Function OutdentAll() As Void

Remove all indentation levels.

generated by DocGenDotNet on 18 Nov 2008 6:35:01 PM