WklTreeView

Dim myWklTreeView As WklTreeView
Set myWklTreeView = Me!ControlName.Object

A data-bound tree for Access forms: one node per record of a table, query or SQL statement.

None

The tree is bound through four properties: RecordSource names the records, KeyField the unique key of a node, ParentField the key of its parent, and TextField the displayed text. A record whose parent key does not exist in the source (Null, 0, or any unknown value) is a root. Optional fields add a sort order, symbols, tooltips, check marks, a text color and bold text per node.

Keys are passed as Variant in the type of the key field (Long for an AutoNumber, String for a text key). With a composite key - KeyField naming several fields - a key is an array with one value per key field, Array(4711, 2), in parameters, return values and events alike. Every member that takes a Key raises wkeKeyNotFound when no node has that key.

Events report actions of the user. Changes made by code (for example setting SelectedKey or calling MoveNode) raise no events, like AfterUpdate of an Access control.

Events of an ActiveX control reach VBA only through an event procedure in the form's module (or a WithEvents variable in a class module); Access offers no event property with an expression such as =Funktion() for them. A form without a module receives none of the control's events. What works without a module: the control's own built-in behavior (editing, deleting, menus, export), properties set in design view, and code in another module that reads the control's state (SelectedKey, SelectedKeys) when the user runs an Access command, for example from a ribbon button or an Access shortcut menu. WklTreeList, WklGantt and WklGrid also show the entries of an Access shortcut menu bar in their own shortcut menu (ShortcutMenuBar); the entries call functions of a standard module.

With AutoSave (the default), renames, moves, additions, copies, deletions and check marks made by the user or by code are written into the record source right away, each operation in one transaction. For operations of the user, BeforeUpdate can cancel the operation and roll it back.

The events appear in the code window's object list under the control's name.

An ActiveX control: inserted into a form in design view (Form Design › Controls › ActiveX Controls); reports are not supported. VBA reaches it through the Object property of the control, where ControlName is the name of the control on the form.

Private Sub Form_Load()
    With Me!Tree1.Object
        .RecordSource = "tblCategories"
        .KeyField = "CategoryID": .ParentField = "ParentID": .TextField = "Name"
        .ExpandLevel = 1
    End With
End Sub
 
Private Sub Tree1_NodeSelect(ByVal Key As Variant)
    Me.Details.Form.Filter = "CategoryID = " & Key
    Me.Details.Form.FilterOn = True
End Sub

None

Property Get SelectedKey() As Variant
Property Let SelectedKey(RHS As Variant)

Gets or sets the key of the selected node.

None

Property value: Variant – The key of the selected node, or Null when no node is selected.

Setting a key selects that node, expands its ancestors and scrolls it into view; setting Null clears the selection. With MultiSelect, SelectedKey is the focused node of the selection; SelectedKeys returns all of them. Setting SelectedKey by code makes that node the whole selection, as setting the current record of an Access form does (before type library 1.28 the nodes the user had selected stayed selected, so Delete acted on them).

Default member: it can be left out, as in myWklTreeView(...) for myWklTreeView.SelectedKey(...). Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get RecordSource() As String
Property Let RecordSource(RHS As String)

Gets or sets the table, query or SQL statement that delivers one record per node.

None

Property value: String – A table name, a query name or an SQL statement. Queries may contain form references.

The name is RecordSource, not RowSource: an ActiveX property named RowSource makes the Access property sheet crash. Changing the value reloads the tree.

The control reads one record source for all levels; there is no record source per level. A tree whose parents and children live in different tables needs one query that returns both, usually a UNION query, with a key that is unique across both parts. Access cannot update a UNION query: set AllowEditing to False (and AllowAdditions, AllowDeletions), or load the tree through Recordset, so the user is not offered changes that cannot be saved (see AutoSave).

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get KeyField() As String
Property Let KeyField(RHS As String)

Gets or sets the field with the unique key of a node.

None

Property value: String – A field name of the record source, or several separated by semicolons for a composite key (OrderID;LineNo).

A duplicate key raises wkeDuplicateKey when the tree loads. With a composite key, keys are arrays in VBA (Array(4711, 2)); new keys are proposed by continuing the last part within the leading parts, because a composite key has no AutoNumber.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ParentField() As String
Property Let ParentField(RHS As String)

Gets or sets the field with the key of the node's parent.

None

Property value: String – A field name of the record source; for a composite key as many fields as KeyField, in the same order (OrderID;ParentLineNo).

A record whose parent key does not exist is a root; with a composite key also a record whose parent key has a Null part. A different number of fields than KeyField raises wkeInvalidValue. A cycle in the parent keys raises wkeCycle. WklTreeList with GroupFields accepts an empty value.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get TextField() As String
Property Let TextField(RHS As String)

Gets or sets the field with the displayed text of a node.

None

Property value: String – A field name of the record source.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SortField() As String
Property Let SortField(RHS As String)

Gets or sets the field that orders sibling nodes.

None

Property value: String – A field name, or an empty string to order siblings by their text.

SortOrder decides the direction. With a sort field, siblings are ordered by it and then by text.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ImageField() As String
Property Let ImageField(RHS As String)

Gets or sets the field with the symbol name of a node.

None

Property value: String – A field name, or an empty string for no symbols from the data.

A symbol is an image of the database's image gallery, a built-in name, or a file path. Nodes without a symbol use DefaultImage. The built-in names are Windows icons under an English name that stays the same in every language: Application, Delete, Document, Drive, Error, Folder, FolderOpen, Help, Info, Key, Link, Lock, Network, NetworkDrive, Printer, RecycleBin, Search, Server, Settings, Shield, Users, Warning, World. The German names of releases up to 1.53 (Ordner, Dokument, Warnung …) keep working, so data written with them needs no change. The designer shows the built-in symbols under their name in the user interface language and copies the English name.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get LazyLoad() As Boolean
Property Let LazyLoad(RHS As Boolean)

Gets or sets whether the children of a node are loaded only when it is expanded.

None

Property value: Boolean – True (default) to load on expand, False to load all records at once.

Lazy loading reads the roots first and each level on demand, which suits large or linked tables. ExpandAll, FindNodes and a search in loaded nodes load the whole tree. Grouped records (WklTreeList.GroupFields) are always loaded completely.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ExpandLevel() As Long
Property Let ExpandLevel(RHS As Long)

Gets or sets how many levels are expanded after loading.

None

Property value: Long – The number of levels; 0 (default) shows only the roots.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get CheckBoxes() As Boolean
Property Let CheckBoxes(RHS As Boolean)

Gets or sets whether a check box is shown in front of each node.

None

Property value: Boolean – True to show check boxes; False (default) to hide them.

CheckedField binds the check marks to a Yes/No field; CheckMode makes them recursive.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ShowLines() As Boolean
Property Let ShowLines(RHS As Boolean)

Gets or sets whether lines connect parent and child nodes.

None

Property value: Boolean – True (default) to draw the lines.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ShowRootLines() As Boolean
Property Let ShowRootLines(RHS As Boolean)

Gets or sets whether lines and expand buttons are also drawn in front of the roots.

None

Property value: Boolean – True (default) to draw them.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get FullRowSelect() As Boolean
Property Let FullRowSelect(RHS As Boolean)

Gets or sets whether the selection covers the full width of the row.

None

Property value: Boolean – True to select the full row; False (default) to select the text only.

Takes effect only when ShowLines is False, as in the Windows tree view.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get HideSelection() As Boolean
Property Let HideSelection(RHS As Boolean)

Gets or sets whether the selection is hidden while another control has the focus.

None

Property value: Boolean – True (default) to hide it.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get BackColor() As OLE_COLOR
Property Let BackColor(RHS As OLE_COLOR)

Gets or sets the background color.

None

Property value: OLE_COLOR – A color number as in Access; system colors from &H80000000 on. Default: the Windows window color.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ForeColor() As OLE_COLOR
Property Let ForeColor(RHS As OLE_COLOR)

Gets or sets the text color.

None

Property value: OLE_COLOR – A color number as in Access; system colors from &H80000000 on. Default: the Windows window text color.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get FontName() As String
Property Let FontName(RHS As String)

Gets or sets the font name.

None

Property value: String – The name of an installed font. Default: Segoe UI.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get FontSize() As Long
Property Let FontSize(RHS As Long)

Gets or sets the font size in points.

None

Property value: Long – The size in points. Default: 9.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get DefaultImage() As String
Property Let DefaultImage(RHS As String)

Gets or sets the symbol of nodes without a symbol of their own.

None

Property value: String – A symbol name as for ImageField, or an empty string (default) for no symbol.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SelectedText() As Variant

Returns the text of the selected node.

None

Property value: Variant – The text, or Null when no node is selected.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get NodeCount() As Long

Returns the number of loaded nodes.

None

Property value: Long – The number of nodes loaded so far; with LazyLoad it grows as nodes are expanded.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get Checked(ByVal Key As Variant) As Boolean
Property Let Checked(ByVal Key As Variant, RHS As Boolean)

Gets or sets the check mark of a node.

Property value: Boolean – True when the node's check box is checked.

Setting the value checks or clears the node; with CheckedField and AutoSave it is written into the record source, and with CheckMode = wcmRecursive it applies to the whole subtree.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get CheckedKeys() As Variant

Returns the keys of all checked nodes.

None

Property value: Variant – A Variant array of keys; an empty array when no node is checked.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get Recordset() As Object
Property Set Recordset(RHS As Object)

Gets or sets the DAO or ADO recordset the nodes were loaded from.

None

Property value: Object – The recordset, or Nothing when the tree is bound through RecordSource.

Assign with Set: all records are loaded at once from the recordset. A tree loaded this way does not write back with AutoSave, because it has no record source to write to.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub Requery()

Reads the record source again.

None

The selection and the expanded nodes are kept as far as they still exist. Raises AfterRequery.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub Expand(ByVal Key As Variant)

Expands a node.

With LazyLoad, the children are loaded first.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub Collapse(ByVal Key As Variant)

Collapses a node.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub ExpandAll()

Expands every node.

None

With LazyLoad, the whole tree is loaded first.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub CollapseAll()

Collapses every node.

None

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub EnsureVisible(ByVal Key As Variant)

Expands the ancestors of a node and scrolls it into view.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SortOrder() As WklSortOrder
Property Let SortOrder(RHS As WklSortOrder)

Gets or sets the order of sibling nodes.

None

Property value: `WklSortOrder` – A `WklSortOrder` constant. Default: wsoAscending.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get LabelEdit() As Boolean
Property Let LabelEdit(RHS As Boolean)

Gets or sets whether the user can rename nodes.

None

Property value: Boolean – True to allow renaming (F2, or a click on the selected node); False (default) to prevent it.

A rename raises BeforeLabelEdit and AfterLabelEdit; with AutoSave the new text is written into TextField.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AllowDragDrop() As Boolean
Property Let AllowDragDrop(RHS As Boolean)

Gets or sets whether the user can move nodes with the mouse.

None

Property value: Boolean – True to allow dragging; False (default) to prevent it.

Dragging moves a node; with Ctrl held down it copies the node with its subtree. The same operations are available with Ctrl+X, Ctrl+C, Ctrl+V and Alt+Arrow keys. Only moves within the same control are supported.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AutoSave() As Boolean
Property Let AutoSave(RHS As Boolean)

Gets or sets whether changes are written into the record source right away.

None

Property value: Boolean – True (default) to write every change; False to change only the display.

Each operation is written in one transaction; BeforeUpdate can cancel it and roll back what was already written. A tree loaded from a Recordset or a file never writes.

The control does not check beforehand whether the record source can be updated. When Access refuses to write - a query that cannot be updated, a validation rule, a locked record - the transaction is rolled back, the tree is reloaded, and DataError occurs, followed by a message box with its text unless DataError sets Response to acDataErrContinue. For a source that cannot be updated, switch editing off instead (AllowEditing, AllowAdditions, AllowDeletions).

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get NodeText(ByVal Key As Variant) As String
Property Let NodeText(ByVal Key As Variant, RHS As String)

Gets or sets the text of a node.

Property value: String – The displayed text.

Setting the text renames the node; with AutoSave the new text is written into TextField.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub MoveNode(ByVal Key As Variant, ByVal TargetKey As Variant, Optional ByVal Position As WklDropPosition = wdpInside)

Moves a node to a new place.

With AutoSave, the new parent key (and the sort value, when SortField is set) is written into the record source. Moving a node below itself or one of its descendants raises wkeInvalidValue.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub StartLabelEdit(ByVal Key As Variant)

Starts renaming a node in form view, for example from a custom menu item.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub SaveToFile(ByVal Path As String, Optional ByVal Format As WklFileFormat = wffAuto)

Saves the nodes and their state (expanded nodes, selection, check marks) to a file.

Values keep their type (a Long key loads as Long) and are written independent of regional settings. A WklTreeList also writes the values of its columns with each node; LoadFromFile into an unbound list shows them again. Files without column values load with empty columns.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub LoadFromFile(ByVal Path As String, Optional ByVal Format As WklFileFormat = wffAuto)

Loads a file written by SaveToFile.

Without RecordSource, the file's nodes become an unbound tree. With RecordSource, only the state is applied (expanded nodes, selection, check marks) to the nodes of the source. An invalid file raises wkeInvalidValue.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub SaveToStream(ByVal Stream As Object, Optional ByVal Format As WklFileFormat = wffJson)

Writes the nodes and their state to an open ADODB.Stream.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub LoadFromStream(ByVal Stream As Object, Optional ByVal Format As WklFileFormat = wffAuto)

Reads the nodes and their state from an open ADODB.Stream.

The rules of LoadFromFile apply.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get MultiSelect() As Boolean
Property Let MultiSelect(RHS As Boolean)

Gets or sets whether several nodes can be selected.

None

Property value: Boolean – True to allow Ctrl+click and Shift+click; False (default) for a single selection.

Dragging, copying and deleting act on all selected nodes.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SelectedKeys() As Variant
Property Let SelectedKeys(RHS As Variant)

Gets or sets the keys of all selected nodes.

None

Property value: Variant – A Variant array of keys, in display order.

Setting an array selects those nodes; setting an empty array clears the selection.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ContextMenu() As Boolean
Property Let ContextMenu(RHS As Boolean)

Gets or sets whether the built-in context menu opens on the right mouse button.

None

Property value: Boolean – True (default) to show it; False to show only the custom items of AddMenuItem.

The built-in menu of WklTreeView (the menus of WklTreeList and WklGrid are described on their pages):

With ContextMenu = False only the custom entries are shown. Before any menu opens, NodeRightClick occurs; setting its Cancel shows no menu at all, for example to show an Access shortcut menu instead. The menu key and Shift+F10 open the same menu at the selected node, without NodeRightClick.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AllowAdditions() As Boolean
Property Let AllowAdditions(RHS As Boolean)

Gets or sets whether the user can add nodes.

None

Property value: Boolean – True to allow Insert (same level) and Ctrl+Insert (below) and the menu items; False (default) to prevent it.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AllowDeletions() As Boolean
Property Let AllowDeletions(RHS As Boolean)

Gets or sets whether the user can delete nodes.

None

Property value: Boolean – True to allow Delete and the menu item; False (default) to prevent it.

A node is deleted with its subtree after a confirmation, which BeforeDelete can suppress.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function AddNode(ByVal TargetKey As Variant, ByVal Text As String, Optional ByVal Position As WklDropPosition = wdpInside) As Variant

Adds a node and returns its key.

Return value: Variant – The key of the new node.

With AutoSave, a record is added to the record source; an AutoNumber key is returned as assigned by Access.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function CopyNode(ByVal Key As Variant, ByVal TargetKey As Variant, Optional ByVal Position As WklDropPosition = wdpInside) As Variant

Copies a node with its subtree and returns the key of the copy.

Return value: Variant – The key of the copy.

With AutoSave, the records are copied in the record source. Attachment and multi-valued fields are not copied.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub DeleteNode(ByVal Key As Variant)

Deletes a node with its subtree, without confirmation.

With AutoSave, the records are deleted from the record source.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get PathSeparator() As String
Property Let PathSeparator(RHS As String)

Gets or sets the separator of text paths.

None

Property value: String – The separator used by FullPath, SelectNode and NodeExists. Default: a backslash, as in the VB6 TreeView.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get FullPath(ByVal Key As Variant) As String

Returns the text path of a node.

Property value: String – The texts from the root down to the node, separated by PathSeparator.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function SelectNode(ByVal Path As String) As Variant

Selects the node a path finds and returns its key.

Return value: Variant – The key of the selected node.

Texts in a text path are compared without case. With LazyLoad, only the levels along the path are loaded. A JPath expression selects its first match. A path that finds no node raises wkeKeyNotFound; use NodeExists to test first.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function FindNodes(ByVal JPath As String) As Variant

Returns the keys of all nodes a JPath expression finds.

Return value: Variant – A Variant array of keys; an empty array when nothing matches.

The expression runs over a JSON view of the tree in which every node has the members Key, Text, ParentKey, Image, SortValue, Checked, Level and Nodes (its children). With LazyLoad, the whole tree is loaded first.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function NodeExists(ByVal Path As String) As Boolean

Tells whether a path finds a node.

Return value: Boolean – True when a node is found.

Never raises an error.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function SaveToString(Optional ByVal Format As WklFileFormat = wffJson) As String

Returns the nodes and their state as text.

Return value: String – The same text SaveToFile writes.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub LoadFromString(ByVal Text As String, Optional ByVal Format As WklFileFormat = wffAuto)

Loads the nodes and their state from a text written by SaveToString.

The rules of LoadFromFile apply.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AsJSON() As Object
Property Set AsJSON(RHS As Object)

Gets or sets the nodes and their state as a WKL Office JSON document.

None

Property value: Object – A JDoc; its Json property holds the text.

Requires WKL Office JSON to be registered. Assigning a JDoc with Set loads it under the rules of LoadFromFile.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub BeginUpdate()

Suspends drawing until the matching EndUpdate.

None

Use it around many changes made by code. Calls can be nested.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub EndUpdate()

Ends a BeginUpdate.

None

The last EndUpdate of a nesting redraws the tree once.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get EventProcedures() As String
Property Let EventProcedures(RHS As String)

Lists the events that have an event procedure in the form module.

None

Property value: String – The event names, separated by semicolons. Writing is ignored.

Access never lists the events of an ActiveX control on the property sheet's Event tab. This row of the Other tab is the way to them: its [...] button opens the Events page, which creates or opens the event procedures.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ToolTipField() As String
Property Let ToolTipField(RHS As String)

Gets or sets the field with the tooltip of a node.

None

Property value: String – A field name, or an empty string for no tooltips; for example a description when TextField holds a number.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get NodeToolTip(ByVal Key As Variant) As String

Returns the tooltip of a node.

Property value: String – The value of ToolTipField for the node; an empty string without a tooltip.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get CheckedField() As String
Property Let CheckedField(RHS As String)

Gets or sets the Yes/No field with the check mark of a node.

None

Property value: String – A field name, or an empty string for check marks that are not stored.

With AutoSave, toggling a check box writes the field.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get CheckMode() As WklCheckMode
Property Let CheckMode(RHS As WklCheckMode)

Gets or sets how check boxes behave.

None

Property value: `WklCheckMode` – A `WklCheckMode` constant. Default: wcmIndependent.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get NodeCheckState(ByVal Key As Variant) As WklCheckState

Returns the displayed state of a node's check box.

Property value: `WklCheckState` – A `WklCheckState` constant; wcsMixed only with CheckMode = wcmRecursive.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ForeColorField() As String
Property Let ForeColorField(RHS As String)

Gets or sets the field with the text color of a node.

None

Property value: String – A field name with a color number, or an empty string to use ForeColor.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get BoldField() As String
Property Let BoldField(RHS As String)

Gets or sets the Yes/No field that shows a node's text in bold.

None

Property value: String – A field name, or an empty string for regular text.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AllowSearch() As Boolean
Property Let AllowSearch(RHS As Boolean)

Gets or sets whether Ctrl+F opens the search bar in form view.

None

Property value: Boolean – True (default) to allow the search bar.

The search bar searches the text of all nodes of the record source, loaded or not, and counts at most 1,000 matches. F3 and Shift+F3 move between matches; “Nur Treffer” filters to the matches.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SearchText() As String
Property Let SearchText(RHS As String)

Gets or sets the search text.

None

Property value: String – The text; nodes whose text contains it are highlighted. An empty string ends the search.

Nodes that are not loaded yet count as matches too. SearchCount returns the number of matches, FindNext selects them.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function FindNext(Optional ByVal Backward As Boolean = False) As Variant

Selects the next match of SearchText and returns its key.

Return value: Variant – The key of the selected match, or Null when there is no match.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get SearchCount() As Long

Returns the number of matches of SearchText.

None

Property value: Long – The number of matches.

Read-only.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get Filter() As String
Property Let Filter(RHS As String)

Gets or sets a filter that limits the visible nodes.

None

Property value: String – A WHERE condition of the record source (as Form.Filter), or a JPath expression starting with $ over the loaded nodes. An empty string shows all nodes.

Matches stay visible together with their ancestors. A WHERE condition queries the record source each time it is set; for a pass-through query the whole query runs on the server. Every record that meets the condition is shown: for up to 1,000 matches the tree loads the path to each, for more it loads the whole tree once. In WklTreeList, FilterIncludesChildren shows the child nodes of a match as well, and the column filter applies in addition. Removing the filter restores the view from before.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub AddMenuItem(ByVal Caption As String, ByVal Tag As String, Optional ByVal BeginGroup As Boolean = False)

Adds a custom item to the context menu.

Adding an item with a tag that exists replaces that item. In WklTreeList, WklGantt and WklGrid, MenuItemEnabled, MenuItemChecked, MenuItemGlyph, MenuItemShortcut and MenuItemParent change an item afterwards, and MenuPlacement sets where the items stand.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub RemoveMenuItem(ByVal Tag As String)

Removes the custom menu item with a tag.

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub ClearMenuItems()

Removes all custom menu items.

None

None

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get Layout() As String
Property Let Layout(RHS As String)

Gets or sets the view state as text: expanded nodes and selection, without the nodes.

None

Property value: String – The layout text.

Store the text between sessions (for example in a table or TempVars) and assign it back to restore the view.

In a WklTreeList and a WklGantt the text also holds the arrangement of the columns since type library 1.28 ("arrangement", as AutoSaveLayout remembers it); assigning a text without it - written by an older version, or with nothing changed - shows the columns as designed. Set before the control shows (in Form_Load), the text wins over the remembered arrangement; for storage of your own, switch AutoSaveLayout off. WklGantt adds its zoom, split position and first visible day.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get FormatEvents() As Boolean
Property Let FormatEvents(RHS As Boolean)

Gets or sets whether NodeFormat (and CellFormat of WklTreeList) is raised.

None

Property value: Boolean – True to raise the events; False (default) to skip them.

Access passes every event call to the form, handled or not, at a cost of about 3 ms per call; the formatting events run for every visible node or cell on every redraw. Switch this on only when the form handles the events. ForeColorField and BoldField do not need it.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get LivePreview() As Boolean
Property Let LivePreview(RHS As Boolean)

Gets or sets whether design view shows the real data.

None

Property value: Boolean – True to draw the records of the record source in design view; False (default) to draw sample nodes.

With False, drawing the form in design view never queries the record source, so forms bound to pass-through queries or large linked tables open in design view without delay. Form view and the preview of the designer window always read the data. On a report the control shows a notice instead of data; reports are not supported. A tree linked to a master (LinkChildFields) shows in design view and in the designer preview the records of the form's first record, because design view has no current record.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get LinkChildFields() As String
Property Let LinkChildFields(RHS As String)

Gets or sets the fields that link the records to a master record, as on an Access subform.

None

Property value: String – Field names of the record source, separated by semicolons; empty (default) for a tree without master.

With LinkChildFields set, the tree shows only the records whose link fields equal the master values (see LinkMasterFields, MasterValues and MasterRecordset). Without a master record - a new or empty master - the tree is empty and adding and copying are refused with wkeInvalidValue. New records get the master values in their link fields. The value is saved with the form.

Read/write.

With Me!List1.Object
    .LinkChildFields = "OrderID"
    .LinkMasterFields = "ID"
End With

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get LinkMasterFields() As String
Property Let LinkMasterFields(RHS As String)

Gets or sets the fields or controls of the master that hold the values for LinkChildFields.

None

Property value: String – Names in the same order as LinkChildFields, separated by semicolons.

The master is the form the control sits on, unless MasterRecordset or MasterValues is set. A name is looked up as a field of the form's recordset first and as a control of the form second, as LinkMasterFields of an Access subform. In form view the control checks the master record on idle (every 250 ms) and reloads when it changed; with ControlSource set, Access reports each change at once through MasterValue.

A name can also name another WKL control of the same form (WklGrid, WklTreeList, WklTreeView, WklGantt) as the master. Only the form the control sits on is searched: a control inside a subform cannot name a control of the main form; use MasterValues or MasterRecordset from code for that case. Grid1 stands for its key (every part of a composite key), Grid1.KundeID for a field of its selected record - the key, a column, or any other field of its record source. The control then follows the selection of that control without code: at once for a change made by code, after a short pause while the user moves through the records with the keyboard. With nothing selected there, or a group row, the control shows no records. Names of both kinds can be mixed. In design view with LivePreview, the first record of the master control's record source is the master.

The other way round, an Access subform follows a WKL control when its LinkMasterFields names the control (Grid1) and its LinkChildFields the field that holds the key: Access reads the selected key through the control's Value, and the control requeries such subforms when its selection changes, because Access does not do it by itself.

The value is saved with the form.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get MasterValue() As Variant
Property Let MasterValue(RHS As Variant)

Gets or sets the value Access writes into the control on every record change of the form when ControlSource is set.

None

Property value: Variant – The current value of the control's ControlSource.

MasterValue is the bindable default property of the control for Access' data binding: set the control's ControlSource (property sheet, tab Data) to a link field such as ID, or to an expression over several fields, and Access writes the current value on every record change - also for filters and new records. The value is only the trigger: the master values are read from LinkMasterFields. Without ControlSource, the idle check does the same with a delay of up to 250 ms.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get MasterValues() As Variant
Property Let MasterValues(RHS As Variant)

Gets or sets the master values the records are limited to.

None

Property value: Variant – A value for one link field, or an array with one value per link field; Null when there is no master record.

Reading returns the current master values, wherever they come from. Setting a value takes it from code and ignores the form and MasterRecordset until MasterValues is set to Null; this works in any container, also on Excel, Word and Outlook UserForms, which have no form recordset. Setting from code raises no events.

Read/write.

UserForm1.List1.MasterValues = Array("A", 4711)   ' two link fields, on an Excel UserForm

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get MasterRecordset() As Object
Property Set MasterRecordset(RHS As Object)

Gets or sets a DAO or ADO recordset whose current record is the master.

None

Property value: Object – The recordset, or Nothing to use the form again.

Assign with Set. The control reads LinkMasterFields from the current record of the recordset, for example of another subform's recordset or a combo box's. In form view it checks the record on idle; SyncMaster reads it at once. A field that the recordset does not have raises wkeInvalidValue.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Sub SyncMaster()

Reads the master values again and reloads the records when they changed.

None

Needed only when the master changes outside form view or must take effect at once, for example after moving MasterRecordset by code. Raises no events.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Function KeyCriteria(ByVal Key As Variant) As String

Returns the WHERE condition that finds the record of a key.

Return value: String – For example [ID] = 7, or [OrderID] = 4711 AND [LineNo] = 2 for a composite key; a Null part as Is Null.

Use it to filter a form by the selected node without building the condition by hand, also for composite keys and text or date keys.

Private Sub List1_NodeSelect(ByVal Key As Variant)
    Me.Details.Form.Filter = Me!List1.Object.KeyCriteria(Key)
    Me.Details.Form.FilterOn = True
End Sub

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get MasterFilterMode() As WklMasterFilterMode
Property Let MasterFilterMode(RHS As WklMasterFilterMode)

Gets or sets how a linked tree selects the records of the master record.

None

Property value: `WklMasterFilterMode` – wmfSource (default) to read the records of each master record through a WHERE condition on the record source; wmfLocal to read the record source once and filter it in memory.

Applies only with LinkChildFields set. wmfLocal is meant for sources that Access can only wrap, such as a pass-through query or a slow linked table: with wmfSource every master change runs the whole query again. With wmfLocal the tree reads all records once, together with the link fields, and each master change only filters them; Requery and every change the tree writes read the source again. wmfLocal loads all levels at once (LazyLoad does not apply), and searching and filtering work on the loaded records. The value is saved with the form. The designer page Link offers it as Load once, filter in memory.

Read/write.

Me!List1.Object.MasterFilterMode = wmfLocal   ' tblLines is a pass-through query

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get ColorScheme() As WklColorScheme
Property Let ColorScheme(RHS As WklColorScheme)

Gets or sets the color scheme the control draws in.

None

Property value: `WklColorScheme` – wcoAutomatic (default), wcoLight, wcoDark or wcoHighContrast.

wcoAutomatic follows, in this order, Windows high contrast mode, then the color set of the database design (Access: Design › Themes or Colors; the Riviera theme of the release package is one), and draws light when the database has no design. Office's own design setting (File › Account) and the Windows app mode are deliberately not followed: a database looks the same on every PC. In high contrast mode the control always uses the system colors, whatever the setting, as Office does. The scheme colors the records, headers and lines of WklTreeList and WklGantt; the native tree of WklTreeView takes background, text and search highlight from the scheme and asks Windows for the dark Explorer look of its chevrons and scroll bars with a dark scheme: background and text while BackColor and ForeColor keep their defaults (a color you set wins), headers, lines, selection, focus, group rows and marks. Every text keeps a contrast of at least 4.5:1, also with a database color set whose own colors would fall below it. The control reads the database design when it is first drawn and again with Requery, never while Access draws the form; a design chosen while the form is open shows after Requery or when the form is opened again. The value is saved with the form.

Read/write.

Me!List1.Object.ColorScheme = wcoDark

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Property Get AllowFileDrop() As Boolean
Property Let AllowFileDrop(RHS As Boolean)

Gets or sets whether files and folders dragged from Windows Explorer can be dropped on the control.

None

Property value: Boolean – True to accept files; False (default) to refuse them.

With True the control reports a drag from Windows Explorer through FileDragOver and a drop through FileDrop; it writes nothing itself, so your code decides what a file becomes (a record, an attachment, a path in a field). The target is the node under the mouse, with the same insert mark and position as when nodes are dragged; a drop below the last node has no target. Other drags than files (text from Word, a mail from Outlook) are refused. Files are taken only in form view, not in design view. The setting is independent of AllowDragDrop, which moves nodes within the control. The value is saved with the form; a form saved before version 1.57 takes the default.

Read/write.

None

Declared by WklTreeView; also available on `WklTreeList`, `WklGantt`.

Event NodeSelect(ByVal Key As Variant)

Occurs when the user selects a node.

In a form module: Private Sub <ControlName>_NodeSelect(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeExpand(ByVal Key As Variant)

Occurs after a node is expanded.

In a form module: Private Sub <ControlName>_NodeExpand(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeCollapse(ByVal Key As Variant)

Occurs after a node is collapsed.

In a form module: Private Sub <ControlName>_NodeCollapse(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeCheck(ByVal Key As Variant, ByVal Checked As Boolean)

Occurs after the user toggles a check box.

In a form module: Private Sub <ControlName>_NodeCheck(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeDblClick(ByVal Key As Variant)

Occurs when the user double-clicks a node.

In a form module: Private Sub <ControlName>_NodeDblClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeNodeSelect(ByVal Key As Variant, ByRef Cancel As Integer)

Occurs before a node is selected.

In a form module: Private Sub <ControlName>_BeforeNodeSelect(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeExpand(ByVal Key As Variant, ByRef Cancel As Integer)

Occurs before a node is expanded.

In a form module: Private Sub <ControlName>_BeforeExpand(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeCollapse(ByVal Key As Variant, ByRef Cancel As Integer)

Occurs before a node is collapsed.

In a form module: Private Sub <ControlName>_BeforeCollapse(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeNodeCheck(ByVal Key As Variant, ByVal Checked As Boolean, ByRef Cancel As Integer)

Occurs before a check box is toggled.

In a form module: Private Sub <ControlName>_BeforeNodeCheck(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeClick(ByVal Key As Variant)

Occurs when the user clicks a node with the left mouse button.

In a form module: Private Sub <ControlName>_NodeClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeRightClick(ByVal Key As Variant, ByVal X As Single, ByVal Y As Single, ByRef Cancel As Integer)

Occurs when the user right-clicks a node.

In a form module: Private Sub <ControlName>_NodeRightClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeLabelEdit(ByVal Key As Variant, ByRef Cancel As Integer)

Occurs before the user starts renaming a node.

In a form module: Private Sub <ControlName>_BeforeLabelEdit(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterLabelEdit(ByVal Key As Variant, ByRef NewText As String, ByRef Cancel As Integer)

Occurs after the user renamed a node, before the new text is saved.

In a form module: Private Sub <ControlName>_AfterLabelEdit(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeDragStart(ByVal Key As Variant, ByRef Cancel As Integer)

Occurs when the user starts dragging a node.

In a form module: Private Sub <ControlName>_NodeDragStart(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeDragOver(ByVal SourceKey As Variant, ByVal TargetKey As Variant, ByVal Position As WklDropPosition, ByVal Effect As WklDropEffect, ByRef Cancel As Integer)

Occurs when a dragged node moves over a new target.

In a form module: Private Sub <ControlName>_NodeDragOver(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeDrop(ByVal SourceKey As Variant, ByVal TargetKey As Variant, ByVal Position As WklDropPosition, ByVal Effect As WklDropEffect, ByRef Cancel As Integer)

Occurs when a node is moved or copied, before the change is saved.

Raised for dragging, paste and the move up and down commands; with a multiple selection once per node.

In a form module: Private Sub <ControlName>_NodeDrop(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterNodeDrop(ByVal SourceKey As Variant, ByVal TargetKey As Variant, ByVal Position As WklDropPosition, ByVal Effect As WklDropEffect, ByVal NewKey As Variant)

Occurs after a node was moved or copied and saved.

In a form module: Private Sub <ControlName>_AfterNodeDrop(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event CompareNodes(ByVal Key1 As Variant, ByVal Key2 As Variant, ByRef Result As Long)

Occurs when two sibling nodes are compared with SortOrder = wsoCustom.

In a form module: Private Sub <ControlName>_CompareNodes(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterRequery()

Occurs after the nodes were loaded again.

None

In a form module: Private Sub <ControlName>_AfterRequery(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event DataError(ByVal DataErr As Long, ByVal Description As String, ByRef Response As Integer)

Occurs when loading or saving fails.

Also raised when a list reads records while it draws, scrolls or follows the keyboard - WklGrid in server mode reads page by page: once per failure, after the current message; the window then shows the text instead of records and reads nothing more until Requery. Code that needs the records receives the error as a run-time error.

In a form module: Private Sub <ControlName>_DataError(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event KeyDown(ByRef KeyCode As Integer, ByVal Shift As Integer)

Occurs when a key is pressed while the control has the focus.

In a form module: Private Sub <ControlName>_KeyDown(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event KeyPress(ByRef KeyAscii As Integer)

Occurs when a character is typed.

In a form module: Private Sub <ControlName>_KeyPress(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event KeyUp(ByRef KeyCode As Integer, ByVal Shift As Integer)

Occurs when a key is released.

In a form module: Private Sub <ControlName>_KeyUp(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event MouseDown(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Single, ByVal Y As Single)

Occurs when a mouse button is pressed over the control.

In a form module: Private Sub <ControlName>_MouseDown(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event MouseUp(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Single, ByVal Y As Single)

Occurs when a mouse button is released over the control.

In a form module: Private Sub <ControlName>_MouseUp(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event MouseMove(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Single, ByVal Y As Single)

Occurs when the mouse moves over the control.

In a form module: Private Sub <ControlName>_MouseMove(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event MouseWheel(ByVal Page As Boolean, ByVal Count As Long)

Occurs when the mouse wheel turns over the control.

In a form module: Private Sub <ControlName>_MouseWheel(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event SelectionChange()

Occurs when the user changes the multiple selection (SelectedKeys).

None

In a form module: Private Sub <ControlName>_SelectionChange(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeNodeCopy(ByVal SourceKey As Variant, ByRef NewKey As Variant, ByRef Cancel As Integer)

Occurs before a node is copied.

In a form module: Private Sub <ControlName>_BeforeNodeCopy(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeNodeAdd(ByVal ParentKey As Variant, ByRef NewKey As Variant, ByRef Text As String, ByRef Cancel As Integer)

Occurs before the user adds a node.

In a form module: Private Sub <ControlName>_BeforeNodeAdd(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterNodeAdd(ByVal Key As Variant)

Occurs after a node was added and saved.

In a form module: Private Sub <ControlName>_AfterNodeAdd(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeDelete(ByVal Key As Variant, ByVal Count As Long, ByRef Cancel As Integer, ByRef Confirm As Boolean)

Occurs before the user deletes a node.

In a form module: Private Sub <ControlName>_BeforeDelete(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterDelete(ByVal Key As Variant)

Occurs after a node was deleted with its subtree.

In a form module: Private Sub <ControlName>_AfterDelete(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeUpdate(ByVal Key As Variant, ByVal Action As WklUpdateAction, ByRef Cancel As Integer)

Occurs before each write into the record source caused by an action of the user.

One user action can write several records (for example a copied subtree); all writes of an action share one transaction.

In a form module: Private Sub <ControlName>_BeforeUpdate(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterUpdate(ByVal Key As Variant, ByVal Action As WklUpdateAction)

Occurs after each write into the record source caused by an action of the user.

In a form module: Private Sub <ControlName>_AfterUpdate(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event NodeFormat(ByVal Key As Variant, ByRef ForeColor As Long, ByRef BackColor As Long, ByRef Bold As Boolean, ByRef Italic As Boolean)

Occurs before a node is shown in form view, to format it.

Raised only with FormatEvents = True, for every visible node on every redraw. Keep the procedure short and avoid queries in it.

In a form module: Private Sub <ControlName>_NodeFormat(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event MenuItemClick(ByVal Tag As String, ByVal Key As Variant)

Occurs when the user clicks a custom menu item.

In a form module: Private Sub <ControlName>_MenuItemClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event BeforeMasterChange(ByVal Values As Variant, ByRef Cancel As Integer)

Occurs before the tree changes to the records of another master record.

Raised for changes of the form's record and of MasterRecordset, not when MasterValues is set by code.

In a form module: Private Sub <ControlName>_BeforeMasterChange(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event AfterMasterChange(ByVal Values As Variant)

Occurs after the tree was loaded with the records of another master record.

In a form module: Private Sub <ControlName>_AfterMasterChange(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event FileDragOver(ByVal Files As Variant, ByVal TargetKey As Variant, ByVal Position As WklDropPosition, ByRef Cancel As Integer)

Occurs when files from Windows Explorer are dragged over a new target (AllowFileDrop).

The event occurs once for each new target or position, not on every movement of the mouse. Windows Explorer waits for the handler while the user drags, so keep it short: decide from the paths and the target, do not open files or show messages here.

In a form module: Private Sub <ControlName>_FileDragOver(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.

Event FileDrop(ByVal Files As Variant, ByVal TargetKey As Variant, ByVal Position As WklDropPosition)

Occurs when files from Windows Explorer were dropped (AllowFileDrop).

The event occurs after the drop has ended, so Windows Explorer is free again while the handler runs; the handler may show messages, copy files or write records. The control changes nothing: add records, store paths or read the files in the handler, then call Requery if the control should show new records. A target for which FileDragOver set Cancel never receives a drop. Folders appear as paths like files; use GetAttr to tell them apart.

In a form module: Private Sub <ControlName>_FileDrop(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTreeView.