Interface ITerminologyProviderViewerWinFormsUI

This interface should be implemented by terminology provider implementers that are able to provide more information about a term when required in the Trados Studio Editor View Implementation of this interface should be marked up with the TerminologyProviderViewerWinFormsUIAttribute attribute for registration it with the plug-in manager.

Namespace: Sdl.Terminology.TerminologyProvider.Core

Assembly: Sdl.Terminology.TerminologyProvider.Core.dll

Syntax

public interface ITerminologyProviderViewerWinFormsUI

Properties

CanAddTerm

Returns whether this component supports adding a term.

Declaration

bool CanAddTerm { get; }

Property Value

Type	Description
bool	Returns true if this component supports adding a term; otherwise, false.

Control

The control to be displayed in the Termbase Viewer window in the Editor View

Declaration

Control Control { get; }

Property Value

Type	Description
Control

Initialized

Determines whether the viewer was initialized.

Declaration

bool Initialized { get; }

Property Value

Type	Description
bool

IsEditing

Returns wether this component is in edit mode.

Declaration

bool IsEditing { get; }

Property Value

Type	Description
bool	Returns true if this component is in edit mode; otherwise, false.

SelectedTerm

Gets or sets the term that is currently active in the Termbase Viewer window

Declaration

Entry SelectedTerm { get; set; }

Property Value

Type	Description
Entry

Methods

AddAndEditTerm(Entry, string, string)

The user triggered an add on an already existing term.

Declaration

void AddAndEditTerm(Entry term, string source, string target)

Parameters

Type	Name	Description
Entry	term	The term with the same source that already exists.
string	source	The new text for the source.
string	target	The text for the target.

AddTerm(string, string)

The user requested to add a new entry into the terminology provider.

Declaration

void AddTerm(string source, string target)

Parameters

Type	Name	Description
string	source	The text for the source term.
string	target	The text for the target term.

CancelTerm()

Cancels the current term editing operation.

Declaration

void CancelTerm()

EditTerm(Entry)

The user triggered an editing on the specified term.

Declaration

void EditTerm(Entry term)

Parameters

Type	Name	Description
Entry	term	The term to edit.

Initialize(ITerminologyProvider, CultureCode, CultureCode)

Called when the terminology provider viewer is initialized.

Declaration

void Initialize(ITerminologyProvider terminologyProvider, CultureCode source, CultureCode target)

Parameters

Type	Name	Description
ITerminologyProvider	terminologyProvider	The terminology provider to be used in the current viewer instance.
CultureCode	source	The source language for the current document language direction.
CultureCode	target	The target language for the current document language direction.

JumpToTerm(Entry)

The user requested to see more information about an entry. Usually triggered by the "View term details" action in the Term Recognition window from the Editor View.

Declaration

void JumpToTerm(Entry entry)

Parameters

Type	Name	Description
Entry	entry	The entry which should be displayed in the Termbase Viewer window

Release()

Called when the terminology provider viewer is not needed anymore.

Declaration

void Release()

SaveTerm()

Saves the current state of a term.

Declaration

void SaveTerm()

SupportsTerminologyProviderUri(Uri)

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

Declaration

bool SupportsTerminologyProviderUri(Uri terminologyProviderUri)

Parameters

Type	Name	Description
Uri	terminologyProviderUri	The uri.

Returns

Type	Description
bool	True if this component supports the specified terminology provider URI.

Events

SelectedTermChanged

Triggered when the active term has changed, when triggered it will save the specified term on the active document.

Declaration

event EventHandler<EntryEventArgs> SelectedTermChanged

Event Type

Type	Description
EventHandler<EntryEventArgs>

TermChanged

Triggered when something has in the terminology provider. Usually used when adding, editing or removing a term. This event will trigger a new term recognition for the active segment.

Declaration

event EventHandler TermChanged

Event Type

Type	Description
EventHandler