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

File:UserInterfaceTranslationService
Purpose:UI Translation Service of the SmartFramework
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri May 10 10:03:45 CEST 2013

Navigate to: Methods | Constructors | Events | Properties



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
+ 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

PROTECTED FetchTranslationsForObject (character)
Purpose: Retrieves stored translations from the back end
Notes:

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

PUBLIC CHARACTER GetPartialMatchKey (character)
Purpose: Returns the Partial match key for the given resource key
Notes: Replaces all numbers with *, eliminated double **

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

PUBLIC 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 TABLE
INPUT-OUTPUT The table with the string resources (input the original strings, output the translated)
Top

PUBLIC 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 TABLE
OUTPUT The table with the string resources
Top

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

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

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

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

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

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

PUBLIC StoreTranslationsForObject (character, table)
Purpose: Stores the String Resources Table for the named UI object
Notes:

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


Event Detail
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:36:58