IGLib  1.5
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
IG.Forms.ReporterForms Class Reference

Reporting system that in particular utilizes forms. Beside the main delegates for assembling location and message strings, this class has three additional delegates for each kind of reporting (i.e. reporting with console consform, message box, fading message or console) More...

+ Inheritance diagram for IG.Forms.ReporterForms:
+ Collaboration diagram for IG.Forms.ReporterForms:

Public Member Functions

 ReporterForms ()
 Constructor. Initializes all error reporting delegates to default values and sets auxliary object to null. Auxiliary object Obj is set to null. More...
 
 ReporterForms (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate, ReserveReportErrorDelegate reservereportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates that are not specified (have a null reference) are set to default values. More...
 
 ReporterForms (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates that are not specified are set to default values. More...
 
 ReporterForms (object obj, ReportDelegate reportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and the delegate to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates for assembling the error location string and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
 ReporterForms (object obj, ReportDelegate reportdelegate, ReserveReportErrorDelegate reservereportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates for assembling the error locatin and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
override void Report (ReportType messagetype, string location, string message, Exception ex)
 Basic method for reporting by this class (i.e., reporting by forms). More...
 
- Public Member Functions inherited from IG.Lib.ReporterBase
 ReporterBase ()
 Constructor. Initializes all error reporting delegates to default values and sets auxliary object to null. Auxiliary object Obj is set to null. More...
 
 ReporterBase (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate, ReserveReportErrorDelegate reservereportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates that are not specified are set to default values. More...
 
 ReporterBase (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates that are not specified are set to default values. More...
 
 ReporterBase (object obj, ReportDelegate reportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and the delegate to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates for assembling the error location string and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
 ReporterBase (object obj, ReportDelegate reportdelegate, ReserveReportErrorDelegate reservereportdelegate)
 Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates for assembling the error locatin and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
void Init (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate, ReserveReportErrorDelegate reservereportdelegate)
 Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates that are not specified are set to default values. More...
 
void Init ()
 Initializes all error reporting delegates to default values and sets auxliary object to null. Auxiliary object Obj is set to null. More...
 
void Init (object obj, ReportDelegate reportdelegate, ReportLocationDelegate locationdelegate, ReportMessageDelegate messagedelegate)
 Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates that are not specified are set to default values. More...
 
void Init (object obj, ReportDelegate reportdelegate)
 Initializes the error reporter by the specified auxiliary object and the delegate to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates for assembling the error location string and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
void Init (object obj, ReportDelegate reportdelegate, ReserveReportErrorDelegate reservereportdelegate)
 Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates for assembling the error locatin and error message string are set to their default values, which are adapted to console-like eror reporting systems. More...
 
void Dispose ()
 
bool AppSettingsRead (string groupname)
 Returns a flag that tells whether configuration settings with a given group name have already been read for this reporter. More...
 
bool AppSettingsRead ()
 Returns a flag that tells whether general configuration settings (not belonging to any group) have already been read for this reporter. More...
 
void ReadAppSettings (string groupname, bool onlyonce)
 Reads settings for a specified named group of reporters from the application configuration file. More...
 
void ReadAppSettings (string groupname)
 Reads settings for a specified named group of reporters from the application configuration file. More...
 
void ReadAppSettings ()
 Reads common reporter settings (i.e. settings that are not assigned for any named group) from the application configuration file. More...
 
void IncreaseDepth ()
 Increases indentation level by 1. More...
 
void IncreaseDepth (int numlevels)
 Increases indentation level by the specified number of levels (can be 0 or negative). More...
 
void DecreaseDepth ()
 Decreases indentation level by 1. More...
 
void DecreaseDepth (int numlevels)
 Decreases indentation level by the specified number of levels (can be 0 or negative). More...
 
void ResetLevels ()
 Resets the various kinds of reporting levels to default values. More...
 
bool DoReporting (ReportType reptype)
 Returns true if the report of a given type should be shown by user interface (according to ReportingLevel), and false if not. More...
 
bool DoLogging (ReportType reptype)
 Returns true if the report of a given type should be logged in log files (according to ReportingLevel), and false if not. More...
 
bool DoTracing (ReportType reptype)
 Returns true if the report of a given type should traced (according to ReportingLevel), and false if not. More...
 
void Report (ReportType messagetype, string message, Exception ex)
 Launches a report. Predominantly for error and warning reports. More...
 
void Report (ReportType messagetype, Exception ex, string location)
 Launches a report. Predominantly for error and warning reports. More...
 
void Report (ReportType messagetype, Exception ex)
 Launches a report. Predominantly for error and warning reports. More...
 
void Report (ReportType messagetype, string location, string message)
 Launches a report. More...
 
void Report (ReportType messagetype, string message)
 Launches a report. More...
 
void ReportError (string location, string message, Exception ex)
 Basic error reporting method (overloaded). Supplemental data (such as objects necessary to launch visualize the report or operation flags) are obtained from the class' instance. More...
 
void ReportError (string message, Exception ex)
 Launches an error report. More...
 
void ReportError (Exception ex, string location)
 Launches an error report. More...
 
void ReportError (Exception ex)
 Launches an error report. Predominantly for error and warning reports. More...
 
void ReportError (string location, string message)
 Launches an error report. More...
 
void ReportError (string message)
 Launches an error report. More...
 
void ReportWarning (string location, string message, Exception ex)
 Basic warning reporting method (overloaded). Supplemental data (such as objects necessary to launch visualize the report or operation flags) are obtained from the class' instance. More...
 
void ReportWarning (string message, Exception ex)
 Launches a warning report. More...
 
void ReportWarning (Exception ex, string location)
 Launches a warning report. More...
 
void ReportWarning (Exception ex)
 Launches a warning report. Predominantly for error and warning reports. More...
 
void ReportWarning (string location, string message)
 Launches a warning report. More...
 
void ReportWarning (string message)
 Launches a warning report. More...
 
void ReportInfo (Exception ex)
 Launches an info. More...
 
void ReportInfo (string location, string message)
 Launches an info. More...
 
void ReportInfo (string message)
 Launches an info. More...
 
bool SetTW (ref TextWriter tw, ref bool disptw, string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter upon a file and sets it as the text writer to which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool SetTextWriter (TextWriter writer)
 Sets the text writer to which reporting is also performed. More...
 
bool SetTextWriter (TextWriter writer, bool writeintro)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextWriter (TextWriter writer, bool writeintro, bool disposewriter)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextWriter (Stream stream)
 Creates a TextWriter upon the stream and sets it as the text writer to which reporting is also performed. More...
 
bool SetTextWriter (Stream stream, bool writeintro)
 Creates a TextWriter upon the stream and sets it as the basic TextWriter to which reporting is performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextWriter (Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter upon the stream and sets it as the basic TextWriter to which reporting is performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextWriter (string filename)
 Creates a TextWriter upon a file and sets it as the basic TextWriter to which reporting is also performed. The file is overwritten. More...
 
bool SetTextWriter (string filename, bool append)
 Creates a TextWriter upon a file and sets it as the basic TextWriter to which reporting is also performed, where the caller specifies either to overwrite the file or to append to it. More...
 
bool SetTextWriter (string filename, bool append, bool writeintro)
 Creates a TextWriter upon a file and sets it as the text writer to which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool SetTextWriter (string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter upon a file and sets it as the text writer to which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool AddTextWriter (TextWriter writer)
 Sets the text writer to which reporting is also performed. More...
 
bool AddTextWriter (TextWriter writer, bool writeintro)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextWriter (TextWriter writer, bool writeintro, bool disposewriter)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextWriter (Stream stream)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. More...
 
bool AddTextWriter (Stream stream, bool writeintro)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextWriter (Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextWriter (string filename)
 Creates a TextWriter from the file name and adds it to the list of TextWriters on which reporting is also performed. The file is overwritten. More...
 
bool AddTextWriter (string filename, bool append)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies either to overwrite the file or to append to it. More...
 
bool AddTextWriter (string filename, bool append, bool writeintro)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool AddTextWriter (string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool RemoveTextWriters ()
 Removes all text writers from the TextWriter subsystem. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextWriter ()
 Removes the default text writer from the TextWriter subsystem. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextWriter (TextWriter writer)
 Removes the first object from Writers that contains the specified TextWriter. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextWriter (Stream stream)
 Removes the first object from Writers whose TextWriter has been created form the specified stream. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextWriter (string filename)
 Removes the first object from Writers whose TextWriter has been created form the file with the specified name. If appropriate, the corresponding text writer is closed. More...
 
List< TextWriter > TextWriterWriters ()
 Returns a list of all text writers that are currently used by the reporter's text writer. Only text writers that are actually writable are included. More...
 
List< TextWriter > TextWriterWriters (bool writableonly)
 Returns a list of all text writers that are currently used by the reporter's text writer. Warning: Beware of thread safety issues! Blocks of code where the returned list is used should be enclosed in lock(reporter.lockobj){...} block (where reporter is the object through which this method was called). More...
 
int TextWriterNumWriters ()
 Returns the current number of text writers used by the reporter's text logging module. Only text writers that are actually writable are counted. More...
 
int TextWriterNumWriters (bool writableonly)
 Returns the current number of TextWriters used by the reporter's text logging module. More...
 
int TextWriterFlush ()
 Flushes all text writers of the Writer's TextWriter subsystem. More...
 
int TextWriterWrite (string str)
 Writes a string to all text writers of the Writer's TextWriter subsystem. More...
 
int TextWriterWriteLine (string str)
 Similar to TextWriterWrite(), except that a newline is added at the end of the string. More...
 
bool SetTextLogger (TextWriter writer)
 Sets the text writer to which reporting is also performed. More...
 
bool SetTextLogger (TextWriter writer, bool writeintro)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextLogger (TextWriter writer, bool writeintro, bool disposewriter)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextLogger (Stream stream)
 Creates a TextWriter upon the stream and sets it as the text writer to which reporting is also performed. More...
 
bool SetTextLogger (Stream stream, bool writeintro)
 Creates a TextWriter upon the stream and sets it as the basic TextWriter to which reporting is performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextLogger (Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter upon the stream and sets it as the basic TextWriter to which reporting is performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTextLogger (string filename)
 Creates a TextWriter upon a file and sets it as the basic TextWriter to which reporting is also performed. The file is overwritten. More...
 
bool SetTextLogger (string filename, bool append)
 Creates a TextWriter upon a file and sets it as the basic TextWriter to which reporting is also performed, where the caller specifies either to overwrite the file or to append to it. More...
 
bool SetTextLogger (string filename, bool append, bool writeintro)
 Creates a TextWriter upon a file and sets it as the text writer to which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool SetTextLogger (string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter upon a file and sets it as the text writer to which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool AddTextLogger (TextWriter writer)
 Sets the text writer to which reporting is also performed. More...
 
bool AddTextLogger (TextWriter writer, bool writeintro)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextLogger (TextWriter writer, bool writeintro, bool disposewriter)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextLogger (Stream stream)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. More...
 
bool AddTextLogger (Stream stream, bool writeintro)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextLogger (Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTextLogger (string filename)
 Creates a TextWriter from the file name and adds it to the list of TextWriters on which reporting is also performed. The file is overwritten. More...
 
bool AddTextLogger (string filename, bool append)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies either to overwrite the file or to append to it. More...
 
bool AddTextLogger (string filename, bool append, bool writeintro)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool AddTextLogger (string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool RemoveTextLoggers ()
 Removes all text writers from the TextLogger subsystem. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextLogger ()
 Removes the default text writer from the TextLogger subsystem. If appropriate, the corresponding txt writer is closed. More...
 
bool RemoveTextLogger (TextWriter writer)
 Removes the first object from Loggers that contains the specified TextWriter. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextLogger (Stream stream)
 Removes the first object from Loggers whose TextWriter has been created form the specified stream. If appropriate, the corresponding text writer is closed. More...
 
bool RemoveTextLogger (string filename)
 Removes the first object from Loggers whose TextWriter has been created form the file with the specified name. If appropriate, the corresponding text writer is closed. More...
 
List< TextWriter > TextLoggerWriters ()
 Returns a list of all text writers that are currently used by the reporter's text logger. Only text writers that are actually writable are included. More...
 
List< TextWriter > TextLoggerWriters (bool writableonly)
 Returns a list of all text writers that are currently used by the reporter's text logger. Warning: Beware of thread safety issues! Blocks of code where the returned list is used should be enclosed in lock(reporter.lockobj){...} block (where reporter is the object through which this method was called). More...
 
int TextLoggerNumWriters ()
 Returns the current number of text writers used by the reporter's text logging module. Only text writers that are actually writable are counted. More...
 
int TextLoggerNumWriters (bool writableonly)
 Returns the current number of TextWriters used by the reporter's text logging module. More...
 
int TextLoggerFlush ()
 Flushes all text writers of the Writer's TextLogger subsystem. More...
 
int TextLoggerWrite (string str)
 Writes a string to all text writers of the Writer's TextLogger subsystem. More...
 
int TextLoggerWriteLine (string str)
 Similar to TextLoggerWrite(), except that a newline is added at the end of the string. More...
 

Static Public Member Functions

static void DefaultReserveReportErrorForms (ReporterBase reporter, ReportType messagetype, string location, string message, Exception ex, Exception ex1)
 Default function function for reserve error reporting (called if an exception is thrown in an error reporting function): More...
 
- Static Public Member Functions inherited from IG.Lib.ReporterBase
static Exception ReviseException (Exception ex, string messageaddition, Type newtype, bool sametype, bool keepmessage, bool oldasinner)
 Takes an existing exception and returns a modified exception based on it. More...
 
static Exception ReviseException (Exception ex, string messageaddition)
 Takes an existing exception and returns a modified exception based on it. The returned exception is of the same type as the original one. Original message is appended to messageaddition . The created exception does not have an inner exception. More...
 
static Exception ReviseException (Exception ex, string messageaddition, bool keepmessage)
 Takes an existing exception and returns a modified exception based on it. The returned exception is of the same type as the original one. The created exception does not have an inner exception. More...
 
static Exception ReviseException (Exception ex, string messageaddition, bool keepmessage, bool oldasinner)
 Takes an existing exception and returns a modified exception based on it. The returned exception is of the same type as the original one. More...
 
static Exception ReviseException (Exception ex, string messageaddition, Type newtype)
 Takes an existing exception and returns a modified exception based on it. Original message is appended to messageaddition . The created exception does not have an inner exception. More...
 
static Exception ReviseException (Exception ex, string messageaddition, Type newtype, bool keepmessage)
 Takes an existing exception and returns a modified exception based on it. The created exception does not have an inner exception. More...
 
static Exception ReviseException (Exception ex, string messageaddition, Type newtype, bool keepmessage, bool oldasinner)
 Takes an existing exception and returns a modified exception based on it. More...
 
static void GetAppSetting (string key, ref string value, out bool assigned)
 Reads a string value from the application configuration file (e.g. app.config) and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref char value, out bool assigned)
 Reads a character value from the application configuration file and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref List< char > value, out bool assigned)
 Reads a list of characters from the application configuration file and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref int value, out bool assigned)
 Reads an integer value from the application configuration file and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref double value, out bool assigned)
 Reads a floating point value from the application configuration file and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref bool value, out bool assigned)
 Reads a boolean value from the application configuration file and assigns it to the specified variable. Numerical representation is allowed (0 for false, non-zero for true) More...
 
static void GetAppSetting (string key, ref bool value, out bool assigned, bool otherformatsallowed)
 Reads a boolean value from the application configuration file and assigns it to the specified variable. More...
 
static void GetAppSetting (string key, ref ReportLevel value, out bool assigned)
 Reads an integer value from the application configuration file and assigns it to the specified variable. More...
 
static bool DoLaunch (ReportType reptype, ReportLevel replevel)
 Returns true if the report of a given type will be launched at the given reporting level, and false if not. More...
 
static EventLogEntryType ReportType2EventLogEntryType (ReportType rt)
 Returns the System.Diagnostics.EventLogEntryType value corresponding to the given ReportType. Remark: FailureAudit and SuccessAudit can not be generated because they don't have representation in ReportType. More...
 
static ReportType EventLogEntryType2ReportType (EventLogEntryType el)
 Returns the ReportType value corresponding to the given System.Diagnostics.EventLogEntryType. Remark: FailureAudit and SuccessAudit do not have representation in ReportType and are mapped to Error and Warning, respectively. More...
 
static TraceLevel ReportLevel2TraceLevel (ReportLevel level)
 Returns the System.Diagnostics.TraceLevel value corresponding to the given ReportLevel. More...
 
static ReportLevel TraceLevel2ReportLevel (TraceLevel tl)
 Returns the ReportLevel value corresponding to the given System.Diagnostics.TraceLevel. More...
 
static string FormatLogMsgDefault (int depth, int initialindent, int indentincrement, char indentchar, ReportType type, string location, string message, ReportSource source)
 Formats a one-line message for tracing output. More...
 
static string FormatTraceMsgDefault (int depth, int initialindent, int indentincrement, char indentchar, ReportType type, string location, string message, ReportSource source)
 Formats a one-line message for tracing output. More...
 
static string DefaultReportStringMessageBox (ReporterBase reporter, ReportType messagetype, string errorlocation, string errormessage)
 Auxiliary method that composes the complete message, including decoration, for reports launched in a message box. More...
 
static string DefaultReportStringConsole (ReporterBase reporter, ReportType messagetype, string errorlocation, string errormessage)
 Auxiliary method that composes the complete message, including decoration, for reports launched in consoles. More...
 
static string DefaultReportStringConsoleTimeStamp (ReporterBase reporter, ReportType messagetype, string errorlocation, string errormessage)
 Auxiliary method that composes the complete message, including decoration with a TIMESTAMP, for reports launched in consoles. More...
 
static string DefaultReportStringConsoleBas (ReporterBase reporter, ReportType messagetype, string errorlocation, string errormessage, bool timestamp)
 Base method for DefaultReportStringConsole and DefaultReportStringConsoleTimeStamp. More...
 
static void DefaultReportConsole (ReporterBase reporter, ReportType messagetype, string errorlocation, string errormessage)
 Default delegate for reporting. For parameter descriptions, see ReportDlg. More...
 
static string DefaultLocationString (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Default delegate for assembly of the location string when reporting on consoles. For parameter descriptions, see ReportMessageDlg. More...
 
static string DefaultMessageString (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Default delegate for message assembly of the message string when reporting on consoles. For parameter descriptions, see ReportMessageDlg. More...
 
static string DefaultReserveReportMessage (ReporterBase reporter, ReportType messagetype, string location, string message, Exception ex, Exception ex1)
 Default function function for assembling reserve error reporting message. This is put outside the DefaultReserveReportError() method such that the same assembly method can be used in different systems. The method is considered bulletproof.
Parameters
messagetypeLevel of the message (Error, Warning,Info, etc.)
locationLocation string as passed to the error reporting function that has thrown an exception.
messageError message string as passed to the error reporting function that has thrown an exception.
exOriginal exception that was being reported when the error reporting function threw an exception.
ex1Exception thrown by the error reporting function.
More...
 
static void DefaultReserveReportError (ReporterBase reporter, ReportType messagetype, string location, string message, Exception ex, Exception ex1)
 Default function function for reserve error reporting (called if an exception is thrown in a reporting function). Writes a report to the application's standard console (if defined) and Reporter's text writers and loggers (when defined). Writing is unconditional (e.g., even if reporter.UseTextWriter = false or reporter.ReportingLevel = Off, a message is written to the TextWriter's output streams). More...
 
static string ErrorLocationString0 (Exception ex)
 Returns location string derived from ex, which includes information about the location where error occurred, specified by the source file name, function and line and column numbers. More...
 
static string ErrorLocationString0 (string location, Exception ex)
 Returns Error location string derived from ex, which includes information about location of error occurrence and is prepended by additional location information (such as class name) More...
 

Public Attributes

ConsoleForm ConsoleForm = null
 Console consform used for reporting. If null then global console consform is used (this is the matter of delegate methods). More...
 
ReportDelegate ReportDlgConsoleForm = new ReportDelegate(DefaultReport_ConsoleForm)
 Delegate that performs error reporting via console consform. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlgConsoleForm = new ReportLocationDelegate(DefaultReportLocation_ConsoleForm)
 Delegate that assembles the error location string for reporting via console consform. More...
 
ReportMessageDelegate ReportMessageDlgConsoleForm = new ReportMessageDelegate(DefaultReportMessage_ConsoleForm)
 Delegate that assembles the eror message string for reporting via console consform. More...
 
int FadeMessageShowtime = 4000
 Fading message visibility time in milliseconds. More...
 
double FadeMessageFadingTimePortion = 0.25
 Portion of visibility time when the message is fading. More...
 
Color FadeMessageBackColor = Color.Orange
 Actibe background color of the fading message. More...
 
Color FadeMessageBackColorFinal = Color.DarkGray
 Final (fade) background color of the fading message. More...
 
Color FadeMessageForeColor = Color.Blue
 Text color of the fading message. More...
 
ReportDelegate ReportDlgFadeMessage = new ReportDelegate(DefaultReport_FadeMessage)
 Delegate that performs error reporting via fading message. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlgFadeMessage = new ReportLocationDelegate(DefaultReportLocation_FadeMessage)
 Delegate that assembles the error location string for reporting via fading message. More...
 
ReportMessageDelegate ReportMessageDlgFadeMessage = new ReportMessageDelegate(DefaultReportMessage_FadeMessage)
 Delegate that assembles the eror message string for reporting via fading message. More...
 
ReportDelegate ReportDlgConsole = new ReportDelegate(DefaultReport_Console)
 Delegate that performs error reporting via console. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlgConsole = new ReportLocationDelegate(DefaultReportLocation_Console)
 Delegate that assembles the error location string for reporting via console. More...
 
ReportMessageDelegate ReportMessageDlgConsole = new ReportMessageDelegate(DefaultReportMessage_Console)
 Delegate that assembles the eror message string for reporting via console. More...
 
ReportDelegate ReportDlgMessageBox = new ReportDelegate(DefaultReport_MessageBox)
 Delegate that performs error reporting via message box. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlgMessageBox = new ReportLocationDelegate(DefaultReportLocation_MessageBox)
 Delegate that assembles the error location string for reporting via message box. More...
 
ReportMessageDelegate ReportMessageDlgMessageBox = new ReportMessageDelegate(DefaultReportMessage_MessageBox)
 Delegate that assembles the eror message string for reporting via message box. More...
 
- Public Attributes inherited from IG.Lib.ReporterBase
ReportDelegate ReportDlg = null
 Delegate that performs error reporting. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlg = null
 Delegate that assembles the error location string. More...
 
ReportMessageDelegate ReportMessageDlg = null
 Delegate that assembles the eror message string. More...
 
ReserveReportErrorDelegate ReserveReportErrorDlg = null
 Delegate that reports an error when the error reporting function throws an exception. Functions assigned to this delegate should really be BULLETPROOF. If not assigned then the internal method of the corresponding class is called. It is highly recommended to do reporting in small steps enclosed in try/catch blocks and especially to use the error reporting object very carefully (because it may not be initialized properly, which can also be the reason that the error reporting function crashes). It is higly recommended to first call the DefaultReserveReportError() within the function assigned to this delegate, or at least to use the DefaultReserveReportMessage() method for assembly of the message shown. More...
 
bool DebugMode = false
 Indicates that reporting suitable for debugging mode should be performed. A standard flag that can be used by the delegate functions. More...
 
ReportDelegate ReportDlgTextWriter = new ReportDelegate(DefaultReport_TextWriter)
 Delegate that performs reporting (actually logging) via text writer. More...
 
ReportLocationDelegate ReportLocationDlgTextWriter = new ReportLocationDelegate(DefaultReportLocation_TextWriter)
 Delegate that assembles the location string for reporting via TextWriter. More...
 
ReportMessageDelegate ReportMessageDlgTextWriter = new ReportMessageDelegate(DefaultReportMessage_TextWriter)
 Delegate that assembles the message string for reporting via text writer. More...
 
ReportDelegate ReportDlgTextLogger = new ReportDelegate(DefaultReport_TextLogger)
 Delegate that performs reporting (actually logging) via text writer. More...
 
ReportLocationDelegate ReportLocationDlgTextLogger = new ReportLocationDelegate(DefaultReportLocation_TextLogger)
 Delegate that assembles the location string for reporting via text logger. More...
 
ReportMessageDelegate ReportMessageDlgTextLogger = new ReportMessageDelegate(DefaultReportMessage_TextLogger)
 Delegate that assembles the message string for reporting via text writer. More...
 
ReportSource MsgSource = ReportSource.Unknown
 Indicates the source of the message (such as client, server, web service, etc.) More...
 
ReportDelegate ReportDlgTrace = new ReportDelegate(DefaultReport_Trace)
 Delegate that performs reporting (logging) via Pado trace mechanism. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way. More...
 
ReportLocationDelegate ReportLocationDlgTrace = new ReportLocationDelegate(DefaultReportLocation_Trace)
 Delegate that assembles the error location string for reporting (logging) via Pado trace mechanism. More...
 
ReportMessageDelegate ReportMessageDlgTrace = new ReportMessageDelegate(DefaultReportMessage_Trace)
 Delegate that assembles the eror message string for reporting (logging) via Pado trace mechanism. More...
 

Protected Member Functions

override void SetDefaultReportDlg ()
 Sets the error reporting delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.) More...
 
override void SetDefaultReportLocationDlg ()
 Sets the error location assembling delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.) More...
 
override void SetDefaultReportMessageDlg ()
 Sets the error message assembling delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.) More...
 
override void SetDefaultReserveReportErrorDlg ()
 Sets the reserve error reporting delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.) More...
 
override void ReserveReportErrorSpecific (ReportType messagetype, string location, string message, Exception ex, Exception ex1)
 Used to report errors within reporting functions. Designed to be bullet proof in order to ensure that improper behavior of the reporting system does not remain unnoticed. Overrides the method of the base class in order to show the message in forms rather than just in a console. More...
 
virtual void Report_ConsoleForm (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via console consform. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
virtual void Report_FadeMessage (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via fading message. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
virtual void Report_Console (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via console. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
virtual void Report_MessageBox (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via message box. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
- Protected Member Functions inherited from IG.Lib.ReporterBase
virtual void InitBegin ()
 Initial part of initialization. Auxiliary object is not affected because default delegates do not utilize it. More...
 
virtual void InitEnd ()
 Finalizing part of initialization. Auxiliary object is not affected because default delegates do not utilize it. More...
 
virtual void Dispose (bool disposing)
 
void GetAppSetting (string reportername, string keyroot, ref string value, out bool assigned)
 Reads a string value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref char value, out bool assigned)
 Reads a character value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref List< char > value, out bool assigned)
 Reads a list of characters from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref int value, out bool assigned)
 Reads an integer value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref double value, out bool assigned)
 Reads a numeric value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref bool value, out bool assigned)
 Reads a boolean value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void GetAppSetting (string reportername, string keyroot, ref ReportLevel value, out bool assigned)
 Reads a ReportLevel enumeration value from the application configuration file (e.g. app.config) and assigns it to the specified parameter of the reporter. More...
 
void AppSettingsReadWarning (string groupname)
 Launches an internal warning that the configuration settings belonging tot he specified group have already been read for this reporter. The warning is launched only if the settings have actually been read and if warnings of this type are switched on. More...
 
void MarkAppSettingsRead (string groupname)
 Marks a specified group of settings as been read for the current reporter. More...
 
virtual void ReadAppSettingsBasic (string groupname)
 Reads settings for a specified named group of reporters from the application configuration file. In the derived classes, this method should be overridden by the method that calls the base class' method. More...
 
void SyncReportLevelWithTraceSwitch (TraceSwitch tswitch, ref ReportLevel level)
 Synchronizes the value of ReportLevel enumeration variable with the state of a TraceSwitch variable. Enumeration is synchronized according to the Level property of the switch. More...
 
void SyncTraceSwitchWithReportLevel (ReportLevel level, TraceSwitch tswitch)
 Synchronizes the state of a TraceSwitch object with the value of the ReportLevel enumeration. More...
 
void ReserveReportError (ReportType messagetype, string location, string message, Exception ex, Exception ex1)
 Used to report internal errors of the reporter. Designed to be bullet proof in order to ensure that improper behavior of the reporting system does not remain unnoticed. More...
 
virtual void PrintIntro (TextWriter tw, string introtext, string programname)
 Writes to a textwriter the introduction text that is usually printed before logging starts. More...
 
bool SetTW (ref TextWriter tw, ref bool disptw, TextWriter writer, bool writeintro, bool disposewriter)
 Sets the basic text writer to which reporting is performed, but overrides the writeintro property by the 'writeintro' argument. More...
 
bool SetTW (ref TextWriter tw, ref bool disptw, Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter upon the stream and sets it as the basic TextWriter to which reporting is performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTW (ref List< TWClass > lwriters, TextWriter writer, bool writeintro, bool disposewriter)
 Adds another TextWriter to which reporting will also be performed. More...
 
bool AddTW (ref List< TWClass > lwriters, Stream stream, bool writeintro, bool disposewriter)
 Creates a TextWriter from the stream and adds it to the list of TextWriters on which reporting is also performed. Overrides the writeintro property by the 'writeintro' argument. More...
 
bool AddTW (ref List< TWClass > lwriters, string filename, bool append, bool writeintro, bool disposewriter)
 Creates a TextWriter from a specific file and adds it to the list of TextWriters on which reporting is also performed. The caller specifies whether to overwrite the file or to append to it, and whether the introductory text is written before reporting to the file begins. More...
 
bool RemoveTW (List< TWClass > lwriters, TextWriter writer)
 Removes the first object from a list that contains the specified TextWriter. More...
 
bool RemoveTW (List< TWClass > lwriters, Stream stream)
 Removes the first object from a list whose TextWriter has been created form the specified stream. More...
 
bool RemoveTW (List< TWClass > lwriters, string filename)
 Removes the first object from a list whose TextWriter has been created form the file with the specified name. More...
 
virtual void TextWriterPrintIntro (TextWriter tw)
 Writes to a textwriter the introduction text that is usually printed before logging starts. More...
 
virtual void Report_TextWriter (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via text writers. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
virtual void TextLoggerPrintIntro (TextWriter tw)
 Writes to a textwriter the introduction text that is usually printed before logging starts. More...
 
virtual void Report_TextLogger (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via text logger. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 
virtual void Report_Trace (ReportType messagetype, string location, string message, Exception ex)
 Launches a report via Trace. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function. More...
 

Static Protected Member Functions

static void DefaultReport_ConsoleForm (ReporterBase reporter, ReportType messagetype, string location, string message)
 Delegat for launching a report via console consform. More...
 
static string DefaultReportLocation_ConsoleForm (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_ConsoleForm (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
static void DefaultReport_FadeMessage (ReporterBase reporter, ReportType messagetype, string location, string message)
 Delegat for launching a report via fading message. More...
 
static string DefaultReportLocation_FadeMessage (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_FadeMessage (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
static void DefaultReport_Console (ReporterBase reporter, ReportType messagetype, string location, string message)
 Delegat for launching a report via console. More...
 
static string DefaultReportLocation_Console (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_Console (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
static void DefaultReport_MessageBox (ReporterBase reporter, ReportType messagetype, string location, string message)
 Delegat for launching a report via message box. More...
 
static string DefaultReportLocation_MessageBox (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_MessageBox (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
- Static Protected Member Functions inherited from IG.Lib.ReporterBase
static string FullKey (string reportername, string keyroot)
 Returns a full keyroot of a specific configuration item with a reporter name specified. More...
 
static void DefaultReport_TextWriter (ReporterBase reporter, ReportType messagetype, string location, string message)
 Default delegate for launching reports (actually logging reports) via text writer. More...
 
static string DefaultReportLocation_TextWriter (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_TextWriter (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
static void DefaultReport_TextLogger (ReporterBase reporter, ReportType messagetype, string location, string message)
 Default delegate for launching reports (actually logging reports) via text writer. More...
 
static string DefaultReportLocation_TextLogger (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_TextLogger (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 
static void DefaultReport_Trace (ReporterBase reporter, ReportType messagetype, string location, string message)
 Delegat for launching a report via Trace. More...
 
static string DefaultReportLocation_Trace (ReporterBase reporter, ReportType messagetype, string location, Exception ex)
 Delegate for assembling a location string for this kind of report. More...
 
static string DefaultReportMessage_Trace (ReporterBase reporter, ReportType messagetype, string basicmessage, Exception ex)
 Delegate for assembling a report message for this kind of report. More...
 

Properties

static new bool GlobalInitialized [get]
 
static new ReporterForms Global [get, protected set]
 Gets the global reporter object. This is typically used for configuring the global reporter. More...
 
bool UseConsoleForm [get, set]
 Gets or sets the flag specifying whether reporting using a console form is performed or not. More...
 
bool UseFadeMessage [get, set]
 Gets or sets the flag specifying whether reporting using a fadinfg messagebox is performed or not. More...
 
bool UseConsole [get, set]
 Gets or sets the flag specifying whether reporting using a system console is performed or not. More...
 
bool UseMessageBox [get, set]
 Gets or sets the flag specifying whether reporting using a message box is performed or not. More...
 
- Properties inherited from IG.Lib.ReporterBase
static bool GlobalInitialized [get]
 Gets the value indicating whether the global reporter of this class has already been initialized. More...
 
static ReporterBase Global [get, private set]
 Gets the global reporter object. This is typically used for configuring the global reporter. More...
 
bool AppSettingsWarnings [get, set]
 Gets or sets the flag that specifies whether a warning message is launched when reading of application settings is attempted more than once for the same named group of settings. More...
 
bool IsGlobal [get, protected set]
 Indicates whether the current reporter is used as a global reporter or not. More...
 
int Depth [get, set]
 Gets or sets the current indentation level for on-line output. This should normally be done by calling IncreaseDepth() or DecreaseDepth(). More...
 
int TextLoggerIndentInitial [get, set]
 Gets or sets number fo initial indentation charactyers. More...
 
int TextLoggerIndentSpacing [get, set]
 Gets or sets the number of indentation characters written per indentation level. More...
 
char TextLoggerIndentCharacter [get, set]
 Gets or sets the indentation character. More...
 
ReportLevel ReportingLevel [get, set]
 Gets or sets level of output for reporting (console output, message boxes, etc.). More...
 
ReportLevel LoggingLevel [get, set]
 Gets or sets level of output for logging (writing to log files). More...
 
ReportLevel TracingLevel [get, set]
 Gets or sets trace level (for external trace systems). More...
 
bool TreatError [get]
 Returns a boolean value indicating whether errors are treated by the reporter in its current state. More...
 
bool TreatWarning [get]
 Returns a boolean value indicating whether warnings are treated by the reporter in its current state. More...
 
bool TreatInfo [get]
 Returns a boolean value indicating whether info messages are treated by the reporter in its current state. More...
 
bool TreatUndefined [get]
 Returns a boolean value indicating whether undefined messages with the lowest priority are treated by the reporter in its current state. More...
 
ReportLevel Level [get, set]
 Gets the level with the lowesst priority (out of reporting, logging and tracing level), or sets all levels to the assigned level. More...
 
virtual bool this[ReportLevel level] [get, set]
 Indexer that returns true if messages of a given level are treated by the reporter (either by the reporting, logging or tracing part, according to the corresponding level states), or false if not (i.e. if all the levels are set lover than the index). In the case of assignment, when true is assigned, all levels that are set lower than the are set to index. Assignment with false should be used only exteptionally; but in this case all levels that are set higher or equal than the index are set one level below. More...
 
TraceSwitch ReportingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with ReportingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the ReportingLevel, which will override its settings). More...
 
TraceSwitch LoggingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with LoggingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the LoggingLevel, which will override its settings). More...
 
TraceSwitch TracingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with TracingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the TracingLevel, which will override its settings). More...
 
bool ThrowTestException [get, set]
 If true then the basic reporting function will throw an exception. This is intended predominantly for testing how the reporter behaves in case of internal errors. When the exception is thrown, the value is set back to false. If we want an exception to be thrown again then the value must be set to true once again. More...
 
object Obj [get, set]
 Auxiliary object used by the delegates that perform error reporting. The object is used to provide additional information used in error reporting, or to provide objects that perform some actions in error reporting tasks, or both. It is left entirely to error reporting delegates to interpret the object's contents. More...
 
virtual object lockobj [get]
 Object used for locking. More...
 
bool UseTextWriter [get, set]
 Gets or sets the flag specifying whether reporting using a text writer is performed or not. More...
 
bool TextWriterFlushing [get, set]
 Gets or sets the flag that tells whether or not the text writers are flushed after every message that is reported through them. More...
 
string TextWriterIntroText [get, set]
 Gets or sets the introduction string that is written before logging to a TextWriter begins. If this is not specified then the reporter composes its own introduction string, eventually using programname (when defined). More...
 
string TextWriterProgramName [get, set]
 String denoting the name of the program or other entity that uses the Reporter for logging. When introtext is not specified, this name is used in the introduction text composed by the reporter. More...
 
bool TextWriterWriteIntro [get, set]
 Specifies whether introduction text is written before logging of messages begins or not. More...
 
bool UseTextLogger [get, set]
 Gets or sets the flag specifying whether reporting using a text writer is performed or not. More...
 
bool TextLoggerFlushing [get, set]
 Gets or sets the flag that tells whether or not the text writers are flushed after every message that is reported through them. More...
 
string TextLoggerIntroText [get, set]
 Gets or sets the introduction string that is written before logging to a TextWriter begins. If this is not specified then the reporter composes its own introduction string, eventually using programname (when defined). More...
 
string TextLoggerProgramName [get, set]
 String denoting the name of the program or other entity that uses the Reporter for logging. When introtext is not specified, this name is used in the introduction text composed by the reporter. More...
 
bool TextLoggerWriteIntro [get, set]
 Specifies whether introduction text is written before logging of messages begins or not. More...
 
bool UseTrace [get, set]
 Gets or sets the flag specifying whether reporting using the pado trace is performed or not. More...
 
- Properties inherited from IG.Lib.IReporterBase
bool AppSettingsWarnings [get, set]
 Gets or sets the flag that specifies whether a warning message is launched when reading of application settings is attempted more than once for the same named group of settings. More...
 
bool IsGlobal [get]
 Indicates whether the current reporter is used as a global reporter or not. More...
 
int Depth [get, set]
 Gets or sets the current indentation level for on-line output. This should normally be done by calling IncreaseDepth() or DecreaseDepth(). More...
 
ReportLevel ReportingLevel [get, set]
 Gets or sets level of output for reporting (console output, message boxes, etc.). More...
 
ReportLevel LoggingLevel [get, set]
 Gets or sets level of output for logging (writing to log files). More...
 
ReportLevel TracingLevel [get, set]
 Gets or sets trace level (for external trace systems). More...
 
bool TreatError [get]
 Returns a boolean value indicating whether errors are treated by the reporter in its current state. More...
 
bool TreatWarning [get]
 Returns a boolean value indicating whether warnings are treated by the reporter in its current state. More...
 
bool TreatInfo [get]
 Returns a boolean value indicating whether info messages are treated by the reporter in its current state. More...
 
bool TreatUndefined [get]
 Returns a boolean value indicating whether undefined messages with the lowest priority are treated by the reporter in its current state. More...
 
ReportLevel Level [get, set]
 Gets the level with the lowesst priority (out of reporting, logging and tracing level), or sets all levels to the assigned level. More...
 
bool this[ReportLevel level] [get, set]
 Indexer that returns true if messages of a given level are treated by the reporter (either by the reporting, logging or tracing part, according to the corresponding level states), or false if not (i.e. if all the levels are set lover than the index). In the case of assignment, when true is assigned, all levels that are set lower than the are set to index. Assignment with false should be used only exteptionally; but in this case all levels that are set higher or equal than the index are set one level below. More...
 
TraceSwitch ReportingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with ReportingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the ReportingLevel, which will override its settings). More...
 
TraceSwitch LoggingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with LoggingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the LoggingLevel, which will override its settings). More...
 
TraceSwitch TracingSwitch [get, set]
 Gets or sets the TraceSwitch that is synchronized with TracingLevel. IMPORTANT: State of the object obtained by get accessor must not be changed unless the object is assigned back by the set accessor. If one wants that this TraceSwitch assumes values specified by the configuration file, a corresponding Traceswitch must be created and assigned to this property (otherwise the TraceSwitch will be synchronized with the TracingLevel, which will override its settings). More...
 
object Obj [get, set]
 Auxiliary object used by the delegates that perform error reporting. More...
 
object lockobj [get]
 Object used for locking. More...
 
- Properties inherited from IG.Lib.IReporterTextWriter
bool UseTextWriter [get, set]
 Specifies whether or not TextWriter(s) are used by the Reporter to log messages. More...
 
string TextWriterIntroText [get, set]
 Gets or sets the introduction string that is written before logging to a TextWriter begins. If this is not specified then the reporter composes its own introduction string, eventually using programname (when defined). More...
 
string TextWriterProgramName [get, set]
 String denoting the name of the program or other entity that uses the Reporter for logging. When introtext is not specified, this name is used in the introduction text composed by the reporter. More...
 
bool TextWriterWriteIntro [get, set]
 Specifies whether introduction text is written before logging of messages begins or not. More...
 
- Properties inherited from IG.Lib.IReporterTextLogger
bool UseTextLogger [get, set]
 Specifies whether or not TextLogger(s) are used by the Reporter to log messages. More...
 
int TextLoggerIndentInitial [get, set]
 Gets or sets number fo initial indentation charactyers. More...
 
int TextLoggerIndentSpacing [get, set]
 Gets or sets the number of indentation characters written per indentation level. More...
 
char TextLoggerIndentCharacter [get, set]
 Gets or sets the indentation character. More...
 
string TextLoggerIntroText [get, set]
 Gets or sets the introduction string that is written before logging to a TextLogger begins. If this is not specified then the reporter composes its own introduction string, eventually using programname (when defined). More...
 
string TextLoggerProgramName [get, set]
 String denoting the name of the program or other entity that uses the Reporter for logging. When introtext is not specified, this name is used in the introduction text composed by the reporter. More...
 
bool TextLoggerWriteIntro [get, set]
 Specifies whether introduction text is written before logging of messages begins or not. More...
 
- Properties inherited from IG.Lib.IReporterTrace
bool UseTrace [get, set]
 

Private Attributes

bool _UseConsoleForm = false
 
bool _UseFadeMessage = false
 
bool _UseConsole = false
 
bool _UseMessageBox = false
 

Static Private Attributes

static ReporterForms _Global = new ReporterForms()
 
static bool _GlobalInitialized = false
 
static int NumShownDialog = 0
 
static int MaxShownDialog = 3
 

Additional Inherited Members

- Static Public Attributes inherited from IG.Lib.ReporterBase
static bool ReadGlobalAppSettings = true
 Indicates whether a global Reporter (or its derived class) should read settings from the application configuration file when initialized (default is true). More...
 
- Protected Attributes inherited from IG.Lib.ReporterBase
const string KeyPrefix = "ReporterMsg"
 
const string KeyLevelOn = "LevelOn"
 
TraceSwitch _ReportingSwitch = null
 
object _lockobj = new Object()
 

Detailed Description

Reporting system that in particular utilizes forms. Beside the main delegates for assembling location and message strings, this class has three additional delegates for each kind of reporting (i.e. reporting with console consform, message box, fading message or console)

The Reporting class objects can be extended with appropriate delegates to use forms, while ReporterForms itself contains implementation of methods that utilize several standard forms suitable for reporting.

Constructor & Destructor Documentation

IG.Forms.ReporterForms.ReporterForms ( )
inline

Constructor. Initializes all error reporting delegates to default values and sets auxliary object to null. Auxiliary object Obj is set to null.

IG.Forms.ReporterForms.ReporterForms ( object  obj,
ReportDelegate  reportdelegate,
ReportLocationDelegate  locationdelegate,
ReportMessageDelegate  messagedelegate,
ReserveReportErrorDelegate  reservereportdelegate 
)
inline

Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates that are not specified (have a null reference) are set to default values.

Parameters
objAuxiliary object that will be passed to error reporting delegates when called in local methods.
reportdelegateDelegates that is called to launc an error report. Methods of this class will pass to this class the auxiliary object, location strings assembled by the location assembling delegate, and error message string assembled by the error message delegate.
locationdelegateDelegate that is called to assemble the error location string. The Auxiliary object this.Obj will be internally passed to this delegate any time it is called.
messagedelegateDelegate that is called to assemble the error message (without decorations). The Auxiliary object this.Obj will be internally passed to this delegate any time it is called.
reservereportdelegateDelegate that is called to report exceptions that occur within error reporting methods. In particular, this must ne as bullet proof as possible.
IG.Forms.ReporterForms.ReporterForms ( object  obj,
ReportDelegate  reportdelegate,
ReportLocationDelegate  locationdelegate,
ReportMessageDelegate  messagedelegate 
)
inline

Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates that are not specified are set to default values.

IG.Forms.ReporterForms.ReporterForms ( object  obj,
ReportDelegate  reportdelegate 
)
inline

Constructor. Initializes the error reporter by the specified auxiliary object and the delegate to perform error reporting tasks. Reserve error reporting delegate is initialized to a default value. Delegates for assembling the error location string and error message string are set to their default values, which are adapted to console-like eror reporting systems.

IG.Forms.ReporterForms.ReporterForms ( object  obj,
ReportDelegate  reportdelegate,
ReserveReportErrorDelegate  reservereportdelegate 
)
inline

Constructor. Initializes the error reporter by the specified auxiliary object and delegates used to perform error reporting tasks. Delegates for assembling the error locatin and error message string are set to their default values, which are adapted to console-like eror reporting systems.

Parameters
objAuxiliary object that will be passed to error reporting delegates when called in local methods.
reportdelegateDelegates that is called to launc an error report. Methods of this class will pass to this class the auxiliary object, location strings assembled by the location assembling delegate, and error message string assembled by the error message delegate.
reservereportdelegateDelegate that is called to report exceptions that occur within error reporting methods. In particular, this must ne as bullet proof as possible.

Member Function Documentation

override void IG.Forms.ReporterForms.SetDefaultReportDlg ( )
inlineprotectedvirtual

Sets the error reporting delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.)

Reimplemented from IG.Lib.ReporterBase.

override void IG.Forms.ReporterForms.SetDefaultReportLocationDlg ( )
inlineprotectedvirtual

Sets the error location assembling delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.)

Reimplemented from IG.Lib.ReporterBase.

References IG.Lib.Old.ReportLocationDelegate().

override void IG.Forms.ReporterForms.SetDefaultReportMessageDlg ( )
inlineprotectedvirtual

Sets the error message assembling delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.)

Reimplemented from IG.Lib.ReporterBase.

References IG.Lib.Old.ReportMessageDelegate().

override void IG.Forms.ReporterForms.SetDefaultReserveReportErrorDlg ( )
inlineprotectedvirtual

Sets the reserve error reporting delegate to the default value. The default delegate does not utilize the auxiliary object (and can be mixed with the delegates that do.)

Reimplemented from IG.Lib.ReporterBase.

References IG.Lib.Old.ReserveReportErrorDelegate().

static void IG.Forms.ReporterForms.DefaultReserveReportErrorForms ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
string  message,
Exception  ex,
Exception  ex1 
)
inlinestatic

Default function function for reserve error reporting (called if an exception is thrown in an error reporting function):

Parameters
reporterReporter object whre the method can get additional information.
messagetypeLevel of the message (Error, Warning,Info, etc.)
locationLocation string as passed to the error reporting function that has thrown an exception.
messageError message string as passed to the error reporting function that has thrown an exception.
exOriginal exception that was being reported when the error reporting function threw an exception.
ex1Exception thrown by the error reporting function.

References IG.Forms.FadingMessage.BackGroundColor, IG.Forms.UtilForms.Console, IG.Forms.FadingMessage.FadeColor, IG.Forms.FadingMessage.FadingTimePortion, IG.Forms.FadingMessage.ForeGroundColorMsg, IG.Forms.FadingMessage.ForeGroundColorTitle, IG.Forms.FadingMessage.MsgText, IG.Forms.FadingMessage.MsgTitle, IG.Forms.FadingMessage.ShowThread(), IG.Forms.FadingMessage.ShowTime, and IG.Forms.ConsoleForm.Write().

override void IG.Forms.ReporterForms.ReserveReportErrorSpecific ( ReportType  messagetype,
string  location,
string  message,
Exception  ex,
Exception  ex1 
)
inlineprotectedvirtual

Used to report errors within reporting functions. Designed to be bullet proof in order to ensure that improper behavior of the reporting system does not remain unnoticed. Overrides the method of the base class in order to show the message in forms rather than just in a console.

Parameters
messagetype
location
message
ex
ex1

Reimplemented from IG.Lib.ReporterBase.

override void IG.Forms.ReporterForms.Report ( ReportType  messagetype,
string  location,
string  message,
Exception  ex 
)
inlinevirtual

Basic method for reporting by this class (i.e., reporting by forms).

Parameters
reporterReporter object where additional data can be found.
messagetypeThe type of the report (e.g. Error, Warning, etc.).
locationUser-provided description of error location.
messageUser-provided description of error.
exException thrown when error occurred.

Reimplemented from IG.Lib.ReporterBase.

static void IG.Forms.ReporterForms.DefaultReport_ConsoleForm ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
string  message 
)
inlinestaticprotected

Delegat for launching a report via console consform.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationShort string desctribing location where report was triggered.
messageMessage of the report.

References IG.Forms.UtilForms.Console, IG.Forms.ReporterForms.ConsoleForm, and IG.Forms.ConsoleForm.Report().

static string IG.Forms.ReporterForms.DefaultReportLocation_ConsoleForm ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a location string for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
exException that triggered reporting.
Returns
Location string that can be used in a report.
static string IG.Forms.ReporterForms.DefaultReportMessage_ConsoleForm ( ReporterBase  reporter,
ReportType  messagetype,
string  basicmessage,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a report message for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
basicmessageUser provided message string.
exException that triggered reporting.
Returns
Message string that can be used in a report.
virtual void IG.Forms.ReporterForms.Report_ConsoleForm ( ReportType  messagetype,
string  location,
string  message,
Exception  ex 
)
inlineprotectedvirtual

Launches a report via console consform. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function.

Parameters
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
messageUser provided message string.
exException that triggered reporting.
static void IG.Forms.ReporterForms.DefaultReport_FadeMessage ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
string  message 
)
inlinestaticprotected
static string IG.Forms.ReporterForms.DefaultReportLocation_FadeMessage ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a location string for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
exException that triggered reporting.
Returns
Location string that can be used in a report.
static string IG.Forms.ReporterForms.DefaultReportMessage_FadeMessage ( ReporterBase  reporter,
ReportType  messagetype,
string  basicmessage,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a report message for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
basicmessageUser provided message string.
exException that triggered reporting.
Returns
Message string that can be used in a report.
virtual void IG.Forms.ReporterForms.Report_FadeMessage ( ReportType  messagetype,
string  location,
string  message,
Exception  ex 
)
inlineprotectedvirtual

Launches a report via fading message. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function.

Parameters
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
messageUser provided message string.
exException that triggered reporting.
static void IG.Forms.ReporterForms.DefaultReport_Console ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
string  message 
)
inlinestaticprotected

Delegat for launching a report via console.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationShort string desctribing location where report was triggered.
messageMessage of the report.
static string IG.Forms.ReporterForms.DefaultReportLocation_Console ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a location string for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
exException that triggered reporting.
Returns
Location string that can be used in a report.
static string IG.Forms.ReporterForms.DefaultReportMessage_Console ( ReporterBase  reporter,
ReportType  messagetype,
string  basicmessage,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a report message for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
basicmessageUser provided message string.
exException that triggered reporting.
Returns
Message string that can be used in a report.
virtual void IG.Forms.ReporterForms.Report_Console ( ReportType  messagetype,
string  location,
string  message,
Exception  ex 
)
inlineprotectedvirtual

Launches a report via console. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function.

Parameters
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
messageUser provided message string.
exException that triggered reporting.
static void IG.Forms.ReporterForms.DefaultReport_MessageBox ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
string  message 
)
inlinestaticprotected

Delegat for launching a report via message box.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationShort string desctribing location where report was triggered.
messageMessage of the report.
static string IG.Forms.ReporterForms.DefaultReportLocation_MessageBox ( ReporterBase  reporter,
ReportType  messagetype,
string  location,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a location string for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
exException that triggered reporting.
Returns
Location string that can be used in a report.
static string IG.Forms.ReporterForms.DefaultReportMessage_MessageBox ( ReporterBase  reporter,
ReportType  messagetype,
string  basicmessage,
Exception  ex 
)
inlinestaticprotected

Delegate for assembling a report message for this kind of report.

Parameters
reporterReporter object where additional information can be found.
messagetypeType of the report(Error, Warning, Info...).
basicmessageUser provided message string.
exException that triggered reporting.
Returns
Message string that can be used in a report.
virtual void IG.Forms.ReporterForms.Report_MessageBox ( ReportType  messagetype,
string  location,
string  message,
Exception  ex 
)
inlineprotectedvirtual

Launches a report via message box. Report is launched by using special delegates for this kind of reporting. If the corresponding delegates for error location and message are not specified then general delegates are used for this purporse, or location and message string are simple assembled by this function.

Parameters
messagetypeType of the report(Error, Warning, Info...).
locationUser provided location string.
messageUser provided message string.
exException that triggered reporting.

Member Data Documentation

ReporterForms IG.Forms.ReporterForms._Global = new ReporterForms()
staticprivate
bool IG.Forms.ReporterForms._GlobalInitialized = false
staticprivate
int IG.Forms.ReporterForms.NumShownDialog = 0
staticprivate
int IG.Forms.ReporterForms.MaxShownDialog = 3
staticprivate
bool IG.Forms.ReporterForms._UseConsoleForm = false
private
ConsoleForm IG.Forms.ReporterForms.ConsoleForm = null

Console consform used for reporting. If null then global console consform is used (this is the matter of delegate methods).

Referenced by IG.Forms.ReporterForms.DefaultReport_ConsoleForm().

ReportDelegate IG.Forms.ReporterForms.ReportDlgConsoleForm = new ReportDelegate(DefaultReport_ConsoleForm)

Delegate that performs error reporting via console consform. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way.

ReportLocationDelegate IG.Forms.ReporterForms.ReportLocationDlgConsoleForm = new ReportLocationDelegate(DefaultReportLocation_ConsoleForm)

Delegate that assembles the error location string for reporting via console consform.

ReportMessageDelegate IG.Forms.ReporterForms.ReportMessageDlgConsoleForm = new ReportMessageDelegate(DefaultReportMessage_ConsoleForm)

Delegate that assembles the eror message string for reporting via console consform.

bool IG.Forms.ReporterForms._UseFadeMessage = false
private
int IG.Forms.ReporterForms.FadeMessageShowtime = 4000

Fading message visibility time in milliseconds.

Referenced by IG.Forms.ReporterForms.DefaultReport_FadeMessage().

double IG.Forms.ReporterForms.FadeMessageFadingTimePortion = 0.25

Portion of visibility time when the message is fading.

Referenced by IG.Forms.ReporterForms.DefaultReport_FadeMessage().

Color IG.Forms.ReporterForms.FadeMessageBackColor = Color.Orange

Actibe background color of the fading message.

Referenced by IG.Forms.ReporterForms.DefaultReport_FadeMessage().

Color IG.Forms.ReporterForms.FadeMessageBackColorFinal = Color.DarkGray

Final (fade) background color of the fading message.

Referenced by IG.Forms.ReporterForms.DefaultReport_FadeMessage().

Color IG.Forms.ReporterForms.FadeMessageForeColor = Color.Blue

Text color of the fading message.

Referenced by IG.Forms.ReporterForms.DefaultReport_FadeMessage().

ReportDelegate IG.Forms.ReporterForms.ReportDlgFadeMessage = new ReportDelegate(DefaultReport_FadeMessage)

Delegate that performs error reporting via fading message. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way.

ReportLocationDelegate IG.Forms.ReporterForms.ReportLocationDlgFadeMessage = new ReportLocationDelegate(DefaultReportLocation_FadeMessage)

Delegate that assembles the error location string for reporting via fading message.

ReportMessageDelegate IG.Forms.ReporterForms.ReportMessageDlgFadeMessage = new ReportMessageDelegate(DefaultReportMessage_FadeMessage)

Delegate that assembles the eror message string for reporting via fading message.

bool IG.Forms.ReporterForms._UseConsole = false
private
ReportDelegate IG.Forms.ReporterForms.ReportDlgConsole = new ReportDelegate(DefaultReport_Console)

Delegate that performs error reporting via console. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way.

ReportLocationDelegate IG.Forms.ReporterForms.ReportLocationDlgConsole = new ReportLocationDelegate(DefaultReportLocation_Console)

Delegate that assembles the error location string for reporting via console.

ReportMessageDelegate IG.Forms.ReporterForms.ReportMessageDlgConsole = new ReportMessageDelegate(DefaultReportMessage_Console)

Delegate that assembles the eror message string for reporting via console.

bool IG.Forms.ReporterForms._UseMessageBox = false
private
ReportDelegate IG.Forms.ReporterForms.ReportDlgMessageBox = new ReportDelegate(DefaultReport_MessageBox)

Delegate that performs error reporting via message box. It calls delegates ReportDlg to assemble error location information and ReportMessageDlg to assemble error message. Then it uses both to assemble the final decorated error message and launches it in its own way.

ReportLocationDelegate IG.Forms.ReporterForms.ReportLocationDlgMessageBox = new ReportLocationDelegate(DefaultReportLocation_MessageBox)

Delegate that assembles the error location string for reporting via message box.

ReportMessageDelegate IG.Forms.ReporterForms.ReportMessageDlgMessageBox = new ReportMessageDelegate(DefaultReportMessage_MessageBox)

Delegate that assembles the eror message string for reporting via message box.

Property Documentation

new bool IG.Forms.ReporterForms.GlobalInitialized
staticget
bool IG.Forms.ReporterForms.UseConsoleForm
getset

Gets or sets the flag specifying whether reporting using a console form is performed or not.

bool IG.Forms.ReporterForms.UseFadeMessage
getset

Gets or sets the flag specifying whether reporting using a fadinfg messagebox is performed or not.

bool IG.Forms.ReporterForms.UseConsole
getset

Gets or sets the flag specifying whether reporting using a system console is performed or not.

Referenced by IG.Forms.AppTestForms.BeforeInitialization().

bool IG.Forms.ReporterForms.UseMessageBox
getset

Gets or sets the flag specifying whether reporting using a message box is performed or not.


The documentation for this class was generated from the following file: