Class AbstractBilingualFileTypeComponent

Convenient base class from which bilingual file type components can be built. Implements the setters and getters for the bilingual component initialization. For convenience, implements the IBilingualContentMessageReporter interface by forwarding all calls to the MessageReporter (if set).

Inheritance
System.Object
AbstractBilingualFileTypeComponent
GenericTagVerifier
AbstractBilingualContentHandler
AbstractBilingualParser
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.FileTypeSupport.Framework.BilingualApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public class AbstractBilingualFileTypeComponent : IBilingualFileTypeComponent, IBilingualContentMessageReporter, IBasicMessageReporter, IBilingualContentMessageReporterWithExtendedData, IBasicMessageReporterWithExtendedData
Remarks

Implementations are not required to derive from this class. It is designed as a convenient default implementation to be used when appropriate.

Constructors

AbstractBilingualFileTypeComponent()

Protected constructor that is used by derived classes

Declaration
protected AbstractBilingualFileTypeComponent()

Properties

ItemFactory

Default implementation of the ItemFactory property

Declaration
public virtual IDocumentItemFactory ItemFactory { get; set; }
Property Value
Type Description
IDocumentItemFactory

MessageReporter

Accessor for the message reporter

Declaration
public virtual IBilingualContentMessageReporter MessageReporter { get; set; }
Property Value
Type Description
IBilingualContentMessageReporter

PropertiesFactory

Convenience accessor to the properties factory used by the item factory.

Declaration
public IPropertiesFactory PropertiesFactory { get; }
Property Value
Type Description
IPropertiesFactory

Methods

ReportMessage(Object, String, ErrorLevel, String, TextLocation, TextLocation)

Calls the corresponding method on the message reporter (if set).

Declaration
public void ReportMessage(object source, string origin, ErrorLevel level, string message, TextLocation fromLocation, TextLocation uptoLocation)
Parameters
Type Name Description
System.Object source
System.String origin

The description of the action/component that this message originated from.
ErrorLevel level
System.String message
TextLocation fromLocation
TextLocation uptoLocation

ReportMessage(Object, String, ErrorLevel, String, TextLocation, TextLocation, ExtendedMessageEventData)

Calls the corresponding method on the message reporter (if set).

Declaration
public void ReportMessage(object source, string origin, ErrorLevel level, string message, TextLocation fromLocation, TextLocation uptoLocation, ExtendedMessageEventData extendedData)
Parameters
Type Name Description
System.Object source
System.String origin

The description of the action/component that this message originated from.
ErrorLevel level
System.String message
TextLocation fromLocation
TextLocation uptoLocation
ExtendedMessageEventData extendedData

ReportMessage(Object, String, ErrorLevel, String, String)

Calls the corresponding method on the message reporter (if set).

Declaration
public void ReportMessage(object source, string origin, ErrorLevel level, string message, string locationDescription)
Parameters
Type Name Description
System.Object source
System.String origin

The description of the action/component from which this message originates.
ErrorLevel level
System.String message
System.String locationDescription

ReportMessage(Object, String, ErrorLevel, String, String, ExtendedMessageEventData)

Calls the corresponding method on the message reporter (if set).

Declaration
public void ReportMessage(object source, string origin, ErrorLevel level, string message, string locationDescription, ExtendedMessageEventData extendedData)
Parameters
Type Name Description
System.Object source
System.String origin

The description of the action/component from which this message originates.
ErrorLevel level
System.String message
System.String locationDescription
ExtendedMessageEventData extendedData

Implements