Search Results for

    Show / Hide Table of Contents

    Namespace Sdl.LanguagePlatform.TranslationMemory

    Classes

    AppliedPenalty

    Represents the penalty applied to a search result.

    AtomicExpression

    Base class for filter expressions. Expressions can be atomic or composed.

    ComposedExpression

    Base class for filter expressions. Expressions can be atomic or composed.

    DateTimeFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    DocumentDetail

    DuplicateIterator

    Base iterator class. Contains the common properties needed for iteration through a translation memory.

    DuplicateIterator.DuplicateIteratorPosition

    Represents a position within the translation memory of this iterator.

    ExportSettings

    Encapsulates settings and parameters for export.

    ExportStatistics

    Encapsulates the results of an export process without keeping track of the individual action taken for each exported TU.

    Field

    Represents a field declaration.

    FieldDefinitions

    Encapsulates a set of field declarations. Fields are identified through their name or through their GUID. Note that field names are case-insensitive.

    FieldIdentifier

    FieldIdentifier class uniquely identifies a field by the field value type and the field name.

    FieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    FieldValues

    Encapsulates a collection of field values.

    Filter

    Represents a filter meant to retrieve a subset of translation units from a translation memory.

    FilterExpression

    Base class for filter expressions. Expressions can be atomic or composed.

    FilterExpressionParser

    Provides a parser that can read a filter expression from a string and create an equivalent FilterExpression object.

    The returned object can be serialized back into an equivalent string, which may not look exactly like the original input. That is because the parser normalizes the input, by surrounding field names and values with double quotes and by adding brackets.

    Field names are case insensitive and so are string values.

    Picklist values are case sensitive and the parser will throw an error if the expression contains a value not defined by the specified field.

    FuzzyIndexTuningSettings

    Settings which affect the performance of the fuzzy index. A specific storage implementation may, but does not have to, honor any tuning settings.

    ImportResult

    Encapsulates information about the result of an import operation.

    ImportResults

    Encapsulates the results of an import process without keeping track of the individual action taken for each import TU. The ImportResults give more detail.

    ImportSettings

    Represents a group of settings which control the way the import is executed.

    ImportStatistics

    Encapsulates the results of an import process without keeping track of the individual action taken for each import TU. The ImportResults give more detail.

    IntFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    LogManager

    MultiplePicklistFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    MultipleStringFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    NLogLogger

    Penalty

    Represents a penalty, which is a combination of a penalty type and a penalty value (the malus).

    PersistentObject

    A base class for various translation memory objects which are persisted, such as translation units. This class is for internal purposes only and not intended to be used by the end user.

    PersistentObjectToken

    Encapsulates the primary key of a PersistentObject, such as a TM, TU, or Field Declaration.

    PicklistField

    Represents a field declaration.

    PicklistItem

    Represents a picklist item in a picklist field declaration.

    PicklistItems

    Encapsulates a collection of picklist items.

    Placeable

    A placeable is a combination of a source token index together with a target token index. Either index can be -1, indicating that no corresponding token pair exists (or no appropriate segment was available). Not both of the indices should be -1.

    PlaceableAssociation

    A placeable association is a correspondence between two placeables, one in the source segment, and one in the target segment. Either may be null, but not both at the same time. If a placeable is null and the other isn't, it means that the respective segment wasn't available when the placeables were computed, or that no association could be found.

    PlaceableComputer

    Provides methods to compute placeables and their alignments from two segments, or from a translation unit.

    RegularIterator

    Base iterator class. Contains the common properties needed for iteration through a translation memory.

    ScoringResult

    Represents the score for a search result.

    SearchResult

    Encapsulates the result of a search operation, a memory translation unit, possiby annotated with score, placeables and context information.

    SearchResultFieldValueAccessor

    A class which allows to use a search result as a ITypedKeyValueContainer.

    SearchResultFieldValueComparer

    Implements a comparer for search results.

    SearchResults

    Represents a set of results returned by the translation memory after a search operation for a given input (segment/translation unit/string).

    SearchResultsMerged

    Represents a set of results returned by the translation memory after a search operation for a given input (segment/translation unit/string).

    SearchSettings

    Represents a set of settings relevant for search opeartions.

    SegmentAndSubsegmentSearchResults

    Represents a set of results returned by the translation memory after a search operation for a given input (segment/translation unit/string).

    SegmentAndSubsegmentSearchResultsMerged

    Represents a set of results returned by the translation memory after a search operation for a given input (segment/translation unit/string).

    SegmentSerializer

    SinglePicklistFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    SingleStringFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    SortCriterium

    Encapsulates a sort criterium.

    SortDisambiguator

    Disambiguator to identify the sort order, by comparing two search results.
    Ambiguation occurs when the match results are qualified as being identical, which would require
    further elaboration to establish which result is more significant, taking into consideration the presedence of the translation providers, from where the results are derived.

    SortSpecification

    Encapsulates a set of criteria used for sorting translation units.

    The order in which the different criteria are added to a sort specification is essential. Only if two translation units are equivalent according to a sort criterium, the next relevant criterium will be considered in order to decide which of the translation units comes first and so on.

    The sort specification consists of a collection of SortCriterium objects which in turn may refer to system fields or filter names, and include a specification whether to sort ascending or descending. Typical examples are: Sco/D UsD/D which sorts descending by score and descending by last usage date.

    Sorter<T>

    A Sorter<T> implements the generic IComparer<T> interface to compare two objects of type T, using a caller-supplied sort specification (which includes the fields to consider during sorting, and the sort direction). A field value resolver then is used to retrieve, for a specific field, the value of that field in each of the two instaces which are currently compared.

    SubsegmentSearchResult

    Encapsulates the result of a search operation, a memory translation unit, possiby annotated with score, placeables and context information.

    SubsegmentSearchResults

    Represents a set of results returned by the translation memory after a subsegment search operation for a given input (segment/translation unit/string).

    SubsegmentSearchResultsCollection

    A collection of SubsegmentSearchResults produced by performing subsegment matching for a segment.

    SubsegmentSearchSettings

    Represents a set of settings relevant for search opeartions.

    SystemFields

    Encapsulates the system fields of a translation unit.

    SystemFieldsKeys

    Used for systemFields metadata keys

    SystemFieldsParameters

    TranslationMemoryIterator

    Base iterator class. Contains the common properties needed for iteration through a translation memory.

    TranslationMemoryProgress

    TranslationUnit

    Represents a pair of source and target text, decorated with a set of system fields and eventually, with a set of user defined fields/attributes. It may also contain contextual information as well as information about its origin and eventually, a key for unique identification on a given system.

    TuContext

    Encapsulates information about the context of a translation unit relative to other translation units within a document.

    TuContexts

    A collection of translation unit context objects.

    The same translation unit may occur in different places within a document, thus having different contexts.

    TuIdContexts

    A collection of translation unit idcontext objects.

    The same translation unit may occur in different places within a document, thus having different contexts.

    TuLimitsValidatorSettings

    Settings object for a TU limits validator

    Utilities

    General utilities.

    WordCounter

    Provides WordCounts for a set of tokens, where necessary converting TokenType.Word tokens for JA/ZH et al back to TokenType.CharSequence to produce 'legacy' results. When creating word counts for multiple segments, use a single WordCounter object and call GetWordCountsAsync(IList<Token>, WordCountsOptions, CultureCode) repeatedly, to avoid repeated tokenizer creation in those cases.

    WordCounts

    Represents the result of a word count.

    WordCountsOptions

    Interfaces

    IAttribute

    Attribute data, V2 schema.

    IField

    Represents a field declaration.

    IFieldDefinitions

    Represents an enumerable collection of fields, with getters by name and by GUID.

    IFieldTemplate

    Field template, V2 schema.

    IFieldValueComparer<T>

    Defines a generic method for comparing objects that expose fields.

    ILogLogger

    IPicklistOption

    PicklistItem, V2 schema.

    ITypedKeyValueContainer

    Simplified interface for retrieving field values.

    An object that has field values associated with it should implement this interface (such as TranslationUnit).

    Enums

    Action

    Represents the action taken for a translation unit during an import operation.

    AdaptiveMachineTranslationLookupMode

    Specifies how to use adaptive machine translation.

    AtomicExpression.Operator

    Specifies the operators available in an atomic expression.

    ComposedExpression.Operator

    Specifies the operators available in a composed expression.

    FGASupport

    Specifies the fine-grained-alignment support status

    FieldType

    The type of a field, i.e. whether it's a user-defined field, a system-defined field, a pseudo field, etc.

    FieldValueType

    Specifies the type of a field declaration or value.

    The field type define the operators that can be applied to a particular field value.

    FuzzyIndexes

    Specifies the fuzzy index type.

    ImportSettings.FieldUpdateMode

    Specifies how existing custom field data should be updated.

    ImportSettings.ImportTUProcessingMode

    Controls whether cleanup heuristics are applied to TUs being read and which ones are processed by the importer.

    ImportSettings.NewFieldsOption

    Specifies how the system should react if an import or an add operation would result in a change to the setup (such as implicitly adding unknown fields or field values).

    ImportSettings.TUUpdateMode

    The mode to update TU when a TU with the same source segment already exists in the TM

    ImportStatus

    Translation Memory Import Status

    MachineTranslationLookupMode

    Specifies when to use machine translation.

    PenaltyType

    Specifies the penalty type.

    PlaceableType

    Specifies the type of a placeable.

    SearchMode

    Specifies the search type.

    SortDirection

    Specifies the sort direction, ascending or descending.

    SubsegmentMatchType

    Specifies the type of a subsegment match

    SubsegmentSearchCondition

    Specifies the conditions under which subsegment matching should be performed

    TextContextMatch

    Specifies the type of a context match.

    TextContextMatchType

    Indicates what kind of text context match a TM will use

    TranslationUnitFormat

    The original format of the Translation Unit, if imported from legacy sources.

    TranslationUnitOrigin

    Specifies the origin of a translation unit.

    WordCountFlags

    Flags controlling word count behaviour

    Delegates

    SearchResults.SearchResultComparer

    Represents a method which compares two search results, and returns a value indicating the sort order.

    SortDisambiguator.Disambiguator

    Represents a method which compares two objects, and returns a value indicating the sort order.

    In this article
    • Classes
    • Interfaces
    • Enums
    • Delegates
    Back to top Generated by DocFX