ILLdictionary

Data Access

Data #

DataSheet backing store

Signature:

Public Property Get Data() As IDataSheet: End Property

Returns: An IDataSheet reference with the dictionary data

DataRange #

Data range accessor

Signature:

Public Property Get DataRange(Optional ByVal colName As String = "__all__", _
                              Optional ByVal includeHeaders As Boolean = False) As Range

Parameters:

  • colName: Optional String. Column header to retrieve. Defaults to "all".
  • includeHeaders: Optional Boolean. Include headers in the returned range. Defaults to False.

Returns: A Range scoped to the requested dictionary data

Prepared #

Dictionary preparation status

Signature:

Public Property Get Prepared() As Boolean: End Property

Returns: True when the dictionary is ready for designer workflows

TotalNumberOfExports #

Total number of export columns

Signature:

Public Property Get TotalNumberOfExports() As Long: End Property

Returns: A Long representing the configured number of export slots

TotalNumberOfExports #

Update total number of export columns

Signature:

Public Property Let TotalNumberOfExports(ByVal numberOfExports As Long): End Property

Parameters:

  • numberOfExports: Long. Requested number of export slots to persist.
Column Operations

ColumnExists #

Test for column existence

Signature:

Public Function ColumnExists(ByVal colName As String, _
                             Optional ByVal checkValidity As Boolean = False) As Boolean

Parameters:

  • colName: String. Column header to search for.
  • checkValidity: Optional Boolean. When True, the column is validated against the allowed list.

Returns: True when the column is present

UniqueValues #

Unique column values

Signature:

Public Function UniqueValues(ByVal colName As String) As BetterArray: End Function

Parameters:

  • colName: String. Column header for the lookup.

Returns: A BetterArray containing distinct values

VariableExists #

Variable presence test

Signature:

Public Function VariableExists(ByVal varName As String) As Boolean: End Function

Parameters:

  • varName: String. Variable identifier to search for.

Returns: True when the variable exists in the dictionary

AddColumn #

Append a column to the dictionary

Signature:

Public Sub AddColumn(ByVal colName As String): End Sub

Parameters:

  • colName: String. Name of the column to append.

InsertColumn #

Insert a column relative to another

Signature:

Public Sub InsertColumn(ByVal colName As String, ByVal After As String): End Sub

Parameters:

  • colName: String. Name of the column to insert.
  • After: String. Existing column after which the new column is inserted.

RemoveColumn #

Remove a column from the dictionary

Signature:

Public Sub RemoveColumn(ByVal colName As String): End Sub

Parameters:

  • colName: String. Column header to delete.

RenameColumn #

Rename a column in the dictionary

Signature:

Public Sub RenameColumn(ByVal currentName As String, _
                        ByVal newName As String, _
                        Optional ByVal strictSearch As Boolean = True, _
                        Optional ByVal matchCase As Boolean = False)
Row Operations

AddRows #

Add rows to the dictionary listobject when available

Signature:

Public Sub AddRows(): End Sub

InsertRows #

Insert rows relative to a target selection

Signature:

Public Sub InsertRows(ByVal targetCell As Range, _
                      Optional ByVal insertShift As Boolean = False)

Parameters:

  • targetCell: Range anchor whose height dictates the number of rows inserted.
  • insertShift: Optional Boolean. When True worksheet rows are inserted to preserve stacked tables.

RemoveRows #

Remove rows from the dictionary listobject when available

Signature:

Public Sub RemoveRows(): End Sub

ManageRows #

Manage rows from the dictionary listobject when availabe

Signature:

Public Sub ManageRows(Optional ByVal del As Boolean = False): End Sub
Specialised Views

ChoicesVars #

Choice variables list

Signature:

Public Property Get ChoicesVars() As BetterArray: End Property

Returns: A BetterArray listing variables controlled by choices

GeoVars #

Geographic variables list

Signature:

Public Property Get GeoVars() As BetterArray: End Property

Returns: A BetterArray with geography-driven variables

TimeVars #

Time variables list

Signature:

Public Property Get TimeVars() As BetterArray: End Property

Returns: A BetterArray with time-related variables

SpecialVars #

Filtered variable list by criteria

Signature:

Public Property Get SpecialVars(ByVal first_condition As String, _
                                Optional ByVal second_condition As String = vbNullString, _
                                Optional ByVal conditionName As String = "Control") As BetterArray

Parameters:

  • first_condition: String. Primary control/tag value to match.
  • second_condition: Optional String. Secondary control/tag value.
  • conditionName: Optional String. Column header to evaluate. Defaults to "Control".

Returns: A BetterArray of matching variables

Preparation

Prepare #

Prepare dictionary for designer workflows

Signature:

Public Sub Prepare(Optional ByVal PreservedSheetNames As BetterArray, _
                   Optional ByVal geoObject As Object, _
                   Optional ByVal tablePrefix As String = "table")

Parameters:

  • PreservedSheetNames: BetterArray containing table names to preserve.
  • geoObject: ILLGeo implementation to enrich geographic variables.
  • msgTrads: ITranslationObject providing translations.
  • tablePrefix: Optional String prefix for generated table names. Defaults to "table".

Clean #

Clean up dictionary columns

Signature:

Public Sub Clean(Optional ByVal removeAddedColumns As Boolean = False): End Sub

Sort #

Sort the dictionary on sheetname and main section

Signature:

Public Sub Sort(): End Sub
Data Exchange

Import #

Import dictionary data

Signature:

Public Sub Import(ByVal fromWksh As Worksheet, _ 
                  ByVal fromStartRow As Long, _ 
                  ByVal fromStartcol As Long, _ 
                  Optional ByVal clearSheet As Boolean = False)

Parameters:

  • fromWksh: Worksheet source worksheet.
  • fromStartRow: Long. Starting row of the source data.
  • fromStartcol: Long. Starting column of the source data.

Export #

Export dictionary data

Signature:

Public Sub Export(ByVal toWkb As Workbook, _
                  Optional ByVal exportType As String = "__all__", _
                  Optional ByVal addListObject As Boolean = True, _
                  Optional ByVal Hide As Long = xlSheetHidden)

Parameters:

  • toWkb: Workbook destination workbook.
  • exportType: Optional String filter for export. Defaults to "all".
  • addListObject: Optional Boolean. Add a table to exported sheet. Defaults to True.
  • Hide: Optional Long sheet visibility after export. Defaults to xlSheetHidden.

Translate #

Translate dictionary labels

Signature:

Public Sub Translate(ByVal TransObject As ITranslationObject)

Parameters:

  • TransObject: ITranslationObject used to translate ranges.