Interface IMessageControlPlugIn

IMessageControlPlugIn interface represents a message control plug-in.

Namespace: SdlSdl.VerificationApi

Assembly: Sdl.Verification.Api.dll

Syntax

public interface IMessageControlPlugIn

Remarks

A message control plug-in is responsible for creating a message control for a given message allowing the developer to use different message controls for different types of messages.

Methods

CreateMessageControl(IMessageControlContainer, MessageEventArgs, IBilingualDocument, ISegment, ISegment)

Creates the message control for the given message.

Declaration

UserControl CreateMessageControl(IMessageControlContainer messageControlContainer, MessageEventArgs messageEventArgs, IBilingualDocument bilingualDocument, ISegment sourceSegment, ISegment targetSegment)

Parameters

Type	Name	Description
IMessageControlContainer	messageControlContainer	message control container
MessageEventArgs	messageEventArgs	message
IBilingualDocument	bilingualDocument	bilingual document
ISegment	sourceSegment	source segment
ISegment	targetSegment	target segment

Returns

Type	Description
UserControl	message control

SupportsMessage(MessageEventArgs)

Determines whether the message control plug-in supports the given message.

Declaration

bool SupportsMessage(MessageEventArgs messageEventArgs)

Parameters

Type	Name	Description
MessageEventArgs	messageEventArgs	message

Returns

Type	Description
bool	whether supports message