State and constants

Class_Initialize #

initialize

Set default state on construction.

Signature:

Private Sub Class_Initialize()

Public configuration

Path #

path-set

Store the path to the setup workbook.

Signature:

Public Property Let Path(ByVal value As String)

Parameters:

• value: String. The path to assign.

ProgressObject #

progress-object-set

Store the progress display object reference.

Signature:

Public Property Set ProgressObject(ByVal value As Object)

Parameters:

• value: Object. The progress display to store.

Self #

self

Current object instance cast to the interface.

Signature:

Public Property Get Self() As ISetupImportService

Returns: ISetupImportService. The current instance.

DisplayPrompts #

display-prompts-set

Toggle UI prompts displayed during operations.

Signature:

Public Property Let DisplayPrompts(ByVal state As Boolean)

When False, suppresses folder-picker dialogs and other interactive prompts. Primarily used by automated tests.

Parameters:

• state: Boolean. True to enable prompts.

Application state coordination

ApplicationScope #

application-scope

Guard Excel with the reusable ApplicationState scope.

Signature:

Private Function ApplicationScope() As IApplicationState

EnterBusyState #

enter-busy-state

Apply the busy state when heavy work starts.

Signature:

Private Sub EnterBusyState()

LeaveBusyState #

leave-busy-state

Restore Excel configuration when work completes.

Signature:

Private Sub LeaveBusyState(Optional ByVal silent As Boolean = False)

Workbook-driven import

ImportDictionaryUsingClass #

import-dictionary

Import dictionary worksheet using LLdictionary.

Signature:

Private Sub ImportDictionaryUsingClass(ByVal pass As IPasswords, _
                                       ByVal hostWorkbook As Workbook, _
                                       ByVal importWorkbook As Workbook)

ImportChoicesUsingClass #

import-choices

Import choices worksheet using LLChoices.

Signature:

Private Sub ImportChoicesUsingClass(ByVal pass As IPasswords, ByVal hostworkbook As Workbook, ByVal importworkbook As Workbook)

ImportExportUsingClass #

import-exports

Import export specifications via LLExport.

Signature:

Private Sub ImportExportUsingClass(ByVal pass As IPasswords, _
                                   ByVal hostWorkbook As Workbook, _
                                   ByVal importWorkbook As Workbook)

ImportAnalysisUsingClass #

import-analysis

Import analysis worksheet content via Analysis class.

Signature:

Private Sub ImportAnalysisUsingClass(ByVal pass As IPasswords, _
                                     ByVal hostWorkbook As Workbook, _
                                     ByVal importWorkbook As Workbook)

ImportTranslationsUsingClass #

import-translations

Import translations worksheet using CustomTable and SetupTranslationsTable.

Signature:

Private Sub ImportTranslationsUsingClass(ByVal pass As IPasswords, _
                                         ByVal hostWorkbook As Workbook, _
                                         ByVal importWorkbook As Workbook)

ResolveTranslationsList #

resolve-translations-list

Resolve the translations ListObject from a worksheet.

Signature:

Private Function ResolveTranslationsList(ByVal sheetRef As Worksheet, _ 
                                         Optional ByVal preferred As ListObject = Nothing) As ListObject

Preparation helpers

PrepareImport #

prepare-import

Ensure the exports and dictionary sheets are aligned prior to import.

Signature:

Private Sub PrepareImport(ByVal pass As IPasswords, _
                          Optional ByVal sheetsList As BetterArray, _ 
                          Optional ByVal forceSync As Boolean = True, _
                          Optional ByVal impStartRow As Long = EXPORT_HOST_START_ROW, _
                          Optional ByVal impStartColumn As Long = EXPORT_HOST_START_COLUMN, _ 
                          Optional ByVal renameChoices As Boolean = False)

PostImport #

post-import

Restore choices column names after import completes.

Signature:

Private Sub PostImport(ByVal pass As IPasswords, _
                        Optional ByVal sheetsList As BetterArray)

Validation helpers

ResolveImportSheets #

resolve-import-sheets

Resolve the requested sheets set, defaulting to core setup worksheets.

Signature:

Private Function ResolveImportSheets(ByVal sheetsList As BetterArray) As BetterArray

DefaultImportSheets #

default-import-sheets

Default sheet list covering the core setup worksheets.

Signature:

Private Function DefaultImportSheets() As BetterArray

ShouldImportSheet #

should-import-sheet

Determine whether a sheet should participate in the import.

Signature:

Private Function ShouldImportSheet(ByVal sheetsList As BetterArray, ByVal sheetName As String) As Boolean

EnsureImportSelection #

ensure-import-selection

Ensure at least one import option is selected.

Signature:

Private Sub EnsureImportSelection(ByVal importDictionary As Boolean, _
                                  ByVal importChoices As Boolean, _
                                  ByVal importExports As Boolean, _
                                  ByVal importAnalysis As Boolean, _
                                  ByVal importTranslations As Boolean, _
                                  ByVal cleanSetup As Boolean)

EnsureImportPathConfigured #

ensure-import-path-configured

Ensure the import path has been configured.

Signature:

Private Sub EnsureImportPathConfigured(ByVal value As String)

ValidatePasswords #

validate-passwords

Validate availability of requested passwords object.

Signature:

Private Sub ValidatePasswords(ByVal pass As IPasswords)

EnsureSheetsList #

ensure-sheets-list

Ensure the sheets list is initialised.

Signature:

Private Function EnsureSheetsList(ByVal sheetsList As BetterArray) As BetterArray

ValidateImportPath #

validate-import-path

Confirm the import path string is valid.

Signature:

Private Sub ValidateImportPath(ByVal pathValue As String)

ValidateProgressDisplay #

validate-progress-display

Ensure the progress display object exposes a Caption or Value property.

Signature:

Private Sub ValidateProgressDisplay(ByVal progressDisplay As Object)

TestProperty #

test-property

Test whether an object supports a named property.

Signature:

Private Function TestProperty(ByVal Obj As Object, ByRef hasProp As Boolean, Optional ByVal propName As String = "Caption") As Boolean

EnsureImportFileExists #

ensure-import-file-exists

Ensure the import workbook file exists before opening.

Signature:

Private Sub EnsureImportFileExists(ByVal filePath As String)

Workbook helpers

EnsureImportWorkbook #

ensure-import-workbook

Obtain the imported workbook, opening it when needed.

Signature:

Private Function EnsureImportWorkbook() As Workbook

EnsureExportWorkbook #

ensure-export-workbook

Obtain or create the export workbook, prompting for a folder when needed.

Signature:

Private Function EnsureExportWorkbook() As Workbook

EnsureSavedExport #

ensure-saved-export

Save the export workbook to the configured path.

Signature:

Private Sub EnsureSavedExport()

ResolveDictionaryFormat #

resolve-dictionary-format

Return format header names when the sheet is the dictionary.

Signature:

Private Function ResolveDictionaryFormat(ByVal sheetName As String) As BetterArray

BuildExportFilePath #

build-export-file-path

Build the timestamped export file path from the configured folder.

Signature:

Private Function BuildExportFilePath() As String

CloseImportWorkbook #

close-import-workbook

Close and release the imported workbook.

Signature:

Private Sub CloseImportWorkbook()

CloseExportWorkbook #

close-export-workbook

Close and release the export workbook.

Signature:

Private Sub CloseExportWorkbook()

CloseWorkbook #

close-workbook

Close workbook safely without raising errors.

Signature:

Private Sub CloseWorkbook(ByVal workbookRef As Workbook)

WorksheetExists #

worksheet-exists

Detect whether a worksheet exists within a workbook.

Signature:

Private Function WorksheetExists(ByVal workbookRef As Workbook, ByVal sheetName As String) As Boolean

ResolveRegistrySheet #

resolve-registry-sheet

Resolve the registry worksheet if present.

Signature:

Private Function ResolveRegistrySheet(ByVal workbookRef As Workbook) As Worksheet

ListObjectExists #

list-object-exists

Detect whether a ListObject exists within a worksheet.

Signature:

Private Function ListObjectExists(ByVal sheetRef As Worksheet, ByVal listName As String) As Boolean

Worksheet helpers

CleanWorksheetTables #

clean-worksheet-tables

Clean all ListObjects within a worksheet.

Signature:

Private Sub CleanWorksheetTables(ByVal targetSheet As Worksheet)

ClearWorksheetComments #

clear-worksheet-comments

Remove both classic and threaded comments from a worksheet.

Signature:

Private Sub ClearWorksheetComments(ByVal targetSheet As Worksheet)

ProtectWorksheet #

protect-worksheet

Protect worksheet with default rules.

Signature:

Private Sub ProtectWorksheet(ByVal pass As IPasswords, ByVal sheetName As String)

Messaging helpers

WriteInfo #

write-info

Display informational text through the progress object.

Signature:

Private Sub WriteInfo(ByVal message As String)

WriteProgress #

write-progress

Update a textual progress bar representation.

Signature:

Private Sub WriteProgress(ByVal percentage As Integer)

BuildOpenFailureMessage #

build-open-failure-message

Combine failure details when opening a workbook fails.

Signature:

Private Function BuildOpenFailureMessage(ByVal sourcePath As String, ByVal failureDetails As String) As String

Error handling

ReportAndThrow #

report-and-throw

Report message then raise a project error.

Signature:

Private Sub ReportAndThrow(ByVal errNumber As ProjectError, ByVal message As String)

ThrowError #

throw-error

Raise a ProjectError-based exception.

Signature:

Private Sub ThrowError(ByVal errNumber As ProjectError, ByVal message As String)

Class_Terminate #

terminate

Cleanup resources on destruction.

Signature:

Private Sub Class_Terminate()

Interface implementation

ISetupImportService_Check #

Signature:

Private Sub ISetupImportService_Check(ByVal importDictionary As Boolean, _
                                      ByVal importChoices As Boolean, _
                                      ByVal importExports As Boolean, _
                                      ByVal importAnalysis As Boolean, _
                                      ByVal importTranslations As Boolean, _
                                      Optional ByVal cleanSetup As Boolean = False)

Thin delegation stubs forwarding each ISetupImportService member to the corresponding public implementation above.

• ISetupImportService.cls
• SetupImportService.cls
• EventsSetupRibbon.bas
• SetupHelpers.bas
• TestSetupImportService.bas