Click or drag to resize
TranslationMemoryIterator Class
Base iterator class. Contains the common properties needed for iteration through a translation memory.
Inheritance Hierarchy

Namespace: Sdl.LanguagePlatform.TranslationMemory
Assembly: Sdl.LanguagePlatform.TranslationMemory (in Sdl.LanguagePlatform.TranslationMemory.dll) Version: 1.6.0.0 (1.7.3662.0)
Syntax
public abstract class TranslationMemoryIterator

The TranslationMemoryIterator type exposes the following members.

Constructors
  NameDescription
Protected methodTranslationMemoryIterator
Initializes a new instance with default values (the max count is set to 100).
Protected methodTranslationMemoryIterator(Int32)
Initializes a new instance with the specified values.
Top
Properties
  NameDescription
Public propertyFilter
Gets or sets the filter used by this iterator.

Only translation units satisfying this filter will be returned.

Public propertyForward
Gets or sets whether this iterator is moving forward or backward to retrieve the next page of translation units.
Public propertyMaxCount
Gets or sets the maximum number of translation units that this iterator will return to the caller in one step.
Public propertyMaxScan
Gets or sets the maximum number of translation units that this iterator will retrieve from the TM in one step. If 0, the number will be unlimited. Note that while MaxCount limits the number of TUs returned to the caller, MaxScan limits the number of TUs retrieved from the storage. This facilitates cancellation and progress reporting in cases where the iterator's filter conditions require many (or all) TUs retrieved from the storage to fill the result set.

Since TUs are retrieved from storage in batches of size MaxCount, the number of scanned TUs in one iteration may actually be larger than the MaxScan value.

Public propertyProcessedTranslationUnits
Gets or sets the number of translation units processed by this iterator since its creation.
Public propertyScannedTranslationUnits
Gets or sets the number of translation units processed by this iterator in the last roundtrip.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReset
Repositions the iterator at the beginning of the translation memory.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments