Interface ITerminologyProviderWinFormsUI

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

Namespace: Sdl.Terminology.TerminologyProvider.Core
Assembly: Sdl.Terminology.TerminologyProvider.Core.dll
Syntax
public interface ITerminologyProviderWinFormsUI

Properties

SupportsEditing

Determines whether this supplied terminology 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 Cloud-Based Terminology."

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

TypeName

Gets the type name of the factory; e.g. "Cloud-Based Terminology Provider"

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

Methods

Browse(IWin32Window, ITerminologyProviderCredentialStore)

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

Declaration
ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
Parameters
Type Name Description
System.Windows.Forms.IWin32Window owner

The window that will own the dialog
ITerminologyProviderCredentialStore credentialStore

A credential store object that can be used to retrieve credentials required.

Returns
Type Description
ITerminologyProvider[]

A collection of terminology providers selected by the user, or null if none were selected or available or the browse was canceled.

Edit(IWin32Window, ITerminologyProvider)

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

Declaration
bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
Parameters
Type Name Description
System.Windows.Forms.IWin32Window owner

The window that will own the dialog
ITerminologyProvider terminologyProvider

A terminology provider descriptor, representing the terminology provider to edit.
Returns
Type Description
System.Boolean

True if changes were made to the terminology provider; false otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when calling this method while SupportsEditing return 

false
.

GetDisplayInfo(Uri)

Gets display information for the specified terminology provider.

Declaration
TerminologyProviderDisplayInfo GetDisplayInfo(Uri terminologyProviderUri)
Parameters
Type Name Description
System.Uri terminologyProviderUri

A terminology provider URI, representing the terminology provider.
Returns
Type Description
TerminologyProviderDisplayInfo

A TerminologyProviderDisplayInfo object, containing display information that allows an application to represent the terminology 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.

SupportsTerminologyProviderUri(Uri)

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

Declaration
bool SupportsTerminologyProviderUri(Uri terminologyProviderUri)
Parameters
Type Name Description
System.Uri terminologyProviderUri

The uri.
Returns
Type Description
System.Boolean

True if this component supports the specified terminology provider URI.