Interface ITranslationMemory

Represents a translation memory.

Inherited Members
Namespace: Sdl.LanguagePlatform.TranslationMemoryApi
Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll
Syntax
public interface ITranslationMemory : ITranslationProvider, ISupportPlaceables

Properties

Gets or sets the copyright string for this translation memory.

Declaration
string Copyright { get; set; }
Property Value
Type Description
System.String

You have to call Save() in order to persist changes to this property.

CreationDate

Gets the creation date of this translation memory.

Declaration
DateTime CreationDate { get; }
Property Value
Type Description
System.DateTime

CreationUserName

Gets the creation user of this translation memory.

Declaration
string CreationUserName { get; }
Property Value
Type Description
System.String

Description

Gets or sets a general description of the translation memory.

Declaration
string Description { get; set; }
Property Value
Type Description
System.String
Remarks

You have to call Save() in order to persist changes to this property.

ExpirationDate

Gets or sets the expiration date for this translation memory.

Declaration
DateTime? ExpirationDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
Remarks

You have to call Save() in order to persist changes to this property.

FieldDefinitions

Gets the custom fields defined for this TM.

Declaration
FieldDefinitionCollection FieldDefinitions { get; }
Property Value
Type Description
FieldDefinitionCollection
Remarks

In case this is a server-based translation memory, which is associated with a fields template (see IFieldsTemplate), this returns a read-only fields collection identical to the template's fields collection. In all other cases, the field collection returned can be modified. Note that you have to call Save() to persist any changes made to the fields.

FuzzyIndexes

Gets or sets the set of fuzzy indices defined on this TM.

Declaration
FuzzyIndexes FuzzyIndexes { get; set; }
Property Value
Type Description
FuzzyIndexes

FuzzyIndexStatisticsRecomputedAt

Gets the time of the last fuzzy index statistics recomputation of this TM, if available.

Declaration
DateTime? FuzzyIndexStatisticsRecomputedAt { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

FuzzyIndexStatisticsSize

Gets the size of the TM at the point of the last fuzzy index statistics recomputation, if available.

Declaration
int? FuzzyIndexStatisticsSize { get; }
Property Value
Type Description
System.Nullable<System.Int32>

FuzzyIndexTuningSettings

Gets or sets the fuzzy index tuning settings for the TM.

Declaration
FuzzyIndexTuningSettings FuzzyIndexTuningSettings { get; set; }
Property Value
Type Description
FuzzyIndexTuningSettings

SupportedLanguageDirections

Gets the list of language directions which are supported by this translation memory.

Declaration
ReadOnlyCollection<LanguagePair> SupportedLanguageDirections { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<LanguagePair>

Methods

Delete()

Deletes this translation memory.

Declaration
void Delete()
Remarks

In the case of a file-based translation memory, this deletes the translation memory file itself. Server-based translation memories are deleted from the server, including all their content.

GetLanguageDirection(LanguagePair)

Gets a specified translation memory language direction.

Declaration
ITranslationMemoryLanguageDirection GetLanguageDirection(LanguagePair languageDirection)
Parameters
Type Name Description
LanguagePair languageDirection

The language direction.
Returns
Type Description
ITranslationMemoryLanguageDirection

A translation provider for the specified language direction, or null if no language direction matches.

GetTranslationUnitCount()

Gets the total translation unit count for all language directions in this translation memory.

Declaration
int GetTranslationUnitCount()
Returns
Type Description
System.Int32

The total translation unit count for this TM.

HasPermission(String)

Checks whether the current user has the specified permission on this translation memory.

Declaration
bool HasPermission(string permission)
Parameters
Type Name Description
System.String permission

A permission ID. See TranslationMemoryPermissions.
Returns
Type Description
System.Boolean

True if the user has the specified permission for this TM.

RecomputeFuzzyIndexStatistics()

Synchronously recomputes the fuzzy index statistics of the TM.

Declaration
void RecomputeFuzzyIndexStatistics()

Save()

Saves changes made to properties of this translation memory.

Declaration
void Save()

ShouldRecomputeFuzzyIndexStatistics()

Gets a flag which indicates whether it is recommended to recompute the fuzzy index statistics (see RecomputeFuzzyIndexStatistics()).

Declaration
bool ShouldRecomputeFuzzyIndexStatistics()
Returns
Type Description
System.Boolean