Search Results for

    Show / Hide Table of Contents

    Class TranslationProviderConfiguration

    This class represents the configuration settings related to the use of translation providers within a project, including the list of translation providers to use, the project translation memories and in which scenarios to use these translation providers.

    Inheritance
    System.Object
    TranslationProviderConfiguration
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Sdl.ProjectAutomation.Core
    Assembly: Sdl.ProjectAutomation.Core.dll
    Syntax
    public class TranslationProviderConfiguration
    Remarks

    The translation provider configuration can be defined on the project level (see GetTranslationProviderConfiguration()) and can be overridden for a specific project target language (see GetTranslationProviderConfiguration(Language) and UpdateTranslationProviderConfiguration(TranslationProviderConfiguration)).

    Constructors

    TranslationProviderConfiguration()

    Default constructor. Creates an empty configuration that doesn't override the parent.

    Declaration
    public TranslationProviderConfiguration()

    TranslationProviderConfiguration(List<TranslationProviderCascadeEntry>, Boolean, Boolean)

    Constructor that takes the given cascade entry items, cascade search mode, and override parent flag.

    Declaration
    public TranslationProviderConfiguration(List<TranslationProviderCascadeEntry> entries, bool stopSearchingWhenResultsFound, bool overrideParent)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TranslationProviderCascadeEntry> entries

    The cascade entries. Can be empty, but not null.

    System.Boolean stopSearchingWhenResultsFound

    Whether to stop searching translation providers once a result has been found. The translation providers are usually searched sequentially in the order they are specified in the Entries list.

    System.Boolean overrideParent

    Whether this configuration should override the parent translation provider configuration. This is only applicable when working with a target-language specific translation provider configuration (see GetTranslationProviderConfiguration(Language) and UpdateTranslationProviderConfiguration(TranslationProviderConfiguration)).

    Properties

    Entries

    Gets or sets the ordered list of translation provider cascade entries in this configuration. Can be empty but not null.

    Declaration
    public List<TranslationProviderCascadeEntry> Entries { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<TranslationProviderCascadeEntry>
    Remarks

    The order of the entries in this list is significant. It determines the order in which look-ups and updates are performed. When StopSearchingWhenResultsFound is set to

    true
    , this means the results returned could be different depending on the order of the entries.

    OverrideParent

    Gets or sets whether this configuration should override the parent translation provider configuration. This is only applicable when working with a target-language specific translation provider configuration (see GetTranslationProviderConfiguration(Language) and UpdateTranslationProviderConfiguration(TranslationProviderConfiguration)).

    Declaration
    public bool OverrideParent { get; set; }
    Property Value
    Type Description
    System.Boolean

    StopSearchingWhenResultsFound

    Gets or sets whether to stop searching translation providers once a result has been found. The translation providers are usually searched sequentially in the order they are specified in the Entries list.

    Declaration
    public bool StopSearchingWhenResultsFound { get; set; }
    Property Value
    Type Description
    System.Boolean

    On this page

    • Constructors
      • TranslationProviderConfiguration()
      • TranslationProviderConfiguration(List<TranslationProviderCascadeEntry>, Boolean, Boolean)
    • Properties
      • Entries
      • OverrideParent
      • StopSearchingWhenResultsFound
    Back to top Generated by DocFX