SftTree/OCX 7.0

SftTree Object (ISftTree Interface)

Softel vdm, Inc.

The SftTree object represents the SftTree/OCX control. Through its properties, additional objects can be accessed.

Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.

 

Property/Method

Description

_FlatProperties

Defines whether properties are stored as a flat list in a property bag.

_Version

Returns the product's exact version.

AboutBox

Displays product, contact and copyright information.

AddItem

Adds a new item at the end of the list.

Appearance

Defines the control's border look.

AutoRespond

Defines whether the tree control expands and collapses items automatically.

BackColor

Defines the default background color used to draw items that are not selected.

BackColorOdd

Defines the background color used to draw items in odd rows.

BackgroundPicture

Defines the graphic displayed as the control's background.

BackgroundPictureH

Defines the graphic displayed as the control's background.

BackgroundStyle

Defines the scrolling style of the background bitmap.

BackgroundX

Defines the origin (horizontally) of the background bitmap.

BackgroundY

Defines the origin (vertically) of the background bitmap.

BorderStyle

Defines the tree control's border style used.

BulkUpdate

Defines bulk update mode.

ButtonAppearance

Defines the expand/collapse button appearance.

ButtonCollapsed

Defines the expand/collapse button for a collapsed parent item.

ButtonCollapsedDown

Defines the expand/collapse button for a collapsed parent item when the expand/collapse button is pressed.

ButtonCollapsedHot

Defines the expand/collapse button for a collapsed parent item when the mouse cursor is over the expand/collapse button.

ButtonExpanded

Defines the expand/collapse button image for an expanded parent item.

ButtonExpandedDown

Defines the expand/collapse button image for an expanded parent item when the expand/collapse button is pressed.

ButtonExpandedHot

Defines the expand/collapse button image for an expanded parent item when the mouse cursor is over the expand/collapse button.

ButtonPicture

Defines the graphic used to display expand/collapse buttons.

ButtonPictureH

Defines the graphic used to display expand/collapse buttons.

ButtonStyle

Defines the expand/collapse button display method.

CalcCellFromPos

Returns the item index and column number for given coordinates.

CalcCellFromPosPix

Returns the item index and column number for given coordinates.

CalcColumnFromPos

Returns the column number for given coordinates.

CalcColumnFromPosPix

Returns the column number for given coordinates.

CalcIndexFromPos

Returns the item index for given coordinates.

CalcIndexFromPosPix

Returns the item index for given coordinates.

CalcLimit

Defines the maximum number of items to consider for optimal column width and scrolling calculation.

CalcOptimalColumnWidth

Calculates a column's optimal width based on the column contents.

CalcOptimalRowHeaderWidth

Calculates the row header's optimal width based on the contents of all row headers.

CalcVisibleOnly

Defines whether only visible items are considered for optimal column width and scrolling calculation.

CancelMode

Cancels internal modes.

Cell

Returns a SftTreeCell object for a given item/column.

Cell3D

Defines whether cells are painted using a 3D effect.

CellBackColor

Defines the background color used to draw an item's cell that is not selected.

CellEditIntercept

Defines keystrokes to be intercepted during cell editing (using the EditNavigating event).

CellEditLimit

Defines the maximum number of characters in an edit control or combo box during cell editing.

CellEditStyle

Defines the cell editing display style.

CellEventHandling

Defines whether the application handles cell editing events.

CellFont

Defines the font used to display an item's cell text.

CellForeColor

Defines the text color used to draw an item's cell that is not selected.

CellItemData

Defines a cell's application specific value.

CellItemDataString

Defines a cell's application specific string value.

CellPicture

Defines the graphic displayed as an item's cell graphic.

CellPictureAlign

Defines the position of the graphic displayed in an item's cell.

CellPictureH

Defines the graphic displayed as an item's cell graphic.

CellSelectBackColor

Defines the background color used to draw an item's cell that is selected.

CellSelectForeColor

Defines the text color used to draw an item's cell that is selected.

CellText

Defines an item's cell text.

CellTextAlign

Defines the position of the text displayed in an item's cell.

CharSearchColumn

Defines the column searched for characters typed by the user.

CharSearchMode

Defines the search mode for characters typed by the user.

Clear

Removes all items.

ClearCellPictures

Removes the cell graphics from all items.

ClearItemPictures

Removes the item graphics from all items.

ClearLabelPictures

Removes the label graphics from all items.

ClearRowHeaderPictures

Removes the row header graphics from all items.

ColHeaderAppearance

Defines the appearance of all column headers.

ColHeaderBackColor

Defines the background color for all column headers.

ColHeaderButton

Defines the currently pressed column header button.

ColHeaderEnabled

Defines whether the specified column header is enabled.

ColHeaderFont

Defines the font used for all column headers.

ColHeaderForeColor

Defines the text color for all column headers.

ColHeaderGrayedColor

Defines the text color used to draw all disabled column headers.

ColHeaderHilightColor

Defines the color used to draw the highlighted edge of all column headers.

ColHeaderShadowColor

Defines the color used to draw the dark edge of all column headers.

Collapse

Collapses an item so its dependents are no longer visible.

Column

Returns a SftTreeColumn object for a given column.

ColumnBackColor

Defines the background color of cells in the specified column.

ColumnButtonRemainUp

Defines whether the specified column header button will return to its "up" position when pressed.

ColumnForeColor

Defines the text color of cells in the specified column.

ColumnMinWidth

Defines the minimum width of the specified column.

ColumnPicture

Defines the graphic displayed in the specified column header.

ColumnPictureAlign

Defines the position of the graphic displayed in the specified column header.

ColumnPictureH

Defines the graphic displayed in a column header.

Columns

Defines the number of columns.

ColumnSelectBackColor

Defines the background color of selected items in the specified column.

ColumnSelectForeColor

Defines the text color of selected items in the specified column.

ColumnsObj

Returns the SftTreeColumns object.

ColumnStyle

Defines the cell style in the specified column.

ColumnText

Defines a column header's text.

ColumnTextStyle

Defines a column header's text style.

ColumnWidth

Defines the width of the specified column.

CopyItem

Copies an item to a new position in the tree control.

CopyItemDataString

Defines whether the Item.DataString property is copied or moved with an item.

CopyItems

Copies items to a new position in the tree control.

CrossColumnResize

Defines whether multiple columns can be resized in one resizing operation.

CustomCode

Defines optional product customization.

DeleteDependents

Deletes an item's dependents.

DeleteGDIPlusImage

Deletes a GDI+ image object.

DependentCount

Returns an item's number of dependents.

Direct

Returns an ISftTreeVTable interface pointer.

DisplayColumn

Returns the display column number given a real column number.

DragImage

Defines whether a semi-transparent image is used to represent the data being dragged.

DragMethod

Defines how drag & drop is implemented.

DragType

Defines the method that determines when a drag & drop operation starts.

DropHighlight

Defines the index of the current drop target of a drag & drop operation.

DropHighlightColor

Defines the color used to display the drop target item of a drag & drop operation.

DropHighlightStyle

Defines the style used to display the drop target of a drag & drop operation.

EditColumn

Returns the column of the cell currently being edited.

EditIndex

Returns the index of the cell currently being edited.

EditNavigate

Positions cell editing on another cell.

Enabled

Defines whether the tree control responds to user-generated events.

EndEdit

Ends cell editing.

Expand

Expands an item so its dependents become visible.

FindItemData

Searches the Data property of items.

FindItemDataString

Searches the DataString property of items.

FindString

Searches items for a string.

FindStringExact

Searches items for a string using an exact match.

FirstDependent

Returns the index of an item's first dependent.

FirstDisplayColumn

Returns the index of the first displayed column.

FirstDisplayColumn2

Returns the index of the first displayed column in the right pane.

FirstSibling

Returns the index of an item's first sibling item.

FlybyHighlight

Defines whether items are underlined as the mouse cursor moves over an item.

Font

Defines the default font used to display cell text.

Footer

Returns a SftTreeFooter object for a given column.

Footers

Returns the SftTreeFooters object.

ForeColor

Defines the default text color used to draw items that are not selected.

ForeColorOdd

Defines the text color used to draw items in odd rows.

GDIPlusSupport

Returns whether GDI+ support is available.

GetCellColorSample

Defines the color sample displayed as an item's cell graphic.

GetCellEditSelection

Returns the position of the selection during cell editing.

GetCellPictureImage

Defines the graphic displayed as an item's cell graphic.

GetCellPicturePos

Returns the coordinates of a cell's graphic component.

GetCellPicturePosPix

Returns the coordinates of a cell's graphic component.

GetCellPos

Returns the coordinates of a cell.

GetCellPosPix

Returns the coordinates of a cell.

GetCellTextPos

Returns the coordinates of a cell's text component.

GetCellTextPosPix

Returns the coordinates of a cell's text component.

GetHeaderPos

Returns the coordinates of a column header.

GetHeaderPosPix

Returns the coordinates of a column header.

GetItemPictureImage

Defines the graphic displayed as an item's item graphic.

GetItemPos

Returns the coordinates of an item.

GetItemPosPix

Returns the coordinates of an item.

GetNextShown

Returns the index of the next visible item.

GetPrevShown

Returns the index of the previous visible item.

GetSplitterPos

Returns the coordinates of the splitter bar.

GetSplitterPosPix

Returns the coordinates of the splitter bar.

GrayedColor

Defines the text color used to draw items that are disabled.

GridHorizontalColor

Defines the color used to draw horizontal grid lines.

GridStyle

Defines the method used to paint grid lines.

GridVerticalColor

Defines the color used to draw vertical grid lines.

HandleReturn

Defines whether the control accepts and handles the RETURN key.

Header

Returns a SftTreeHeader object for a given column.

Headers

Returns the SftTreeHeaders object.

HilightColor

Defines the color used to draw the highlighted edge of items.

HitTest

Returns the index of the item found at given coordinates.

HitTestPix

Returns the index of the item found at given coordinates.

HorizontalExtent

Defines the current horizontal scrolling extent.

HorizontalExtent2

Defines the current horizontal scrolling extent in the right pane.

HorizontalOffset

Defines the current horizontal scrolling offset.

HorizontalOffset2

Defines the current horizontal scrolling offset in the right pane.

hWnd

Returns the tree control's window handle.

InheritBgColor

Defines whether the area left of the first cell inherits the cell's background color.

InsertItem

Inserts a new item.

IntegralHeight

Vertically resizes the tree control so visible items are displayed in their entirety.

Item

Returns a SftTreeItem object for a given item.

ItemData

Defines an item's application specific value.

ItemDataFloat

Defines an item's application specific floating point value.

ItemDataObject

Defines an item's application specific object.

ItemDataString

Defines an item's application specific string value.

ItemDataTag

Defines an application defined value associated with an item.

ItemEditFont

Defines the font used for cell editing.

ItemExpand

Defines whether an item is expanded or collapsed.

ItemExpandable

Defines whether an item is expandable.

ItemExpandAll

Defines an item and all its dependents as expanded or collapsed.

ItemHeight

Returns the height of one item in the tree control.

ItemHeight1

Returns the height of an item in the tree control.

ItemID

Returns the item ID of an item.

ItemIndex

Returns the item index given an item ID.

ItemLevel

Defines an item's level number.

ItemLines

Defines the number of text lines used for item height calculation.

ItemPicture

Defines the graphic displayed as the item's item graphic.

ItemPictureAlign

Defines whether item graphics are aligned with higher level cells.

ItemPictureExpandable

Defines the default graphic used to display an expandable item's item graphic.

ItemPictureExpandableH

Defines the default graphic used to display an expandable item's item graphic.

ItemPictureExpanded

Defines the default graphic used to display an expanded item's item graphic.

ItemPictureExpandedH

Defines the default graphic used to display an expanded item's item graphic.

ItemPictureH

Defines the graphic displayed as the item's item graphic.

ItemPictureLeaf

Defines the default graphic used to display a leaf item's item graphic.

ItemPictureLeafH

Defines the default graphic used to display a leaf item's item graphic.

Items

Returns the SftTreeItems object.

ItemShown

Defines whether an item is shown.

ItemsShown

Returns the number of completely and partially visible items in the client area.

ItemsShownComplete

Returns the number of completely visible items in the client area.

ItemStatus

Defines an item's enabled/disabled status.

ItemStyle

Defines the item style.

LabelPicture

Defines the graphic displayed as an item's label graphic.

LabelPictureH

Defines the graphic displayed as an item's label graphic.

LastDependent

Returns the index of an item's last dependent.

LastDisplayColumn

Returns the index of the last displayed column.

LastDisplayColumn2

Returns the index of the last displayed column in the right pane.

LastSibling

Returns the index of an item's last sibling item.

LeftButtonOnly

Defines whether the tree control responds only to the left mouse button.

LeftItemClickOnly

Defines whether the tree control generates Item(Dbl)Click events only in response to the left mouse button.

LeftWindow

Returns the window handle of the left pane in a split tree control.

License

Returns the product's license number.

List

Defines an item's cell text.

ListCount

Returns the number of items in the tree control.

ListIndex

Defines the current item (caret location).

ListSelection

Returns the selected item.

ListSelection1

Returns the selected item.

Load

Loads the control contents.

LoadGDIPlusImage

Loads a GDI+ image from a file.

LoadGDIPlusImageFromResource

Loads a GDI+ image from a resource.

LoadPicture

Loads a picture from a file/URL.

MakeCellVisible

Horizontally and vertically scrolls the specified cell into view so it is displayed in the tree control's client area.

MakeColumnOptimal

Sets the optimal column width so that the text and graphics of all items can be displayed.

MakeColumnVisible

Horizontally scrolls the specified column into view so it is displayed in the tree control's client area.

MakeIntegralHeight

Vertically resizes the tree control so visible items are displayed in their entirety.

MakeIntegralHeightPix

Vertically resizes the tree control so visible items are displayed in their entirety.

MakeRowHeaderOptimal

Sets the optimal row header width so that the text and graphics of all row headers can be displayed.

MakeRowVisible

Vertically scrolls the specified item into view so it is displayed in the tree control's client area.

MakeSplitterOptimal

Positions the splitter bar optimally.

MouseIcon

Defines a custom mouse icon.

MouseIconH

Defines a custom mouse icon.

MouseOverTransitionEffect

Defines the transition effects used when the mouse enters/leaves the tree control.

MousePointer

Defines the mouse pointer used.

MoveColumn

Moves a column to a new position.

MoveItem

Moves an item to a new position in the tree control.

MoveItems

Moves items to a new position in the tree control.

MultilineHeader

Defines whether column header titles can consist of multiple text lines.

MultiSelect

Defines whether one or multiple items can be selected at a time.

NextSibling

Returns the index of an item's next sibling item.

NoFocusStyle

Defines the display style of selected items when the tree control does not have the input focus.

NoSelection

Defines whether the selection changes when the caret location changes.

OLEDrag

Initiates an OLE drag & drop operation.

OLEDropMode

Defines whether the tree control can act as an OLE drop target.

OpenEnded

Defines whether the last column is open-ended.

OpenEnded2

Defines whether the last column is open-ended in the right pane.

OverheadWidth

Returns the width of the area added to the first column for hierarchical graphics components.

Parent

Returns the index of an item's parent item.

PlusMinusPictureExpandable

Defines the graphic used to display an expandable item's plus/minus graphic.

PlusMinusPictureExpandableH

Defines the graphic used to display an expandable item's plus/minus graphic.

PlusMinusPictureExpanded

Defines the graphic used to display an expanded item's plus/minus graphic.

PlusMinusPictureExpandedH

Defines the graphic used to display an expanded item's plus/minus graphic.

PlusMinusPictureLeaf

Defines the graphic used to display a leaf item's plus/minus graphic.

PlusMinusPictureLeafH

Defines the graphic used to display a leaf item's plus/minus graphic.

PrevSibling

Returns the index of an item's previous sibling item.

RealColumn

Returns the real column number given a display column number.

RecalcHorizontalExtent

Recalculates the optimal horizontal scrolling extent.

Refresh

Forces an immediate repaint of the tree control.

RemoveItem

Removes an item.

ReorderColumns

Defines whether columns can be reordered using column drag & drop.

ResizeColumn

Returns the column number currently being resized.

ResizeHeader

Defines whether column headers can be resized by the user.

RightToLeft

Defines the display direction and visual appearance on a bi-directional system.

RightWindow

Returns the window handle of the right pane in a split tree control.

RowBackColor

Defines the row header background color used to draw the item when it is not selected.

RowColButtonDown

Defines whether the row/column button is currently down (pressed).

RowColButtonRemainUp

Defines whether the row/column button will return to its "up" position when pressed.

RowColHeaderAppearance

Defines the row/column header's appearance.

RowColHeaderBackColor

Defines the row/column header's background color.

RowColHeaderEnabled

Defines whether the row/column header is enabled.

RowColHeaderForeColor

Defines the row/column header's text color.

RowColHeaderGrayedColor

Defines the text color used to draw a disabled row/column header.

RowColHeaderHilightColor

Defines the color used to draw the highlighted edge of the row/column header.

RowColHeaderShadowColor

Defines the color used to draw the dark edge of the row/column header.

RowColPicture

Defines the graphic displayed in the row/column header.

RowColPictureAlign

Defines the position of the graphic displayed in the row/column header.

RowColPictureH

Defines the graphic displayed in the row/column header.

RowColText

Defines the text displayed in the row/column header.

RowColTextStyle

Defines the style used to display the row/column header text.

RowColumnFooter

Returns the SftTreeRowColumnFooter object.

RowColumnHeader

Returns the SftTreeRowColumnHeader object.

RowForeColor

Defines the row header text color used to draw the item when it is not selected.

RowHeaderAppearance

Defines the row header appearance.

RowHeaderBackColor

Defines the default background color used to draw row headers of items that are not selected.

RowHeaderButtonRemainUp

Defines whether row header buttons will return to their "up" position when pressed.

RowHeaderEnabled

Defines whether row headers are enabled.

RowHeaderFont

Defines the row header font.

RowHeaderForeColor

Defines the default text color used to draw row headers of items that are not selected.

RowHeaderGrayedColor

Defines the text color used to draw disabled row headers.

RowHeaderHilightColor

Defines the default color used to draw the highlighted edge of row headers.

RowHeaderLines

Defines the number of row header text lines used for height calculation.

RowHeaders

Returns the SftTreeRowHeaders object.

RowHeaderSelectBackColor

Defines the default row header background color used to draw items that are selected.

RowHeaderSelectForeColor

Defines the default row header text color used to draw items that are selected.

RowHeaderShadowColor

Defines the default color used to draw the dark edge of row headers.

RowHeaderTextStyle

Defines the default alignment for row header text.

RowHeaderWidth

Defines the width of the row header area.

RowPicture

Defines the graphic displayed in an item's row header.

RowPictureAlign

Defines the position of the graphic displayed in an item's row header.

RowPictureH

Defines the graphic displayed in an item's row header.

RowSelectBackColor

Defines the row header background color used to draw the item when it is selected.

RowSelectForeColor

Defines the row header text color used to draw the item when it is selected.

RowText

Defines an item's row header text.

RowTextAlign

Defines the position of the text displayed in an item's row header.

Save

Saves the control contents.

Scrollbars

Defines the presence of horizontal and vertical scroll bars.

ScrollbarStyle

Defines the appearance of the scroll bars.

ScrollTips

Defines whether ScrollTips are shown.

SelCount

Returns the number of currently selected items.

SelectBackColor

Defines the background color used to draw selected items.

SelectBackColorNoFocus

Defines the background color used to draw selected items when the control doesn't have the input focus.

Selected

Defines whether an item is selected.

SelectForeColor

Defines the text color used to draw selected items.

SelectForeColorNoFocus

Defines the text color used to draw selected items when the control doesn't have the input focus.

SelectionArea

Defines the area where selection changes occur.

SelectionGroupEnd

Returns the index of the last selected item in a group of selected items.

SelectionGroups

Returns the number of groups of selected items.

SelectionGroupStart

Returns the index of the first selected item in a group of selected items.

SelectRange

Selects or deselects a range of items.

SelectStyle

Defines the display style of selected items when the tree control has the input focus.

SetCellColorSample

Defines the color sample displayed as an item's cell graphic.

SetCellEditSelection

Sets the position of the selection during cell editing.

SetCellPictureImage

Defines the graphic displayed as an item's cell graphic.

SetItemPictureImage

Defines the graphic displayed as an item's item graphic.

ShadowColor

Defines the color used to draw the dark edge of items.

ShowFocusRectangle

Defines whether the focus rectangle is displayed.

ShowTruncated

Defines whether text is clipped or truncated using trailing '...'.

SmoothScroll

Defines whether items are scrolled pixel by pixel (for small scrolling increments only).

SortDependents

Sorts an item's dependents.

SplitColumn

Defines the number of columns displayed in the left pane of a split tree control.

Splitter

Returns the SftTreeSplitter object.

SplitterBar

Defines whether a vertical splitter bar is present.

SplitterOffset

Defines the horizontal offset of the splitter bar in a split tree control.

SplitterResizeMode

Allows the user to resize the panes of a split tree control using the keyboard.

SplitterWidth

Defines the width of the splitter bar.

StartCombo

Starts editing the specified cell using a combo box.

StartComboEdit

Starts editing the specified cell using a combo box with edit capability.

StartEdit

Starts editing the specified cell using an edit control.

ToolTipAlways

Defines whether ToolTips are shown, even if cell text is completely visible.

ToolTipBackColor

Defines the background color used to draw ToolTips and ScrollTips.

ToolTipForeColor

Defines the text color used to draw ToolTips and ScrollTips.

ToolTipIntervalOff

Defines the delay (in milliseconds) after which ToolTips are removed.

ToolTipIntervalOn

Defines the delay (in milliseconds) after which ToolTips are displayed.

ToolTipsUseEntireCell

Defines whether ToolTips use the entire cell.

TopIndex

Defines the index of the first item displayed in the tree control's client area.

TopParent

Returns the index of an item's top-most parent item.

TreeLineColor

Defines the color used to draw connecting tree lines when the tree control is enabled.

TreeLineGrayedColor

Defines the color used to draw connecting tree lines when the tree control is disabled.

TreeLineStyle

Defines the current tree line display style.

UseThemes

Defines whether Windows themes are used (Windows XP and up).

VAlignStyle

Defines the vertical alignment of tree lines, expand/collapse buttons, label, plus/minus and item graphics.

Version

Returns the product's exact version.

VirtualCount

Defines the number of items in the control in virtual mode.

VirtualImageSizes

Defines the maximum graphics sizes when using a virtual data source.

VirtualItemChanged

Notifies the control that one or all items of the virtual data source have changed.

VirtualMode

Defines whether the tree control is in virtual mode.

VirtualPictures

Defines the maximum graphics sizes when using a virtual data source.

WebLicense

Defines the license information for use on one web site.

Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.

See Also  Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com