ILLSheets

Properties

Dictionary #

Dictionary accessor

Signature:

Public Property Get Dictionary() As ILLdictionary: End Property

Returns: ILLdictionary backing store for the sheets helper.

Queries

SheetInfo #

Retrieve a specific metadata entry for the supplied sheet

Signature:

Public Function SheetInfo(ByVal sheetName As String, Optional ByVal info As Byte = SheetInfoType.SheetInfoSheetType) As String: End Function

Parameters:

  • sheetName: String. Sheet identifier.
  • info: Byte. Selector from SheetInfoType.

Returns: String metadata value.

Contains #

Determine whether the dictionary contains the supplied sheet

Signature:

Public Function Contains(ByVal sheetName As String) As Boolean: End Function

Parameters:

  • sheetName: String. Sheet identifier.

Returns: True when the sheet exists.

DataBounds #

Return positional bounds for the sheet layout

Signature:

Public Function DataBounds(ByVal sheetName As String, Optional ByVal Bound As Byte = SheetBound.RowSart) As Long: End Function

Parameters:

  • sheetName: String. Sheet identifier.
  • Bound: Byte. Selector from SheetBound.

Returns: Long bound value.

ContainsControl #

Test whether a sheet exposes the requested control type

Signature:

Public Function ContainsControl(ByVal sheetName As String, _
                                Optional ByVal control As String = "list_auto", _
                                Optional ByVal colName As String = "control") As Boolean: End Function

Parameters:

  • sheetName: String. Sheet identifier.
  • control: Optional String. Control type to search for. Defaults to "list_auto".
  • colName: Optional String. Column that contains control metadata. Defaults to "control".

Returns: True when at least one variable matches the control.

VariableAddress #

Build a cell address pointing to the variable location

Signature:

Public Function VariableAddress(ByVal varName As String, Optional ByVal onSheet As String = vbNullString) As String: End Function

Parameters:

  • varName: String. Variable identifier.
  • onSheet: Optional String. Target sheet to suppress sheet prefix when matching.

Returns: String Excel address for the variable.

RowIndex #

Retrieve the worksheet row containing the sheet metadata row

Signature:

Public Function RowIndex(ByVal sheetName As String) As Long: End Function

Parameters:

  • sheetName: String. Sheet identifier.

Returns: Long worksheet row index (0 when not found).

NumberOfVars #

Count the variables assigned to the sheet

Signature:

Public Function NumberOfVars(ByVal sheetName As String) As Long: End Function

Parameters:

  • sheetName: String. Sheet identifier.

Returns: Long number of variables.