Studio Developers WIKI

06 Submitting apps for signing and/or publication

Paul — Wed, 04 Jun 2025 08:28:53 GMT

Current Revision posted to Studio Developers WIKI by Paul on 6/4/2025 8:28:53 AM

This article explains how to submit your Trados Studio plug-in (.sdlplugin) for code signing and/or publication on the RWS AppStore. If you are developing plug-ins for distribution (internally or externally), this is a required step to avoid security warnings in Trados Studio and to allow wider deployment. This information is taken from https://developers.rws.com/studio-api-docs/articles/gettingstarted/plugin_deployment.html which should be referred to for the latest information.

When you install an unsigned plug-in in Trados Studio, a security warning will appear at startup:

“Unsigned SDL Trados Studio Plug-in Found...”

To remove this warning, your plug-in must be signed by RWS.

Steps to Request Signing:

Build your plug-in using the official Trados Studio SDK project templates.
Send an email to:
app-signing@sdl.com
Include in the email:
- A brief description of your plug-in
- A download link to the .sdlplugin file (e.g. Dropbox, OneDrive, WeTransfer, etc.)

Once verified, RWS will:

Sign the plug-in on your behalf
Return a signed version via email

You can now distribute this version without triggering the unsigned warning.

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Tue, 13 Feb 2024 16:25:27 GMT

Current Revision posted to Studio Developers WIKI by Patrick Andrew Hartnett on 2/13/2024 4:25:27 PM

There will be significant changes to the Terminology provider API with the release of Trados Studio SR2. These changes are all geared towards decoupling the Multiterm integration from Trados Studio to promote independent development cycles and reduce the risk of compatibility issues. This means that updates, bug fixes, and new features can be developed and released separately and lead to faster development cycles for each product.

Unfortunately, this will introduce breaking changes for plugin and project automation integrations with the Terminology provider API. The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR2

Terminology Provider API

Make reference to the release notes for Trados Studio SR2 when updating your plugin integrations with the Terminology Provider API. It includes all of the API changes that will facilitate better management, customization, and extensibility of terminology providers, providing more flexibility and control for developers and users.

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

The AbstractTerminologyProvider is no longer available & in its place you must implement the ITerminologyProvider interface, which has some new properties & methods such as ActiveFilter property & associated method GetFilters() that enable a user to add filters to restrict the results that provider displays when searching a termbase during translation.

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Terminology Provider Type

Set the Type to TerminologyProviderType.Custom for Third-party terminology providers

public class MyTerminologyProvider : ITerminologyProvider
{
    public TerminologyProviderType Type => TerminologyProviderType.Custom;
}

Definition

Its important to fully describe the DescriptiveFields to the Definition property of the provider to provide sufficient information when integrating with other services, such as the Terminology Verifier. For example: to enable integration with the feature to check for forbidden terms, you should include the DescriptiveField at the TermLevel, as shown here (e.g. var statusField)

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

You will noticed that the property SupportsEditing & the method Edit(IWin32Window owner, ITerminologyProvider terminologyProvider) have been removed from the ITerminologyProviderWinFormsUI interface. If your provider allows a user to edit the provider settings by displaying a settings dialog, then implement the new interface ITerminologyProviderWinFormsUIWithEdit. Additionally, the new interface ITerminologyProviderWinFormsUIWithCreate introduces a new extensibility point that will display a context menu item in the Create button from the Terminology Provider Settings in Trados Studio. This is useful for use cases where the creation of the provider needs to be a separate to the edit settings dialogs.

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

There following are a list of known dependency version changes that may influence your integration with the latest Trados Studio 2022 APIs; this is typically seen from standalone applications that are running outside of the Trados Studio context. To resolve these references, include the following binding redirects in the configuration file of the project.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-7.0.0.0" newVersion="7.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Tue, 13 Feb 2024 15:57:40 GMT

Revision 6 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 2/13/2024 3:57:40 PM

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-7.0.0.0" newVersion="7.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Fri, 10 Nov 2023 14:37:44 GMT

Revision 5 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 11/10/2023 2:37:44 PM

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Fri, 10 Nov 2023 13:49:50 GMT

Revision 4 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 11/10/2023 1:49:50 PM

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

The AbstractTerminologyProvider is no longer available & in its place you must implement the ITerminologyProvider interface, which has some new properties & methods such as ActiveFilter { get; set; } & associated method GetFilters() that enable a user to add filters to restrict the results that provider displays when searching a termbase during translation.

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Fri, 10 Nov 2023 11:30:57 GMT

Revision 3 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 11/10/2023 11:30:57 AM

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

The AbstractTerminologyProvider is no longer available & in its place you must implement the ITerminologyProvider interface, which has some new properties & methods such as ActiveFilter { get; set; } & associated method GetFilters() that enable a user to add filters to restrict the results that provider displays when searching a termbase during translation.

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

Its important to fully describe the DescriptiveFields to the Definition property of the provider to provide sufficient information when integrating with other services, such as the Terminology Verifier. For example: to enable integration with the feature to check for forbidden terms, remember to include the DescriptiveField at the TermLevel as shown here (e.g. var statusField)

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Fri, 10 Nov 2023 11:29:54 GMT

Revision 2 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 11/10/2023 11:29:54 AM

Unfortunately, this will introduce breaking changes for plugin and project automation integrations with the Terminology provider API.

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR2

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

The AbstractTerminologyProvider is no longer available & in its place you must implement the ITerminologyProvider interface, which has some new properties & methods such as ActiveFilter { get; set; } & associated method GetFilters() that enable a user to add filters to restrict the results that provider displays when searching a termbase during translation.

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

Its important to fully describe the DescriptiveFields to the Definition property of the provider to provide sufficient information when integrating with other services, such as the Terminology Verifier. For example: to enable integration with the feature to check for forbidden terms, remember to include the DescriptiveField at the TermLevel as shown here (e.g. var statusField)

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

How to update plugins to Trados Studio 2022 SR2

Patrick Andrew Hartnett — Fri, 10 Nov 2023 11:27:43 GMT

Revision 1 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 11/10/2023 11:27:43 AM

Unfortunately, this will introduce breaking changes for plugin and project automation integrations with the Terminology provider API

Terminology Provider API

Removed Classes and Interfaces: Several classes and interfaces have been removed, such as AbstractTerminologyProvider, IDefinition, IDefinitionLanguage, and others.
Updated Classes: Major changes include the Definition class, Entry, EntryField, EntryLanguage, and others. These updates involve changes in property types, constructors, and interfaces.
TerminologyProviderManager: Now implements ITerminologyProviderManager, offering new methods for managing terminology providers, such as RemoveTerminologyProvider.
ITerminologyProvider Updates: The ITerminologyProvider interface has several new properties and methods for managing active filters, initialization, and more. The type of returned values for methods like GetEntry and Search has changed.
New Interfaces: Several new interfaces have been added, including ITerminologyProviderManager, ITerminologyProviderWinFormsUIWithCreate, and ITerminologyProviderWinFormsUIWithEdit.

Note: A full integration of these new changes to the Terminology Provider API are available from the IATE Terminology Provider for reference.

ITerminologyProvider

The AbstractTerminologyProvider is no longer available & in its place you must implement the ITerminologyProvider interface, which has some new properties & methods such as ActiveFilter { get; set; } & associated method GetFilters() that enable a user to add filters to restrict the results that provider displays when searching a termbase during translation.

public class IATETerminologyProvider : ITerminologyProvider
{
    public FilterDefinition ActiveFilter { get; set; }
 
    public IList<FilterDefinition> GetFilters()
    {
        var filterDefinitions = new List<FilterDefinition>();
        var filterDefinition = new FilterDefinition { ID = 0, Name = "Source contains synonyms" };
        filterDefinitions.Add(filterDefinition);
 
        return filterDefinitions;
    }
}

Definition

Its important to fully describe the DescriptiveFields to the Definition property of the provider to provide sufficient information when integrating with other services, such as the Terminology Verifier. For example: to enable integration with the feature to check for forbidden terms, remember to include the DescriptiveField at the TermLevel as shown here (e.g. var statusField)

public class IATETerminologyProvider : ITerminologyProvider
{
    public Definition Definition => new Definition(GetDescriptiveFields(), GetDefinitionLanguages());
 
    public IList<DescriptiveField> GetDescriptiveFields()
    {
        var result = new List<DescriptiveField>();
 
        var definitionField = new DescriptiveField
        {
            Label = "Definition", Level = FieldLevel.EntryLevel, Mandatory = true, Multiple = true,
            Type = FieldType.String
        };
        result.Add(definitionField);
 
        var statusField = new DescriptiveField
        {
            Label = "Status", Level = FieldLevel.TermLevel, Mandatory = false, Multiple = true,
            Type = FieldType.PickList,
            PickListValues = new[] { "Deprecated", "Obsolete", "Admitted", "Preferred", "Proposed" }
        };
        result.Add(statusField);
 
        return result;
    }
}

public IList<DefinitionLanguage> GetDefinitionLanguages()
{
    var result = new List<DefinitionLanguage>();
 
    var currentProject = SdlTradosStudio.Application?.GetController<ProjectsController>()?.CurrentProject;
    if (currentProject == null) return result;
 
    var projectInfo = currentProject.GetProjectInfo();
 
    result.Add(new DefinitionLanguage
    {
        Locale = projectInfo.SourceLanguage.CultureInfo,
        Name = projectInfo.SourceLanguage.DisplayName
    });
 
    result.AddRange(projectInfo.TargetLanguages.Select(language => new DefinitionLanguage
    {
        Locale = language.CultureInfo,
        Name = language.DisplayName
    }));
 
    return result;
}

ITerminologyProviderWinFormsUI

[TerminologyProviderWinFormsUI]
public class MyTerminologyProviderWinFormsUI : ITerminologyProviderWinFormsUIWithEdit, ITerminologyProviderWinFormsUIWithCreate
{
    public ITerminologyProvider Create()
    {
        // Adds the capability to create a ITerminologyProvider.
        // Allows the creation of an ITerminologyProvider from the UI.It returns a ITerminologyProvider
        return null;
    }
 
    public bool Edit(IWin32Window owner, ITerminologyProvider terminologyProvider)
    {
        // Adds the capability to edit settings.
        // Used to display a dialog to interactively change any of the terminology provider settings.
        return true;
    }
 
    public ITerminologyProvider[] Browse(IWin32Window owner, ITerminologyProviderCredentialStore credentialStore)
    {
        // Adds the capability to select a ITerminologyProvider.
        // Used to display a dialog to add a new terminology provider.
        return null;
    }
}

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version: 17.2. If your plugin has been updated to support these latest changes to the Terminology Provider API, then you should reflect this by setting the minimum supported version of your plugin to 17.2
Max version: 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name:: TradosStudio

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.2" maxversion="17.9" />
</PluginPackage>

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration.

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.1, has been released to support the latest version of Trados Studio 2022 SR1+. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <NetFx40_PInvokeStackResilience enabled="1" />
    <legacyCorruptedStateExceptionsPolicy enabled="true" />
    <ThrowUnobservedTaskException enabled="true" />
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

Trados Studio API

Paul — Fri, 04 Aug 2023 15:58:42 GMT

Current Revision posted to Studio Developers WIKI by Paul on 8/4/2023 3:58:42 PM

Trados Studio API Developers Community Wiki

Welcome to the Wiki of the Trados Studio API Developers Community! This knowledge-base has ambitions to become a comprehensive resource designed to support your journey with the Trados Studio API development. Whether you're a seasoned developer or new to the ecosystem, we want this wiki to be here to provide guidance, helpful tips, and technical insights.

Join us in this collaborative endeavour to learn, develop, and innovate together. We look forward to learning from you what we should have in this wiki, and also to accepting any interesting contributions you'd like to make yourselves.

Developer Licences

Paul — Fri, 04 Aug 2023 11:11:15 GMT

Current Revision posted to Studio Developers WIKI by Paul on 8/4/2023 11:11:15 AM

Requesting a Developer License for Trados Studio

Introduction

Trados Studio, a part of the Trados portfolio, is a leading translation software in the language industry. It provides tools and features that enable users to manage, translate, and review their translation projects efficiently. To expand on its capabilities, Trados offers developer licenses that allow users to create customized solutions to further enhance the Trados experience.

Types of Licenses

There are two primary types of licenses offered by Trados:

1. Desktop License for Trados Studio: This allows you to utilize the full functionality of the Trados Studio software on a single computer.

2. Cloud License for Trados Team or Enterprise solutions: This allows you to use Trados in a cloud-based environment, facilitating team collaboration and streamlining project management.

Requesting a Developer License

To request a developer license, you need to provide certain information to help Trados better understand your needs and potential contributions. The information includes:

- Full name and address: This is necessary for identification and communication purposes.
- Reason for requesting a dev license: Please explain your intended use of the developer license and how it will add value to your work or the Trados community.
- Affiliated company and contact person: If applicable, please specify the company you are working for and who the contact person would be. This information is particularly crucial if you're representing an existing customer.

Please note that Trados does not grant developer licenses indiscriminately. The request will be evaluated based on the valid reasons and potential benefits provided in your application. To apply click on the link available on this page:

Intended Solutions and Pricing

In your request, please specify whether you plan to offer any solutions developed using the dev license on the AppStore. Also, clarify whether you plan to charge for these solutions. This information is essential for us to understand the potential impact and reach of your proposed project.

Technology Partner Programme

Depending on the details you provide in your request, it may be appropriate to consider you for our Technology Partner Programme. This programme is designed to establish collaborations with tech-based entities to co-create advanced solutions for the language industry. Your details may be provided to our Technology Partner Manager, who will then reach out to explore potential collaborations.

By providing accurate and detailed information in your request, you will help us make an informed decision regarding your developer license. We are looking forward to the innovative solutions you aim to develop and the potential positive impacts these could bring to the Trados community.

Developer Licences

Paul — Fri, 04 Aug 2023 10:57:44 GMT

Revision 4 posted to Studio Developers WIKI by Paul on 8/4/2023 10:57:44 AM

Requesting a Developer License for Trados Studio

Introduction

Trados Studio, a part of the Language Cloud portfolio, is a leading translation software in the language industry. It provides tools and features that enable users to manage, translate, and review their translation projects efficiently. To expand on its capabilities, Trados offers developer licenses that allow users to create customized solutions to further enhance the Trados experience.

Types of Licenses

There are two primary types of licenses offered by Trados:

1. Desktop License for Trados Studio: This allows you to utilize the full functionality of the Trados Studio software on a single computer.

2. Cloud License for Trados Team or Enterprise solutions: This allows you to use Trados Studio in a cloud-based environment, facilitating team collaboration and streamlining project management.

Requesting a Developer License

To request a developer license, you need to provide certain information to help Trados better understand your needs and potential contributions. The information includes:

Intended Solutions and Pricing

Technology Partner Programme

Developer Licences

Paul — Fri, 04 Aug 2023 10:56:42 GMT

Revision 3 posted to Studio Developers WIKI by Paul on 8/4/2023 10:56:42 AM

Requesting a Developer License for Trados Studio

Introduction

Types of Licenses

There are two primary types of licenses offered by Trados:

1. Desktop License for Trados Studio: This allows you to utilize the full functionality of the Trados Studio software on a single computer.

2. Cloud License for Trados Team or Enterprise solutions: This allows you to use Trados Studio in a cloud-based environment, facilitating team collaboration and streamlining project management.

Requesting a Developer License

To request a developer license, you need to provide certain information to help Trados better understand your needs and potential contributions. The information includes:

Intended Solutions and Pricing

Technology Partner Programme

Developer Licences

Paul — Fri, 04 Aug 2023 10:50:45 GMT

Revision 2 posted to Studio Developers WIKI by Paul on 8/4/2023 10:50:45 AM

Requesting a Developer License for Trados Studio

Introduction

Types of Licenses

There are two primary types of licenses offered by Trados:

1. Desktop License for Trados Studio: This allows you to utilize the full functionality of the Trados Studio software on a single computer.

2. Cloud License for Trados Team or Enterprise solutions: This allows you to use Trados Studio in a cloud-based environment, facilitating team collaboration and streamlining project management.

Requesting a Developer License

To request a developer license, you need to provide certain information to help Trados better understand your needs and potential contributions. The information includes:

Please note that Trados does not grant developer licenses indiscriminately. The request will be evaluated based on the valid reasons and potential benefits provided in your application.

Intended Solutions and Pricing

Technology Partner Programme

Developer Licences

Paul — Fri, 04 Aug 2023 10:40:16 GMT

Revision 1 posted to Studio Developers WIKI by Paul on 8/4/2023 10:40:16 AM

Knowledgebase

Georgiana Iancu — Thu, 03 Aug 2023 07:28:00 GMT

Current Revision posted to Studio Developers WIKI by Georgiana Iancu on 8/3/2023 7:28:00 AM

Articles related to Trados Studio

Trados Studio API

Georgiana Iancu — Wed, 02 Aug 2023 14:20:32 GMT

Revision 1 posted to Studio Developers WIKI by Georgiana Iancu on 8/2/2023 2:20:32 PM

How to update plugins to Trados Studio 2022 SR1

Paul — Wed, 26 Jul 2023 16:57:38 GMT

Current Revision posted to Studio Developers WIKI by Paul on 7/26/2023 4:57:38 PM

In an effort to achieve consistent behaviour across a range of platforms and applications, some changes have been made to control the way in which language metadata is used in our software. These changes may affect your plugin or application integration with the public APIs, especially if Sdl.Core.Globalization.Language referenced in the project.

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR1

Plugin Manifest
Project References
Language Registry API
Known Issues
- Trados.Community.Toolkit (formally SDL.Community.Toolkit)
- Dependency version changes

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version should be set to: 17.1. If your plugin has been updated to support this latest release of Trados Studio, then you should reflect this by setting the minimum supported version to 17.1
Max version should be set to 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name should be set to: TradosStudio

Example

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.1" maxversion="17.9" />
</PluginPackage>

Project References

The following changes should be applied in the project file (.csproj)

Add a reference to Sdl.Core.Globalization.Async, if your code is making reference to Sdl.Core.Globalization.Language
```
<Reference Include="Sdl.Core.Globalization.Async">
    <HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio17\Sdl.Core.Globalization.Async.dll</HintPath>
</Reference>
```
Note: it is recommended that you use the reserved and well-known MSBuild property $(MSBuildProgramFiles32) as opposed to $(ProgramFiles) to define the location of the 32-bit program folder C:\Program Files (x86)\

To update settings directly in the project file from Visual Studio

Right-click on the project node in the Solution Explorer and select Unload Project.
Then, right-click on the project and choose Edit <projectname>

Once you have applied your changes in the project file, then reload project

In the Solution Explorer, select the projects you want to load (press Ctrl while clicking to select more than one project)
Then right-click on the project and choose Reload Project.

Language Registry API

Third party developers now have access to Trados Studio's custom language registry, which offers finer control over language management than the language registry provided by Microsoft. Following this change, CultureCode is now the recommended alternative to the standard CultureInfo.

To ensure compatibility with Studio and other RWS system interfacing with Studio please recover the language info using our internal language registry

private CultureCode GetCultureCode(string cultureIsoCode)
{
    try
    {
        // Language registry contains all the languages that are supported in Studio               
        var language = LanguageRegistryApi.Instance.GetLanguage(cultureIsoCode);
        return new CultureCode(language.CultureInfo);
    }
    catch (UnsupportedLanguageException)
    {
        // In case the language is not supported an exception is thrown
        return null;
    }
}

Use LanguageRegistryApi.Instance to recover all langauges

private IList<Language> GetAllLanguages()
{  
    return LanguageRegistryApi.Instance.GetAllLanguages()
}

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.0, has been released to support the latest version of Trados Studio 2022 SR1. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="icu.net" publicKeyToken="416fdd914afa6b66" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-2.7.0.0" newVersion="2.7.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

Tags: Trados Studio 2022 SR1

How to update plugins to Trados Studio 2022 SR1

Patrick Andrew Hartnett — Fri, 14 Jul 2023 14:26:39 GMT

Revision 12 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 7/14/2023 2:26:39 PM

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR1

Plugin Manifest
Project References
Language Registry API

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version should be set to: 17.1. If your plugin has been updated to support this latest release of Trados Studio, then you should reflect this by setting the minimum supported version to 17.1
Max version should be set to 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name should be set to: TradosStudio

Example

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.1" maxversion="17.9" />
</PluginPackage>

Project References

The following changes should be applied in the project file (.csproj)

Add a reference to Sdl.Core.Globalization.Async, if your code is making reference to Sdl.Core.Globalization.Language
```
<Reference Include="Sdl.Core.Globalization.Async">
    <HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio17\Sdl.Core.Globalization.Async.dll</HintPath>
</Reference>
```
Note: it is recommended that you use the reserved and well-known MSBuild property $(MSBuildProgramFiles32) as opposed to $(ProgramFiles) to define the location of the 32-bit program folder C:\Program Files (x86)\

To update settings directly in the project file from Visual Studio

Right-click on the project node in the Solution Explorer and select Unload Project.
Then, right-click on the project and choose Edit <projectname>

Once you have applied your changes in the project file, then reload project

In the Solution Explorer, select the projects you want to load (press Ctrl while clicking to select more than one project)
Then right-click on the project and choose Reload Project.

Language Registry API

To ensure compatibility with Studio and other RWS system interfacing with Studio please recover the language info using our internal language registry

private CultureCode GetCultureCode(string cultureIsoCode)
{
    try
    {
        // Language registry contains all the languages that are supported in Studio               
        var language = LanguageRegistryApi.Instance.GetLanguage(cultureIsoCode);
        return new CultureCode(language.CultureInfo);
    }
    catch (UnsupportedLanguageException)
    {
        // In case the language is not supported an exception is thrown
        return null;
    }
}

Use LanguageRegistryApi.Instance to recover all langauges

private IList<Language> GetAllLanguages()
{  
    return LanguageRegistryApi.Instance.GetAllLanguages()
}

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.0, has been released to support the latest version of Trados Studio 2022 SR1. This includes the following assemblies:

Dependency version changes

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="icu.net" publicKeyToken="416fdd914afa6b66" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-2.7.0.0" newVersion="2.7.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

Tags: Trados Studio 2022 SR1

How to update plugins to Trados Studio 2022 SR1

Patrick Andrew Hartnett — Fri, 14 Jul 2023 14:25:19 GMT

Revision 11 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 7/14/2023 2:25:19 PM

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR1

Plugin Manifest
Project References
Language Registry API

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version should be set to: 17.1. If your plugin has been updated to support this latest release of Trados Studio, then you should reflect this by setting the minimum supported version to 17.1
Max version should be set to 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name should be set to: TradosStudio

Example

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.1" maxversion="17.9" />
</PluginPackage>

Project References

The following changes should be applied in the project file (.csproj)

Add a reference to Sdl.Core.Globalization.Async, if your code is making reference to Sdl.Core.Globalization.Language
```
<Reference Include="Sdl.Core.Globalization.Async">
    <HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio17\Sdl.Core.Globalization.Async.dll</HintPath>
</Reference>
```
Note: it is recommended that you use the reserved and well-known MSBuild property $(MSBuildProgramFiles32) as opposed to $(ProgramFiles) to define the location of the 32-bit program folder C:\Program Files (x86)\

To update settings directly in the project file from Visual Studio

Right-click on the project node in the Solution Explorer and select Unload Project.
Then, right-click on the project and choose Edit <projectname>

Once you have applied your changes in the project file, then reload project

In the Solution Explorer, select the projects you want to load (press Ctrl while clicking to select more than one project)
Then right-click on the project and choose Reload Project.

Language Registry API

To ensure compatibility with Studio and other RWS system interfacing with Studio please recover the language info using our internal language registry

private CultureCode GetCultureCode(string cultureIsoCode)
{
    try
    {
        // Language registry contains all the languages that are supported in Studio               
        var language = LanguageRegistryApi.Instance.GetLanguage(cultureIsoCode);
        return new CultureCode(language.CultureInfo);
    }
    catch (UnsupportedLanguageException)
    {
        // In case the language is not supported an exception is thrown
        return null;
    }
}

Use LanguageRegistryApi.Instance to recover all langauges

private IList<Language> GetAllLanguages()
{  
    return LanguageRegistryApi.Instance.GetAllLanguages()
}

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.0, has been released to support the latest version of Trados Studio 2022 SR1. This includes the following assemblies:

Dependency version changes

There following are a list of known dependency version changes that may influence your integration with the latest Trados Studio 2022 APIs; this is typically seen from standalone applications that are running outside of the Trados Studio context. To resolve the references, include the following binding redirects in the configuration file of the project.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="icu.net" publicKeyToken="416fdd914afa6b66" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-2.7.0.0" newVersion="2.7.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

Tags: Trados Studio 2022 SR1

How to update plugins to Trados Studio 2022 SR1

Patrick Andrew Hartnett — Fri, 14 Jul 2023 13:27:22 GMT

Revision 10 posted to Studio Developers WIKI by Patrick Andrew Hartnett on 7/14/2023 1:27:22 PM

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2022 SR1

Plugin Manifest
Project References
Language Registry API

Plugin Manifest

The manifest file pluginpackage.manifest.xml is located at the root of your project solution. The values of the RequiredProduct should be updated to align with the latest release.

RequiredProduct

Min version should be set to: 17.1. If your plugin has been updated to support this latest release of Trados Studio, then you should reflect this by setting the minimum supported version to 17.1
Max version should be set to 17.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
Name should be set to: TradosStudio

Example

<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
  <PlugInName>My plugin name</PlugInName>
  <Version>1.1.0.0</Version>
  <Description>My plugin description</Description>
  <Author>Trados AppStore Team</Author>
  <RequiredProduct name="TradosStudio" minversion="17.1" maxversion="17.9" />
</PluginPackage>

Project References

The following changes should be applied in the project file (.csproj)

Add a reference to Sdl.Core.Globalization.Async, if your code is making reference to Sdl.Core.Globalization.Language
```
<Reference Include="Sdl.Core.Globalization.Async">
    <HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio17\Sdl.Core.Globalization.Async.dll</HintPath>
</Reference>
```
Note: it is recommended that you use the reserved and well-known MSBuild property $(MSBuildProgramFiles32) as opposed to $(ProgramFiles) to define the location of the 32-bit program folder C:\Program Files (x86)\

To update settings directly in the project file from Visual Studio

Right-click on the project node in the Solution Explorer and select Unload Project.
Then, right-click on the project and choose Edit <projectname>

Once you have applied your changes in the project file, then reload project

In the Solution Explorer, select the projects you want to load (press Ctrl while clicking to select more than one project)
Then right-click on the project and choose Reload Project.

Language Registry API

To ensure compatibility with Studio and other RWS system interfacing with Studio please recover the language info using our internal language registry

private CultureCode GetCultureCode(string cultureIsoCode)
{
    try
    {
        // Language registry contains all the languages that are supported in Studio               
        var language = LanguageRegistryApi.Instance.GetLanguage(cultureIsoCode);
        return new CultureCode(language.CultureInfo);
    }
    catch (UnsupportedLanguageException)
    {
        // In case the language is not supported an exception is thrown
        return null;
    }
}

Use LanguageRegistryApi.Instance to recover all langauges

private IList<Language> GetAllLanguages()
{  
    return LanguageRegistryApi.Instance.GetAllLanguages()
}

Known Issues

The following are a list of known issues and solutions that you might encounter depending on your settings and configuration

Trados.Community.Toolkit (formally SDL.Community.Toolkit)

A new version of the Trados Community Toolkit, version 4.1.0, has been released to support the latest version of Trados Studio 2022 SR1. This includes the following assemblies:

Dependency version changes

There following are a list of known dependency version changes that may influence your integration with the latest Trados Studio 2022 APIs; this is typically seen from standalone applications that are running outside of the Trados Studio context. To resolve, include the following binding redirects in the configuration file of the project.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="icu.net" publicKeyToken="416fdd914afa6b66" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-2.7.0.0" newVersion="2.7.0.0" />
      </dependentAssembly>
      <dependentAssembly>
        <assemblyIdentity name="Microsoft.Data.SqlClient" publicKeyToken="23ec7fc2d6eaa4a5" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-5.0.0.0" newVersion="5.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

Tags: Trados Studio 2022 SR1