| INativeTextLocationMessageReporterReportMessage Method (Object, String, ErrorLevel, String, NativeTextLocation, NativeTextLocation) |
Used by file writers etc. in order to report a non-critical issue with an associated content range or location expressed in line and
character offset numbers in the original native file format.
Namespace: Sdl.FileTypeSupport.Framework.NativeApiAssembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
Syntaxvoid ReportMessage(
Object source,
string origin,
ErrorLevel level,
string message,
NativeTextLocation fromLocation,
NativeTextLocation uptoLocation
)
Sub ReportMessage (
source As Object,
origin As String,
level As ErrorLevel,
message As String,
fromLocation As NativeTextLocation,
uptoLocation As NativeTextLocation
)
void ReportMessage(
Object^ source,
String^ origin,
ErrorLevel level,
String^ message,
NativeTextLocation^ fromLocation,
NativeTextLocation^ uptoLocation
)
abstract ReportMessage :
source : Object *
origin : string *
level : ErrorLevel *
message : string *
fromLocation : NativeTextLocation *
uptoLocation : NativeTextLocation -> unit
Parameters
- source
- Type: SystemObject
- origin
- Type: SystemString
The description of the action/component from which this message originated. - level
- Type: Sdl.FileTypeSupport.Framework.NativeApiErrorLevel
- message
- Type: SystemString
- fromLocation
- Type: Sdl.FileTypeSupport.Framework.NativeApiNativeTextLocation
Start location in the native text file - uptoLocation
- Type: Sdl.FileTypeSupport.Framework.NativeApiNativeTextLocation
(Optional) end location in the native text file. You can pass null for this parameter.
Remarks
When converting the locations to bilingual or native content the line and offset numbers will
be interpreted by the framework as referring to the textual content of the content that is processed
through the native API. The framework will count the number of characters and line breaks
that appear inside text and tags in an attempt to reference the corresponding location in the native content stream
or in the bilingual content model (as needed). That means that if the tags and text in the native content
fully correspond to the original file format, the locations will map well. If this is not the case,
it is recommended that you use the IBasicMessageReporter interface, and refer to
locations in an explanatory manner instead (e.g. through a message box).
See Also
Comments