Namespace: Consultingwerk.SmartFramework.System
Class 
TranslationProvider Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.System.TranslationProvider

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartFramework.ITranslationProvider

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
CacheAllTranslations () Caches all translations for the current language
CacheTranslationsByScope (character) Caches all translations by a given scope
CHARACTER GetTranslationByKey (character, character) Returns a translation based on a key value and an optional scope
CHARACTER GetTranslationByKey (character, character, character) Returns a translation based on a key value and an optional scope
CHARACTER GetTranslationByString (character, character) Returns a translation for a string value and an optional scope
LanguageKeyChangedHandler () Event handler for the LanguageKeyChanged handler of the SessionManager

Top Constructor Summary
Options Name Purpose
TranslationProvider () Constructor for the TranslationProvider class

Top Property Summary
Options Name Purpose
LOGICAL AllTranslationsCached
LOGICAL DontFetchTranslationsWhenAllTranslationsCached
LOGICAL KeepTranslationCacheOnLanguageChange
LOGICAL UseEmptyScopeAsFallback


Method Detail
Top

CacheAllTranslations ()
Purpose: Caches all translations for the current language
Notes: Useful to avoid AppServer calls when multiple translations are
required

Top

CacheTranslationsByScope (character)
Purpose: Caches all translations by a given scope
Notes: Useful to avoid AppServer calls when multiple translations are
required in a row

Parameters:
pcScope CHARACTER
The scope to retrieve from the back end
Top

CHARACTER GetTranslationByKey (character, character)
Purpose: Returns a translation based on a key value and an optional scope
Notes: Returns ? when no translation is available

Parameters:
pcScope CHARACTER
The optional translation scope
pcKey CHARACTER
The translation key value to return
Returns CHARACTER
The translated string
Top

CHARACTER GetTranslationByKey (character, character, character)
Purpose: Returns a translation based on a key value and an optional scope
Notes: Returns ? when no translation is available

Parameters:
pcScope CHARACTER
The optional translation scope
pcKey CHARACTER
The translation key value to return
pcDefaultString CHARACTER
The optional default string to return when no translation is available
Returns CHARACTER
The translated string
Top

CHARACTER GetTranslationByString (character, character)
Purpose: Returns a translation for a string value and an optional scope
Notes: Returns the original string when no translation is available

Parameters:
pcScope CHARACTER
The optional translation scope
pcOriginalString CHARACTER
The original string to translate
Returns CHARACTER
The translated string
Top

LanguageKeyChangedHandler ()
Purpose: Event handler for the LanguageKeyChanged handler of the SessionManager
Notes: Clears all translation cache



Constructor Detail
Top

TranslationProvider ()
Purpose: Constructor for the TranslationProvider class
Notes:



Property Detail
Top

LOGICAL AllTranslationsCached

Returns LOGICAL
Top

LOGICAL DontFetchTranslationsWhenAllTranslationsCached

Returns LOGICAL
Top

LOGICAL KeepTranslationCacheOnLanguageChange

Returns LOGICAL
Top

LOGICAL UseEmptyScopeAsFallback

Returns LOGICAL


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:32:56