Interface IInputTranslationMemory

Represents a legacy translation memory that is part of a migration project (see IMigrationProject). This has a reference to legacy translation memory (see ILegacyTranslationMemory, provides access to theis translation memory's setup information and holds status information about whether the necessary content has been exported to TMX yet (see TmxFileStatus and TmxFilePath).

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi.Upgrade

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public interface IInputTranslationMemory

Properties

Setup

Gets the setup information from the legacy translation memory. This information is initially retrieved through GetSetup() and then cached for easy access throughout the migration process.

Declaration

ILegacyTranslationMemorySetup Setup { get; }

Property Value

Type	Description
ILegacyTranslationMemorySetup

TmxFilePath

Gets or sets the absolute TMX file path to which to export the legacy translation memory's content.

Declaration

string TmxFilePath { get; set; }

Property Value

Type	Description
System.String

Remarks

Setting this property will update the TmxFileStatus property, depending on whether the file exists.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when setting this property to null or an empty string.
System.InvalidOperationException	Thrown when attempting to set this property if the legacy translation memory is a ITmxLegacyTranslationMemory.

TmxFileStatus

Gets the status of the TMX export file specified in TmxFilePath. A call to ExportTmxFile(EventHandler<BatchExportedEventArgs>) will update the value of this property.

Declaration

TmxFileStatus TmxFileStatus { get; }

Property Value

Type	Description
TmxFileStatus

TranslationMemory

Gets the legacy translation memory which this input translation memory represents.

Declaration

ILegacyTranslationMemory TranslationMemory { get; }

Property Value

Type	Description
ILegacyTranslationMemory

Methods

ExportTmxFile(EventHandler<BatchExportedEventArgs>)

Exports the legacy TM's data to the path set in the TmxFilePath property.

Declaration

void ExportTmxFile(EventHandler<BatchExportedEventArgs> progressEventHandler)

Parameters

Type	Name	Description
System.EventHandler<BatchExportedEventArgs>	progressEventHandler	A progress event handler which can be used to monitor progress or cancel the export operation.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown when attempting to call this method if the legacy translation memory is a ITmxLegacyTranslationMemory.
System.InvalidOperationException	Thrown when calling this method before the TmxFilePath property is set.