ISetupErrors

Defines the public contract for the SetupErrors class, exposing methods to initialise a setup consistency checker, execute all validation checks (dictionary, choices, exports, translations), and retrieve the resulting collection of IChecking report objects.

Lifecycle

Initialise #

Bind the setup checker to a workbook and optional collaborators

Signature:

Public Sub Initialise(ByVal hostBook As Workbook, _
                      Optional ByVal passwordService As IPasswords, _
                      Optional ByVal dictionary As ILLdictionary, _
                      Optional ByVal choices As ILLChoices, _
                      Optional ByVal formulaStore As IFormulaData, _
                      Optional ByVal transManager As ISetupTranslationsTable, _
                      Optional ByVal stateScope As IApplicationState)

Stores the workbook reference and optional collaborators (password manager, dictionary, choices, formula store, application state). When optional parameters are omitted, the checker creates default instances internally during ConfigureDependencies.

Parameters:

  • hostBook: Workbook. The workbook containing setup tables and helper sheets.
  • passwordService: Optional IPasswords. Password manager handling sheet protection.
  • dictionary: Optional ILLdictionary. Dictionary wrapper providing data access.
  • choices: Optional ILLChoices. Choices wrapper exposing list names and categories.
  • formulaStore: Optional IFormulaData. Formula data handler used to validate expressions.
  • transManager: Optional ISetupTranslationsTable. Translations table accessor.
  • stateScope: Optional IApplicationState. Application state scope guarding Excel settings.
Execution

Run #

Execute all setup consistency checks and publish the report

Signature:

Public Sub Run()

Suspends Excel UI, resets the internal check container, then runs each checker in sequence (dictionary, choices, exports, translations). On completion, publishes all collected IChecking objects to the reporting worksheet. Restores Excel state even when an error occurs.

Results

Checkings #

Collection of generated checking objects

Signature:

Public Property Get Checkings() As BetterArray

Returns a BetterArray containing the IChecking instances produced by the most recent Run call. Each entry covers one validation domain (dictionary, choices, exports, translations).

Returns: BetterArray. The generated IChecking instances.