| RegularIterator Class |
Represents a regular iterator that can retrieve all the translation units from a translation memory page by page.
The iterator can have a filter, in which case it will only return those translation units that match the filter.
The default page for this iterator is 100 translation units.
Inheritance HierarchySystemObject
Sdl.LanguagePlatform.TranslationMemoryTranslationMemoryIterator
Sdl.LanguagePlatform.TranslationMemoryRegularIterator
Sdl.LanguagePlatform.TranslationMemoryTranslationMemoryIterator
Sdl.LanguagePlatform.TranslationMemoryRegularIterator
Namespace: Sdl.LanguagePlatform.TranslationMemory
Assembly: Sdl.LanguagePlatform.TranslationMemory (in Sdl.LanguagePlatform.TranslationMemory.dll) Version: 1.6.0.0 (1.7.3662.0)
SyntaxThe RegularIterator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RegularIterator |
Initializes a new instance with default values.
|
| RegularIterator(Int32) |
Initializes a new instance with the specified page size.
|
Properties| Name | Description | |
|---|---|---|
 | Filter |
Gets or sets the filter used by this iterator.
(Inherited from TranslationMemoryIterator.)Only translation units satisfying this filter will be returned. |
| Forward |
Gets or sets whether this iterator is moving forward or backward to retrieve the next page of translation units.
(Inherited from TranslationMemoryIterator.) |
| MaxCount |
Gets or sets the maximum number of translation units that this iterator will return
to the caller in one step.
(Inherited from TranslationMemoryIterator.) |
| MaxScan |
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.
(Inherited from TranslationMemoryIterator.)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. |
| PositionFrom |
Gets or sets the starting position of the current page in this iterator.
The page starts at the first translation unit AFTER this position. |
| PositionTo |
Gets or sets the last position of the current page in this iterator.
The page ends at this position, inclusively. |
| ProcessedTranslationUnits |
Gets or sets the number of translation units processed by this iterator since its creation.
(Inherited from TranslationMemoryIterator.) |
| ScannedTranslationUnits |
Gets or sets the number of translation units processed by this iterator in the last roundtrip.
(Inherited from TranslationMemoryIterator.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Reset |
See Reset (Overrides TranslationMemoryIteratorReset.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoCommunityComments