Namespace: Consultingwerk.SmartFramework.Localization
Class 
UserInterfaceTranslationService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Localization.UserInterfaceTranslationService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartFramework.Localization.IUserInterfaceTranslationService


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



Top Method Summary
Options Name Purpose
FetchTranslationsForObject (character) Retrieves stored translations from the back end
CHARACTER GetPartialMatchKey (character) Returns the Partial match key for the given resource key
GetTranslationsForObject (character, table) Returns the translated String Resources Table for the named UI object
GetTranslationsForObject (character, CharacterDictionary, table) Returns the String Resources Table for the named UI object
OnFilterStringResource (FilterStringResourceEventArgs) Raises the FilterStringResource event
OnObtainTranslation (ObtainTranslationEventArgs) Raises the ObtainTranslation event
OnStoreTranslation (StoreTranslationEventArgs) Raises the StoreTranslation event
LOGICAL ResolveTranslation (character, character, character, character, character, character) Resolves the translation for a single resource string from the previously fetched SmartUiTranslation records
StoreTranslationsForObject (character, table) Stores the String Resources Table for the named UI object

Top Event Summary
Options Name Purpose
FilterStringResource (Object, FilterStringResourceEventArgs) Event raised to allow filtering out a resource string for translation
ObtainTranslation (Object, ObtainTranslationEventArgs) Event raised to allow obtaining customized translation
StoreTranslation (Object, StoreTranslationEventArgs) Event raised to allow customizing how a translation is stored


Method Detail
Top

FetchTranslationsForObject (character)
Purpose: Retrieves stored translations from the back end
Notes: Retrieves the local translation records of the given object
together with the global translation records (stored with an
empty ObjectName)

Parameters:
pcObjectName CHARACTER
The name of the UI object to retrieve translations for
Top

CHARACTER GetPartialMatchKey (character)
Purpose: Returns the Partial match key for the given resource key

Parameters:
pcResourceKey CHARACTER
The original resource key
Returns CHARACTER
The partial match key
Top

GetTranslationsForObject (character, table)
Purpose: Returns the translated String Resources Table for the named UI object
Notes:

Parameters:
pcObjectName CHARACTER
The name of the object to translate (class name)
eStringResources TEMP-TABLE eStringResources
INPUT-OUTPUT The table with the string resources (input the original strings, output the translated)
Top

GetTranslationsForObject (character, CharacterDictionary, table)
Purpose: Returns the String Resources Table for the named UI object
Notes:

Parameters:
pcObjectName CHARACTER
The name of the object to translate (class name)
poOriginalStrings Consultingwerk.Framework.Collections.CharacterDictionary
The dictionary with the original UI strings
eStringResources TEMP-TABLE eStringResources
OUTPUT The table with the string resources
Top

OnFilterStringResource (FilterStringResourceEventArgs)
Purpose: Raises the FilterStringResource event
Notes:

Parameters:
e Consultingwerk.SmartFramework.Localization.FilterStringResourceEventArgs
The FilterStringResourceEventArgs with the data for this event
Top

OnObtainTranslation (ObtainTranslationEventArgs)
Purpose: Raises the ObtainTranslation event
Notes:

Parameters:
e Consultingwerk.SmartFramework.Localization.ObtainTranslationEventArgs
The ObtainTranslationEventArgs with the data for the event
Top

OnStoreTranslation (StoreTranslationEventArgs)
Purpose: Raises the StoreTranslation event
Notes:

Parameters:
e Consultingwerk.SmartFramework.Localization.StoreTranslationEventArgs
The ObtainTranslationEventArgs with the data for the event
Top

LOGICAL ResolveTranslation (character, character, character, character, character, character)
Purpose: Resolves the translation for a single resource string from the
previously fetched SmartUiTranslation records
Notes: Applies the translation types in the order of their precedence:
local translations before global translations, matches by key
before matches by partial key and original text before matches
by original text only. Expects the eSmartUiTranslation temp-table
to be filled by FetchTranslationsForObject

Parameters:
pcObjectName CHARACTER
The name of the object to translate (class name)
pcResourceKey CHARACTER
The resource key of the string to translate
pcPartialKey CHARACTER
The partial match key of the string to translate
pcOriginalString CHARACTER
The original (untranslated) string
pcTranslatedString CHARACTER
OUTPUT The translated string when a match was found
pcTranslationType CHARACTER
OUTPUT The TranslationTypeEnum value of the matching record
Returns LOGICAL
Logical value indicating if a translation was found
Top

StoreTranslationsForObject (character, table)
Purpose: Stores the String Resources Table for the named UI object
Notes: Records are stored in the SmartUiTranslation table using the
convention described in the class Notes: local records carry
the object name, global records an empty ObjectName; by-key
records the full resource key, partial-key records the partial
match key and by-text records an empty ResourceKey. When the
translation type of a row was changed away from LocalByKey, a
previously stored local by-key record for the same resource key
is removed so it does not mask the new translation. Global
records are never removed here as they may be shared with
other containers

Parameters:
pcObjectName CHARACTER
The name of the object to translate (class name)
eStringResources TEMP-TABLE eStringResources
INPUT-OUTPUT The table with the string resources


Event Detail
Top

FilterStringResource (Object, FilterStringResourceEventArgs)
Purpose: Event raised to allow filtering out a resource string for translation
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartFramework.Localization.FilterStringResourceEventArgs
The FilterStringResourceEventArgs with the data for this event
Top

ObtainTranslation (Object, ObtainTranslationEventArgs)
Purpose: Event raised to allow obtaining customized translation
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the ObtainTranslation event
e Consultingwerk.SmartFramework.Localization.ObtainTranslationEventArgs
The ObtainTranslationEventArgs with the data for the event
Top

StoreTranslation (Object, StoreTranslationEventArgs)
Purpose: Event raised to allow customizing how a translation is stored
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartFramework.Localization.StoreTranslationEventArgs
The StoreTranslationEventArgs with the data for this event


Temp-Table Detail

Temp-Table eStringResources

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.07.2026 21:01:48