SftTree/OCX 8.0 - ActiveX Tree Control

CaretChange Event, SftTree Object

The caret location changes.

Syntax

object

A SftTree object.

ItemIndex

The new zero-based index of the current item.

Comments

The CaretChange event occurs when the caret location changes.

The current item is the item that has the caret rectangle, which is a rectangle outlining the border of the current item (see Items.Current). When using the up and down arrow keys, the user changes the current item (or caret location, also see Items.NoSelection). The current item is not necessarily the same as the selected item. The Item.Selected property can be used to change the selected item.

ItemIndex may be 0, even if the tree control is empty.

The current item can also be affected by the Items.DropHighlightStyle property.

Examples

VB.NET

        AxSftTree1.Splitter.MakeOptimal()
        ' allow sorting
        AxSftTree1.Headers.SortIndicators = SftTreeHeaderSortIndicatorsConstants.headerSortIndicatorsSftTreeAuto

        AxSftTree1.Items.Current = 0
        AxSftTree1_CaretChange(Me, New _DSftTreeEvents_CaretChangeEvent(0))
    End Sub

    Private Sub AxSftTree1_CaretChange(ByVal sender As Object, ByVal e As AxSftTreeLib80._DSftTreeEvents_CaretChangeEvent) Handles AxSftTree1.CaretChange
        ' set column headers based on selected item
        Dim ID As Integer
        ID = AxSftTree1.get_Item(e.itemIndex).ID
        If ID = m_InboxFolder Or ID = m_OutboxFolder Or ID = m_SavedFolder Or ID = m_DeletedFolder Then
            AxSftTree1.get_Header(0).Text = "Folder"
            AxSftTree1.get_Header(1).Text = "Description"
            AxSftTree1.get_Header(2).Text = "" ' we can use this to merge the adjacent title

View Entire Sample Code

C#

                                if (sortedColumn == 3)
                                    axSftTree1.Items.SortDependents(ItemIndex, sortedColumn, SftTreeSortTypeConstants.sortSftTreeDscCellItemData);
                                else
                                    axSftTree1.Items.SortDependents(ItemIndex, sortedColumn, SftTreeSortTypeConstants.sortSftTreeDescending);
                            }
                            ItemIndex = axSftTree1.get_Item(ItemIndex).NextSibling;
                        } while (ItemIndex >= 0);
                    }
                    // update column headers by calling CaretChange
                    axSftTree1_CaretChange(this, new _DSftTreeEvents_CaretChangeEvent(axSftTree1.Items.Current));
                }
            }
        }

        private void axSftTree1_ItemDblClick(object sender, AxSftTreeLib80._DSftTreeEvents_ItemDblClickEvent e) {
            SftTreeAreaTypeConstants area = (SftTreeAreaTypeConstants) e.areaType; 

View Entire Sample Code

C++

                            m_vTree->Items->SortDependents(ItemIndex, sortedColumn, sortSftTreeDscCellItemData);
                        else
                            m_vTree->Items->SortDependents(ItemIndex, sortedColumn, sortSftTreeDescending);
                    }
                    ItemIndex = m_vTree->Item[ItemIndex]->NextSibling;
                } while (ItemIndex >= 0);
            }
        } 
        // update column headers by calling CaretChange
        OnCaretChangeSftTree1(m_vTree->Items->Current);
    }
}

void CEmailDlg::OnItemDblClickSftTree1(long ItemIndex, short ColIndex, short AreaType, short Button, short Shift) 
{
    if (AreaType == constSftTreeText || AreaType == constSftTreeButton) {

View Entire Sample Code

See Also SftTree Object | Object Hierarchy