WklBands
WklBands class
Signature
Dim myWklBands As WklBands
Summary
The bands of a tree list: header groups above the columns.
Parameters
None
Remarks
Returned by WklTreeList.Bands. Supports For Each. Bands can be nested to build multi-level headers.
Not created directly; returned by other members of the library.
Code example
None
Inheritance
None
Item property
Signature
Property Get Item(ByVal Index As Variant) As WklBand
Summary
Returns a band by position or name.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Index | Variant | No | – | A 0-based position (Long) or a band name (String). |
Property value: `WklBand` – The band.
Remarks
Default member: it can be left out, as in myWklBands(...) for myWklBands.Item(...). Read-only.
Code example
None
Inheritance
Declared by WklBands.
Count property
Signature
Property Get Count() As Long
Summary
Returns the number of bands.
Parameters
None
Property value: Long – The number of bands.
Remarks
Read-only.
Code example
None
Inheritance
Declared by WklBands.
Add method
Signature
Function Add(ByVal Name As String, Optional ByVal Caption As String = "", Optional ByVal ParentBand As String = "") As WklBand
Summary
Adds a band.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Name | String | No | – | The unique name of the band. |
Caption | String | Yes | "" | The header text; empty for none. |
ParentBand | String | Yes | "" | The name of the band above it; empty for a top-level band. |
Return value: `WklBand` – The new band.
Remarks
None
Code example
None
Inheritance
Declared by WklBands.
Remove method
Signature
Sub Remove(ByVal Index As Variant)
Summary
Removes a band.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Index | Variant | No | – | A 0-based position or a band name. |
Remarks
None
Code example
None
Inheritance
Declared by WklBands.
Clear method
Signature
Sub Clear()
Summary
Removes all bands.
Parameters
None
Remarks
None
Code example
None
Inheritance
Declared by WklBands.