Interface ITranslationProviderWinFormsUI

This interface should be implemented by translation provider implementers in order to provide user interface functionality in SDL Trados Studio specific to that type of translation provider. Implementation of this interface should be marked up with the TranslationProviderWinFormsUiAttribute attribute for registration it with the plug-in manager.

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public interface ITranslationProviderWinFormsUI

Properties

SupportsEditing

Determines whether this supplied translation provider can be edited (i.e. whether any settings can be changed).

Declaration

bool SupportsEditing { get; }

Property Value

Type	Description
System.Boolean	true if the provider's settings can be changed, and false otherwise.

TypeDescription

Gets the type description of the factory; e.g. "A plug-in provider to use Language Weaver machine translation engines."

Declaration

string TypeDescription { get; }

Property Value

Type	Description
System.String

TypeName

Gets the type name of the factory; e.g. "Language Weaver Translation Provider"

Declaration

string TypeName { get; }

Property Value

Type	Description
System.String

Methods

Browse(IWin32Window, LanguagePair[], ITranslationProviderCredentialStore)

Displays a dialog to interactively browse for one or more translation providers.

Declaration

ITranslationProvider[] Browse(IWin32Window owner, LanguagePair[] languagePairs, ITranslationProviderCredentialStore credentialStore)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	The window that will own the dialog
LanguagePair[]	languagePairs	A collection of language pairs. If provided, the list of available translation providers will be filtered by these language directions.
ITranslationProviderCredentialStore	credentialStore	A credential store object that can be used to retrieve credentials required.

Returns

Type	Description
ITranslationProvider[]	A collection of translation providers selected by the user, or null if none were selected or available or the browse was cancelled.

Edit(IWin32Window, ITranslationProvider, LanguagePair[], ITranslationProviderCredentialStore)

Displays a dialog to interactively change any of the translation provider settings.

Declaration

bool Edit(IWin32Window owner, ITranslationProvider translationProvider, LanguagePair[] languagePairs, ITranslationProviderCredentialStore credentialStore)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	The window that will own the dialog
ITranslationProvider	translationProvider	A translation provider descriptor, representing the translation provider to edit.
LanguagePair[]	languagePairs	A collection of language pairs. If provided, the list of available translation providers will be filtered by these language directions.
ITranslationProviderCredentialStore	credentialStore	A credential store object that can be used to retrieve credentials required.

Returns

Type	Description
System.Boolean	True if changes were made to the translation provider; false otherwise.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown when calling this method while SupportsEditing return false .

GetCredentialsFromUser(IWin32Window, Uri, String, ITranslationProviderCredentialStore)

Gets the credentials from the user and puts these credentials in the credential store.

Declaration

bool GetCredentialsFromUser(IWin32Window owner, Uri translationProviderUri, string translationProviderState, ITranslationProviderCredentialStore credentialStore)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	The window that will own the dialog
System.Uri	translationProviderUri	translation provider uri
System.String	translationProviderState	translation provider state
ITranslationProviderCredentialStore	credentialStore	credential store

Returns

Type	Description
System.Boolean	true if the user provided credentials or false if the user canceled

GetDisplayInfo(Uri, String)

Gets display information for the specified translation provider.

Declaration

TranslationProviderDisplayInfo GetDisplayInfo(Uri translationProviderUri, string translationProviderState)

Parameters

Type	Name	Description
System.Uri	translationProviderUri	A translation provider URI, representing the translation provider.
System.String	translationProviderState	Optional translation provider state information, which can be used to determine certain aspects of the display information.

Returns

Type	Description
TranslationProviderDisplayInfo	A TranslationProviderDisplayInfo object, containing display information that allows an application to represent the translation provider without having to instantiate it.

Remarks

Note that this method can potentially be called very frequently so it is not advisable to instantiate the translation provider within its implementation.

SupportsTranslationProviderUri(Uri)

Returns true if this component supports the specified translation provider URI.

Declaration

bool SupportsTranslationProviderUri(Uri translationProviderUri)

Parameters

Type	Name	Description
System.Uri	translationProviderUri	The uri.

Returns

Type	Description
System.Boolean	True if this component supports the specified translation provider URI.