MasterSetupVariables
Internal members (not exported)
Factory helpers
Create #
Create a configured variables table manager instance.
Signature:
Public Function Create(ByVal listObject As ListObject) As IMasterSetupVariables
Parameters:
listObject: ListObject representing the Master Setup Variables worksheet table.
Returns: IMasterSetupVariables ready to manage the associated ListObject.
Self #
Self reference used by factories returning interface instances.
Signature:
Public Property Get Self() As IMasterSetupVariables
Public API
Initialise #
Initialise validation, hidden names, and duplicate detection.
Signature:
Public Sub Initialise(ByVal dropdowns As IDropdownLists)
Parameters:
dropdowns: IDropdownLists provider used to configure the Default Status validation.
RefreshChoices #
Refresh the concatenated choices values for the supplied variable.
Signature:
Public Sub RefreshChoices(ByVal variableName As String, ByVal choices As ILLChoices)
Parameters:
variableName: String identifier of the variable row to update.choices: ILLChoices providing category listings.
LabelFor #
Retrieve the label for the supplied variable.
Signature:
Public Function LabelFor(ByVal variableName As String) As String
DefaultChoiceFor #
Retrieve the default choice for the supplied variable.
Signature:
Public Function DefaultChoiceFor(ByVal variableName As String) As String
ChoicesFor #
Retrieve the concatenated choices values for the supplied variable.
Signature:
Public Function ChoicesFor(ByVal variableName As String) As String
DefaultStatusFor #
Retrieve the default status for the supplied variable.
Signature:
Public Function DefaultStatusFor(ByVal variableName As String) As String
SectionFor #
Retrieve the section label for the supplied variable.
Signature:
Public Function SectionFor(ByVal variableName As String) As String
AddRows #
Append rows to the underlying table.
Signature:
Public Sub AddRows(Optional ByVal rowCount As Long = 20)
RemoveRows #
Remove rows from the underlying table.
Signature:
Public Sub RemoveRows(Optional ByVal rowCount As Long = 1)
TranslateHeaders #
Translate the header row with the supplied translations object.
Signature:
Public Sub TranslateHeaders(ByVal trads As ITranslationObject)
TranslateContent #
Translate the key content columns without affecting headers.
Signature:
Public Sub TranslateContent(ByVal trads As ITranslationObject)
TranslateAll #
Translate both headers and content using the supplied translation object.
Signature:
Public Sub TranslateAll(ByVal contentsTrads As ITranslationObject, Optional ByVal ribbonTrads As ITranslationObject)
SetVariableValidation #
Apply workbook-scoped validation for variable names onto the supplied range.
Signature:
Private Sub SetVariableValidation(ByVal targetRange As Range)
CloneToWorkbook #
Clone the managed table into another workbook.
Signature:
Public Function CloneToWorkbook(ByVal targetWorkbook As Workbook, _
Optional ByVal sheetName As String = vbNullString, _
Optional ByVal startCell As Range = Nothing) As IMasterSetupVariables
Parameters:
targetWorkbook: Workbook receiving the cloned table.sheetName: Optional sheet name; defaults to the source worksheet name.startCell: Optional starting cell; defaults to the source table anchor.
Returns: IMasterSetupVariables bound to the cloned ListObject.
RestoreFrom #
Restore current table contents from a peer instance.
Signature:
Public Sub RestoreFrom(ByVal source As IMasterSetupVariables)
Parameters:
source: IMasterSetupVariables providing data and metadata.
ExportToWorksheet #
Export the managed table to a plain worksheet range.
Signature:
Public Sub ExportToWorksheet(ByVal targetSheet As Worksheet)
Parameters:
targetSheet: Worksheet receiving the exported values.
ImportFromWorksheet #
Import table data from a plain worksheet range.
Signature:
Public Sub ImportFromWorksheet(ByVal sourceSheet As Worksheet)
Parameters:
sourceSheet: Worksheet containing headers and rows matching the variables schema.
CopyToListObject #
Copy the managed table content into a supplied ListObject.
Signature:
Public Sub CopyToListObject(ByVal targetTable As ListObject)
Parameters:
targetTable: ListObject receiving headers, values, and formatting.
ExportMetadata #
Export the hidden metadata required to resolve translated columns.
Signature:
Public Sub ExportMetadata(ByVal targetSheet As Worksheet)
Parameters:
targetSheet: Worksheet receiving the hidden name definitions.
Table #
Expose the managed ListObject.
Signature:
Public Property Get Table() As ListObject
Initialised #
Indicates whether initialisation logic already executed.
Signature:
Public Property Get Initialised() As Boolean
DataRange #
Return the range for the supplied column header, optionally including headers.
Signature:
Private Function DataRange(ByVal headerName As String, _
Optional ByVal includeHeaders As Boolean = False) As Range
Interface implementation
IMasterSetupVariables_SetVariableValidation #
Apply workbook-scoped variable dropdown validation to a target range.
Signature:
Private Sub IMasterSetupVariables_SetVariableValidation(ByVal targetRange As Range)