WklBand
WklBand class
Signature
Dim myWklBand As WklBand
Summary
A band of a tree list: a header above a group of columns.
Parameters
None
Remarks
Not created directly; returned by other members of the library.
| Member | Kind | Summary |
|---|---|---|
| `Name` | Property | Gets or sets the unique name of the band. |
| `Caption` | Property | Gets or sets the header text. |
| `ParentBand` | Property | Gets or sets the band above this one. |
| `Visible` | Property | Gets or sets whether the band is shown. |
| `VisibleIndex` | Property | Gets or sets the position of the band among its siblings. |
Code example
None
Inheritance
None
Name property
Signature
Property Get Name() As String Property Let Name(RHS As String)
Summary
Gets or sets the unique name of the band.
Parameters
None
Property value: String – The name; referenced by WklColumn.Band and WklBand.ParentBand.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklBand.
Caption property
Signature
Property Get Caption() As String Property Let Caption(RHS As String)
Summary
Gets or sets the header text.
Parameters
None
Property value: String – The text.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklBand.
ParentBand property
Signature
Property Get ParentBand() As String Property Let ParentBand(RHS As String)
Summary
Gets or sets the band above this one.
Parameters
None
Property value: String – The name of the parent band; empty for a top-level band.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklBand.
Visible property
Signature
Property Get Visible() As Boolean Property Let Visible(RHS As Boolean)
Summary
Gets or sets whether the band is shown.
Parameters
None
Property value: Boolean – True to show the band. A hidden band hides its columns too.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklBand.
VisibleIndex property
Signature
Property Get VisibleIndex() As Long Property Let VisibleIndex(RHS As Long)
Summary
Gets or sets the position of the band among its siblings.
Parameters
None
Property value: Long – The 0-based display position.
Remarks
Read/write.
Code example
None
Inheritance
Declared by WklBand.