API Reference
InternalLogger
Internal logger that allows to write to console, error or wherever else is needed
Inheritance
- Object
- InternalLogger
Constructors
public InternalLogger(Boolean isVerbose = false) #Initialize logger
Parameters
- isVerbose System.Boolean = false
Methods
public Void WriteDebug(String message, params Object[] args) #VoidWrites a formatted debug message.
Parameters
- message System.String
- Composite format string.
- args System.Object[]
- Format arguments.
public Void WriteError(String message) #VoidWrites an error message.
Parameters
- message System.String
- Error text.
public Void WriteError(String message, params Object[] args) #VoidWrites a formatted error message.
Parameters
- message System.String
- Composite format string.
- args System.Object[]
- Format arguments.
public Void WriteError(Exception exception, String message = null, params Object[] args) #VoidWrites an error with an associated exception.
Parameters
- exception System.Exception
- Exception to include.
- message System.String = null
- Optional message template.
- args System.Object[]
- Optional template arguments.
public Void WriteInformation(String message, params Object[] args) #VoidWrites a formatted information message.
Parameters
- message System.String
- Composite format string.
- args System.Object[]
- Format arguments.
public Void WriteProgress(String activity, String currentOperation, Int32 percentCompleted, Nullable<Int32> currentSteps = null, Nullable<Int32> totalSteps = null) #VoidWrites a progress update and raises the OnProgressMessage event.
Parameters
- activity System.String
- Top-level activity label.
- currentOperation System.String
- Current operation/phase.
- percentCompleted System.Int32
- Completion percentage.
- currentSteps System.Nullable{System.Int32} = null
- Optional current step of a multi-step activity.
- totalSteps System.Nullable{System.Int32} = null
- Optional total steps of a multi-step activity.
public Void WriteVerbose(String message) #VoidWrites a verbose message.
Parameters
- message System.String
- Message text.
public Void WriteVerbose(String message, params Object[] args) #VoidWrites a formatted verbose message.
Parameters
- message System.String
- Composite format string.
- args System.Object[]
- Format arguments.
public Void WriteWarning(String message) #VoidWrites a warning message.
Parameters
- message System.String
- Warning text.
public Void WriteWarning(String message, params Object[] args) #VoidWrites a formatted warning message.
Parameters
- message System.String
- Composite format string.
- args System.Object[]
- Format arguments.
public Void WriteWarning(Exception exception, String message = null, params Object[] args) #VoidWrites a warning with an associated exception.
Parameters
- exception System.Exception
- Exception to include.
- message System.String = null
- Optional message template.
- args System.Object[]
- Optional template arguments.
Inherited Methods
Properties
public Boolean IsVerbose { get; set; } #If true, will write verbose messages to console
public Boolean IsError { get; set; } #If true, will write error messages to console
public Boolean IsWarning { get; set; } #If true, will write warning messages to console
public Boolean IsDebug { get; set; } #If true, will write debug messages to console
public Boolean IsInformation { get; set; } #If true, will write information messages to console
public Boolean IsProgress { get; set; } #if true, will write progress messages to console
Events
public event EventHandler<LogEventArgs> OnVerboseMessage #Define Verbose message event
public event EventHandler<LogEventArgs> OnWarningMessage #Define Warning message event
public event EventHandler<LogEventArgs> OnErrorMessage #Define Error message event
public event EventHandler<LogEventArgs> OnDebugMessage #Define Debug message event
public event EventHandler<LogEventArgs> OnProgressMessage #Define Progress message event
public event EventHandler<LogEventArgs> OnInformationMessage #Define Information message event