SftTree/DLL 7.5 - Tree Control
SftBox/OCX 5.0 - Combo Box Control
SftButton/OCX 3.0 - Button Control
SftMask/OCX 7.0 - Masked Edit Control
SftTabs/OCX 6.5 - Tab Control (VB6 only)
SftTree/OCX 7.5 - Tree Control
SftPrintPreview/DLL 2.0 - Print Preview Control (discontinued)
SftTree/DLL 7.5 - Tree Control
SftBox/OCX 5.0 - Combo Box Control
SftButton/OCX 3.0 - Button Control
SftDirectory 3.5 - File/Folder Control (discontinued)
SftMask/OCX 7.0 - Masked Edit Control
SftOptions 1.0 - Registry/INI Control (discontinued)
SftPrintPreview/OCX 1.0 - Print Preview Control (discontinued)
SftTabs/OCX 6.5 - Tab Control (VB6 only)
SftTree/OCX 7.5 - Tree Control
SftTabs/NET 6.0 - Tab Control (discontinued)
SftTree/NET 2.0 - Tree Control
Direct calls to the SftTree DLLs are used to communicate with the tree control for maximum efficiency.
The class CSftTree defines all necessary functions to communicate with the tree control. The class CSftTreeSplit defines a split tree control.
The API Reference section lists C and C++ macros and functions. They are sorted alphabetically, but leading SftTree_, SftTree_Get and SftTree_Set text is not considered. E.g., when looking up the function SftTree_GetCurSel, look for topic CurSel, the leading SftTree_Get is dropped.
The following function groups are listed in detail:
Application | Application initialization and termination |
Attributes | General tree control attributes |
Callback Routines | Application-defined callback routines |
Columns, Column Headers and Footers | Column and column header/column footer attributes |
Current Item, Selection | The currently selected item |
Drag & Drop | Drag & drop support functions |
Item Attributes | Item and cell attributes |
Item Hit Testing | Hit testing |
Items | Item manipulation |
Positioning & Resizing | Item positioning and resizing |
Relationships | Retrieving parent/child relationship information |
Row/Column Footer | Row/column footer attributes |
Row/Column Header | Row/column header attributes |
Row Header | Row header attributes |
Scrolling | Scrolling manipulation |
Sorting | Sorting items |
Split Tree Control | Split tree control and splitter bar manipulation |
Virtual Mode | Using a virtual data source |
RegisterApp | Registers an application with SftTree/DLL. |
UnregisterApp | Unregisters an application from SftTree/DLL. |
FreeGDIPlusImageLoadedFromResource | Deletes a GDI+ image obtained using SftTree_LoadGDIPlusImageFromResource. |
LoadGDIPlusImageFromResource | Loads a GDI+ image from an application's or DLL's resources. |
~CSftTree | Standard destructor. |
~CSftTreeSplit | Standard destructor. |
AutoExpand | Defines whether items are automatically expanded when the mouse hovers over a collapsed parent item. |
AutoExpandItem | Returns the zero-based index of the item to be expanded as a result of a call to StartAutoExpandTimer or SetAutoExpand. |
BackgroundBitmap | Defines a background bitmap used as the background for the tree control. |
Bitmaps | Registers the size and sets the default item pictures used for all items. |
Buttons | Registers the size and sets the bitmaps used for expand/collapse buttons. |
CalcLimit | Defines the maximum number of items to consider for optimal column width and scrolling calculation. |
CalcVisibleOnly | Defines whether only visible items are considered for optimal column width and scrolling calculation. |
CharSearchMode | Defines the method used to search for matching items in response to characters typed by the user. |
ControlData | Defines an application-defined value. |
ControlInfo | Defines the tree control's attributes. |
Create | Creates a tree control window and attaches it to the CSftTree or CSftTreeSplit object. |
CSftTree | Standard constructor. |
CSftTreeSplit | Standard constructor. |
CtlColors | Defines the tree control's color attributes. |
CustomCode | Defines optional product customization. |
Flyby | Defines whether flyby highlighting is enabled. |
FlybyIndex | Returs the index of the highlighted item for flyby highlighting. |
ForwardChildMsgs | Defines the child window message handling status. |
GridStyle | Defines the grid line display style. |
Indentation | Defines the indentation (in pixels) for item levels. |
InheritBgColor | Defines whether the area to the left of the first cell inherits the cell's background color. |
ItemLines | Defines the number of text lines used for item height calculation. |
ItemsShown | Returns the number of items displayable in the tree control's client area, including partial items. |
ItemsShownComplete | Returns the number of items displayable in the tree control's client area, not including partial items. |
KeyHandling | Defines keystrokes intercepted during cell editing. |
NoFocusStyle | Defines the display style of selected items when the tree control does not have the input focus. |
Pictures | Registers the size and sets the default item pictures used for all items. |
PlusMinus | Defines the plus/minus bitmaps used for all items. |
ScrollTips | Defines whether ScrollTips are displayed during vertical scrolling. |
SFT_PICTURE | Used to describe a picture component (a bitmap, icon or ImageList image, etc.). |
SFTTREE_CLASS | Defines the window class name of a tree control without splitter bar. |
SFTTREE_COLORS | Used with GetCtlColors and SetCtlColors to retrieve and set a tree control's color attributes. |
SFTTREE_CONTROL | Used with GetControlInfo and SetControlInfo to retrieve and set tree control attributes. |
SFTTREE_DWORD_PTR | Defines a type large enough to hold a DWORD or pointer value. |
SFTTREE_ID | Defines the type of an item ID. |
SFTTREE_MAXLEVELS | Defines the maximum number of levels supported. |
SFTTREE_NOCOLOR | Used to indicate that the default color should be used. |
SFTTREE_OBSOLETE_4 | Used to indicate compatibility with SftTree/DLL 4.0 (and older). |
SFTTREESPLIT_CLASS | Defines the window class name of a tree control with splitter bar. |
Show3D | Defines the current display method used for items. |
ShowBitmaps | Returns a value indicating the presence of item pictures. |
ShowButton0 | Defines the presence of level 0 expand/collapse buttons. |
ShowButtons | Defines the presence of expand/collapse buttons (other than level 0). |
ShowGrid | Defines the presence of grid lines. |
ShowLabels | Returns the presence of label pictures. |
ShowPlusMinus | Returns the presence of plus/minus bitmaps. |
ShowTruncated | Defines whether text is clipped or truncated using trailing "...". |
TabKeyIntercept | Defines the status of Tab key handling during cell editing. |
ToolTipAlways | Defines whether ToolTips are shown even if cell text is not truncated. |
ToolTipsUseEntireCell | Defines whether ToolTips use the entire cell. |
TreeLineStyle | Defines the display style of tree lines. |
UpdateCaretExpandCollapse | Defines whether the current location (caret) is updated when the expand/collapse buttons are used. |
UseSmoothScroll | Defines whether smooth scrolling is used. |
UseThemes | Defines whether the control can use Windows themes. |
VAlign | Defines the vertical alignment of tree lines, label pictures, plus/minus bitmap and item pictures. |
DeleteCallback | Defines a deletion callback routine, called when items are deleted. |
LPFNSFTTREE_OWNERDRAWPROC | Defines the type of an application-supplied owner-draw function, which is called whenever an object needs to be rendered. |
OwnerDrawCallback | Defines an application-supplied owner-draw function, which is called whenever an object needs to be rendered. |
SFTTREE_DELETEPARM | Used to define an application-specific deletion callback routine, which is called whenever an item is removed from the tree control. |
SFTTREE_DELETEPROC | Defines the type of a user-supplied callback routine, called by SftTree/DLL whenever an item is removed from the tree control. |
SFTTREE_OWNERDRAW | Used as parameter for an application-supplied owner-draw function of type LPFNSFTTREE_OWNERDRAWPROC. |
SFTTREE_OWNERDRAWPARM | Used to define an application-specific owner-draw callback routine, which is called whenever an object needs to be rendered. |
SFTTREE_TOOLTIPSPARM | Used as parameter for SetToolTipsCallback, to define an application-specific ToolTips callback routine, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed. |
SFTTREE_TOOLTIPSPROC | Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to define the ToolTip text when a ToolTip or ScrollTip is to be displayed. |
ToolTipsCallback | Defines an application supplied callback function, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed. |
Columns | Defines the number of columns and column attributes. |
CrossColumnResize | Defines whether multiple columns can be resized during one column resizing operation. |
DisplayColumn | Returns the display column number given a real column number. |
DisplayFooterDropDownRect | Returns the dimensions of the column footer dropdown/filter button. |
DisplayFooterRect | Returns the dimensions of the column footer area. |
DisplayHeaderDropDownRect | Returns the dimensions of the column header dropdown/filter button. |
DisplayHeaderRect | Returns the dimensions of the column header area. |
FirstDisplayColumn | Returns the index of the first displayed column. |
Footer | Defines a column's footer text. |
FooterButton | Defines the column number of the currently pressed column footer button. |
FooterFont | Defines the font used for column footer text display. |
FooterLength | Returns the length of a column's footer text. |
FooterRect | Returns the dimensions of the column footer area. |
Header | Defines a column's header text. |
HeaderButton | Defines the column number of the currently pressed column header button. |
HeaderFont | Defines the font used for column header text display. |
HeaderLength | Returns the length of a column's header text. |
HeaderRect | Returns the dimensions of the column header area. |
LastDisplayColumn | Returns the index of the last displayed column. |
MultilineFooter | Defines whether column footers can display multiple lines of text. |
MultilineHeader | Defines whether column headers can display multiple lines of text. |
OpenEnded | Defines whether the last column is open-ended. |
OverheadWidth | Returns the width of the area added to the first column for hierarchical graphics components. |
RealColumn | Returns the real column number given a display column number. |
ReorderColumns | Defines whether columns can be reordered using column drag & drop. |
ResizeColumn | Returns the column number of the column being resized. |
ResizeFooter | Defines whether column footers are resizable by the user. |
ResizeHeader | Defines whether column headers are resizable by the user. |
SFTTREE_COLUMN_EX | Used with GetColumns and SetColumns to retrieve and set column attributes. |
ShowFooter | Defines the presence of column footers. |
ShowFooterButtons | Defines the presence of column footers buttons. |
ShowHeader | Defines the presence of column headers. |
ShowHeaderButtons | Defines the presence of column header buttons. |
CaretColumn | Returns the column where a mouse button was last clicked. |
CaretIndex | Defines the current item (caret location). |
ClickAgainPos | Returns the location of the item that was clicked again. |
CurSel | Defines the index of the selected item (single selection tree control). |
DrawSelectionOutline | Draws a selection outline. |
RubberbandSelection | Defines whether click-drag selection of multiple items using a selection rectangle is supported. |
Sel | Defines the selection status of an item (multiple selection tree only). |
SelCount | Returns the number of currently selected items (multiple selection tree only). |
SelectionArea | Defines the area where selection changes occur. |
SelectionStyle | Defines the display style of selected items. |
SelectString | Searches a string and selects the matching item. |
SelectStringExact | Searches a string and selects the matching item. |
SelItemRange | Selects or deselects a range of items (multiple selection tree only). |
SelItems | Fills an array with the index numbers of currently selected items. |
SelItemsArray | Returns an array of SFTTREE_SELENTRY structures describing groups of selected items. |
SFTTREE_SELENTRY | Used by GetSelItemsArray to return an array of structures describing groups of selected items. |
ShowFocus | Defines whether a focus rectangle is drawn around the current item when the tree control has the input focus. |
DragBitmaps | Defines the drag & drop starting location attribute. |
DragImage | Returns a drag image representing the currently selected items. |
DragInfo | Returns drag & drop operation information in a SFTTREE_DRAGINFO structure. |
DragType | Defines the drag & drop detection attribute. |
DropHighlight | Defines the current drag & drop target location. |
DropHighlightStyle | Defines the display attribute of the current drag & drop target item. |
SFTTREE_DRAGINFO | Used during drag & drop operations and can be retrieved using GetDragInfo. |
StartAutoExpandTimer | Starts a timer for the specified item, so a SFTTREEN_AUTOEXPANDING notification will be sent. |
StopAutoExpandTimer | Ends a started SFTTREEN_AUTOEXPANDING notification timer. |
AdjustCellEditRect | Returns a cell's location in client area coordinates of the left or right pane of a split tree control. |
CellEditWindow | Returns the window containing the specified cell in a split tree control. |
CellInfo | Defines a cell's attributes. |
CellRectInfo | Returns the location of a cell, the cell text and cell picture. |
CellRectInfoEx | Returns the location of a cell, the cell text and cell picture. |
DisplayCellRect | Returns the location of a cell. |
DisplayCellRectForItem | Returns the location of a cell. |
ExpandCollapseButtonRect | Returns the location of an item's expand/collapse button. |
ExpandCollapseIndex | Returns the zero-based index of the item to expand/collapse. |
ItemBitmap | Defines an item's item picture. |
ItemBitmapAlign | Defines whether item pictures of items are aligned with the cells of the immediate parent level. |
ItemData | Defines an item's application-specific value. |
ItemEditIgnore | Defines whether an item is ignored for cell editing. |
ItemExpand | Defines an item's expand status. |
ItemExpandable | Defines whether an item is expandable. |
ItemExpandCollapseButton | Defines whether an item's expand/collapse button is shown. |
ItemHeight | Returns an item's height (in pixels). |
ItemHeightMinMax | Defines an item's minimum and maximum height (in pixels). |
ItemID | Defines an item's ID. |
ItemIgnore | Defines whether the item is excluded from optimal column width and row header width calculation. |
ItemIndex | Returns an item's index given an item ID. |
ItemLabel | Defines an item's label picture information. |
ItemLabelPicture | Defines an item's label picture information. |
ItemLevel | Defines an item's level number. |
ItemPicture | Defines an item's item picture. |
ItemPictureAlign | Defines whether item pictures of items are aligned with the cells of the immediate parent level. |
ItemRect | Returns an item's location in client area coordinates. |
ItemShown | Defines an item's visibility status. |
ItemStatus | Defines an item's enabled/disabled status. |
SFTTREE_CELL | Used with GetCellInfo/SetCellInfo to retrieve and set cell attributes and as part of the SFTTREE_ITEM structure (for a virtual data source). |
SFTTREE_CELLINFOPARM | Used as parameter for GetCellInfo and SetCellInfo to retrieve and set cell attributes. |
Text | Defines an item's cell text. |
TextLength | Returns the length of an item's cell text. |
CalcCellFromPoint | Calculates the item index and column number given a point in tree control client area coordinates. |
CalcColumnFromPoint | Calculates the column number given a point in tree control client area coordinates. |
CalcIndexFromPoint | Calculates the item index number given a point in tree control client area coordinates. |
AddString | Adds a new item to a tree control. The new item is added as the last item at level 0. |
Collapse | Collapses a parent item. |
CopyItems | Copies a group of items to a new location. |
DeleteDependents | Deletes an item's dependent items. |
DeleteString | Deletes an item. |
Expand | Expands a parent item. |
FindItem | Searches item data. |
FindString | Searches a string. |
FindStringEx | Searches cells for a string. |
FindStringExact | Searches a string. |
Count | Returns the number of items in the tree control. |
InsertString | Inserts a new item using a string. |
MoveItems | Moves a group of items to a new position in the tree control. |
ResetContent | Removes all items from the tree control. |
CalcOptimalCellDimensions | Calculates a cell's optimal height and width so its contents aren't truncated. |
CalcOptimalColumnWidth | Calculates a column's optimal width so text and pictures are not clipped. |
CalcOptimalRowHeaderWidth | Calculates the optimal width for row headers so text and pictures are not clipped. |
TopIndex | Defines the index number of the item shown at the top of the tree control. |
MakeCellVisible | Scrolls the specified cell into view horizontally and vertically so that it is displayed in the tree control's client area. |
MakeColumnOptimal | Sets the optimal column width so that the text and pictures of all items can be displayed without being clipped horizontally. |
MakeColumnVisible | Scrolls the specified column into view horizontally so that it is displayed in the tree control's client area. |
MakeIntegralHeight | Resizes the tree control vertically so visible items are displayed in their entirety. |
MakeRowHeaderOptimal | Sets the optimal row header width so that the text and pictures of all row headers can be displayed. |
MakeRowVisible | Scrolls the specified item into view vertically so that it is displayed in the tree control's client area. |
Dependent | Returns dependent item information for a parent item. |
DependentCount | Returns the number of dependents for a parent item. |
NextShown | Returns the next visible item. |
Parent | Returns an item's parent index. |
PrevShown | Returns the previous visible item. |
Sibling | Returns an item's sibling information. |
TopParent | Returns the highest level parent index number for an item. |
RowColFooterButton | Defines whether the row/column footer button is currently down (pressed). |
RowColFooterPicture | Defines the picture displayed in the row/column footer. |
RowColFooterPictureStyle | Defines the position of the picture displayed in the row/column footer. |
RowColFooterRect | Returns the dimensions of the row/column footer area. |
RowColFooterStyle | Defines the position of the text displayed in the row/column footer. |
RowColFooterText | Defines the row/column footer text. |
RowColFooterTextLength | Returns the row/column footer text length. |
ShowRowColFooterButton | Defines the row/column footer's display style. |
RowColBitmap | Defines the picture displayed in the row/column header. |
RowColBitmapStyle | Defines the position of the picture displayed in the row/column header. |
RowColHeaderButton | Defines whether the row/column header button is currently down (pressed). |
RowColHeaderPicture | Defines the picture displayed in the row/column header. |
RowColHeaderPictureStyle | Defines the position of the picture displayed in the row/column header. |
RowColHeaderRect | Returns the dimensions of the row/column header area. |
RowColHeaderStyle | Defines the position of the text displayed in the row/column header. |
RowColHeaderText | Defines the row/column header text. |
RowColHeaderTextLength | Returns the row/column header text length. |
RowColPicture | Defines the picture displayed in the row/column header. |
RowColPictureStyle | Defines the position of the picture displayed in the row/column header. |
RowColText | Defines the row/column header text. |
RowColTextLength | Returns the row/column header text length. |
ShowRowColHeaderButton | Defines the row/column header's display style. |
RowHeaderFont | Defines the font used for row header text display. |
RowHeaderLines | Defines the number of text lines used for row header height calculation. |
RowHeaderRect | Returns the dimensions of the row header area. |
RowHeaderStyle | Defines the position of text displayed in the row headers. |
RowHeaderWidth | Defines the width of the row header area. |
RowInfo | Defines an item's row header attributes. |
RowText | Defines an item's row header text. |
RowTextLength | Returns an item's row header text length. |
SFTTREE_ROW | Used with GetRowInfo and SetRowInfo and as part of the SFTTREE_ITEM structure (for a virtual data source). |
SFTTREE_ROWINFOPARM | Used as parameter for GetRowInfo and SetRowInfo to retrieve and set row header attributes. |
ShowRowHeader | Defines the row header display style. |
DisableNoScroll | Defines the scroll bar handling status. |
HorizontalExtent | Defines the horizontal extent (in pixels) of the displayable area. |
HorizontalOffset | Defines the current horizontal offset (in pixels) of the displayed area. |
RecalcHorizontalExtent | Recalculates the optimal horizontal scrolling extent. |
EnableSortIndicators | Enables sort indicators in column headers. |
ResetSortIndicators | Removes all sort indicators from all columns. |
SFTTREE_SORTPROC_CELLDATA | Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents. |
SFTTREE_SORTPROC_ITEM | Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents. |
SFTTREE_SORTPROCEX | Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents. |
SortColumn1 | Returns information about the currently sorted column. |
SortDependents | Sorts items. |
EnterResizeMode | Allows the user to resize the panes of a split tree control using the keyboard. |
LeftWindow | Returns the window handle or object of the tree control in the left pane of a split tree control. |
MakeSplitterOptimal | Positions the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar. |
RightWindow | Returns the window handle or object of the tree control in the right pane of a split tree control. |
SplitColumn | Defines the number of columns displayed in the left pane of a split tree control. |
SplitterOffset | Defines the offset of the splitter bar relative to the left edge of the tree control's client area. |
SplitterRect | Returns the location of the splitter bar in client area coordinates. |
SplitterWidth | Defines the width of the splitter bar in a split tree control. |
LPFNSFTTREE_VGETITEM | Defines the type of the virtual data source callback used by SftTree/DLL to retrieve information about one item as it is needed by the tree control. |
LPFNSFTTREE_VRELEASEITEM | Defines the type of the virtual data source callback called by SftTree/DLL to release information previously returned by the SFTTREE_VGETITEM callback. |
MakeContentWindow | Defines the specified window as a content window (virtual mode only). |
SFTTREE_ITEM | Used by the callback function SFTTREE_VGETITEM to return the requested item information to SftTree/DLL when a virtual data source is used. |
SFTTREE_VIRTUALDEF | Used by VirtualInitialize to use the tree control in virtual mode and to define the virtual data source. |
VirtualCount | Defines the number of items when using a virtual data source. |
VirtualInitialize | Initializes a tree control for virtual mode and for use with a virtual data source. |
VirtualItemChanged | Notifies a tree control using a virtual data source that items have been changed. |
VirtualUserData | Returns the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called. |
See Also C/C++ API | Notifications