ILLTranslation

Defines the public contract for the LLTranslation class, exposing scoped translation objects, import/export of translation ListObjects, dictionary exchange, and workbook-level hidden name initialisation for translated configuration values.

Properties

TransObject #

Scoped translation object

Signature:

Public Property Get TransObject(Optional ByVal trans As Byte = TranslationOfMessages) As ITranslationObject

Accessors for translation objects and the host worksheet. Returns an ITranslationObject configured for the requested translation scope. The language code is resolved from the host workbook HiddenNames.

Parameters:

  • trans: Optional Byte. TranslationScope value selecting the content scope. Defaults to TranslationOfMessages.

Returns: ITranslationObject. The translation object for the requested scope.


Wksh #

Host translation worksheet

Signature:

Public Property Get Wksh() As Worksheet

Returns the worksheet bound to this LLTranslation instance, hosting all translation ListObjects.

Returns: Worksheet. The host translation worksheet.


DataExchange

Export #

Export all translation tables to an output workbook

Signature:

Public Sub Export(ByVal outputWkb As Workbook, _
                  Optional ByVal Hide As Long = xlSheetVeryHidden)

Import, export, and dictionary exchange operations. Creates or clears a worksheet in the output workbook matching the host sheet name, then exports every ListObject from the host sheet using CustomTable.Export with stacking.

Parameters:

  • outputWkb: Workbook. The destination workbook.
  • Hide: Optional Long. Sheet visibility after export. Defaults to xlSheetVeryHidden.

Import #

Import translation tables from another workbook

Signature:

Public Sub Import(ByVal fromWkb As Workbook)

Finds a worksheet in the source workbook matching the host sheet name. Cleans the dictionary ListObject before import. For each ListObject on the host sheet, imports data from the matching ListObject on the source sheet. Missing source tables are silently skipped.

Parameters:

  • fromWkb: Workbook. The source workbook containing translation data.

ImportDictionary #

Import dictionary translations from a raw ListObject

Signature:

Public Sub ImportDictionary(ByVal dictionaryTable As ListObject)

Overwrites the host dictionary table with data from the supplied ListObject, preserving the source column headers.

Parameters:

  • dictionaryTable: ListObject. The source dictionary ListObject.

ExportDictionary #

Export the dictionary table to a named worksheet

Signature:

Public Sub ExportDictionary(ByVal outputWkb As Workbook, _
                            Optional ByVal sheetName As String = "Translations", _
                            Optional ByVal Hide As Long = xlSheetVisible)

Creates or clears a worksheet in the output workbook with the given name, then exports the dictionary ListObject using CustomTable.Export.

Parameters:

  • outputWkb: Workbook. The destination workbook.
  • sheetName: Optional String. Worksheet name for the export. Defaults to "Translations".
  • Hide: Optional Long. Sheet visibility after export. Defaults to xlSheetVisible.

HiddenNames

InitialiseHiddenNames #

Create RNG_ hidden names on a target workbook*

Signature:

Public Sub InitialiseHiddenNames(ByVal targetWkb As Workbook)

Workbook-level hidden name initialisation from translations. Translates message and sheet-name tags using the TranslationOfMessages scope, then writes each translated value as a workbook-level hidden name on the target workbook. These names replace the legacy named ranges that were previously stored on the translation worksheet.

Parameters:

  • targetWkb: Workbook. The workbook receiving the hidden names.

InitialiseSheetNames #

Create language HiddenNames on the translation worksheet

Signature:

Public Sub InitialiseSheetNames(ByVal dictLang As String, ByVal llLang As String)

Creates worksheet-level HiddenNames for the dictionary language and interface language on the translation worksheet. These values are read by TransObject when resolving the language code for translation lookups.

Parameters:

  • dictLang: String. The dictionary language code (e.g., "en").
  • llLang: String. The interface language code (e.g., "fr").

ValueAccess

Value #

Retrieve a named configuration value from the translation worksheet

Signature:

Public Property Get Value(ByVal nameId As String) As String

Mapped value retrieval from worksheet-level HiddenNames. Returns the value of a worksheet-level HiddenName identified by a logical key. Supported keys: "dictlang" -> RNG_DictionaryLanguage "lllang" -> RNG_LLLanguageCode

Parameters:

  • nameId: String. The logical key to look up.

Returns: String. The stored value, or vbNullString if unknown.