Interface IBasicMessageReporter
Basic mechanism for components to report non-fatal issues to the framework. (Fatal errors should yield exceptions.)
Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IBasicMessageReporterRemarks
This is the most basic interface for message reporting. It contains no explicit means of associating explicit locations with the error messages. Some more advanced message reporters are derived from this interface, and it provides methods that allow locations and ranges to be associated with the messages in a manner to support automated navigation such as click-on error messages.
Methods
ReportMessage(object, string, ErrorLevel, string, string)
Used by any component to report a non-critical issue, not explicitly associated with a content location.
Declaration
void ReportMessage(object source, string origin, ErrorLevel level, string message, string locationDescription)Parameters
| Type | Name | Description |
|---|---|---|
| object | source | The component from which the message originates. Components typically pass |
| string | origin | The description of the action/component from which this message originates. |
| ErrorLevel | level | Severity of the message |
| string | message | The actual message text |
| string | locationDescription | Optional (may be Clear text description of the location that the message refers to. Can be used to communicate in clear text how the user can find the corresponding location in the content being processed. |
Remarks
This overload is used when the message cannot be associated with an explicit content location, e.g. for issues concerning the whole file/document, or for situations in which an explicit location is difficult to specify.