Class MessageEventArgs

Information passed in Message events

Inheritance
object
EventArgs
MessageEventArgs
Inherited Members
Namespace: SdlSdl.FileTypeSupportFrameworkIntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public class MessageEventArgs : EventArgs

Constructors

MessageEventArgs()

Creates an uninitialized instance.

Declaration
public MessageEventArgs()

MessageEventArgs(string, string, ErrorLevel, string, IMessageLocation, IMessageLocation)

Creates an instance initialized with the specified parameters.

Declaration
public MessageEventArgs(string filePath, string origin, ErrorLevel level, string message, IMessageLocation fromLocation, IMessageLocation uptoLocation)
Parameters
Type Name Description
string filePath
string origin

The description of the action/component from which this message originated.
ErrorLevel level
string message
IMessageLocation fromLocation
IMessageLocation uptoLocation

MessageEventArgs(string, string, ErrorLevel, string, IMessageLocation, IMessageLocation, ExtendedMessageEventData)

Creates an instance initialized with the specified parameters.

Declaration
public MessageEventArgs(string filePath, string origin, ErrorLevel level, string message, IMessageLocation fromLocation, IMessageLocation uptoLocation, ExtendedMessageEventData extendedData)
Parameters
Type Name Description
string filePath
string origin

The description of the action/component from which this message originated.
ErrorLevel level
string message
IMessageLocation fromLocation
IMessageLocation uptoLocation
ExtendedMessageEventData extendedData

Properties

ExtendedData

Extended data used to add specific message data to the message; for example, it could be used for verification data.

Declaration
public ExtendedMessageEventData ExtendedData { get; set; }
Property Value
Type Description
ExtendedMessageEventData

FilePath

Full path to the file being processed, or null if unknown

Declaration
public string FilePath { get; set; }
Property Value
Type Description
string

FromLocation

Start location of the content the message refers to, or null if none.

Declaration
public IMessageLocation FromLocation { get; set; }
Property Value
Type Description
IMessageLocation

Level

Severity of the reported issue

Declaration
public ErrorLevel Level { get; set; }
Property Value
Type Description
ErrorLevel

Message

Actual (localized) message text that will be shown to the user

Declaration
public string Message { get; set; }
Property Value
Type Description
string

Origin

Description of the object/action from which the message was sent

Declaration
public string Origin { get; set; }
Property Value
Type Description
string

UptoLocation

End location of the content the message refers to, or null if none

Declaration
public IMessageLocation UptoLocation { get; set; }
Property Value
Type Description
IMessageLocation

Methods

ToString()

Returns a string of the form [Level]: [Message] with the error level and message, intended for debugging purposes.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
Remarks

This intended is for debugging purposes only. Do not use this in the UI; the content is not fully localized.