# SftTree/OCX 8.0 — API Reference
> Complete A-Z reference for SftTree/OCX 8.0. The guide and feature documentation is in https://softelvdm.com/Vault/Softelvdm.com/llms/SftTree-OCX-8.0.txt
Online documentation: https://softelvdm.com/Documentation/SftTree%20OCX%208%200
## Objects
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/i_object_hierarchy*
All objects shown in this table are used with SftTree/OCX. These objects (and the respective interfaces) are used to access properties and methods exposed by each object. The [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree) represents the SftTree/OCX control. Through its properties, additional objects can be accessed.
 [](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeEvents)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject)
[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles)
| Object | Interface | Description |
| --- | --- | --- |
| SftTree | ISftTree | The SftTree/OCX control object. |
| - | ISftTreeVTable | The SftTree/OCX control object (used with the [Direct](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Direct) property). |
| SftTree Events | - | Events generated by a SftTree object |
| SftTreeColumns | ISftTreeColumns | Describes attributes that apply to all columns. Can be retrieved using the [SftTree.Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) property. |
| SftTreeHeaders | ISftTreeHeaders | Describes attributes that apply to all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). Can be retrieved using the [SftTree.Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers) property. |
| SftTreeFooters | ISftTreeFooters | Describes attributes that apply to all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters). Can be retrieved using the [SftTree.Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers) property. |
| SftTreeItems | ISftTreeItems | Describes attributes that apply to all items. Can be retrieved using the [SftTree.Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) property. |
| SftTreeRowColumnHeader | ISftTreeRowColumnHeader | Describes attributes that apply to the row/column header. Can be retrieved using the [SftTree.RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader) property. |
| SftTreeRowColumnFooter | ISftTreeRowColumnFooter | Describes attributes that apply to the row/column footer. Can be retrieved using the [SftTree.RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter) property. |
| SftTreeRowHeaders | ISftTreeRowHeaders | Describes attributes that apply to all [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders). Can be retrieved using the [SftTree.RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders) property. |
| SftTreeSplitter | ISftTreeSplitter | Describes attributes of the vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar). Can be retrieved using the [SftTree.Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter) property. |
| SftTreeColumn | ISftTreeColumn | Describes attributes of a specific column. Can be retrieved using the [SftTree.Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column) property. |
| SftTreeHeader | ISftTreeHeader | Describes attributes of a specific column header. Can be retrieved using the [SftTree.Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) property. |
| SftTreeFooter | ISftTreeFooter | Describes attributes of a specific column footer. Can be retrieved using the SftTree.Header property. |
| SftTreeItem | ISftTreeItem | Describes the attributes of a specific item. Can be retrieved using the [SftTree.Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item) property. |
| SftTreeCell | ISftTreeCell | Describes the attributes of a specific [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). Can be retrieved using the [SftTree.Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell) property. |
| SftTreeRowHeader | ISftTreeRowHeader | Describes the attributes of a specific item's row header. Can be retrieved using the Item.[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader) property. |
| VirtualItem | IVirtItem | The VirtualItem object is used during the [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) event to provide item attributes. The event is called for each item, so the application can provide all necessary information for a particular item using the VirtualItem object's properties. |
| SftPictureObject | ISftPictureObject | Describes a graphic consisting of a bitmap, icon, metafile, [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image, ImageList, built-in image or color sample. |
| DataObject | IVDMDataObject | Used to specify formats and data during [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operations. |
| DataObjectFiles | IVDMDataObjectFiles | A collection of filenames used by the DataObject object ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only). |
## DataObject Object (IVDMDataObject Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject*
The DataObject object is used to define data formats and data during an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
| Property/Method | Description |
| --- | --- |
| [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear) | Clears all data and formats in a [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object. |
| [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) | Returns a collection of filenames used by the [sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format. |
| [GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) | Retrieves data of a specified format from a DataObject object. |
| [GetFormat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetFormat) | Determines if a specified clipboard format is supported by the DataObject object. |
| [SetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData) | Adds a supported format and possibly its data to a DataObject object. |
See Also Object Hierarchy
## DataObjectFiles Object (IVDMDataObjectFiles Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles*
The DataObjectFiles object is used by a [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object to define file names during an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
| Property/Method | Description |
| --- | --- |
| [Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Add) | Adds a filename to the DataObject.[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only). |
| [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Clear) | Clears all filenames stored in the DataObject.Files collection (sftCFFiles format only). |
| [Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Count) | Returns the number of filenames in the DataObject.Files collection (sftCFFiles format only). |
| [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Item) | Returns a specific filename by index from the DataObject.Files collection (sftCFFiles format only). |
| [Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Remove) | Removes a filename from the DataObject.Files collection (sftCFFiles format only). |
See Also Object Hierarchy
## SftPictureObject Object (ISftPictureObject Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject*
The SftPictureObject object describes a graphic consisting of a bitmap, icon, metafile, ImageList, [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image, built-in image or color sample.
| Property/Method | Description |
| --- | --- |
| [ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) | Returns the actual height of the image. |
| [ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) | Returns the actual width of the image. |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Appearance) | Defines the image object using a built-in, special purpose image. |
| [BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle) | Defines the image object using a bitmap handle. |
| [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Clear) | Clears the image object. |
| [FrameColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_FrameColor) | Defines the border color of the color sample. |
| [GetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetColorSample) | Retrieves the picture object attributes defined as a color sample. |
| [GetImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImage) | Retrieves the picture object attributes defined as a GDI+ image. |
| [GetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageList) | Retrieves the picture object attributes defined as an ImageList image. |
| [GetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageListH) | Retrieves the picture object attributes defined as an ImageList image. |
| [Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) | Defines the desired image height. |
| [IconHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IconHandle) | Defines the image object using an icon handle. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image) | Defines the image object using a GDI+ image. |
| [IsEmpty](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IsEmpty) | Returns whether the image object is empty. |
| [LoadImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImage) | Loads an image from a file as a GDI+ image. |
| [LoadImageFromHBITMAP](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImageFromHBITMAP) | Loads an image from a bitmap handle as a GDI+ image. |
| [LoadImageFromResource](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImageFromResource) | Loads an image from a resource as a GDI+ image. |
| [NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) | Defines the image object using a .NET image object (IUnknown interface). |
| [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) | Defines the image object using an OLE Picture object (IPictureDisp interface). |
| [PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) | Defines the image object as an OLE Picture object (using a bitmap/icon handle). |
| [SampleColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SampleColor) | Defines the picture object as a color sample. |
| [SetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample) | Defines the picture object as a color sample. |
| [SetImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImage) | Defines the picture object attributes defined as a GDI+ image. |
| [SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) | Defines the picture object as an ImageList image. |
| [SetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageListH) | Defines the picture object as an ImageList image. |
| [Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) | Returns the defined image type. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) | Defines the desired image width. |
See Also Object Hierarchy
## SftTree Object (ISftTree Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree*
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](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree__FlatProperties) | Defines whether properties are stored as a flat list in a property bag. |
| [_Version](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree__Version) | Returns the product's exact version. |
| [AboutBox](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AboutBox) | Displays product, contact and copyright information. |
| [AddItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AddItem) | Adds a new item at the end of the list. |
| [Announce](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Announce) | Announces short status text to attached [screen readers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_accessibility). |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Appearance) | Defines the control's border look. |
| [AutoRespond](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AutoRespond) | Defines whether the tree control expands and collapses items automatically. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackColor) | Defines the default background color used to draw items that are not selected. |
| [BackColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackColorOdd) | Defines the background color used to draw items in odd rows. |
| [BackgroundPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture) | Defines the graphic displayed as the control's background. |
| [BackgroundPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPictureH) | Defines the graphic displayed as the control's background. |
| [BackgroundStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle) | Defines the scrolling style of the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap). |
| [BackgroundX](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundX) | Defines the origin (horizontally) of the background bitmap. |
| [BackgroundY](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundY) | Defines the origin (vertically) of the background bitmap. |
| [BorderStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BorderStyle) | Defines the tree control's border style used. |
| [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) | Defines bulk update mode. |
| [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) | Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) appearance. |
| [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) | Defines the expand/collapse button for a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item. |
| [ButtonCollapsedDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedDown) | Defines the expand/collapse button for a collapsed parent item when the expand/collapse button is pressed. |
| [ButtonCollapsedHot](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedHot) | Defines the expand/collapse button for a collapsed parent item when the mouse cursor is over the expand/collapse button. |
| [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) | Defines the expand/collapse button image for an expanded parent item. |
| [ButtonExpandedDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedDown) | Defines the expand/collapse button image for an expanded parent item when the expand/collapse button is pressed. |
| [ButtonExpandedHot](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedHot) | Defines the expand/collapse button image for an expanded parent item when the mouse cursor is over the expand/collapse button. |
| [ButtonPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPicture) | Defines the graphic used to display expand/collapse buttons. |
| [ButtonPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPictureH) | Defines the graphic used to display expand/collapse buttons. |
| [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle) | Defines the expand/collapse button display method. |
| [CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) | Returns the item index and column number for given coordinates. |
| [CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) | Returns the item index and column number for given coordinates. |
| [CalcColumnFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPos) | Returns the column number for given coordinates. |
| [CalcColumnFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPosPix) | Returns the column number for given coordinates. |
| [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) | Returns the item index for given coordinates. |
| [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) | Returns the item index for given coordinates. |
| [CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcLimit) | Defines the maximum number of items to consider for optimal column width and scrolling calculation. |
| [CalcOptimalColumnWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcOptimalColumnWidth) | Calculates a column's optimal width based on the column contents. |
| [CalcOptimalRowHeaderWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcOptimalRowHeaderWidth) | Calculates the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s optimal width based on the contents of all row headers. |
| [CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcVisibleOnly) | Defines whether only visible items are considered for optimal column width and scrolling calculation. |
| [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) | Cancels internal modes. |
| [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell) | Returns a [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object for a given item/column. |
| [Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell3D) | Defines whether [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are painted using a 3D effect. |
| [CellBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellBackColor) | Defines the background color used to draw an item's cell that is not selected. |
| [CellEditIntercept](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditIntercept) | Defines keystrokes to be intercepted during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) (using the [EditNavigating](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating) event). |
| [CellEditLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditLimit) | Defines the maximum number of characters in an edit control or combo box during cell editing. |
| [CellEditStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle) | Defines the cell editing display style. |
| [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) | Defines whether the application handles cell editing events. |
| [CellFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellFont) | Defines the font used to display an item's cell text. |
| [CellForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellForeColor) | Defines the text color used to draw an item's cell that is not selected. |
| [CellItemData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellItemData) | Defines a cell's application specific value. |
| [CellItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellItemDataString) | Defines a cell's application specific string value. |
| [CellPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPicture) | Defines the graphic displayed as an item's cell graphic. |
| [CellPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPictureAlign) | Defines the position of the graphic displayed in an item's cell. |
| [CellPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPictureH) | Defines the graphic displayed as an item's cell graphic. |
| [CellSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellSelectBackColor) | Defines the background color used to draw an item's cell that is selected. |
| [CellSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellSelectForeColor) | Defines the text color used to draw an item's cell that is selected. |
| [CellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellText) | Defines an item's cell text. |
| [CellTextAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellTextAlign) | Defines the position of the text displayed in an item's cell. |
| [CharSearchColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CharSearchColumn) | Defines the column searched for characters typed by the user. |
| [CharSearchMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CharSearchMode) | Defines the search mode for characters typed by the user. |
| [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Clear) | Removes all items. |
| [ClearCellPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearCellPictures) | Removes the cell graphics from all items. |
| [ClearItemPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearItemPictures) | Removes the item graphics from all items. |
| [ClearLabelPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearLabelPictures) | Removes the label graphics from all items. |
| [ClearRowHeaderPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearRowHeaderPictures) | Removes the row header graphics from all items. |
| [ColHeaderAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderAppearance) | Defines the appearance of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). |
| [ColHeaderBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderBackColor) | Defines the background color for all column headers. |
| [ColHeaderButton](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderButton) | Defines the currently pressed column header button. |
| [ColHeaderEnabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderEnabled) | Defines whether the specified column header is enabled. |
| [ColHeaderFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderFont) | Defines the font used for all column headers. |
| [ColHeaderForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderForeColor) | Defines the text color for all column headers. |
| [ColHeaderGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderGrayedColor) | Defines the text color used to draw all disabled column headers. |
| [ColHeaderHilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderHilightColor) | Defines the color used to draw the highlighted edge of all column headers. |
| [ColHeaderShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderShadowColor) | Defines the color used to draw the dark edge of all column headers. |
| [Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Collapse) | Collapses an item so its dependents are no longer visible. |
| [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column) | Returns a [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object for a given column. |
| [ColumnBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnBackColor) | Defines the background color of cells in the specified column. |
| [ColumnButtonRemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnButtonRemainUp) | Defines whether the specified column header button will return to its "up" position when pressed. |
| [ColumnForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnForeColor) | Defines the text color of cells in the specified column. |
| [ColumnMinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnMinWidth) | Defines the minimum width of the specified column. |
| [ColumnPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPicture) | Defines the graphic displayed in the specified column header. |
| [ColumnPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPictureAlign) | Defines the position of the graphic displayed in the specified column header. |
| [ColumnPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPictureH) | Defines the graphic displayed in a column header. |
| [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) | Defines the number of columns. |
| [ColumnSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnSelectBackColor) | Defines the background color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in the specified column. |
| [ColumnSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnSelectForeColor) | Defines the text color of selected items in the specified column. |
| [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj) | Returns the [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object. |
| [ColumnStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnStyle) | Defines the cell style in the specified column. |
| [ColumnText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnText) | Defines a column header's text. |
| [ColumnTextStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnTextStyle) | Defines a column header's text style. |
| [ColumnWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnWidth) | Defines the width of the specified column. |
| [CopyItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItem) | Copies an item to a new position in the tree control. |
| [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) | Defines whether the Item.DataString property is copied or moved with an item. |
| [CopyItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItems) | Copies items to a new position in the tree control. |
| [CrossColumnResize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CrossColumnResize) | Defines whether multiple columns can be resized in one resizing operation. |
| [CustomCode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CustomCode) | Defines optional product customization. |
| [DarkMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkMode) | Defines the [dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) setting (off, on, or following the Windows setting). |
| [DarkModeActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkModeActive) | Returns whether dark mode is currently active. |
| [DeleteDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteDependents) | Deletes an item's dependents. |
| [DeleteGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteGDIPlusImage) | Deletes a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image object. |
| [DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DependentCount) | Returns an item's number of dependents. |
| [Direct](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Direct) | Returns an ISftTreeVTable interface pointer. |
| [DisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DisplayColumn) | Returns the [display column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number given a real column number. |
| [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DPI) | Returns the effective [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi) for the control's current monitor. |
| [DragImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragImage) | Defines whether a semi-transparent image is used to represent the data being dragged. |
| [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) | Defines how [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) is implemented. |
| [DragType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragType) | Defines the method that determines when a drag & drop operation starts. |
| [DropHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlight) | Defines the index of the current [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) of a drag & drop operation. |
| [DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlightColor) | Defines the color used to display the drop target item of a drag & drop operation. |
| [DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlightStyle) | Defines the style used to display the drop target of a drag & drop operation. |
| [EditColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditColumn) | Returns the column of the cell currently being edited. |
| [EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex) | Returns the index of the cell currently being edited. |
| [EditNavigate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditNavigate) | Positions cell editing on another cell. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Enabled) | Defines whether the tree control responds to user-generated events. |
| [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit) | Ends cell editing. |
| [Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Expand) | Expands an item so its dependents become visible. |
| [FindItemData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindItemData) | Searches the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property of items. |
| [FindItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindItemDataString) | Searches the Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property of items. |
| [FindString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindString) | Searches items for a string. |
| [FindStringExact](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindStringExact) | Searches items for a string using an exact match. |
| [FirstDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDependent) | Returns the index of an item's first [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents). |
| [FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDisplayColumn) | Returns the index of the first displayed column. |
| [FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDisplayColumn2) | Returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar). |
| [FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstSibling) | Returns the index of an item's first sibling item. |
| [FlybyHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FlybyHighlight) | Defines whether items are underlined as the mouse cursor moves over an item. |
| [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) | Defines the default font used to display cell text. |
| [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) | Returns a [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object for a given column. |
| [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers) | Returns the [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ForeColor) | Defines the default text color used to draw items that are not selected. |
| [ForeColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ForeColorOdd) | Defines the text color used to draw items in odd rows. |
| [GDIPlusSupport](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GDIPlusSupport) | Returns whether GDI+ support is available. |
| [GetCellColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellColorSample) | Defines the color sample displayed as an item's cell graphic. |
| [GetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellEditSelection) | Returns the position of the selection during cell editing. |
| [GetCellPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPictureImage) | Defines the graphic displayed as an item's cell graphic. |
| [GetCellPicturePos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePos) | Returns the coordinates of a cell's graphic component. |
| [GetCellPicturePosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePosPix) | Returns the coordinates of a cell's graphic component. |
| [GetCellPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPos) | Returns the coordinates of a cell. |
| [GetCellPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPosPix) | Returns the coordinates of a cell. |
| [GetCellTextPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPos) | Returns the coordinates of a cell's text component. |
| [GetCellTextPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPosPix) | Returns the coordinates of a cell's text component. |
| [GetHeaderPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPos) | Returns the coordinates of a column header. |
| [GetHeaderPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPosPix) | Returns the coordinates of a column header. |
| [GetItemPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPictureImage) | Defines the graphic displayed as an item's item graphic. |
| [GetItemPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPos) | Returns the coordinates of an item. |
| [GetItemPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPosPix) | Returns the coordinates of an item. |
| [GetNextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetNextShown) | Returns the index of the next [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus). |
| [GetPrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetPrevShown) | Returns the index of the previous visible item. |
| [GetSplitterPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPos) | Returns the coordinates of the splitter bar. |
| [GetSplitterPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPosPix) | Returns the coordinates of the splitter bar. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GrayedColor) | Defines the text color used to draw items that are disabled. |
| [GridHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridHorizontalColor) | Defines the color used to draw horizontal grid lines. |
| [GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridStyle) | Defines the method used to paint grid lines. |
| [GridVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridVerticalColor) | Defines the color used to draw vertical grid lines. |
| [HandleReturn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HandleReturn) | Defines whether the control accepts and handles the RETURN key. |
| [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) | Returns a [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object for a given column. |
| [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers) | Returns the [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object. |
| [HighContrastActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastActive) | Returns whether [high contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) is currently active. |
| [HighContrastMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastMode) | Defines the high contrast setting (off, on, or following the Windows setting). |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HilightColor) | Defines the color used to draw the highlighted edge of items. |
| [HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTest) | Returns the index of the item found at given coordinates. |
| [HitTestPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTestPix) | Returns the index of the item found at given coordinates. |
| [HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalExtent) | Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent. |
| [HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalExtent2) | Defines the current horizontal scrolling extent in the right pane. |
| [HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalOffset) | Defines the current horizontal scrolling offset. |
| [HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalOffset2) | Defines the current horizontal scrolling offset in the right pane. |
| [hWnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_hWnd) | Returns the tree control's window handle. |
| [ImageScaling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ImageScaling) | Defines whether the control's images are scaled to the current DPI. |
| [InheritBgColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_InheritBgColor) | Defines whether the area left of the first cell inherits the cell's background color. |
| [InsertItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_InsertItem) | Inserts a new item. |
| [IntegralHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_IntegralHeight) | Vertically resizes the tree control so visible items are displayed in their entirety. |
| Item | Returns a [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object for a given item. |
| [ItemData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemData) | Defines an item's application specific value. |
| [ItemDataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataFloat) | Defines an item's application specific floating point value. |
| [ItemDataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataObject) | Defines an item's application specific object. |
| [ItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataString) | Defines an item's application specific string value. |
| [ItemDataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataTag) | Defines an application defined value associated with an item. |
| [ItemEditFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont) | Defines the font used for cell editing. |
| [ItemExpand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpand) | Defines whether an item is expanded or collapsed. |
| [ItemExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpandable) | Defines whether an item is expandable. |
| [ItemExpandAll](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpandAll) | Defines an item and all its dependents as expanded or collapsed. |
| [ItemHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight) | Returns the height of one item in the tree control. |
| [ItemHeight1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight1) | Returns the height of an item in the tree control. |
| [ItemID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemID) | Returns the [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids) of an item. |
| [ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemIndex) | Returns the item index given an item ID. |
| [ItemLevel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemLevel) | Defines an item's level number. |
| [ItemLines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemLines) | Defines the number of text lines used for item height calculation. |
| [ItemPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPicture) | Defines the graphic displayed as the item's item graphic. |
| [ItemPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureAlign) | Defines whether item graphics are aligned with higher level cells. |
| [ItemPictureExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandable) | Defines the default graphic used to display an expandable item's item graphic. |
| [ItemPictureExpandableH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandableH) | Defines the default graphic used to display an expandable item's item graphic. |
| [ItemPictureExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpanded) | Defines the default graphic used to display an expanded item's item graphic. |
| [ItemPictureExpandedH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandedH) | Defines the default graphic used to display an expanded item's item graphic. |
| [ItemPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureH) | Defines the graphic displayed as the item's item graphic. |
| [ItemPictureLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeaf) | Defines the default graphic used to display a leaf item's item graphic. |
| [ItemPictureLeafH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeafH) | Defines the default graphic used to display a leaf item's item graphic. |
| [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) | Returns the [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object. |
| [ItemShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemShown) | Defines whether an item is shown. |
| [ItemsShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemsShown) | Returns the number of completely and partially visible items in the client area. |
| [ItemsShownComplete](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemsShownComplete) | Returns the number of completely visible items in the client area. |
| [ItemStatus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemStatus) | Defines an item's enabled/disabled status. |
| [ItemStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemStyle) | Defines the item style. |
| [LabelPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPicture) | Defines the graphic displayed as an item's label graphic. |
| [LabelPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPictureH) | Defines the graphic displayed as an item's label graphic. |
| [LastDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDependent) | Returns the index of an item's last dependent. |
| [LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDisplayColumn) | Returns the index of the last displayed column. |
| [LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDisplayColumn2) | Returns the index of the last displayed column in the right pane. |
| [LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastSibling) | Returns the index of an item's last sibling item. |
| [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) | Defines whether the tree control responds only to the left mouse button. |
| [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) | Defines whether the tree control generates Item(Dbl)[Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click) events only in response to the left mouse button. |
| [LeftWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftWindow) | Returns the window handle of the left pane in a split tree control. |
| [License](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_License) | Returns the product's license number. |
| [List](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_List) | Defines an item's cell text. |
| [ListCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListCount) | Returns the number of items in the tree control. |
| [ListIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListIndex) | Defines the current item (caret location). |
| [ListSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListSelection) | Returns the selected item. |
| [ListSelection1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListSelection1) | Returns the selected item. |
| [Load](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Load) | Loads the control contents. |
| [LoadGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImage) | Loads a GDI+ image from a file. |
| [LoadGDIPlusImageFromResource](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImageFromResource) | Loads a GDI+ image from a resource. |
| [LoadPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadPicture) | Loads a picture from a file/URL. |
| [MakeCellVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeCellVisible) | Horizontally and vertically scrolls the specified cell into view so it is displayed in the tree control's client area. |
| [MakeColumnOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeColumnOptimal) | Sets the optimal column width so that the text and graphics of all items can be displayed. |
| [MakeColumnVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeColumnVisible) | Horizontally scrolls the specified column into view so it is displayed in the tree control's client area. |
| [MakeIntegralHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeight) | Vertically resizes the tree control so visible items are displayed in their entirety. |
| [MakeIntegralHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeightPix) | Vertically resizes the tree control so visible items are displayed in their entirety. |
| [MakeRowHeaderOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeRowHeaderOptimal) | Sets the optimal row header width so that the text and graphics of all row headers can be displayed. |
| [MakeRowVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeRowVisible) | Vertically scrolls the specified item into view so it is displayed in the tree control's client area. |
| [MakeSplitterOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeSplitterOptimal) | Positions the splitter bar optimally. |
| [MouseIcon](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIcon) | Defines a custom mouse icon. |
| [MouseIconH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIconH) | Defines a custom mouse icon. |
| [MouseOverTransitionEffect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseOverTransitionEffect) | Defines the transition effects used when the mouse enters/leaves the tree control. |
| [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) | Defines the mouse pointer used. |
| [MoveColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveColumn) | Moves a column to a new position. |
| [MoveItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItem) | Moves an item to a new position in the tree control. |
| [MoveItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItems) | Moves items to a new position in the tree control. |
| [MultilineHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MultilineHeader) | Defines whether column header titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline). |
| [MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MultiSelect) | Defines whether one or multiple items can be selected at a time. |
| [NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NextSibling) | Returns the index of an item's next sibling item. |
| [NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NoFocusStyle) | Defines the display style of selected items when the tree control does not have the input focus. |
| [NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NoSelection) | Defines whether the selection changes when the caret location changes. |
| [OLEDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDrag) | Initiates an OLE drag & drop operation. |
| [OLEDropMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDropMode) | Defines whether the tree control can act as an OLE drop target. |
| [OpenEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OpenEnded) | Defines whether the last column is [open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded). |
| [OpenEnded2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OpenEnded2) | Defines whether the last column is open-ended in the right pane. |
| [OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OverheadWidth) | Returns the width of the area added to the first column for hierarchical graphics components. |
| [Parent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Parent) | Returns the index of an item's parent item. |
| [PixelScaling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PixelScaling) | Defines whether caller-supplied pixel dimensions are scaled to the current DPI. |
| [PlusMinusPictureExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandable) | Defines the graphic used to display an expandable item's plus/minus graphic. |
| [PlusMinusPictureExpandableH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandableH) | Defines the graphic used to display an expandable item's plus/minus graphic. |
| [PlusMinusPictureExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpanded) | Defines the graphic used to display an expanded item's plus/minus graphic. |
| [PlusMinusPictureExpandedH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandedH) | Defines the graphic used to display an expanded item's plus/minus graphic. |
| [PlusMinusPictureLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeaf) | Defines the graphic used to display a leaf item's plus/minus graphic. |
| [PlusMinusPictureLeafH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeafH) | Defines the graphic used to display a leaf item's plus/minus graphic. |
| [PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PrevSibling) | Returns the index of an item's previous sibling item. |
| [RealColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RealColumn) | Returns the real column number given a display column number. |
| [RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RecalcHorizontalExtent) | Recalculates the optimal horizontal scrolling extent. |
| [Refresh](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Refresh) | Forces an immediate repaint of the tree control. |
| [RemoveItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RemoveItem) | Removes an item. |
| [ReorderColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ReorderColumns) | Defines whether columns can be reordered using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop). |
| [ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ResizeColumn) | Returns the column number currently being resized. |
| [ResizeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ResizeHeader) | Defines whether column headers can be resized by the user. |
| [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) | Defines the display direction and visual appearance on a [bi-directional](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rtl) system. |
| [RightWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightWindow) | Returns the window handle of the right pane in a split tree control. |
| [RowBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowBackColor) | Defines the row header background color used to draw the item when it is not selected. |
| [RowColButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColButtonDown) | Defines whether the row/column button is currently down (pressed). |
| [RowColButtonRemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColButtonRemainUp) | Defines whether the row/column button will return to its "up" position when pressed. |
| [RowColHeaderAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderAppearance) | Defines the row/column header's appearance. |
| [RowColHeaderBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderBackColor) | Defines the row/column header's background color. |
| [RowColHeaderEnabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderEnabled) | Defines whether the row/column header is enabled. |
| [RowColHeaderForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderForeColor) | Defines the row/column header's text color. |
| [RowColHeaderGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderGrayedColor) | Defines the text color used to draw a disabled row/column header. |
| [RowColHeaderHilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderHilightColor) | Defines the color used to draw the highlighted edge of the row/column header. |
| [RowColHeaderShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderShadowColor) | Defines the color used to draw the dark edge of the row/column header. |
| [RowColPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPicture) | Defines the graphic displayed in the row/column header. |
| [RowColPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPictureAlign) | Defines the position of the graphic displayed in the row/column header. |
| [RowColPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPictureH) | Defines the graphic displayed in the row/column header. |
| [RowColText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColText) | Defines the text displayed in the row/column header. |
| [RowColTextStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColTextStyle) | Defines the style used to display the row/column header text. |
| [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter) | Returns the [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object. |
| [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader) | Returns the [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object. |
| [RowForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowForeColor) | Defines the row header text color used to draw the item when it is not selected. |
| [RowHeaderAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderAppearance) | Defines the row header appearance. |
| [RowHeaderBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderBackColor) | Defines the default background color used to draw row headers of items that are not selected. |
| [RowHeaderButtonRemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderButtonRemainUp) | Defines whether row header buttons will return to their "up" position when pressed. |
| [RowHeaderEnabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderEnabled) | Defines whether row headers are enabled. |
| [RowHeaderFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderFont) | Defines the row header font. |
| [RowHeaderForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderForeColor) | Defines the default text color used to draw row headers of items that are not selected. |
| [RowHeaderGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderGrayedColor) | Defines the text color used to draw disabled row headers. |
| [RowHeaderHilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderHilightColor) | Defines the default color used to draw the highlighted edge of row headers. |
| [RowHeaderLines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderLines) | Defines the number of row header text lines used for height calculation. |
| [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders) | Returns the [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object. |
| [RowHeaderSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderSelectBackColor) | Defines the default row header background color used to draw items that are selected. |
| [RowHeaderSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderSelectForeColor) | Defines the default row header text color used to draw items that are selected. |
| [RowHeaderShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderShadowColor) | Defines the default color used to draw the dark edge of row headers. |
| [RowHeaderTextStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderTextStyle) | Defines the default alignment for row header text. |
| [RowHeaderWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderWidth) | Defines the width of the row header area. |
| [RowPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPicture) | Defines the graphic displayed in an item's row header. |
| [RowPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPictureAlign) | Defines the position of the graphic displayed in an item's row header. |
| [RowPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPictureH) | Defines the graphic displayed in an item's row header. |
| [RowSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowSelectBackColor) | Defines the row header background color used to draw the item when it is selected. |
| [RowSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowSelectForeColor) | Defines the row header text color used to draw the item when it is selected. |
| [RowText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowText) | Defines an item's row header text. |
| [RowTextAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowTextAlign) | Defines the position of the text displayed in an item's row header. |
| [Save](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Save) | Saves the control contents. |
| [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) | Defines the presence of horizontal and vertical scroll bars. |
| [ScrollbarStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ScrollbarStyle) | Defines the appearance of the scroll bars. |
| [ScrollTips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ScrollTips) | Defines whether [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) are shown. |
| [SelCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelCount) | Returns the number of currently selected items. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectBackColor) | Defines the background color used to draw selected items. |
| [SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectBackColorNoFocus) | Defines the background color used to draw selected items when the control doesn't have the input focus. |
| [Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Selected) | Defines whether an item is selected. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectForeColor) | Defines the text color used to draw selected items. |
| [SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectForeColorNoFocus) | Defines the text color used to draw selected items when the control doesn't have the input focus. |
| [SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionArea) | Defines the area where selection changes occur. |
| [SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroupEnd) | Returns the index of the last selected item in a group of selected items. |
| [SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroups) | Returns the number of groups of selected items. |
| [SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroupStart) | Returns the index of the first selected item in a group of selected items. |
| [SelectRange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectRange) | Selects or deselects a range of items. |
| [SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectStyle) | Defines the display style of selected items when the tree control has the input focus. |
| [SetCellColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellColorSample) | Defines the color sample displayed as an item's cell graphic. |
| [SetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellEditSelection) | Sets the position of the selection during cell editing. |
| [SetCellPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellPictureImage) | Defines the graphic displayed as an item's cell graphic. |
| [SetItemPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetItemPictureImage) | Defines the graphic displayed as an item's item graphic. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShadowColor) | Defines the color used to draw the dark edge of items. |
| [ShowFocusRectangle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShowFocusRectangle) | Defines whether the focus rectangle is displayed. |
| [ShowTruncated](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShowTruncated) | Defines whether text is clipped or truncated using trailing '...'. |
| [SizeBox](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBox) | Defines whether a size box (resize grip) is shown so the user can resize the control. |
| [SizeBoxActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBoxActive) | Returns whether the user is currently resizing the control using the size box. |
| [SmoothScroll](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SmoothScroll) | Defines whether items are scrolled pixel by pixel (for small scrolling increments only). |
| [SortDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SortDependents) | Sorts an item's dependents. |
| [SplitColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitColumn) | Defines the number of columns displayed in the left pane of a split tree control. |
| [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter) | Returns the [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object. |
| [SplitterBar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterBar) | Defines whether a vertical splitter bar is present. |
| [SplitterOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterOffset) | Defines the horizontal offset of the splitter bar in a split tree control. |
| [SplitterResizeMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterResizeMode) | Allows the user to resize the panes of a split tree control using the keyboard. |
| [SplitterWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterWidth) | Defines the width of the splitter bar. |
| [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) | Starts editing the specified cell using a combo box. |
| [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) | Starts editing the specified cell using a combo box with edit capability. |
| [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit) | Starts editing the specified cell using an edit control. |
| [ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipAlways) | Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are shown, even if cell text is completely visible. |
| [ToolTipBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipBackColor) | Defines the background color used to draw Tool Tips and Scroll Tips. |
| [ToolTipForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipForeColor) | Defines the text color used to draw Tool Tips and Scroll Tips. |
| [ToolTipIntervalOff](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipIntervalOff) | Defines the delay (in milliseconds) after which Tool Tips are removed. |
| [ToolTipIntervalOn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipIntervalOn) | Defines the delay (in milliseconds) after which Tool Tips are displayed. |
| [ToolTipsUseEntireCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipsUseEntireCell) | Defines whether ToolTips use the entire cell. |
| [TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TopIndex) | Defines the index of the first item displayed in the tree control's client area. |
| [TopParent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TopParent) | Returns the index of an item's top-most parent item. |
| [TreeLineColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineColor) | Defines the color used to draw connecting tree lines when the tree control is enabled. |
| [TreeLineGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineGrayedColor) | Defines the color used to draw connecting tree lines when the tree control is disabled. |
| [TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineStyle) | Defines the current tree line display style. |
| [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) | Defines whether [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. |
| [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) | Defines the vertical alignment of tree lines, expand/collapse buttons, label, plus/minus and item graphics. |
| [Version](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Version) | Returns the product's exact version. |
| [VirtualCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualCount) | Defines the number of items in the control in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode). |
| [VirtualImageSizes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualImageSizes) | Defines the maximum graphics sizes when using a [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource). |
| [VirtualItemChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualItemChanged) | Notifies the control that one or all items of the virtual data source have changed. |
| [VirtualMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualMode) | Defines whether the tree control is in virtual mode. |
| [VirtualPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualPictures) | Defines the maximum graphics sizes when using a virtual data source. |
| [WebLicense](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_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
## SftTreeCell Object (ISftTreeCell Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell*
The SftTreeCell object represents one [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in a SftTree/OCX control. A SftTreeCell object for a particular cell can be accessed through the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell) property or through an item's [Item.Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell) property. An item is defined by the [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) Object. Certain default properties and behavior for cells can be defined using the [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) Object.
| Property/Method | Description |
| --- | --- |
| [AttachContentWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_AttachContentWindow) | Attaches a [content window](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contentwindows) to the cell. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) | Defines the cell's background color. |
| [BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd) | Defines the cell's background color, combined with BackColor creating a gradient fill. |
| [BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) | Defines the cell's background gradient fill orientation. |
| [ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ColumnIndex) | Returns the column index of this cell. |
| [Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) | Defines the cell's application specific numeric value. |
| [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject) | Defines the cell's application specific object value. |
| [DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) | Defines the cell's application specific string value. |
| [DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) | Defines the cell's application specific variant value. |
| [Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) | Edits the cell. |
| [EditIgnore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_EditIgnore) | Defines whether the cell is ignored for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting). |
| [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) | Defines the font used for this cell. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) | Defines the cell's foreground color. |
| [GetContentWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetContentWindow) | Retrieves the content window attached to the cell. |
| [GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) | Returns the coordinates of the cell image. |
| [GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) | Returns the coordinates of the cell image. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) | Returns the coordinates of the cell. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) | Returns the coordinates of the cell. |
| [GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) | Returns the coordinates of the cell text. |
| [GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) | Returns the coordinates of the cell text. |
| [Ignore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Ignore) | Defines whether the cell is ignored for optimal column width and extent calculation. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) | Defines the graphic displayed in this cell. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) | Defines the horizontal alignment of the graphic in this cell. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) | Defines the vertical alignment of the graphic in this cell. |
| [ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ItemIndex) | Returns the item index of this cell. |
| [MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) | Horizontally and vertically scrolls the cell into view so it is displayed in the tree control's client area. |
| [ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) | Defines the [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for this cell. |
| [ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) | Defines the progress bar color used for this cell, combined with ProgressColor creating a gradient fill. |
| [ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) | Defines the progress bar's gradient fill orientation. |
| [ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) | Defines the cell's progress bar maximum value (0 to turn off). |
| [ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressStyle) | Defines the progress bar's appearance. |
| [ProgressValue](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressValue) | Defines the cell's progress bar value. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) | Defines the cell's background color when the item is selected. |
| [SelectBackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColorEnd) | Defines the cell's background color when the item is selected, combined with SelectBackColor creating a gradient fill. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) | Defines the cell's foreground color when the item is selected. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) | Defines the cell's text. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) | Defines the horizontal alignment of the text in this cell. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) | Defines the vertical alignment of the text in this cell. |
See Also Object Hierarchy
## SftTreeColumn Object (ISftTreeColumn Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn*
The SftTreeColumn object represents one column in a SftTree/OCX control. A SftTreeColumn object for a particular column can be accessed through the control's [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column) property. Certain default properties and behavior for all columns can be defined using the [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
| Property/Method | Description |
| --- | --- |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) | Defines the background color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column. |
| [BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorEnd) | Defines the default background color of cells in this column, combined with BackColor creating a gradient fill. |
| [BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorOrientation) | Defines the default background gradient fill orientation of cells in this column. |
| [CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) | Defines the default horizontal alignment of cell contents in this column. |
| [CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) | Defines whether multi-line text is allowed in cells in this column. |
| [CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) | Defines the default vertical alignment of cell contents in this column. |
| [CellWordWrap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap) | Defines whether the cell text may word-wrap within the available space in this column. |
| [DisplayPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_DisplayPosition) | Returns the display position of this column. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) | Defines the text color of cells in this column. |
| [Index](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Index) | Returns the [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number of this column. |
| [MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) | Sets the column's optimal width so that the text and graphics of all items can be displayed without being clipped horizontally. |
| [MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) | Horizontally scrolls the column into view so it is displayed in the tree control's client area. |
| [Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) | Defines whether the contents of this column can merge into the next displayed column. |
| [MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) | Defines whether the contents of the previous column can merge into this column. |
| [MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) | Defines the minimum width of this column. |
| [MinWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidthPix) | Defines the minimum width of this column. |
| [OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) | Returns the column's optimal width based on its contents. |
| [OptimalWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidthPix) | Returns the column's optimal width based on its contents. |
| [ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColor) | Defines the default [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for cells in this column. |
| [ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorEnd) | Defines the default progress bar color used for this cell in this column, combined with ProgressColor creating a gradient fill. |
| [ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorOrientation) | Defines the default gradient fill orientation for progress bars in this column. |
| [ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressStyle) | Defines the default progress bar appearance for cells in this column. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) | Defines the background color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in this column. |
| [SelectBackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColorEnd) | Defines the background color of selected items in this column, combined with SelectBackColor creating a gradient fill. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) | Defines the text color of selected items in this column. |
| [ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip) | Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are used for cells in this column. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) | Defines the width of this column. |
| [WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_WidthPix) | Defines the width of this column. |
See Also Object Hierarchy
## SftTreeColumns Object (ISftTreeColumns Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns*
The SftTreeColumns object describes attributes that apply to all columns in a SftTree/OCX control. The SftTreeColumns object can be accessed through the control's [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) property. A control has only one SftTreeColumns object. An individual column's [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object can be accessed through the control's [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column) property.
| Property/Method | Description |
| --- | --- |
| [ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) | Returns the [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number given a display position of a column. |
| [Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) | Defines the number of columns. |
| [DisplayPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_DisplayPosition) | Returns the display position given a real column number. |
| [FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) | Returns the index of the first displayed column. |
| [FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) | Returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar). |
| [InheritBgColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_InheritBgColor) | Defines whether the area left of the first [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) inherits the cell's background color. |
| [LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) | Returns the index of the last displayed column. |
| [LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) | Returns the index of the last displayed column in the right pane. |
| [MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) | Sets the optimal column width of all columns so that the text and graphics of all items can be displayed without being clipped horizontally. |
| [Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) | Moves a column to a new position. |
| [OpenEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) | Defines whether the last column is open-ended. |
| [OpenEnded2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded2) | Defines whether the last column is open-ended in the right pane. |
| [Order](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Order) | Defines the column order, usually used to save/load an existing column layout. |
| [OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) | Returns the width of the area added to the first column for hierarchical graphics components. |
| [OverheadWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidthPix) | Returns the width of the area added to the first column for hierarchical graphics components. |
| [Widths](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Widths) | Defines the widths of all columns, usually used to save/load an existing column layout. |
See Also Object Hierarchy
## SftTreeFooter Object (ISftTreeFooter Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter*
The SftTreeFooter object represents one [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. A SftTreeFooter object for a particular column can be accessed through the control's [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) property. Certain default properties and behavior for column footers can be defined using the [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
| Property/Method | Description |
| --- | --- |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor) | Defines the background color for this column footer. |
| [BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColorDisabled) | Defines the background color for this column footer, when it is disabled. |
| [Button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Button) | Defines the column footer's button appearance. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled) | Defines whether the column footer is enabled. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor) | Defines the foreground color for this column footer. |
| [ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColorDisabled) | Defines the foreground color for this column footer, when it is disabled. |
| [GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPosition) | Returns the coordinates of the footer button area. |
| [GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPositionPix) | Returns the coordinates of the footer button area. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) | Returns the coordinates of the footer. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPositionPix) | Returns the coordinates of the footer. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Image) | Defines the graphic displayed in this column footer. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageHAlign) | Defines the horizontal alignment of the graphic in this column footer. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageVAlign) | Defines the vertical alignment of the graphic in this column footer. |
| [Index](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Index) | Returns the column number of this footer. |
| [Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Locked) | Defines whether this column's size is locked so the user cannot resize the column. |
| [OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) | Defines whether the column footer's color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes). |
| [RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_RemainUp) | Defines whether this column footer button will return to its "up" position when pressed. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectBackColor) | Defines the background color for this column footer, when it is pressed. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectForeColor) | Defines the foreground color for this column footer, when it is pressed. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Text) | Defines this column footer's text. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextHAlign) | Defines the horizontal alignment of the text in this column footer. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextVAlign) | Defines the vertical alignment of the text in this column footer. |
See Also Object Hierarchy
## SftTreeFooters Object (ISftTreeFooters Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters*
The SftTreeFooters object describes attributes that apply to all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. The SftTreeFooters object can be accessed through the control's [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers) property. A control has only one SftTreeFooters Object. An individual column's [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object can be accessed through the control's [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) property.
| Property/Method | Description |
| --- | --- |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance) | Defines the appearance of all column footers. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_BackColor) | Defines the background color for all column footers. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Font) | Defines the font used for all column footers. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor) | Defines the text color for all column footers. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) | Returns the coordinates of the combined row/column footer and all column footers. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPositionPix) | Returns the coordinates of the combined row/column footer and all column footers. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GrayedColor) | Defines the text color used to draw all disabled column footers. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_HilightColor) | Defines the color used to draw the highlighted edge of all column footers. |
| [Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Multiline) | Defines whether column footer titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline). |
| [Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Pressed) | Defines the currently pressed column footer button. |
| [Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Resizable) | Defines whether column footers can be resized by the user. |
| [ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ResizeColumn) | Returns the column number currently being resized. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ShadowColor) | Defines the color used to draw the dark edge of all column footers. |
See Also Object Hierarchy
## SftTreeHeader Object (ISftTreeHeader Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader*
The SftTreeHeader object represents one [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. A SftTreeHeader object for a particular column can be accessed through the control's [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) property. Certain default properties and behavior for column headers can be defined using the [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) Object.
| Property/Method | Description |
| --- | --- |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor) | Defines the background color for this column header. |
| [BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColorDisabled) | Defines the background color for this column header, when it is disabled. |
| [Button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Button) | Defines the column header's button appearance. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) | Defines whether the column header is enabled. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor) | Defines the foreground color for this column header. |
| [ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColorDisabled) | Defines the foreground color for this column header, when it is disabled. |
| [GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPosition) | Returns the coordinates of the header button area. |
| [GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPositionPix) | Returns the coordinates of the header button area. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) | Returns the coordinates of the header. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPositionPix) | Returns the coordinates of the header. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) | Defines the graphic displayed in this column header. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign) | Defines the horizontal alignment of the graphic in this column header. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign) | Defines the vertical alignment of the graphic in this column header. |
| [Index](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Index) | Returns the column number of this header. |
| [KeepPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_KeepPosition) | Defines whether this column header must remain in its current position and cannot be reordered. |
| [Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked) | Defines whether this column's size is locked so the user cannot resize the column. |
| [OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) | Defines whether the column header's color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes). |
| [RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) | Defines whether this column header button will return to its "up" position when pressed. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectBackColor) | Defines the background color for this column header, when it is pressed. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectForeColor) | Defines the foreground color for this column header, when it is pressed. |
| [SortIndicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SortIndicator) | Defines the column header's [sort indicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) appearance. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text) | Defines this column header's text. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) | Defines the horizontal alignment of the text in this column header. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign) | Defines the vertical alignment of the text in this column header. |
See Also Object Hierarchy
## SftTreeHeaders Object (ISftTreeHeaders Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders*
The SftTreeHeaders object describes attributes that apply to all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. The SftTreeHeaders object can be accessed through the control's [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers) property. A control has only one SftTreeHeaders object. An individual column's [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) Object can be accessed through the control's [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) property.
| Property/Method | Description |
| --- | --- |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) | Defines the appearance of all column headers. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor) | Defines the background color for all column headers. |
| [ClearSortIndicators](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ClearSortIndicators) | Clears all [sort indicators](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) in all columns. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Font) | Defines the font used for all column headers. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor) | Defines the text color for all column headers. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) | Returns the coordinates of the combined row/column header and all column headers. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPositionPix) | Returns the coordinates of the combined row/column header and all column headers. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor) | Defines the text color used to draw all disabled column headers. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_HilightColor) | Defines the color used to draw the highlighted edge of all column headers. |
| [Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline) | Defines whether column header titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline). |
| [Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) | Defines the currently pressed column header button. |
| [Reorderable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Reorderable) | Defines whether columns can be reordered using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop). |
| [Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable) | Defines whether column headers can be resized by the user. |
| [ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ResizeColumn) | Returns the column number currently being resized. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ShadowColor) | Defines the color used to draw the dark edge of all column headers. |
| [SortedColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_SortedColumn) | Returns the column number of the first column with a sort indicator. |
| [SortIndicators](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_SortIndicators) | Defines whether sort indicators are shown. |
See Also Object Hierarchy
## SftTreeItem Object (ISftTreeItem Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem*
The SftTreeItem object represents one item in a SftTree/OCX control. A SftTreeItem object for a particular item can be accessed through the control's [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item) property. Certain default properties and behavior for items can be defined using the [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) Object.
| Property/Method | Description |
| --- | --- |
| [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) | Returns a [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object for a given cell. |
| [ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ClearCellImages) | Removes the cell images from this item. |
| [Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse) | Collapses the item so its dependents are no longer visible. |
| [Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) | Defines the item's application specific numeric value. |
| [DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) | Defines the item's application specific floating point value. |
| [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) | Defines the item's application specific object value. |
| [DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) | Defines the item's application specific string value. |
| [DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag) | Defines the item's application specific variant value. |
| [DeleteDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DeleteDependents) | Deletes the item's dependents. |
| [DependentAllCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentAllCount) | Returns the item's number of all dependents. |
| [DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) | Returns the item's number of immediate dependents. |
| [EditIgnore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_EditIgnore) | Defines whether the item is ignored for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting). |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) | Defines whether the item is enabled. |
| [Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) | Expands the item so its dependents become visible. |
| [Expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expandable) | Defines whether the item is [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems). |
| [Expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expanded) | Defines whether the item is expanded or collapsed. |
| [FirstDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstDependent) | Returns the item's first [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents). |
| [FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) | Returns the item's first sibling. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPosition) | Returns the coordinates of the item. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPositionPix) | Returns the coordinates of the item. |
| [Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) | Returns the item's height. |
| [HeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_HeightPix) | Returns the item's height. |
| [HideExpandCollapseButton](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_HideExpandCollapseButton) | Defines whether the item's [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) is hidden. |
| [ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID) | Defines the [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids) of the item. |
| [Ignore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Ignore) | Defines whether the item is ignored for optimal column width and extent calculation. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image) | Defines the item graphic displayed in this item. |
| [ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ItemIndex) | Returns the item index of this item. |
| [LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage) | Defines the label graphic displayed in this item. |
| [LastDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastDependent) | Returns the item's last dependent. |
| [LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) | Returns the item's last sibling. |
| [Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) | Defines the item's level number. |
| [MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) | Vertically scrolls the item into view so it is displayed in the tree control's client area. |
| [MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MaxHeightPix) | Defines the maximum height of the item. |
| [MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MinHeightPix) | Defines the minimum height of the item. |
| [NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown) | Returns the index of the next [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus). |
| [NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) | Returns the item's next sibling. |
| [Parent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Parent) | Returns the item's parent item. |
| [PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown) | Returns the index of the previous visible item. |
| [PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) | Returns the item's previous sibling. |
| [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader) | Returns the item's [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object. |
| [Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) | Defines whether the item is selected. |
| [Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown) | Defines whether the item is shown. |
| [TopParent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_TopParent) | Returns the item's top-most parent item. |
See Also Object Hierarchy
## SftTreeItems Object (ISftTreeItems Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems*
The SftTreeItems object describes attributes that apply to all items in a SftTree/OCX control. The SftTreeItems object can be accessed through the control's [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) property. A control has only one SftTreeItems object. An individual item's [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object can be accessed through the control's [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item) property.
| Property/Method | Description |
| --- | --- |
| [Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) | Adds a new item at the end of the list. |
| [AutoExpandDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDrop) | Defines whether items are automatically [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) during an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. |
| [AutoExpandDragDropInterval](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDropInterval) | Defines the delay (in milliseconds) after which items are automatically expanded during an OLE drag & drop operation. |
| [AutoExpandHover](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHover) | Defines whether items are automatically expanded when the mouse cursor hovers over an item. |
| [AutoExpandHoverInterval](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHoverInterval) | Defines the delay (in milliseconds) after which items are automatically expanded when the mouse cursor hovers over an item. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) | Defines the default background color used to draw items that are not selected. |
| [BackColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColorOdd) | Defines the background color used to draw items in odd rows. |
| [CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) | Defines the maximum number of items to consider for optimal column width and scrolling calculation. |
| [CalcOptimalCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcOptimalCell) | Returns the size of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) contents. |
| [CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) | Defines whether only visible items are considered for optimal column width and scrolling calculation. |
| [Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) | Defines whether cells are painted using a 3D effect. |
| [CharSearchColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchColumn) | Defines the column searched for characters typed by the user. |
| [CharSearchMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchMode) | Defines the search mode for characters typed by the user. |
| [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Clear) | Removes all items. |
| [ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) | Removes the cell images from all items. |
| [ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) | Removes the item images from all items. |
| [ClearLabelImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages) | Removes the label images from all items. |
| [Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) | Collapses all items so no child items are visible. |
| [Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) | Copies items to a new position in the tree control. |
| [CopyAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CopyAfter) | Copies items to a new position in the tree control. |
| [Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Count) | Returns the number of items in the tree control. |
| [Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) | Defines the current item (caret location). |
| [DisabledItemsSelectable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DisabledItemsSelectable) | Defines whether disabled items can be selected by the end-user. |
| [DropHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) | Defines the index of the current drop target of a drag & drop operation. |
| [DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) | Defines the color used to display the drop target item of a drag & drop operation. |
| [DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) | Defines the style used to display the drop target of a drag & drop operation. |
| [DropTargetInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerBorderColor) | Defines the inner border color for items as drop targets during a drag & drop operation. |
| [DropTargetInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill1) | Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for items as drop targets during a drag & drop operation. |
| [DropTargetInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill2) | Defines the ending color used to fill the selection outline for items as drop targets during a drag & drop operation. |
| [DropTargetOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetOutlineBorderColor) | Defines the outline border color for items as drop targets during a drag & drop operation. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [EditNoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EditNoFocusStyle) | Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting). |
| [Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) | Expands all items so their dependents become visible. |
| [FindCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCell) | Searches items for a string. |
| [FindCellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellText) | Searches items for a string. |
| [FindCellTextExact](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellTextExact) | Searches items for a string using an exact match. |
| [FindData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindData) | Searches the Data property of items. |
| [FindDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindDataString) | Searches the DataString property of items. |
| [FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown) | Returns the index of the first [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus) in the tree control. |
| [FlybyHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FlybyHighlight) | Defines whether items are underlined as the mouse cursor moves over an item. |
| [FlybyHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FlybyHighlightStyle) | Defines whether items are underlined as the mouse cursor moves over an item. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) | Defines the default text color used to draw items that are not selected. |
| [ForeColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColorOdd) | Defines the text color used to draw items in odd rows. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) | Defines the text color used to draw items that are disabled. |
| [GridHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridHorizontalColor) | Defines the color used to draw horizontal grid lines. |
| [GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) | Defines the method used to paint grid lines. |
| [GridVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridVerticalColor) | Defines the color used to draw vertical grid lines. |
| [Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) | Returns the height of an item in a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control. |
| [HeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HeightPix) | Returns the height of an item in a fixed height tree control. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HilightColor) | Defines the color used to draw the highlighted edge of items. |
| [HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) | Returns the index of the item found at given coordinates. |
| [HitTestPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTestPix) | Returns the index of the item found at given coordinates. |
| [HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) | Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent. |
| [HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) | Defines the current horizontal scrolling extent in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar). |
| [HorizontalExtent2Pix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2Pix) | Defines the current horizontal scrolling extent. |
| [HorizontalExtentPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtentPix) | Defines the current horizontal scrolling extent. |
| [HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) | Defines the current horizontal scrolling offset. |
| [HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) | Defines the current horizontal scrolling offset in the right pane. |
| [HorizontalOffset2Pix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2Pix) | Defines the current horizontal scrolling offset in the right pane. |
| [HorizontalOffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffsetPix) | Defines the current horizontal scrolling offset. |
| [HotInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerBorderColor) | Defines the inner border color for items when the mouse cursor is on the item. |
| [HotInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill1) | Defines the starting color used to fill the selection outline for items when the mouse cursor is on the item. |
| [HotInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill2) | Defines the ending color used to fill the selection outline for items when the mouse cursor is on the item. |
| [HotOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotOutlineBorderColor) | Defines the outline border color for items when the mouse cursor is on the item. |
| [Indentation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Indentation) | Defines the indentation for item levels. |
| [IndentationPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_IndentationPix) | Defines the indentation for item levels. |
| [Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) | Inserts a new item at the specified index position. |
| [InsertAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_InsertAfter) | Inserts a new item following the specified index position. |
| [ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) | Defines whether item graphics are aligned with higher level cells. |
| [ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable) | Defines the default graphic used to display an expandable item's item image. |
| [ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) | Defines the default graphic used to display an expanded item's item image. |
| [ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) | Defines the default graphic used to display a leaf item's item image. |
| [ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemIndex) | Returns the item index given an [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids). |
| [LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) | Returns the index of the last visible item in the tree control. |
| [Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) | Defines the number of text lines used for item height calculation. |
| [MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MaxHeightPix) | Defines the maximum height of all items. |
| [MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MinHeightPix) | Defines the minimum height of all items. |
| [Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) | Moves items to a new position in the tree control. |
| [MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter) | Moves items to a new position in the tree control. |
| [MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) | Defines whether one or multiple items can be selected at a time. |
| [NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) | Defines the display style of selected items when the tree control does not have the input focus. |
| [NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection) | Defines whether the selection changes when the caret location changes. |
| OutlineStyle | Defines the display style of the selection outline. |
| [PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) | Defines the graphic used to display an expandable item's plus/minus graphic. |
| [PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) | Defines the graphic used to display an expanded item's plus/minus graphic. |
| [PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) | Defines the graphic used to display a leaf item's plus/minus graphic. |
| [RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) | Recalculates the optimal horizontal scrolling extent. |
| [Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) | Removes an item. |
| [RubberbandSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RubberbandSelection) | Defines whether rubberband selection is enabled (multiple selection only). |
| [ScrollTips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ScrollTips) | Defines whether [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) are shown. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) | Defines the background color used to draw selected items. |
| [SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus) | Defines the background color used to draw selected items when the control doesn't have the input focus. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) | Defines the text color used to draw selected items. |
| [SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus) | Defines the text color used to draw selected items when the control doesn't have the input focus. |
| [SelectHotInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerBorderColor) | Defines the inner border color for selected items when the mouse cursor is on the item. |
| [SelectHotInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill1) | Defines the starting color used to fill the selection outline for selected items when the mouse cursor is on the item. |
| [SelectHotInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill2) | Defines the ending color used to fill the selection outline for selected items when the mouse cursor is on the item. |
| [SelectHotOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotOutlineBorderColor) | Defines the outline border color for selected items when the mouse cursor is on the item. |
| [SelectInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerBorderColor) | Defines the inner border color for selected items. |
| [SelectInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill1) | Defines the starting color used to fill the selection outline for selected items. |
| [SelectInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill2) | Defines the ending color used to fill the selection outline for selected items. |
| [Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) | Returns the selected item. |
| [SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) | Defines the area where selection changes occur. |
| [SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount) | Returns the number of currently selected items. |
| [SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) | Returns the index of the last selected item in a group of selected items. |
| [SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) | Returns the number of groups of selected items. |
| [SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) | Returns the index of the first selected item in a group of selected items. |
| [SelectNoFocusInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerBorderColor) | Defines the inner border color for selected items when the tree control does not have the input focus. |
| [SelectNoFocusInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill1) | Defines the starting color used to fill the selection outline for selected items when the tree control does not have the input focus. |
| [SelectNoFocusInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill2) | Defines the ending color used to fill the selection outline for selected items when the tree control does not have the input focus. |
| [SelectNoFocusOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusOutlineBorderColor) | Defines the outline border color for selected items when the tree control does not have the input focus. |
| [SelectOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectOutlineBorderColor) | Defines the outline border color for selected items. |
| [SelectRange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectRange) | Selects or deselects a range of items. |
| [SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) | Defines the display style of selected items when the tree control has the input focus. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShadowColor) | Defines the color used to draw the dark edge of items. |
| [ShowFocusRectangle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShowFocusRectangle) | Defines whether the focus rectangle is displayed. |
| [Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Shown) | Returns the number of completely and partially visible items in the client area. |
| [ShownComplete](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShownComplete) | Returns the number of completely visible items in the client area. |
| [SortDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) | Sorts an item's dependents. |
| [Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style) | Defines the item style. |
| [ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways) | Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are shown, even if cell text is completely visible. |
| [ToolTipBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipBackColor) | Defines the background color used to draw Tool Tips and Scroll Tips. |
| [ToolTipForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipForeColor) | Defines the text color used to draw Tool Tips and Scroll Tips. |
| [ToolTipIntervalOff](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOff) | Defines the delay (in milliseconds) after which Tool Tips are removed. |
| [ToolTipIntervalOn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOn) | Defines the delay (in milliseconds) after which Tool Tips are displayed. |
| [ToolTipsUseEntireCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipsUseEntireCell) | Defines whether Tool Tips use the entire cell. |
| [TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex) | Defines the index of the first item displayed in the tree control's client area. |
| [TreeLineColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineColor) | Defines the color used to draw connecting tree lines when the tree control is enabled. |
| [TreeLineGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineGrayedColor) | Defines the color used to draw connecting tree lines when the tree control is disabled. |
| [TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) | Defines the current tree line display style. |
| [UpdateCurrentExpandCollapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_UpdateCurrentExpandCollapse) | Defines whether the current item (Items.Current) is updated when the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) is clicked. |
See Also Object Hierarchy
## SftTreeRowColumnFooter Object (ISftTreeRowColumnFooter Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter*
The SftTreeRowColumnFooter object describes the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. The SftTreeRowColumnFooter object can be accessed through the control's [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter) property. A control has only one SftTreeRowColumnFooter object.
| Property/Method | Description |
| --- | --- |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance) | Defines the row/column footer's appearance. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_BackColor) | Defines the row/column footer's background color. |
| [ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ButtonDown) | Defines whether the row/column footer button is currently pressed. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Enabled) | Defines whether the row/column footer is enabled. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ForeColor) | Defines the row/column footer's text color. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_GrayedColor) | Defines the text color used to draw a disabled row/column footer. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_HilightColor) | Defines the color used to draw the highlighted edge of the row/column footer. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Image) | Defines the graphic displayed in the row/column footer. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageHAlign) | Defines the horizontal alignment of the graphic in the row/column footer. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageVAlign) | Defines the vertical alignment of the graphic in the row/column footer. |
| [OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_OverrideTheme) | Defines whether the row/column footer's color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes). |
| [RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_RemainUp) | Defines whether the row/column footer button will return to its "up" position when pressed. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ShadowColor) | Defines the color used to draw the dark edge of the row/column footer. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Text) | Defines the text displayed in the row/column footer. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextHAlign) | Defines the horizontal alignment of the text in the row/column footer. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextVAlign) | Defines the vertical alignment of the text in the row/column footer. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Width) | Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) ( and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), row/column footer) area. |
| [WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_WidthPix) | Defines the width of the row header ( and row/column header, row/column footer) area. |
See Also Object Hierarchy
## SftTreeRowColumnHeader Object (ISftTreeRowColumnHeader Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader*
The SftTreeRowColumnHeader object describes the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. The SftTreeRowColumnHeader object can be accessed through the control's [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader) property. A control has only one SftTreeRowColumnHeader object.
| Property/Method | Description |
| --- | --- |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) | Defines the row/column header's appearance. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_BackColor) | Defines the row/column header's background color. |
| [ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ButtonDown) | Defines whether the row/column header button is currently pressed. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled) | Defines whether the row/column header is enabled. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ForeColor) | Defines the row/column header's text color. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor) | Defines the text color used to draw a disabled row/column header. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_HilightColor) | Defines the color used to draw the highlighted edge of the row/column header. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) | Defines the graphic displayed in the row/column header. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign) | Defines the horizontal alignment of the graphic in the row/column header. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign) | Defines the vertical alignment of the graphic in the row/column header. |
| [OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_OverrideTheme) | Defines whether the row/column header's color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes). |
| [RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) | Defines whether the row/column header button will return to its "up" position when pressed. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ShadowColor) | Defines the color used to draw the dark edge of the row/column header. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text) | Defines the text displayed in the row/column header. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) | Defines the horizontal alignment of the text in the row/column header. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) | Defines the vertical alignment of the text in the row/column header. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Width) | Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) ( and row/column header, row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)) area. |
| [WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_WidthPix) | Defines the width of the row header ( and row/column header, row/column footer) area. |
See Also Object Hierarchy
## SftTreeRowHeader Object (ISftTreeRowHeader Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader*
The SftTreeRowHeader object represents one item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) in a SftTree/OCX control. A SftTreeRowHeader object for a particular item can be accessed through an item's [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader) property. An item is defined by the [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) Object. Certain default properties and behavior for row headers can be defined using the [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
| Property/Method | Description |
| --- | --- |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) | Defines the row header's background color. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) | Defines the row header's foreground color. |
| [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) | Defines the graphic displayed in this row header. |
| [ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) | Defines the horizontal alignment of the graphic in this row header. |
| [ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) | Defines the vertical alignment of the graphic in this row header. |
| [ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ItemIndex) | Returns the item index of this row header. |
| [OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme) | Defines whether the row header's color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes). |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) | Defines the row header's background color when the item is selected. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) | Defines the row header's foreground color when the item is selected. |
| [Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) | Defines the row header's text. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) | Defines the horizontal alignment of the text in this row header. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) | Defines the vertical alignment of the text in this row header. |
See Also Object Hierarchy
## SftTreeRowHeaders Object (ISftTreeRowHeaders Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders*
The SftTreeRowHeaders object describes attributes that apply to all [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) in a SftTree/OCX control. \ The SftTreeRowHeaders object can be accessed through the control's [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders) property. A control has only one SftTreeRowHeaders object. An individual item's [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) Object can be accessed through the item's [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader) property.
| Property/Method | Description |
| --- | --- |
| [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) | Defines the row header appearance. |
| [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_BackColor) | Defines the default background color used to draw row headers of items that are not selected. |
| [ClearImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages) | Removes the row header images from all items. |
| [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeHorizontalColor) | Defines the color used to draw all horizontal edges around headers/footers. |
| [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeVerticalColor) | Defines the color used to draw all vertical edges around headers/footers. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) | Defines whether row headers are enabled. |
| [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Font) | Defines the row header font. |
| [ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ForeColor) | Defines the default text color used to draw row headers of items that are not selected. |
| [GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor) | Defines the text color used to draw disabled row headers. |
| [HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_HilightColor) | Defines the default color used to draw the highlighted edge of row headers. |
| [Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Lines) | Defines the number of row header text lines used for height calculation. |
| [MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) | Sets the optimal row header width so that the text and graphics of all row headers can be displayed without being clipped horizontally. |
| [OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) | Returns the row header area's optimal width based on its contents. |
| [OptimalWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidthPix) | Returns the row header area's optimal width based on its contents. |
| [RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_RemainUp) | Defines whether row header buttons will return to their "up" position when pressed. |
| [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectBackColor) | Defines the default row header background color used to draw items that are selected. |
| [SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectForeColor) | Defines the default row header text color used to draw items that are selected. |
| [ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ShadowColor) | Defines the default color used to draw the dark edge of row headers. |
| [TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) | Defines the horizontal alignment of text in all row headers. |
| [TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) | Defines the vertical alignment of text in all row headers. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) | Defines the width of the row header area. |
| [WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_WidthPix) | Defines the width of the row header area. |
See Also Object Hierarchy
## SftTreeSplitter Object (ISftTreeSplitter Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter*
The SftTreeSplitter object describes the vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a SftTree/OCX control. The SftTreeSplitter object can be accessed through the control's [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter) property. A control has only one SftTreeSplitter object.
| Property/Method | Description |
| --- | --- |
| [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Column) | Defines the number of columns displayed in the left pane of a split tree control. |
| [GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition) | Returns the coordinates of the splitter bar. |
| [GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPositionPix) | Returns the coordinates of the splitter bar. |
| [LeftWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_LeftWindow) | Returns the window handle of the left pane in a split tree control. |
| [MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal) | Positions the splitter bar optimally. |
| [Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) | Defines the horizontal offset of the splitter bar in a split tree control. |
| [OffsetMin](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMin) | Defines the minimum splitter offset so the user cannot hide the left pane entirely. |
| [OffsetMinPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMinPix) | Defines the minimum splitter offset so the user cannot hide the left pane entirely. |
| [OffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix) | Defines the horizontal offset of the splitter bar in a split tree control. |
| [ResizeMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_ResizeMode) | Allows the user to resize the panes of a split tree control using the keyboard. |
| [RightWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_RightWindow) | Returns the window handle of the right pane in a split tree control. |
| [Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) | Defines whether a vertical splitter bar is present. |
| [Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) | Defines the width of the splitter bar. |
| [WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_WidthPix) | Defines the width of the splitter bar. |
See Also Object Hierarchy
## VirtualItem Object (IVirtItem Interface)
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem*
The VirtualItem object is used during the [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) event to provide item attributes. The event is called for each item, so the application can provide all necessary information for a particular item using the VirtualItem object's properties.
Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.
| Property/Method | Description |
| --- | --- |
| [CellBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellBackColor) | Defines the background color used to draw the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is not selected. |
| [CellFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellFont) | Defines the font used to display the item's cell text. |
| [CellForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellForeColor) | Defines the foreground color used to draw the item's cell that is not selected. |
| [CellPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPicture) | Defines the graphic displayed as the item's cell graphic. |
| [CellPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPictureAlign) | Defines the position of the graphic displayed in the item's cell. |
| [CellPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPictureH) | Defines the graphic displayed as the item's cell graphic. |
| [CellSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellSelectBackColor) | Defines the background color used to draw the item's cell that is selected. |
| [CellSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellSelectForeColor) | Defines the foreground color used to draw the item's cell that is selected. |
| [CellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellText) | Defines the item's cell text. |
| [CellTextAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellTextAlign) | Defines the position of the text displayed in the item's cell. |
| [ColumnCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ColumnCount) | Returns the current number of columns. |
| [Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Enabled) | Defines the item's enabled/disabled status. |
| [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item) | Returns the [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object of the item currently requested from the [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource). |
| [ItemData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemData) | Defines the item's application specific value. |
| [ItemDataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataFloat) | Defines the item's application specific floating point value. |
| [ItemDataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataObject) | Defines the item's application specific object. |
| [ItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataString) | Defines the item's application specific string value. |
| [ItemDataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataTag) | Defines an application defined value associated with the item. |
| [ItemID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemID) | Defines the item's [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids). |
| [ItemPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPicture) | Defines the graphic displayed as the item's item graphic. |
| [ItemPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPictureH) | Defines the graphic displayed as the item's item graphic. |
| [LabelPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPicture) | Defines the graphic displayed as the item's label graphic. |
| [LabelPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPictureH) | Defines the graphic displayed as the item's label graphic. |
| [RowBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowBackColor) | Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw the item when it is not selected. |
| [RowForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowForeColor) | Defines the row header foreground color used to draw the item when it is not selected. |
| [RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex) | Returns the item index of the item currently requested from the virtual data source. |
| [RowPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPicture) | Defines the graphic displayed in the item's row header. |
| [RowPictureAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPictureAlign) | Defines the position of the graphic displayed in an item's row header. |
| [RowPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPictureH) | Defines the graphic displayed in the item's row header. |
| [RowSelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowSelectBackColor) | Defines the row header background color used to draw the item when it is selected. |
| [RowSelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowSelectForeColor) | Defines the row header foreground color used to draw the item when it is selected. |
| [RowText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowText) | Defines the item's row header text. |
| [RowTextAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowTextAlign) | Defines the position of the text displayed in the item's row header. |
| [SetCellColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetCellColorSample) | Defines the color sample displayed as the item's cell graphic. |
| [SetCellPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetCellPictureImage) | Defines the graphic displayed as the item's cell graphic. |
| [SetItemPictureImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetItemPictureImage) | Defines the graphic displayed as the item's item graphic. |
Properties and methods shown grayed are provided for compatibility with older releases only and should no longer be used.
See Also Object Hierarchy
## Events
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeEvents*
The SftTree/OCX control generates these events:
Events shown grayed are provided for compatibility with older releases only and should no longer be used.
| Event | Description |
| --- | --- |
| [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) | [Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is about to end. |
| [AutoCancelDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoCancelDragging) | Dragging has been canceled (automatic [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) only). |
| [AutoDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging) | Dragging in progress (automatic DragMethod only). |
| [AutoEndDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoEndDragging) | Dragging has ended (automatic DragMethod only). |
| [CaretChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CaretChange) | The caret location changes. |
| [CEChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEChange) | The contents of the edit control or combo box have changed (cell editing). |
| [CEClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEClick) | The selection of a combo box has changed (cell editing). |
| [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) | A key has been pressed (cell editing). |
| [CEKeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress) | A key has been pressed (cell editing). |
| [CEKeyUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyUp) | A key has been released (cell editing). |
| [Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click) | The selection changes. |
| [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) | The user resizes the columns. |
| [ColumnSizeEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeEnded) | The user has stopped resizing the columns. |
| [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) | The user is about to resize the columns. |
| [ColumnsReordered](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnsReordered) | The columns have been reordered. |
| [ContextMenu](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ContextMenu) | The right mouse button is released or Shift-F10 is pressed requesting a context menu. |
| [DarkModeChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DarkModeChange) | The effective [dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) state has changed (Automatic dark mode only). |
| [DblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DblClick) | A mouse button is double-clicked. |
| [DPIChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DPIChanged) | The control moved to a monitor with a different [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi). |
| [DragStarting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DragStarting) | The user initiates a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. |
| [EditAllowed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditAllowed) | Determines whether a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can be reached during cell editing. |
| [EditEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnded) | Cell editing has ended. |
| [EditEnding](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnding) | Cell editing is ending. |
| [EditInitialized](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitialized) | Cell editing is about to start. |
| [EditInitializing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing) | The control used for cell editing is initialized. |
| [EditNavigating](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating) | A key has been intercepted which is used for navigation during cell editing. |
| [EditValidate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditValidate) | The new contents of the cell being edited are to be validated. |
| [FlybyHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FlybyHighlight) | The item highlighted by [flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) has changed. |
| [FocusIn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusIn) | The control receives the input focus. |
| [FocusOut](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusOut) | The control loses the input focus. |
| [HighContrastChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_HighContrastChange) | The effective [high contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) state has changed (Automatic high contrast only). |
| [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) | A mouse button is clicked. |
| [ItemClickAgain](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClickAgain) | An already [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) has been clicked. |
| [ItemCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemCollapsed) | An item has been [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems). |
| [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) | A mouse button is double-clicked. |
| [ItemDeleted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDeleted) | An item is about to be deleted. |
| [ItemExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemExpanded) | An item has been expanded. |
| [KeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyDown) | A key is pressed. |
| [KeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress) | An ANSI key is pressed or released. |
| [KeyUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyUp) | A key is released. |
| [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) | A mouse button is pressed. |
| [MouseEnterControl](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseEnterControl) | The mouse cursor is entering the control. |
| [MouseLeaveControl](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseLeaveControl) | The mouse cursor is leaving the control. |
| [MouseMove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseMove) | The mouse is moved. |
| [MouseUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseUp) | A mouse button is released. |
| [OffsetChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OffsetChange) | The user scrolls the tree control horizontally. |
| [OLECompleteDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLECompleteDrag) | The OLE drag & drop operation has ended. |
| [OLEDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragDrop) | An OLE drag & drop event indicating something has been dropped over the tree control. |
| [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) | An OLE drag & drop event indicating something is being dragged over the tree control. |
| [OLEGiveFeedback](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEGiveFeedback) | The OLE drag & drop operation is in progress, used for visual feedback. |
| [OLESetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLESetData) | OLE drag & drop data needs to be provided. |
| [OLEStartDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEStartDrag) | The tree control's [OLEDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDrag) method has been invoked. |
| [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) | Cell editing has ended. |
| [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) | The selection changes. |
| [SortCompare](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SortCompare) | [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are being sorted. |
| [ToolTipCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipCell) | A cell [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) is about to be displayed. |
| [ToolTipColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumn) | A [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) Tool Tip is about to be displayed. |
| [ToolTipColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumnFooter) | A [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) Tool Tip is about to be displayed. |
| [ToolTipColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumnHeader) | A column header Tool Tip is about to be displayed. |
| [ToolTipVScroll](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipVScroll) | A [Scroll Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) is about to be displayed. |
| [TopChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_TopChange) | The user scrolls the tree control vertically. |
| [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) | The [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource) is called to provide item information. |
Events shown grayed are provided for compatibility with older releases only and should no longer be used.
See Also Object Hierarchy
## SftControlButtonConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftControlButtonConstants*
Mouse button constants.
| Name | Value | Description |
| --- | --- | --- |
| constSftControlLeftButton | 1 | Left button |
| constSftControlRightButton | 2 | Right button |
| constSftControlMiddleButton | 4 | Middle button |
See Also Object Hierarchy
## SftControlKeyConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftControlKeyConstants*
Key constants.
| Name | Value | Description |
| --- | --- | --- |
| constSftControlShiftMask | 1 | Shift |
| constSftControlCtrlMask | 2 | Control |
| constSftControlAltMask | 4 | Alt |
See Also Object Hierarchy
## SftControlOLEDragModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftControlOLEDragModeConstants*
OLE drag mode constants (used with OLEDragMode property).
| Name | Value | Description |
| --- | --- | --- |
| OLEDragSftControlNone | 0 | None |
| OLEDragSftControlManual | 1 | Manual |
| OLEDragSftControlAutomatic | 2 | Automatic |
See Also Object Hierarchy
## SftControlOLEDragOverConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftControlOLEDragOverConstants*
[OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event constants.
| Name | Value | Description |
| --- | --- | --- |
| enterSftControl | 0 | Enter |
| leaveSftControl | 1 | Leave |
| overSftControl | 2 | Over |
See Also Object Hierarchy
## SftControlOLEDropModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftControlOLEDropModeConstants*
OLE drop mode constants (used with [OLEDropMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDropMode) property).
| Name | Value | Description |
| --- | --- | --- |
| OLEDropSftControlNone | 0 | None |
| OLEDropSftControlManual | 1 | Manual |
| OLEDropSftControlAutomatic | 2 | Automatic |
See Also Object Hierarchy
## SftMousePointerConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftMousePointerConstants*
Predefined mouse icon constants (used with [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property).
| Name | Value | Description |
| --- | --- | --- |
| sftDefault | 0 | (Default) |
| sftArrow | 1 | Arrow |
| sftCross | 2 | Cross |
| sftIBeam | 3 | IBeam |
| sftIcon | 4 | Icon (Obsolete) |
| sftSize | 5 | Size |
| sftSizeNESW | 6 | Size NW SW |
| sftSizeNS | 7 | Size N S |
| sftSizeNWSE | 8 | Size NW SE |
| sftSizeWE | 9 | Size W E |
| sftUpArrow | 10 | Up Arrow |
| sftHourglass | 11 | Hourglass |
| sftNoDrop | 12 | No Drop |
| sftArrowHourglass | 13 | Arrow and Hourglass |
| sftArrowQuestion | 14 | Arrow and Question Mark |
| sftSizeAll | 15 | Size All |
| sftCustom | 99 | Custom |
See Also Object Hierarchy
## SftOLEClipboardConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants*
[OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) format (clipboard) constants.
| Name | Value | Description |
| --- | --- | --- |
| sftCFText | 1 | Text |
| sftCFBitmap | 2 | Bitmap |
| sftCFMetafile | 3 | Metafile |
| sftCFDIB | 8 | DIB |
| sftCFPalette | 9 | Palette |
| sftCFEMetafile | 14 | EnhMetafile |
| sftCFFiles | 15 | [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) |
| sftCFRTF | -16639 | RTF |
See Also Object Hierarchy
## SftPictureImageConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureImageConstants*
Image constants.
| Name | Value | Description |
| --- | --- | --- |
| sftImageNone | -1 | None |
| sftImageCheckboxNo | 0 | Checkbox - No |
| sftImageCheckboxYes | 1 | Checkbox - Yes |
| sftImageCheckboxUnknown | 2 | Checkbox - Unknown |
| sftImageCheckboxNoDisabled | 3 | Checkbox - No, Disabled |
| sftImageCheckboxYesDisabled | 4 | Checkbox - Yes, Disabled |
| sftImageCheckboxUnknownDisabled | 5 | Checkbox - Unknown, Disabled |
| sftImageRadioButtonNo | 6 | RadioButton - No |
| sftImageRadioButtonYes | 7 | RadioButton - Yes |
| sftImageRadioButtonNoDisabled | 8 | RadioButton - No, Disabled |
| sftImageRadioButtonYesDisabled | 9 | RadioButton - Yes, Disabled |
| sftImageUp | 10 | Up |
| sftImageUpDisabled | 11 | Up, Disabled |
| sftImageDown | 12 | Down |
| sftImageDownDisabled | 13 | Down, Disabled |
| sftImageSortAsc | 14 | Sort Ascending |
| sftImageSortAscDisabled | 15 | Sort Ascending, Disabled |
| sftImageSortDesc | 16 | Sort Descending |
| sftImageSortDescDisabled | 17 | Sort Descending, Disabled |
See Also Object Hierarchy
## SftPictureTypeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants*
Image type constants.
| Name | Value | Description |
| --- | --- | --- |
| sftTypeNone | 0 | None |
| sftTypeIDispatch | 1 | IDispatch |
| sftTypeBitmap | 2 | Bitmap |
| sftTypeIcon | 3 | Icon |
| sftTypeImageList | 4 | ImageList |
| sftTypeColorSample | 5 | Color Sample |
| sftTypeBuiltin | 6 | Built-In Appearance |
| sftTypeImageListH | 7 | ImageListH |
| sftTypeGDIPlus | 8 | GDIPlus |
| sftTypeNET | 9 | .NET |
See Also Object Hierarchy
## SftTreeAlignConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants*
Alignment constants.
| Name | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | Left |
| alignSftTreeCenter | 1 | Center |
| alignSftTreeRight | 2 | Right |
| alignSftTreeVCenter | 16 | VCenter |
| alignSftTreeTop | 32 | Top |
| alignSftTreeBottom | 64 | Bottom |
See Also Object Hierarchy
## SftTreeAnnounceConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAnnounceConstants*
Live-region announcement kind constants.
| Name | Value | Description |
| --- | --- | --- |
| announceSftTreeInfo | 0 | Informational (polite) |
| announceSftTreeSuccess | 1 | Success (action completed) |
| announceSftTreeWarning | 2 | Warning (notable) |
| announceSftTreeError | 3 | Error (action failed) |
See Also Object Hierarchy | [Accessibility (Screen Readers)](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_accessibility)
## SftTreeAreaTypeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAreaTypeConstants*
Area constants.
| Name | Value | Description |
| --- | --- | --- |
| constSftTreeLabel | 0 | Label graphic |
| constSftTreePlusMinus | 1 | Plus/minus graphic |
| constSftTreeTree | 2 | Tree lines |
| constSftTreeButton | 3 | [Expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) |
| constSftTreeItem | 4 | Item graphic |
| constSftTreeText | 5 | [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text or graphic |
| constSftTreeColumnHeader | 6 | [Column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) |
| constSftTreeColumn | 6 | Column header - use constSftTreeColumnHeader instead |
| constSftTreeRowColumnHeader | 7 | Row/column header |
| constSftTreeRowColumn | 7 | Row/column header - use constSftTreeRowColumnHeader instead |
| constSftTreeRow | 8 | [Row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) |
| constSftTreeCellText | 9 | Cell text |
| constSftTreeCellGraphic | 10 | Cell graphic |
| constSftTreeColumnRes | 11 | Column header resizing |
| constSftTreeExpandAll | 12 | ExpandAll key |
| constSftTreeRowColumnFooter | 14 | Row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) |
| constSftTreeColumnFooter | 15 | Column footer |
| constSftTreeColumnHeaderButton | 16 | [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) [dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) |
| constSftTreeColumnFooterButton | 17 | [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) dropdown/filter button |
See Also Object Hierarchy
## SftTreeBackgroundStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeBackgroundStyleConstants*
Background style constants.
| Name | Value | Description |
| --- | --- | --- |
| backSftTreeNone | 0 | Tiled - No scrolling |
| backSftTreeHScroll | 1 | Tiled - [Horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) |
| backSftTreeCenter | 2 | Centered |
See Also Object Hierarchy
## SftTreeButtonAppearanceConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants*
[Expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) appearance constants.
| Name | Value | Description |
| --- | --- | --- |
| buttonsSftTreeUserImages | -1 | User defined button images |
| buttonsSftTreeClassicSmall | 0 | Classic small button |
| buttonsSftTreeClassicWide | 1 | Classic wide button |
| buttonsSftTreeClassicLarge | 2 | Classic large buttons |
| buttonsSftTreeSimple | 3 | Simple |
| buttonsSftTreeModern | 4 | Modern (using bitmaps) |
| buttonsSftTreeThemeImitation | 5 | Theme imitation (using bitmaps) |
| buttonsSftTreeAutoThemeImitation | 6 | Automatic theme imitation (using bitmaps) |
| buttonsSftTreeAutoTheme | 7 | Automatic theme |
| buttonsSftTreeAutoThemeVista | 8 | Automatic theme (Vista) |
See Also Object Hierarchy
## SftTreeButtonConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants*
Mouse button constants.
| Name | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | Left button |
| constSftTreeRightButton | 2 | Right button |
| constSftTreeMiddleButton | 4 | Middle button |
See Also Object Hierarchy
## SftTreeButtonStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonStyleConstants*
Button style constants.
| Name | Value | Description |
| --- | --- | --- |
| buttonsSftTreeNone | 0 | None |
| buttonsSftTree1 | 1 | Buttons (except 0) |
| buttonsSftTreeAll | 2 | Buttons (all levels) |
See Also Object Hierarchy
## SftTreeCellEditInterceptStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCellEditInterceptStyleConstants*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) constants.
| Name | Value | Description |
| --- | --- | --- |
| cellEditInterceptSftTreeChar | 1 | Character Only |
| cellEditInterceptSftTreeControlChar | 4 | Control + Character |
| cellEditInterceptSftTreeShiftChar | 8 | Shift + Character |
See Also Object Hierarchy
## SftTreeCellEditStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCellEditStyleConstants*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) constants.
| Name | Value | Description |
| --- | --- | --- |
| cellSftTreeNormal | 0 | Normal |
| cellSftTreeAutoSize | 1 | Auto size |
See Also Object Hierarchy
## SftTreeCharSearchModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCharSearchModeConstants*
Search mode constants.
| Name | Value | Description |
| --- | --- | --- |
| searchSftTreeOneChar | 0 | One character |
| searchSftTreeAllChars | 1 | All characters |
| searchSftTreeNone | 2 | None |
| searchSftTreeAllChars2 | 3 | All characters (exclude hidden items) |
| searchSftTreeOneChar2 | 4 | One character (exclude hidden items) |
| searchSftTreeOneCharWrap | 5 | One character, wrap around |
| searchSftTreeOneCharWrap2 | 6 | One character, wrap around (exclude hidden items) |
See Also Object Hierarchy
## SftTreeColumnStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeColumnStyleConstants*
Column style constants.
| Name | Value | Description |
| --- | --- | --- |
| colstyleSftTreeLeft | 0 | Left |
| colstyleSftTreeCenter | 1 | Center |
| colstyleSftTreeRight | 2 | Right |
| colstyleSftTreeMultiline | 4 | Multiline |
| colstyleSftTreeWrap | 16 | Wrap |
| colstyleSftTreeToolTip | 8 | [ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip) |
| colstyleSftTreeLocked | 256 | Locked |
| colstyleSftTreeKeepPos | 512 | KeepPos |
| colstyleSftTreeMerge | 1024 | [Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) |
| colstyleSftTreeMergeInto | 2048 | [MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) |
| colstyleSftTreeTop | 4096 | Top |
| colstyleSftTreeVCenter | 8192 | VCenter |
| colstyleSftTreeBottom | 16384 | Bottom |
See Also Object Hierarchy
## SftTreeContentWindowStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeContentWindowStyleConstants*
[Content window](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contentwindows) style constants.
| Name | Value | Description |
| --- | --- | --- |
| contentWindowSftTreeNone | 0 | None |
| contentWindowSftTreeKeepDisabled | 1 | Keep Disabled |
| contentWindowSftTreeKeepSize | 2 | Keep Size ([Variable Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) Tree Control) |
See Also Object Hierarchy
## SftTreeDarkModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDarkModeConstants*
[Dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) constants.
| Name | Value | Description |
| --- | --- | --- |
| darkSftTreeOff | 0 | Off (always light) |
| darkSftTreeOn | 1 | On (always dark) |
| darkSftTreeAuto | 2 | Automatic (follow Windows setting) |
See Also Object Hierarchy | Dark Mode
## SftTreeDragMethodConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants*
[OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) style constants.
| Name | Value | Description |
| --- | --- | --- |
| dragSftTreeNone | 0 | None |
| dragSftTreeManual | 1 | Manual |
| dragSftTreeAuto | 2 | Auto |
| dragSftTreeOLE | 3 | OLE |
See Also Object Hierarchy
## SftTreeDragTypeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragTypeConstants*
[Drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) style constants.
| Name | Value | Description |
| --- | --- | --- |
| dragSftTreeNext | 0 | Text, leaving |
| dragSftTreeBmpNext | 1 | Text/bitmap, leaving |
| dragSftTreePix | 2 | Text, pixel-diff |
| dragSftTreeBmpPix | 3 | Text/bitmap, pixel-diff |
| dragSftTreeNextImm | 4 | Text, immediate, leaving |
| dragSftTreeBmpNextImm | 5 | Text/bitmap, immediate, leaving |
| dragSftTreePixImm | 6 | Text, immediate, pixel-diff |
| dragSftTreeBmpPixImm | 7 | Text/bitmap, immediate, pixel-diff |
See Also Object Hierarchy
## SftTreeDropHighlightStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDropHighlightStyleConstants*
[Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) highlight style constants.
| Name | Value | Description |
| --- | --- | --- |
| dropSftTreeCaret | 0 | [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) |
| dropSftTreeOnTop | 1 | Highlight |
| dropSftTreeBetween | 2 | Between |
See Also Object Hierarchy
## SftTreeFlybyHighlightStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeFlybyHighlightStyleConstants*
Grid lines constants.
| Name | Value | Description |
| --- | --- | --- |
| flybySftTreeNone | 0 | None |
| flybySftTreeCol1 | 1 | First Column |
| flybySftTreeAllColumns | 2 | All [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) |
See Also Object Hierarchy
## SftTreeFooterButtonConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeFooterButtonConstants*
[Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) button style constants.
| Name | Value | Description |
| --- | --- | --- |
| footerButtonSftTreeNone | 0 | None |
| footerButtonSftTreeDropDown | 1 | DropDown |
| footerButtonSftTreeFilter | 2 | Filter |
See Also Object Hierarchy
## SftTreeGridStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeGridStyleConstants*
Grid lines constants.
| Name | Value | Description |
| --- | --- | --- |
| gridSftTreeNone | 0 | None |
| gridSftTreeVert | 1 | Vertical, Solid |
| gridSftTreeHorz | 2 | Horizontal, Solid |
| gridSftTreeBoth | 3 | Both, Solid |
| gridSftTreeVertDot | 4 | Vertical, Dotted |
| gridSftTreeHorzDot | 5 | Horizontal, Dotted |
| gridSftTreeBothDot | 6 | Both, Dotted |
| gridSftTreeHorzExtendRight | 7 | Horizontal, Solid, Extend Right |
| gridSftTreeBothExtendRight | 8 | Both, Solid, Extend Right |
| gridSftTreeHorzDotExtendRight | 9 | Horizontal, Dotted, Extend Right |
| gridSftTreeBothDotExtendRight | 10 | Both, Dotted, Extend Right |
See Also Object Hierarchy
## SftTreeHAlignConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants*
Horizontal alignment constants.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | Left |
| halignSftTreeCenter | 1 | Center |
| halignSftTreeRight | 2 | Right |
See Also Object Hierarchy
## SftTreeHAlignDefaultConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignDefaultConstants*
Horizontal alignment constants.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeDefault | -1 | (Default) |
| halignSftTreeDefaultLeft | 0 | Left |
| halignSftTreeDefaultCenter | 1 | Center |
| halignSftTreeDefaultRight | 2 | Right |
See Also Object Hierarchy
## SftTreeHeaderAppearanceConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants*
[Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) style constants.
| Name | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | None |
| headerSftTreeButton | 1 | Button |
| headerSftTreeText | 2 | Title |
See Also Object Hierarchy
## SftTreeHeaderButtonConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderButtonConstants*
[Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) button style constants.
| Name | Value | Description |
| --- | --- | --- |
| headerButtonSftTreeNone | 0 | None |
| headerButtonSftTreeDropDown | 1 | DropDown |
| headerButtonSftTreeFilter | 2 | Filter |
See Also Object Hierarchy
## SftTreeHeaderSortIndicatorsConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderSortIndicatorsConstants*
[Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) [sort indicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) style constants.
| Name | Value | Description |
| --- | --- | --- |
| headerSortIndicatorsSftTreeNone | 0 | None |
| headerSortIndicatorsSftTreeAuto | 1 | Automatic |
| headerSortIndicatorsSftTreeManual | 2 | Manual |
See Also Object Hierarchy
## SftTreeHighContrastConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHighContrastConstants*
[High contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) constants.
| Name | Value | Description |
| --- | --- | --- |
| highContrastSftTreeOff | 0 | Off (ignore Windows high contrast) |
| highContrastSftTreeOn | 1 | On (always use the system palette) |
| highContrastSftTreeAuto | 2 | Automatic (follow Windows setting) |
See Also Object Hierarchy | High Contrast
## SftTreeItemStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeItemStyleConstants*
Item style constants.
| Name | Value | Description |
| --- | --- | --- |
| itemSftTreeFixed | 0 | Fixed |
| itemSftTreeVariable | 1 | Variable |
See Also Object Hierarchy
## SftTreeKeyConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants*
Key constants.
| Name | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | Shift |
| constSftTreeCtrlMask | 2 | Control |
| constSftTreeAltMask | 4 | Alt |
See Also Object Hierarchy
## SftTreeMouseOverTransitionEffectConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMouseOverTransitionEffectConstants*
Transition effect constants.
| Name | Value | Description |
| --- | --- | --- |
| transitionSftTreeNone | 0 | None |
| transitionSftTreeVistaNoFocus | 1 | Vista+, No Focus |
| transitionSftTreeVista | 2 | Vista+ |
| transitionSftTreeAlwaysNoFocus | 3 | Always, No Focus |
| transitionSftTreeAlways | 4 | Always |
See Also Object Hierarchy
## SftTreeMultiSelectConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMultiSelectConstants*
[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) style constants.
| Name | Value | Description |
| --- | --- | --- |
| selectSftTreeSingle | 0 | Single |
| selectSftTreeMulti | 1 | Multiple |
See Also Object Hierarchy
## SftTreeNoFocusStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants*
Control focus style constants.
| Name | Value | Description |
| --- | --- | --- |
| noFocusSftTreeKeepSel | 0 | Show selection |
| noFocusSftTreeFrame | 1 | Frame |
| noFocusSftTreeNothing | 2 | Hide selection |
See Also Object Hierarchy
## SftTreeOLEDragModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDragModeConstants*
OLE drop mode constants.
| Name | Value | Description |
| --- | --- | --- |
| OLEDragSftTreeNone | 0 | None |
| OLEDragSftTreeManual | 1 | Manual |
| OLEDragSftTreeAutomatic | 2 | Automatic |
See Also Object Hierarchy
## SftTreeOLEDragOverConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDragOverConstants*
[OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event constants.
| Name | Value | Description |
| --- | --- | --- |
| enterSftTree | 0 | Enter |
| leaveSftTree | 1 | Leave |
| overSftTree | 2 | Over |
See Also Object Hierarchy
## SftTreeOLEDropModeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDropModeConstants*
[OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) style constants.
| Name | Value | Description |
| --- | --- | --- |
| OLEDropSftTreeNone | 0 | None |
| OLEDropSftTreeManual | 1 | Manual |
See Also Object Hierarchy
## SftTreeOrientationConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationConstants*
| Name | Value | Description |
| --- | --- | --- |
| horizontalOrientationSftTree | 0 | Horizontal |
| verticalOrientationSftTree | 1 | Vertical |
See Also Object Hierarchy
## SftTreeOrientationDefaultConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationDefaultConstants*
| Name | Value | Description |
| --- | --- | --- |
| defaultOrientationSftTree | -1 | (Default) |
| horizontalDefaultOrientationSftTree | 0 | Horizontal |
| verticalDefaultOrientationSftTree | 1 | Vertical |
See Also Object Hierarchy
## SftTreeOutlineStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants*
[Selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) style constants.
| Name | Value | Description |
| --- | --- | --- |
| OutlineStyleSftTreeRect | 0 | Rectangle |
| OutlineStyleSftTreeRectGradient | 1 | Rectangle with borders and gradient fill |
See Also Object Hierarchy
## SftTreeProgressStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeProgressStyleConstants*
| Name | Value | Description |
| --- | --- | --- |
| fullsizeProgressStyleSftTree | 0 | Full Size |
| smallProgressStyleSftTree | 1 | Small |
See Also Object Hierarchy
## SftTreeProgressStyleDefaultConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeProgressStyleDefaultConstants*
| Name | Value | Description |
| --- | --- | --- |
| defaultProgressStyleSftTree | -1 | (Default) |
| fullsizeDefaultProgressStyleSftTree | 0 | Full Size |
| smallDefaultProgressStyleSftTree | 1 | Small |
See Also Object Hierarchy
## SftTreeResizeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeResizeConstants*
Risizing style constants.
| Name | Value | Description |
| --- | --- | --- |
| resizeSftTreeNone | 0 | None |
| resizeSftTreeOne | 1 | One column |
| resizeSftTreeMultiple | 2 | Multiple columns |
See Also Object Hierarchy
## SftTreeRowHeaderAppearanceConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants*
[Row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) style constants.
| Name | Value | Description |
| --- | --- | --- |
| rowheaderSftTreeNone | 0 | None |
| rowheaderSftTreeButton | 1 | Button |
| rowheaderSftTreeText | 2 | Title |
| rowheaderSftTreeButtonCnt0 | 3 | Button (0..[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).Count-1) |
| rowheaderSftTreeTextCnt0 | 4 | Title (0..Items.Count-1) |
| rowheaderSftTreeButtonCnt1 | 5 | Button (1..Items.Count) |
| rowheaderSftTreeTextCnt1 | 6 | Title (1..Items.Count) |
See Also Object Hierarchy
## SftTreeSaveFormatConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSaveFormatConstants*
File format constants.
| Name | Value | Description |
| --- | --- | --- |
| saveFormatSftTreeStream | 0 | Stream |
| saveFormatSftTreePropertyPages | 1 | Stream as used by Property Page dialog ([Load](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Load)/[Save](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Save) Properties) |
See Also Object Hierarchy
## SftTreeScalingConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScalingConstants*
[DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi) scaling constants.
| Name | Value | Description |
| --- | --- | --- |
| scalingSftTreeAsIs | 0 | As is (native size) |
| scalingSftTreeStretch | 1 | Stretch (scale by DPI) |
See Also Object Hierarchy | Per-Monitor DPI and Scaling
## SftTreeScrollbarsConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScrollbarsConstants*
Scroll bar style constants.
| Name | Value | Description |
| --- | --- | --- |
| scrollSftTreeNone | 0 | None |
| scrollSftTreeHorz | 1 | Horizontal |
| scrollSftTreeVert | 2 | Vertical |
| scrollSftTreeBoth | 3 | Both |
| scrollSftTreeHorzDis | 4 | Horizontal (disable if noscroll) |
| scrollSftTreeVertDis | 5 | Vertical (disable if noscroll) |
| scrollSftTreeBothDis | 6 | Both (disable if noscroll) |
See Also Object Hierarchy
## SftTreeScrollbarStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScrollbarStyleConstants*
Scroll bar style constants.
| Name | Value | Description |
| --- | --- | --- |
| scrollstyleSftTreeStandard | 0 | Standard |
| scrollstyleSftTreeFlat | 1 | Flat |
| scrollstyleSftTreeFlat3D | 2 | Flat/3D |
See Also Object Hierarchy
## SftTreeSelectionAreaConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectionAreaConstants*
[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) area constants.
| Name | Value | Description |
| --- | --- | --- |
| selSftTreeAll | 0 | Anywhere on item |
| selSftTreeCells | 1 | All [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) |
| selSftTreeCell1 | 2 | Cell in first column |
| selSftTreeCellText1 | 3 | Cell text in first column |
| selSftTreeCellsRow | 4 | All cells + [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) |
| selSftTreeCell1Row | 5 | Cell in first column + row header |
| selSftTreeCellText1Row | 6 | Cell text in first column + row header |
See Also Object Hierarchy
## SftTreeSelectStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants*
[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) style constants.
| Name | Value | Description |
| --- | --- | --- |
| selectSftTreeAll | 0 | Highlight entire item |
| selectSftTreeText | 1 | Highlight text only |
| selectSftTreeCell1 | 2 | Highlight text in first [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) only |
| selectSftTreeCellCurrent | 3 | Highlight entire first cell |
| selectSftTreeCell1Full | 4 | Highlight text in first cell only (full height) |
See Also Object Hierarchy
## SftTreeSortIndicatorConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortIndicatorConstants*
Sort indicator style constants.
| Name | Value | Description |
| --- | --- | --- |
| sortIndicatorSftTreeNone | 0 | None |
| sortIndicatorSftTreeAscending | 1 | Ascending |
| sortIndicatorSftTreeDescending | 2 | Descending |
See Also Object Hierarchy
## SftTreeSortTypeConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortTypeConstants*
[Sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) constants.
| Name | Value | Description |
| --- | --- | --- |
| sortSftTreeAscending | 0 | Ascending |
| sortSftTreeDescending | 1 | Descending |
| sortSftTreeAscItemData | 2 | Ascending Item.Data |
| sortSftTreeDscItemData | 3 | Descending Item.Data |
| sortSftTreeAscItemDataFloat | 4 | Ascending Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) |
| sortSftTreeDscItemDataFloat | 5 | Descending Item.DataFloat |
| sortSftTreeEvent | 6 | Event |
| sortSftTreeEventCell | 7 | EventCell |
| sortSftTreeAscCellItemData | 8 | Ascending [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).Data |
| sortSftTreeDscCellItemData | 9 | Descending Cell.Data |
| sortSftTreeAscItemDataString | 10 | Ascending Item.DataString |
| sortSftTreeDscItemDataString | 11 | Descending Item.DataString |
| sortSftTreeEventWithIndex | 12 | EventWithIndex |
See Also Object Hierarchy
## SftTreeTreeLineStyleConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeTreeLineStyleConstants*
Tree line style constants.
| Name | Value | Description |
| --- | --- | --- |
| treeSftTreeNone | 0 | None |
| treeSftTreeShown | 1 | Solid line |
| treeSftTreeDotted | 2 | Dotted line, (levels 1-n) |
| treeSftTreeDotted0 | 3 | Dotted line, (levels 0-n) |
| treeSftTreeInvisible | 4 | Invisible |
| treeSftTreeAutomatic | 5 | Automatic, (levels 1-n) |
| treeSftTreeAutomatic0 | 6 | Automatic, (levels 0-n) |
See Also Object Hierarchy
## SftTreeVAlignConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants*
Vertical alignment constants.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | VCenter |
| valignSftTreeTop | 1 | Top |
| valignSftTreeBottom | 2 | Bottom |
See Also Object Hierarchy
## SftTreeVAlignDefaultConstants
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignDefaultConstants*
Vertical alignment constants.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeDefault | -1 | (Default) |
| valignSftTreeDefaultCenter | 0 | VCenter |
| valignSftTreeDefaultTop | 1 | Top |
| valignSftTreeDefaultBottom | 2 | Bottom |
See Also Object Hierarchy
## _FlatProperties Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree__FlatProperties*
Defines whether properties are stored as a flat list in a property bag.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**_FlatProperties** **As Boolean** |
| VB | *Boolean* = *object*.**_FlatProperties** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**_FlatProperties**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**_FlatProperties**;
**VARIANT_BOOL** *Boolean* = *object*->Get**_FlatProperties**(); |
| C | **HRESULT** *object*->get_**_FlatProperties**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**_FlatProperties** = *Boolean* **As Boolean** |
| VB | *object*.**_FlatProperties** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**_FlatProperties** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**_FlatProperties** = *Boolean*;
**void** *object*->Put**_FlatProperties**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**_FlatProperties**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether properties are stored as a flat list in a property bag.
| Boolean | Description |
| --- | --- |
| True | Properties are stored as a flat list if a property bag is used (IPropertyBag interface). |
| False | Properties are stored as objects if a property bag is used (IPropertyBag interface). This is the default and the recommended setting. |
### Comments
The _FlatProperties property defines whether properties are stored as a flat list in a property bag.
The _FlatProperties property can be used with development tools that do not properly save objects in a property bag (IPropertyBag interface). Visual Basic, Visual C++, Delphi, C++ Builder and many others fully support objects in property bags or use the IStream interface. For these, the _FlatProperties property should be set to False (the default).
When using development tools that cannot save objects in a property bag, you will notice that certain settings are lost when saving and loading forms, usually with HTML editors. In this case the _FlatProperties property should be set to True. This is a limitation of the development tool, not our product. Even with _FlatProperties set to False, [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object and Font object definitions (such as the Font property) are still lost. These must be set at run-time and are lost if defined at design-time. Only the SftTree objects are affected by the _FlatProperties property.
See Also SftTree Object | Object Hierarchy
## _Version Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree__Version*
Returns the product's exact version.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**_Version** **As String** |
| VB | *Text* = *object*.**_Version** **As String** |
| C#.NET | **string** *Text* = *object*.**_Version**; |
| VC++ | **_bstr_t** *Text* = *object*->**_Version**;
**_bstr_t** *Text* = *object*->Get**_Version**(); |
| C | **HRESULT** *object*->get_**_Version**(**BSTR*** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
Returns the product's exact version.
### Comments
The _Version property returns the product's exact version.
This information is used for [product support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contactsoftel) and can be displayed using the [property dialogs](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_property_dialog).
The _Version property returns the exact version number only. The [Version](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Version) property (without a leading underscore character) returns the product name and the exact version number.
See Also SftTree Object | Object Hierarchy
## AboutBox Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AboutBox*
Displays product, contact and copyright information.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**AboutBox**() |
| VB | *object*.**AboutBox** |
| C#.NET | **void** *object*.**AboutBox**(); |
| VC++ | **HRESULT** *object*->**AboutBox**(); |
| C | **HRESULT** *object*->raw_**AboutBox**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The AboutBox method displays product, contact and copyright information.
If you require [product support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contactsoftel), please have the licensing information available when contacting Softel vdm, Inc. The licensing information can also be found on the SftTree installation media.
See Also SftTree Object | Object Hierarchy
## ActualHeight Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight*
Returns the actual height of the image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *HPix* = *object*.**ActualHeight** **As Integer** |
| VB | *HPix* = *object*.**ActualHeight** **As Long** |
| C#.NET | **int** *HPix* = *object*.**ActualHeight**; |
| VC++ | **long** *HPix* = *object*->**ActualHeight**;
**long** *HPix* = *object*->Get**ActualHeight**(); |
| C | **HRESULT** *object*->get_**ActualHeight**(**long*** *HPix*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
HPix
Returns the actual height of the image.
### Comments
The ActualHeight property returns the actual height of the image.
The [SftPictureObject.Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) property returns the desired image height, last defined by the application. The desired height is only used for certain image types (see [SftPictureObject.Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type)).
See Also SftPictureObject Object | Object Hierarchy
## ActualWidth Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth*
Returns the actual width of the image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**ActualWidth** **As Integer** |
| VB | *WPix* = *object*.**ActualWidth** **As Long** |
| C#.NET | **int** *WPix* = *object*.**ActualWidth**; |
| VC++ | **long** *WPix* = *object*->**ActualWidth**;
**long** *WPix* = *object*->Get**ActualWidth**(); |
| C | **HRESULT** *object*->get_**ActualWidth**(**long*** *WPix*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
WPix
Returns the actual width of the image.
### Comments
The ActualWidth property returns the actual width of the image.
The [SftPictureObject.Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) property returns the desired image width, last defined by the application. The desired width is only used for certain image types (see [SftPictureObject.Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type)).
See Also SftPictureObject Object | Object Hierarchy
## Add Method, DataObjectFiles Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Add*
Adds a filename to the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject).[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Add**(**ByVal** *Filename* **As String**, [ **ByVal** *ItemIndex* **As Object** ] ) |
| VB | *object*.**Add**(**ByVal** *Filename* **As String**, [ **ByVal** *ItemIndex* **As Variant** ] ) |
| C#.NET | **void** *object*.**Add**(**string** *Filename*, **object** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**Add**(**_bstr_t** *Filename*, **const _variant_t**&**** *ItemIndex* = **vtMissing**); |
| C | **HRESULT** *object*->raw_**Add**(**BSTR** *Filename*, **VARIANT** *ItemIndex*); |
object
A [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles) object.
Filename
The file name to be added to the collection.
ItemIndex
The one-based position where the file name is to be inserted. If *ItemIndex* is not specified, the new file name is added at the end of the collection.
### Comments
The Add method adds a filename to the DataObject.Files collection (sftCFFiles format only).
The DataObject.Files collection is filled with file names only when the DataObject object contains data of type sftCFFiles. The DataObject object can contain several different types of data. You can iterate through the DataObject.Files collection to retrieve the list of file names.
See Also DataObjectFiles Object | Object Hierarchy
## Add Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add*
Adds a new item at the end of the list.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**Add**(**ByVal** *Text* **As String**) **As Integer** |
| VB | *ItemIndex* = *object*.**Add**(**ByVal** *Text* **As String**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**Add**(**string** *Text*); |
| VC++ | **long** *ItemIndex* = *object*->**Add**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->raw_**Add**(**BSTR** *Text*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Text
The text to be used for the item's first (or only) column.
ItemIndex
Returns the zero-based index of the newly added item.
### Comments
The Add method adds a new item at the end of the list.
New items added using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) method are always added at the end of the list. By default, new items are added at level 0. Use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property to change an item's level. If many items have to be added or inserted, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
Once an item has been added, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property can be used to change the text for any of the available columns.
Items can be inserted at a specific location using the Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) method. Items can be deleted using the Items.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method.
When a tree control is populated using Items.Add or Items.Insert, the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method can be used to have the tree control calculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) area so scroll bars are enabled, depending on the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
See Also SftTreeItems Object | Object Hierarchy
## AddItem Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AddItem*
Adds a new item at the end of the list.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**AddItem**(**ByVal** *Text* **As String**) **As Integer** |
| VB | *ItemIndex* = *object*.**AddItem**(**ByVal** *Text* **As String**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**AddItem**(**string** *Text*); |
| VC++ | **long** *ItemIndex* = *object*->**AddItem**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->raw_**AddItem**(**BSTR** *Text*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
The text to be used for the item's first (or only) column.
ItemIndex
Returns the zero-based index of the newly added item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Add instead
The AddItem method adds a new item at the end of the list.
New items added using the Items.Add method are always added at the end of the list. By default, new items are added at level 0. Use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property to change an item's level. If many items have to be added or inserted, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
Once an item has been added, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property can be used to change the text for any of the available columns.
Items can be inserted at a specific location using the Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) method. Items can be deleted using the Items.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method.
When a tree control is populated using Items.Add or Items.Insert, the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method can be used to have the tree control calculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) area so scroll bars are enabled, depending on the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
See Also SftTree Object | Object Hierarchy
## AfterEdit Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is about to end.
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**AfterEdit**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**AfterEdit** |
| VB | **Private Sub** *object*_**AfterEdit**(*CancelEdit* **As Boolean**, *NewString* **As String**, **ByVal** *CBIndex* **As Long**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**AfterEdit**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**AfterEdit***object*(**VARIANT_BOOL*** *CancelEdit*, **_bstr_t*** *NewString*, **long** *CBIndex*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**AfterEdit***object*(**VARIANT_BOOL*** *CancelEdit*, **BSTR*** *NewString*, **long** *CBIndex*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
CancelEdit
Set to True to cancel the AfterEdit event and resume cell editing. Set to False to accept the text and end cell editing. By default, the* *value of *CancelEdit* on entry to the event handler is set to False.
NewString
The text as entered or selected by the user.
CBIndex
The index of the selection made in the combo box. This value is only valid if cell editing was started using [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) or [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit).
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The AfterEdit event occurs when cell editing is about to end.
The AfterEdit event occurs when the user clicks outside of the current cell being edited, the TAB or ENTER keys are pressed (see [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling)) or if the [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit)(True) method is used. The AfterEdit event allows the application to perform input validation. The new cell text *NewString* can be inspected and/or modified. If the text entered or selected is invalid, the *CancelEdit* variable can be set to True. This indicates that the value in *NewString* should not be accepted and cell editing is to be resumed. Setting *CancelEdit* to False (default), cell editing is ended and the text in *NewString* becomes the new cell text.
If the CellEventHandling property is set to True, the AfterEdit event will not be generated if the TAB or ENTER keys are pressed. The application must handle these keys explicitly using the [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) event and end cell editing using the EndEdit method.
*NewString* is passed by reference, so an application can change the string value before returning. If the string is changed, it is used as the new cell text if *CancelEdit* is False. If *CancelEdit* is True, the current edit control or combo box control text will be set to the value in *NewString*.
If cell editing is aborted by the user by pressing the ESCAPE key, the AfterEdit event is not generated. The [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) event can be used instead to perform additional processing.
> The tree control properties cannot be modified during this event. If the tree control is updated in any way, cell editing is terminated. Use the PostEdit events to modify the cell contents.
If the control is in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode), the AfterEdit event automatically calls the [VirtualItemChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualItemChanged) method to mark the item as modified (if *CancelEdit* is False). The application should not use any methods (including VirtualItemChanged) while processing the event.
See Also SftTree Object | Object Hierarchy
## Announce Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Announce*
Announces short status text to attached [screen readers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_accessibility) via a UIA live region.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Announce**(*Text* **As String**, *Kind* **As [SftTreeAnnounceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAnnounceConstants)**, *Assertive* **As Boolean**) |
| VB | *object*.**Announce**(*Text* **As String**, *Kind* **As SftTreeAnnounceConstants**, *Assertive* **As Boolean**) |
| C#.NET | **void** *object*.**Announce**(**string** *Text*, **SftTreeAnnounceConstants** *Kind*, **bool** *Assertive*); |
| VC++ | **HRESULT** *object*->**Announce**(**_bstr_t** *Text*, **enum SftTreeAnnounceConstants** *Kind*, **VARIANT_BOOL** *Assertive*); |
| C | **HRESULT** *object*->**Announce**(**BSTR** *Text*, **enum SftTreeAnnounceConstants** *Kind*, **VARIANT_BOOL** *Assertive*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
The status text to announce. An empty string is ignored.
Kind
The kind of announcement.
| Name | Value | Description |
| --- | --- | --- |
| announceSftTreeInfo | 0 | Informational (polite). |
| announceSftTreeSuccess | 1 | Success - an action completed. |
| announceSftTreeWarning | 2 | Warning - notable or important. |
| announceSftTreeError | 3 | Error - an action was aborted or failed. |
Assertive
Defines whether the announcement is delivered assertively.
| Boolean | Description |
| --- | --- |
| True | The announcement is delivered even if it would normally be dropped. |
| False | The announcement uses the default delivery for its kind. |
### Comments
The Announce method announces short status text to attached screen readers via a UIA live region.
The text is delivered to attached screen readers (Narrator, NVDA, JAWS) as a live-region notification. It has no visual effect and is a no-op when no assistive technology is listening or when *Text* is empty.
If *Kind* is not one of the values listed above, the method fails and returns **CTL_E_INVALIDPROPERTYVALUE**. Announce is also a no-op if it is called before the control's window has been created.
See Also SftTree Object | Object Hierarchy | Accessibility (Screen Readers)
## Appearance Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Appearance*
Defines the image object using a built-in, special purpose image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftPictureImageConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureImageConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftPictureImageConstants** |
| C#.NET | **SftPictureImageConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftPictureImageConstants** *Style* = *object*->**Appearance**;
**enum SftPictureImageConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftPictureImageConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftPictureImageConstants** |
| VB | *object*.**Appearance** = *Style* **As SftPictureImageConstants** |
| C#.NET | **SftPictureImageConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftPictureImageConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftPictureImageConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftPictureImageConstants** *Style*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Style
Defines the image object using a built-in, special purpose image.
| Name | Value | Description |
| --- | --- | --- |
| sftImageNone | -1 | None |
| sftImageCheckboxNo | 0 | Checkbox - No |
| sftImageCheckboxYes | 1 | Checkbox - Yes |
| sftImageCheckboxUnknown | 2 | Checkbox - Unknown |
| sftImageCheckboxNoDisabled | 3 | Checkbox - No, Disabled |
| sftImageCheckboxYesDisabled | 4 | Checkbox - Yes, Disabled |
| sftImageCheckboxUnknownDisabled | 5 | Checkbox - Unknown, Disabled |
| sftImageRadioButtonNo | 6 | RadioButton - No |
| sftImageRadioButtonYes | 7 | RadioButton - Yes |
| sftImageRadioButtonNoDisabled | 8 | RadioButton - No, Disabled |
| sftImageRadioButtonYesDisabled | 9 | RadioButton - Yes, Disabled |
| sftImageUp | 10 | Up |
| sftImageUpDisabled | 11 | Up, Disabled |
| sftImageDown | 12 | Down |
| sftImageDownDisabled | 13 | Down, Disabled |
| sftImageSortAsc | 14 | Sort Ascending |
| sftImageSortAscDisabled | 15 | Sort Ascending, Disabled |
| sftImageSortDesc | 16 | Sort Descending |
| sftImageSortDescDisabled | 17 | Sort Descending, Disabled |
### Comments
The Appearance property defines the image object using a built-in, special purpose image.
The [SftPictureObject.Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeBuiltin](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants).
The [SftPictureObject.Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) and [SftPictureObject.Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) properties should be used to define the requested image size. The [SftPictureObject.ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and [SftPictureObject.ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image dimensions.
See Also SftPictureObject Object | Object Hierarchy
## Appearance Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Appearance*
Defines the control's border look.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type)* = *object*.**Appearance** **As Short** |
| VB | *Type* = *object*.**Appearance** **As Integer** |
| C#.NET | **short** *Type* = *object*.**Appearance**; |
| VC++ | **short** *Type* = *object*->**Appearance**;
**short** *Type* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**short*** *Type*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Type* **As Short** |
| VB | *object*.**Appearance** = *Type* **As Integer** |
| C#.NET | **short** *object*.**Appearance** = *Type*; |
| VC++ | **short** *object*->**Appearance** = *Type*;
**void** *object*->Put**Appearance**(**short** *Type*); |
| C | **HRESULT** *object*->put_**Appearance**(**short** *Type*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Type
Defines the control's border look.
| Type | Description |
| --- | --- |
| 0 | Flat, without visual effects. |
| 1 | Paints the control with three dimensional effects. |
### Comments
The Appearance property defines the control's border look.
The Appearance property affects the border drawn around the control. If the [BorderStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BorderStyle) property defines a border, the Appearance property will cause it to be painted using a 3D effect. If [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used, this property will cause a border to be displayed (if set to 1), rendered using the current theme's style.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property can be used to give items a 3D look.
> This property is read/only at run-time.
See Also SftTree Object | Object Hierarchy
## Appearance Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance*
Defines the appearance of all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**Appearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Style
Defines the appearance of all column footers.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | No column footers. The column footers and row/column footer are not displayed. The [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance) property is also set to headerSftTreeNone. |
| headerSftTreeButton | 1 | Displays column footers as buttons. The column footers are displayed as buttons, which can be clicked by the user. The status of the each column footer button can be controlled using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled) and Footer.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_RemainUp) properties. The currently pressed button can be defined using the [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Pressed) property. |
| headerSftTreeText | 2 | Displays column footers as titles. |
### Comments
The Appearance property defines the appearance of all column footers.
Individual column footers cannot override the appearance.
See Also SftTreeFooters Object | Object Hierarchy
## Appearance Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance*
Defines the appearance of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**Appearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Style
Defines the appearance of all column headers.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | No column headers. The column headers and row/column header are not displayed. The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is also set to headerSftTreeNone. |
| headerSftTreeButton | 1 | Displays column headers as buttons. The column headers are displayed as buttons, which can be clicked by the user. The status of the each column header button can be controlled using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) and Header.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) properties. The currently pressed button can be defined using the [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) property. |
| headerSftTreeText | 2 | Displays column headers as titles. |
### Comments
The Appearance property defines the appearance of all column headers.
Individual column headers cannot override the appearance.
See Also SftTreeHeaders Object | Object Hierarchy
## Appearance Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance*
Defines the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**Appearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Style
Defines the row/column footer's appearance.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | The row/column footer, column footers and [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) are not displayed. The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) properties are set to headerSftTreeNone and [rowheaderSftTreeNone](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants). |
| headerSftTreeButton | 1 | Displays the row/column footer as a button. The row/column footer is displayed as a button, which can be clicked by the user. The status of the row/column footer button can be controlled using the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Enabled) and RowColumnFooter.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_RemainUp) properties. The current button status can be defined using the RowColumnFooter.[ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ButtonDown) property. |
| headerSftTreeText | 2 | Displays the row/column footer as a title. |
### Comments
The Appearance property defines the row/column footer's appearance.
The width of the row/column footer (and row header area) is defined using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## Appearance Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**Appearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**Appearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Style
Defines the row/column header's appearance.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | The row/column header, column headers and [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) are not displayed. The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) properties are set to headerSftTreeNone and [rowheaderSftTreeNone](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants). |
| headerSftTreeButton | 1 | Displays the row/column header as a button. The row/column header is displayed as a button, which can be clicked by the user. The status of the row/column header button can be controlled using the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled) and RowColumnHeader.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) properties. The current button status can be defined using the RowColumnHeader.[ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ButtonDown) property. |
| headerSftTreeText | 2 | Displays the row/column header as a title. |
### Comments
The Appearance property defines the row/column header's appearance.
The width of the row/column header (and row header area) is defined using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## Appearance Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Appearance** **As [SftTreeRowHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**Appearance** **As SftTreeRowHeaderAppearanceConstants** |
| C#.NET | **SftTreeRowHeaderAppearanceConstants** *Style* = *object*.**Appearance**; |
| VC++ | **enum SftTreeRowHeaderAppearanceConstants** *Style* = *object*->**Appearance**;
**enum SftTreeRowHeaderAppearanceConstants** *Style* = *object*->Get**Appearance**(); |
| C | **HRESULT** *object*->get_**Appearance**(**enum SftTreeRowHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Appearance** = *Style* **As SftTreeRowHeaderAppearanceConstants** |
| VB | *object*.**Appearance** = *Style* **As SftTreeRowHeaderAppearanceConstants** |
| C#.NET | **SftTreeRowHeaderAppearanceConstants** *object*.**Appearance** = *Style*; |
| VC++ | **enum SftTreeRowHeaderAppearanceConstants** *object*->**Appearance** = *Style*;
**void** *object*->Put**Appearance**(**enum SftTreeRowHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**Appearance**(**enum SftTreeRowHeaderAppearanceConstants** *Style*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Style
Defines the row header appearance.
| Style | Value | Description |
| --- | --- | --- |
| rowheaderSftTreeNone | 0 | No row headers. The row headers and row/[column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) are not displayed. The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set to [headerSftTreeNone](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants). |
| rowheaderSftTreeButton | 1 | Displays row headers as buttons. The row header text is defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) property. |
| rowheaderSftTreeText | 2 | Displays row headers as titles. The row header text is defined using the RowHeader.Text property. |
| rowheaderSftTreeButtonCnt0 | 3 | Displays row headers as buttons. The row header text defaults to the zero-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeTextCnt0 | 4 | Displays row headers as titles. The row header text defaults to the zero-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeButtonCnt1 | 5 | Displays row headers as buttons. The row header text defaults to the one-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeTextCnt1 | 6 | Displays row headers as titles. The row header text defaults to the one-based index of the item and can be specified using the RowHeader.Text property. |
### Comments
The Appearance property defines the row header appearance.
If the [RowHeaderAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderAppearance) property is set to rowheaderSftTreeButton, rowheaderSftTreeButtonCnt0 or rowheaderSftTreeButtonCnt1, the row headers are displayed as buttons, which can be clicked by the user. Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The RowHeaderAppearance property applies to all row headers and cannot be changed for individual items.
The status of the row header buttons can be controlled using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) and RowHeaders.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_RemainUp) properties.
See Also SftTreeRowHeaders Object | Object Hierarchy
## AttachContentWindow Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_AttachContentWindow*
Attaches a [content window](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contentwindows) to the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**AttachContentWindow**(**ByVal** *Window* **As Integer**, **ByVal** *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* **As [SftTreeContentWindowStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeContentWindowStyleConstants)**) |
| VB | *object*.**AttachContentWindow**(**ByVal** *Window* **As OLE_HANDLE**, **ByVal** *Style* **As SftTreeContentWindowStyleConstants**) |
| C#.NET | **void** *object*.**AttachContentWindow**(**int** *Window*, **SftTreeContentWindowStyleConstants** *Style*); |
| VC++ | **HRESULT** *object*->**AttachContentWindow**(**OLE_HANDLE** *Window*, **enum SftTreeContentWindowStyleConstants** *Style*); |
| C | **HRESULT** *object*->raw_**AttachContentWindow**(**OLE_HANDLE** *Window*, **enum SftTreeContentWindowStyleConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Window
The window handle of the window to use for the cell as a content window. Specify NULL/Nothing to clear the cell's content window, so the cell's regular contents are shown instead.
Style
Defines options for the content window. Values of the following tables can be combined and used as *Style* value:
| Name | Value | Description |
| --- | --- | --- |
| contentWindowSftTreeNone | 0 | None - No special handling. |
| contentWindowSftTreeKeepDisabled | 1 | Keep Disabled - The content window is always disabled. A content window is normally enabled and disabled as it is made visible or hidden. When contentWindowSftTreeKeepDisabled is specified, the content window is always disabled, even when it is visible. |
| contentWindowSftTreeKeepSize | 2 | Keep Size ([Variable Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) Tree Control) - The original size of the content window is preserved and the cell size adjusts accordingly. While a column can still be smaller or larger than the content window width, the content window is not resized, it is merely clipped. Without contentWindowSftTreeKeepSize, a content window is resized in height and width to fit within the cell. contentWindowSftTreeKeepSize has no effect in a fixed height tree control. |
### Comments
The AttachContentWindow method attaches a content window to the cell.
If a content window is attached to a cell, the cell's regular contents (e.g., [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text)) are not shown.
The Cell.[GetContentWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetContentWindow) method can be used to retrieve a cell's current content window settings.
See Also SftTreeCell Object | Object Hierarchy
## AutoCancelDragging Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoCancelDragging*
Dragging has been canceled (automatic [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) only).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**AutoCancelDragging**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**AutoCancelDragging** |
| VB | **Private Sub** *object*_**AutoCancelDragging**() |
| C#.NET | **void** *object*_**AutoCancelDragging**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**AutoCancelDragging***object*(); |
| C | **HRESULT** On**AutoCancelDragging***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The AutoCancelDragging event occurs when dragging has been canceled (automatic DragMethod only).
This event is only available if the DragMethod property is set to [dragSftTreeAuto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants) and is suitable for [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) within one tree control only. If drag & drop between controls is desired, the container (i.e. Visual Basic, Visual C++, etc.) must implement the necessary drag & drop support (see DragMethod) or OLE drag & drop should be used instead.
This event signals that the drag & drop operation has been aborted. The user can abandon a drag & drop operation by pressing the ESCAPE key.
If the mouse pointer ([MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property) was modified during the [AutoDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging) event, the application must restore the original mouse pointer.
See Also SftTree Object | Object Hierarchy
## AutoDragging Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging*
Dragging in progress (automatic [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) only).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**AutoDragging**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**AutoDragging** |
| VB | **Private Sub** *object*_**AutoDragging**(**ByVal** *ItemIndex* **As Long**, **ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, *Allowed* **As Boolean**) |
| C#.NET | **void** *object*_**AutoDragging**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**AutoDragging***object*(**long** *ItemIndex*, **short** *Button*, **short** *Shift*, **VARIANT_BOOL*** *Allowed*); |
| C | **HRESULT** On**AutoDragging***object*(**long** *ItemIndex*, **short** *Button*, **short** *Shift*, **VARIANT_BOOL*** *Allowed*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index where the current [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) is located. This value may be -1 if there is no current drop target.
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
Allowed
Set to True to allow the item at *ItemIndex* to be a valid drop target, otherwise set to False. This value is passed to the [AutoEndDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoEndDragging) event as *Allowed* parameter. This value has no effect on the current mouse pointer used. The mouse pointer must be modified using the [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property.
### Comments
The AutoDragging event occurs when dragging in progress (automatic DragMethod only).
This event is only available if the DragMethod property is set to [dragSftTreeAuto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants) and is suitable for [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) within one tree control only. If drag & drop between controls is desired, the container (i.e. Visual Basic, Visual C++, etc.) must implement the necessary drag & drop support (see DragMethod) or OLE drag & drop should be used instead.
The drop target (and any other tree control properties) cannot be modified during this event. It signals that the mouse cursor has moved and that the user is attempting to drag the currently [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections)(s). You can override the MousePointer property in response to this event to provide visual feedback to the user.
The current drop target is displayed using the style defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) property.
See Also SftTree Object | Object Hierarchy
## AutoEndDragging Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoEndDragging*
Dragging has ended (automatic [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) only).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**AutoEndDragging**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**AutoEndDragging** |
| VB | **Private Sub** *object*_**AutoEndDragging**(**ByVal** *ItemIndex* **As Long**, **ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, **ByVal** *Allowed* **As Boolean**) |
| C#.NET | **void** *object*_**AutoEndDragging**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**AutoEndDragging***object*(**long** *ItemIndex*, **short** *Button*, **short** *Shift*, **VARIANT_BOOL** *Allowed*); |
| C | **HRESULT** On**AutoEndDragging***object*(**long** *ItemIndex*, **short** *Button*, **short** *Shift*, **VARIANT_BOOL** *Allowed*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index where the current [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) is located (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).DropHighlight or Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current)). This value may be -1 if there is no current drop target.
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
Allowed
Contains the value last set by the [AutoDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging) event.
### Comments
The AutoEndDragging event occurs when dragging has ended (automatic DragMethod only).
This event is only available if the DragMethod property is set to [dragSftTreeAuto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants) and is suitable for [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) within one tree control only. If drag & drop between controls is desired, the container (i.e. Visual Basic, Visual C++, etc.) must implement the necessary drag & drop support (see DragMethod) or OLE drag & drop should be used instead.
This event signals that the user has dropped the [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections)(s) at the item described by *ItemIndex*. The application can now move or copy items (using Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) or Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy)) as needed to reflect the drag & drop operation.
If the mouse pointer ([MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property) was modified during the AutoDragging event, the application must restore the original mouse pointer.
See Also SftTree Object | Object Hierarchy
## AutoExpandDragDrop Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDrop*
Defines whether items are automatically [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) during an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**AutoExpandDragDrop** **As Boolean** |
| VB | *Boolean* = *object*.**AutoExpandDragDrop** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**AutoExpandDragDrop**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**AutoExpandDragDrop**;
**VARIANT_BOOL** *Boolean* = *object*->Get**AutoExpandDragDrop**(); |
| C | **HRESULT** *object*->get_**AutoExpandDragDrop**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**AutoExpandDragDrop** = *Boolean* **As Boolean** |
| VB | *object*.**AutoExpandDragDrop** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**AutoExpandDragDrop** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**AutoExpandDragDrop** = *Boolean*;
**void** *object*->Put**AutoExpandDragDrop**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**AutoExpandDragDrop**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether items are automatically expanded during an OLE drag & drop operation.
| Boolean | Description |
| --- | --- |
| True | An expandable item is automatically expanded during a drag & drop operation, if the mouse cursor hovers over the item for an extended period of time. |
| False | [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are not automatically expanded. |
### Comments
The AutoExpandDragDrop property defines whether items are automatically expanded during an OLE drag & drop operation.
During a drag & drop operation, if the mouse cursor hovers over an expandable item for an extended period of time, the item can automatically be expanded based on the AutoExpandDragDrop property setting. This applies to drag & drop operations started by a SftTree/OCX control or any other data source. Once the drag & drop operation completes, the affected items remain expanded.
The [AutoExpandDragDropInterval](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDropInterval) property defines the delay (in milliseconds) after which items are automatically expanded during an OLE drag & drop operation.
The [AutoExpandHover](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHover) property defines whether items are automatically expanded when the mouse hovers over an item (outside of a drag & drop operation).
See Also SftTreeItems Object | Object Hierarchy
## AutoExpandDragDropInterval Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDropInterval*
Defines the delay (in milliseconds) after which items are automatically [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) during an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**AutoExpandDragDropInterval** **As Integer** |
| VB | *milliSeconds* = *object*.**AutoExpandDragDropInterval** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**AutoExpandDragDropInterval**; |
| VC++ | **long** *milliSeconds* = *object*->**AutoExpandDragDropInterval**;
**long** *milliSeconds* = *object*->Get**AutoExpandDragDropInterval**(); |
| C | **HRESULT** *object*->get_**AutoExpandDragDropInterval**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**AutoExpandDragDropInterval** = *milliSeconds* **As Integer** |
| VB | *object*.**AutoExpandDragDropInterval** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**AutoExpandDragDropInterval** = *milliSeconds*; |
| VC++ | **long** *object*->**AutoExpandDragDropInterval** = *milliSeconds*;
**void** *object*->Put**AutoExpandDragDropInterval**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**AutoExpandDragDropInterval**(**long** *milliSeconds*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
milliSeconds
Defines the delay (in milliseconds) after which items are automatically expanded during an OLE drag & drop operation. If 0 is specified, the default of 1200 milliseconds is used instead.
### Comments
The AutoExpandDragDropInterval property defines the delay (in milliseconds) after which items are automatically expanded during an OLE drag & drop operation.
The [AutoExpandDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDrop) property defines whether items are automatically expanded during an OLE drag & drop operation.
See Also SftTreeItems Object | Object Hierarchy
## AutoExpandHover Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHover*
Defines whether items are automatically [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) when the mouse cursor hovers over an item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**AutoExpandHover** **As Boolean** |
| VB | *Boolean* = *object*.**AutoExpandHover** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**AutoExpandHover**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**AutoExpandHover**;
**VARIANT_BOOL** *Boolean* = *object*->Get**AutoExpandHover**(); |
| C | **HRESULT** *object*->get_**AutoExpandHover**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**AutoExpandHover** = *Boolean* **As Boolean** |
| VB | *object*.**AutoExpandHover** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**AutoExpandHover** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**AutoExpandHover** = *Boolean*;
**void** *object*->Put**AutoExpandHover**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**AutoExpandHover**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether items are automatically expanded when the mouse cursor hovers over an item.
| Boolean | Description |
| --- | --- |
| True | An expandable item is automatically expanded, if the mouse cursor hovers over the item for an extended period of time. |
| False | [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are not automatically expanded. |
### Comments
The AutoExpandHover property defines whether items are automatically expanded when the mouse cursor hovers over an item.
If the mouse cursor hovers over an expandable item for an extended period of time, the item can automatically be expanded based on the AutoExpandHover property setting.
The [AutoExpandHoverInterval](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHoverInterval) property defines the delay (in milliseconds) after which items are automatically expanded when the mouse cursor hovers over an item.
The [AutoExpandDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandDragDrop) property defines whether items are automatically expanded during [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop).
See Also SftTreeItems Object | Object Hierarchy
## AutoExpandHoverInterval Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHoverInterval*
Defines the delay (in milliseconds) after which items are automatically [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) when the mouse cursor hovers over an item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**AutoExpandHoverInterval** **As Integer** |
| VB | *milliSeconds* = *object*.**AutoExpandHoverInterval** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**AutoExpandHoverInterval**; |
| VC++ | **long** *milliSeconds* = *object*->**AutoExpandHoverInterval**;
**long** *milliSeconds* = *object*->Get**AutoExpandHoverInterval**(); |
| C | **HRESULT** *object*->get_**AutoExpandHoverInterval**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**AutoExpandHoverInterval** = *milliSeconds* **As Integer** |
| VB | *object*.**AutoExpandHoverInterval** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**AutoExpandHoverInterval** = *milliSeconds*; |
| VC++ | **long** *object*->**AutoExpandHoverInterval** = *milliSeconds*;
**void** *object*->Put**AutoExpandHoverInterval**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**AutoExpandHoverInterval**(**long** *milliSeconds*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
milliSeconds
Defines the delay (in milliseconds) after which items are automatically expanded when the mouse cursor hovers over an item. If 0 is specified, the default of 1200 milliseconds is used instead.
### Comments
The AutoExpandHoverInterval property defines the delay (in milliseconds) after which items are automatically expanded when the mouse cursor hovers over an item.
The [AutoExpandHover](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_AutoExpandHover) property defines whether items are automatically expanded when the mouse cursor hovers over an item.
See Also SftTreeItems Object | Object Hierarchy
## AutoRespond Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AutoRespond*
Defines whether the tree control expands and collapses items automatically.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**AutoRespond** **As Boolean** |
| VB | *Boolean* = *object*.**AutoRespond** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**AutoRespond**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**AutoRespond**;
**VARIANT_BOOL** *Boolean* = *object*->Get**AutoRespond**(); |
| C | **HRESULT** *object*->get_**AutoRespond**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**AutoRespond** = *Boolean* **As Boolean** |
| VB | *object*.**AutoRespond** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**AutoRespond** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**AutoRespond** = *Boolean*;
**void** *object*->Put**AutoRespond**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**AutoRespond**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the tree control expands and collapses items automatically.
| Boolean | Description |
| --- | --- |
| True | The tree control expands and collapses items automatically. Certain [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) or [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events are no longer generated. |
| False | The tree control does not expand and collapse items automatically. ItemClick or ItemDblClick events can be used to implement expanding and [collapsing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) items. |
### Comments
The AutoRespond property defines whether the tree control expands and collapses items automatically.
The AutoRespond property is used to handle the certain events automatically by expanding or collapsing an item. If the AutoRespond property is set to True, the corresponding ItemClick or ItemDblClick event is no longer generated.
If a more sophisticated response should be implemented, AutoRespond has to be set to False and all necessary event handlers have to be implemented by the application.
If AutoRespond is set to True, items are expanded or collapsed using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) method.
See Also SftTree Object | Object Hierarchy
## BackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackColor*
Defines the default background color used to draw items that are not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default background color used to draw items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.BackColor instead
The BackColor property defines the default background color used to draw items that are not selected.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the default background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property for only portions of the item, the BackColor property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## BackColor Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s background color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's background color. -1 indicates that there is no defined color and the default color defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) is used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the cell's background color.
The cell has the background color attribute *Clr*. This color is used as background color when the item is not selected. If the item is selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property is used instead.
The Cell.[BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd) property can be used to define the cell's background color, combined with BackColor creating a gradient fill. The orientation of the gradient fill can be defined using the Cell.[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) property.
See Also SftTreeCell Object | Object Hierarchy
## BackColor Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor*
Defines the background color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the background color of cells in this column. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the background color of cells in this column.
The BackColor property defines the background color of cells in this column for items that are not selected. Cells can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property for only portions of the item, the BackColor property is used for the remainder of the item.
The BackColor property can be used to define the default background color of cells in this column, combined with [BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorEnd) creating a gradient fill.
See Also SftTreeColumn Object | Object Hierarchy
## BackColor Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor*
Defines the background color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the background color for this column footer. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the background color for this column footer.
The color defined overrides the default color for column footers defined using [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Footers.BackColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Footer.[BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColorDisabled) property can be used to define the background color for this column footer, when it is disabled.
See Also SftTreeFooter Object | Object Hierarchy
## BackColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_BackColor*
Defines the background color for all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the background color for all column footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the background color for all column footers. Column footers can override the background color using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor) property.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background.
See Also SftTreeFooters Object | Object Hierarchy
## BackColor Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor*
Defines the background color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the background color for this column header. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the background color for this column header.
The color defined overrides the default color for column headers defined using [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Headers.BackColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Header.[BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColorDisabled) property can be used to define the background color for this column header, when it is disabled.
See Also SftTreeHeader Object | Object Hierarchy
## BackColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_BackColor*
Defines the background color for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the background color for all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the background color for all column headers. Column headers can override the background color using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor) property.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background.
See Also SftTreeHeaders Object | Object Hierarchy
## BackColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor*
Defines the default background color used to draw items that are not selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the default background color used to draw items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the default background color used to draw items that are not selected.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the default background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property for only portions of the item, the BackColor property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## BackColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_BackColor*
Defines the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s background color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the row/column footer's background color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the row/column footer's background color.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## BackColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_BackColor*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s background color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the row/column header's background color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the row/column header's background color.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## BackColor Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s background color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Clr
Defines the row header's background color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the row header's background color.
The row header has the background color attribute *Clr*. This color is used as background color when the item is not selected. If the item is selected, the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) property is used instead.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_BackColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background. The RowHeader.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme) property can be used to override Windows themes so defined colors are used instead.
See Also SftTreeRowHeader Object | Object Hierarchy
## BackColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_BackColor*
Defines the default background color used to draw [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) of items that are not selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColor**;
**OLE_COLOR** *Clr* = *object*->Get**BackColor**(); |
| C | **HRESULT** *object*->get_**BackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColor** = *Clr* **As UInteger** |
| VB | *object*.**BackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColor** = *Clr*;
**void** *object*->Put**BackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default background color used to draw row headers of items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColor property defines the default background color used to draw row headers of items that are not selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header background color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) property.
This property may have no effect when [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. Certain semi-transparent themes use this color for portions of the background.
See Also SftTreeRowHeaders Object | Object Hierarchy
## BackColorDisabled Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColorDisabled*
Defines the background color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), when it is disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorDisabled** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorDisabled** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColorDisabled**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorDisabled**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorDisabled**(); |
| C | **HRESULT** *object*->get_**BackColorDisabled**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorDisabled** = *Clr* **As UInteger** |
| VB | *object*.**BackColorDisabled** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColorDisabled** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorDisabled** = *Clr*;
**void** *object*->Put**BackColorDisabled**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorDisabled**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the background color for this column footer, when it is disabled. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColorDisabled property defines the background color for this column footer, when it is disabled.
If the column footer is disabled, the color defined using the BackColorDisabled property overrides the default color for this column footer defined using [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Footer.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Footer.BackColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Footer.BackColor property can be used to define the background color for this column footer, when it is not disabled.
See Also SftTreeFooter Object | Object Hierarchy
## BackColorDisabled Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColorDisabled*
Defines the background color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), when it is disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorDisabled** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorDisabled** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColorDisabled**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorDisabled**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorDisabled**(); |
| C | **HRESULT** *object*->get_**BackColorDisabled**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorDisabled** = *Clr* **As UInteger** |
| VB | *object*.**BackColorDisabled** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColorDisabled** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorDisabled** = *Clr*;
**void** *object*->Put**BackColorDisabled**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorDisabled**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the background color for this column header, when it is disabled. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColorDisabled property defines the background color for this column header, when it is disabled.
If the column header is disabled, the color defined using the BackColorDisabled property overrides the default color for this column header defined using [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Header.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Header.BackColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Header.BackColor property can be used to define the background color for this column header, when it is not disabled.
See Also SftTreeHeader Object | Object Hierarchy
## BackColorEnd Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s background color, combined with BackColor creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorEnd**(); |
| C | **HRESULT** *object*->get_**BackColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**BackColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorEnd** = *Clr*;
**void** *object*->Put**BackColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's background color, combined with BackColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColorEnd property defines the cell's background color, combined with [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) creating a gradient fill.
The Cell.BackColor property can be used to define the cell's background color, combined with BackColorEnd creating a gradient fill. The orientation of the gradient fill can be defined using the Cell.[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) property. If Cell.BackColor is not defined, BackColorEnd is ignored and has no effect.
See Also SftTreeCell Object | Object Hierarchy
## BackColorEnd Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorEnd*
Defines the default background color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column, combined with [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorEnd**(); |
| C | **HRESULT** *object*->get_**BackColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**BackColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorEnd** = *Clr*;
**void** *object*->Put**BackColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the default background color of cells in this column, combined with BackColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColorEnd property defines the default background color of cells in this column, combined with BackColor creating a gradient fill.
Cells can override the ending background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd) property.
See Also SftTreeColumn Object | Object Hierarchy
## BackColorOdd Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackColorOdd*
Defines the background color used to draw items in odd rows.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[BackColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColorOdd) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorOdd** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorOdd** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**BackColorOdd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorOdd**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorOdd**(); |
| C | **HRESULT** *object*->get_**BackColorOdd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorOdd** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**BackColorOdd** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**BackColorOdd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorOdd** = *Clr*;
**void** *object*->Put**BackColorOdd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorOdd**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the background color used to draw items in odd rows. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.BackColorOdd instead
The BackColorOdd property defines the background color used to draw items in odd rows.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property for only portions of the item, the Items.BackColorOdd property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## BackColorOdd Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColorOdd*
Defines the background color used to draw items in odd rows.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**BackColorOdd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**BackColorOdd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**BackColorOdd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**BackColorOdd**;
**OLE_COLOR** *Clr* = *object*->Get**BackColorOdd**(); |
| C | **HRESULT** *object*->get_**BackColorOdd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorOdd** = *Clr* **As UInteger** |
| VB | *object*.**BackColorOdd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**BackColorOdd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**BackColorOdd** = *Clr*;
**void** *object*->Put**BackColorOdd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**BackColorOdd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the background color used to draw items in odd rows. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackColorOdd property defines the background color used to draw items in odd rows.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property for only portions of the item, the BackColorOdd property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## BackColorOrientation Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s background gradient fill orientation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**BackColorOrientation** **As [SftTreeOrientationDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationDefaultConstants)** |
| VB | *Style* = *object*.**BackColorOrientation** **As SftTreeOrientationDefaultConstants** |
| C#.NET | **SftTreeOrientationDefaultConstants** *Style* = *object*.**BackColorOrientation**; |
| VC++ | **enum SftTreeOrientationDefaultConstants** *Style* = *object*->**BackColorOrientation**;
**enum SftTreeOrientationDefaultConstants** *Style* = *object*->Get**BackColorOrientation**(); |
| C | **HRESULT** *object*->get_**BackColorOrientation**(**enum SftTreeOrientationDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorOrientation** = *Style* **As SftTreeOrientationDefaultConstants** |
| VB | *object*.**BackColorOrientation** = *Style* **As SftTreeOrientationDefaultConstants** |
| C#.NET | **SftTreeOrientationDefaultConstants** *object*.**BackColorOrientation** = *Style*; |
| VC++ | **enum SftTreeOrientationDefaultConstants** *object*->**BackColorOrientation** = *Style*;
**void** *object*->Put**BackColorOrientation**(**enum SftTreeOrientationDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**BackColorOrientation**(**enum SftTreeOrientationDefaultConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the cell's background gradient fill orientation.
| Name | Value | Description |
| --- | --- | --- |
| defaultOrientationSftTree | -1 | (Default) - The default orientation defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorOrientation) is used. |
| horizontalDefaultOrientationSftTree | 0 | Horizontal - The gradient fill orientation is horizontal, starting at the left using [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) and ending at the right edge of the cell using Cell.[BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd) (reversed when using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) rendering). |
| verticalDefaultOrientationSftTree | 1 | Vertical - The gradient fill orientation is vertical, starting at the top using Cell.BackColor and ending at the bottom edge of the cell using Cell.BackColorEnd. |
### Comments
The BackColorOrientation property defines the cell's background gradient fill orientation.
See Also SftTreeCell Object | Object Hierarchy
## BackColorOrientation Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorOrientation*
Defines the default background gradient fill orientation of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**BackColorOrientation** **As [SftTreeOrientationConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationConstants)** |
| VB | *Style* = *object*.**BackColorOrientation** **As SftTreeOrientationConstants** |
| C#.NET | **SftTreeOrientationConstants** *Style* = *object*.**BackColorOrientation**; |
| VC++ | **enum SftTreeOrientationConstants** *Style* = *object*->**BackColorOrientation**;
**enum SftTreeOrientationConstants** *Style* = *object*->Get**BackColorOrientation**(); |
| C | **HRESULT** *object*->get_**BackColorOrientation**(**enum SftTreeOrientationConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackColorOrientation** = *Style* **As SftTreeOrientationConstants** |
| VB | *object*.**BackColorOrientation** = *Style* **As SftTreeOrientationConstants** |
| C#.NET | **SftTreeOrientationConstants** *object*.**BackColorOrientation** = *Style*; |
| VC++ | **enum SftTreeOrientationConstants** *object*->**BackColorOrientation** = *Style*;
**void** *object*->Put**BackColorOrientation**(**enum SftTreeOrientationConstants** *Style*); |
| C | **HRESULT** *object*->put_**BackColorOrientation**(**enum SftTreeOrientationConstants** *Style*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Style
Defines the default background gradient fill orientation of cells in this column.
| Name | Value | Description |
| --- | --- | --- |
| horizontalOrientationSftTree | 0 | Horizontal - The gradient fill orientation is horizontal, starting at the left using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) and ending at the right edge of the cell using Column.[BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColorEnd) (reversed when using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) rendering). |
| verticalOrientationSftTree | 1 | Vertical - The gradient fill orientation is vertical, starting at the top using Column.BackColor and ending at the bottom edge of the cell using Column.[BackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorEnd). |
### Comments
The BackColorOrientation property defines the default background gradient fill orientation of cells in this column.
Cells can override the default background gradient fill orientation using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) property.
See Also SftTreeColumn Object | Object Hierarchy
## BackgroundPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture*
Defines the graphic displayed as the control's background.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**BackgroundPicture** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**BackgroundPicture** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**BackgroundPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**BackgroundPicture**(); |
| C | **HRESULT** *object*->get_**BackgroundPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**BackgroundPicture**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**BackgroundPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**BackgroundPicture**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**BackgroundPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**BackgroundPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**BackgroundPicture** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**BackgroundPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**BackgroundPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**BackgroundPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**BackgroundPicture**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
A [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object. This Picture object contains the graphic used as the control's background. The * refPictureObj* object must represent a bitmap and cannot represent an icon or a metafile. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The BackgroundPicture property defines the graphic displayed as the control's background.
The BackgroundPicture and [BackgroundPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
If the Background property defines a valid bitmap, this bitmap is displayed as the tree control's background. If the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap) is too small to fill the entire client area of the tree control, it is tiled. The properties [BackgroundX](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundX) and [BackgroundY](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundY) can be used to define an offset with which the bitmap should be aligned. The background bitmap is aligned with the top, left edge of the tree control window (not the client area) if 0 is specified.
The [BackgroundStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle) property defines whether the bitmap is centered or should be scrolled horizontally when the tree control contents are scrolled horizontally.
The [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area, row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) area and column header do not display the background bitmap. These areas are not transparent.
There is no default background bitmap. [Bitmap transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency) is not used for the background bitmap.
If a background bitmap is used, the background colors defined for the tree control, columns and [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) should be set to the default values, so these do not interfere with the background bitmap.
When using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) for [right-to-left reading support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rtl), the bitmap origin is the top, right corner of the tree control window. The properties BackgroundX and BackgroundY specify offsets relative to the top, right edge of the tree control window. In this case, the bitmap is also tiled right to left.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## BackgroundPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPictureH*
Defines the graphic displayed as the control's background.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**BackgroundPictureH** **As Integer** |
| VB | *Handle* = *object*.**BackgroundPictureH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**BackgroundPictureH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**BackgroundPictureH**;
**OLE_HANDLE** *Handle* = *object*->Get**BackgroundPictureH**(); |
| C | **HRESULT** *object*->get_**BackgroundPictureH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackgroundPictureH** = *Handle* **As Integer** |
| VB | *object*.**BackgroundPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**BackgroundPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**BackgroundPictureH** = *Handle*;
**void** *object*->Put**BackgroundPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**BackgroundPictureH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. This bitmap contains the graphic used as the control's background. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed.
### Comments
The BackgroundPictureH property defines the graphic displayed as the control's background.
The [BackgroundPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture) and BackgroundPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
If the Background property defines a valid bitmap, this bitmap is displayed as the tree control's background. If the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap) is too small to fill the entire client area of the tree control, it is tiled. The properties [BackgroundX](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundX) and [BackgroundY](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundY) can be used to define an offset with which the bitmap should be aligned. The background bitmap is aligned with the top, left edge of the tree control window (not the client area) if 0 is specified.
The [BackgroundStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle) property defines whether the bitmap is centered or should be scrolled horizontally when the tree control contents are scrolled horizontally.
The [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area, row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) area and column header do not display the background bitmap. These areas are not transparent.
There is no default background bitmap. [Bitmap transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency) is not used for the background bitmap.
If a background bitmap is used, the background colors defined for the tree control, columns and [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) should be set to the default values, so these do not interfere with the background bitmap.
When using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) for [right-to-left reading support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rtl), the bitmap origin is the top, right corner of the tree control window. The properties BackgroundX and BackgroundY specify offsets relative to the top, right edge of the tree control window. In this case, the bitmap is also tiled right to left.
See Also SftTree Object | Object Hierarchy
## BackgroundStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle*
Defines the scrolling style of the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**BackgroundStyle** **As [SftTreeBackgroundStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeBackgroundStyleConstants)** |
| VB | *Style* = *object*.**BackgroundStyle** **As SftTreeBackgroundStyleConstants** |
| C#.NET | **SftTreeBackgroundStyleConstants** *Style* = *object*.**BackgroundStyle**; |
| VC++ | **enum SftTreeBackgroundStyleConstants** *Style* = *object*->**BackgroundStyle**;
**enum SftTreeBackgroundStyleConstants** *Style* = *object*->Get**BackgroundStyle**(); |
| C | **HRESULT** *object*->get_**BackgroundStyle**(**enum SftTreeBackgroundStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackgroundStyle** = *Style* **As SftTreeBackgroundStyleConstants** |
| VB | *object*.**BackgroundStyle** = *Style* **As SftTreeBackgroundStyleConstants** |
| C#.NET | **SftTreeBackgroundStyleConstants** *object*.**BackgroundStyle** = *Style*; |
| VC++ | **enum SftTreeBackgroundStyleConstants** *object*->**BackgroundStyle** = *Style*;
**void** *object*->Put**BackgroundStyle**(**enum SftTreeBackgroundStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**BackgroundStyle**(**enum SftTreeBackgroundStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the scrolling style of the background bitmap.
| Style | Value | Description |
| --- | --- | --- |
| backSftTreeNone | 0 | The bitmap is never scrolled horizontally and is aligned with the top/left edge of the tree control window (or the offset defined using the properties [BackgroundX](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundX) and [BackgroundY](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundY)). |
| backSftTreeHScroll | 1 | The bitmap is aligned with the top/left edge of the tree control window (or the offset defined using the properties BackgroundX and BackgroundY) and the alignment is further adjusted by the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset)) resulting in horizontal scrolling of the background. |
| backSftTreeCenter | 2 | The bitmap is centered vertically and horizontally within the available area. [Bitmap transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency) is used for the bitmap when used with this style. |
### Comments
The BackgroundStyle property defines the scrolling style of the background bitmap.
If a background picture has been defined using the [BackgroundPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture) property, the BackgroundStyle property defines the bitmap positioning and behavior when the tree control contents are scrolled horizontally.
See Also SftTree Object | Object Hierarchy
## BackgroundX Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundX*
Defines the origin (horizontally) of the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *XOrigin* = *object*.**BackgroundX** **As Single** |
| VB | *XOrigin* = *object*.**BackgroundX** **As Single** |
| C#.NET | **float** *XOrigin* = *object*.**BackgroundX**; |
| VC++ | **float** *XOrigin* = *object*->**BackgroundX**;
**float** *XOrigin* = *object*->Get**BackgroundX**(); |
| C | **HRESULT** *object*->get_**BackgroundX**(**float*** *XOrigin*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackgroundX** = *XOrigin* **As Single** |
| VB | *object*.**BackgroundX** = *XOrigin* **As Single** |
| C#.NET | **float** *object*.**BackgroundX** = *XOrigin*; |
| VC++ | **float** *object*->**BackgroundX** = *XOrigin*;
**void** *object*->Put**BackgroundX**(**float** *XOrigin*); |
| C | **HRESULT** *object*->put_**BackgroundX**(**float** *XOrigin*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
XOrigin
Defines the origin (horizontally) of the background bitmap. If 0 is specified, the background bitmap is aligned with the top/left edge of the tree control window. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The BackgroundX property defines the origin (horizontally) of the background bitmap.
The [BackgroundPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture) property defines the graphic displayed as the control's background. The [BackgroundStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle) property affects how the bitmap is displayed when the tree control is scrolled horizontally.
See Also SftTree Object | Object Hierarchy
## BackgroundY Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundY*
Defines the origin (vertically) of the [background bitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_background_bitmap).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *YOrigin* = *object*.**BackgroundY** **As Single** |
| VB | *YOrigin* = *object*.**BackgroundY** **As Single** |
| C#.NET | **float** *YOrigin* = *object*.**BackgroundY**; |
| VC++ | **float** *YOrigin* = *object*->**BackgroundY**;
**float** *YOrigin* = *object*->Get**BackgroundY**(); |
| C | **HRESULT** *object*->get_**BackgroundY**(**float*** *YOrigin*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BackgroundY** = *YOrigin* **As Single** |
| VB | *object*.**BackgroundY** = *YOrigin* **As Single** |
| C#.NET | **float** *object*.**BackgroundY** = *YOrigin*; |
| VC++ | **float** *object*->**BackgroundY** = *YOrigin*;
**void** *object*->Put**BackgroundY**(**float** *YOrigin*); |
| C | **HRESULT** *object*->put_**BackgroundY**(**float** *YOrigin*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
YOrigin
Defines the origin (vertically) of the background bitmap. If 0 is specified, the background bitmap is aligned with the top/left edge of the tree control window. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The BackgroundY property defines the origin (vertically) of the background bitmap.
The [BackgroundPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundPicture) property defines the graphic displayed as the control's background. The [BackgroundStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackgroundStyle) property affects how the bitmap is displayed when the tree control is scrolled horizontally.
See Also SftTree Object | Object Hierarchy
## BitmapHandle Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle*
Defines the image object using a bitmap handle.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *hBitmap* = *object*.**BitmapHandle** **As Integer** |
| VB | *hBitmap* = *object*.**BitmapHandle** **As OLE_HANDLE** |
| C#.NET | **int** *hBitmap* = *object*.**BitmapHandle**; |
| VC++ | **OLE_HANDLE** *hBitmap* = *object*->**BitmapHandle**;
**OLE_HANDLE** *hBitmap* = *object*->Get**BitmapHandle**(); |
| C | **HRESULT** *object*->get_**BitmapHandle**(**OLE_HANDLE*** *hBitmap*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BitmapHandle** = *hBitmap* **As Integer** |
| VB | *object*.**BitmapHandle** = *hBitmap* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**BitmapHandle** = *hBitmap*; |
| VC++ | **OLE_HANDLE** *object*->**BitmapHandle** = *hBitmap*;
**void** *object*->Put**BitmapHandle**(**OLE_HANDLE** *hBitmap*); |
| C | **HRESULT** *object*->put_**BitmapHandle**(**OLE_HANDLE** *hBitmap*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
hBitmap
Defines the image object using a bitmap handle. The bitmap handle can be NULL, in which case the SftPictureObject object is cleared.
### Comments
The BitmapHandle property defines the image object using a bitmap handle.
Typically, .NET applications use the [NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) property to define an image, C and C++ applications use BitmapHandle or [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image), VB6 and other COM applications use the [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) property.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeBitmap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
See Also SftPictureObject Object | Object Hierarchy
## BorderStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BorderStyle*
Defines the tree control's border style used.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**BorderStyle** **As Short** |
| VB | *Style* = *object*.**BorderStyle** **As Integer** |
| C#.NET | **short** *Style* = *object*.**BorderStyle**; |
| VC++ | **short** *Style* = *object*->**BorderStyle**;
**short** *Style* = *object*->Get**BorderStyle**(); |
| C | **HRESULT** *object*->get_**BorderStyle**(**short*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BorderStyle** = *Style* **As Short** |
| VB | *object*.**BorderStyle** = *Style* **As Integer** |
| C#.NET | **short** *object*.**BorderStyle** = *Style*; |
| VC++ | **short** *object*->**BorderStyle** = *Style*;
**void** *object*->Put**BorderStyle**(**short** *Style*); |
| C | **HRESULT** *object*->put_**BorderStyle**(**short** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the tree control's border style used.
| Style | Description |
| --- | --- |
| 0 | None. The tree control does not have a border. |
| 1 | Paints the control with a border. |
### Comments
The BorderStyle property defines the tree control's border style used.
The tree control's border can be controlled by the [Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Appearance) property. Depending on the Appearance property, the tree control's border is a fixed, single line or a 3D style border.
If [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used, this property will cause a border to be displayed (if set to 1), rendered using the current theme's style.
> This property is read/only at run-time.
See Also SftTree Object | Object Hierarchy
## BulkUpdate Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate*
Defines bulk update mode.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**BulkUpdate** **As Boolean** |
| VB | *Boolean* = *object*.**BulkUpdate** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**BulkUpdate**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**BulkUpdate**;
**VARIANT_BOOL** *Boolean* = *object*->Get**BulkUpdate**(); |
| C | **HRESULT** *object*->get_**BulkUpdate**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**BulkUpdate** = *Boolean* **As Boolean** |
| VB | *object*.**BulkUpdate** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**BulkUpdate** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**BulkUpdate** = *Boolean*;
**void** *object*->Put**BulkUpdate**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**BulkUpdate**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines bulk update mode.
| Boolean | Description |
| --- | --- |
| True | A mass-update is in progress. |
| False | A mass-update is not in progress. |
### Comments
The BulkUpdate property defines bulk update mode.
The BulkUpdate property should be used when many items are added to a tree control or other lengthy operations are performed. By setting the property to True, the tree control can skip certain internal processing. Once updates are completed, the property has to be set to False. When adding, inserting or deleting items and when changing the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property, the tree control may have to do an extensive scan of parent items to determine if the current (visual) presentation has to be changed. This processing can be skipped when the BulkUpdate property is set to True, considerably speeding up the process.
After updating the tree control, the BulkUpdate property must be set to False. If the property remains set to True, the tree control will no longer redraw itself properly.
The BulkUpdate property is automatically reset to False whenever the control's [Refresh](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Refresh) method is used and when the [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font), [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Font) or [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Font) properties are changed.
This property is not available at design-time.
See Also SftTree Object | Object Hierarchy
## Button Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Button*
Defines the [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s button appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Button** **As **[SftTreeFooterButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeFooterButtonConstants)**** |
| VB | *Style* = *object*.**Button** **As SftTreeFooterButtonConstants** |
| C#.NET | **SftTreeFooterButtonConstants** *Style* = *object*.**Button**; |
| VC++ | **enum SftTreeFooterButtonConstants** *Style* = *object*->**Button**;
**enum SftTreeFooterButtonConstants** *Style* = *object*->Get**Button**(); |
| C | **HRESULT** *object*->get_**Button**(**enum SftTreeFooterButtonConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Button** = *Style* **As SftTreeFooterButtonConstants** |
| VB | *object*.**Button** = *Style* **As SftTreeFooterButtonConstants** |
| C#.NET | **SftTreeFooterButtonConstants** *object*.**Button** = *Style*; |
| VC++ | **enum SftTreeFooterButtonConstants** *object*->**Button** = *Style*;
**void** *object*->Put**Button**(**enum SftTreeFooterButtonConstants** *Style*); |
| C | **HRESULT** *object*->put_**Button**(**enum SftTreeFooterButtonConstants** *Style*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Style
Defines the column footer's button appearance.
| Name | Value | Description |
| --- | --- | --- |
| footerButtonSftTreeNone | 0 | None. No [footer dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) is shown. |
| footerButtonSftTreeDropDown | 1 | DropDown. The footer displays a footer dropdown button. |
| footerButtonSftTreeFilter | 2 | Filter. The footer displays a footer filter button. |
### Comments
The Button property defines the column footer's button appearance.
See Also SftTreeFooter Object | Object Hierarchy
## Button Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Button*
Defines the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s button appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Button** **As **[SftTreeHeaderButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderButtonConstants)**** |
| VB | *Style* = *object*.**Button** **As SftTreeHeaderButtonConstants** |
| C#.NET | **SftTreeHeaderButtonConstants** *Style* = *object*.**Button**; |
| VC++ | **enum SftTreeHeaderButtonConstants** *Style* = *object*->**Button**;
**enum SftTreeHeaderButtonConstants** *Style* = *object*->Get**Button**(); |
| C | **HRESULT** *object*->get_**Button**(**enum SftTreeHeaderButtonConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Button** = *Style* **As SftTreeHeaderButtonConstants** |
| VB | *object*.**Button** = *Style* **As SftTreeHeaderButtonConstants** |
| C#.NET | **SftTreeHeaderButtonConstants** *object*.**Button** = *Style*; |
| VC++ | **enum SftTreeHeaderButtonConstants** *object*->**Button** = *Style*;
**void** *object*->Put**Button**(**enum SftTreeHeaderButtonConstants** *Style*); |
| C | **HRESULT** *object*->put_**Button**(**enum SftTreeHeaderButtonConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the column header's button appearance.
| Name | Value | Description |
| --- | --- | --- |
| headerButtonSftTreeNone | 0 | None. No [header dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) is shown. |
| headerButtonSftTreeDropDown | 1 | DropDown. The header displays a header dropdown button. |
| headerButtonSftTreeFilter | 2 | Filter. The header displays a header filter button. |
### Comments
The Button property defines the column header's button appearance.
See Also SftTreeHeader Object | Object Hierarchy
## ButtonAppearance Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ButtonAppearance** **As [SftTreeButtonAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants)** |
| VB | *Style* = *object*.**ButtonAppearance** **As SftTreeButtonAppearanceConstants** |
| C#.NET | **SftTreeButtonAppearanceConstants** *Style* = *object*.**ButtonAppearance**; |
| VC++ | **enum SftTreeButtonAppearanceConstants** *Style* = *object*->**ButtonAppearance**;
**enum SftTreeButtonAppearanceConstants** *Style* = *object*->Get**ButtonAppearance**(); |
| C | **HRESULT** *object*->get_**ButtonAppearance**(**enum SftTreeButtonAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonAppearance** = *Style* **As SftTreeButtonAppearanceConstants** |
| VB | *object*.**ButtonAppearance** = *Style* **As SftTreeButtonAppearanceConstants** |
| C#.NET | **SftTreeButtonAppearanceConstants** *object*.**ButtonAppearance** = *Style*; |
| VC++ | **enum SftTreeButtonAppearanceConstants** *object*->**ButtonAppearance** = *Style*;
**void** *object*->Put**ButtonAppearance**(**enum SftTreeButtonAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**ButtonAppearance**(**enum SftTreeButtonAppearanceConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the expand/collapse button appearance.
| Style | Value | Description |
| --- | --- | --- |
| buttonsSftTreeUserImages | -1 | User defined button images - Expand/collapse buttons are defined using the properties [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded), [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) (and optionally the properties [ButtonExpandedDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedDown), [ButtonCollapsedDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedDown), [ButtonExpandedHot](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedHot), [ButtonCollapsedHot](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedHot)). |
| buttonsSftTreeClassicSmall | 0 | Classic small button - Small gray button image with + and - symbols. |
| buttonsSftTreeClassicWide | 1 | Classic wide button - Wide gray button image with + and - symbols. |
| buttonsSftTreeClassicLarge | 2 | Classic large buttons - Large gray button image with up and down symbols |
| buttonsSftTreeSimple | 3 | Simple - White box with + and - symbols, similar to the classic Windows Explorer look |
| buttonsSftTreeModern | 4 | Modern (using bitmaps) - The button style is not based on a bitmap. It is rendered by Windows. **Note:** The button will always be rendered using the buttonsSftTreeClassicSmall style, as standard buttons supported by most themes are not suitable for use as expand/collapse buttons due to their small size. |
| buttonsSftTreeThemeImitation | 5 | Theme imitation (using bitmaps) - Button image as used on Windows XP. This style is not limited to Windows XP as it is based on a bitmap. No actual [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. |
| buttonsSftTreeAutoThemeImitation | 6 | Automatic theme imitation (using bitmaps) - Depending on the available features, the control selects the appropriate button style. With themes, buttonsSftTreeThemeImitation is selected. If themes are not available, buttonsSftTreeModern is selected. |
| buttonsSftTreeAutoTheme | 7 | Automatic theme - Depending on the available features, the control selects the appropriate button style. With themes, the button image is rendered using the currently selected Windows theme. If themes are not available, buttonsSftTreeSimple is selected. For a look similar to Windows Explorer, select buttonsSftTreeAutoThemeVista instead. |
| buttonsSftTreeAutoThemeVista | 8 | Automatic theme (Vista+) - Depending on the available features, the control selects the appropriate button style. With themes, a look similar to Windows Explorer is used (based on [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) images). If themes are not available, buttonsSftTreeSimple is selected. |
### Comments
The ButtonAppearance property defines the expand/collapse button appearance.
All items use the same expand/collapse bitmap. Expand/collapse buttons are only shown if enabled using [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle).
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
When using buttonsSftTreeAutoThemeVista to adapt the button style based on the current operating system used, the application must be marked as supporting specific operating systems (see [https://msdn.microsoft.com/en-us/library/windows/desktop/dn481241](https://msdn.microsoft.com/en-us/library/windows/desktop/dn481241)). Users can further override the determined operating system using the application's compatibility settings.
See Also SftTree Object | Object Hierarchy
## ButtonCollapsed Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) for a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonCollapsed** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonCollapsed** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonCollapsed**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonCollapsed**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonCollapsed**(); |
| C | **HRESULT** *object*->get_**ButtonCollapsed**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonCollapsed** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonCollapsed** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonCollapsed** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonCollapsed** = *refImageObj*;
**void** *object*->Put**ButtonCollapsed**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonCollapsed**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button for a collapsed parent item.
### Comments
The ButtonCollapsed property defines the expand/collapse button for a collapsed parent item.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) and [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonCollapsedDown Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedDown*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) for a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item when the expand/collapse button is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonCollapsedDown** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonCollapsedDown** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonCollapsedDown**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonCollapsedDown**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonCollapsedDown**(); |
| C | **HRESULT** *object*->get_**ButtonCollapsedDown**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonCollapsedDown** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonCollapsedDown** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonCollapsedDown** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonCollapsedDown** = *refImageObj*;
**void** *object*->Put**ButtonCollapsedDown**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonCollapsedDown**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button for a collapsed parent item when the expand/collapse button is pressed.
### Comments
The ButtonCollapsedDown property defines the expand/collapse button for a collapsed parent item when the expand/collapse button is pressed.
If the ButtonCollapsedDown property is set to Null/Nothing, the image defined using the [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) property is used instead.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) and ButtonCollapsed properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonCollapsedHot Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsedHot*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) for a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item when the mouse cursor is over the expand/collapse button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonCollapsedHot** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonCollapsedHot** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonCollapsedHot**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonCollapsedHot**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonCollapsedHot**(); |
| C | **HRESULT** *object*->get_**ButtonCollapsedHot**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonCollapsedHot** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonCollapsedHot** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonCollapsedHot** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonCollapsedHot** = *refImageObj*;
**void** *object*->Put**ButtonCollapsedHot**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonCollapsedHot**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button for a collapsed parent item when the mouse cursor is over the expand/collapse button.
### Comments
The ButtonCollapsedHot property defines the expand/collapse button for a collapsed parent item when the mouse cursor is over the expand/collapse button.
If the ButtonCollapsedHot property is set to Null/Nothing, the image defined using the [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) property is used instead.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) and ButtonCollapsed properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonDown Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ButtonDown*
Defines whether the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) button is currently pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ButtonDown** **As Boolean** |
| VB | *Boolean* = *object*.**ButtonDown** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ButtonDown**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ButtonDown**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ButtonDown**(); |
| C | **HRESULT** *object*->get_**ButtonDown**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonDown** = *Boolean* **As Boolean** |
| VB | *object*.**ButtonDown** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ButtonDown** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ButtonDown** = *Boolean*;
**void** *object*->Put**ButtonDown**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ButtonDown**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Boolean
Defines whether the row/column footer button is currently pressed.
| Boolean | Description |
| --- | --- |
| True | The row/column footer button is pressed. |
| False | The row/column footer button is not pressed. |
### Comments
The ButtonDown property defines whether the row/column footer button is currently pressed.
The row/column footer is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column footers (see [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column footer button. The [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_RemainUp) property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column footer is drawn as a button if the RowColumnFooter.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance) property is set accordingly.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## ButtonDown Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ButtonDown*
Defines whether the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button is currently pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ButtonDown** **As Boolean** |
| VB | *Boolean* = *object*.**ButtonDown** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ButtonDown**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ButtonDown**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ButtonDown**(); |
| C | **HRESULT** *object*->get_**ButtonDown**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonDown** = *Boolean* **As Boolean** |
| VB | *object*.**ButtonDown** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ButtonDown** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ButtonDown** = *Boolean*;
**void** *object*->Put**ButtonDown**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ButtonDown**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Boolean
Defines whether the row/column header button is currently pressed.
| Boolean | Description |
| --- | --- |
| True | The row/column header button is pressed. |
| False | The row/column header button is not pressed. |
### Comments
The ButtonDown property defines whether the row/column header button is currently pressed.
The row/column header is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column headers (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column header button. The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column header is drawn as a button if the RowColumnHeader.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set accordingly.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## ButtonExpanded Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) image for an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonExpanded** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonExpanded** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonExpanded**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonExpanded**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonExpanded**(); |
| C | **HRESULT** *object*->get_**ButtonExpanded**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonExpanded** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonExpanded** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonExpanded** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonExpanded** = *refImageObj*;
**void** *object*->Put**ButtonExpanded**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonExpanded**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button image for an expanded parent item.
### Comments
The ButtonExpanded property defines the expand/collapse button image for an expanded parent item.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the ButtonExpanded and [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonExpandedDown Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedDown*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) image for an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item when the expand/collapse button is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonExpandedDown** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonExpandedDown** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonExpandedDown**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonExpandedDown**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonExpandedDown**(); |
| C | **HRESULT** *object*->get_**ButtonExpandedDown**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonExpandedDown** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonExpandedDown** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonExpandedDown** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonExpandedDown** = *refImageObj*;
**void** *object*->Put**ButtonExpandedDown**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonExpandedDown**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button image for an expanded parent item when the expand/collapse button is pressed.
### Comments
The ButtonExpandedDown property defines the expand/collapse button image for an expanded parent item when the expand/collapse button is pressed.
If the ButtonExpandedDown property is set to Null/Nothing, the image defined using the [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) property is used instead.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the ButtonExpanded and [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonExpandedHot Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpandedHot*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) image for an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item when the mouse cursor is over the expand/collapse button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ButtonExpandedHot** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ButtonExpandedHot** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ButtonExpandedHot**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ButtonExpandedHot**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ButtonExpandedHot**(); |
| C | **HRESULT** *object*->get_**ButtonExpandedHot**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonExpandedHot** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ButtonExpandedHot** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ButtonExpandedHot** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ButtonExpandedHot** = *refImageObj*;
**void** *object*->Put**ButtonExpandedHot**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ButtonExpandedHot**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refImageObj
Defines the expand/collapse button image for an expanded parent item when the mouse cursor is over the expand/collapse button.
### Comments
The ButtonExpandedHot property defines the expand/collapse button image for an expanded parent item when the mouse cursor is over the expand/collapse button.
If the ButtonExpandedHot property is set to Null/Nothing, the image defined using the [ButtonExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonExpanded) property is used instead.
User-defined expand/collapse button images are only used if the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property is set to [buttonsSftTreeUserImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonAppearanceConstants) and at least the ButtonExpanded and [ButtonCollapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonCollapsed) properties define valid images.
Sample bitmaps for expand/collapse buttons are provided in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images.
See Also SftTree Object | Object Hierarchy
## ButtonPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPicture*
Defines the graphic used to display [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons).
> Deprecated - Provided for compatibility with earlier versions only - Use the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**ButtonPicture** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ButtonPicture** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**ButtonPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ButtonPicture**(); |
| C | **HRESULT** *object*->get_**ButtonPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ButtonPicture**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ButtonPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ButtonPicture**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ButtonPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ButtonPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ButtonPicture** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**ButtonPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**ButtonPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**ButtonPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ButtonPicture**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
A [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object. This Picture object contains the graphic used to display the expand/collapse buttons. The * refPictureObj* object must represent a bitmap and cannot represent an icon or a metafile. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use the ButtonAppearance property instead
The ButtonPicture property defines the graphic used to display expand/collapse buttons.
The ButtonPicture and [ButtonPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The ButtonPicture property can be used to override the default expand/collapse buttons provided by a tree control. The * refPictureObj* object must represent a bitmap and cannot represent an icon or a metafile.
The bitmap represented by the * refPictureObj* object must contain four equal-sized images of an expand/collapse button in the following 4 states:
- up, [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item. The default is a 12 x 11 button with a '+' image.
- up, expanded item. The default is a 12 x 11 button with a '-' image.
- down, expandable item. The default is a 12 x 11 button with a '+' image.
- down, expanded item. The default is a 12 x 11 button with a '-' image.
The buttons are arranged horizontally in the bitmap, so the height of the bitmap is the height of one button and the width of the bitmap is four times the width of one button. The top, left pixel of each button bitmap must contain the background color. This color will be replaced by the actual item background color when the bitmap is displayed.
All items use the same expand/collapse button graphic. Expand/collapse buttons are only shown if the [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle) property is set accordingly. Only parent items with dependents receive an expand/collapse button. Leaf items never have an expand/collapse button.
The ButtonPicture property can be set to the value Nothing (NULL), which restores the tree control's default, built-in expand/collapse button bitmap.
The ButtonStyle property can be used to define the presence of expand/collapse buttons.
The height of the items displayed is adjusted if necessary so the complete button graphic can be displayed vertically and horizontally.
Sample button bitmaps can be found in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images. E.g., Buttons4.bmp contains the button image as used by Windows Explorer.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ButtonPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPictureH*
Defines the graphic used to display [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons).
> Deprecated - Provided for compatibility with earlier versions only - Use the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**ButtonPictureH** **As Integer** |
| VB | *Handle* = *object*.**ButtonPictureH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**ButtonPictureH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ButtonPictureH**;
**OLE_HANDLE** *Handle* = *object*->Get**ButtonPictureH**(); |
| C | **HRESULT** *object*->get_**ButtonPictureH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonPictureH** = *Handle* **As Integer** |
| VB | *object*.**ButtonPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**ButtonPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**ButtonPictureH** = *Handle*;
**void** *object*->Put**ButtonPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ButtonPictureH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. This bitmap contains the graphic used to display the expand/collapse buttons. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use the ButtonAppearance property instead
The ButtonPictureH property defines the graphic used to display expand/collapse buttons.
The [ButtonPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonPicture) and ButtonPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The ButtonPictureH property can be used to override the default expand/collapse buttons provided by a tree control.
The bitmap represented by *Handle* must contain four equal-sized images of an expand/collapse button in the following 4 states:
- up, [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item. The default is a 12 x 11 button with a '+' image.
- up, expanded item. The default is a 12 x 11 button with a '-' image.
- down, expandable item. The default is a 12 x 11 button with a '+' image.
- down, expanded item. The default is a 12 x 11 button with a '-' image.
The buttons are arranged horizontally in the bitmap, so the height of the bitmap is the height of one button and the width of the bitmap is four times the width of one button. The top, left pixel of each button bitmap must contain the background color. This color will be replaced by the actual item background color when the bitmap is displayed.
All items use the same expand/collapse button graphic. Expand/collapse buttons are only shown if the [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle) property is set accordingly. Only parent items with dependents receive an expand/collapse button. Leaf items never have an expand/collapse button.
The ButtonPictureH property can be set to NULL, which restores the tree control's default, built-in expand/collapse button bitmap.
The ButtonStyle property can be used to define the presence of expand/collapse buttons.
The height of the items displayed is adjusted if necessary so the complete button graphic can be displayed vertically and horizontally.
Sample button bitmaps can be found in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images. E.g., Buttons4.bmp contains the button image as used by Windows Explorer.
See Also SftTree Object | Object Hierarchy
## ButtonStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle*
Defines the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) display method.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ButtonStyle** **As [SftTreeButtonStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonStyleConstants)** |
| VB | *Style* = *object*.**ButtonStyle** **As SftTreeButtonStyleConstants** |
| C#.NET | **SftTreeButtonStyleConstants** *Style* = *object*.**ButtonStyle**; |
| VC++ | **enum SftTreeButtonStyleConstants** *Style* = *object*->**ButtonStyle**;
**enum SftTreeButtonStyleConstants** *Style* = *object*->Get**ButtonStyle**(); |
| C | **HRESULT** *object*->get_**ButtonStyle**(**enum SftTreeButtonStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ButtonStyle** = *Style* **As SftTreeButtonStyleConstants** |
| VB | *object*.**ButtonStyle** = *Style* **As SftTreeButtonStyleConstants** |
| C#.NET | **SftTreeButtonStyleConstants** *object*.**ButtonStyle** = *Style*; |
| VC++ | **enum SftTreeButtonStyleConstants** *object*->**ButtonStyle** = *Style*;
**void** *object*->Put**ButtonStyle**(**enum SftTreeButtonStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**ButtonStyle**(**enum SftTreeButtonStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the expand/collapse button display method.
| Style | Value | Description |
| --- | --- | --- |
| buttonsSftTreeNone | 0 | None. The tree control does not display expand/collapse buttons. |
| buttonsSftTree1 | 1 | The tree control displays expand/collapse buttons for parent items on level 1 and above. |
| buttonsSftTreeAll | 2 | The tree control displays expand/collapse buttons for parent items on all levels. |
### Comments
The ButtonStyle property defines the expand/collapse button display method.
If the connecting tree lines are not displayed (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) property), the expand/collapse buttons are not shown. Tree lines are required for expand/collapse buttons to be shown.
The expand/collapse buttons graphic is defined using the [ButtonAppearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonAppearance) property.
See Also SftTree Object | Object Hierarchy
## CalcCellFromPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos*
Returns the item index and column number for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcCellFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, **ByRef** *ItemIndex* **As Integer**, **ByRef** *ColIndex* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcCellFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, *ItemIndex* **As Long**, *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcCellFromPos**(**float** *xPos*, **float** *yPos*, **out** **int** *ItemIndex*, **out** **short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcCellFromPos**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*, **short*** *ColIndex*); |
| C | **HRESULT** *object*->raw_**CalcCellFromPos**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*, **short*** *ColIndex*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
xPos
The horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
ItemIndex
Returns the item index at the specified coordinates *xPos*, *yPos*.
ColIndex
Returns the column number at the specified coordinates *xPos*, *yPos*.
Boolean
| Boolean | Description |
| --- | --- |
| True | A [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) was located at the specified coordinates *xPos*, *yPos*. |
| False | No cell was located at the specified coordinates *xPos*, *yPos*. |
### Comments
Returns the item index and column number for given coordinates.
The CalcCellFromPos and [CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) methods are synonyms, but may use different coordinate systems.
If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed, CalcCellFromPos will return the actually displayed cell at the given location. The column number returned does not necessarily match the physical column. If the actual column is required, use [CalcColumnFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPos) instead. [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) can be used to calculate the index of the item.
See Also SftTree Object | Object Hierarchy
## CalcCellFromPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix*
Returns the item index and column number for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcCellFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, **ByRef** *ItemIndex* **As Integer**, **ByRef** *ColIndex* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcCellFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, *ItemIndex* **As Long**, *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcCellFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **out** **int** *ItemIndex*, **out** **short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcCellFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*, **short*** *ColIndex*); |
| C | **HRESULT** *object*->raw_**CalcCellFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*, **short*** *ColIndex*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
XPosPix
The horizontal position relative to the top, left corner of the tree control in pixels.
YPosPix
The vertical position relative to the top, left corner of the tree control in pixels.
ItemIndex
Returns the item index at the specified coordinates *xPosPix*, *yPos**Pix*.
ColIndex
Returns the column number at the specified coordinates *xPosPix*, *yPos**Pix*.
Boolean
| Boolean | Description |
| --- | --- |
| True | A [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) was located at the specified coordinates *xPosPix*, *yPos**Pix*. |
| False | No cell was located at the specified coordinates *xPosPix*, *yPos**Pix*. |
### Comments
The CalcCellFromPosPix method returns the item index and column number for given coordinates.
The [CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) and CalcCellFromPosPix methods are synonyms, but may use different coordinate systems.
If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed, CalcCellFromPosPix will return the actually displayed cell at the given location. The column number returned does not necessarily match the physical column. If the actual column is required, use [CalcColumnFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPosPix) instead. [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) can be used to calculate the index of the item.
See Also SftTree Object | Object Hierarchy
## CalcColumnFromPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPos*
Returns the column number for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcColumnFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, **ByRef** *ColIndex* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcColumnFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcColumnFromPos**(**float** *xPos*, **float** *yPos*, **out** **short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcColumnFromPos**(**float** *xPos*, **float** *yPos*, **short*** *ColIndex*); |
| C | **HRESULT** *object*->raw_**CalcColumnFromPos**(**float** *xPos*, **float** *yPos*, **short*** *ColIndex*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
xPos
The horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
ColIndex
Returns the column number at the specified coordinates *xPos*, *yPos*.
Boolean
| Boolean | Description |
| --- | --- |
| True | A column was located at the specified coordinates *xPos*, *yPos*. |
| False | No column was located at the specified coordinates *xPos*, *yPos*. |
### Comments
The CalcColumnFromPos method returns the column number for given coordinates.
The CalcColumnFromPos and [CalcColumnFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPosPix) methods are synonyms, but may use different coordinate systems.
This method returns the column number * ColIndex* at the coordinates described by *xPos*, * yPos*. This position may be located above an item or a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). [CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) can be used to determine the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) can be used to determine the index of the item.
See Also SftTree Object | Object Hierarchy
## CalcColumnFromPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPosPix*
Returns the column number for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcColumnFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, **ByRef** *ColIndex* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcColumnFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcColumnFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **out** **short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcColumnFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **short*** *ColIndex*); |
| C | **HRESULT** *object*->raw_**CalcColumnFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **short*** *ColIndex*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
XPosPix
The horizontal position relative to the top, left corner of the tree control in pixels.
YPosPix
The vertical position relative to the top, left corner of the tree control in pixels.
ColIndex
Returns the column number at the specified coordinates *xPosPix*, *yPosPix*.
Boolean
| Boolean | Description |
| --- | --- |
| True | A column was located at the specified coordinates *xPosPix*, *yPosPix*. |
| False | No column was located at the specified coordinates *xPosPix*, *yPosPix*. |
### Comments
The CalcColumnFromPosPix method returns the column number for given coordinates.
The [CalcColumnFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPos) and CalcColumnFromPosPix methods are synonyms, but may use different coordinate systems.
This method returns the column number * ColIndex* at the coordinates described by *xPosPix*, *yPosPix*. This position may be located above an item or a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). [CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) can be used to determine the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) can be used to determine the index of the item.
See Also SftTree Object | Object Hierarchy
## CalcIndexFromPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos*
Returns the item index for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcIndexFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, **ByRef** *ItemIndex* **As Integer**, **ByRef** *[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader)* **As Boolean**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcIndexFromPos**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**, *ItemIndex* **As Long**, *RowHeader* **As Boolean**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcIndexFromPos**(**float** *xPos*, **float** *yPos*, **out** **int** *ItemIndex*, **out** **bool** *RowHeader*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcIndexFromPos**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*, **VARIANT_BOOL*** *RowHeader*); |
| C | **HRESULT** *object*->raw_**CalcIndexFromPos**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*, **VARIANT_BOOL*** *RowHeader*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
xPos
The horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
ItemIndex
Returns the item index at the specified coordinates *xPos*, *yPos*.
RowHeader
Returns True if the position is in the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area, otherwise False is returned.
Boolean
| Boolean | Description |
| --- | --- |
| True | An item was located at the specified coordinates *xPos*, *yPos*. |
| False | No item was located at the specified coordinates *xPos*, *yPos*. |
### Comments
The CalcIndexFromPos method returns the item index for given coordinates.
The CalcIndexFromPos and [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) methods are synonyms, but may use different coordinate systems.
[CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) can be used to determine the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). [CalcColumnFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPos) can be used to determine The zero-based column number.
See Also SftTree Object | Object Hierarchy
## CalcIndexFromPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix*
Returns the item index for given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcIndexFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, **ByRef** *ItemIndex* **As Integer**, **ByRef** *[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader)* **As Boolean**) **As Boolean** |
| VB | *Boolean* = *object*.**CalcIndexFromPosPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**, *ItemIndex* **As Long**, *RowHeader* **As Boolean**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcIndexFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **out** **int** *ItemIndex*, **out** **bool** *RowHeader*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcIndexFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*, **VARIANT_BOOL*** *RowHeader*); |
| C | **HRESULT** *object*->raw_**CalcIndexFromPosPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*, **VARIANT_BOOL*** *RowHeader*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
XPosPix
The horizontal position relative to the top, left corner of the tree control in pixels.
YPosPix
The vertical position relative to the top, left corner of the tree control in pixels.
ItemIndex
Returns the item index at the specified coordinates *xPosPix*, *yPosPix*.
RowHeader
Returns True if the position is in the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area, otherwise False is returned.
Boolean
Returns the item index for given coordinates.
| Boolean | Description |
| --- | --- |
| True | An item was located at the specified coordinates *xPosPix*, *yPosPix*. |
| False | No item was located at the specified coordinates *xPosPix*, *yPosPix*. |
### Comments
The CalcIndexFromPosPix method returns the item index for given coordinates.
The [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) and CalcIndexFromPosPix methods are synonyms, but may use different coordinate systems.
[CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) can be used to determine the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). [CalcColumnFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcColumnFromPosPix) can be used to determine The zero-based column number.
See Also SftTree Object | Object Hierarchy
## CalcLimit Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcLimit*
Defines the maximum number of items to consider for optimal column width and scrolling calculation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Limit* = *object*.**CalcLimit** **As Integer** |
| VB | *Limit* = *object*.**CalcLimit** **As Long** |
| C#.NET | **int** *Limit* = *object*.**CalcLimit**; |
| VC++ | **long** *Limit* = *object*->**CalcLimit**;
**long** *Limit* = *object*->Get**CalcLimit**(); |
| C | **HRESULT** *object*->get_**CalcLimit**(**long*** *Limit*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CalcLimit** = *Limit* **As Integer** |
| VB | *object*.**CalcLimit** = *Limit* **As Long** |
| C#.NET | **int** *object*.**CalcLimit** = *Limit*; |
| VC++ | **long** *object*->**CalcLimit** = *Limit*;
**void** *object*->Put**CalcLimit**(**long** *Limit*); |
| C | **HRESULT** *object*->put_**CalcLimit**(**long** *Limit*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Limit
Defines the maximum number of items to consider for optimal column width and scrolling calculation. If 0 is specified, all items will be considered.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.CalcLimit instead
The CalcLimit property defines the maximum number of items to consider for optimal column width and scrolling calculation.
The limit defined using the CalcLimit property defines how many items are evaluated using the methods [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth), Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) and Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent).
See Also SftTree Object | Object Hierarchy
## CalcLimit Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit*
Defines the maximum number of items to consider for optimal column width and scrolling calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Limit* = *object*.**CalcLimit** **As Integer** |
| VB | *Limit* = *object*.**CalcLimit** **As Long** |
| C#.NET | **int** *Limit* = *object*.**CalcLimit**; |
| VC++ | **long** *Limit* = *object*->**CalcLimit**;
**long** *Limit* = *object*->Get**CalcLimit**(); |
| C | **HRESULT** *object*->get_**CalcLimit**(**long*** *Limit*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CalcLimit** = *Limit* **As Integer** |
| VB | *object*.**CalcLimit** = *Limit* **As Long** |
| C#.NET | **int** *object*.**CalcLimit** = *Limit*; |
| VC++ | **long** *object*->**CalcLimit** = *Limit*;
**void** *object*->Put**CalcLimit**(**long** *Limit*); |
| C | **HRESULT** *object*->put_**CalcLimit**(**long** *Limit*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Limit
Defines the maximum number of items to consider for optimal column width and scrolling calculation. If 0 is specified, all items will be considered.
### Comments
The CalcLimit property defines the maximum number of items to consider for optimal column width and scrolling calculation.
The limit defined using the CalcLimit property defines how many items are evaluated using the methods [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth), Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent).
See Also SftTreeItems Object | Object Hierarchy
## CalcOptimalCell Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcOptimalCell*
Returns the size of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) contents.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**CalcOptimalCell**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *AvailableWidth* **As Integer**, **ByRef** *WidthPix* **As Integer**, **ByRef** *HeightPix* **As Integer**) |
| VB | *object*.**CalcOptimalCell**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *AvailableWidth* **As Integer**, *WidthPix* **As Integer**, *HeightPix* **As Integer**) |
| C#.NET | **void** *object*.**CalcOptimalCell**(**int** *ItemIndex*, **short** *ColIndex*, **int** *AvailableWidth*, **out** **int** *WidthPix*, **out** **int** *HeightPix*); |
| VC++ | **HRESULT** *object*->**CalcOptimalCell**(**long** *ItemIndex*, **short** *ColIndex*, **int** *AvailableWidth*, **int*** *WidthPix*, **int*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**CalcOptimalCell**(**long** *ItemIndex*, **short** *ColIndex*, **int** *AvailableWidth*, **int*** *WidthPix*, **int*** *HeightPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item.
ColIndex
The zero-based column number of the cell whose optimal width is to be calculated.
AvailableWidth
The width available to display the cell contents or 0 to calculate the optimal width and height without any constraints in width.
WidthPix
Returns the optimal width of the cell, in pixels.
HeightPix
Returns the optimal height of the cell, in pixels.
### Comments
The CalcOptimalCell method returns the size of the cell contents.
This method can be used to calculate the best width and height for a cell.
The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) property can be used to calculate a column's optimal width. The Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) method can be used to set a column's optimal width without having to calculate it first.
See Also SftTreeItems Object | Object Hierarchy
## CalcOptimalColumnWidth Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcOptimalColumnWidth*
Calculates a column's optimal width based on the column contents.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**CalcOptimalColumnWidth**(**ByVal** *ColIndex* **As Short**) **As Single** |
| VB | *Width* = *object*.**CalcOptimalColumnWidth**(**ByVal** *ColIndex* **As Integer**) **As Single** |
| C#.NET | **float** *Width* = *object*.**CalcOptimalColumnWidth**(**short** *ColIndex*); |
| VC++ | **float** *Width* = *object*->**CalcOptimalColumnWidth**(**short** *ColIndex*); |
| C | **HRESULT** *object*->raw_**CalcOptimalColumnWidth**(**short** *ColIndex*, **float*** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Width
Returns the optimal column width. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.OptimalWidth instead
The CalcOptimalColumnWidth method calculates a column's optimal width based on the column contents.
This method calculates the optimal width of a specified column so that the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text and graphic can be completely displayed without being truncated or clipped. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) method can be used to set a column's optimal width without having to calculate it first.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control.
CalcOptimalColumnWidth scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTree Object | Object Hierarchy
## CalcOptimalRowHeaderWidth Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcOptimalRowHeaderWidth*
Calculates the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s optimal width based on the contents of all row headers.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**CalcOptimalRowHeaderWidth**() **As Single** |
| VB | *Width* = *object*.**CalcOptimalRowHeaderWidth**() **As Single** |
| C#.NET | **float** *Width* = *object*.**CalcOptimalRowHeaderWidth**(); |
| VC++ | **float** *Width* = *object*->**CalcOptimalRowHeaderWidth**(); |
| C | **HRESULT** *object*->raw_**CalcOptimalRowHeaderWidth**(**float*** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Width
Returns the row header's optimal width based on the contents of all row headers. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.OptimalWidth instead
The CalcOptimalRowHeaderWidth method calculates the row header's optimal width based on the contents of all row headers.
This method calculates the optimal width of the row header area so that the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text and graphic and the row header text and graphics can be completely displayed without being truncated or clipped. The row header width can be changed using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property. The RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) method can be used to set the optimal row header width without having to calculate it first.
By changing tree control properties, the optimal row header width may change. Adding items, setting new row header graphics and changing row header text are a few of the actions that can affect the optimal row header width. The row header width may have to be set again to allow items to be completely visible. The tree control does not automatically adjust the row header width.
Calculating the optimal row header width can be a time consuming operation, particularly if many items have been added to the tree control. CalcOptimalRowHeaderWidth scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTree Object | Object Hierarchy
## CalcVisibleOnly Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcVisibleOnly*
Defines whether only visible items are considered for optimal column width and scrolling calculation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcVisibleOnly** **As Boolean** |
| VB | *Boolean* = *object*.**CalcVisibleOnly** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcVisibleOnly**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcVisibleOnly**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CalcVisibleOnly**(); |
| C | **HRESULT** *object*->get_**CalcVisibleOnly**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CalcVisibleOnly** = *Boolean* **As Boolean** |
| VB | *object*.**CalcVisibleOnly** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CalcVisibleOnly** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CalcVisibleOnly** = *Boolean*;
**void** *object*->Put**CalcVisibleOnly**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CalcVisibleOnly**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether only visible items are considered for optimal column width and scrolling calculation.
| Boolean | Description |
| --- | --- |
| True | Only visible items are considered for optimal column width and scrolling calculation. |
| False | All items are considered for optimal column width and scrolling calculation. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.CalcVisibleOnly instead
The CalcVisibleOnly property defines whether only visible items are considered for optimal column width and scrolling calculation.
The CalcVisibleOnly property defines whether hidden items are evaluated using the methods [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth), Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) and Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent).
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the CalcVisibleOnly property to True.
See Also SftTree Object | Object Hierarchy
## CalcVisibleOnly Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly*
Defines whether only visible items are considered for optimal column width and scrolling calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CalcVisibleOnly** **As Boolean** |
| VB | *Boolean* = *object*.**CalcVisibleOnly** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CalcVisibleOnly**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CalcVisibleOnly**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CalcVisibleOnly**(); |
| C | **HRESULT** *object*->get_**CalcVisibleOnly**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CalcVisibleOnly** = *Boolean* **As Boolean** |
| VB | *object*.**CalcVisibleOnly** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CalcVisibleOnly** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CalcVisibleOnly** = *Boolean*;
**void** *object*->Put**CalcVisibleOnly**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CalcVisibleOnly**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether only visible items are considered for optimal column width and scrolling calculation.
| Boolean | Description |
| --- | --- |
| True | Only visible items are considered for optimal column width and scrolling calculation. |
| False | All items are considered for optimal column width and scrolling calculation. |
### Comments
The CalcVisibleOnly property defines whether only visible items are considered for optimal column width and scrolling calculation.
The CalcVisibleOnly property defines whether hidden items are evaluated using the methods [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth), Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent).
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the CalcVisibleOnly property to True.
See Also SftTreeItems Object | Object Hierarchy
## CancelMode Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode*
Cancels internal modes.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**CancelMode**() |
| VB | *object*.**CancelMode** |
| C#.NET | **void** *object*.**CancelMode**(); |
| VC++ | **HRESULT** *object*->**CancelMode**(); |
| C | **HRESULT** *object*->raw_**CancelMode**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The CancelMode method cancels internal modes.
Applications may wish to respond to events such as [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) or [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown). Many mouse related events may have built-in functions, particularly [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operations may be started after these events are processed. If an application wants to suppress the built-in behavior, e.g. to display a context menu, the internal state of the tree control has to be cleared. This can be accomplished using the CancelMode method.
See Also SftTree Object | Object Hierarchy
## CaretChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CaretChange*
The caret location changes.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CaretChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CaretChange** |
| VB | **Private Sub** *object*_**CaretChange**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**CaretChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CaretChange***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**CaretChange***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
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](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current)). When using the up and down arrow keys, the user changes the current item (or caret location, also see Items.[NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection)). The current item is not necessarily the same as the [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_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](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) property.
See Also SftTree Object | Object Hierarchy
## CEChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEChange*
The contents of the edit control or combo box have changed ([cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CEChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CEChange** |
| VB | **Private Sub** *object*_**CEChange**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *CurrString* **As String**) |
| C#.NET | **void** *object*_**CEChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CEChange***object*(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *CurrString*); |
| C | **HRESULT** On**CEChange***object*(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *CurrString*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
CurrString
The text currently displayed by the edit control or combo box used for cell editing.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CEChange event occurs when the contents of the edit control or combo box have changed (cell editing).
This event is only available if the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property is set to True.
The tree control properties cannot be modified during this event. If the cell contents are modified, cell editing is terminated. Use the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) or [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) events to modify the cell contents.
See Also SftTree Object | Object Hierarchy
## CEClick Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEClick*
The selection of a combo box has changed ([cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CEClick**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CEClick** |
| VB | **Private Sub** *object*_**CEClick**(**ByVal** *[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection)* **As Long**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *CurrString* **As String**) |
| C#.NET | **void** *object*_**CEClick**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CEClick***object*(**long** *Selection*, **long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *CurrString*); |
| C | **HRESULT** On**CEClick***object*(**long** *Selection*, **long** *ItemIndex*, **short** *ColIndex*, **BSTR** *CurrString*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Selection
The zero-based index of the selection made in the combo box used for cell editing. This value may be -1 if no item is selected.
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
CurrString
The text currently displayed by the combo box used for cell editing.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CEClick event occurs when the selection of a combo box has changed (cell editing).
This event is only available if the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property is set to True.
The tree control properties cannot be modified during this event. If the cell contents are modified, cell editing is terminated. Use the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) or [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) events to modify the cell contents.
The combo box selection can change in response to a mouse click or keyboard input such as up or down arrow keys. The CEClick event cannot be used to end cell editing.
See Also SftTree Object | Object Hierarchy
## CEKeyDown Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown*
A key has been pressed ([cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CEKeyDown**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CEKeyDown** |
| VB | **Private Sub** *object*_**CEKeyDown**(*Key* **As Long**, **ByVal** *Shift* **As Integer**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *CurrString* **As String**) |
| C#.NET | **void** *object*_**CEKeyDown**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CEKeyDown***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *CurrString*); |
| C | **HRESULT** On**CEKeyDown***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **BSTR** *CurrString*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
The key code. This value can be set to 0 to suppress the key from being processed by SftTree/OCX. The key codes are defined by the development tool used. For Visual Basic, key code examples are vbKeyF1 (the F1 key), for Visual C++ VK_UP (the up arrow key).
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
CurrString
The text currently displayed by the edit control or combo box used for cell editing.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CEKeyDown event occurs when a key has been pressed (cell editing).
This event is only available if the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property is set to True.
The tree control properties cannot be modified during this event. If the cell contents are modified, cell editing is terminated. Use the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) or [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) events to modify the cell contents.
The Key typed by the user can be suppressed by setting *Key* to 0. It can be modified by assigning a new value to the variable.
See Also SftTree Object | Object Hierarchy
## CEKeyPress Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress*
A key has been pressed ([cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CEKeyPress**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CEKeyPress** |
| VB | **Private Sub** *object*_**CEKeyPress**(*Key* **As Long**, **ByVal** *Shift* **As Integer**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *CurrString* **As String**) |
| C#.NET | **void** *object*_**CEKeyPress**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CEKeyPress***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *CurrString*); |
| C | **HRESULT** On**CEKeyPress***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **BSTR** *CurrString*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
The key code. This value can be set to 0 to suppress the key from being processed by SftTree/OCX.
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
CurrString
The text currently displayed by the edit control or combo box used for cell editing.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CEKeyPress event occurs when a key has been pressed (cell editing).
This event is only available if the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property is set to True.
The tree control properties cannot be modified during this event. If the cell contents are modified, cell editing is terminated. Use the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) or [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) events to modify the cell contents.
The Key typed by the user can be suppressed by setting *Key* to 0. It can be modified by assigning a new value to the variable.
See Also SftTree Object | Object Hierarchy
## CEKeyUp Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyUp*
A key has been released ([cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**CEKeyUp**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**CEKeyUp** |
| VB | **Private Sub** *object*_**CEKeyUp**(*Key* **As Long**, **ByVal** *Shift* **As Integer**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *CurrString* **As String**) |
| C#.NET | **void** *object*_**CEKeyUp**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**CEKeyUp***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *CurrString*); |
| C | **HRESULT** On**CEKeyUp***object*(**long*** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*, **BSTR** *CurrString*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
The key code. This value can be set to 0 to suppress the key from being processed by SftTree/OCX. The key codes are defined by the development tool used. For Visual Basic, key code examples are vbKeyF1 (the F1 key), for Visual C++ VK_UP (the up arrow key).
Shift
The state of the SHIFT, CONTROL and ALT keys during the event. A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| [constSftTreeShiftMask](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants) | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
ItemIndex
The zero-based index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited.
ColIndex
The column number of the cell being edited.
CurrString
The text currently displayed by the edit control or combo box used for cell editing.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CEKeyUp event occurs when a key has been released (cell editing).
This event is only available if the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property is set to True.
The tree control properties cannot be modified during this event. If the cell contents are modified, cell editing is terminated. Use the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) or [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) events to modify the cell contents.
The Key typed by the user can be suppressed by setting *Key* to 0. It can be modified by assigning a new value to the variable.
See Also SftTree Object | Object Hierarchy
## Cell Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell*
Returns a [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object for a given item/column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refCellObj* = *object*.get_**Cell**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As SftTreeCell** |
| VB | **Set** *refCellObj* = *object*.**Cell**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As SftTreeCell** |
| C#.NET | **SftTreeCell** *refCellObj* = *object*.**Cell**[**int** *ItemIndex*][**short** *ColIndex*]; |
| VC++ | **ISftTreeCell*** *refCellObj* = *object*->**Cell**[**long** *ItemIndex*][**short** *ColIndex*];
**ISftTreeCell*** *refCellObj* = *object*->Get**Cell**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**Cell**(**long** *ItemIndex*, **short** *ColIndex*, **ISftTreeCell**** *refCellObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
refCellObj
Returns a SftTreeCell object for a given item/column.
### Comments
The Cell property returns a SftTreeCell object for a given item/column.
The SftTreeCell object represents one cell in a SftTree/OCX control. Numerous cell-specific properties and methods can be accessed using the returned object *refCellObj*.
A SftTreeCell object can also be obtained through an item's [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell) property.
Certain default properties and behavior for cells can be defined using the [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
See Also SftTree Object | Object Hierarchy
## Cell Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell*
Returns a [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object for a given [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refCellObj* = *object*.**Cell**(**ByVal** *ColIndex* **As Short**) **As SftTreeCell** |
| VB | **Set** *refCellObj* = *object*.**Cell**(**ByVal** *ColIndex* **As Integer**) **As SftTreeCell** |
| C#.NET | **SftTreeCell** *refCellObj* = *object*.get_**Cell**(**short** *ColIndex*); |
| VC++ | **ISftTreeCell*** *refCellObj* = *object*->**Cell**[**short** *ColIndex*];
**ISftTreeCell*** *refCellObj* = *object*->Get**Cell**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**Cell**(**short** *ColIndex*, **ISftTreeCell**** *refCellObj*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ColIndex
The zero-based column number of the cell to retrieve.
refCellObj
Returns a SftTreeCell object for a given cell.
### Comments
The Cell property returns a SftTreeCell object for a given cell.
The SftTreeCell object represents one cell in a SftTree/OCX control. Numerous cell-specific properties and methods can be accessed using the returned object *refCellObj*.
A SftTreeCell object can also be obtained through the control's [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell) property.
Certain default properties and behavior for cells can be defined using the [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
See Also SftTreeItem Object | Object Hierarchy
## Cell3D Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell3D*
Defines whether [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are painted using a 3D effect.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Cell3D** **As Boolean** |
| VB | *Boolean* = *object*.**Cell3D** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Cell3D**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Cell3D**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Cell3D**(); |
| C | **HRESULT** *object*->get_**Cell3D**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Cell3D** = *Boolean* **As Boolean** |
| VB | *object*.**Cell3D** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Cell3D** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Cell3D** = *Boolean*;
**void** *object*->Put**Cell3D**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Cell3D**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether cells are painted using a 3D effect.
| Boolean | Description |
| --- | --- |
| True | Cells are painted using a 3D effect. |
| False | Cells are painted without 3D effect. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Cell3D instead
The Cell3D property defines whether cells are painted using a 3D effect.
If 3D rendering is chosen, the color properties Items.[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShadowColor) and Items.[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HilightColor) are used to display dark and highlighted edges around the items. The Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) and Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) properties may have to be adjusted to allow for the proper contrast between all color properties involved. In design-mode, the Items.BackColor and Items.ForeColor properties are adjusted automatically.
If the Cell3D property is set to True, only the text portion of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is highlighted, never the entire item, i.e., the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is ignored.
See Also SftTree Object | Object Hierarchy
## Cell3D Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D*
Defines whether [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are painted using a 3D effect.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Cell3D** **As Boolean** |
| VB | *Boolean* = *object*.**Cell3D** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Cell3D**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Cell3D**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Cell3D**(); |
| C | **HRESULT** *object*->get_**Cell3D**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Cell3D** = *Boolean* **As Boolean** |
| VB | *object*.**Cell3D** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Cell3D** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Cell3D** = *Boolean*;
**void** *object*->Put**Cell3D**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Cell3D**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether cells are painted using a 3D effect.
| Boolean | Description |
| --- | --- |
| True | Cells are painted using a 3D effect. |
| False | Cells are painted without 3D effect. |
### Comments
The Cell3D property defines whether cells are painted using a 3D effect.
If 3D rendering is chosen, the color properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShadowColor) and Items.[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HilightColor) are used to display dark and highlighted edges around the items. The Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) and Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) properties may have to be adjusted to allow for the proper contrast between all color properties involved. In design-mode, the Items.BackColor and Items.ForeColor properties are adjusted automatically.
If the Cell3D property is set to True, only the text portion of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is highlighted, never the entire item, i.e., the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is ignored.
See Also SftTreeItems Object | Object Hierarchy
## CellBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellBackColor*
Defines the background color used to draw an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**CellBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**CellBackColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**CellBackColor**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**CellBackColor**[**long** *ItemIndex*][**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**CellBackColor**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**CellBackColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellBackColor**(**int** *ItemIndex*, **short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellBackColor**[**long** *ItemIndex*][**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Defines the background color used to draw an item's cell that is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.BackColor instead
The CellBackColor property defines the background color used to draw an item's cell that is not selected.
The cell described by *ItemIndex*, *ColIndex* has the background color attribute *Clr*. This color is used as background color when the item is not selected. If the item is selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the Cell.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property is used instead.
See Also SftTree Object | Object Hierarchy
## CellBackColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellBackColor*
Defines the background color used to draw the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellBackColor**(**ByVal** *ColIndex* **As Short**) = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**CellBackColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellBackColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellBackColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Clr
Defines the background color used to draw the item's cell that is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.BackColor instead
The CellBackColor property defines the background color used to draw the item's cell that is not selected.
The VirtualItem.CellBackColor property is used while handling a VirtualItem event to define the background color for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellEditIntercept Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditIntercept*
Defines keystrokes to be intercepted during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) (using the [EditNavigating](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating) event).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**CellEditIntercept**(**ByVal** *Key* **As Integer**, **ByVal** *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* **As [SftTreeCellEditInterceptStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCellEditInterceptStyleConstants)**) |
| VB | *object*.**CellEditIntercept**(**ByVal** *Key* **As Long**, **ByVal** *Style* **As SftTreeCellEditInterceptStyleConstants**) |
| C#.NET | **void** *object*.**CellEditIntercept**(**int** *Key*, **SftTreeCellEditInterceptStyleConstants** *Style*); |
| VC++ | **HRESULT** *object*->**CellEditIntercept**(**long** *Key*, **enum SftTreeCellEditInterceptStyleConstants** *Style*); |
| C | **HRESULT** *object*->raw_**CellEditIntercept**(**long** *Key*, **enum SftTreeCellEditInterceptStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
A virtual key code. Defines the key to be intercepted during cell editing.
| Symbol Name | Value | Description |
| --- | --- | --- |
| VK_LBUTTON | 0x01 | Touch screen |
| VK_CANCEL | 0x03 | Control-break processing |
| VK_BACK | 0x08 | BACKSPACE key |
| VK_TAB | 0x09 | TAB key |
| VK_CLEAR | 0x0c | CLEAR key |
| VK_RETURN | 0x0d | ENTER key |
| VK_SHIFT | 0x10 | SHIFT key |
| VK_CONTROL | 0x11 | CTRL key |
| VK_MENU | 0x12 | ALT key |
| VK_CAPITAL | 0x14 | CAPS LOCK key |
| VK_ESCAPE | 0x1B | ESC key |
| VK_SPACE | 0x20 | SPACEBAR key |
| VK_PRIOR | 0x21 | PAGE UP key |
| VK_NEXT | 0x22 | PAGE DOWN key |
| VK_END | 0x23 | END key |
| VK_HOME | 0x24 | HOME key |
| VK_LEFT | 0x25 | LEFT ARROW key |
| VK_UP | 0x26 | UP ARROW key |
| VK_RIGHT | 0x27 | RIGHT ARROW key |
| VK_DOWN | 0x28 | DOWN ARROW key |
| VK_SELECT | 0x29 | SELECT key |
| VK_EXECUTE | 0x2B | EXECUTE key |
| VK_SNAPSHOT | 0x2C | PRINT SCREEN key for Windows 3.0 and later |
| VK_HELP | 0x2F | HELP key |
| VK_0 | 0x30 | 0 key |
| VK_1 | 0x31 | 1 key |
| VK_2 | 0x32 | 2 key |
| VK_3 | 0x33 | 3 key |
| VK_4 | 0x34 | 4 key |
| VK_5 | 0x35 | 5 key |
| VK_6 | 0x36 | 6 key |
| VK_7 | 0x37 | 7 key |
| VK_8 | 0x38 | 8 key |
| VK_9 | 0x39 | 9 key |
| VK_A | 0x41 | A key |
| VK_B | 0x42 | B key |
| VK_C | 0x43 | C key |
| VK_D | 0x44 | D key |
| VK_E | 0x45 | E key |
| VK_F | 0x46 | F key |
| VK_G | 0x47 | G key |
| VK_H | 0x48 | H key |
| VK_I | 0x49 | I key |
| VK_J | 0x4A | J key |
| VK_K | 0x4B | K key |
| VK_L | 0x4C | L key |
| VK_M | 0x4D | M key |
| VK_N | 0x4E | N key |
| VK_O | 0x4F | O key |
| VK_P | 0x50 | P key |
| VK_Q | 0x51 | Q key |
| VK_R | 0x52 | R key |
| VK_S | 0x53 | S key |
| VK_T | 0x54 | T key |
| VK_U | 0x55 | U key |
| VK_V | 0x56 | V key |
| VK_W | 0x57 | W key |
| VK_X | 0x58 | X key |
| VK_Y | 0x59 | Y key |
| VK_Z | 0x5A | Z key |
| VK_NUMPAD0 | 0x60 | Numeric keypad 0 key |
| VK_NUMPAD1 | 0x61 | Numeric keypad 1 key |
| VK_NUMPAD2 | 0x62 | Numeric keypad 2 key |
| VK_NUMPAD3 | 0x63 | Numeric keypad 3 key |
| VK_NUMPAD4 | 0x64 | Numeric keypad 4 key |
| VK_NUMPAD5 | 0x65 | Numeric keypad 5 key |
| VK_NUMPAD6 | 0x66 | Numeric keypad 6 key |
| VK_NUMPAD7 | 0x67 | Numeric keypad 7 key |
| VK_NUMPAD8 | 0x68 | Numeric keypad 8 key |
| VK_NUMPAD9 | 0x69 | Numeric keypad 9 key |
| VK_MULTIPLY | 0x6A | Asterisk (*) key |
| VK_ADD | 0x6B | Plus sign (+) key |
| VK_SEPARATOR | 0x6C | Separator key |
| VK_SUBTRACT | 0x6D | Minus sign (-) key |
| VK_DECIMAL | 0x6E | Period (.) key |
| VK_DIVIDE | 0x6F | Slash mark (/) key |
| VK_ATTN | 0xF6 | - |
| VK_CRSEL | 0xF7 | - |
| VK_EXSEL | 0xF8 | - |
| VK_EREOF | 0xF9 | - |
| VK_PLAY | 0xFA | - |
| VK_ZOOM | 0xFB | - |
| VK_NONAME | 0xFC | - |
| VK_PA1 | 0xFD | - |
| VK_OEM_CLEAR | 0xFE | - |
| VK_LWIN | 0x5B | - |
| VK_RWIN | 0x5C | - |
| VK_APPS | 0x5D | - |
| VK_LSHIFT | 0xA0 | - |
| VK_RSHIFT | 0xA1 | - |
| VK_LCONTROL | 0xA2 | - |
| VK_RCONTROL | 0xA3 | - |
| VK_LMENU | 0xA4 | - |
| VK_RMENU | 0xA5 | - |
**Note:** Symbolic names are only available to applications written in C/C++, which use the #include directive to include WinUser.h, part of the Windows header files.
Style
Defines the processing options for the specified key. One or more values of the following table can be combined. Specify 0 to clear a key's processing options so it is no longer intercepted.
| Name | Value | Description |
| --- | --- | --- |
| cellEditInterceptSftTreeChar | 1 | Character Only - If the key is pressed without the CONTROL or SHIFT key, the EditNavigating event occurs. |
| cellEditInterceptSftTreeControlChar | 4 | CONTROL + Character - If the key is pressed with the CONTROL key, the EditNavigating event occurs. |
| cellEditInterceptSftTreeShiftChar | 8 | SHIFT + Character - If the key is pressed with the SHIFT key, the EditNavigating event occurs. |
### Comments
The CellEditIntercept method defines keystrokes to be intercepted during cell editing (using the EditNavigating event).
A key that is intercepted will generate the EditNavigating event so the application can handle the key. Even keys such as RETURN and TAB, that are normally handled by enclosing forms, can be intercepted.
Only navigation keys should be intercepted. Other keys can be handled in the control's own event handlers ([KeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyDown)/[KeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress)/[KeyUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyUp) events).
Any key that is intercepted will no longer generate KeyDown, KeyPress and KeyUp events for the control used for cell editing and must be completely handled by the EditNavigating event.
The CellEditIntercept method is normally used in the [EditInitializing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing) event to define [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) navigation keys for the cell about to be edited.
The defined intercepted keys are cleared once cell editing for a cell ends (the [EditEnding](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnding) event occurs).
See Also SftTree Object | Object Hierarchy
## CellEditLimit Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditLimit*
Defines the maximum number of characters in an edit control or combo box during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *NumChars* = *object*.**CellEditLimit** **As Short** |
| VB | *NumChars* = *object*.**CellEditLimit** **As Integer** |
| C#.NET | **short** *NumChars* = *object*.**CellEditLimit**; |
| VC++ | **short** *NumChars* = *object*->**CellEditLimit**;
**short** *NumChars* = *object*->Get**CellEditLimit**(); |
| C | **HRESULT** *object*->get_**CellEditLimit**(**short*** *NumChars*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellEditLimit** = *NumChars* **As Short** |
| VB | *object*.**CellEditLimit** = *NumChars* **As Integer** |
| C#.NET | **short** *object*.**CellEditLimit** = *NumChars*; |
| VC++ | **short** *object*->**CellEditLimit** = *NumChars*;
**void** *object*->Put**CellEditLimit**(**short** *NumChars*); |
| C | **HRESULT** *object*->put_**CellEditLimit**(**short** *NumChars*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
NumChars
Defines the maximum number of characters in an edit control or combo box during cell editing. If 0 is specified, there is no maximum number.
### Comments
The CellEditLimit property defines the maximum number of characters in an edit control or combo box during cell editing.
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The limit defined using the CellEditLimit property defines how many characters can be entered into an edit control or combo box during cell editing. The user will not be able to enter or paste more than the specified number of characters into the control.
The CellEditLimit property is used for the edit control and combo box when editing [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using the [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) and [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) methods. It is not used for cell editing started using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
See Also SftTree Object | Object Hierarchy
## CellEditStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle*
Defines the [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) display style.
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**CellEditStyle** **As [SftTreeCellEditStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCellEditStyleConstants)** |
| VB | *Style* = *object*.**CellEditStyle** **As SftTreeCellEditStyleConstants** |
| C#.NET | **SftTreeCellEditStyleConstants** *Style* = *object*.**CellEditStyle**; |
| VC++ | **enum SftTreeCellEditStyleConstants** *Style* = *object*->**CellEditStyle**;
**enum SftTreeCellEditStyleConstants** *Style* = *object*->Get**CellEditStyle**(); |
| C | **HRESULT** *object*->get_**CellEditStyle**(**enum SftTreeCellEditStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellEditStyle** = *Style* **As SftTreeCellEditStyleConstants** |
| VB | *object*.**CellEditStyle** = *Style* **As SftTreeCellEditStyleConstants** |
| C#.NET | **SftTreeCellEditStyleConstants** *object*.**CellEditStyle** = *Style*; |
| VC++ | **enum SftTreeCellEditStyleConstants** *object*->**CellEditStyle** = *Style*;
**void** *object*->Put**CellEditStyle**(**enum SftTreeCellEditStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**CellEditStyle**(**enum SftTreeCellEditStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the cell editing display style.
| Style | Value | Description |
| --- | --- | --- |
| cellSftTreeNormal | 0 | The edit control or combo box used for cell editing is sized to fit exactly within the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited. This may clip the text displayed in the control. The [ItemEditFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont) property can be used to reduce the size of the font used. |
| cellSftTreeAutoSize | 1 | The edit control or combo box used for cell editing is sized automatically to fit the text based on the font used for cell editing (see ItemEditFont). The control may extend beyond the borders of the cell being edited. |
### Comments
The CellEditStyle property defines the cell editing display style.
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
When using a CellEditStyle of cellSftTreeNormal, the text in the edit control or combo box control may be clipped vertically if it is too large to fit within the control. The control is sized to fit exactly within the cell being edited.
If cellSftTreeAutoSize is used, the control is adjusted based on the ItemEditFont property, so the text is not clipped. However, the control may exceed the boundaries of the cell being edited.
The CellEditStyle property is used for the edit control and combo box when editing cells using the [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) and [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) methods. It is not used for cell editing started using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
See Also SftTree Object | Object Hierarchy
## CellEventHandling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling*
Defines whether the application handles [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) events.
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CellEventHandling** **As Boolean** |
| VB | *Boolean* = *object*.**CellEventHandling** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CellEventHandling**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CellEventHandling**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CellEventHandling**(); |
| C | **HRESULT** *object*->get_**CellEventHandling**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellEventHandling** = *Boolean* **As Boolean** |
| VB | *object*.**CellEventHandling** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CellEventHandling** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CellEventHandling** = *Boolean*;
**void** *object*->Put**CellEventHandling**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CellEventHandling**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the application handles cell editing events.
| Boolean | Description |
| --- | --- |
| True | If the user clicks a mouse button outside of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited, the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) event is generated. This allows the application to perform input validation and other cleanup processing. If Cancel = False, the text selected replaces the cell's text. If Cancel = True, cell editing is not ended. The ENTER or TAB keys do not end cell editing and must be handled by the [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) or [CEKeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress) event. Using these events, an application can implement cell motion, moving from one cell to the next in response to keystrokes. |
| False | If the user clicks a mouse button outside of the cell being edited or presses the TAB or ENTER key, the AfterEdit event is generated. This allows the application to perform input validation and other cleanup processing. If Cancel = False, the text selected replaces the cell's text. If Cancel = True, cell editing is not ended. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The CellEventHandling property defines whether the application handles cell editing events.
CellEventHandling affects the handling of ENTER and TAB keys. The ESCAPE key is not affected. If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost. Once cell editing has ended (or was aborted by the user), the [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) event is generated.
The CellEventHandling property is used for the edit control and combo box when editing cells using the [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) and [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) methods. It is not used for cell editing started using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
See Also SftTree Object | Object Hierarchy
## CellFont Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellFont*
Defines the font used to display an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.get_**CellFont**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Font[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**CellFont**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *refFontObj* = *object*.get_**CellFont**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**CellFont**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellFont**(**long** *ItemIndex*, **short** *ColIndex*, **IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**CellFont**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | *object*.**CellFont**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**CellFont**(**int** *ItemIndex*, **short** *ColIndex*, **System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->Put**CellFont**(**long** *ItemIndex*, **short** *ColIndex*, **IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**CellFont**(**long** *ItemIndex*, **short** *ColIndex*, **IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**CellFont**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | **Set** *object*.**CellFont**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.set_**CellFont**(**int** *ItemIndex*, **short** *ColIndex*, **System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->PutRef**CellFont**(**long** *ItemIndex*, **short** *ColIndex*, **IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**CellFont**(**long** *ItemIndex*, **short** *ColIndex*, **IFontDisp*** *refFontObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
refFontObj
Defines the font used to display an item's cell text. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Font instead
The CellFont property defines the font used to display an item's cell text.
The CellFont property overrides the control's [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) property for the specified cell. If the CellFont property is not set for a particular cell, the control's Font property is used to draw the cell text instead. The CellFont property can be set to the value Nothing, which restores the tree control's default font, defined using the Font property.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)) and the CellFont property describes a font that is larger than the control's Font property, cell text will be clipped vertically. Items do not adjust their height to the CellFont property. Cell text is centered vertically and horizontally based on the Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) and Cell.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) properties.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## CellFont Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellFont*
Defines the font used to display the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**CellFont**(**ByVal** *ColIndex* **As Short**) **As stdole.IFontDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**CellFont**(**ByVal** *ColIndex* **As Integer**) **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *refFontObj* = *object*.get_**CellFont**(**short** *ColIndex*); |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**CellFont**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellFont**(**short** *ColIndex*, **IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**CellFont**(**ByVal** *ColIndex* **As Short**, **ByVal** *refFontObj* **As stdole.IFontDisp**) |
| VB | *object*.**CellFont**(**ByVal** *ColIndex* **As Integer**) = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**CellFont**(**short** *ColIndex*, **stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->Put**CellFont**(**short** *ColIndex*, **IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**CellFont**(**short** *ColIndex*, **IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**CellFont**(**ByVal** *ColIndex* **As Short**) = *refFontObj* **As stdole.IFontDisp** |
| VB | **Set** *object*.**CellFont**(**ByVal** *ColIndex* **As Integer**) = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.set_**CellFont**(**short** *ColIndex*, **stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->PutRef**CellFont**(**short** *ColIndex*, **IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**CellFont**(**short** *ColIndex*, **IFontDisp*** *refFontObj*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
refFontObj
Defines the font used to display the item's cell text. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Font instead
The CellFont property defines the font used to display the item's cell text.
The VirtualItem.CellFont property is used while handling a VirtualItem event to define the font for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellForeColor*
Defines the text color used to draw an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**CellForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**CellForeColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**CellForeColor**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**CellForeColor**[**long** *ItemIndex*][**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**CellForeColor**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**CellForeColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellForeColor**(**int** *ItemIndex*, **short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellForeColor**[**long** *ItemIndex*][**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Defines the text color used to draw an item's cell that is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.ForeColor instead
The CellForeColor property defines the text color used to draw an item's cell that is not selected.
The cell described by *ItemIndex*, *ColIndex* has the foreground color attribute *Clr*. This color is used as text color when the item is not selected. If the item is selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the Cell.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property is used instead.
See Also SftTree Object | Object Hierarchy
## CellForeColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellForeColor*
Defines the foreground color used to draw the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellForeColor**(**ByVal** *ColIndex* **As Short**) = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**CellForeColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellForeColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellForeColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Clr
Defines the foreground color used to draw the item's cell that is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.ForeColor instead
The CellForeColor property defines the foreground color used to draw the item's cell that is not selected.
The VirtualItem.CellForeColor property is used while handling a VirtualItem event to define the foreground color for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellHAlign Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign*
Defines the default horizontal alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) contents in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**CellHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**CellHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**CellHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**CellHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**CellHAlign**(); |
| C | **HRESULT** *object*->get_**CellHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**CellHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**CellHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**CellHAlign** = *Style*;
**void** *object*->Put**CellHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**CellHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Style
Defines the default horizontal alignment of cell contents in this column.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The CellHAlign property defines the default horizontal alignment of cell contents in this column.
The alignment applies to all cells in the column specified. Individual cells can override the defined default alignment using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign), Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign), Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTreeColumn Object | Object Hierarchy
## CellItemData Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellItemData*
Defines a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific value.
> Deprecated - Provided for compatibility with earlier versions only - [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Data* = *object*.get_**CellItemData**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As Integer** |
| VB | *Data* = *object*.**CellItemData**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As Long** |
| C#.NET | **int** *Data* = *object*.get_**CellItemData**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **long** *Data* = *object*->**CellItemData**[**long** *ItemIndex*][**short** *ColIndex*];
**long** *Data* = *object*->Get**CellItemData**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellItemData**(**long** *ItemIndex*, **short** *ColIndex*, **long*** *Data*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellItemData**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Data* **As Integer**) |
| VB | *object*.**CellItemData**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Data* **As Long** |
| C#.NET | **void** *object*.set_**CellItemData**(**int** *ItemIndex*, **short** *ColIndex*, **int** *Data*); |
| VC++ | **long** *object*->**CellItemData**[**long** *ItemIndex*][**short** *ColIndex*] = *Data*;
**void** *object*->Put**CellItemData**(**long** *ItemIndex*, **short** *ColIndex*, **long** *Data*); |
| C | **HRESULT** *object*->put_**CellItemData**(**long** *ItemIndex*, **short** *ColIndex*, **long** *Data*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Data
Defines the cell's application specific value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Cell.Data instead
The CellItemData property defines a cell's application specific value.
The CellItemData property can be used to store application specific data with a cell. Possible uses include storing pointers to data structures or values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
The Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties can be used to store additional application specific data, using other data types (strings, objects, variants).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTree Object | Object Hierarchy
## CellItemDataString Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellItemDataString*
Defines a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific string value.
> Deprecated - Provided for compatibility with earlier versions only - [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Data* = *object*.get_**CellItemDataString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As String** |
| VB | *Data* = *object*.**CellItemDataString**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As String** |
| C#.NET | **string** *Data* = *object*.get_**CellItemDataString**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **_bstr_t** *Data* = *object*->**CellItemDataString**[**long** *ItemIndex*][**short** *ColIndex*];
**_bstr_t** *Data* = *object*->Get**CellItemDataString**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellItemDataString**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR*** *Data*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellItemDataString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Data* **As String**) |
| VB | *object*.**CellItemDataString**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Data* **As String** |
| C#.NET | **void** *object*.set_**CellItemDataString**(**int** *ItemIndex*, **short** *ColIndex*, **string** *Data*); |
| VC++ | **_bstr_t** *object*->**CellItemDataString**[**long** *ItemIndex*][**short** *ColIndex*] = *Data*;
**void** *object*->Put**CellItemDataString**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *Data*); |
| C | **HRESULT** *object*->put_**CellItemDataString**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *Data*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Data
Defines a cell's application specific string value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Cell.DataString instead
The CellItemDataString property defines a cell's application specific string value.
The Cell.[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties can be used to store additional application specific data, using other data types (numeric values, objects, variants).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTree Object | Object Hierarchy
## CellMultiline Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline*
Defines whether multi-line text is allowed in [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CellMultiline** **As Boolean** |
| VB | *Boolean* = *object*.**CellMultiline** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CellMultiline**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CellMultiline**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CellMultiline**(); |
| C | **HRESULT** *object*->get_**CellMultiline**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellMultiline** = *Boolean* **As Boolean** |
| VB | *object*.**CellMultiline** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CellMultiline** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CellMultiline** = *Boolean*;
**void** *object*->Put**CellMultiline**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CellMultiline**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Boolean
Defines whether multi-line text is allowed in cells in this column.
| Boolean | Description |
| --- | --- |
| True | Cell text may contain CR/LF (carriage-return, line-feed) characters which signal the start of a new line. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to reserve sufficient space. The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellWordWrap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap) property can be used to enable word-wrap. |
| False | Cell text is displayed as-is. CR/LF (carriage-return, line-feed) characters are not interpreted. The Column.CellWordWrap property has no effect. |
### Comments
The CellMultiline property defines whether multi-line text is allowed in cells in this column.
See Also SftTreeColumn Object | Object Hierarchy
## CellPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPicture*
Defines the graphic displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.get_**CellPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**CellPicture**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.get_**CellPicture**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**CellPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**CellPicture**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**CellPicture**(**int** *ItemIndex*, **short** *ColIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**CellPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | **Set** *object*.**CellPicture**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**CellPicture**(**int** *ItemIndex*, **short** *ColIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**CellPicture**(**long** *ItemIndex*, **short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
refPictureObj
Defines the graphic displayed as the item's cell graphic. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.Picture instead
The CellPicture property defines the graphic displayed as an item's cell graphic.
The CellPicture and [CellPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as cell graphic at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as cell graphics are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearCellImages method can be used to remove all cell graphics. The CellPicture property can be set to the value Nothing (NULL), which removes the graphic from the cell.
The position of the cell graphics is determined by the Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## CellPicture Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPicture*
Defines the graphic displayed as the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**CellPicture**(**ByVal** *ColIndex* **As Short**) **As stdole.IPictureDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**CellPicture**(**ByVal** *ColIndex* **As Integer**) **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *refPictureObj* = *object*.get_**CellPicture**(**short** *ColIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**CellPicture**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellPicture**(**short** *ColIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**CellPicture**(**ByVal** *ColIndex* **As Short**, **ByVal** *refPictureObj* **As stdole.IPictureDisp**) |
| VB | *object*.**CellPicture**(**ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**CellPicture**(**short** *ColIndex*, **stdole.IPictureDisp** *refPictureObj*); |
| VC++ | **void** *object*->Put**CellPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**CellPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**CellPicture**(**ByVal** *ColIndex* **As Short**) = *refPictureObj* **As stdole.IPictureDisp** |
| VB | **Set** *object*.**CellPicture**(**ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**CellPicture**(**short** *ColIndex*, **stdole.IPictureDisp** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**CellPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**CellPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
refPictureObj
Defines the graphic displayed as the item's cell graphic. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Image.Picture instead
The CellPicture property defines the graphic displayed as the item's cell graphic.
The VirtualItem.CellPicture property is used while handling a VirtualItem event to define the cell graphic for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellPictureAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPictureAlign*
Defines the position of the graphic displayed in an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**CellPictureAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**CellPictureAlign**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**CellPictureAlign**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**CellPictureAlign**[**long** *ItemIndex*][**short** *ColIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**CellPictureAlign**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellPictureAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellPictureAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**CellPictureAlign**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**CellPictureAlign**(**int** *ItemIndex*, **short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**CellPictureAlign**[**long** *ItemIndex*][**short** *ColIndex*] = *Align*;
**void** *object*->Put**CellPictureAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**CellPictureAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Align
Defines the position of the graphic displayed in an item's cell.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the cell text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the cell. The cell text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the cell text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.ImageHAlign and Cell.ImageVAlign instead
The CellPictureAlign property defines the position of the graphic displayed in an item's cell.
The cell graphic is defined using the Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
See Also SftTree Object | Object Hierarchy
## CellPictureAlign Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPictureAlign*
Defines the position of the graphic displayed in the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and VirtualItem.Item.Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellPictureAlign**(**ByVal** *ColIndex* **As Short**) = *Align* **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *object*.**CellPictureAlign**(**ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**CellPictureAlign**(**short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**CellPictureAlign**[**short** *ColIndex*] = *Align*;
**void** *object*->Put**CellPictureAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**CellPictureAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A VirtItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Align
Defines the position of the graphic displayed in an item's cell.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the cell text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the cell. The cell text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the cell text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.ImageHAlign and VirtualItem.Item.Cell.ImageVAlign instead
The CellPictureAlign property defines the position of the graphic displayed in the item's cell.
The VirtualItem.CellPictureAlign property is used while handling a VirtualItem event to define the position of the graphic for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPictureH*
Defines the graphic displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.get_**CellPictureH**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As Integer** |
| VB | *Handle* = *object*.**CellPictureH**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.get_**CellPictureH**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**CellPictureH**[**long** *ItemIndex*][**short** *ColIndex*];
**OLE_HANDLE** *Handle* = *object*->Get**CellPictureH**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellPictureH**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellPictureH**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Handle* **As Integer**) |
| VB | *object*.**CellPictureH**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**CellPictureH**(**int** *ItemIndex*, **short** *ColIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**CellPictureH**[**long** *ItemIndex*][**short** *ColIndex*] = *Handle*;
**void** *object*->Put**CellPictureH**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**CellPictureH**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Handle
A bitmap handle. Defines the graphic displayed as the item's cell graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.PictureH instead
The CellPictureH property defines the graphic displayed as an item's cell graphic.
The [CellPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellPicture) and CellPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as cell graphic at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as cell graphics are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearCellImages method can be used to remove all cell graphics. The CellPictureH property can be set to the value NULL, which removes the graphic from the cell.
The position of the cell graphics is determined by the Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTree Object | Object Hierarchy
## CellPictureH Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellPictureH*
Defines the graphic displayed as the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellPictureH**(**ByVal** *ColIndex* **As Short**) = *Handle* **As Integer** |
| VB | *object*.**CellPictureH**(**ByVal** *ColIndex* **As Integer**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**CellPictureH**(**short** *ColIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**CellPictureH**[**short** *ColIndex*] = *Handle*;
**void** *object*->Put**CellPictureH**(**short** *ColIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**CellPictureH**(**short** *ColIndex*, **OLE_HANDLE** *Handle*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Handle
A bitmap handle. Defines the graphic displayed as the item's cell graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Image.PictureH instead
The CellPictureH property defines the graphic displayed as the item's cell graphic.
The VirtualItem.CellPictureH property is used while handling a VirtualItem event to define the cell graphic for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellSelectBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellSelectBackColor*
Defines the background color used to draw an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**CellSelectBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**CellSelectBackColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**CellSelectBackColor**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**CellSelectBackColor**[**long** *ItemIndex*][**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**CellSelectBackColor**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellSelectBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellSelectBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**CellSelectBackColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellSelectBackColor**(**int** *ItemIndex*, **short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellSelectBackColor**[**long** *ItemIndex*][**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellSelectBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellSelectBackColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Defines the background color used to draw an item's cell that is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.SelectBackColor instead
The CellSelectBackColor property defines the background color used to draw an item's cell that is selected.
The cell described by *ItemIndex*, *ColIndex* has the background color attribute *Clr*. This color is used as background color when the item is selected. If the item is not selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the Cell.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property is used instead.
See Also SftTree Object | Object Hierarchy
## CellSelectBackColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellSelectBackColor*
Defines the background color used to draw the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellSelectBackColor**(**ByVal** *ColIndex* **As Short**) = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**CellSelectBackColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellSelectBackColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellSelectBackColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellSelectBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellSelectBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Clr
Defines the background color used to draw the item's cell that is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.SelectBackColor instead
The CellSelectBackColor property defines the background color used to draw the item's cell that is selected.
The VirtualItem.CellSelectBackColor property is used while handling a VirtualItem event to define the background color for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellSelectForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellSelectForeColor*
Defines the text color used to draw an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**CellSelectForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**CellSelectForeColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**CellSelectForeColor**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**CellSelectForeColor**[**long** *ItemIndex*][**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**CellSelectForeColor**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellSelectForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellSelectForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**CellSelectForeColor**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellSelectForeColor**(**int** *ItemIndex*, **short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellSelectForeColor**[**long** *ItemIndex*][**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellSelectForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellSelectForeColor**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Defines the text color used to draw an item's cell that is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.SelectForeColor instead
The CellSelectForeColor property defines the text color used to draw an item's cell that is selected.
The cell described by *ItemIndex*, *ColIndex* has the foreground color attribute *Clr*. This color is used as text color when the item is selected. If the item is not selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the Cell.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property is used instead.
See Also SftTree Object | Object Hierarchy
## CellSelectForeColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellSelectForeColor*
Defines the foreground color used to draw the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) that is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellSelectForeColor**(**ByVal** *ColIndex* **As Short**) = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**CellSelectForeColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**CellSelectForeColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**CellSelectForeColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**CellSelectForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**CellSelectForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A VirtItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Clr
Defines the foreground color used to draw the item's cell that is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.SelectForeColor instead
The CellSelectForeColor property defines the foreground color used to draw the item's cell that is selected.
The VirtualItem.CellSelectForeColor property is used while handling a VirtualItem event to define the foreground color for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellText Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellText*
Defines an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.get_**CellText**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As String** |
| VB | *Text* = *object*.**CellText**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As String** |
| C#.NET | **string** *Text* = *object*.get_**CellText**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **_bstr_t** *Text* = *object*->**CellText**[**long** *ItemIndex*][**short** *ColIndex*];
**_bstr_t** *Text* = *object*->Get**CellText**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellText**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellText**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Text* **As String**) |
| VB | *object*.**CellText**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**CellText**(**int** *ItemIndex*, **short** *ColIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**CellText**[**long** *ItemIndex*][**short** *ColIndex*] = *Text*;
**void** *object*->Put**CellText**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**CellText**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Text
Defines an item's cell text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Text instead
The CellText property defines an item's cell text.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add), Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) and Items.[InsertAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_InsertAfter) methods add new items. The text specified when adding new items always defines the cell text for the first or only column (column 0).
The cell text may contain new-line characters (CR-LF) if [multi-line cell text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_multilinecelltext) is enabled (see Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline)).
If the cell text is empty, the cell in the preceding column may merge into the empty cell, based on the Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings.
The default cell text alignment for a column is defined using the Column.[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties. A cell can override the default using the Cell.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) and Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) properties.
See Also SftTree Object | Object Hierarchy
## CellText Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellText*
Defines the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellText**(**ByVal** *ColIndex* **As Short**) = *Text* **As String** |
| VB | *object*.**CellText**(**ByVal** *ColIndex* **As Integer**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**CellText**(**short** *ColIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**CellText**[**short** *ColIndex*] = *Text*;
**void** *object*->Put**CellText**(**short** *ColIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**CellText**(**short** *ColIndex*, **BSTR** *Text*); |
object
A VirtItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Text
Defines the item's cell text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Text instead
The CellText property defines the item's cell text.
The VirtualItem.CellText property is used while handling a VirtualItem event to define the text for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellTextAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellTextAlign*
Defines the position of the text displayed in an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) and Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**CellTextAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**CellTextAlign**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**CellTextAlign**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**CellTextAlign**[**long** *ItemIndex*][**short** *ColIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**CellTextAlign**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**CellTextAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**CellTextAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**CellTextAlign**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**CellTextAlign**(**int** *ItemIndex*, **short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**CellTextAlign**[**long** *ItemIndex*][**short** *ColIndex*] = *Align*;
**void** *object*->Put**CellTextAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**CellTextAlign**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Align
Defines the position of the text displayed in an item's cell.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The cell text is left aligned. |
| alignSftTreeCenter | 1 | The cell text is centered in the cell. |
| alignSftTreeRight | 2 | The cell text is right aligned. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The cell text is vertically centered. |
| alignSftTreeTop | 32 | The cell text is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The cell text is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.TextHAlign and Cell.TextVAlign instead
The CellTextAlign property defines the position of the text displayed in an item's cell.
The CellTextAlign property determines the position of the cell text and graphic, defined using the Cell.[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties. It overrides the column's default alignment defined using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties.
See Also SftTree Object | Object Hierarchy
## CellTextAlign Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_CellTextAlign*
Defines the position of the text displayed in the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) and VirtualItem.Item.[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellTextAlign**(**ByVal** *ColIndex* **As Short**) = *Align* **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *object*.**CellTextAlign**(**ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**CellTextAlign**(**short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**CellTextAlign**[**short** *ColIndex*] = *Align*;
**void** *object*->Put**CellTextAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**CellTextAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Align
Defines the position of the text displayed in an item's cell.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The cell text is left aligned. |
| alignSftTreeCenter | 1 | The cell text is centered in the cell. |
| alignSftTreeRight | 2 | The cell text is right aligned. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The cell text is vertically centered. |
| alignSftTreeTop | 32 | The cell text is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The cell text is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.TextHAlign and VirtualItem.Item.Cell.TextVAlign instead
The CellTextAlign property defines the position of the text displayed in the item's cell.
The VirtualItem.CellTextAlign property is used while handling a VirtualItem event to define the position of the text for the cell described by *ColIndex* and the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## CellVAlign Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign*
Defines the default vertical alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) contents in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**CellVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**CellVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**CellVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**CellVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**CellVAlign**(); |
| C | **HRESULT** *object*->get_**CellVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**CellVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**CellVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**CellVAlign** = *Style*;
**void** *object*->Put**CellVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**CellVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Style
Defines the default vertical alignment of cell contents in this column.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The CellVAlign property defines the default vertical alignment of cell contents in this column.
The alignment applies to all cells in the column specified. Individual cells can override the defined default alignment using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign), Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign), Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTreeColumn Object | Object Hierarchy
## CellWordWrap Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap*
Defines whether the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text may word-wrap within the available space in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CellWordWrap** **As Boolean** |
| VB | *Boolean* = *object*.**CellWordWrap** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CellWordWrap**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CellWordWrap**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CellWordWrap**(); |
| C | **HRESULT** *object*->get_**CellWordWrap**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CellWordWrap** = *Boolean* **As Boolean** |
| VB | *object*.**CellWordWrap** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CellWordWrap** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CellWordWrap** = *Boolean*;
**void** *object*->Put**CellWordWrap**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CellWordWrap**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Boolean
Defines whether the cell text may word-wrap within the available space in this column.
| Boolean | Description |
| --- | --- |
| True | Cell text may word-wrap within the available space. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property should be used to define the (maximum) number of text lines allowed. Word-wrap is only available if [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) is set to True used. |
| False | Cell text does not word-wrap. |
### Comments
The CellWordWrap property defines whether the cell text may word-wrap within the available space in this column.
See Also SftTreeColumn Object | Object Hierarchy
## CharSearchColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CharSearchColumn*
Defines the column searched for characters typed by the user.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CharSearchColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchColumn) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**CharSearchColumn** **As Short** |
| VB | *ColIndex* = *object*.**CharSearchColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**CharSearchColumn**; |
| VC++ | **short** *ColIndex* = *object*->**CharSearchColumn**;
**short** *ColIndex* = *object*->Get**CharSearchColumn**(); |
| C | **HRESULT** *object*->get_**CharSearchColumn**(**short*** *ColIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CharSearchColumn** = *ColIndex* **As Short** |
| VB | *object*.**CharSearchColumn** = *ColIndex* **As Integer** |
| C#.NET | **short** *object*.**CharSearchColumn** = *ColIndex*; |
| VC++ | **short** *object*->**CharSearchColumn** = *ColIndex*;
**void** *object*->Put**CharSearchColumn**(**short** *ColIndex*); |
| C | **HRESULT** *object*->put_**CharSearchColumn**(**short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
Defines the column searched for characters typed by the user. Specify -1 to search the first displayed column.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.CharSearchColumn instead
The CharSearchColumn property defines the column searched for characters typed by the user.
The Items.[CharSearchMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchMode) property defines the search mode for characters typed by the user.
See Also SftTree Object | Object Hierarchy
## CharSearchColumn Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchColumn*
Defines the column searched for characters typed by the user.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**CharSearchColumn** **As Short** |
| VB | *ColIndex* = *object*.**CharSearchColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**CharSearchColumn**; |
| VC++ | **short** *ColIndex* = *object*->**CharSearchColumn**;
**short** *ColIndex* = *object*->Get**CharSearchColumn**(); |
| C | **HRESULT** *object*->get_**CharSearchColumn**(**short*** *ColIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CharSearchColumn** = *ColIndex* **As Short** |
| VB | *object*.**CharSearchColumn** = *ColIndex* **As Integer** |
| C#.NET | **short** *object*.**CharSearchColumn** = *ColIndex*; |
| VC++ | **short** *object*->**CharSearchColumn** = *ColIndex*;
**void** *object*->Put**CharSearchColumn**(**short** *ColIndex*); |
| C | **HRESULT** *object*->put_**CharSearchColumn**(**short** *ColIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ColIndex
Defines the column searched for characters typed by the user. Specify -1 to search the first displayed column.
### Comments
The CharSearchColumn property defines the column searched for characters typed by the user.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CharSearchMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchMode) property defines the search mode for characters typed by the user.
See Also SftTreeItems Object | Object Hierarchy
## CharSearchMode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CharSearchMode*
Defines the search mode for characters typed by the user.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CharSearchMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchMode) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**CharSearchMode** **As [SftTreeCharSearchModeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCharSearchModeConstants)** |
| VB | *Style* = *object*.**CharSearchMode** **As SftTreeCharSearchModeConstants** |
| C#.NET | **SftTreeCharSearchModeConstants** *Style* = *object*.**CharSearchMode**; |
| VC++ | **enum SftTreeCharSearchModeConstants** *Style* = *object*->**CharSearchMode**;
**enum SftTreeCharSearchModeConstants** *Style* = *object*->Get**CharSearchMode**(); |
| C | **HRESULT** *object*->get_**CharSearchMode**(**enum SftTreeCharSearchModeConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CharSearchMode** = *Style* **As SftTreeCharSearchModeConstants** |
| VB | *object*.**CharSearchMode** = *Style* **As SftTreeCharSearchModeConstants** |
| C#.NET | **SftTreeCharSearchModeConstants** *object*.**CharSearchMode** = *Style*; |
| VC++ | **enum SftTreeCharSearchModeConstants** *object*->**CharSearchMode** = *Style*;
**void** *object*->Put**CharSearchMode**(**enum SftTreeCharSearchModeConstants** *Style*); |
| C | **HRESULT** *object*->put_**CharSearchMode**(**enum SftTreeCharSearchModeConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the search mode for characters typed by the user.
| Style | Value | Description |
| --- | --- | --- |
| searchSftTreeOneChar | 0 | Starting at the current item, the next item starting with the one single character typed is located and made current. [Collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent items are automatically expanded if a match is found. Collapsed parent items are automatically expanded if a match is found. The search ends once the end of the tree control items has been reached. |
| searchSftTreeAllChars | 1 | The first item in the tree control that matches the character(s) typed within a short time period is made current. As the user types additional characters, the search continues. If the user pauses for more than one second, the search ends. The next character typed starts a new search. Collapsed parent items are automatically expanded if a match is found. |
| searchSftTreeNone | 2 | Characters typed are ignored. |
| searchSftTreeAllChars2 | 3 | Like searchSftTreeAllChars, but does not automatically expand collapsed parent items. |
| searchSftTreeOneChar2 | 4 | Like searchSftTreeOneChar, but does not automatically expand collapsed parent items. |
| searchSftTreeOneCharWrap | 5 | Like searchSftTreeOneChar, but the search wraps around once the end of the tree control items has been reached. |
| searchSftTreeOneCharWrap2 | 6 | Like searchSftTreeOneCharWrap, but does not automatically expand collapsed parent items. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.CharSearchMode instead
The CharSearchMode property defines the search mode for characters typed by the user.
The Items.[CharSearchColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchColumn) property defines the column searched for characters typed by the user.
See Also SftTree Object | Object Hierarchy
## CharSearchMode Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchMode*
Defines the search mode for characters typed by the user.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**CharSearchMode** **As [SftTreeCharSearchModeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeCharSearchModeConstants)** |
| VB | *Style* = *object*.**CharSearchMode** **As SftTreeCharSearchModeConstants** |
| C#.NET | **SftTreeCharSearchModeConstants** *Style* = *object*.**CharSearchMode**; |
| VC++ | **enum SftTreeCharSearchModeConstants** *Style* = *object*->**CharSearchMode**;
**enum SftTreeCharSearchModeConstants** *Style* = *object*->Get**CharSearchMode**(); |
| C | **HRESULT** *object*->get_**CharSearchMode**(**enum SftTreeCharSearchModeConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CharSearchMode** = *Style* **As SftTreeCharSearchModeConstants** |
| VB | *object*.**CharSearchMode** = *Style* **As SftTreeCharSearchModeConstants** |
| C#.NET | **SftTreeCharSearchModeConstants** *object*.**CharSearchMode** = *Style*; |
| VC++ | **enum SftTreeCharSearchModeConstants** *object*->**CharSearchMode** = *Style*;
**void** *object*->Put**CharSearchMode**(**enum SftTreeCharSearchModeConstants** *Style*); |
| C | **HRESULT** *object*->put_**CharSearchMode**(**enum SftTreeCharSearchModeConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the search mode for characters typed by the user.
| Style | Value | Description |
| --- | --- | --- |
| searchSftTreeOneChar | 0 | Starting at the current item, the next item starting with the one single character typed is located and made current. |
| searchSftTreeAllChars | 1 | The first item in the tree control that matches the character(s) typed within a short time period is made current. As the user types additional characters, the search continues. If the user pauses for more than one second, the search ends. The next character typed starts a new search. |
| searchSftTreeNone | 2 | Characters typed are ignored. |
| searchSftTreeAllChars2 | 3 | Like searchSftTreeAllChars, but does not automatically expand [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent items. |
| searchSftTreeOneChar2 | 4 | Like searchSftTreeOneChar, but does not automatically expand collapsed parent items. |
| searchSftTreeOneCharWrap | 5 | Like searchSftTreeOneChar, but the search wraps around once the end of the tree control items has been reached. |
| searchSftTreeOneCharWrap2 | 6 | Like searchSftTreeOneChar2, but the search wraps around once the end of the tree control items has been reached. |
### Comments
The CharSearchMode property defines the search mode for characters typed by the user.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CharSearchColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CharSearchColumn) property defines the column searched for characters typed by the user.
See Also SftTreeItems Object | Object Hierarchy
## Clear Method, DataObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear*
Clears all data and formats in a [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Clear**() |
| VB | *object*.**Clear** |
| C#.NET | **void** *object*.**Clear**(); |
| VC++ | **HRESULT** *object*->**Clear**(); |
| C | **HRESULT** *object*->raw_**Clear**(); |
object
A DataObject object.
### Comments
The Clear method clears all data and formats in a DataObject object.
This method is available only for OLE drag sources. If Clear is called from a [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) component, an error is generated.
See Also DataObject Object | Object Hierarchy
## Clear Method, DataObjectFiles Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Clear*
Clears all filenames stored in the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject).[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Clear**() |
| VB | *object*.**Clear** |
| C#.NET | **void** *object*.**Clear**(); |
| VC++ | **HRESULT** *object*->**Clear**(); |
| C | **HRESULT** *object*->raw_**Clear**(); |
object
A [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles) object.
### Comments
The Clear method clears all filenames stored in the DataObject.Files collection (sftCFFiles format only).
To remove only one file name, use the DataObjectFiles.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Remove) method instead.
See Also DataObjectFiles Object | Object Hierarchy
## Clear Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Clear*
Clears the image object.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Clear**() |
| VB | *object*.**Clear** |
| C#.NET | **void** *object*.**Clear**(); |
| VC++ | **HRESULT** *object*->**Clear**(); |
| C | **HRESULT** *object*->raw_**Clear**(); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
### Comments
The Clear method clears the image object.
See Also SftPictureObject Object | Object Hierarchy
## Clear Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Clear*
Removes all items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Clear) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Clear**() |
| VB | *object*.**Clear** |
| C#.NET | **void** *object*.**Clear**(); |
| VC++ | **HRESULT** *object*->**Clear**(); |
| C | **HRESULT** *object*->raw_**Clear**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Clear instead
The Clear method removes all items.
See Also SftTree Object | Object Hierarchy
## Clear Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Clear*
Removes all items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Clear**() |
| VB | *object*.**Clear** |
| C#.NET | **void** *object*.**Clear**(); |
| VC++ | **HRESULT** *object*->**Clear**(); |
| C | **HRESULT** *object*->raw_**Clear**(); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Comments
The Clear method removes all items.
See Also SftTreeItems Object | Object Hierarchy
## ClearCellImages Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ClearCellImages*
Removes the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) images from this item.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearCellImages**() |
| VB | *object*.**ClearCellImages** |
| C#.NET | **void** *object*.**ClearCellImages**(); |
| VC++ | **HRESULT** *object*->**ClearCellImages**(); |
| C | **HRESULT** *object*->raw_**ClearCellImages**(); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
### Comments
The ClearCellImages method removes the cell images from this item.
Cells are otherwise unaffected. Their text, color and other properties remain unchanged. Individual cell graphics can be added or removed using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method can be used to remove the cell images from all items.
See Also SftTreeItem Object | Object Hierarchy
## ClearCellImages Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages*
Removes the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) images from all items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearCellImages**() |
| VB | *object*.**ClearCellImages** |
| C#.NET | **void** *object*.**ClearCellImages**(); |
| VC++ | **HRESULT** *object*->**ClearCellImages**(); |
| C | **HRESULT** *object*->raw_**ClearCellImages**(); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Comments
The ClearCellImages method removes the cell images from all items.
Cells are otherwise unaffected. Their text, color and other properties remain unchanged. Individual cell graphics can be added or removed using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ClearCellImages) method can be used to remove the cell images from one item.
See Also SftTreeItems Object | Object Hierarchy
## ClearCellPictures Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearCellPictures*
Removes the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphics from all items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearCellPictures**() |
| VB | *object*.**ClearCellPictures** |
| C#.NET | **void** *object*.**ClearCellPictures**(); |
| VC++ | **HRESULT** *object*->**ClearCellPictures**(); |
| C | **HRESULT** *object*->raw_**ClearCellPictures**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ClearCellImages instead
The ClearCellPictures method removes the cell graphics from all items.
Cells are otherwise unaffected. Their text, color and other properties remain unchanged. Individual cell graphics can be added or removed using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
See Also SftTree Object | Object Hierarchy
## ClearImages Method, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages*
Removes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) images from all items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearImages**() |
| VB | *object*.**ClearImages** |
| C#.NET | **void** *object*.**ClearImages**(); |
| VC++ | **HRESULT** *object*->**ClearImages**(); |
| C | **HRESULT** *object*->raw_**ClearImages**(); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
### Comments
The ClearImages method removes the row header images from all items.
Row headers are otherwise unaffected. Their text, color and other properties remain unchanged. Individual row header graphics can be added or removed using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property.
See Also SftTreeRowHeaders Object | Object Hierarchy
## ClearItemImages Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages*
Removes the item images from all items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearItemImages**() |
| VB | *object*.**ClearItemImages** |
| C#.NET | **void** *object*.**ClearItemImages**(); |
| VC++ | **HRESULT** *object*->**ClearItemImages**(); |
| C | **HRESULT** *object*->raw_**ClearItemImages**(); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Comments
The ClearItemImages method removes the item images from all items.
The ClearItemImages method removes all item graphics from all items, including the graphics defined using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties. Items are otherwise unaffected. Their text, color and other properties remain unchanged. Individual item graphics can be added or removed using the Item.Image property.
See Also SftTreeItems Object | Object Hierarchy
## ClearItemPictures Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearItemPictures*
Removes the item graphics from all items.
> Deprecated - Provided for compatibility with earlier versions only - [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearItemPictures**() |
| VB | *object*.**ClearItemPictures** |
| C#.NET | **void** *object*.**ClearItemPictures**(); |
| VC++ | **HRESULT** *object*->**ClearItemPictures**(); |
| C | **HRESULT** *object*->raw_**ClearItemPictures**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Items.ClearItemImages instead
The ClearItemPictures method removes the item graphics from all items.
The ClearItemPictures method removes all item graphics from all items, including the graphics defined using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties. Items are otherwise unaffected. Their text, color and other properties remain unchanged. Individual item graphics can be added or removed using the Item.Image property.
See Also SftTree Object | Object Hierarchy
## ClearLabelImages Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages*
Removes the label images from all items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearLabelImages**() |
| VB | *object*.**ClearLabelImages** |
| C#.NET | **void** *object*.**ClearLabelImages**(); |
| VC++ | **HRESULT** *object*->**ClearLabelImages**(); |
| C | **HRESULT** *object*->raw_**ClearLabelImages**(); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Comments
The ClearLabelImages method removes the label images from all items.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are otherwise unaffected. Their text, color and other properties remain unchanged. Individual label graphics can be added or removed using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage) property.
See Also SftTreeItems Object | Object Hierarchy
## ClearLabelPictures Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearLabelPictures*
Removes the label graphics from all items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ClearLabelImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearLabelPictures**() |
| VB | *object*.**ClearLabelPictures** |
| C#.NET | **void** *object*.**ClearLabelPictures**(); |
| VC++ | **HRESULT** *object*->**ClearLabelPictures**(); |
| C | **HRESULT** *object*->raw_**ClearLabelPictures**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ClearLabelImages instead
The ClearLabelPictures method removes the label graphics from all items.
Items are otherwise unaffected. Their text, color and other properties remain unchanged. Individual label graphics can be added or removed using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage) property.
See Also SftTree Object | Object Hierarchy
## ClearRowHeaderPictures Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ClearRowHeaderPictures*
Removes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) graphics from all items.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ClearImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearRowHeaderPictures**() |
| VB | *object*.**ClearRowHeaderPictures** |
| C#.NET | **void** *object*.**ClearRowHeaderPictures**(); |
| VC++ | **HRESULT** *object*->**ClearRowHeaderPictures**(); |
| C | **HRESULT** *object*->raw_**ClearRowHeaderPictures**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.ClearImages instead
The ClearRowHeaderPictures method removes the row header graphics from all items.
Row headers are otherwise unaffected. Their text, color and other properties remain unchanged. Individual row header graphics can be added or removed using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property.
See Also SftTree Object | Object Hierarchy
## ClearSortIndicators Method, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ClearSortIndicators*
Clears all [sort indicators](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) in all columns.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ClearSortIndicators**() |
| VB | *object*.**ClearSortIndicators** |
| C#.NET | **void** *object*.**ClearSortIndicators**(); |
| VC++ | **HRESULT** *object*->**ClearSortIndicators**(); |
| C | **HRESULT** *object*->raw_**ClearSortIndicators**(); |
object
### Comments
The ClearSortIndicators method Clears all sort indicators in all columns.
The sort order of the tree items is not changed. Only the visual sort indicators are removed.
See Also [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) Object | Object Hierarchy
## Click Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click*
The selection changes.
> Deprecated - Provided for compatibility with earlier versions only - Use the [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) event instead
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ClickEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ClickEvent** |
| VB | **Private Sub** *object*_**Click**() |
| C#.NET | **void** *object*_**ClickEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**Click***object*(); |
| C | **HRESULT** On**Click***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use the SelectionChange event instead
The Click event occurs when the selection changes.
The Click event is not limited to mouse events as the selection can change through keyboard input also. To determine which mouse button was pressed and/or in which area of the tree control the mouse button was pressed, use the [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) or [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) property can be used to control the areas that cause a selection change.
See Also SftTree Object | Object Hierarchy
## ColHeaderAppearance Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderAppearance*
Defines the appearance of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ColHeaderAppearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**ColHeaderAppearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**ColHeaderAppearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**ColHeaderAppearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**ColHeaderAppearance**(); |
| C | **HRESULT** *object*->get_**ColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderAppearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**ColHeaderAppearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**ColHeaderAppearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**ColHeaderAppearance** = *Style*;
**void** *object*->Put**ColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**ColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the appearance of all column headers.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | No column header. The column headers and row/column header are not displayed. The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is also set to headerSftTreeNone. |
| headerSftTreeButton | 1 | Displays column headers as buttons. The column headers are displayed as buttons, which can be clicked by the user. The status of the each column header button can be controlled using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) and Header.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) properties. The currently pressed button can be defined using the Headers.[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) property. |
| headerSftTreeText | 2 | Displays column headers as titles. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Appearance instead
The ColHeaderAppearance property defines the appearance of all column headers.
See Also SftTree Object | Object Hierarchy
## ColHeaderBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderBackColor*
Defines the background color for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ColHeaderBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColHeaderBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ColHeaderBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColHeaderBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**ColHeaderBackColor**(); |
| C | **HRESULT** *object*->get_**ColHeaderBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ColHeaderBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ColHeaderBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ColHeaderBackColor** = *Clr*;
**void** *object*->Put**ColHeaderBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColHeaderBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the background color for all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.BackColor instead
The ColHeaderBackColor property defines the background color for all column headers.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## ColHeaderButton Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderButton*
Defines the currently pressed [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button.
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ColHeaderButton** **As Short** |
| VB | *ColIndex* = *object*.**ColHeaderButton** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**ColHeaderButton**; |
| VC++ | **short** *ColIndex* = *object*->**ColHeaderButton**;
**short** *ColIndex* = *object*->Get**ColHeaderButton**(); |
| C | **HRESULT** *object*->get_**ColHeaderButton**(**short*** *ColIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderButton** = *ColIndex* **As Short** |
| VB | *object*.**ColHeaderButton** = *ColIndex* **As Integer** |
| C#.NET | **short** *object*.**ColHeaderButton** = *ColIndex*; |
| VC++ | **short** *object*->**ColHeaderButton** = *ColIndex*;
**void** *object*->Put**ColHeaderButton**(**short** *ColIndex*); |
| C | **HRESULT** *object*->put_**ColHeaderButton**(**short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number of the header button that is currently pressed. This can be -1 if no column header button is pressed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Pressed instead
The ColHeaderButton property defines the currently pressed column header button.
Only one button can be pressed at a time. All buttons can be reset by specifying -1 as *ColIndex*.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) property can be used to allow header buttons to automatically return to their "up" position, so the ColHeaderButton property does not have to be used.
See Also SftTree Object | Object Hierarchy
## ColHeaderEnabled Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderEnabled*
Defines whether the specified [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) is enabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Enabled* = *object*.get_**ColHeaderEnabled**(**ByVal** *ColIndex* **As Short**) **As Boolean** |
| VB | *Enabled* = *object*.**ColHeaderEnabled**(**ByVal** *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Enabled* = *object*.get_**ColHeaderEnabled**(**short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *Enabled* = *object*->**ColHeaderEnabled**[**short** *ColIndex*];
**VARIANT_BOOL** *Enabled* = *object*->Get**ColHeaderEnabled**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColHeaderEnabled**(**short** *ColIndex*, **VARIANT_BOOL*** *Enabled*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColHeaderEnabled**(**ByVal** *ColIndex* **As Short**, **ByVal** *Enabled* **As Boolean**) |
| VB | *object*.**ColHeaderEnabled**(**ByVal** *ColIndex* **As Integer**) = *Enabled* **As Boolean** |
| C#.NET | **void** *object*.set_**ColHeaderEnabled**(**short** *ColIndex*, **bool** *Enabled*); |
| VC++ | **VARIANT_BOOL** *object*->**ColHeaderEnabled**[**short** *ColIndex*] = *Enabled*;
**void** *object*->Put**ColHeaderEnabled**(**short** *ColIndex*, **VARIANT_BOOL** *Enabled*); |
| C | **HRESULT** *object*->put_**ColHeaderEnabled**(**short** *ColIndex*, **VARIANT_BOOL** *Enabled*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Enabled
Defines whether the specified column header is enabled.
| Boolean | Description |
| --- | --- |
| True | The column header is enabled. |
| False | The column header is disabled. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.Enabled instead
The ColHeaderEnabled property defines whether the specified column header is enabled.
A disabled column header is drawn using the [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor) property value as text color and column header graphics (see Header.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) property) are drawn in a "grayed" fashion, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled column header button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) or [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events.
See Also SftTree Object | Object Hierarchy
## ColHeaderFont Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderFont*
Defines the font used for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Font) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**ColHeaderFont** **As System.Drawing.Font[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**ColHeaderFont** **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *refFontObj* = *object*.**ColHeaderFont**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**ColHeaderFont**(); |
| C | **HRESULT** *object*->get_**ColHeaderFont**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ColHeaderFont**(**ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | *object*.**ColHeaderFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**ColHeaderFont**(**System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->Put**ColHeaderFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**ColHeaderFont**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderFont** = *refFontObj* **As System.Drawing.Font** |
| VB | **Set** *object*.**ColHeaderFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *object*.**ColHeaderFont** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**ColHeaderFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**ColHeaderFont**(**IFontDisp*** *refFontObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refFontObj
Defines the font used for all column headers. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Font instead
The ColHeaderFont property defines the font used for all column headers.
The ColHeaderFont property is used to change the font for all column headers and the row/column header.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ColHeaderForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderForeColor*
Defines the text color for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ColHeaderForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColHeaderForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ColHeaderForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColHeaderForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ColHeaderForeColor**(); |
| C | **HRESULT** *object*->get_**ColHeaderForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ColHeaderForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ColHeaderForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ColHeaderForeColor** = *Clr*;
**void** *object*->Put**ColHeaderForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColHeaderForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color for all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.ForeColor instead
The ColHeaderForeColor property defines the text color for all column headers.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## ColHeaderGrayedColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderGrayedColor*
Defines the text color used to draw all disabled [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ColHeaderGrayedColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColHeaderGrayedColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ColHeaderGrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColHeaderGrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**ColHeaderGrayedColor**(); |
| C | **HRESULT** *object*->get_**ColHeaderGrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderGrayedColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ColHeaderGrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ColHeaderGrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ColHeaderGrayedColor** = *Clr*;
**void** *object*->Put**ColHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw all disabled column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.GrayedColor instead
The ColHeaderGrayedColor property defines the text color used to draw all disabled column headers.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property is used to enable and disable individual column headers.
All column headers use the same grayed text color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## ColHeaderHilightColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderHilightColor*
Defines the color used to draw the highlighted edge of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_HilightColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ColHeaderHilightColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColHeaderHilightColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ColHeaderHilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColHeaderHilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**ColHeaderHilightColor**(); |
| C | **HRESULT** *object*->get_**ColHeaderHilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderHilightColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ColHeaderHilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ColHeaderHilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ColHeaderHilightColor** = *Clr*;
**void** *object*->Put**ColHeaderHilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColHeaderHilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the highlighted edge of all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.HilightColor instead
The ColHeaderHilightColor property defines the color used to draw the highlighted edge of all column headers.
All column headers use the same highlight color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## ColHeaderShadowColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColHeaderShadowColor*
Defines the color used to draw the dark edge of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ShadowColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ColHeaderShadowColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColHeaderShadowColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ColHeaderShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColHeaderShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ColHeaderShadowColor**(); |
| C | **HRESULT** *object*->get_**ColHeaderShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ColHeaderShadowColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ColHeaderShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ColHeaderShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ColHeaderShadowColor** = *Clr*;
**void** *object*->Put**ColHeaderShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColHeaderShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the dark edge of all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.ShadowColor instead
The ColHeaderShadowColor property defines the color used to draw the dark edge of all column headers.
All columns use the same shadow color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## Collapse Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Collapse*
Collapses an item so its dependents are no longer visible.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Collapse**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Preserve* **As Boolean**) |
| VB | *object*.**Collapse**(**ByVal** *ItemIndex* **As Long**, **ByVal** *Preserve* **As Boolean**) |
| C#.NET | **void** *object*.**Collapse**(**int** *ItemIndex*, **bool** *Preserve*); |
| VC++ | **HRESULT** *object*->**Collapse**(**long** *ItemIndex*, **VARIANT_BOOL** *Preserve*); |
| C | **HRESULT** *object*->raw_**Collapse**(**long** *ItemIndex*, **VARIANT_BOOL** *Preserve*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to collapse. If -1 is specified, all items on level 0 are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
Preserve
Defines whether the expand/collapse state is preserved.
| Preserve | Description |
| --- | --- |
| True | Preserves the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items that are made no longer visible. A subsequent call to Items.[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) or Item.[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) will restore the items with the remembered expand/collapse state. |
| False | The expand/collapse state is not preserved. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Collapse and Item.Collapse instead
The Collapse method collapses an item so its dependents are no longer visible.
The Collapse method collapses all dependent items of item *ItemIndex* and saves the expand/collapse state of all dependent items, so it can be restored by a subsequent Items.Expand or Item.Expand method call.
If a parent item is collapsed, subsequently adding child items will automatically expand the item.
See Also SftTree Object | Object Hierarchy
## Collapse Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse*
Collapses the item so its dependents are no longer visible.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Collapse**(**ByVal** *Preserve* **As Boolean**) |
| VB | *object*.**Collapse**(**ByVal** *Preserve* **As Boolean**) |
| C#.NET | **void** *object*.**Collapse**(**bool** *Preserve*); |
| VC++ | **HRESULT** *object*->**Collapse**(**VARIANT_BOOL** *Preserve*); |
| C | **HRESULT** *object*->raw_**Collapse**(**VARIANT_BOOL** *Preserve*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Preserve
Defines whether the expand/collapse state is preserved.
| Preserve | Description |
| --- | --- |
| True | Preserves the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items that are made no longer visible. A subsequent call to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) will restore the items with the remembered expand/collapse state. |
| False | The expand/collapse state is not preserved. |
### Comments
The Collapse method collapses the item so its dependents are no longer visible.
The Collapse method collapses all dependent items of the item and saves the expand/collapse state of all dependent items, so it can be restored by a subsequent Items.Expand or Item.Expand method call.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
See Also SftTreeItem Object | Object Hierarchy
## Collapse Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse*
Collapses all items so no child items are visible.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Collapse**(**ByVal** *Preserve* **As Boolean**) |
| VB | *object*.**Collapse**(**ByVal** *Preserve* **As Boolean**) |
| C#.NET | **void** *object*.**Collapse**(**bool** *Preserve*); |
| VC++ | **HRESULT** *object*->**Collapse**(**VARIANT_BOOL** *Preserve*); |
| C | **HRESULT** *object*->raw_**Collapse**(**VARIANT_BOOL** *Preserve*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Preserve
Defines whether the expand/collapse state is preserved.
| Preserve | Description |
| --- | --- |
| True | Preserves the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items that are made no longer visible. A subsequent call to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) will restore the items with the remembered expand/collapse state. |
| False | The expand/collapse state is not preserved. |
### Comments
The Collapse method collapses all items so no child items are visible.
The Collapse method collapses all dependent items of all items and saves the expand/collapse state of all dependent items, so it can be restored by a subsequent Items.Expand or Item.Expand method call. The Collapse method visits each item on level 0 and collapses it. Items on other levels are not [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
If a parent item is collapsed, subsequently adding child items will automatically expand the item.
See Also SftTreeItems Object | Object Hierarchy
## Column Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column*
Returns a [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object for a given column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refColumnObj* = *object*.get_**Column**(**ByVal** *ColIndex* **As Short**) **As SftTreeColumn** |
| VB | **Set** *refColumnObj* = *object*.**Column**(**ByVal** *ColIndex* **As Integer**) **As SftTreeColumn** |
| C#.NET | **SftTreeColumn** *refColumnObj* = *object*.get_**Column**(**short** *ColIndex*); |
| VC++ | **ISftTreeColumn*** *refColumnObj* = *object*->**Column**[**short** *ColIndex*];
**ISftTreeColumn*** *refColumnObj* = *object*->Get**Column**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**Column**(**short** *ColIndex*, **ISftTreeColumn**** *refColumnObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
refColumnObj
Returns a SftTreeColumn object for a given column.
### Comments
The Column property returns a SftTreeColumn object for a given column.
The SftTreeColumn object represents one column in a SftTree/OCX control. Numerous column-specific properties and methods can be accessed using the returned object *refColumnObj*.
Certain default properties and behavior for all columns can be defined using the [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
See Also SftTree Object | Object Hierarchy
## Column Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Column*
Defines the number of columns displayed in the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**Column** **As Short** |
| VB | *Count* = *object*.**Column** **As Integer** |
| C#.NET | **short** *Count* = *object*.**Column**; |
| VC++ | **short** *Count* = *object*->**Column**;
**short** *Count* = *object*->Get**Column**(); |
| C | **HRESULT** *object*->get_**Column**(**short*** *Count*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Column** = *Count* **As Short** |
| VB | *object*.**Column** = *Count* **As Integer** |
| C#.NET | **short** *object*.**Column** = *Count*; |
| VC++ | **short** *object*->**Column** = *Count*;
**void** *object*->Put**Column**(**short** *Count*); |
| C | **HRESULT** *object*->put_**Column**(**short** *Count*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Count
Defines the number of columns displayed in the left pane of a split tree control. The number specified must be between 1 and the total number of columns-1.
### Comments
The Column property defines the number of columns displayed in the left pane of a split tree control.
The total number of columns is defined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property.
See Also SftTreeSplitter Object | Object Hierarchy
## ColumnBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnBackColor*
Defines the background color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**ColumnBackColor**(**ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColumnBackColor**(**ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**ColumnBackColor**(**short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColumnBackColor**[**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**ColumnBackColor**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnBackColor**(**short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnBackColor**(**ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**ColumnBackColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**ColumnBackColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**ColumnBackColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**ColumnBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColumnBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Clr
Defines the background color of cells in the specified column. The valid range for a color value is 0 to 16,777,215 (&HFFFFFF). The high order byte of a number in this range equals 0; the lower 3 bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF). If the high byte is not 0, the system colors as defined in Control Panel's settings are used. See your development environment's documentation for color constants.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.BackColor instead
The ColumnBackColor property defines the background color of cells in the specified column *ColIndex* of items that are not selected.
Cells can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property for only portions of the item, the Column.BackColor property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ColumnButtonRemainUp Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnButtonRemainUp*
Defines whether the specified [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button will return to its "up" position when pressed.
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *RemainUp* = *object*.get_**ColumnButtonRemainUp**(**ByVal** *ColIndex* **As Short**) **As Boolean** |
| VB | *RemainUp* = *object*.**ColumnButtonRemainUp**(**ByVal** *ColIndex* **As Integer**) **As Boolean** |
| C#.NET | **bool** *RemainUp* = *object*.get_**ColumnButtonRemainUp**(**short** *ColIndex*); |
| VC++ | **VARIANT_BOOL** *RemainUp* = *object*->**ColumnButtonRemainUp**[**short** *ColIndex*];
**VARIANT_BOOL** *RemainUp* = *object*->Get**ColumnButtonRemainUp**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnButtonRemainUp**(**short** *ColIndex*, **VARIANT_BOOL*** *RemainUp*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnButtonRemainUp**(**ByVal** *ColIndex* **As Short**, **ByVal** *RemainUp* **As Boolean**) |
| VB | *object*.**ColumnButtonRemainUp**(**ByVal** *ColIndex* **As Integer**) = *RemainUp* **As Boolean** |
| C#.NET | **void** *object*.set_**ColumnButtonRemainUp**(**short** *ColIndex*, **bool** *RemainUp*); |
| VC++ | **VARIANT_BOOL** *object*->**ColumnButtonRemainUp**[**short** *ColIndex*] = *RemainUp*;
**void** *object*->Put**ColumnButtonRemainUp**(**short** *ColIndex*, **VARIANT_BOOL** *RemainUp*); |
| C | **HRESULT** *object*->put_**ColumnButtonRemainUp**(**short** *ColIndex*, **VARIANT_BOOL** *RemainUp*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
RemainUp
Defines whether the specified column header button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The column header button will return to its "up" position when pressed. |
| False | The column header button remains pressed. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.RemainUp instead
The ColumnButtonRemainUp property defines whether the specified column header button will return to its "up" position when pressed.
If column headers are not shown or column headers are shown as titles (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property), this property has no effect.
See Also SftTree Object | Object Hierarchy
## ColumnCount Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ColumnCount*
Returns the current number of columns.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Total* = *object*.**ColumnCount** **As Short** |
| VB | *Total* = *object*.**ColumnCount** **As Integer** |
| C#.NET | **short** *Total* = *object*.**ColumnCount**; |
| VC++ | **short** *Total* = *object*->**ColumnCount**;
**short** *Total* = *object*->Get**ColumnCount**(); |
| C | **HRESULT** *object*->get_**ColumnCount**(**short*** *Total*); |
object
A [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem) object.
Total
Returns the current number of columns.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.Count instead
The ColumnCount property returns the current number of columns.
See Also VirtualItem Object | Object Hierarchy
## ColumnForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnForeColor*
Defines the text color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**ColumnForeColor**(**ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColumnForeColor**(**ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**ColumnForeColor**(**short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColumnForeColor**[**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**ColumnForeColor**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnForeColor**(**short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnForeColor**(**ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**ColumnForeColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**ColumnForeColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**ColumnForeColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**ColumnForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColumnForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Clr
Defines the text color of cells in the specified column. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.ForeColor instead
The ColumnForeColor property defines the text color of cells in the specified column *ColIndex* of items that are not selected.
Cells can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property for only portions of the item, the Column.ForeColor property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ColumnIndex Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ColumnIndex*
Returns the column index of this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ColumnIndex** **As Short** |
| VB | *ColIndex* = *object*.**ColumnIndex** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**ColumnIndex**; |
| VC++ | **short** *ColIndex* = *object*->**ColumnIndex**;
**short** *ColIndex* = *object*->Get**ColumnIndex**(); |
| C | **HRESULT** *object*->get_**ColumnIndex**(**short*** *ColIndex*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
ColIndex
Returns the column index of this cell.
### Comments
The ColumnIndex property returns the column index of this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ItemIndex) property can be used to retrieve the item index of this cell.
See Also SftTreeCell Object | Object Hierarchy
## ColumnIndex Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex*
Returns the [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number given a display position of a column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ColumnIndex**(**ByVal** *DispColIndex* **As Short**) **As Short** |
| VB | *ColIndex* = *object*.**ColumnIndex**(**ByVal** *DispColIndex* **As Integer**) **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.get_**ColumnIndex**(**short** *DispColIndex*); |
| VC++ | **short** *ColIndex* = *object*->**ColumnIndex**[**short** *DispColIndex*];
**short** *ColIndex* = *object*->Get**ColumnIndex**(**short** *DispColIndex*); |
| C | **HRESULT** *object*->get_**ColumnIndex**(**short** *DispColIndex*, **short*** *ColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
DispColIndex
The display column number whose real column number is to be returned.
ColIndex
Returns the real column number given a display position of a column.
### Comments
The ColumnIndex property returns the real column number given a display position of a column.
As a user reorders columns, this is completely transparent to the application. An application still references [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.
If a user reorders columns using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop), the (display) column numbers, which is the column number as it appears to the user, may need to be translated into the real column number as used by an application.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) method can be used to reorder columns under program control.
See Also SftTreeColumns Object | Object Hierarchy
## ColumnMinWidth Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnMinWidth*
Defines the minimum width of the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.get_**ColumnMinWidth**(**ByVal** *ColIndex* **As Short**) **As Single** |
| VB | *Width* = *object*.**ColumnMinWidth**(**ByVal** *ColIndex* **As Integer**) **As Single** |
| C#.NET | **float** *Width* = *object*.get_**ColumnMinWidth**(**short** *ColIndex*); |
| VC++ | **float** *Width* = *object*->**ColumnMinWidth**[**short** *ColIndex*];
**float** *Width* = *object*->Get**ColumnMinWidth**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnMinWidth**(**short** *ColIndex*, **float*** *Width*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnMinWidth**(**ByVal** *ColIndex* **As Short**, **ByVal** *Width* **As Single**) |
| VB | *object*.**ColumnMinWidth**(**ByVal** *ColIndex* **As Integer**) = *Width* **As Single** |
| C#.NET | **void** *object*.set_**ColumnMinWidth**(**short** *ColIndex*, **float** *Width*); |
| VC++ | **float** *object*->**ColumnMinWidth**[**short** *ColIndex*] = *Width*;
**void** *object*->Put**ColumnMinWidth**(**short** *ColIndex*, **float** *Width*); |
| C | **HRESULT** *object*->put_**ColumnMinWidth**(**short** *ColIndex*, **float** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Width
Defines the minimum width of the specified column. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.MinWidth instead
The ColumnMinWidth property defines the minimum width of the specified column.
The ColumnMinWidth property is used to change the minimum width of a column. The minimum column width must be less than or equal to the column's defined width. The column width can be defined using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The minimum column width is only used to prevent the user from resizing the column and making it smaller than the defined minimum width.
See Also SftTree Object | Object Hierarchy
## ColumnPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPicture*
Defines the graphic displayed in the specified [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.get_**ColumnPicture**(**ByVal** *ColIndex* **As Short**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ColumnPicture**(**ByVal** *ColIndex* **As Integer**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.get_**ColumnPicture**(**short** *ColIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ColumnPicture**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnPicture**(**short** *ColIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ColumnPicture**(**ByVal** *ColIndex* **As Short**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ColumnPicture**(**ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ColumnPicture**(**short** *ColIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ColumnPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ColumnPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnPicture**(**ByVal** *ColIndex* **As Short**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | **Set** *object*.**ColumnPicture**(**ByVal** *ColIndex* **As Integer**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**ColumnPicture**(**short** *ColIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**ColumnPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ColumnPicture**(**short** *ColIndex*, **IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
refPictureObj
Defines the graphic displayed in the specified column header. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.Image.Picture instead
The ColumnPicture property defines the graphic displayed in the specified column header.
The ColumnPicture and [ColumnPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
All graphics used in a tree control as ColumnPicture or Header.Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the column headers, so graphics used as ColumnPicture or Header.Image property are never clipped vertically. To change the column header graphic size, all column header graphics must be removed first by setting the ColumnPicture and Header.Image properties to Nothing (NULL) for each column before assigning new column header graphics.
If a column header is disabled (see Header.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ColumnPicture property can be set to the value Nothing (NULL), which removes the graphic from the column header.
The position of the column header graphic is determined by the Header.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign), Header.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign) and Header.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) properties.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ColumnPictureAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPictureAlign*
Defines the position of the graphic displayed in the specified [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign) and Header.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**ColumnPictureAlign**(**ByVal** *ColIndex* **As Short**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**ColumnPictureAlign**(**ByVal** *ColIndex* **As Integer**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**ColumnPictureAlign**(**short** *ColIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**ColumnPictureAlign**[**short** *ColIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**ColumnPictureAlign**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnPictureAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnPictureAlign**(**ByVal** *ColIndex* **As Short**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**ColumnPictureAlign**(**ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**ColumnPictureAlign**(**short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**ColumnPictureAlign**[**short** *ColIndex*] = *Align*;
**void** *object*->Put**ColumnPictureAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**ColumnPictureAlign**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Align
Defines the position of the graphic displayed in the specified column header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the column header text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the column header. The column header text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the column header text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.ImageHAlign and Header.ImageVAlign instead
The ColumnPictureAlign property defines the position of the graphic displayed in the specified column header.
The column header graphic is defined using the Header.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) property.
See Also SftTree Object | Object Hierarchy
## ColumnPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPictureH*
Defines the graphic displayed in a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.get_**ColumnPictureH**(**ByVal** *ColIndex* **As Short**) **As Integer** |
| VB | *Handle* = *object*.**ColumnPictureH**(**ByVal** *ColIndex* **As Integer**) **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.get_**ColumnPictureH**(**short** *ColIndex*); |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ColumnPictureH**[**short** *ColIndex*];
**OLE_HANDLE** *Handle* = *object*->Get**ColumnPictureH**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnPictureH**(**short** *ColIndex*, **OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnPictureH**(**ByVal** *ColIndex* **As Short**, **ByVal** *Handle* **As Integer**) |
| VB | *object*.**ColumnPictureH**(**ByVal** *ColIndex* **As Integer**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**ColumnPictureH**(**short** *ColIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**ColumnPictureH**[**short** *ColIndex*] = *Handle*;
**void** *object*->Put**ColumnPictureH**(**short** *ColIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ColumnPictureH**(**short** *ColIndex*, **OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Handle
A bitmap handle. Defines the graphic displayed in a column header. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.Image.PictureH instead
The ColumnPictureH property defines the graphic displayed in a column header.
The [ColumnPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnPicture) and ColumnPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
All graphics used in a tree control as ColumnPictureH or Header.Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the column headers, so graphics used as ColumnPictureH or Header.Image property are never clipped vertically. To change the column header graphic size, all column header graphics must be removed first by setting the ColumnPictureH and Header.Image properties to Nothing (NULL) for each column before assigning new column header graphics.
If a column header is disabled (see Header.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ColumnPictureH property can be set to the value Nothing (NULL), which removes the graphic from the column header.
The position of the column header graphic is determined by the Header.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign), Header.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign) and Header.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) properties.
See Also SftTree Object | Object Hierarchy
## Columns Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns*
Defines the number of columns.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *NumCols* = *object*.**Columns** **As Short** |
| VB | *NumCols* = *object*.**Columns** **As Integer** |
| C#.NET | **short** *NumCols* = *object*.**Columns**; |
| VC++ | **short** *NumCols* = *object*->**Columns**;
**short** *NumCols* = *object*->Get**Columns**(); |
| C | **HRESULT** *object*->get_**Columns**(**short*** *NumCols*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Columns** = *NumCols* **As Short** |
| VB | *object*.**Columns** = *NumCols* **As Integer** |
| C#.NET | **short** *object*.**Columns** = *NumCols*; |
| VC++ | **short** *object*->**Columns** = *NumCols*;
**void** *object*->Put**Columns**(**short** *NumCols*); |
| C | **HRESULT** *object*->put_**Columns**(**short** *NumCols*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
NumCols
Defines the number of columns.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.Count instead
The Columns property defines the number of columns.
The number of columns can only be changed if a tree control is empty. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Clear) method can be used to remove all items from a tree control.
Additional columns are always added at the end of the list of columns. Existing column properties are not changed. Default values are used for the new columns added. These can be changed using the column related properties. The last column will be defined using an explicit column width. If an [open-ended column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) is desired, use the ColumnsObj.OpenEnded property to redefine the last column.
See Also SftTree Object | Object Hierarchy
## ColumnSelectBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnSelectBackColor*
Defines the background color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**ColumnSelectBackColor**(**ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColumnSelectBackColor**(**ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**ColumnSelectBackColor**(**short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColumnSelectBackColor**[**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**ColumnSelectBackColor**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnSelectBackColor**(**short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnSelectBackColor**(**ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**ColumnSelectBackColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**ColumnSelectBackColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**ColumnSelectBackColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**ColumnSelectBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColumnSelectBackColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Clr
Defines the background color of selected items in the specified column. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.SelectBackColor instead
The ColumnSelectBackColor property defines the background color of selected items in the specified column *ColIndex* of items that are selected.
[Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Column.SelectBackColor property for only portions of the item, the Column.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ColumnSelectForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnSelectForeColor*
Defines the text color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**ColumnSelectForeColor**(**ByVal** *ColIndex* **As Short**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ColumnSelectForeColor**(**ByVal** *ColIndex* **As Integer**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**ColumnSelectForeColor**(**short** *ColIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ColumnSelectForeColor**[**short** *ColIndex*];
**OLE_COLOR** *Clr* = *object*->Get**ColumnSelectForeColor**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnSelectForeColor**(**short** *ColIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnSelectForeColor**(**ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**ColumnSelectForeColor**(**ByVal** *ColIndex* **As Integer**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**ColumnSelectForeColor**(**short** *ColIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**ColumnSelectForeColor**[**short** *ColIndex*] = *Clr*;
**void** *object*->Put**ColumnSelectForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ColumnSelectForeColor**(**short** *ColIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Clr
Defines the text color of selected items in the specified column. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.SelectForeColor instead
The ColumnSelectForeColor property defines the text color of selected items in the specified column *ColIndex* of items that are selected.
[Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If a selected item uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Column.SelectForeColor property for only portions of the item, the Column.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ColumnSize Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize*
The user resizes the columns.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ColumnSize**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ColumnSize** |
| VB | **Private Sub** *object*_**ColumnSize**() |
| C#.NET | **void** *object*_**ColumnSize**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ColumnSize***object*(); |
| C | **HRESULT** On**ColumnSize***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The ColumnSize event occurs when the user resizes the columns or moves the vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control.
When a user is about to resize a column, the [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) event occurs (as the user presses the left mouse button in the [column resizing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnresizing) area, before the column width changes). As the column is resized, the ColumnSize event can occur multiple times. Once the user releases the mouse button used to resize the column, the [ColumnSizeEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeEnded) event occurs. These events also occur identically during splitter bar resizing.
The ColumnSize event allows the application to adjust the column sizes if necessary, after the user resizes the columns.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ResizeColumn) property contains the number of the column being resized or -1 if the vertical splitter bar of a split tree control is moved.
The Headers.[Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable) property can be used to disable resizable columns. Individual columns can be locked in size by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked) property.
See Also SftTree Object | Object Hierarchy
## ColumnSizeEnded Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeEnded*
The user has stopped resizing the columns.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ColumnSizeEnded**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ColumnSizeEnded** |
| VB | **Private Sub** *object*_**ColumnSizeEnded**() |
| C#.NET | **void** *object*_**ColumnSizeEnded**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ColumnSizeEnded***object*(); |
| C | **HRESULT** On**ColumnSizeEnded***object*(); |
object
A SftTreeEvents object.
### Comments
The ColumnSizeEnded event occurs when the user has stopped resizing the columns.
When a user is about to resize a column, the [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) event occurs as the user presses the left mouse button in the [column resizing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnresizing) area, before the column width changes. As the column is resized, the [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) event can occur multiple times. Once the user releases the mouse button used to resize the column, the ColumnSizeEnded event occurs. These events also occur identically during [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) resizing.
See Also SftTreeEvents Object | Object Hierarchy
## ColumnSizeStarted Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted*
The user is about to resize the columns.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ColumnSizeStarted**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ColumnSizeStarted** |
| VB | **Private Sub** *object*_**ColumnSizeStarted**() |
| C#.NET | **void** *object*_**ColumnSizeStarted**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ColumnSizeStarted***object*(); |
| C | **HRESULT** On**ColumnSizeStarted***object*(); |
object
A SftTreeEvents object.
### Comments
The ColumnSizeStarted event occurs when the user is about to resize the columns.
When a user is about to resize a column, the ColumnSizeStarted event occurs as the user presses the left mouse button in the [column resizing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnresizing) area, before the column width changes. As the column is resized, the [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) event can occur multiple times. Once the user releases the mouse button used to resize the column, the [ColumnSizeEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeEnded) event occurs. These events also occur identically during [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) resizing.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ResizeColumn) property contains the number of the column being resized or -1 if the vertical splitter bar of a split tree control is moved.
See Also SftTreeEvents Object | Object Hierarchy
## ColumnsObj Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj*
Returns the [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refColumnsObj* = *object*.**ColumnsObj** **As SftTreeColumns** |
| VB | **Set** *refColumnsObj* = *object*.**ColumnsObj** **As SftTreeColumns** |
| C#.NET | **SftTreeColumns** *refColumnsObj* = *object*.**ColumnsObj**; |
| VC++ | **ISftTreeColumns*** *refColumnsObj* = *object*->**ColumnsObj**;
**ISftTreeColumns*** *refColumnsObj* = *object*->Get**ColumnsObj**(); |
| C | **HRESULT** *object*->get_**ColumnsObj**(**ISftTreeColumns**** *refColumnsObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refColumnsObj
Returns the SftTreeColumns object.
### Comments
The ColumnsObj property returns the SftTreeColumns object.
The SftTreeColumns object describes attributes that apply to all columns in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object *refColumnsObj*. A control has only one SftTreeColumns object.
An individual column's [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object can be accessed through the control's [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column) property.
See Also SftTree Object | Object Hierarchy
## ColumnsReordered Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnsReordered*
The columns have been reordered.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ColumnsReordered**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ColumnsReordered** |
| VB | **Private Sub** *object*_**ColumnsReordered**() |
| C#.NET | **void** *object*_**ColumnsReordered**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ColumnsReordered***object*(); |
| C | **HRESULT** On**ColumnsReordered***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The ColumnsReordered event occurs when the columns have been reordered.
[Column reordering](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop) is enabled using the [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Reorderable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Reorderable) property. Individual columns can be prevented from being reordered by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked) property.
See Also SftTree Object | Object Hierarchy
## ColumnStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnStyle*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) style in the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign), Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign), Column.[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline), Column.[ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip), Column.[CellWordWrap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap), [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked), Header.[KeepPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_KeepPosition), Column.[Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge), Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.get_**ColumnStyle**(**ByVal** *ColIndex* **As Short**) **As [SftTreeColumnStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeColumnStyleConstants)** |
| VB | *Style* = *object*.**ColumnStyle**(**ByVal** *ColIndex* **As Integer**) **As SftTreeColumnStyleConstants** |
| C#.NET | **SftTreeColumnStyleConstants** *Style* = *object*.get_**ColumnStyle**(**short** *ColIndex*); |
| VC++ | **enum SftTreeColumnStyleConstants** *Style* = *object*->**ColumnStyle**[**short** *ColIndex*];
**enum SftTreeColumnStyleConstants** *Style* = *object*->Get**ColumnStyle**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnStyle**(**short** *ColIndex*, **enum SftTreeColumnStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnStyle**(**ByVal** *ColIndex* **As Short**, **ByVal** *Style* **As SftTreeColumnStyleConstants**) |
| VB | *object*.**ColumnStyle**(**ByVal** *ColIndex* **As Integer**) = *Style* **As SftTreeColumnStyleConstants** |
| C#.NET | **void** *object*.set_**ColumnStyle**(**short** *ColIndex*, **SftTreeColumnStyleConstants** *Style*); |
| VC++ | **enum SftTreeColumnStyleConstants** *object*->**ColumnStyle**[**short** *ColIndex*] = *Style*;
**void** *object*->Put**ColumnStyle**(**short** *ColIndex*, **enum SftTreeColumnStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**ColumnStyle**(**short** *ColIndex*, **enum SftTreeColumnStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Style
Defines the cell style in the specified column.
One value of each of the following tables can be combined and used as * Style* value (use Column.CellHAlign, Column.CellVAlign instead):
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| colstyleSftTreeLeft | 0 | The text and graphic component are left aligned. |
| colstyleSftTreeCenter | 1 | The text and graphic component are centered. |
| colstyleSftTreeRight | 2 | The text and graphic component are right aligned. |
| Vertical Alignment | Value | Description |
| colstyleSftTreeVCenter | 0x1000 (4096) | The text is vertically centered. If no vertical alignment value is specified, this is the default. |
| colstyleSftTreeTop | 0x2000 (8192) | The text is aligned with the top of the available area. |
| colstyleSftTreeBottom | 0x4000 (16384) | The text is aligned with the bottom of the available area. |
The values in the above table can be combined with the following values using a bit-wise Or operator.
| Style | Value | Description |
| --- | --- | --- |
| colstyleSftTreeMultiline | 0x0004 (4) | Cell text may contain CR/LF (carriage-return, line-feed) characters which signal the start of a new line. If multi-line text is allowed, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to reserve sufficient space. Use Column.CellMultiline instead. |
| colstyleSftTreeToolTip | 0x0008 (8) | Displays [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) for the column if the cell text and/or graphic component are clipped. Also see the Items.[ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways) property. Use Column.ToolTip instead. |
| colstyleSftTreeWrap | 0x0010 (16) | Cell text may word-wrap within the available space. The Items.Lines property should be used to define the (maximum) number of text lines allowed. Word-wrap is only available if colstyleSftTreeMultiline is also used. If colstyleSftTreeMultiline is not given, colstyleSftTreeWrap is ignored. Use Column.CellWordWrap instead. |
| colstyleSftTreeLocked | 0x0100 256 | The column width is locked and the user cannot resize the column. This can be used to hide certain columns. By setting a column's width to 0 and locking it, a user cannot make the column visible. Use Header.Locked instead. |
| colstyleSftTreeKeepPos | 0x0200 (512) | The column must remain in the current column position. [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) on the left can be reordered but cannot be moved to the right of the column and vice versa. This is usually used with the first column, to prevent the user from changing its position when using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop). Use Header.KeepPosition instead. |
| colstyleSftTreeMerge | 0x0400 (1024) | Allows the contents of this column to merge into the next displayed column if the contents of the next cell (or [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)) are empty and the next column allows being [merged into](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) (colstyleSftTreeMergeInto). This style also applies to column headers. Use Column.Merge instead. |
| colstyleSftTreeMergeInto | 0x0800 (2048) | Allows the contents of the previous column to merge into this column if the cell (or column header) in this column is empty. This style also applies to column headers. Use Column.MergeInto instead. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.CellHAlign, Column.CellVAlign, Column.CellMultiline, Column.ToolTip, Column.CellWordWrap, Header.Locked, Header.KeepPosition, Column.Merge, Column.MergeInto instead
The ColumnStyle property defines the cell style in the specified column.
The * Style* value defined using the ColumnStyle property applies to all cells in the column specified. Individual cells can override the defined default alignment using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign), Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign), Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
To define the column header's text alignment, use the Header.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) and Header.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign) properties instead.
See Also SftTree Object | Object Hierarchy
## ColumnText Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnText*
Defines a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text.
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.get_**ColumnText**(**ByVal** *ColIndex* **As Short**) **As String** |
| VB | *Text* = *object*.**ColumnText**(**ByVal** *ColIndex* **As Integer**) **As String** |
| C#.NET | **string** *Text* = *object*.get_**ColumnText**(**short** *ColIndex*); |
| VC++ | **_bstr_t** *Text* = *object*->**ColumnText**[**short** *ColIndex*];
**_bstr_t** *Text* = *object*->Get**ColumnText**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnText**(**short** *ColIndex*, **BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnText**(**ByVal** *ColIndex* **As Short**, **ByVal** *Text* **As String**) |
| VB | *object*.**ColumnText**(**ByVal** *ColIndex* **As Integer**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**ColumnText**(**short** *ColIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**ColumnText**[**short** *ColIndex*] = *Text*;
**void** *object*->Put**ColumnText**(**short** *ColIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**ColumnText**(**short** *ColIndex*, **BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Text
Defines a column header's text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.Text instead
The ColumnText property defines a column header's text.
The alignment of the column header text can be defined using the Header.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) and Header.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign) properties.
The column header text may contain new-line characters (CR-LF) if multi-line header text is enabled (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline)).
If the column header text is empty, the column header of the preceding column may merge into the empty column header, based on the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) and Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings. The row/column header never merges into a column header.
When defining column header text using the [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) [property page](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_property_dialog), any trailing empty lines are automatically removed. To preserve a trailing empty line, add a space character to the line.
See Also SftTree Object | Object Hierarchy
## ColumnTextStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnTextStyle*
Defines a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text style.
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) and Header.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**ColumnTextStyle**(**ByVal** *ColIndex* **As Short**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**ColumnTextStyle**(**ByVal** *ColIndex* **As Integer**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**ColumnTextStyle**(**short** *ColIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**ColumnTextStyle**[**short** *ColIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**ColumnTextStyle**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnTextStyle**(**short** *ColIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnTextStyle**(**ByVal** *ColIndex* **As Short**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**ColumnTextStyle**(**ByVal** *ColIndex* **As Integer**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**ColumnTextStyle**(**short** *ColIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**ColumnTextStyle**[**short** *ColIndex*] = *Align*;
**void** *object*->Put**ColumnTextStyle**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**ColumnTextStyle**(**short** *ColIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Align
Defines a column header's text style.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| alignSftTreeCenter | 1 | The text and graphic component are centered. |
| alignSftTreeRight | 2 | The text and graphic component are right aligned. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The text is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The text is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The text is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.TextHAlign and Header.TextVAlign instead
The ColumnTextStyle property defines a column header's text style.
To change the default alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text use the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties instead.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline) property can be used to enable multi-line column header text.
See Also SftTree Object | Object Hierarchy
## ColumnWidth Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnWidth*
Defines the width of the specified column.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.get_**ColumnWidth**(**ByVal** *ColIndex* **As Short**) **As Single** |
| VB | *Width* = *object*.**ColumnWidth**(**ByVal** *ColIndex* **As Integer**) **As Single** |
| C#.NET | **float** *Width* = *object*.get_**ColumnWidth**(**short** *ColIndex*); |
| VC++ | **float** *Width* = *object*->**ColumnWidth**[**short** *ColIndex*];
**float** *Width* = *object*->Get**ColumnWidth**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**ColumnWidth**(**short** *ColIndex*, **float*** *Width*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ColumnWidth**(**ByVal** *ColIndex* **As Short**, **ByVal** *Width* **As Single**) |
| VB | *object*.**ColumnWidth**(**ByVal** *ColIndex* **As Integer**) = *Width* **As Single** |
| C#.NET | **void** *object*.set_**ColumnWidth**(**short** *ColIndex*, **float** *Width*); |
| VC++ | **float** *object*->**ColumnWidth**[**short** *ColIndex*] = *Width*;
**void** *object*->Put**ColumnWidth**(**short** *ColIndex*, **float** *Width*); |
| C | **HRESULT** *object*->put_**ColumnWidth**(**short** *ColIndex*, **float** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
Width
Defines the width of the specified column. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.Width instead
The ColumnWidth property defines the width of the specified column.
The column width must be greater or equal to the column's minimum width. The minimum width can be defined using the Column.[MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) property.
The last column in a tree control may be defined as an [open-ended column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) (see [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded). An open-ended column cannot be resized, because an open-ended column doesn't have a defined width. An open-ended column will always use the space remaining between the previous column and the right edge of the tree control window.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum width. The text portion of the first column will always be at least of the specified width, no matter what level the item is on. This can result in the first column being much wider than the defined width. To calculate the actual width of column 0, add the value returned by the ColumnsObj.[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property to the value returned by ColumnWidth(0).
When changing column widths, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method may have to be used to recalculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
The Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) or Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) methods can be used to calculate or define the optimal width for a column. An optimal width allows all text and graphic components in a column to be displayed in their entirety, without being clipped.
See Also SftTree Object | Object Hierarchy
## ContextMenu Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ContextMenu*
The right mouse button is released or Shift-F10 is pressed requesting a context menu.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ContextMenuEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ContextMenuEvent** |
| VB | **Private Sub** *object*_**ContextMenu**(**ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, **ByVal** *x* **As OLE_XPOS_PIXELS**, **ByVal** *y* **As OLE_YPOS_PIXELS**) |
| C#.NET | **void** *object*_**ContextMenuEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ContextMenu***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
| C | **HRESULT** On**ContextMenu***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor when the button was pressed. If *x* and *y* are -1, the user pressed Shift-F10.
y
The y coordinate of the mouse cursor when the button was pressed. If *x* and *y* are -1, the user pressed Shift-F10.
### Comments
The ContextMenu event occurs when the right mouse button is released or Shift-F10 is pressed requesting a context menu.
An application can display a context menu in response to this event. Before displaying the popup menu, the [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) method must be called.
See Also SftTree Object | Object Hierarchy
## Copy Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy*
Copies items to a new position in the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | *CountCopied* = *object*.**Copy**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *InsertIndex* **As Integer**) **As Integer** |
| VB | *CountCopied* = *object*.**Copy**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *InsertIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountCopied* = *object*.**Copy**(**int** *FromIndex*, **int** *Count*, **int** *InsertIndex*); |
| VC++ | **long** *CountCopied* = *object*->**Copy**(**long** *FromIndex*, **long** *Count*, **long** *InsertIndex*); |
| C | **HRESULT** *object*->raw_**Copy**(**long** *FromIndex*, **long** *Count*, **long** *InsertIndex*, **long*** *CountCopied*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
FromIndex
The zero-based index of the first item to be copied.
Count
The number of items to be copied.
InsertIndex
The zero-based index of the position where the items are to be inserted. If * InsertIndex* is -1, the items will be added at the end of the list.
CountCopied
Returns the number of items copied.
### Comments
The Copy method copies items to a new position in the tree control.
The Copy method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. Also copied are all data attributes such as [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc. If these values should remain unique in an application, they have to be explicitly changed after copying an item. The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target * InsertIndex* cannot be inside the group of items to be copied.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can also be copied using the Items.[CopyAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CopyAfter) method.
Items can be moved using the Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) and Items.[MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter) methods.
See Also SftTreeItems Object | Object Hierarchy
## CopyAfter Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CopyAfter*
Copies items to a new position in the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | *CountCopied* = *object*.**CopyAfter**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *AfterIndex* **As Integer**) **As Integer** |
| VB | *CountCopied* = *object*.**CopyAfter**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *AfterIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountCopied* = *object*.**CopyAfter**(**int** *FromIndex*, **int** *Count*, **int** *AfterIndex*); |
| VC++ | **long** *CountCopied* = *object*->**CopyAfter**(**long** *FromIndex*, **long** *Count*, **long** *AfterIndex*); |
| C | **HRESULT** *object*->raw_**CopyAfter**(**long** *FromIndex*, **long** *Count*, **long** *AfterIndex*, **long*** *CountCopied*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
FromIndex
The zero-based index of the first item to be copied.
Count
The number of items to be copied.
AfterIndex
The zero-based index of the position after which the items are to be inserted. If * AfterIndex* is -1, the items will be added at the end of the list.
CountCopied
Copies items to a new position in the tree control.
### Comments
The CopyAfter method copies items to a new position in the tree control.
The [Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. Also copied are all data attributes such as [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc. If these values should remain unique in an application, they have to be explicitly changed after copying an item. The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target * InsertIndex* cannot be inside the group of items to be copied.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can also be copied using the Items.Copy method.
Items can be moved using the Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) and Items.[MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter) methods.
See Also SftTreeItems Object | Object Hierarchy
## CopyItem Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItem*
Copies an item to a new position in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *NewIndex* = *object*.**CopyItem**(**ByVal** *FromIndex* **As Integer**, **ByVal** *ToIndex* **As Integer**) **As Integer** |
| VB | *NewIndex* = *object*.**CopyItem**(**ByVal** *FromIndex* **As Long**, **ByVal** *ToIndex* **As Long**) **As Long** |
| C#.NET | **int** *NewIndex* = *object*.**CopyItem**(**int** *FromIndex*, **int** *ToIndex*); |
| VC++ | **long** *NewIndex* = *object*->**CopyItem**(**long** *FromIndex*, **long** *ToIndex*); |
| C | **HRESULT** *object*->raw_**CopyItem**(**long** *FromIndex*, **long** *ToIndex*, **long*** *NewIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FromIndex
The zero-based index of the item to be copied.
ToIndex
The zero-based index of the position where the item is to be inserted. If *ToIndex* is -1, the item will be added at the end of the list.
NewIndex
Returns the zero-based index of the newly inserted item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Copy instead
The CopyItem method copies an item to a new position in the tree control.
The CopyItem method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. Also copied are the properties [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc. If these values should remain unique in an application, they have to be explicitly changed after copying items. The Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property is copied based on the settings of the [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property.
A group of items can be copied using the Items.Copy method. Items can be moved using the Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) method.
See Also SftTree Object | Object Hierarchy
## CopyItemDataString Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString*
Defines whether the Item.DataString property is copied or moved with an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move), Items.[MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter), Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) and Items.[CopyAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CopyAfter) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CopyItemDataString** **As Boolean** |
| VB | *Boolean* = *object*.**CopyItemDataString** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CopyItemDataString**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CopyItemDataString**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CopyItemDataString**(); |
| C | **HRESULT** *object*->get_**CopyItemDataString**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CopyItemDataString** = *Boolean* **As Boolean** |
| VB | *object*.**CopyItemDataString** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CopyItemDataString** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CopyItemDataString** = *Boolean*;
**void** *object*->Put**CopyItemDataString**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CopyItemDataString**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the Item.DataString property is copied or moved with an item.
| Boolean | Description |
| --- | --- |
| True | The deprecated [MoveItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItem) and [CopyItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItem) methods move/copy the Item.DataString property. |
| False | The deprecated MoveItem and CopyItem methods do not move/ copy the Item.DataString property. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Move, Items.MoveAfter, Items.Copy and Items.CopyAfter instead
The CopyItemDataString property defines whether the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property is copied or moved with an item.
The deprecated MoveItem and CopyItem methods do not move or copy the Item.DataString property when an item is moved or copied unless the [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property is set to True.
The CopyItemDataString property has no effect on the methods Items.Move, Items.MoveAfter, Items.Copy and Items.CopyAfter or the deprecated methods CopyItem/[CopyItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItems) and MoveItem/[MoveItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItems), as these methods always copy the Item.DataString property.
See Also SftTree Object | Object Hierarchy
## CopyItems Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItems*
Copies items to a new position in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *CountCopied* = *object*.**CopyItems**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *ToIndex* **As Integer**) **As Integer** |
| VB | *CountCopied* = *object*.**CopyItems**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *ToIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountCopied* = *object*.**CopyItems**(**int** *FromIndex*, **int** *Count*, **int** *ToIndex*); |
| VC++ | **long** *CountCopied* = *object*->**CopyItems**(**long** *FromIndex*, **long** *Count*, **long** *ToIndex*); |
| C | **HRESULT** *object*->raw_**CopyItems**(**long** *FromIndex*, **long** *Count*, **long** *ToIndex*, **long*** *CountCopied*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FromIndex
The zero-based index of the first item to be copied.
Count
The number of items to be copied.
ToIndex
The zero-based index of the position where the items are to be inserted. If *ToIndex* is -1, the items will be added at the end of the list.
CountCopied
Returns the number of items copied.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Copy instead
The CopyItems method copies items to a new position in the tree control.
The CopyItems method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. Also copied are all data attributes such as [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc. If these values should remain unique in an application, they have to be explicitly changed after copying an item. The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target * ToIndex* cannot be inside the group of items to be copied.
Items can be moved using the Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) and Items.[MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter) methods.
See Also SftTree Object | Object Hierarchy
## Count Property, DataObjectFiles Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Count*
Returns the number of filenames in the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject).[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Total* = *object*.**Count** **As Integer** |
| VB | *Total* = *object*.**Count** **As Long** |
| C#.NET | **int** *Total* = *object*.**Count**; |
| VC++ | **long** *Total* = *object*->**Count**;
**long** *Total* = *object*->Get**Count**(); |
| C | **HRESULT** *object*->get_**Count**(**long*** *Total*); |
object
A [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles) object.
Total
Returns the number of filenames in the DataObject.Files collection (sftCFFiles format only).
### Comments
The Count property returns the number of filenames in the DataObject.Files collection (sftCFFiles format only).
This property can be used to iterate through all file names in the DataObject.Files collection.
See Also DataObjectFiles Object | Object Hierarchy
## Count Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count*
Defines the number of columns.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Cols* = *object*.**Count** **As Short** |
| VB | *Cols* = *object*.**Count** **As Integer** |
| C#.NET | **short** *Cols* = *object*.**Count**; |
| VC++ | **short** *Cols* = *object*->**Count**;
**short** *Cols* = *object*->Get**Count**(); |
| C | **HRESULT** *object*->get_**Count**(**short*** *Cols*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Count** = *Cols* **As Short** |
| VB | *object*.**Count** = *Cols* **As Integer** |
| C#.NET | **short** *object*.**Count** = *Cols*; |
| VC++ | **short** *object*->**Count** = *Cols*;
**void** *object*->Put**Count**(**short** *Cols*); |
| C | **HRESULT** *object*->put_**Count**(**short** *Cols*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
Cols
Defines the number of columns. The valid range is 1 through 255.
### Comments
The Count property defines the number of columns.
The number of columns can only be changed if a tree control is empty. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Clear) method can be used to remove all items from a tree control.
Additional columns are always added at the end of the list of columns. Existing column properties are not changed. Default values are used for the new columns added. These can be changed using the column related properties. The last column will be defined using an explicit column width. If an [open-ended column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) is desired, use the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded property to redefine the last column.
See Also SftTreeColumns Object | Object Hierarchy
## Count Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Count*
Returns the number of items in the tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**Count** **As Integer** |
| VB | *Count* = *object*.**Count** **As Long** |
| C#.NET | **int** *Count* = *object*.**Count**; |
| VC++ | **long** *Count* = *object*->**Count**;
**long** *Count* = *object*->Get**Count**(); |
| C | **HRESULT** *object*->get_**Count**(**long*** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Returns the number of items in the tree control.
### Comments
The Count property returns the number of items in the tree control.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) and Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) methods add new items.
See Also SftTreeItems Object | Object Hierarchy
## CrossColumnResize Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CrossColumnResize*
Defines whether multiple columns can be resized in one resizing operation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**CrossColumnResize** **As Boolean** |
| VB | *Boolean* = *object*.**CrossColumnResize** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**CrossColumnResize**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**CrossColumnResize**;
**VARIANT_BOOL** *Boolean* = *object*->Get**CrossColumnResize**(); |
| C | **HRESULT** *object*->get_**CrossColumnResize**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CrossColumnResize** = *Boolean* **As Boolean** |
| VB | *object*.**CrossColumnResize** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**CrossColumnResize** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**CrossColumnResize** = *Boolean*;
**void** *object*->Put**CrossColumnResize**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**CrossColumnResize**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether multiple columns can be resized in one resizing operation.
| Boolean | Description |
| --- | --- |
| True | A user can make several columns invisible by continually resizing one column. |
| False | Prevent a user from making more than one column invisible (by resizing it to a zero width). |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Resizable instead
The CrossColumnResize property defines whether multiple columns can be resized in one resizing operation.
See Also SftTree Object | Object Hierarchy
## Current Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current*
Defines the current item (caret location).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**Current** **As Integer** |
| VB | *ItemIndex* = *object*.**Current** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**Current**; |
| VC++ | **long** *ItemIndex* = *object*->**Current**;
**long** *ItemIndex* = *object*->Get**Current**(); |
| C | **HRESULT** *object*->get_**Current**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Current** = *ItemIndex* **As Integer** |
| VB | *object*.**Current** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**Current** = *ItemIndex*; |
| VC++ | **long** *object*->**Current** = *ItemIndex*;
**void** *object*->Put**Current**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**Current**(**long** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
Defines the current item (caret location).
### Comments
The Current property defines the current item (caret location).
The Current property describes the current item, which is the item that has the focus rectangle. This item is not necessarily also selected. The current item is described by the Current property, the currently [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is described by the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property. These are not necessarily the same even in a single-selection tree control (see Items.[NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection) property).
When the user changes the current item (caret location), the [CaretChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CaretChange) event occurs. The [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) event occurs when the selection changes.
If the tree control is empty, the Current property returns -1. An application must set the property to a valid, existing item. It cannot set it to -1.
The focus rectangle can be hidden using the Items.[ShowFocusRectangle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShowFocusRectangle) property.
See Also SftTreeItems Object | Object Hierarchy
## CustomCode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CustomCode*
Defines optional product customization.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Code* = *object*.**CustomCode** **As Integer** |
| VB | *Code* = *object*.**CustomCode** **As Long** |
| C#.NET | **int** *Code* = *object*.**CustomCode**; |
| VC++ | **long** *Code* = *object*->**CustomCode**;
**long** *Code* = *object*->Get**CustomCode**(); |
| C | **HRESULT** *object*->get_**CustomCode**(**long*** *Code*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**CustomCode** = *Code* **As Integer** |
| VB | *object*.**CustomCode** = *Code* **As Long** |
| C#.NET | **int** *object*.**CustomCode** = *Code*; |
| VC++ | **long** *object*->**CustomCode** = *Code*;
**void** *object*->Put**CustomCode**(**long** *Code*); |
| C | **HRESULT** *object*->put_**CustomCode**(**long** *Code*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Code
Defines optional product customization.
### Comments
The CustomCode property defines optional product customization.
Valid *Code* values are made available by [Product Support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contactsoftel), in response to purchased enhancements, special features, etc. and are only available upon request.
See Also SftTree Object | Object Hierarchy
## DarkMode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkMode*
Defines the [dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) setting (off, on, or following the Windows setting).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Mode* = *object*.**DarkMode** **As [SftTreeDarkModeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDarkModeConstants)** |
| VB | *Mode* = *object*.**DarkMode** **As SftTreeDarkModeConstants** |
| C#.NET | **SftTreeDarkModeConstants** *Mode* = *object*.**DarkMode**; |
| VC++ | **enum SftTreeDarkModeConstants** *Mode* = *object*->**DarkMode**;
**enum SftTreeDarkModeConstants** *Mode* = *object*->Get**DarkMode**(); |
| C | **HRESULT** *object*->get_**DarkMode**(**enum SftTreeDarkModeConstants*** *Mode*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DarkMode** = *Mode* **As SftTreeDarkModeConstants** |
| VB | *object*.**DarkMode** = *Mode* **As SftTreeDarkModeConstants** |
| C#.NET | **SftTreeDarkModeConstants** *object*.**DarkMode** = *Mode*; |
| VC++ | **enum SftTreeDarkModeConstants** *object*->**DarkMode** = *Mode*;
**void** *object*->Put**DarkMode**(**enum SftTreeDarkModeConstants** *Mode*); |
| C | **HRESULT** *object*->put_**DarkMode**(**enum SftTreeDarkModeConstants** *Mode*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Mode
Defines the dark mode setting (off, on, or following the Windows setting).
| Name | Value | Description |
| --- | --- | --- |
| darkSftTreeOff | 0 | Always light (the default). |
| darkSftTreeOn | 1 | Always dark. |
| darkSftTreeAuto | 2 | Follow the Windows dark mode setting. |
### Comments
The DarkMode property defines the dark mode setting (off, on, or following the Windows setting).
When set to darkSftTreeAuto, the control follows the Windows 10 'Choose your mode' setting and re-renders automatically when it changes; the [DarkModeChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DarkModeChange) event is raised when the effective state changes.
Use [DarkModeActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkModeActive) to determine whether dark mode is currently active.
See Also SftTree Object | Object Hierarchy | Dark Mode
## DarkModeActive Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkModeActive*
Returns whether [dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) is currently active.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**DarkModeActive** **As Boolean** |
| VB | *Boolean* = *object*.**DarkModeActive** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**DarkModeActive**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**DarkModeActive**;
**VARIANT_BOOL** *Boolean* = *object*->Get**DarkModeActive**(); |
| C | **HRESULT** *object*->get_**DarkModeActive**(**VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Returns whether dark mode is currently active.
| Boolean | Description |
| --- | --- |
| True | Dark mode is currently active. |
| False | Dark mode is not active. |
### Comments
The DarkModeActive property returns whether dark mode is currently active.
The dark mode setting is defined using the [DarkMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkMode) property.
See Also SftTree Object | Object Hierarchy | DarkMode | [DarkModeChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DarkModeChange) | Dark Mode
## DarkModeChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DarkModeChange*
The effective [dark mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_darkmode) state has changed (Automatic dark mode only).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**DarkModeChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**DarkModeChange** |
| VB | **Private Sub** *object*_**DarkModeChange**(**ByVal** *Active* **As Boolean**) |
| C#.NET | **void** *object*_**DarkModeChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**DarkModeChange***object*(**VARIANT_BOOL** *Active*); |
| C | **HRESULT** On**DarkModeChange***object*(**VARIANT_BOOL** *Active*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Active
The new effective dark mode state (True if dark mode is now active).
### Comments
The DarkModeChange event occurs when the effective dark mode state changes while [DarkMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkMode) is set to [darkSftTreeAuto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDarkModeConstants) and the user changes the Windows setting.
See Also SftTree Object | Object Hierarchy | DarkMode | [DarkModeActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DarkModeActive) | Dark Mode
## Data Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific numeric value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Number* = *object*.**Data** **As Integer** |
| VB | *Number* = *object*.**Data** **As Long** |
| C#.NET | **int** *Number* = *object*.**Data**; |
| VC++ | **long** *Number* = *object*->**Data**;
**long** *Number* = *object*->Get**Data**(); |
| C | **HRESULT** *object*->get_**Data**(**long*** *Number*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Data** = *Number* **As Integer** |
| VB | *object*.**Data** = *Number* **As Long** |
| C#.NET | **int** *object*.**Data** = *Number*; |
| VC++ | **long** *object*->**Data** = *Number*;
**void** *object*->Put**Data**(**long** *Number*); |
| C | **HRESULT** *object*->put_**Data**(**long** *Number*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Number
Defines the cell's application specific numeric value.
### Comments
The Data property defines the cell's application specific numeric value.
The Data property can be used to store application specific data with a cell. Possible uses include storing pointers to data structures or values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties can be used to store additional application specific data, using other data types (strings, objects, variants).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTreeCell Object | Object Hierarchy
## Data Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data*
Defines the item's application specific numeric value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Number* = *object*.**Data** **As Integer** |
| VB | *Number* = *object*.**Data** **As Long** |
| C#.NET | **int** *Number* = *object*.**Data**; |
| VC++ | **long** *Number* = *object*->**Data**;
**long** *Number* = *object*->Get**Data**(); |
| C | **HRESULT** *object*->get_**Data**(**long*** *Number*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Data** = *Number* **As Integer** |
| VB | *object*.**Data** = *Number* **As Long** |
| C#.NET | **int** *object*.**Data** = *Number*; |
| VC++ | **long** *object*->**Data** = *Number*;
**void** *object*->Put**Data**(**long** *Number*); |
| C | **HRESULT** *object*->put_**Data**(**long** *Number*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Number
Defines the item's application specific numeric value.
### Comments
The Data property defines the item's application specific numeric value.
The Data property can be used to store an application specific value with an item. Possible uses include storing values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTreeItem Object | Object Hierarchy
## DataFloat Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat*
Defines the item's application specific floating point value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Float* = *object*.**DataFloat** **As Single** |
| VB | *Float* = *object*.**DataFloat** **As Single** |
| C#.NET | **float** *Float* = *object*.**DataFloat**; |
| VC++ | **float** *Float* = *object*->**DataFloat**;
**float** *Float* = *object*->Get**DataFloat**(); |
| C | **HRESULT** *object*->get_**DataFloat**(**float*** *Float*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DataFloat** = *Float* **As Single** |
| VB | *object*.**DataFloat** = *Float* **As Single** |
| C#.NET | **float** *object*.**DataFloat** = *Float*; |
| VC++ | **float** *object*->**DataFloat** = *Float*;
**void** *object*->Put**DataFloat**(**float** *Float*); |
| C | **HRESULT** *object*->put_**DataFloat**(**float** *Float*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Float
Defines the item's application specific floating point value.
### Comments
The DataFloat property defines the item's application specific floating point value.
The DataFloat property can be used to store an application specific value with an item. Possible uses include storing values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).Data, Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTreeItem Object | Object Hierarchy
## DataObject Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific object value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refObjectPtr* = *object*.**DataObject** **As Object** |
| VB | *refObjectPtr* = *object*.**DataObject** **As Object** |
| C#.NET | **object** *refObjectPtr* = *object*.**DataObject**; |
| VC++ | **LPDISPATCH** *refObjectPtr* = *object*->**DataObject**;
**LPDISPATCH** *refObjectPtr* = *object*->Get**DataObject**(); |
| C | **HRESULT** *object*->get_**DataObject**(**LPDISPATCH*** *refObjectPtr*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**DataObject** = *refObjectPtr* **As Object** |
| VB | **Set** *object*.**DataObject** = *refObjectPtr* **As Object** |
| C#.NET | **object** *object*.**DataObject** = *refObjectPtr*; |
| VC++ | **LPDISPATCH** *object*->**DataObject** = *refObjectPtr*;
**void** *object*->PutRef**DataObject**(**LPDISPATCH** *refObjectPtr*); |
| C | **HRESULT** *object*->putref_**DataObject**(**LPDISPATCH** *refObjectPtr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
refObjectPtr
Defines the cell's application specific object value.
### Comments
The [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) property defines the cell's application specific object value.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString), Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties can be used to store additional application specific data, using other data types (numeric values, strings, variants).
When using .NET languages, the Cell.DataTag property should be used instead. DataObject is intended to be used with COM objects only.
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTreeCell Object | Object Hierarchy
## DataObject Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject*
Defines the item's application specific object value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refObjectPtr* = *object*.**DataObject** **As Object** |
| VB | *refObjectPtr* = *object*.**DataObject** **As Object** |
| C#.NET | **object** *refObjectPtr* = *object*.**DataObject**; |
| VC++ | **LPDISPATCH** *refObjectPtr* = *object*->**DataObject**;
**LPDISPATCH** *refObjectPtr* = *object*->Get**DataObject**(); |
| C | **HRESULT** *object*->get_**DataObject**(**LPDISPATCH*** *refObjectPtr*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**DataObject** = *refObjectPtr* **As Object** |
| VB | **Set** *object*.**DataObject** = *refObjectPtr* **As Object** |
| C#.NET | **object** *object*.**DataObject** = *refObjectPtr*; |
| VC++ | **LPDISPATCH** *object*->**DataObject** = *refObjectPtr*;
**void** *object*->PutRef**DataObject**(**LPDISPATCH** *refObjectPtr*); |
| C | **HRESULT** *object*->putref_**DataObject**(**LPDISPATCH** *refObjectPtr*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
refObjectPtr
Defines the item's application specific object value.
### Comments
The [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) property defines the item's application specific object value.
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
When using .NET languages, the Item.DataTag property should be used instead. DataObject is intended to be used with COM objects only.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTreeItem Object | Object Hierarchy
## DataString Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific string value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**DataString** **As String** |
| VB | *String* = *object*.**DataString** **As String** |
| C#.NET | **string** *String* = *object*.**DataString**; |
| VC++ | **_bstr_t** *String* = *object*->**DataString**;
**_bstr_t** *String* = *object*->Get**DataString**(); |
| C | **HRESULT** *object*->get_**DataString**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DataString** = *String* **As String** |
| VB | *object*.**DataString** = *String* **As String** |
| C#.NET | **string** *object*.**DataString** = *String*; |
| VC++ | **_bstr_t** *object*->**DataString** = *String*;
**void** *object*->Put**DataString**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**DataString**(**BSTR** *String*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
String
Defines the cell's application specific string value.
### Comments
The DataString property defines the cell's application specific string value.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties can be used to store additional application specific data, using other data types (long, objects, variants).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTreeCell Object | Object Hierarchy
## DataString Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString*
Defines the item's application specific string value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**DataString** **As String** |
| VB | *String* = *object*.**DataString** **As String** |
| C#.NET | **string** *String* = *object*.**DataString**; |
| VC++ | **_bstr_t** *String* = *object*->**DataString**;
**_bstr_t** *String* = *object*->Get**DataString**(); |
| C | **HRESULT** *object*->get_**DataString**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DataString** = *String* **As String** |
| VB | *object*.**DataString** = *String* **As String** |
| C#.NET | **string** *object*.**DataString** = *String*; |
| VC++ | **_bstr_t** *object*->**DataString** = *String*;
**void** *object*->Put**DataString**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**DataString**(**BSTR** *String*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
String
Defines the item's application specific string value.
### Comments
The DataString property defines the item's application specific string value.
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTreeItem Object | Object Hierarchy
## DataTag Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s application specific variant value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *V* = *object*.**DataTag** **As Object** |
| VB | *V* = *object*.**DataTag** **As Variant** |
| C#.NET | **object** *V* = *object*.**DataTag**; |
| VC++ | **_variant_t** *V* = *object*->**DataTag**;
**_variant_t** *V* = *object*->Get**DataTag**(); |
| C | **HRESULT** *object*->get_**DataTag**(**VARIANT*** *V*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DataTag** = *V* **As Object** |
| VB | *object*.**DataTag** = *V* **As Variant** |
| C#.NET | **object** *object*.**DataTag** = *V*; |
| VC++ | **_variant_t** *object*->**DataTag** = *V*;
**void** *object*->Put**DataTag**(**const _variant_t**&**** *V*); |
| C | **HRESULT** *object*->put_**DataTag**(**VARIANT** *V*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
V
Defines the cell's application specific variant value.
### Comments
The DataTag property defines the cell's application specific variant value.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) properties can be used to store additional application specific data, using other data types (long, objects, strings).
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
See Also SftTreeCell Object | Object Hierarchy
## DataTag Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag*
Defines the item's application specific variant value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *V* = *object*.**DataTag** **As Object** |
| VB | *V* = *object*.**DataTag** **As Variant** |
| C#.NET | **object** *V* = *object*.**DataTag**; |
| VC++ | **_variant_t** *V* = *object*->**DataTag**;
**_variant_t** *V* = *object*->Get**DataTag**(); |
| C | **HRESULT** *object*->get_**DataTag**(**VARIANT*** *V*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DataTag** = *V* **As Object** |
| VB | *object*.**DataTag** = *V* **As Variant** |
| C#.NET | **object** *object*.**DataTag** = *V*; |
| VC++ | **_variant_t** *object*->**DataTag** = *V*;
**void** *object*->Put**DataTag**(**const _variant_t**&**** *V*); |
| C | **HRESULT** *object*->put_**DataTag**(**VARIANT** *V*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
V
Defines the item's application specific variant value.
### Comments
The DataTag property defines the item's application specific variant value.
Additional properties used to associate an application defined value with an item are [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTreeItem Object | Object Hierarchy
## DblClick Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DblClick*
A mouse button is double-clicked.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**DblClick**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**DblClick** |
| VB | **Private Sub** *object*_**DblClick**() |
| C#.NET | **void** *object*_**DblClick**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**DblClick***object*(); |
| C | **HRESULT** On**DblClick***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The DblClick event occurs when a mouse button is double-clicked.
To determine which mouse button was pressed and/or in which area of the tree control the mouse button was pressed, use the [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) or [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events.
See Also SftTree Object | Object Hierarchy
## DeleteDependents Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteDependents*
Deletes an item's dependents.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DeleteDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DeleteDependents) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**DeleteDependents**(**ByVal** *ItemIndex* **As Integer**) |
| VB | *object*.**DeleteDependents**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*.**DeleteDependents**(**int** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**DeleteDependents**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**DeleteDependents**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item, whose dependents are to be deleted.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DeleteDependents instead
The DeleteDependents method deletes an item's dependents.
By deleting an item's dependents, the item becomes a leaf item which can no longer be [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or collapsed. It is not an error to use the DeleteDependents method if an item doesn't have any dependents. The item described by *ItemIndex* is not deleted. To delete an item, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method can be used.
See Also SftTree Object | Object Hierarchy
## DeleteDependents Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DeleteDependents*
Deletes the item's dependents.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**DeleteDependents**() |
| VB | *object*.**DeleteDependents** |
| C#.NET | **void** *object*.**DeleteDependents**(); |
| VC++ | **HRESULT** *object*->**DeleteDependents**(); |
| C | **HRESULT** *object*->raw_**DeleteDependents**(); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
### Comments
The DeleteDependents method deletes the item's dependents.
By deleting the item's dependents, the item becomes a leaf item which can no longer be [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or collapsed. It is not an error to use the DeleteDependents method if an item doesn't have any dependents. The item itself is not deleted. To delete an item, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method can be used.
See Also SftTreeItem Object | Object Hierarchy
## DeleteGDIPlusImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteGDIPlusImage*
Deletes a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image object.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**DeleteGDIPlusImage**(**ByVal** *pGDIPlusImage* **As Integer**) |
| VB | *object*.**DeleteGDIPlusImage**(**ByVal** *pGDIPlusImage* **As LONG_PTR**) |
| C#.NET | **void** *object*.**DeleteGDIPlusImage**(**int** *pGDIPlusImage*); |
| VC++ | **HRESULT** *object*->**DeleteGDIPlusImage**(**LONG_PTR** *pGDIPlusImage*); |
| C | **HRESULT** *object*->raw_**DeleteGDIPlusImage**(**LONG_PTR** *pGDIPlusImage*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
pGDIPlusImage
A pointer to a GDI+ image (Gdiplus::Image*) allocated using [LoadGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImage) or [LoadGDIPlusImageFromResource](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImageFromResource).
### Comments
The DeleteGDIPlusImage method deletes a GDI+ image object.
A GDI+ image created using LoadGDIPlusImage or LoadGDIPlusImageFromResource must be freed using [DeleteGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteGDIPlusImage) (or the equivalent "delete Gdiplus::Image*", which is usually accessible to C++ applications only).
This method is mainly intended for applications written using a language that does not have direct access to GDI+ (such as VB6). Other languages usually have direct access to GDI+ (such as C++) or have other mechanisms ([NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) for .NET applications).
See Also SftTree Object | Object Hierarchy
## DependentAllCount Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentAllCount*
Returns the item's number of all dependents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**DependentAllCount** **As Integer** |
| VB | *Count* = *object*.**DependentAllCount** **As Long** |
| C#.NET | **int** *Count* = *object*.**DependentAllCount**; |
| VC++ | **long** *Count* = *object*->**DependentAllCount**;
**long** *Count* = *object*->Get**DependentAllCount**(); |
| C | **HRESULT** *object*->get_**DependentAllCount**(**long*** *Count*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Count
Returns the item's number of all dependents, including immediate and indirect dependents.
### Comments
The DependentAllCount property returns the item's number of all dependents.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) property can be used to determine the item's number of immediate dependents.
See Also SftTreeItem Object | Object Hierarchy
## DependentCount Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DependentCount*
Returns an item's number of dependents.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) and Item.[DependentAllCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentAllCount) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.get_**DependentCount**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *DependentType* **As Short**) **As Integer** |
| VB | *Count* = *object*.**DependentCount**(**ByVal** *ItemIndex* **As Long**, **ByVal** *DependentType* **As Integer**) **As Long** |
| C#.NET | **int** *Count* = *object*.get_**DependentCount**(**int** *ItemIndex*, **short** *DependentType*); |
| VC++ | **long** *Count* = *object*->**DependentCount**[**long** *ItemIndex*][**short** *DependentType*];
**long** *Count* = *object*->Get**DependentCount**(**long** *ItemIndex*, **short** *DependentType*); |
| C | **HRESULT** *object*->get_**DependentCount**(**long** *ItemIndex*, **short** *DependentType*, **long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose number of dependents is to be returned.
DependentType
Determines the depth of the dependents included in the count returned.
| DependentType | Description |
| --- | --- |
| 0 | Only include immediate dependents in the count returned. |
| 1 | Include immediate and indirect dependents in the count returned. |
Count
Returns an item's number of dependents.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DependentCount and Item.DependentAllCount instead
The DependentCount property returns an item's number of dependents.
See Also SftTree Object | Object Hierarchy
## DependentCount Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount*
Returns the item's number of immediate dependents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**DependentCount** **As Integer** |
| VB | *Count* = *object*.**DependentCount** **As Long** |
| C#.NET | **int** *Count* = *object*.**DependentCount**; |
| VC++ | **long** *Count* = *object*->**DependentCount**;
**long** *Count* = *object*->Get**DependentCount**(); |
| C | **HRESULT** *object*->get_**DependentCount**(**long*** *Count*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Count
Returns the item's number of immediate dependents.
### Comments
The DependentCount property returns the item's number of immediate dependents.
The [DependentAllCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentAllCount) property can be used to return the item's number of all dependents, including immediate and indirect dependents.
See Also SftTreeItem Object | Object Hierarchy
## Direct Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Direct*
Returns an [ISftTreeVTable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree) interface pointer.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refSftTreeVObj* = *object*.**Direct** **As ISftTreeVTable** |
| VB | **Set** *refSftTreeVObj* = *object*.**Direct** **As SftTreeVTable** |
| C#.NET | **ISftTreeVTable** *refSftTreeVObj* = *object*.**Direct**; |
| VC++ | **ISftTreeVTable*** *refSftTreeVObj* = *object*->**Direct**;
**ISftTreeVTable*** *refSftTreeVObj* = *object*->Get**Direct**(); |
| C | **HRESULT** *object*->get_**Direct**(**ISftTreeVTable**** *refSftTreeVObj*); |
object
A SftTree object.
refSftTreeVObj
Returns an ISftTreeVTable interface pointer.
### Comments
The Direct property returns an ISftTreeVTable interface pointer.
The ISftTreeVTable interface describes a SftTree object (i.e. the control itself). It is used in Visual Basic to insure that vtable binding is used. Visual Basic uses dispatch interface (early and late) binding when a SftTree object is used (i.e. the control). By retrieving the ISftTreeVTable interface, Visual Basic can use vtable binding which is significantly faster than any form of dispatch interface binding.
Any SftTree/OCX control that is used with Visual Basic should use the ISftTreeVTable interface if performance is important. Visual Basic uses vtable binding for all other SftTree objects (such as [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), etc.). Visual Basic will however use dispatch interface binding for the control object (SftTree).
The ISftTreeVTable interface exposes all properties and methods that are supported by the SftTree object.
Other languages (such as C++) can use the SftTree object directly and do not need to retrieve the ISftTreeVTable interface. The ISftTree interface which implements the SftTree object is a dual interface.
See Also SftTree Object | Object Hierarchy
## DisabledItemsSelectable Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DisabledItemsSelectable*
Defines whether disabled items can be selected by the end-user.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**DisabledItemsSelectable** **As Boolean** |
| VB | *Boolean* = *object*.**DisabledItemsSelectable** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**DisabledItemsSelectable**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**DisabledItemsSelectable**;
**VARIANT_BOOL** *Boolean* = *object*->Get**DisabledItemsSelectable**(); |
| C | **HRESULT** *object*->get_**DisabledItemsSelectable**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DisabledItemsSelectable** = *Boolean* **As Boolean** |
| VB | *object*.**DisabledItemsSelectable** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**DisabledItemsSelectable** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**DisabledItemsSelectable** = *Boolean*;
**void** *object*->Put**DisabledItemsSelectable**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**DisabledItemsSelectable**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether disabled items can be selected by the end-user.
| Boolean | Description |
| --- | --- |
| True | Enabled and disabled items are equally selectable by the end-user. |
| False | Only enabled items are selectable by the end-user. Events such as the [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event and others associated with item selection no longer occur for disabled items, if the DisabledItemsSelectable property is set to False. |
### Comments
The DisabledItemsSelectable property defines whether disabled items can be selected by the end-user.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property defines whether an item is enabled.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can always be selected by an application. DisabledItemsSelectable only controls whether the end-user can select an item. The visual appearance of a disabled [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) doesn't necessarily show the item as selected, since it is disabled, but the Item.[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) properly reflects the selection status.
Properties and methods returning the selected item(s) like (Items.[SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount), Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups), Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart), Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd)) may include disabled items, even if DisabledItemsSelectable is used. The Item.Enabled property can be used to test whether an item is enabled.
See Also SftTreeItems Object | Object Hierarchy
## DisplayColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DisplayColumn*
Returns the [display column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number given a real column number.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[DisplayPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_DisplayPosition) or [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[DisplayPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_DisplayPosition) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.get_**DisplayColumn**(**ByVal** *ColIndex* **As Short**) **As Short** |
| VB | *DispColIndex* = *object*.**DisplayColumn**(**ByVal** *ColIndex* **As Integer**) **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.get_**DisplayColumn**(**short** *ColIndex*); |
| VC++ | **short** *DispColIndex* = *object*->**DisplayColumn**[**short** *ColIndex*];
**short** *DispColIndex* = *object*->Get**DisplayColumn**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**DisplayColumn**(**short** *ColIndex*, **short*** *DispColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
DispColIndex
Returns the display column number given a real column number.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.DisplayPosition or ColumnsObj.DisplayPosition instead
The DisplayColumn property returns the display column number given a real column number.
As a user reorders columns, this is completely transparent to the application. An application still references [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.
If a user reorders columns using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop), the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.
The ColumnsObj.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) method can be used to reorder columns under program control.
See Also SftTree Object | Object Hierarchy
## DisplayPosition Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_DisplayPosition*
Returns the display position of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**DisplayPosition** **As Short** |
| VB | *DispColIndex* = *object*.**DisplayPosition** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**DisplayPosition**; |
| VC++ | **short** *DispColIndex* = *object*->**DisplayPosition**;
**short** *DispColIndex* = *object*->Get**DisplayPosition**(); |
| C | **HRESULT** *object*->get_**DisplayPosition**(**short*** *DispColIndex*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
DispColIndex
Returns the display position of this column.
### Comments
The DisplayPosition property returns the display position of this column.
As a user reorders columns, this is completely transparent to the application. An application still references [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number which never changes.
If a user reorders columns using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop), the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) method can be used to reorder columns under program control.
See Also SftTreeColumn Object | Object Hierarchy
## DisplayPosition Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_DisplayPosition*
Returns the display position given a [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**DisplayPosition**(**ByVal** *ColIndex* **As Short**) **As Short** |
| VB | *DispColIndex* = *object*.**DisplayPosition**(**ByVal** *ColIndex* **As Integer**) **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.get_**DisplayPosition**(**short** *ColIndex*); |
| VC++ | **short** *DispColIndex* = *object*->**DisplayPosition**[**short** *ColIndex*];
**short** *DispColIndex* = *object*->Get**DisplayPosition**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**DisplayPosition**(**short** *ColIndex*, **short*** *DispColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
ColIndex
The zero-based column number.
DispColIndex
Returns the display position given a real column number.
### Comments
The DisplayPosition property returns the display position given a real column number.
As a user reorders columns, this is completely transparent to the application. An application still references [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.
If a user reorders columns using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop), the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) method can be used to reorder columns under program control.
See Also SftTreeColumns Object | Object Hierarchy
## DPI Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DPI*
Returns the effective [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi) for the control's current monitor.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DPI* = *object*.**DPI** **As Integer** |
| VB | *DPI* = *object*.**DPI** **As Long** |
| C#.NET | **int** *DPI* = *object*.**DPI**; |
| VC++ | **long** *DPI* = *object*->**DPI**;
**long** *DPI* = *object*->Get**DPI**(); |
| C | **HRESULT** *object*->get_**DPI**(**long*** *DPI*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DPI
Returns the effective DPI for the control's current monitor.
### Comments
The DPI property returns the effective DPI for the control's current monitor.
On a per-monitor DPI-aware host, the value changes when the control moves to a monitor with a different DPI; the [DPIChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DPIChanged) event is raised when this happens. A value of 96 corresponds to 100% scaling.
See Also SftTree Object | Object Hierarchy | Per-Monitor DPI and Scaling
## DPIChanged Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DPIChanged*
The control moved to a monitor with a different [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi) (per-monitor-v2 hosts).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**DPIChanged**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**DPIChanged** |
| VB | **Private Sub** *object*_**DPIChanged**(**ByVal** *DPI* **As Long**) |
| C#.NET | **void** *object*_**DPIChanged**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**DPIChanged***object*(**long** *DPI*); |
| C | **HRESULT** On**DPIChanged***object*(**long** *DPI*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DPI
The new effective DPI for the control's monitor.
### Comments
The DPIChanged event occurs on a per-monitor DPI-aware host when the control moves to a monitor with a different DPI or the system DPI changes. Use [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DPI) to query the current value at any time.
See Also SftTree Object | Object Hierarchy | Per-Monitor DPI and Scaling
## DragImage Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragImage*
Defines whether a semi-transparent image is used to represent the data being dragged.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**DragImage** **As Boolean** |
| VB | *Boolean* = *object*.**DragImage** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**DragImage**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**DragImage**;
**VARIANT_BOOL** *Boolean* = *object*->Get**DragImage**(); |
| C | **HRESULT** *object*->get_**DragImage**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DragImage** = *Boolean* **As Boolean** |
| VB | *object*.**DragImage** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**DragImage** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**DragImage** = *Boolean*;
**void** *object*->Put**DragImage**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**DragImage**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether a semi-transparent image is used to represent the data being dragged.
| Boolean | Description |
| --- | --- |
| True | A semi-transparent image is used to represent the data being dragged. |
| False | A simple cursor is used to represent the data being dragged. |
### Comments
The DragImage property defines whether a semi-transparent image is used to represent the data being dragged.
The DragImage property applies to [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operations only. Note that not all applications used as targets of a drag & drop operation will render the semi-transparent image in their client area.
The DragImage property only affects OLE drag & drop operation initiated from the defining control. When the same control is used as a [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight), a semi-transparent image is always used if the drag source provides such an image.
See Also SftTree Object | Object Hierarchy
## DragMethod Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod*
Defines how [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) is implemented.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**DragMethod** **As [SftTreeDragMethodConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants)** |
| VB | *Style* = *object*.**DragMethod** **As SftTreeDragMethodConstants** |
| C#.NET | **SftTreeDragMethodConstants** *Style* = *object*.**DragMethod**; |
| VC++ | **enum SftTreeDragMethodConstants** *Style* = *object*->**DragMethod**;
**enum SftTreeDragMethodConstants** *Style* = *object*->Get**DragMethod**(); |
| C | **HRESULT** *object*->get_**DragMethod**(**enum SftTreeDragMethodConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DragMethod** = *Style* **As SftTreeDragMethodConstants** |
| VB | *object*.**DragMethod** = *Style* **As SftTreeDragMethodConstants** |
| C#.NET | **SftTreeDragMethodConstants** *object*.**DragMethod** = *Style*; |
| VC++ | **enum SftTreeDragMethodConstants** *object*->**DragMethod** = *Style*;
**void** *object*->Put**DragMethod**(**enum SftTreeDragMethodConstants** *Style*); |
| C | **HRESULT** *object*->put_**DragMethod**(**enum SftTreeDragMethodConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines how drag & drop is implemented. When a drag & drop operation starts, the [OLEStartDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEStartDrag), [DragStarting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DragStarting) or [AutoDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging) events are generated, based on the [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) property settings.
| Style | Value | Description |
| --- | --- | --- |
| dragSftTreeNone | 0 | Drag & drop is not supported. |
| dragSftTreeManual | 1 | Drag & drop is supported. A DragStarting event is generated. The application is responsible for drag & drop within and outside the tree control. |
| dragSftTreeAuto | 2 | Drag & drop is supported within the tree control. Drag & drop outside the tree control is not possible. The AutoDragging event is generated if a drag & drop operation starts. |
| dragSftTreeOLE | 3 | An OLE drag & drop operation is started automatically based on the [DragType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragType) property settings. |
### Comments
The DragMethod property defines how drag & drop is implemented.
The DragType property determines when the OLEStartDrag, DragStarting or AutoDragging event is generated to notify the application that a drag & drop operation has been initiated by the user.
A drag & drop operation always starts at the current location described by the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property. It is the application's responsibility to visually implement the drag & drop operation.
See Also SftTree Object | Object Hierarchy
## DragStarting Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DragStarting*
The user initiates a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**DragStarting**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**DragStarting** |
| VB | **Private Sub** *object*_**DragStarting**(**ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**) |
| C#.NET | **void** *object*_**DragStarting**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**DragStarting***object*(**short** *Button*, **short** *Shift*); |
| C | **HRESULT** On**DragStarting***object*(**short** *Button*, **short** *Shift*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
### Comments
The DragStarting event occurs when the user initiates a drag & drop operation.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) properties, this event may not be generated for the middle and right mouse buttons.
This event is only available if the [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) property is set to [dragSftTreeManual](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants) and is suitable for drag & drop within one tree control or between multiple controls. The container (i.e. Visual Basic, Visual C++, etc.) must implement the necessary drag & drop support (see DragMethod). The DragStarting event is only used to signal that the user has requested a drag & drop operation. The actual implementation of the drag & drop operation is delegated to the container, which must support drag & drop between controls.
The tree control generates the DragStarting event when the user starts a drag & drop operation. The [DragType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragType) property determines when a drag & drop operation is started.
A drag & drop operation always starts at the current location described by the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property. It is the application's responsibility to visually implement the drag & drop operation. When the operation involves the current tree control, this is accomplished by using the Items.[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) method and the Items.[DropHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) property. If dragging to another tree control, the target tree control's Items.HitTest method and Items.DropHighlight property have to be used. If dragging to another control type (list box, edit control, etc.), other means may have to be used as implemented by the target control.
**Note: ** Some host environments may not implement the required events and properties to drag to another control or control type. Some environments may not even support drag & drop operations at all. The Drag method used in the [DragStarting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DragStarting) event below is environment specific and not implemented by the tree control. Your environment's approach to initiating a drag & drop operation may involve another methods or may not be available at all. Please see the documentation that came with your development environment for more information about drag & drop.
See Also SftTree Object | Object Hierarchy
## DragType Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragType*
Defines the method that determines when a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation starts.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type)* = *object*.**DragType** **As [SftTreeDragTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragTypeConstants)** |
| VB | *Type* = *object*.**DragType** **As SftTreeDragTypeConstants** |
| C#.NET | **SftTreeDragTypeConstants** *Type* = *object*.**DragType**; |
| VC++ | **enum SftTreeDragTypeConstants** *Type* = *object*->**DragType**;
**enum SftTreeDragTypeConstants** *Type* = *object*->Get**DragType**(); |
| C | **HRESULT** *object*->get_**DragType**(**enum SftTreeDragTypeConstants*** *Type*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DragType** = *Type* **As SftTreeDragTypeConstants** |
| VB | *object*.**DragType** = *Type* **As SftTreeDragTypeConstants** |
| C#.NET | **SftTreeDragTypeConstants** *object*.**DragType** = *Type*; |
| VC++ | **enum SftTreeDragTypeConstants** *object*->**DragType** = *Type*;
**void** *object*->Put**DragType**(**enum SftTreeDragTypeConstants** *Type*); |
| C | **HRESULT** *object*->put_**DragType**(**enum SftTreeDragTypeConstants** *Type*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Type
Defines the method that determines when a drag & drop operation starts. When a drag & drop operation starts, the [OLEStartDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEStartDrag), [DragStarting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_DragStarting) or [AutoDragging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AutoDragging) events are generated, based on the [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) property settings.
| Type | Value | Description |
| --- | --- | --- |
| dragSftTreeNext | 0 | The drag & drop operation can start from a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and is initiated once the mouse cursor leaves the current item. Before an item can be dragged, it has to be selected using the keyboard or the mouse button and the mouse button has to be released, then a drag & drop operation can be started by pressing the mouse button again. |
| dragSftTreeBmpNext | 1 | The drag & drop operation can start from a label graphic, an item graphic or a cell and is initiated once the mouse cursor leaves the current item. Before an item can be dragged, it has to be selected using the keyboard or the mouse button and the mouse button has to be released, then a drag & drop operation can be started by pressing the mouse button again. |
| dragSftTreePix | 2 | The drag & drop operation can start from a cell and is initiated once the mouse cursor is moved by a certain pixel distance. Before an item can be dragged, it has to be selected using the keyboard or the mouse button and the mouse button has to be released, then a drag & drop operation can be started by pressing the mouse button again. |
| dragSftTreeBmpPix | 3 | The drag & drop operation can start from a label graphic, an item graphic or a cell and is initiated once the mouse cursor is moved by a certain pixel distance. Before an item can be dragged, it has to be selected using the keyboard or the mouse button and the mouse button has to be released, then a drag & drop operation can be started by pressing the mouse button again. |
| dragSftTreeNextImm | 4 | The drag & drop operation can start from a cell and is initiated once the mouse cursor leaves the current item. An item can be dragged as it is selected in a single or [multiple selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) tree control (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property). |
| dragSftTreeBmpNextImm | 5 | The drag & drop operation can start from a label graphic, an item graphic or a cell and is initiated once the mouse cursor leaves the current item. An item can be dragged as it is selected in a single or multiple selection tree control (see Items.MultiSelect property). |
| dragSftTreePixImm | 6 | The drag & drop operation can start from a cell and is initiated once the mouse cursor is moved by a certain pixel distance. An item can be dragged as it is selected in a single or multiple selection tree control (see Items.MultiSelect property). |
| dragSftTreeBmpPixImm | 7 | The drag & drop operation can start from a label graphic, an item graphic or a cell and is initiated once the mouse cursor is moved by a certain pixel distance. An item can be dragged as it is selected in a single or multiple selection tree control (see Items.MultiSelect property). |
### Comments
The DragType property defines the method that determines when a drag & drop operation starts.
The DragType property determines when the OLEStartDrag, DragStarting or AutoDragging event is generated to notify the application that a drag & drop operation has been initiated by the user.
A drag & drop operation always starts at the current location described by the Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property. It is the application's responsibility to visually implement the drag & drop operation unless OLE drag & drop is used.
Depending on the *Type* selected, dragging can start on the cell only or also on the label graphic and the item graphic.
With some *Type* values, a drag & drop operation starts once the user moves the mouse cursor by a certain pixel distance. The pixel distance used is retrieved by using the Windows API GetSystemMetrics(SM_CX/Y/DRAG).
See Also SftTree Object | Object Hierarchy
## DropHighlight Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlight*
Defines the index of the current [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).DropHighlight instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**DropHighlight** **As Integer** |
| VB | *ItemIndex* = *object*.**DropHighlight** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**DropHighlight**; |
| VC++ | **long** *ItemIndex* = *object*->**DropHighlight**;
**long** *ItemIndex* = *object*->Get**DropHighlight**(); |
| C | **HRESULT** *object*->get_**DropHighlight**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlight** = *ItemIndex* **As Integer** |
| VB | *object*.**DropHighlight** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**DropHighlight** = *ItemIndex*; |
| VC++ | **long** *object*->**DropHighlight** = *ItemIndex*;
**void** *object*->Put**DropHighlight**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**DropHighlight**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
Defines the index of the current drop target of a drag & drop operation. This value can be -1 to clear the drop target.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.DropHighlight instead
The DropHighlight property defines the index of the current drop target of a drag & drop operation.
The DropHighlight property is used to highlight the target of a drag & drop operation. There can be only one drop target at any one time. By setting the DropHighlight property to a new item, the previous item is no longer a drop target and is no longer highlighted.
The Items.[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) property can be used to control the appearance of the target item. Depending on the Items.DropHighlightStyle property value, the *ItemIndex* specified is the actual drop target or the insertion point. If used as an insertion point, the *ItemIndex* value can be set to the number of items in the tree control, which moves the insertion point to the end of the list of items.
By setting the DropHighlight property to -1, the current drop target is cleared.
A drag & drop operation always starts at the current location described by the Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property. It is the application's responsibility to visually implement the drag & drop operation. When the operation involves the current tree control, this is accomplished by using the Items.[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) method and the Items.DropHighlight property. If dragging to another tree control, the target tree control's Items.HitTest method and Items.DropHighlight property have to be used. If dragging to another control type (list box, edit control, etc.), other means may have to be used as implemented by the target control.
Once a drag & drop operation ends, the DropHighlight property has to be cleared by setting *ItemIndex* to -1. This removes the highlight indicator from the target item.
If the DropHighlight property is set to the first (or last) item currently visible in the tree control's client area, the tree control automatically scrolls up (or down) one item. This allows a user to drag items to a target item which has to be scrolled into view first. The contents of the tree control will scroll in the given direction until the DropHighlight property is set to -1 or to the index of an item which is not the first (or last) item visible.
See Also SftTree Object | Object Hierarchy
## DropHighlight Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight*
Defines the index of the current drop target of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**DropHighlight** **As Integer** |
| VB | *ItemIndex* = *object*.**DropHighlight** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**DropHighlight**; |
| VC++ | **long** *ItemIndex* = *object*->**DropHighlight**;
**long** *ItemIndex* = *object*->Get**DropHighlight**(); |
| C | **HRESULT** *object*->get_**DropHighlight**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlight** = *ItemIndex* **As Integer** |
| VB | *object*.**DropHighlight** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**DropHighlight** = *ItemIndex*; |
| VC++ | **long** *object*->**DropHighlight** = *ItemIndex*;
**void** *object*->Put**DropHighlight**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**DropHighlight**(**long** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
Defines the index of the current drop target of a drag & drop operation. This value can be -1 to clear the drop target.
### Comments
The DropHighlight property defines the index of the current drop target of a drag & drop operation.
The DropHighlight property is used to highlight the target of a drag & drop operation. There can be only one drop target at any one time. By setting the DropHighlight property to a new item, the previous item is no longer a drop target and is no longer highlighted.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) property can be used to control the appearance of the target item. Depending on the Items.DropHighlightStyle property value, the *ItemIndex* specified is the actual drop target or the insertion point. If used as an insertion point, the *ItemIndex* value can be set to the number of items in the tree control, which moves the insertion point to the end of the list of items.
By setting the DropHighlight property to -1, the current drop target is cleared.
A drag & drop operation always starts at the current location described by the Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property. It is the application's responsibility to visually implement the drag & drop operation. When the operation involves the current tree control, this is accomplished by using the Items.[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) method and the Items.[DropHighlight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) property. If dragging to another tree control, the target tree control's Items.HitTest method and Items.DropHighlight property have to be used. If dragging to another control type (list box, edit control, etc.), other means may have to be used as implemented by the target control.
Once a drag & drop operation ends, the DropHighlight property has to be cleared by setting *ItemIndex* to -1. This removes the highlight indicator from the target item.
If the DropHighlight property is set to the first (or last) item currently visible in the tree control's client area, the tree control automatically scrolls up (or down) one item. This allows a user to drag items to a target item which has to be scrolled into view first. The contents of the tree control will scroll in the given direction until the DropHighlight property is set to -1 or to the index of an item which is not the first (or last) item visible.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property to determine the exact appearance of drop target items. The highlighted portion of a drop target is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## DropHighlightColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlightColor*
Defines the color used to display the [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) item of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropHighlightColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropHighlightColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**DropHighlightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropHighlightColor**;
**OLE_COLOR** *Clr* = *object*->Get**DropHighlightColor**(); |
| C | **HRESULT** *object*->get_**DropHighlightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlightColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**DropHighlightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**DropHighlightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropHighlightColor** = *Clr*;
**void** *object*->Put**DropHighlightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropHighlightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to display the drop target item of a drag & drop operation. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.DropHighlightColor instead
The DropHighlightColor property defines the color used to display the drop target item of a drag & drop operation.
The drop target is displayed using *Clr* based on the Items.[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
See Also SftTree Object | Object Hierarchy
## DropHighlightColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor*
Defines the color used to display the [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) item of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropHighlightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropHighlightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**DropHighlightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropHighlightColor**;
**OLE_COLOR** *Clr* = *object*->Get**DropHighlightColor**(); |
| C | **HRESULT** *object*->get_**DropHighlightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlightColor** = *Clr* **As UInteger** |
| VB | *object*.**DropHighlightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**DropHighlightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropHighlightColor** = *Clr*;
**void** *object*->Put**DropHighlightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropHighlightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to display the drop target item of a drag & drop operation. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The DropHighlightColor property defines the color used to display the drop target item of a drag & drop operation.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property to determine the exact appearance of drop target items. The highlighted portion of a drop target is rendered using the outline style defined by the Items.OutlineStyle property.
The drop target is displayed based on the Items.[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
The DropHighlightColor property is only used if the Items.OutlineStyle property is set to [OutlineStyleSftTreeRect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the Items.[DropTargetInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerBorderColor), Items.[DropTargetInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill1), Items.[DropTargetInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill2), Items.[DropTargetOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetOutlineBorderColor) properties are used instead.
See Also SftTreeItems Object | Object Hierarchy
## DropHighlightStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DropHighlightStyle*
Defines the style used to display the [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**DropHighlightStyle** **As [SftTreeDropHighlightStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDropHighlightStyleConstants)** |
| VB | *Style* = *object*.**DropHighlightStyle** **As SftTreeDropHighlightStyleConstants** |
| C#.NET | **SftTreeDropHighlightStyleConstants** *Style* = *object*.**DropHighlightStyle**; |
| VC++ | **enum SftTreeDropHighlightStyleConstants** *Style* = *object*->**DropHighlightStyle**;
**enum SftTreeDropHighlightStyleConstants** *Style* = *object*->Get**DropHighlightStyle**(); |
| C | **HRESULT** *object*->get_**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlightStyle** = *Style* **As SftTreeDropHighlightStyleConstants** |
| VB | *object*.**DropHighlightStyle** = *Style* **As SftTreeDropHighlightStyleConstants** |
| C#.NET | **SftTreeDropHighlightStyleConstants** *object*.**DropHighlightStyle** = *Style*; |
| VC++ | **enum SftTreeDropHighlightStyleConstants** *object*->**DropHighlightStyle** = *Style*;
**void** *object*->Put**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the style used to display the drop target of a drag & drop operation.
| Style | Value | Description |
| --- | --- | --- |
| dropSftTreeCaret | 0 | The drag & drop target is the current item. The Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property is updated and set to the drop target. The drop target becomes the new current item. The target item is not selected, so even in a [single selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) tree control (see Items.[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property), the Items.Current property value and the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property value are not identical. |
| dropSftTreeOnTop | 1 | The drag & drop target is highlighted using the color defined using the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property. The color is used as background color for the target item. The Items.Current property is not updated. |
| dropSftTreeBetween | 2 | The drag & drop target is highlighted using a solid line drawn using the color defined by the Items.DropHighlightColor property. The line is drawn before the target item, interpreting the Items.DropHighlight property as the insertion point. The Items.Current property is not updated. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.DropHighlightStyle instead
The DropHighlightStyle property defines the style used to display the drop target of a drag & drop operation.
See Also SftTree Object | Object Hierarchy
## DropHighlightStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle*
Defines the style used to display the [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) of a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**DropHighlightStyle** **As [SftTreeDropHighlightStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDropHighlightStyleConstants)** |
| VB | *Style* = *object*.**DropHighlightStyle** **As SftTreeDropHighlightStyleConstants** |
| C#.NET | **SftTreeDropHighlightStyleConstants** *Style* = *object*.**DropHighlightStyle**; |
| VC++ | **enum SftTreeDropHighlightStyleConstants** *Style* = *object*->**DropHighlightStyle**;
**enum SftTreeDropHighlightStyleConstants** *Style* = *object*->Get**DropHighlightStyle**(); |
| C | **HRESULT** *object*->get_**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropHighlightStyle** = *Style* **As SftTreeDropHighlightStyleConstants** |
| VB | *object*.**DropHighlightStyle** = *Style* **As SftTreeDropHighlightStyleConstants** |
| C#.NET | **SftTreeDropHighlightStyleConstants** *object*.**DropHighlightStyle** = *Style*; |
| VC++ | **enum SftTreeDropHighlightStyleConstants** *object*->**DropHighlightStyle** = *Style*;
**void** *object*->Put**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**DropHighlightStyle**(**enum SftTreeDropHighlightStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the style used to display the drop target of a drag & drop operation.
| Style | Value | Description |
| --- | --- | --- |
| dropSftTreeCaret | 0 | The drag & drop target is the current item. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) property is updated and set to the drop target. The drop target becomes the new current item. The target item is not selected, so even in a [single selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) tree control (see Items.[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property), the Items.Current property value and the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property value are not identical. |
| dropSftTreeOnTop | 1 | The drag & drop target is highlighted using the color defined using the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property. The color is used as background color for the target item. The Items.Current property is not updated. |
| dropSftTreeBetween | 2 | The drag & drop target is highlighted using a solid line drawn using the color defined by the Items.DropHighlightColor property. The line is drawn before the target item, interpreting the Items.DropHighlight property as the insertion point. The Items.Current property is not updated. |
### Comments
The DropHighlightStyle property defines the style used to display the drop target of a drag & drop operation.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property to determine the exact appearance of drop target items. The highlighted portion of a drop target is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## DropTargetInnerBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerBorderColor*
Defines the inner border color for items as [drop targets](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) during a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropTargetInnerBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropTargetInnerBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**DropTargetInnerBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropTargetInnerBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**DropTargetInnerBorderColor**(); |
| C | **HRESULT** *object*->get_**DropTargetInnerBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropTargetInnerBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**DropTargetInnerBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**DropTargetInnerBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropTargetInnerBorderColor** = *Clr*;
**void** *object*->Put**DropTargetInnerBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropTargetInnerBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the inner border color for items as drop targets during a drag & drop operation.
### Comments
The DropTargetInnerBorderColor property defines the inner border color for items as drop targets during a drag & drop operation.
The drop target is displayed based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
The DropTargetInnerBorderColor property is only used if the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property is used instead.
See Also SftTreeItems Object | Object Hierarchy
## DropTargetInnerFill1 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill1*
Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for items as [drop targets](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) during a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropTargetInnerFill1** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropTargetInnerFill1** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**DropTargetInnerFill1**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropTargetInnerFill1**;
**OLE_COLOR** *Clr* = *object*->Get**DropTargetInnerFill1**(); |
| C | **HRESULT** *object*->get_**DropTargetInnerFill1**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropTargetInnerFill1** = *Clr* **As UInteger** |
| VB | *object*.**DropTargetInnerFill1** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**DropTargetInnerFill1** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropTargetInnerFill1** = *Clr*;
**void** *object*->Put**DropTargetInnerFill1**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropTargetInnerFill1**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the starting color used to fill the selection outline for items as drop targets during a drag & drop operation.
### Comments
The DropTargetInnerFill1 property defines the starting color used to fill the selection outline for items as drop targets during a drag & drop operation.
The drop target is displayed based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
The DropTargetInnerFill1 property is only used if the Items.OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property is used instead.
See Also SftTreeItems Object | Object Hierarchy
## DropTargetInnerFill2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill2*
Defines the ending color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for items as [drop targets](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) during a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropTargetInnerFill2** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropTargetInnerFill2** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**DropTargetInnerFill2**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropTargetInnerFill2**;
**OLE_COLOR** *Clr* = *object*->Get**DropTargetInnerFill2**(); |
| C | **HRESULT** *object*->get_**DropTargetInnerFill2**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropTargetInnerFill2** = *Clr* **As UInteger** |
| VB | *object*.**DropTargetInnerFill2** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**DropTargetInnerFill2** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropTargetInnerFill2** = *Clr*;
**void** *object*->Put**DropTargetInnerFill2**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropTargetInnerFill2**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the ending color used to fill the selection outline for items as drop targets during a drag & drop operation.
### Comments
The DropTargetInnerFill2 property defines the ending color used to fill the selection outline for items as drop targets during a drag & drop operation.
The drop target is displayed based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
The DropTargetInnerFill2 property is only used if the Items.OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property is used instead.
See Also SftTreeItems Object | Object Hierarchy
## DropTargetOutlineBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetOutlineBorderColor*
Defines the outline border color for items as [drop targets](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) during a [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**DropTargetOutlineBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**DropTargetOutlineBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**DropTargetOutlineBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**DropTargetOutlineBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**DropTargetOutlineBorderColor**(); |
| C | **HRESULT** *object*->get_**DropTargetOutlineBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**DropTargetOutlineBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**DropTargetOutlineBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**DropTargetOutlineBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**DropTargetOutlineBorderColor** = *Clr*;
**void** *object*->Put**DropTargetOutlineBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**DropTargetOutlineBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the outline border color for items as drop targets during a drag & drop operation.
### Comments
The DropTargetOutlineBorderColor property defines the outline border color for items as drop targets during a drag & drop operation.
The drop target is displayed based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[DropHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightStyle) and Items.DropHighlight properties.
The DropTargetOutlineBorderColor property is only used if the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor) property is used instead.
See Also SftTreeItems Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeFooters Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeHeaders Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers.
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeItems Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## EdgeHorizontalColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeHorizontalColor*
Defines the color used to draw all horizontal edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeHorizontalColor**(); |
| C | **HRESULT** *object*->get_**EdgeHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeHorizontalColor** = *Clr*;
**void** *object*->Put**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the color used to draw all horizontal edges around headers/footers.
### Comments
The EdgeHorizontalColor property defines the color used to draw all horizontal edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using EdgeHorizontalColor and [EdgeVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeVerticalColor) are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowHeaders Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the color used to draw all vertical edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeFooters Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the color used to draw all vertical edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeHeaders Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw all vertical edges around headers/footers.
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeItems Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the color used to draw all vertical edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the color used to draw all vertical edges around headers/footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## EdgeVerticalColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeVerticalColor*
Defines the color used to draw all vertical edges around headers/footers.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**EdgeVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**EdgeVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**EdgeVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**EdgeVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**EdgeVerticalColor**(); |
| C | **HRESULT** *object*->get_**EdgeVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EdgeVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**EdgeVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**EdgeVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**EdgeVerticalColor** = *Clr*;
**void** *object*->Put**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**EdgeVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the color used to draw all vertical edges around headers/footers.
### Comments
The EdgeVerticalColor property defines the color used to draw all vertical edges around headers/footers.
[Column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), row/column headers and row/column footers have numerous color properties to define their appearance. The colors defined using [EdgeHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_EdgeHorizontalColor) and EdgeVerticalColor are not part of the headers or footers. They are used to separate display elements from each each other. The EdgeVerticalColor property is used to the right of each column header to separate individual column headers, to the right of row headers, to the right of the row/column header and row/column footer. The EdgeHorizontalColor property is used below each column header, below each row header, below the row/column header and above the row/column footer and column footers.
While many objects have an EdgeVerticalColor and EdgeHorizontalColor property (like [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders), [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader), [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter)), they are all synonyms and by changing one property value, all objects will reflect the new color value.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Edit Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit*
Edits the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Edit**(**ByVal** *Window* **As Integer**, **ByVal** *vData* **As Object**) |
| VB | *object*.**Edit**(**ByVal** *Window* **As OLE_HANDLE**, **ByVal** *vData* **As Variant**) |
| C#.NET | **void** *object*.**Edit**(**int** *Window*, **object** *vData*); |
| VC++ | **HRESULT** *object*->**Edit**(**OLE_HANDLE** *Window*, **const _variant_t**&**** *vData*); |
| C | **HRESULT** *object*->raw_**Edit**(**OLE_HANDLE** *Window*, **VARIANT** *vData*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Window
A window handle. Defines the control used for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting). This parameter can be Nothing (NULL) to allow the [EditInitializing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing) event to provide the window handle used for cell editing (which is also the preferred method).
vData
An application-specific value. This value is used as *vData* parameter for the EditInitializing event. This parameter can be Nothing (NULL).
### Comments
The Edit method edits the cell.
Cell editing is initiated by the subsequent EditInitializing event which is used to position and initialize the control used for cell editing.
The Edit method cannot edit a cell whose [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[EditIgnore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_EditIgnore) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).EditIgnore properties have marked the cell as non-editable or if the [EditAllowed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditAllowed) event indicates that the cell cannot be reached during cell editing.
See Also SftTreeCell Object | Object Hierarchy
## EditAllowed Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditAllowed*
Determines whether a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can be reached during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditAllowed**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditAllowed** |
| VB | **Private Sub** *object*_**EditAllowed**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *Allowed* **As Boolean**) |
| C#.NET | **void** *object*_**EditAllowed**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditAllowed***object*(**long** *ItemIndex*, **short** *ColIndex*, **VARIANT_BOOL*** *Allowed*); |
| C | **HRESULT** On**EditAllowed***object*(**long** *ItemIndex*, **short** *ColIndex*, **VARIANT_BOOL*** *Allowed*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)
The zero-based item index of the item to be tested for cell editing. The combination of *EditIndex* and *EditCol* describes an individual cell.
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
Allowed
Return True to allow editing of the specified cell, False otherwise.
### Comments
The EditAllowed event determines whether a cell can be reached during cell editing.
It is called while a [EditNavigate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditNavigate) method is being processed, to determine whether a cell can be reached during cell editing. It is possible to suppress cell editing for items and cells using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[EditIgnore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_EditIgnore) and [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[EditIgnore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_EditIgnore) properties. In addition, the EditNavigate method can be used to disallow editing of cells, even if the cell is otherwise editable.
If cell editing is suppressed for items and cells using the Item.EditIgnore and Cell.EditIgnore properties, the EditAllowed event does not occur for these items and cells.
Other than determining whether a cell can be reached during cell editing, this event should not take any other action or update the tree control in any way.
See Also SftTree Object | Object Hierarchy
## EditColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditColumn*
Returns the column of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) currently being edited.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**EditColumn** **As Short** |
| VB | *ColIndex* = *object*.**EditColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**EditColumn**; |
| VC++ | **short** *ColIndex* = *object*->**EditColumn**;
**short** *ColIndex* = *object*->Get**EditColumn**(); |
| C | **HRESULT** *object*->get_**EditColumn**(**short*** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
Returns the column of the cell currently being edited. -1 is returned if [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is not active.
### Comments
The EditColumn property returns the column of the cell currently being edited.
The [EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex) property can be used to retrieve the index of the cell currently being edited.
See Also SftTree Object | Object Hierarchy
## EditEnded Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnded*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) has ended.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditEnded**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditEnded** |
| VB | **Private Sub** *object*_**EditEnded**(**ByVal** *Accepted* **As Boolean**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**EditEnded**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditEnded***object*(**VARIANT_BOOL** *Accepted*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**EditEnded***object*(**VARIANT_BOOL** *Accepted*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Accepted
True if cell editing was ended by the used by accepting the input data of the last [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited, False otherwise.
[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)
The zero-based index of the last item being edited. The combination of *EditIndex* and *EditCol* describes an individual cell.
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
### Comments
The EditEnded event occurs when cell editing has ended.
The EditEnded event occurs once cell editing has completely ended. If the user is editing a cell and uses cell navigation to edit another cell or clicks on another cell for editing purposes, the EditEnded event does not occur.
The EditEnded event can be used to validate multiple interrelated cells after cell editing has been completed or to prevent a user from exiting cell editing prematurely. If a cell is incomplete or invalid, cell editing can be restarted using the Cell.[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
See Also SftTree Object | Object Hierarchy
## EditEnding Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnding*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is ending.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditEnding**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditEnding** |
| VB | **Private Sub** *object*_**EditEnding**(**ByVal** *Window* **As OLE_HANDLE**, **ByVal** *vData* **As Variant**, **ByVal** *[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)* **As Long**, **ByVal** *EditCol* **As Integer**, **ByVal** *SaveInput* **As Boolean**) |
| C#.NET | **void** *object*_**EditEnding**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditEnding***object*(**OLE_HANDLE** *Window*, **const _variant_t**&**** *vData*, **long** *EditIndex*, **short** *EditCol*, **VARIANT_BOOL** *SaveInput*); |
| C | **HRESULT** On**EditEnding***object*(**OLE_HANDLE** *Window*, **VARIANT** *vData*, **long** *EditIndex*, **short** *EditCol*, **VARIANT_BOOL** *SaveInput*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Window
The window handle of the control being used for cell editing.
vData
Application-specific data provided as *vData* argument when [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) was called.
EditIndex
The zero-based index of the item being edited. The combination of *EditIndex* and *EditCol* describes an individual cell.
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
SaveInput
True if the new input data should be saved in the tree control, False otherwise. The value of *SaveInput* was returned by the application's [EditValidate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditValidate) event as * InputValid* argument.
### Comments
The EditEnding event occurs when cell editing is ending.
This event occurs every time cell editing for one cell is about to end. This event should only be used to save input data in the tree control and to hide and disable the control used for cell editing. This event should not take any other action or update the tree control in any other way. If the control is in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode), the [VirtualItemChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualItemChanged) method can be used to mark the item and cell as modified.
SftTree/OCX automatically hides and disables the control used for cell editing based (the *Window* handle provided in the [EditInitializing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing) event). However, many environments (including .NET) and ActiveX controls require that the application hide and disable controls explicitly.
After the EditEnding event occurs, another cell could be edited automatically as the result of cell navigation.
The EditValidate event can be used to validate the contents of the cell being edited. The EditValidate event precedes the EditEnding event.
The [EditEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnded) event occurs once cell editing has completely ended.
See Also SftTree Object | Object Hierarchy
## EditIgnore Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_EditIgnore*
Defines whether the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) is ignored for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**EditIgnore** **As Boolean** |
| VB | *Boolean* = *object*.**EditIgnore** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**EditIgnore**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**EditIgnore**;
**VARIANT_BOOL** *Boolean* = *object*->Get**EditIgnore**(); |
| C | **HRESULT** *object*->get_**EditIgnore**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EditIgnore** = *Boolean* **As Boolean** |
| VB | *object*.**EditIgnore** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**EditIgnore** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**EditIgnore** = *Boolean*;
**void** *object*->Put**EditIgnore**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**EditIgnore**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Boolean
Defines whether the cell is ignored for cell editing.
| Boolean | Description |
| --- | --- |
| True | The cell is ignored for cell editing. It cannot be edited using the Cell.[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method and the [EditNavigate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditNavigate) method will skip this cell. |
| False | The cell can be edited, unless editing is prevented by the Item.EditIgnore property. |
### Comments
The EditIgnore property defines whether the cell is ignored for cell editing.
See Also SftTreeCell Object | Object Hierarchy
## EditIgnore Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_EditIgnore*
Defines whether the item is ignored for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**EditIgnore** **As Boolean** |
| VB | *Boolean* = *object*.**EditIgnore** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**EditIgnore**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**EditIgnore**;
**VARIANT_BOOL** *Boolean* = *object*->Get**EditIgnore**(); |
| C | **HRESULT** *object*->get_**EditIgnore**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EditIgnore** = *Boolean* **As Boolean** |
| VB | *object*.**EditIgnore** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**EditIgnore** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**EditIgnore** = *Boolean*;
**void** *object*->Put**EditIgnore**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**EditIgnore**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is ignored for cell editing.
| Boolean | Description |
| --- | --- |
| True | All [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) of this item are ignored for cell editing. They cannot be edited using the Cell.[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method and the [EditNavigate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditNavigate) method will skip this item and all its cells. |
| False | This item and all its cells can be edited, unless editing is prevented by a cell's Cell.EditIgnore property. |
### Comments
The EditIgnore property defines whether the item is ignored for cell editing.
See Also SftTreeItem Object | Object Hierarchy
## EditIndex Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex*
Returns the index of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) currently being edited.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**EditIndex** **As Integer** |
| VB | *ItemIndex* = *object*.**EditIndex** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**EditIndex**; |
| VC++ | **long** *ItemIndex* = *object*->**EditIndex**;
**long** *ItemIndex* = *object*->Get**EditIndex**(); |
| C | **HRESULT** *object*->get_**EditIndex**(**long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
Returns the item index of the cell currently being edited. -1 is returned if [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is not active.
### Comments
The EditIndex property returns the index of the cell currently being edited.
The [EditColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditColumn) property can be used to retrieve the column of the cell currently being edited.
See Also SftTree Object | Object Hierarchy
## EditInitialized Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitialized*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is about to start.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditInitialized**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditInitialized** |
| VB | **Private Sub** *object*_**EditInitialized**(**ByVal** *Window* **As OLE_HANDLE**, **ByVal** *vData* **As Variant**, **ByVal** *[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)* **As Long**, **ByVal** *EditCol* **As Integer**, **ByVal** *ParentWindow* **As OLE_HANDLE**, **ByVal** *LeftPix* **As Long**, **ByVal** *TopPix* **As Long**, **ByVal** *WidthPix* **As Long**, **ByVal** *HeightPix* **As Long**, *Positioned* **As Boolean**) |
| C#.NET | **void** *object*_**EditInitialized**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditInitialized***object*(**OLE_HANDLE** *Window*, **const _variant_t**&**** *vData*, **long** *EditIndex*, **short** *EditCol*, **OLE_HANDLE** *ParentWindow*, **long** *LeftPix*, **long** *TopPix*, **long** *WidthPix*, **long** *HeightPix*, **VARIANT_BOOL*** *Positioned*); |
| C | **HRESULT** On**EditInitialized***object*(**OLE_HANDLE** *Window*, **VARIANT** *vData*, **long** *EditIndex*, **short** *EditCol*, **OLE_HANDLE** *ParentWindow*, **long** *LeftPix*, **long** *TopPix*, **long** *WidthPix*, **long** *HeightPix*, **VARIANT_BOOL*** *Positioned*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Window
The window handle of the control being used for cell editing.
vData
Application-specific data provided as *vData* argument when [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) was called.
EditIndex
The zero-based index of the item being edited. The combination of *EditIndex* and *EditCol* describes an individual [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
ParentWindow
The window handle of the window hosting the control used for cell editing.
LeftPix
The x coordinate of the control used for cell editing in pixels. This value was determined and returned by the [EditInitializing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing) event.
TopPix
The y coordinate of the control used for cell editing in pixels. This value was determined and returned by the EditInitializing event.
WidthPix
The width of the control used for cell editing in pixels. This value was determined and returned by the EditInitializing event.
HeightPix
The height of the control used for cell editing in pixels. This value was determined and returned by the EditInitializing event.
Positioned
Return True if the control used for cell editing was positioned by the application in the [EditInitialized](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitialized) event. The application also must make the control visible, enabled and set the input focus to the control.
If False is returned, the tree control will position the control, enable the control, make it visible and set the input focus to the control.
### Comments
The EditInitialized event occurs when cell editing is about to start.
Cell editing is about to start. The EditInitializing event, which precedes the EditInitialized event, has initialized a control for cell editing (described by the *Window* argument).
This event can be used to perform final control initialization. The control's position and dimension can be set, based on the *LeftPix*, *TopPix*, *WidthPix, HeightPix* arguments. The application also must make the control visible, enabled and set the input focus to the control. If *Positioned* is set to False, the tree control will automatically position the control used for cell editing, make the control visible, enabled and set the input focus to the control. However, many environments (including .NET) and ActiveX controls require that the application make controls visible and enabled explicitly.
Additional final customizations can be performed. For example, when a combo box is used, this event can drop down the dropdown portion of the edit control.
This event should not be used to otherwise initialize a control used for cell editing, nor should the tree control manipulated or updated in any way.
See Also SftTree Object | Object Hierarchy
## EditInitializing Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitializing*
The control used for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) is initialized.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditInitializing**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditInitializing** |
| VB | **Private Sub** *object*_**EditInitializing**(*Window* **As OLE_HANDLE**, *vData* **As Variant**, **ByVal** *[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)* **As Long**, **ByVal** *EditCol* **As Integer**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) |
| C#.NET | **void** *object*_**EditInitializing**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditInitializing***object*(**OLE_HANDLE*** *Window*, **const _variant_t**&***** *vData*, **long** *EditIndex*, **short** *EditCol*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** On**EditInitializing***object*(**OLE_HANDLE*** *Window*, **VARIANT*** *vData*, **long** *EditIndex*, **short** *EditCol*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Window
Returns the window handle of the control being used for cell editing. Initially, this argument contains the value passed as the *Window* argument of the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
vData
Returns application-specific data. Initially, this argument contains the application-specific data passed as the *vData* argument of the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).Edit method.
EditIndex
The zero-based index of the item being edited. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
EditCol
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Left
Returns the coordinate of the desired left edge of the control used for cell editing. Initially, this argument contains the left edge of the cell to be edited. Coordinates are in pixels and relative to the top, left edge of the control's client area.
Top
Returns the coordinate of the desired top edge of the control used for cell editing. Initially, this argument contains the top edge of the cell to be edited. Coordinates are in pixels and relative to the top, left edge of the control's client area.
Width
Returns the desired width of the control used for cell editing. Initially, this argument contains width of the cell to be edited. Dimensions are in pixels.
Height
Returns the desired height of the control used for cell editing. Initially, this argument contains the height of the cell to be edited. Dimensions are in pixels.
### Comments
The EditInitializing event occurs when the control used for cell editing is initialized.
The initializing event is used to make a control for cell editing available, by returning a control window handle (*Window*). The control's display attributes and contents should be fully initialized by this event. Its dimensions and position should be returned in the *Left*, *Top*, *Width*, *Height* arguments.
The control's position cannot be set in the EditInitializing event, instead the [EditInitialized](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditInitialized) event is used. Only the width and height of the control can be updated in the EditInitializing event (or also in the EditInitialized event).
The [CellEditIntercept](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditIntercept) method can be used to define navigational keys and other keystrokes that should be intercepted while cell editing. The [EditNavigating](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating) event occurs when keystrokes are intercepted.
See Also SftTree Object | Object Hierarchy
## EditNavigate Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditNavigate*
Positions [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) on another [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *Handled* = *object*.**EditNavigate**(**ByVal** *Key* **As Integer**, **ByVal** *Shift* **As Short**) **As Boolean** |
| VB | *Handled* = *object*.**EditNavigate**(**ByVal** *Key* **As Long**, **ByVal** *Shift* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Handled* = *object*.**EditNavigate**(**int** *Key*, **short** *Shift*); |
| VC++ | **VARIANT_BOOL** *Handled* = *object*->**EditNavigate**(**long** *Key*, **short** *Shift*); |
| C | **HRESULT** *object*->raw_**EditNavigate**(**long** *Key*, **short** *Shift*, **VARIANT_BOOL*** *Handled*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
A virtual key code. The key to be handled.
| Symbol Name | Value | Description |
| --- | --- | --- |
| VK_TAB | 0x09 | TAB key - This key is handled by the EditNavigate method. Editing of the current cell ends and the next or previous editable cell in the tree control is edited. The TAB key will position to the next cell, SHIFT + TAB to the previous cell. The CONTROL key is ignored. |
| VK_RETURN | 0x0d | ENTER key - This key is handled by the EditNavigate method. Editing of the current cell ends and the next editable cell in the tree control is edited. The CONTROL and SHIFT keys are ignored. |
| VK_ESCAPE | 0x1b | ESC key - This key is handled by the EditNavigate method. Cell editing is ended by calling [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit). |
| VK_END | 0x23 | END key - This key is handled by the EditNavigate method if the CONTROL key is pressed. Editing of the current cell ends and the last editable cell in the tree control is edited. |
| VK_HOME | 0x24 | HOME key - This key is handled by the EditNavigate method if the CONTROL key is pressed. Editing of the current cell ends and the first editable cell in the tree control is edited. |
| VK_UP | 0x26 | UP ARROW key - This key is handled by the EditNavigate method if the CONTROL and SHIFT keys are not pressed. Editing of the current cell ends and the cell in the same column of the preceding item is edited. |
| VK_DOWN | 0x28 | DOWN ARROW key - This key is handled by the EditNavigate method if the CONTROL and SHIFT keys are not pressed. Editing of the current cell ends and the cell in the same column of the next item is edited. |
**Note:** Symbolic names are only available to applications written in C/C++, which use the #include directive to include WinUser.h, part of the Windows header files.
Shift
The state of the SHIFT, CONTROL and ALT keys (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | Not used. The ALT key was pressed. |
Handled
Returns True if the key *Key* was handled by the EditNavigate method, otherwise False is returned.
### Comments
The EditNavigate method positions cell editing on another cell.
The EditNavigate method implements default cell navigation for the virtual key codes *Key* and is called to handle navigation keys pressed during cell editing. These keys can be defined using the [CellEditIntercept](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditIntercept) method. A key that is intercepted will generate the [EditNavigating](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating) event so the application can handle the key by calling EditNavigate.
See Also SftTree Object | Object Hierarchy
## EditNavigating Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditNavigating*
A key has been intercepted which is used for navigation during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditNavigating**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditNavigating** |
| VB | **Private Sub** *object*_**EditNavigating**(**ByVal** *Key* **As Long**, **ByVal** *Shift* **As Integer**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**EditNavigating**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditNavigating***object*(**long** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**EditNavigating***object*(**long** *Key*, **short** *Shift*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Key
A virtual key code. Defines the key that was intercepted. See the [CellEditIntercept](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditIntercept) method for a list of available virtual key codes.
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | Not used. The ALT key was pressed. |
[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)
The zero-based index of the item being edited. The combination of *EditIndex* and *EditCol* describes an individual [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
### Comments
The EditNavigating event occurs when a key has been intercepted which is used for navigation during cell editing.
The CellEditIntercept method defines keystrokes to be intercepted during cell editing using the EditNavigating event. Only navigation keys should be intercepted. Other keys can be handled in the control's own event handlers ([KeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyDown)/[KeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress)/[KeyUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyUp) events).
An application can handle a key by calling [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit) to end cell editing of the current cell, followed by a call to [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) for the new cell to be edited.
See Also SftTree Object | Object Hierarchy
## EditNoFocusStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EditNoFocusStyle*
Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**EditNoFocusStyle** **As [SftTreeNoFocusStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants)** |
| VB | *Style* = *object*.**EditNoFocusStyle** **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *Style* = *object*.**EditNoFocusStyle**; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *Style* = *object*->**EditNoFocusStyle**;
**enum SftTreeNoFocusStyleConstants** *Style* = *object*->Get**EditNoFocusStyle**(); |
| C | **HRESULT** *object*->get_**EditNoFocusStyle**(**enum SftTreeNoFocusStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**EditNoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| VB | *object*.**EditNoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *object*.**EditNoFocusStyle** = *Style*; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *object*->**EditNoFocusStyle** = *Style*;
**void** *object*->Put**EditNoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**EditNoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the display style of selected items during cell editing.
| Style | Value | Description |
| --- | --- | --- |
| noFocusSftTreeKeepSel | 0 | The selected items are drawn the same way as for a tree control that has the input focus. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus) and Items.[SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus) properties can be used to define the colors used for selected items in this case. |
| noFocusSftTreeFrame | 1 | The selected items are drawn as items that are not selected, but are framed by a rectangle drawn using the color specified by the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property. |
| noFocusSftTreeNothing | 2 | The selected items are drawn as items that are not selected. The user cannot distinguish between selected items and items that are not selected during cell editing. |
### Comments
The EditNoFocusStyle property defines the display style of selected items during cell editing.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is used to change the appearance of selected items in a tree control that has the input focus.
The Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property can be used to define the display style of selected items when the tree control does not have the input focus.
See Also SftTreeItems Object | Object Hierarchy
## EditValidate Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditValidate*
The new contents of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) being edited are to be validated.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**EditValidate**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**EditValidate** |
| VB | **Private Sub** *object*_**EditValidate**(**ByVal** *Window* **As OLE_HANDLE**, **ByVal** *vData* **As Variant**, **ByVal** *[EditIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EditIndex)* **As Long**, **ByVal** *EditCol* **As Integer**, *InputValid* **As Boolean**) |
| C#.NET | **void** *object*_**EditValidate**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**EditValidate***object*(**OLE_HANDLE** *Window*, **const _variant_t**&**** *vData*, **long** *EditIndex*, **short** *EditCol*, **VARIANT_BOOL*** *InputValid*); |
| C | **HRESULT** On**EditValidate***object*(**OLE_HANDLE** *Window*, **VARIANT** *vData*, **long** *EditIndex*, **short** *EditCol*, **VARIANT_BOOL*** *InputValid*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Window
The window handle of the control being used for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
vData
Application-specific data provided as *vData* argument when [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) was called.
EditIndex
The zero-based index of the item being edited. The combination of *EditIndex* and *EditCol* describes an individual cell.
EditCol
The zero-based column number. The combination of *EditIndex* and *EditCol* describes an individual cell.
InputValid
Return True if the contents are valid, False otherwise.
### Comments
The EditValidate event occurs when the new contents of the cell being edited are to be validated.
The EditValidate event occurs when editing of one cell is about to end (the user clicks outside of the current cell being edited, cell navigation is handled or if the [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit)(True) method is used. The EditValidate event allows the application to perform input validation. The new cell text currently contained in the control used for cell editing can be inspected and/or modified. If the text entered or selected is invalid, the *InputValid* variable can be set to False. This indicates that the new value cannot be accepted and cell editing is to be resumed. Setting * InputValid* to True (default), cell editing is ended.
If cell editing is aborted by the user by pressing the ESCAPE key, the EditValidate event is not generated.
The new cell contents can be saved while handling the [EditEnding](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnding) event.
> The tree control properties cannot be modified during this event. If the tree control is updated in any way, cell editing is terminated. Use the EditEnding event to save the new cell contents.
See Also SftTree Object | Object Hierarchy
## Enabled Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Enabled*
Defines whether the tree control responds to user-generated events.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the tree control responds to user-generated events.
| Boolean | Description |
| --- | --- |
| True | The tree control is enabled and responds to user-generated events. |
| False | The tree control is disabled and does not respond to user-generated events. |
### Comments
The Enabled property defines whether the tree control responds to user-generated events.
If a tree control is disabled, it uses the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor), [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GrayedColor), [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor), [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor) and [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor) properties to draw the text components in a grayed fashion. Graphic components are displayed in a grayed fashion by graying the images, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
See Also SftTree Object | Object Hierarchy
## Enabled Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled*
Defines whether the [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Boolean
Defines whether the column footer is enabled.
| Boolean | Description |
| --- | --- |
| True | The column footer is enabled. |
| False | The column footer is disabled. |
### Comments
The Enabled property defines whether the column footer is enabled.
A disabled column footer is drawn using the [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GrayedColor) property value as text color and column footer graphics (see [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Image) property) are drawn in a "grayed" fashion, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled column footer button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) or [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events.
See Also SftTreeFooter Object | Object Hierarchy
## Enabled Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled*
Defines whether the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Boolean
Defines whether the column header is enabled.
| Boolean | Description |
| --- | --- |
| True | The column header is enabled. |
| False | The column header is disabled. |
### Comments
The Enabled property defines whether the column header is enabled.
A disabled column header is drawn using the [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor) property value as text color and column header graphics (see [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) property) are drawn in a "grayed" fashion, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled column header button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) or [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events.
See Also SftTreeHeader Object | Object Hierarchy
## Enabled Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled*
Defines whether the item is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is enabled.
| Boolean | Description |
| --- | --- |
| True | The item is enabled. |
| False | The item is disabled. It is drawn in a "grayed" manner indicating its status. |
### Comments
The Enabled property defines whether the item is enabled.
The [DisabledItemsSelectable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DisabledItemsSelectable) property can be used to prevent an end-user from selecting disabled items. [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can always be selected by an application. DisabledItemsSelectable only controls whether the end-user can select an item.
See Also SftTreeItem Object | Object Hierarchy
## Enabled Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Enabled*
Defines whether the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Boolean
Defines whether the row/column footer is enabled.
| Boolean | Description |
| --- | --- |
| True | The row/column footer is enabled. |
| False | The row/column footer is disabled. |
### Comments
The Enabled property defines whether the row/column footer is enabled.
A disabled row/column footer is drawn using the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_GrayedColor) property value as text color and the row/column footer graphic (see RowColumnFooter.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Image) property) is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled row/column footer button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## Enabled Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled*
Defines whether the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Boolean
Defines whether the row/column header is enabled.
| Boolean | Description |
| --- | --- |
| True | The row/column header is enabled. |
| False | The row/column header is disabled. |
### Comments
The Enabled property defines whether the row/column header is enabled.
A disabled row/column header is drawn using the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor) property value as text color and the row/column header graphic (see RowColumnHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) property) is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled row/column header button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## Enabled Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled*
Defines whether [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) are enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Enabled** **As Boolean** |
| VB | *Boolean* = *object*.**Enabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Enabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Enabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Enabled**(); |
| C | **HRESULT** *object*->get_**Enabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Boolean
Defines whether row headers are enabled.
| Boolean | Description |
| --- | --- |
| True | Row headers are enabled. |
| False | Row headers are disabled. |
### Comments
The Enabled property defines whether row headers are enabled.
Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The Enabled property applies to all row headers and cannot be changed for individual items.
Disabled row headers are drawn using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor) property value as text color and row header graphics (see [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property) are drawn in a "grayed" fashion, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Enabled Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Enabled*
Defines the item's enabled/disabled status.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Enabled) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**Enabled** = *Boolean* **As Boolean** |
| VB | *object*.**Enabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Enabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Enabled** = *Boolean*;
**void** *object*->Put**Enabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Enabled**(**VARIANT_BOOL** *Boolean*); |
object
A VirtualItem object.
Boolean
Defines the item's enabled/disabled status.
| Boolean | Description |
| --- | --- |
| True | The item is enabled. |
| False | The item is disabled. It is drawn in a "grayed" manner indicating its status. Except for the visual difference, a disabled item is treated exactly like an enabled item. It is up to the application to implement a different behavior if an item is disabled. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Enabled instead
The Enabled property defines the item's enabled/disabled status.
The VirtualItem.Enabled property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's enabled/disabled status. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## EndEdit Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit*
Ends [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
### Syntax
| | |
| --- | --- |
| VB.NET | *InputValid* = *object*.**EndEdit**(**ByVal** *Validate* **As Boolean**) **As Boolean** |
| VB | *InputValid* = *object*.**EndEdit**(**ByVal** *Validate* **As Boolean**) **As Boolean** |
| C#.NET | **bool** *InputValid* = *object*.**EndEdit**(**bool** *Validate*); |
| VC++ | **VARIANT_BOOL** *InputValid* = *object*->**EndEdit**(**VARIANT_BOOL** *Validate*); |
| C | **HRESULT** *object*->raw_**EndEdit**(**VARIANT_BOOL** *Validate*, **VARIANT_BOOL*** *InputValid*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Validate
Set to True to validate input data, False to skip input validation.
InputValid
Returns True if cell editing has ended, False if it hasn't due to input validation (the application rejected the input data by setting the *Cancel* variable of the [EditValidate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditValidate) (or [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit)) event to True. If * Validate* is False, [EndEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_EndEdit) will always return True.
### Comments
The EndEdit method ends cell editing.
If * Validate* is True, the EditValidate (and AfterEdit) event is generated to allow the application to process the input data. If * Validate* is False, the current data being edited is abandoned and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text remains unchanged.
The EndEdit method doesn't need to be called under normal circumstances. If the user clicks the mouse button outside the cell being edited, the tree control automatically generates an EditValidate (and AfterEdit) event. The EndEdit method can be used to end cell editing due to an external event, such as a timer event or other application specific events.
Cell editing can be started using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
See Also SftTree Object | Object Hierarchy
## Expand Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Expand*
Expands an item so its dependents become visible.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Expand**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| VB | *object*.**Expand**(**ByVal** *ItemIndex* **As Long**, **ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| C#.NET | **void** *object*.**Expand**(**int** *ItemIndex*, **bool** *Preserve*, **bool** *Depth*); |
| VC++ | **HRESULT** *object*->**Expand**(**long** *ItemIndex*, **VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
| C | **HRESULT** *object*->raw_**Expand**(**long** *ItemIndex*, **VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to expand. If -1 is specified, all items on level 0 are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
Preserve
Defines whether the expand/collapse state is restored. This argument is ignored if the *Depth* argument is True.
| Preserve | Description |
| --- | --- |
| True | Restores the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items made visible, as saved by a previous call to Items.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) or Item.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse). |
| False | The expand/collapse state is not restored. Only the item defined by *ItemIndex* is expanded and immediate dependents are made visible. They may be expanded or collapsed based on the *Depth* argument. |
Depth
Defines the depth of the items to become visible.
| Depth | Description |
| --- | --- |
| True | Expands all dependent items, including non-immediate dependent items. *Preserve* is ignored as all dependents are expanded. |
| False | Expands dependent items, based on the *Preserve* settings. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Expand and Item.Expand instead
The Expand method expands an item so its dependents become visible.
The Expand method expands all dependent items of item *ItemIndex* and restores the expand/collapse state of all dependent items, as saved by a previous Items.Collapse or Item.Collapse method call.
If an item is already expanded when using Expand, the item remains unchanged. It does not make any indirect dependents visible. To make sure that an item's indirect dependents are shown, use the Item.Collapse method first, which collapses the item (and all dependents), followed by Expand. Now all dependents are visible.
See Also SftTree Object | Object Hierarchy
## Expand Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand*
Expands the item so its dependents become visible.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Expand**(**ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| VB | *object*.**Expand**(**ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| C#.NET | **void** *object*.**Expand**(**bool** *Preserve*, **bool** *Depth*); |
| VC++ | **HRESULT** *object*->**Expand**(**VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
| C | **HRESULT** *object*->raw_**Expand**(**VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Preserve
Defines whether the expand/collapse state is restored. This argument is ignored if the *Depth* argument is True.
| Preserve | Description |
| --- | --- |
| True | Restores the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items made visible, as saved by a previous call to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse). |
| False | The expand/collapse state is not restored. Only the item itself is [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) and immediate dependents are made visible. They may be expanded or collapsed based on the *Depth* argument. |
Depth
Defines the depth of the items to become visible.
| Depth | Description |
| --- | --- |
| True | Expands all dependent items, including non-immediate dependent items. *Preserve* is ignored as all dependents are expanded. |
| False | Expands dependent items, based on the *Preserve* settings. |
### Comments
The Expand method expands the item so its dependents become visible.
The Expand method expands all dependent items of the item and restores the expand/collapse state of all dependent items, as saved by a previous Items.Collapse or Item.Collapse method call.
If the item is already expanded when using Expand, the item remains unchanged. It does not make any indirect dependents visible. To make sure that an item's indirect dependents are shown, use the Item.Collapse method first, which collapses the item (and all dependents), followed by Expand. Now all dependents are visible.
See Also SftTreeItem Object | Object Hierarchy
## Expand Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand*
Expands all items so their dependents become visible.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Expand**(**ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| VB | *object*.**Expand**(**ByVal** *Preserve* **As Boolean**, **ByVal** *Depth* **As Boolean**) |
| C#.NET | **void** *object*.**Expand**(**bool** *Preserve*, **bool** *Depth*); |
| VC++ | **HRESULT** *object*->**Expand**(**VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
| C | **HRESULT** *object*->raw_**Expand**(**VARIANT_BOOL** *Preserve*, **VARIANT_BOOL** *Depth*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Preserve
Defines whether the expand/collapse state is restored. This argument is ignored if the *Depth* argument is True.
| Preserve | Description |
| --- | --- |
| True | Restores the expand/collapse state of [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items made visible, as saved by a previous call to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse). |
| False | The expand/collapse state is not restored. All items are [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) and immediate dependents are made visible. They may be expanded or collapsed based on the *Depth* argument. |
Depth
Defines the depth of the items to become visible.
| Depth | Description |
| --- | --- |
| True | Expands all dependent items, including non-immediate dependent items. *Preserve* is ignored as all dependents are expanded. |
| False | Expands dependent items, based on the *Preserve* settings. |
### Comments
The Expand method expands all items so their dependents become visible.
The Expand method expands all items and restores the expand/collapse state of all dependent items, as saved by a previous Items.Collapse or Item.Collapse method call. The Expand method visits each item on level 0 and expands these based on the *Preserve* and *Depth* arguments.
If items are already expanded when using Expand, the items remains unchanged. It does not make any indirect dependents visible. To make sure that an item's indirect dependents are shown, use the Items.Collapse method first, which collapses all items (and all dependents), followed by Expand. Now all dependents are visible.
See Also SftTreeItems Object | Object Hierarchy
## Expandable Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expandable*
Defines whether the item is [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Expandable** **As Boolean** |
| VB | *Boolean* = *object*.**Expandable** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Expandable**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Expandable**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Expandable**(); |
| C | **HRESULT** *object*->get_**Expandable**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Expandable** = *Boolean* **As Boolean** |
| VB | *object*.**Expandable** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Expandable** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Expandable** = *Boolean*;
**void** *object*->Put**Expandable**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Expandable**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is expandable.
| Boolean | Description |
| --- | --- |
| True | The item is expandable. |
| False | The item is not expandable. |
### Comments
The Expandable property defines whether the item is expandable.
Normally, only a parent item (with dependents) is expandable. An expandable item displays an [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) and other attributes, such as the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable) graphic.
A leaf item can be made a "temporary" parent item by setting the item's Expandable property to True. The item now displays an expand/collapse button and other attributes, such as the Items.ItemImageExpandable graphic. The item can now also generate an [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event to expand the item. The application can then add child items as the user expands this "temporary" parent item, making it into a real parent item.
When setting the Expandable property, an item's dependents are always removed, unless the item is already expanded.
If an item's Expandable property is set to False, the item is collapsed (and its dependents are removed).
If an item is already expanded or has dependents when setting Expandable to True, the item remains unchanged. It is not expanded.
See Also SftTreeItem Object | Object Hierarchy
## Expanded Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expanded*
Defines whether the item is [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or collapsed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Expanded** **As Boolean** |
| VB | *Boolean* = *object*.**Expanded** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Expanded**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Expanded**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Expanded**(); |
| C | **HRESULT** *object*->get_**Expanded**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Expanded** = *Boolean* **As Boolean** |
| VB | *object*.**Expanded** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Expanded** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Expanded** = *Boolean*;
**void** *object*->Put**Expanded**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Expanded**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is expanded or collapsed.
| Boolean | Description |
| --- | --- |
| True | The item is expanded. |
| False | The item is collapsed. |
### Comments
The Expanded property defines whether the item is expanded or collapsed.
When setting Expanded to True, only an item's immediate dependents are made visible. [Dependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) of items that are made visible are not automatically made visible. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) method can be used to expand all immediate and indirect dependents.
If an item is already expanded when setting Expanded to True, the item remains unchanged. It does not hide any indirect dependents. To make sure that an item's indirect dependents are not shown, Expanded can be set to False first, which collapses the item (and all dependents), followed by setting Expanded to True. Now only immediate dependents are visible.
An item has to be currently shown to be expanded or collapsed. If the item is not shown, its state cannot be modified. The Item.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown) property can be used to determine if an item is shown.
The Item.[DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) property can be used to determine if an item can be expanded. If an item doesn't have any dependents, it is a leaf item and cannot be expanded. However, it is not an error to use Expanded with a leaf item.
The Expanded property does not preserve or restore the expand/collapse state of its dependent items. Use Items.Expand, Item.Expand, Items.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) and Item.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse) to preserve or restore this information.
If a parent item is collapsed, subsequently adding child items will automatically expand the item.
See Also SftTreeItem Object | Object Hierarchy
## Files Property, DataObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files*
Returns a collection of filenames used by the [sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Files* = *object*.**Files** **As [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles)** |
| VB | **Set** *Files* = *object*.**Files** **As DataObjectFiles** |
| C#.NET | **DataObjectFiles** *Files* = *object*.**Files**; |
| VC++ | **IVDMDataObjectFiles*** *Files* = *object*->**Files**;
**IVDMDataObjectFiles*** *Files* = *object*->Get**Files**(); |
| C | **HRESULT** *object*->get_**Files**(**struct IVDMDataObjectFiles**** *Files*); |
object
A [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object.
Files
A collection of filenames used by the sftCFFiles format.
### Comments
The Files property returns a collection of filenames used by the sftCFFiles format.
The Files collection is filled with file names only when the DataObject object contains data of type sftCFFiles. The DataObject object can contain several different types of data. You can iterate through the Files collection using the DataObjectFiles.[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Item) property to retrieve the list of file names.
The Files collection can be filled to allow an application to act as a drag source for a list of files (similar to Windows Explorer).
See Also DataObject Object | Object Hierarchy
## FindCell Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCell*
Searches items for a string.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**FindCell**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *EndIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level)* **As Short**, **ByVal** *SearchString* **As String**, **ByVal** *Wrap* **As Boolean**, **ByVal** *IgnoreCase* **As Boolean**, **ByVal** *ExactMatch* **As Boolean**, **ByVal** *SearchEnabledOnly* **As Boolean**, **ByVal** *SearchVisibleOnly* **As Boolean**, **ByRef** *FoundIndex* **As Integer**, **ByRef** *FoundColumn* **As Short**) |
| VB | *object*.**FindCell**(**ByVal** *ItemIndex* **As Long**, **ByVal** *EndIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *Level* **As Integer**, **ByVal** *SearchString* **As String**, **ByVal** *Wrap* **As Boolean**, **ByVal** *IgnoreCase* **As Boolean**, **ByVal** *ExactMatch* **As Boolean**, **ByVal** *SearchEnabledOnly* **As Boolean**, **ByVal** *SearchVisibleOnly* **As Boolean**, *FoundIndex* **As Long**, *FoundColumn* **As Integer**) |
| C#.NET | **void** *object*.**FindCell**(**int** *ItemIndex*, **int** *EndIndex*, **short** *ColIndex*, **short** *Level*, **string** *SearchString*, **bool** *Wrap*, **bool** *IgnoreCase*, **bool** *ExactMatch*, **bool** *SearchEnabledOnly*, **bool** *SearchVisibleOnly*, **out** **int** *FoundIndex*, **out** **short** *FoundColumn*); |
| VC++ | **HRESULT** *object*->**FindCell**(**long** *ItemIndex*, **long** *EndIndex*, **short** *ColIndex*, **short** *Level*, **_bstr_t** *SearchString*, **VARIANT_BOOL** *Wrap*, **VARIANT_BOOL** *IgnoreCase*, **VARIANT_BOOL** *ExactMatch*, **VARIANT_BOOL** *SearchEnabledOnly*, **VARIANT_BOOL** *SearchVisibleOnly*, **long*** *FoundIndex*, **short*** *FoundColumn*); |
| C | **HRESULT** *object*->raw_**FindCell**(**long** *ItemIndex*, **long** *EndIndex*, **short** *ColIndex*, **short** *Level*, **BSTR** *SearchString*, **VARIANT_BOOL** *Wrap*, **VARIANT_BOOL** *IgnoreCase*, **VARIANT_BOOL** *ExactMatch*, **VARIANT_BOOL** *SearchEnabledOnly*, **VARIANT_BOOL** *SearchVisibleOnly*, **long*** *FoundIndex*, **short*** *FoundColumn*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item after which the search begins (non-inclusive). If -1 is specified, search starts at the first item (index 0).
EndIndex
The zero-based item index where the search ends (inclusive). If -1 is specified, items up to the last item in the list are searched.
ColIndex
The zero-based column number. The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property for [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column are searched. If -1 is specified, all columns are searched.
Level
The item level to search. Only items on this level (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).Level property) are searched. If -1 is specified, all levels are searched.
SearchString
The text to be searched.
Wrap
If set to True, the search starts at *ItemIndex* and wraps around (if necessary) and ends at *EndIndex*, otherwise the search does not wrap around and ends at *EndIndex*.
IgnoreCase
If set to True, the string comparison between the Cell.Text property and *SearchString* is not case sensitive. If False, comparison is case sensitive.
ExactMatch
If set to True, the Cell.Text property must be exactly the same as *SearchString*, otherwise the Cell.Text property must start with the string *SearchString*.
SearchEnabledOnly
If set to True, only enabled items (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled)) are searched, otherwise items are searched regardless of their enabled/disabled status.
SearchVisibleOnly
If set to True, only visible child items ([expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) branches, see Item.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown)) are searched, otherwise items are searched regardless of their visibility status.
FoundIndex
Returns the zero-based index of the cell whose string Cell.Text property and *SearchString* match. -1 is returned if no cell was found.
FoundColumn
Returns the zero-based column number of the cell whose string Cell.Text property and *SearchString* match. -1 is returned if no cell was found.
### Comments
The FindCell method searches items for a string.
See Also SftTreeItems Object | Object Hierarchy
## FindCellText Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellText*
Searches items for a string.
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindCellText**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SearchString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindCellText**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SearchString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindCellText**(**int** *ItemIndex*, **short** *ColIndex*, **string** *SearchString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindCellText**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *SearchString*); |
| C | **HRESULT** *object*->raw_**FindCellText**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *SearchString*, **long*** *FoundIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item where the search begins (including *ItemIndex*).
ColIndex
The zero-based column number to be searched.
SearchString
The text to be searched.
FoundIndex
Returns the zero-based index of the item, where the specified *SearchString* is found. -1 is returned if no item is found matching the specified *SearchString*.
### Comments
The FindCellText method searches items for a string.
The string described by *SearchString* is compared to the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property of all items and columns involved in the search. The search starts at the item described by *ItemIndex* and is restricted to the column specified by *ColIndex*. If an item with a matching Cell.Text property is found, its zero-based index is returned, otherwise -1 is returned.
Only one column can be searched at a time. [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCell) can be used to search multiple columns and with additional features not available to FindCellText.
The comparison of *SearchString* and the Cell.Text property is not case sensitive. If the Cell.Text property starts with the string in *SearchString*, it is considered a match. To find an exact match for *SearchString* use the Items.[FindCellTextExact](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellTextExact) method.
| SearchString | Cell.Text Property | Match | Comment |
| --- | --- | --- | --- |
| ABC | abc | Yes | Same string, case is ignored |
| abc | abc123 | Yes | Property starts with *SearchString* |
| abc | Thisabc | No | Property doesn't start with *SearchString* |
| abc | ab | No | Property doesn't contain the complete *SearchString* |
See Also SftTreeItems Object | Object Hierarchy
## FindCellTextExact Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellTextExact*
Searches items for a string using an exact match.
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindCellTextExact**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SearchString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindCellTextExact**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SearchString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindCellTextExact**(**int** *ItemIndex*, **short** *ColIndex*, **string** *SearchString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindCellTextExact**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *SearchString*); |
| C | **HRESULT** *object*->raw_**FindCellTextExact**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *SearchString*, **long*** *FoundIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item where the search begins (including *ItemIndex*).
ColIndex
The zero-based column number to be searched.
SearchString
The text to be searched.
FoundIndex
Returns the zero-based index of the item, where the specified *SearchString* is found. -1 is returned if no item is found matching the specified *SearchString*.
### Comments
The FindCellTextExact method searches items for a string using an exact match.
The string described by *SearchString* is compared to the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property of all items and columns involved in the search. The search starts at the item described by *ItemIndex* and is restricted to the column specified by *ColIndex*. If an item with a matching Cell.Text property is found, its zero-based index is returned, otherwise -1 is returned.
Only one column can be searched at a time. [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCell) can be used to search multiple columns and with additional features not available to FindCellTextExact.
The comparison of *SearchString* and the Cell.Text property is not case sensitive. The Cell.Text property and the *SearchString* must match in their entirety, partial strings do not match. To find a partial match for *SearchString* use the Items.[FindCellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellText) method.
| SearchString | Cell.Text Property | Match | Comment |
| --- | --- | --- | --- |
| ABC | abc | Yes | Same string, case is ignored |
| abc | abc123 | No | Not the same string |
| abc | Thisabc | No | Not the same string |
| abc | ab | No | Not the same string |
See Also SftTreeItems Object | Object Hierarchy
## FindData Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindData*
Searches the Data property of items.
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindData**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ItemData* **As Integer**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindData**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ItemData* **As Long**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindData**(**int** *ItemIndex*, **int** *ItemData*); |
| VC++ | **long** *FoundIndex* = *object*->**FindData**(**long** *ItemIndex*, **long** *ItemData*); |
| C | **HRESULT** *object*->raw_**FindData**(**long** *ItemIndex*, **long** *ItemData*, **long*** *FoundIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item where the search begins (including * ItemIndex*).
ItemData
The value to be searched.
FoundIndex
Returns the index of the item whose [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property has the value specified by *ItemData*. -1 is returned if no matching item is found.
### Comments
The FindData method searches the Item.Data property of items.
The value described by *ItemData* is compared to the Item.Data property of all items involved in the search. The search starts at the item described by *ItemIndex*. If an item with a matching Item.Data property is found, its zero-based index is returned, otherwise -1 is returned.
See Also SftTreeItems Object | Object Hierarchy
## FindDataString Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindDataString*
Searches the DataString property of items.
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindDataString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ItemDataString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindDataString**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ItemDataString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindDataString**(**int** *ItemIndex*, **string** *ItemDataString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindDataString**(**long** *ItemIndex*, **_bstr_t** *ItemDataString*); |
| C | **HRESULT** *object*->raw_**FindDataString**(**long** *ItemIndex*, **BSTR** *ItemDataString*, **long*** *FoundIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item where the search begins (including * ItemIndex*).
ItemDataString
The value to be searched.
FoundIndex
Returns the index of the item whose [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property has the value specified by *ItemDataString*. -1 is returned if no matching item is found.
### Comments
The FindDataString method searches the Item.DataString property of items.
The value described by *ItemDataString* is compared to the Item.DataString property of all items involved in the search. The search starts at the item described by *ItemI**ndex*. If an item with a matching Item.DataString property is found, its zero-based index is returned, otherwise -1 is returned.
See Also SftTreeItems Object | Object Hierarchy
## FindItemData Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindItemData*
Searches the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property of items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindData) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindItemData**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ItemData* **As Integer**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindItemData**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ItemData* **As Long**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindItemData**(**int** *ItemIndex*, **int** *ItemData*); |
| VC++ | **long** *FoundIndex* = *object*->**FindItemData**(**long** *ItemIndex*, **long** *ItemData*); |
| C | **HRESULT** *object*->raw_**FindItemData**(**long** *ItemIndex*, **long** *ItemData*, **long*** *FoundIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item where the search begins (including * ItemIndex*).
ItemData
The value to be searched.
FoundIndex
Returns the index of the item whose Item.Data property has the value specified by *ItemData*. -1 is returned if no matching item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FindData instead
The FindItemData method searches the Item.Data property of items.
The value described by *ItemData* is compared to the Item.Data property of all items involved in the search. The search starts at the item described by *ItemIndex*. If an item with a matching Item.Data property is found, its zero-based index is returned, otherwise -1 is returned.
See Also SftTree Object | Object Hierarchy
## FindItemDataString Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindItemDataString*
Searches the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property of items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindDataString) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindItemDataString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ItemDataString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindItemDataString**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ItemDataString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindItemDataString**(**int** *ItemIndex*, **string** *ItemDataString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindItemDataString**(**long** *ItemIndex*, **_bstr_t** *ItemDataString*); |
| C | **HRESULT** *object*->raw_**FindItemDataString**(**long** *ItemIndex*, **BSTR** *ItemDataString*, **long*** *FoundIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item where the search begins (including * ItemIndex*).
ItemDataString
The value to be searched.
FoundIndex
Returns the index of the item whose Item.DataString property has the value specified by *ItemData*. -1 is returned if no matching item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FindDataString instead
The [FindItemData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindItemData) method searches the Item.DataString property of items.
The value described by *ItemDataString* is compared to the Item.DataString property of all items involved in the search. The search starts at the item described by *ItemI**ndex*. If an item with a matching Item.DataString property is found, its zero-based index is returned, otherwise -1 is returned.
See Also SftTree Object | Object Hierarchy
## FindString Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindString*
Searches items for a string.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindCellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellText) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SearchString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindString**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SearchString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindString**(**int** *ItemIndex*, **short** *ColIndex*, **string** *SearchString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindString**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *SearchString*); |
| C | **HRESULT** *object*->raw_**FindString**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *SearchString*, **long*** *FoundIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item where the search begins (including *ItemIndex*).
ColIndex
The zero-based column number to be searched.
SearchString
The text to be searched.
FoundIndex
Returns the zero-based index of the item, where the specified *SearchString* is found. -1 is returned if no item is found matching the specified *SearchString*.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FindCellText instead
The FindString method searches items for a string.
The string described by *SearchString* is compared to the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property of all items and columns involved in the search. The search starts at the item described by *ItemIndex* and is restricted to the column specified by *ColIndex*. If an item with a matching Cell.Text property is found, its zero-based index is returned, otherwise -1 is returned.
Only one column can be searched at a time.
The comparison of *SearchString* and the Cell.Text property is not case sensitive. If the Cell.Text property starts with the string in *SearchString*, it is considered a match. To find an exact match for *SearchString* use the Items.[FindCellTextExact](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellTextExact) method.
| SearchString | Cell.Text Property | Match | Comment |
| --- | --- | --- | --- |
| ABC | abc | Yes | Same string, case is ignored |
| abc | abc123 | Yes | Property starts with * SearchString* |
| abc | Thisabc | No | Property doesn't start with * SearchString* |
| abc | ab | No | Property doesn't contain the complete * SearchString* |
See Also SftTree Object | Object Hierarchy
## FindStringExact Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FindStringExact*
Searches items for a string using an exact match.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FindCellTextExact](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellTextExact) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *FoundIndex* = *object*.**FindStringExact**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SearchString* **As String**) **As Integer** |
| VB | *FoundIndex* = *object*.**FindStringExact**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SearchString* **As String**) **As Long** |
| C#.NET | **int** *FoundIndex* = *object*.**FindStringExact**(**int** *ItemIndex*, **short** *ColIndex*, **string** *SearchString*); |
| VC++ | **long** *FoundIndex* = *object*->**FindStringExact**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *SearchString*); |
| C | **HRESULT** *object*->raw_**FindStringExact**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *SearchString*, **long*** *FoundIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item where the search begins (including *ItemIndex*).
ColIndex
The zero-based column number to be searched.
SearchString
The text to be searched.
FoundIndex
Returns the zero-based index of the item, where the specified *SearchString* is found. -1 is returned if no item is found matching the specified *SearchString*.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FindCellTextExact instead
The FindStringExact method searches items for a string using an exact match.
The string described by *SearchString* is compared to the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property of all items and columns involved in the search. The search starts at the item described by *ItemIndex* and is restricted to the column specified by *ColIndex*. If an item with a matching Cell.Text property is found, its zero-based index is returned, otherwise -1 is returned.
Only one column can be searched at a time.
The comparison of *SearchString* and the Cell.Text property is not case sensitive. The Cell.Text property and the *SearchString* must match in their entirety, partial strings do not match. To find a partial match for *SearchString* use the Items.[FindCellText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FindCellText) method.
| SearchString | Cell.Text Property | Match | Comment |
| --- | --- | --- | --- |
| ABC | abc | Yes | Same string, case is ignored |
| abc | abc123 | No | Not the same string |
| abc | Thisabc | No | Not the same string |
| abc | ab | No | Not the same string |
See Also SftTree Object | Object Hierarchy
## FirstDependent Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDependent*
Returns the index of an item's first [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents).
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[FirstDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstDependent) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DependentIndex* = *object*.get_**FirstDependent**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *DependentIndex* = *object*.**FirstDependent**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *DependentIndex* = *object*.get_**FirstDependent**(**int** *ItemIndex*); |
| VC++ | **long** *DependentIndex* = *object*->**FirstDependent**[**long** *ItemIndex*];
**long** *DependentIndex* = *object*->Get**FirstDependent**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**FirstDependent**(**long** *ItemIndex*, **long*** *DependentIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose first dependent item is to be returned.
DependentIndex
Returns the index of the item's first dependent. If the item doesn't have a dependent, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.FirstDependent instead
The FirstDependent property returns the index of an item's first dependent.
The Item.[LastDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastDependent) property can be used to retrieve an item's last dependent.
See Also SftTree Object | Object Hierarchy
## FirstDependent Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstDependent*
Returns the item's first [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**FirstDependent** **As Integer** |
| VB | *ItemIndex* = *object*.**FirstDependent** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**FirstDependent**; |
| VC++ | **long** *ItemIndex* = *object*->**FirstDependent**;
**long** *ItemIndex* = *object*->Get**FirstDependent**(); |
| C | **HRESULT** *object*->get_**FirstDependent**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's first dependent. If the item doesn't have a dependent, -1 is returned.
### Comments
The FirstDependent property returns the item's first dependent.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LastDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastDependent) property can be used to retrieve an item's last dependent.
See Also SftTreeItem Object | Object Hierarchy
## FirstDisplayColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDisplayColumn*
Returns the index of the first displayed column.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**FirstDisplayColumn** **As Short** |
| VB | *DispColIndex* = *object*.**FirstDisplayColumn** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**FirstDisplayColumn**; |
| VC++ | **short** *DispColIndex* = *object*->**FirstDisplayColumn**;
**short** *DispColIndex* = *object*->Get**FirstDisplayColumn**(); |
| C | **HRESULT** *object*->get_**FirstDisplayColumn**(**short*** *DispColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DispColIndex
Returns the index of the first displayed column.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.FirstDisplayColumn instead
The FirstDisplayColumn property returns the index of the first displayed column.
The first column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the first displayed column. It is not necessarily visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The last displayed column can be determined using the ColumnsObj.[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the FirstDisplayColumn property returns the display column number of the first displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) property returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control.
See Also SftTree Object | Object Hierarchy
## FirstDisplayColumn Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn*
Returns the index of the first displayed column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**FirstDisplayColumn** **As Short** |
| VB | *DispColIndex* = *object*.**FirstDisplayColumn** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**FirstDisplayColumn**; |
| VC++ | **short** *DispColIndex* = *object*->**FirstDisplayColumn**;
**short** *DispColIndex* = *object*->Get**FirstDisplayColumn**(); |
| C | **HRESULT** *object*->get_**FirstDisplayColumn**(**short*** *DispColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
DispColIndex
Returns the index of the first displayed column.
### Comments
The FirstDisplayColumn property returns the index of the first displayed column.
The first column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the first displayed column. It is not necessarily visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The last displayed column can be determined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the FirstDisplayColumn property returns the display column number of the first displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) property returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control.
See Also SftTreeColumns Object | Object Hierarchy
## FirstDisplayColumn2 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstDisplayColumn2*
Returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**FirstDisplayColumn2** **As Short** |
| VB | *DispColIndex* = *object*.**FirstDisplayColumn2** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**FirstDisplayColumn2**; |
| VC++ | **short** *DispColIndex* = *object*->**FirstDisplayColumn2**;
**short** *DispColIndex* = *object*->Get**FirstDisplayColumn2**(); |
| C | **HRESULT** *object*->get_**FirstDisplayColumn2**(**short*** *DispColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DispColIndex
Returns the index of the first displayed column in the right pane.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.FirstDisplayColumn2 instead
The FirstDisplayColumn2 property returns the index of the first displayed column in the right pane.
FirstDisplayColumn2 is only available for a split tree control.
The first column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the first displayed column. It is not necessarily visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The last displayed column in the right pane can be determined using the ColumnsObj.[LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the FirstDisplayColumn2 property returns the display column number of the first displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property returns the index of the first displayed column in a regular tree control or the left pane of a split tree control.
See Also SftTree Object | Object Hierarchy
## FirstDisplayColumn2 Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2*
Returns the index of the first displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**FirstDisplayColumn2** **As Short** |
| VB | *DispColIndex* = *object*.**FirstDisplayColumn2** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**FirstDisplayColumn2**; |
| VC++ | **short** *DispColIndex* = *object*->**FirstDisplayColumn2**;
**short** *DispColIndex* = *object*->Get**FirstDisplayColumn2**(); |
| C | **HRESULT** *object*->get_**FirstDisplayColumn2**(**short*** *DispColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
DispColIndex
Returns the index of the first displayed column in the right pane.
### Comments
The FirstDisplayColumn2 property returns the index of the first displayed column in the right pane.
FirstDisplayColumn2 is only available for a split tree control.
The first column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the first displayed column. It is not necessarily visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The last displayed column in the right pane can be determined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the FirstDisplayColumn2 property returns the display column number of the first displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property returns the index of the first displayed column in a regular tree control or the left pane of a split tree control.
See Also SftTreeColumns Object | Object Hierarchy
## FirstShown Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown*
Returns the index of the first [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus) in the tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**FirstShown** **As Integer** |
| VB | *ItemIndex* = *object*.**FirstShown** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**FirstShown**; |
| VC++ | **long** *ItemIndex* = *object*->**FirstShown**;
**long** *ItemIndex* = *object*->Get**FirstShown**(); |
| C | **HRESULT** *object*->get_**FirstShown**(**long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
Returns the index of the first visible item in the tree control. -1 is returned, if no item is found.
### Comments
The FirstShown property returns the index of the first visible item in the tree control.
Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown), Item.[PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown), [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) to retrieve information about item visibility.
See Also SftTreeItems Object | Object Hierarchy
## FirstSibling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FirstSibling*
Returns the index of an item's first sibling item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *SiblingIndex* = *object*.get_**FirstSibling**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *SiblingIndex* = *object*.**FirstSibling**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *SiblingIndex* = *object*.get_**FirstSibling**(**int** *ItemIndex*); |
| VC++ | **long** *SiblingIndex* = *object*->**FirstSibling**[**long** *ItemIndex*];
**long** *SiblingIndex* = *object*->Get**FirstSibling**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**FirstSibling**(**long** *ItemIndex*, **long*** *SiblingIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose first sibling item is to be returned.
SiblingIndex
Returns the index of an item's first sibling item. If the item doesn't have a sibling item, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.FirstSibling instead
The FirstSibling property returns the index of an item's first sibling item.
The first sibling of item *ItemIndex* is found by scanning towards the beginning of the tree control and locating an item on the same level (Item.[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as item *ItemIndex* without encountering a parent item.
The Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) property can be used to retrieve an item's last sibling. The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) and Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) properties can be used to retrieve an item's next or previous sibling.
See Also SftTree Object | Object Hierarchy
## FirstSibling Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling*
Returns the item's first sibling.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**FirstSibling** **As Integer** |
| VB | *ItemIndex* = *object*.**FirstSibling** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**FirstSibling**; |
| VC++ | **long** *ItemIndex* = *object*->**FirstSibling**;
**long** *ItemIndex* = *object*->Get**FirstSibling**(); |
| C | **HRESULT** *object*->get_**FirstSibling**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's first sibling. If the item doesn't have a sibling item, -1 is returned.
### Comments
The FirstSibling property returns the item's first sibling.
The first sibling of the item is found by scanning towards the beginning of the tree control and locating an item on the same level ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as the item without encountering a parent item.
The Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) property can be used to retrieve an item's last sibling. The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) and Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) properties can be used to retrieve an item's next or previous sibling.
See Also SftTreeItem Object | Object Hierarchy
## FlybyHighlight Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FlybyHighlight*
The item highlighted by [flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) has changed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**FlybyHighlight**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**FlybyHighlight** |
| VB | **Private Sub** *object*_**FlybyHighlight**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**FlybyHighlight**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**FlybyHighlight***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**FlybyHighlight***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index number of the item highlighted by flyby highlighting. If -1 is specified, there is no highlighted item.
### Comments
The FlybyHighlight event occurs when the item highlighted by flyby highlighting has changed. This could be used to update status information elsewhere on a form.
Tree control properties should not be updated while handling this event.
See Also SftTree Object | Object Hierarchy
## FlybyHighlight Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_FlybyHighlight*
Defines whether items are underlined as the mouse cursor moves over an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FlybyHighlightStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FlybyHighlightStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**FlybyHighlight** **As Boolean** |
| VB | *Boolean* = *object*.**FlybyHighlight** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**FlybyHighlight**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**FlybyHighlight**;
**VARIANT_BOOL** *Boolean* = *object*->Get**FlybyHighlight**(); |
| C | **HRESULT** *object*->get_**FlybyHighlight**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**FlybyHighlight** = *Boolean* **As Boolean** |
| VB | *object*.**FlybyHighlight** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**FlybyHighlight** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**FlybyHighlight** = *Boolean*;
**void** *object*->Put**FlybyHighlight**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**FlybyHighlight**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether items are underlined as the mouse cursor moves over an item.
| Boolean | Description |
| --- | --- |
| True | Items are underlined as the mouse cursor moves over an item. |
| False | Items are not underlined as the mouse cursor moves over an item. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FlybyHighlightStyle instead
The FlybyHighlight property defines whether items are underlined as the mouse cursor moves over an item.
[Flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) can be useful when multiple columns without grid lines are shown. The user receives immediate feedback when the mouse cursor moves over an item.
See Also SftTree Object | Object Hierarchy
## FlybyHighlight Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FlybyHighlight*
Defines whether items are underlined as the mouse cursor moves over an item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**FlybyHighlight** **As Boolean** |
| VB | *Boolean* = *object*.**FlybyHighlight** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**FlybyHighlight**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**FlybyHighlight**;
**VARIANT_BOOL** *Boolean* = *object*->Get**FlybyHighlight**(); |
| C | **HRESULT** *object*->get_**FlybyHighlight**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**FlybyHighlight** = *Boolean* **As Boolean** |
| VB | *object*.**FlybyHighlight** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**FlybyHighlight** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**FlybyHighlight** = *Boolean*;
**void** *object*->Put**FlybyHighlight**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**FlybyHighlight**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether items are underlined as the mouse cursor moves over an item.
| Boolean | Description |
| --- | --- |
| True | [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are underlined as the mouse cursor moves over an item. |
| False | Items are not underlined as the mouse cursor moves over an item. |
### Comments
The FlybyHighlight property defines whether items are underlined or highlighted as the mouse cursor moves over an item.
[Flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) is also affected by the selected outline style using the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property
Flyby highlighting can be useful when multiple columns without grid lines are shown. The user receives immediate feedback when the mouse cursor moves over an item.
See Also SftTreeItems Object | Object Hierarchy
## FlybyHighlightStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FlybyHighlightStyle*
Defines whether items are underlined as the mouse cursor moves over an item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**FlybyHighlightStyle** **As [SftTreeFlybyHighlightStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeFlybyHighlightStyleConstants)** |
| VB | *Style* = *object*.**FlybyHighlightStyle** **As SftTreeFlybyHighlightStyleConstants** |
| C#.NET | **SftTreeFlybyHighlightStyleConstants** *Style* = *object*.**FlybyHighlightStyle**; |
| VC++ | **enum SftTreeFlybyHighlightStyleConstants** *Style* = *object*->**FlybyHighlightStyle**;
**enum SftTreeFlybyHighlightStyleConstants** *Style* = *object*->Get**FlybyHighlightStyle**(); |
| C | **HRESULT** *object*->get_**FlybyHighlightStyle**(**enum SftTreeFlybyHighlightStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**FlybyHighlightStyle** = *Style* **As SftTreeFlybyHighlightStyleConstants** |
| VB | *object*.**FlybyHighlightStyle** = *Style* **As SftTreeFlybyHighlightStyleConstants** |
| C#.NET | **SftTreeFlybyHighlightStyleConstants** *object*.**FlybyHighlightStyle** = *Style*; |
| VC++ | **enum SftTreeFlybyHighlightStyleConstants** *object*->**FlybyHighlightStyle** = *Style*;
**void** *object*->Put**FlybyHighlightStyle**(**enum SftTreeFlybyHighlightStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**FlybyHighlightStyle**(**enum SftTreeFlybyHighlightStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines whether items are underlined as the mouse cursor moves over an item.
| Style | Value | Description |
| --- | --- | --- |
| flybySftTreeNone | 0 | None |
| flybySftTreeCol1 | 1 | The [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text of cells in the first displayed column are underlined as the mouse cursor moves over an item. |
| flybySftTreeAllColumns | 2 | The cell text of all cells are underlined as the mouse cursor moves over an item. |
### Comments
The FlybyHighlightStyle property defines whether items are underlined as the mouse cursor moves over an item.
[Flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) is also affected by the selected outline style using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property
Flyby highlighting can be useful when multiple columns without grid lines are shown. The user receives immediate feedback when the mouse cursor moves over an item.
See Also SftTreeItems Object | Object Hierarchy
## FocusIn Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusIn*
The control receives the input focus.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**FocusIn**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**FocusIn** |
| VB | **Private Sub** *object*_**FocusIn**() |
| C#.NET | **void** *object*_**FocusIn**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**FocusIn***object*(); |
| C | **HRESULT** On**FocusIn***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The FocusIn event occurs when the control receives the input focus.
Usually containers such as Visual Basic provide their own events which signal that a control receives or loses the input focus. .NET offers the Enter and Leave events, Visual Basic offers the GotFocus and LostFocus events and Visual C++ applications can handle the WM_SETFOCUS and WM_KILLFOCUS Windows messages (OnSetFocus and OnKillFocus). For containers where such a facility is not available, the FocusIn and [FocusOut](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusOut) events can be used instead. It is preferable to use events or mechanisms offered by the container rather than the FocusIn or FocusOut events.
Changing the input focus to another control or window while handling this event is not supported (including display of message boxes).
See Also SftTree Object | Object Hierarchy
## FocusOut Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusOut*
The control loses the input focus.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**FocusOut**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**FocusOut** |
| VB | **Private Sub** *object*_**FocusOut**() |
| C#.NET | **void** *object*_**FocusOut**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**FocusOut***object*(); |
| C | **HRESULT** On**FocusOut***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The FocusOut event occurs when the control loses the input focus.
Usually containers such as Visual Basic provide their own events which signal that a control receives or loses the input focus. .NET offers the Enter and Leave events, Visual Basic offers the GotFocus and LostFocus events and Visual C++ applications can handle the WM_SETFOCUS and WM_KILLFOCUS Windows messages (OnSetFocus and OnKillFocus). For containers where such a facility is not available, the [FocusIn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_FocusIn) and FocusOut events can be used instead. It is preferable to use events or mechanisms offered by the container rather than the FocusIn or FocusOut events.
Changing the input focus to another control or window while handling this event is not supported (including display of message boxes).
See Also SftTree Object | Object Hierarchy
## Font Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font*
Defines the default font used to display [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**Font** **As System.Drawing.Font[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**Font** **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *refFontObj* = *object*.**Font**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**Font**(); |
| C | **HRESULT** *object*->get_**Font**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Font**(**ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**Font**(**System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->Put**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**Font**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Font** = *refFontObj* **As System.Drawing.Font** |
| VB | **Set** *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *object*.**Font** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**Font**(**IFontDisp*** *refFontObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refFontObj
Defines the default font used to display cell text. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Font property defines the default font used to display cell text.
The Font property defines the default font used for all cells. The height for items is calculated based on the Font and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) properties so that cell text is never clipped vertically, unless multi-line text is used with more lines than defined using the Items.Lines property.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) property can be used to override an individual cell's font. The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Font), [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Font) and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Font) properties are used to define the fonts used to display the [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
See Also SftTree Object | Object Hierarchy
## Font Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font*
Defines the font used for this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**Font** **As stdole.IFontDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**Font** **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *refFontObj* = *object*.**Font**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**Font**(); |
| C | **HRESULT** *object*->get_**Font**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Font**(**ByVal** *refFontObj* **As stdole.IFontDisp**) |
| VB | *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**Font**(**stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->Put**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**Font**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Font** = *refFontObj* **As stdole.IFontDisp** |
| VB | **Set** *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *object*.**Font** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**Font**(**IFontDisp*** *refFontObj*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
refFontObj
Defines the font used for this cell. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Font property defines the font used for this cell.
The Font property overrides the control's Font property for the specified cell. If the Font property is not set for a particular cell, the control's [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) property is used to draw the cell text instead. The cell's Font property can be set to the value Nothing, which restores the tree control's default font, defined using the control's Font property.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)) and the Font property describes a font that is larger than the control's Font property, cell text will be clipped vertically. Items do not adjust their height to the Font property. Cell text is centered vertically and horizontally based on the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) and Cell.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) properties.
See Also SftTreeCell Object | Object Hierarchy
## Font Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Font*
Defines the font used for all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**Font** **As stdole.IFontDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**Font** **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *refFontObj* = *object*.**Font**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**Font**(); |
| C | **HRESULT** *object*->get_**Font**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Font**(**ByVal** *refFontObj* **As stdole.IFontDisp**) |
| VB | *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**Font**(**stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->Put**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**Font**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Font** = *refFontObj* **As stdole.IFontDisp** |
| VB | **Set** *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *object*.**Font** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**Font**(**IFontDisp*** *refFontObj*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
refFontObj
Defines the font used for all column footers. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Font property defines the font used for all column footers.
The Font property is used to change the font for all column footers and the row/column footer. Individual column footers cannot override the font.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTreeFooters Object | Object Hierarchy
## Font Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Font*
Defines the font used for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**Font** **As stdole.IFontDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**Font** **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *refFontObj* = *object*.**Font**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**Font**(); |
| C | **HRESULT** *object*->get_**Font**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Font**(**ByVal** *refFontObj* **As stdole.IFontDisp**) |
| VB | *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**Font**(**stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->Put**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**Font**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Font** = *refFontObj* **As stdole.IFontDisp** |
| VB | **Set** *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *object*.**Font** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**Font**(**IFontDisp*** *refFontObj*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
refFontObj
Defines the font used for all column headers. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Font property defines the font used for all column headers.
The Font property is used to change the font for all column headers and the row/column header. Individual column headers cannot override the font.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTreeHeaders Object | Object Hierarchy
## Font Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Font*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) font.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**Font** **As stdole.IFontDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**Font** **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *refFontObj* = *object*.**Font**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**Font**(); |
| C | **HRESULT** *object*->get_**Font**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Font**(**ByVal** *refFontObj* **As stdole.IFontDisp**) |
| VB | *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**Font**(**stdole.IFontDisp** *refFontObj*); |
| VC++ | **void** *object*->Put**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**Font**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Font** = *refFontObj* **As stdole.IFontDisp** |
| VB | **Set** *object*.**Font** = *refFontObj* **As IFontDisp** |
| C#.NET | **stdole.IFontDisp** *object*.**Font** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**Font**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**Font**(**IFontDisp*** *refFontObj*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
refFontObj
Defines the row header font. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Font property defines the row header font.
All row headers use the defined font. Individual items cannot override the default font.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Footer Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer*
Returns a [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object for a given column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFooterObj* = *object*.**Footer**(**ByVal** *ColIndex* **As Short**) **As SftTreeFooter** |
| VB | **Set** *refFooterObj* = *object*.**Footer**(**ByVal** *ColIndex* **As Integer**) **As SftTreeFooter** |
| C#.NET | **SftTreeFooter** *refFooterObj* = *object*.get_**Footer**(**short** *ColIndex*); |
| VC++ | **ISftTreeFooter*** *refFooterObj* = *object*->**Footer**[**short** *ColIndex*];
**ISftTreeFooter*** *refFooterObj* = *object*->Get**Footer**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**Footer**(**short** *ColIndex*, **ISftTreeFooter**** *refFooterObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
refFooterObj
Returns a SftTreeFooter object for a given column.
### Comments
The Footer property returns a SftTreeFooter object for a given column.
The SftTreeFooter object represents one [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. Numerous footer-specific properties and methods can be accessed using the returned object * refFooterObj*.
Certain default properties and behavior for all column footers can be defined using the [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
See Also SftTree Object | Object Hierarchy
## Footers Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers*
Returns the [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFootersObj* = *object*.**Footers** **As SftTreeFooters** |
| VB | **Set** *refFootersObj* = *object*.**Footers** **As SftTreeFooters** |
| C#.NET | **SftTreeFooters** *refFootersObj* = *object*.**Footers**; |
| VC++ | **ISftTreeFooters*** *refFootersObj* = *object*->**Footers**;
**ISftTreeFooters*** *refFootersObj* = *object*->Get**Footers**(); |
| C | **HRESULT** *object*->get_**Footers**(**ISftTreeFooters**** *refFootersObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refFootersObj
Returns the SftTreeFooters object.
### Comments
The Footers property returns the SftTreeFooters object.
The SftTreeFooters object describes attributes that apply to all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object *refFootersObj*. A control has only one SftTreeFooters object.
An individual column's [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object can be accessed through the control's [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer) property.
See Also SftTree Object | Object Hierarchy
## ForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ForeColor*
Defines the default text color used to draw items that are not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default text color used to draw items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ForeColor instead
The ForeColor property defines the default text color used to draw items that are not selected.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the default foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the Items.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the ForeColor property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) property for only portions of the item, the ForeColor property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ForeColor Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s foreground color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's foreground color. -1 indicates that there is no defined color and the default color defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) is used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the cell's foreground color.
The cell has the foreground color attribute *Clr*. This color is used as text color when the item is not selected. If the item is selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property is used instead.
See Also SftTreeCell Object | Object Hierarchy
## ForeColor Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor*
Defines the text color of [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the text color of cells in this column. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the text color of cells in this column.
Cells can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property for only portions of the item, the Column.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property is used for the remainder of the item.
See Also SftTreeColumn Object | Object Hierarchy
## ForeColor Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor*
Defines the foreground color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the foreground color for this column footer. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the foreground color for this column footer.
The color defined overrides the default color for column footers defined using [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Footers.ForeColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Footer.[ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColorDisabled) property can be used to define the foreground color for this column footer, when it is disabled.
See Also SftTreeFooter Object | Object Hierarchy
## ForeColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ForeColor*
Defines the text color for all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the text color for all column footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the text color for all column footers.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeFooters Object | Object Hierarchy
## ForeColor Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor*
Defines the foreground color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the foreground color for this column header. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the foreground color for this column header.
The color defined overrides the default color for column headers defined using [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using Headers.ForeColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The Header.[ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColorDisabled) property can be used to define the foreground color for this column header, when it is disabled.
See Also SftTreeHeader Object | Object Hierarchy
## ForeColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor*
Defines the text color for all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the text color for all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the text color for all column headers. Column headers can override the background color using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeHeaders Object | Object Hierarchy
## ForeColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor*
Defines the default text color used to draw items that are not selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the default text color used to draw items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the default text color used to draw items that are not selected.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the default foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the ForeColor property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) property for only portions of the item, the ForeColor property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## ForeColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ForeColor*
Defines the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s text color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the row/column footer's text color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the row/column footer's text color.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## ForeColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ForeColor*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the row/column header's text color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the row/column header's text color.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## ForeColor Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s foreground color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Clr
Defines the row header's foreground color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the row header's foreground color.
The row header has the foreground color attribute *Clr*. This color is used as foreground color when the item is not selected. If the item is selected, the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) property is used instead.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. The RowHeader.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme) property can be used to override Windows themes so defined colors are used instead.
See Also SftTreeRowHeader Object | Object Hierarchy
## ForeColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ForeColor*
Defines the default text color used to draw [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) of items that are not selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColor**(); |
| C | **HRESULT** *object*->get_**ForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColor** = *Clr*;
**void** *object*->Put**ForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default text color used to draw row headers of items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColor property defines the default text color used to draw row headers of items that are not selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header foreground color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) property.
See Also SftTreeRowHeaders Object | Object Hierarchy
## ForeColorDisabled Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColorDisabled*
Defines the foreground color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), when it is disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColorDisabled** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColorDisabled** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColorDisabled**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColorDisabled**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColorDisabled**(); |
| C | **HRESULT** *object*->get_**ForeColorDisabled**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColorDisabled** = *Clr* **As UInteger** |
| VB | *object*.**ForeColorDisabled** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColorDisabled** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColorDisabled** = *Clr*;
**void** *object*->Put**ForeColorDisabled**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColorDisabled**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the foreground color for this column footer, when it is disabled. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColorDisabled property defines the foreground color for this column footer, when it is disabled.
If the column footer is disabled, the color defined using the ForeColorDisabled property overrides the default color for this column footer defined using [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Footer.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
The Footer.ForeColor property can be used to define the foreground color for this column footer, when it is not disabled.
See Also SftTreeFooter Object | Object Hierarchy
## ForeColorDisabled Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColorDisabled*
Defines the foreground color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), when it is disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColorDisabled** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColorDisabled** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColorDisabled**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColorDisabled**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColorDisabled**(); |
| C | **HRESULT** *object*->get_**ForeColorDisabled**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColorDisabled** = *Clr* **As UInteger** |
| VB | *object*.**ForeColorDisabled** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColorDisabled** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColorDisabled** = *Clr*;
**void** *object*->Put**ForeColorDisabled**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColorDisabled**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the foreground color for this column header, when it is disabled. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColorDisabled property defines the foreground color for this column header, when it is disabled.
If the column header is disabled, the color defined using the ForeColorDisabled property overrides the default color for this column header defined using [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Header.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
The Header.ForeColor property can be used to define the foreground color for this column header, when it is not disabled.
See Also SftTreeHeader Object | Object Hierarchy
## ForeColorOdd Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ForeColorOdd*
Defines the text color used to draw items in odd rows.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ForeColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColorOdd) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColorOdd** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColorOdd** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ForeColorOdd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColorOdd**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColorOdd**(); |
| C | **HRESULT** *object*->get_**ForeColorOdd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColorOdd** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ForeColorOdd** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ForeColorOdd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColorOdd** = *Clr*;
**void** *object*->Put**ForeColorOdd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColorOdd**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw items in odd rows. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ForeColorOdd instead
The ForeColorOdd property defines the text color used to draw items in odd rows.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) property for only portions of the item, the ForeColorOdd property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## ForeColorOdd Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColorOdd*
Defines the text color used to draw items in odd rows.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ForeColorOdd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ForeColorOdd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ForeColorOdd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ForeColorOdd**;
**OLE_COLOR** *Clr* = *object*->Get**ForeColorOdd**(); |
| C | **HRESULT** *object*->get_**ForeColorOdd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ForeColorOdd** = *Clr* **As UInteger** |
| VB | *object*.**ForeColorOdd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ForeColorOdd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ForeColorOdd** = *Clr*;
**void** *object*->Put**ForeColorOdd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ForeColorOdd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the text color used to draw items in odd rows. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ForeColorOdd property defines the text color used to draw items in odd rows.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property. If a [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Items.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) property for only portions of the item, the ForeColorOdd property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## FrameColor Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_FrameColor*
Defines the border color of the color sample.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**FrameColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**FrameColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**FrameColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**FrameColor**;
**OLE_COLOR** *Clr* = *object*->Get**FrameColor**(); |
| C | **HRESULT** *object*->get_**FrameColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**FrameColor** = *Clr* **As UInteger** |
| VB | *object*.**FrameColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**FrameColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**FrameColor** = *Clr*;
**void** *object*->Put**FrameColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**FrameColor**(**OLE_COLOR** *Clr*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Clr
Defines the border color of the color sample. Specify -1 to omit the border of the color sample. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The FrameColor property defines the border color of the color sample.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants).
The SftPictureObject.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) and SftPictureObject.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) properties should be used to define the requested image size.
The SftPictureObject.[SampleColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SampleColor) property can be used to define the sample color.
See Also SftPictureObject Object | Object Hierarchy
## GDIPlusSupport Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GDIPlusSupport*
Returns whether [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) support is available.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GDIPlusSupport** **As Boolean** |
| VB | *Boolean* = *object*.**GDIPlusSupport** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GDIPlusSupport**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GDIPlusSupport**;
**VARIANT_BOOL** *Boolean* = *object*->Get**GDIPlusSupport**(); |
| C | **HRESULT** *object*->get_**GDIPlusSupport**(**VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Returns whether GDI+ support is available.
| Boolean | Description |
| --- | --- |
| True | GDI+ support is available. |
| False | GDI+ support is not available. |
### Comments
The GDIPlusSupport property returns whether GDI+ support is available.
The [SftPictureObject.Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image) and [NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) properties require GDI+ support. For information about [distributing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_distributing) GDI+ with your application, please see "Distributing SftTree/OCX".
An application can use the GDIPlusSupport property to determine at run-time whether GDI+ support is available and use advanced image features, based on the [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) Image property, if GDI+ is available.
See Also SftTree Object | Object Hierarchy
## GetButtonPosition Method, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPosition*
Returns the coordinates of the [footer dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) area.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetButtonPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetButtonPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetButtonPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetButtonPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetButtonPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Left
Returns the horizontal position of the footer dropdown/filter button relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position of the footer dropdown/filter button relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the footer dropdown/filter button. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the footer dropdown/filter button. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The GetButtonPosition method returns the coordinates of the footer dropdown/filter button area. If no footer dropdown/filter button is shown, this method returns *Width*/*Height* 0.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPosition) and Footer.[GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all the entire [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), use Footer.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) instead.
See Also SftTreeFooter Object | Object Hierarchy
## GetButtonPosition Method, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPosition*
Returns the coordinates of the [header dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) area.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetButtonPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetButtonPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetButtonPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetButtonPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetButtonPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Left
Returns the horizontal position of the header dropdown/filter button relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position of the header dropdown/filter button relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the header dropdown/filter button. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the header dropdown/filter button. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The GetButtonPosition method returns the coordinates of the header dropdown/filter button area. If no header dropdown/filter button is shown, this method returns *Width*/*Height* 0.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPosition) and Header.[GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all the entire [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), use Header.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) instead.
See Also SftTreeHeader Object | Object Hierarchy
## GetButtonPositionPix Method, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPositionPix*
Returns the coordinates of the [footer dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) area.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetButtonPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetButtonPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetButtonPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetButtonPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetButtonPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
LeftPix
Returns the horizontal position of the footer dropdown/filter button area relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position of the footer dropdown/filter button area relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the footer dropdown/filter button area in pixels.
HeightPix
Returns the height of the footer dropdown/filter button area in pixels.
### Comments
The GetButtonPositionPix method returns the coordinates of the footer dropdown/filter button area. If no footer dropdown/filter button is shown, this method returns *WidthPix*/*HeightPix* 0.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPosition) and Footer.[GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetButtonPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all the entire [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), use Footer.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) instead.
See Also SftTreeFooter Object | Object Hierarchy
## GetButtonPositionPix Method, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPositionPix*
Returns the coordinates of the [header dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) area.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetButtonPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetButtonPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetButtonPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetButtonPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetButtonPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
LeftPix
Returns the horizontal position of the header dropdown/filter button area relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position of the header dropdown/filter button area relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the header dropdown/filter button area in pixels.
HeightPix
Returns the height of the header dropdown/filter button area in pixels.
### Comments
The GetButtonPositionPix method returns the coordinates of the header dropdown/filter button area. If no header dropdown/filter button is shown, this method returns *WidthPix*/*HeightPix* 0.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetButtonPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPosition) and Header.[GetButtonPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetButtonPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all the entire [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), use Header.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) instead.
See Also SftTreeHeader Object | Object Hierarchy
## GetCellColorSample Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellColorSample*
Defines the color sample displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[GetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetColorSample) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetCellColorSample**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *Clr* **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByRef** *FrameClr* **As System.Drawing.Color**, **ByRef** *WidthPix* **As Short**, **ByRef** *HeightPix* **As Short**) |
| VB | *object*.**GetCellColorSample**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *Clr* **As OLE_COLOR**, *FrameClr* **As OLE_COLOR**, *WidthPix* **As Integer**, *HeightPix* **As Integer**) |
| C#.NET | **void** *object*.**GetCellColorSample**(**int** *ItemIndex*, **short** *ColIndex*, **out** **System.Drawing.Color** *Clr*, **out** **System.Drawing.Color** *FrameClr*, **out** **short** *WidthPix*, **out** **short** *HeightPix*); |
| VC++ | **HRESULT** *object*->**GetCellColorSample**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*, **OLE_COLOR*** *FrameClr*, **short*** *WidthPix*, **short*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetCellColorSample**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR*** *Clr*, **OLE_COLOR*** *FrameClr*, **short*** *WidthPix*, **short*** *HeightPix*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Returns the color value used to fill the color sample rectangle.
FrameClr
Returns the color value used to outline the color sample rectangle.
WidthPix
Returns the width of the color sample rectangle in pixels.
HeightPix
Returns the height of the color sample rectangle in pixels.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.GetColorSample instead
The GetCellColorSample method defines the color sample displayed as an item's cell graphic.
See Also SftTree Object | Object Hierarchy
## GetCellEditSelection Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellEditSelection*
Returns the position of the selection during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetCellEditSelection**(**ByRef** *iStart* **As Integer**, **ByRef** *iEnd* **As Integer**) |
| VB | *object*.**GetCellEditSelection**(*iStart* **As Long**, *iEnd* **As Long**) |
| C#.NET | **void** *object*.**GetCellEditSelection**(**out** **int** *iStart*, **out** **int** *iEnd*); |
| VC++ | **HRESULT** *object*->**GetCellEditSelection**(**long*** *iStart*, **long*** *iEnd*); |
| C | **HRESULT** *object*->raw_**GetCellEditSelection**(**long*** *iStart*, **long*** *iEnd*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
iStart
Returns the zero-based starting position of the first selected character of the edit control used for cell editing. -1 is returned if cell editing is not active or if it has not been started using [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) or [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit).
iEnd
Returns the zero-based ending position, i.e. the position of the first character that is not selected. -1 is returned if cell editing is not active or if it has not been started using StartEdit, StartCombo or StartComboEdit.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The GetCellEditSelection method returns the position of the selection during cell editing.
The GetCellEditSelection method is only available if cell editing has been started using StartEdit, StartCombo or StartComboEdit and cannot be used if cell editing has been initiated using [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit).
Use [SetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellEditSelection) to update the position of the current selection.
See Also SftTree Object | Object Hierarchy
## GetCellPictureImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPictureImage*
Defines the graphic displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[GetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetCellPictureImage**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *ImgListObj* **As Object**, **ByRef** *ImgIndex* **As Short**) |
| VB | *object*.**GetCellPictureImage**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *ImgListObj* **As Object**, *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**GetCellPictureImage**(**int** *ItemIndex*, **short** *ColIndex*, **out** **object** *ImgListObj*, **out** **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**GetCellPictureImage**(**long** *ItemIndex*, **short** *ColIndex*, **LPDISPATCH*** *ImgListObj*, **short*** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**GetCellPictureImage**(**long** *ItemIndex*, **short** *ColIndex*, **LPDISPATCH*** *ImgListObj*, **short*** *ImgIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ImgListObj
Returns the ImageList control object.
ImgIndex
Returns the one-based index of the image in the ImageList control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.GetImageList instead
The GetCellPictureImage method defines the graphic displayed as an item's cell graphic.
The Cell.Image.[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) method is used to set a cell's optional graphic component using an ImageList control.
See Also SftTree Object | Object Hierarchy
## GetCellPicturePos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePos*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s graphic component.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellPicturePos**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellPicturePos**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellPicturePos**(**int** *ItemIndex*, **short** *ColIndex*, **out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellPicturePos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetCellPicturePos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell graphic. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell graphic. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetImagePosition instead
The GetCellPicturePos method returns the coordinates of a cell's graphic component.
The GetCellPicturePos and [GetCellPicturePosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePosPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) method returns the overall dimensions of a cell. The Cell.[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) method returns the dimensions of the cell text.
See Also SftTree Object | Object Hierarchy
## GetCellPicturePosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePosPix*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s graphic component.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellPicturePosPix**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellPicturePosPix**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellPicturePosPix**(**int** *ItemIndex*, **short** *ColIndex*, **out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellPicturePosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetCellPicturePosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell graphic in pixels.
HeightPix
Returns the height of the cell graphic in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetImagePositionPix instead
The GetCellPicturePosPix method returns the coordinates of a cell's graphic component.
The [GetCellPicturePos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPicturePos) and GetCellPicturePosPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) method returns the overall dimensions of a cell. The Cell.[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) method returns the dimensions of the cell text.
See Also SftTree Object | Object Hierarchy
## GetCellPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPos*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellPos**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellPos**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellPos**(**int** *ItemIndex*, **short** *ColIndex*, **out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellPos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetCellPos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the cell occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the cell merges into an adjacent column, a cell can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetPosition instead
The GetCellPos method returns the coordinates of a cell.
The GetCellPos and [GetCellPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPosPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) method is used to return the dimensions of the cell graphic. The Cell.[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) method returns the dimensions of the cell text.
See Also SftTree Object | Object Hierarchy
## GetCellPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPosPix*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellPosPix**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellPosPix**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellPosPix**(**int** *ItemIndex*, **short** *ColIndex*, **out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellPosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetCellPosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell in pixels.
HeightPix
Returns the height of the cell in pixels.
Span
Returns the number of columns that the cell occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the cell merges into an adjacent column, a cell can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetPositionPix instead
The GetCellPosPix method returns the coordinates of a cell.
The [GetCellPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellPos) and GetCellPosPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) method is used to return the dimensions of the cell graphic. The Cell.[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) method returns the dimensions of the cell text.
See Also SftTree Object | Object Hierarchy
## GetCellTextPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPos*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text component.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellTextPos**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellTextPos**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellTextPos**(**int** *ItemIndex*, **short** *ColIndex*, **out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellTextPos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetCellTextPos**(**long** *ItemIndex*, **short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell text. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell text. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetTextPosition instead
The GetCellTextPos method returns the coordinates of a cell's text component.
The GetCellTextPos and [GetCellTextPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPosPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) method is used to return the overall dimensions of the cell. The Cell.[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) method returns the dimensions of the cell graphic.
See Also SftTree Object | Object Hierarchy
## GetCellTextPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPosPix*
Returns the coordinates of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text component.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetCellTextPosPix**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetCellTextPosPix**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetCellTextPosPix**(**int** *ItemIndex*, **short** *ColIndex*, **out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetCellTextPosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetCellTextPosPix**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell text in pixels.
HeightPix
Returns the height of the cell text in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell specified by *ItemIndex* and *ColIndex* is displayed and visible. |
| False | The cell specified by *ItemIndex* and *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.GetTextPositionPix instead
The GetCellTextPosPix method returns the coordinates of a cell's text component.
The [GetCellTextPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellTextPos) and GetCellTextPosPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) method is used to return the overall dimensions of the cell. The Cell.[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) method returns the dimensions of the cell graphic.
See Also SftTree Object | Object Hierarchy
## GetColorSample Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetColorSample*
Retrieves the picture object attributes defined as a color sample.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetColorSample**(**ByRef** *[SampleColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SampleColor)* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByRef** *[FrameColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_FrameColor)* **As UInteger**) |
| VB | *object*.**GetColorSample**(*SampleColor* **As OLE_COLOR**, *FrameColor* **As OLE_COLOR**) |
| C#.NET | **void** *object*.**GetColorSample**(**out** **uint** *SampleColor*, **out** **uint** *FrameColor*); |
| VC++ | **HRESULT** *object*->**GetColorSample**(**OLE_COLOR*** *SampleColor*, **OLE_COLOR*** *FrameColor*); |
| C | **HRESULT** *object*->raw_**GetColorSample**(**OLE_COLOR*** *SampleColor*, **OLE_COLOR*** *FrameColor*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
SampleColor
Returns the current sample color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
FrameColor
Returns the current border color. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".
### Comments
The GetColorSample method retrieves the picture object attributes defined as a color sample.
If the current picture object is not a color sample (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) other than [sftTypeColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)), the returned color values are not valid.
The color sample is defined using the SftPictureObject.SampleColor, SftPictureObject.FrameColor, SftPictureObject.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width), SftPictureObject.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) properties or using the SftPictureObject.[SetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample) method.
See Also SftPictureObject Object | Object Hierarchy
## GetContentWindow Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetContentWindow*
Retrieves the [content window](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contentwindows) attached to the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetContentWindow**(**ByRef** *Window* **As Integer**, **ByRef** *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* **As [SftTreeContentWindowStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeContentWindowStyleConstants)**) |
| VB | *object*.**GetContentWindow**(*Window* **As OLE_HANDLE**, *Style* **As SftTreeContentWindowStyleConstants**) |
| C#.NET | **void** *object*.**GetContentWindow**(**out** **int** *Window*, **out** **SftTreeContentWindowStyleConstants** *Style*); |
| VC++ | **HRESULT** *object*->**GetContentWindow**(**OLE_HANDLE*** *Window*, **enum SftTreeContentWindowStyleConstants*** *Style*); |
| C | **HRESULT** *object*->raw_**GetContentWindow**(**OLE_HANDLE*** *Window*, **enum SftTreeContentWindowStyleConstants*** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Window
Returns the window handle of the window used for the cell as a content window. Returns NULL/Nothing if the cell does not have a content window.
Style
Returns the current options defined for the content window. Values of the following tables can be combined:
| Name | Value | Description |
| --- | --- | --- |
| contentWindowSftTreeNone | 0 | None - No special handling. |
| contentWindowSftTreeKeepDisabled | 1 | Keep Disabled - The content window is always disabled. A content window is normally enabled and disabled as it is made visible or hidden. When contentWindowSftTreeKeepDisabled is specified, the content window is always disabled, even when it is visible. |
| contentWindowSftTreeKeepSize | 2 | Keep Size ([Variable Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) Tree Control) - The original size of the content window is preserved and the cell size adjusts accordingly. While a column can still be smaller or larger than the content window width, the content window is not resized, it is merely clipped. Without contentWindowSftTreeKeepSize, a content window is resized in height and width to fit within the cell. contentWindowSftTreeKeepSize has no effect in a fixed height tree control. |
### Comments
The GetContentWindow method retrieves the content window attached to the cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[AttachContentWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_AttachContentWindow) method can be used to attach a content window to a cell.
See Also SftTreeCell Object | Object Hierarchy
## GetData Method, DataObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData*
Retrieves data of a specified format from a [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object.
### Syntax
| | |
| --- | --- |
| VB.NET | *Data* = *object*.**GetData**([ **ByVal** *Format* **As Object** ] ) **As Object** |
| VB | *Data* = *object*.**GetData**([ **ByVal** *Format* **As Variant** ] ) **As Variant** |
| C#.NET | **object** *Data* = *object*.**GetData**(**object** *Format*); |
| VC++ | **_variant_t** *Data* = *object*->**GetData**(**const _variant_t**&**** *Format* = **vtMissing**); |
| C | **HRESULT** *object*->raw_**GetData**(**VARIANT** *Format*, **VARIANT*** *Data*); |
object
A DataObject object.
Format
The data format requested (see [SftOLEClipboardConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants)). The *Format* argument is optional. If *Format* is not specified, GetData returns data in a suitable format.
| Format | Value | Description |
| --- | --- | --- |
| sftCFText | 1 | Text (as a String value) |
| sftCFBitmap | 2 | Bitmap (as [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object) |
| sftCFMetafile | 3 | Metafile (as Picture object) |
| sftCFDIB | 8 | Device independent bitmap (as Picture object) |
| sftCFFiles | 15 | [List](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_List) of files. The GetData method cannot be used to retrieve this format. Use the DataObject.[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection instead. |
| sftCFRTF | -16639 | Rich text format (as String value) |
Data
Returns data of a specified format from a DataObject object.
### Comments
The GetData method retrieves data of a specified format from a DataObject object.
It is possible for the GetData method and DataObject.[SetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData) method to use data formats other than those listed as valid *Format* argument, including user-defined formats registered with Windows via the RegisterClipboardFormat() API function. The DataObject.SetData method requires the data to be in the form of a byte array when it does not recognize the data format specified. The GetData method always returns data in a byte array when it is in a format that it doesn't recognize, although this may be transparently converted into other data types, such as strings. The byte array returned by GetData will be larger than the actual data when running on some operating systems, with arbitrary bytes at the end of the array. This allocation of memory is often larger than is actually required for the data. Therefore, there may be extraneous bytes near the end of the allocated memory segment.
See Also DataObject Object | Object Hierarchy
## GetFormat Method, DataObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetFormat*
Determines if a specified clipboard format is supported by the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object.
### Syntax
| | |
| --- | --- |
| VB.NET | *FormatSupported* = *object*.**GetFormat**(**ByVal** *Format* **As Short**) **As Boolean** |
| VB | *FormatSupported* = *object*.**GetFormat**(**ByVal** *Format* **As Integer**) **As Boolean** |
| C#.NET | **bool** *FormatSupported* = *object*.**GetFormat**(**short** *Format*); |
| VC++ | **VARIANT_BOOL** *FormatSupported* = *object*->**GetFormat**(**short** *Format*); |
| C | **HRESULT** *object*->raw_**GetFormat**(**short** *Format*, **VARIANT_BOOL*** *FormatSupported*); |
object
A DataObject object.
Format
The data format requested (see [SftOLEClipboardConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants)).
| Format | Value | Description |
| --- | --- | --- |
| sftCFText | 1 | Text |
| sftCFBitmap | 2 | Bitmap |
| sftCFMetafile | 3 | Metafile |
| sftCFDIB | 8 | Device independent bitmap |
| sftCFFiles | 15 | [List](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_List) of files |
| sftCFRTF | -16639 | Rich text format |
FormatSupported
Returns True if the specified clipboard format *Format* is supported by the DataObject object, otherwise False is returned.
### Comments
The GetFormat method determines if a specified clipboard format is supported by the DataObject object.
The GetFormat method returns True if a data format in the DataObject object matches the specified format. Otherwise, it returns False.
See Also DataObject Object | Object Hierarchy
## GetHeaderPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPos*
Returns the coordinates of a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) or [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetHeaderPos**(**ByVal** *ColIndex* **As Short**, **ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetHeaderPos**(**ByVal** *ColIndex* **As Integer**, *Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetHeaderPos**(**short** *ColIndex*, **out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetHeaderPos**(**short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetHeaderPos**(**short** *ColIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number. If -1 is specified, the dimensions of the combined row/column header and all column headers are returned.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the column header. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the column header. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the column header occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the column header merges into an adjacent column header, a column header can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column header specified by *ColIndex* is displayed and visible. |
| False | The column header specified by *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPosition or Headers.GetPosition instead
The GetHeaderPos method returns the coordinates of a column header.
The GetHeaderPos and [GetHeaderPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPosPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column headers, use Headers.GetPosition instead.
See Also SftTree Object | Object Hierarchy
## GetHeaderPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPosPix*
Returns the coordinates of a [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPositionPix) or [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetHeaderPosPix**(**ByVal** *ColIndex* **As Short**, **ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetHeaderPosPix**(**ByVal** *ColIndex* **As Integer**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetHeaderPosPix**(**short** *ColIndex*, **out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetHeaderPosPix**(**short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetHeaderPosPix**(**short** *ColIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number. If -1 is specified, the dimensions of the combined row/column header and all column headers are returned.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the column header in pixels.
HeightPix
Returns the height of the column header in pixels.
Span
Returns the number of columns that the column header occupies.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column header specified by *ColIndex* is displayed and visible. |
| False | The column header specified by *ColIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPositionPix or Headers.GetPositionPix instead
The GetHeaderPosPix method returns the coordinates of a column header.
The [GetHeaderPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetHeaderPos) and GetHeaderPosPix methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column headers, use Headers.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) instead.
See Also SftTree Object | Object Hierarchy
## GetImage Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImage*
Retrieves the picture object attributes defined as a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetImage**(**ByRef** *GDIPlusImage* **As Integer**, **ByRef** *Owned* **As Boolean**) |
| VB | *object*.**GetImage**(*GDIPlusImage* **As LONG_PTR**, *Owned* **As Boolean**) |
| C#.NET | **void** *object*.**GetImage**(**out** **int** *GDIPlusImage*, **out** **bool** *Owned*); |
| VC++ | **HRESULT** *object*->**GetImage**(**LONG_PTR*** *GDIPlusImage*, **VARIANT_BOOL*** *Owned*); |
| C | **HRESULT** *object*->raw_**GetImage**(**LONG_PTR*** *GDIPlusImage*, **VARIANT_BOOL*** *Owned*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
GDIPlusImage
Returns a pointer to a Gdiplus::Image object.
Owned
Returns True if the GDI+ image is owned by the tree control, False otherwise.
### Comments
The [GetImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImage) method retrieves the picture object attributes defined as a GDI+ image.
[SetImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImage) can be used to assign ownership of a GDI+ image to the tree control, so it automatically deletes the object when it is no longer needed. This is typically only used by C++ applications that have direct access to GDI+ classes.
If the current picture object is not based on a GDI+ image (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) other than [sftTypeGDIPlus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)), the returned values are not valid.
See Also SftPictureObject Object | Object Hierarchy
## GetImageList Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageList*
Retrieves the picture object attributes defined as an ImageList image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetImageList**(**ByRef** *ImageList* **As Object**, **ByRef** *ImageIndex* **As Short**) |
| VB | *object*.**GetImageList**(*ImageList* **As Object**, *ImageIndex* **As Integer**) |
| C#.NET | **void** *object*.**GetImageList**(**out** **object** *ImageList*, **out** **short** *ImageIndex*); |
| VC++ | **HRESULT** *object*->**GetImageList**(**LPDISPATCH*** *ImageList*, **short*** *ImageIndex*); |
| C | **HRESULT** *object*->raw_**GetImageList**(**LPDISPATCH*** *ImageList*, **short*** *ImageIndex*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
ImageList
Returns the ImageList control.
ImageIndex
Returns the one-based index of the image in the ImageList control used as graphic.
### Comments
The GetImageList method retrieves the picture object attributes defined as an ImageList image.
GetImageList only supports ActiveX ImageList controls that offer an IImageList interface. [GetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageListH) and [SetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageListH) support a window handle based ImageList control (Common Controls).
If the current picture object is not based on an ImageList (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) other than [sftTypeImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)), the returned values are not valid.
See Also SftPictureObject Object | Object Hierarchy
## GetImageListH Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageListH*
Retrieves the picture object attributes defined as an ImageList image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetImageListH**(**ByRef** *ImageListWindow* **As Integer**, **ByRef** *ImageIndex* **As Short**) |
| VB | *object*.**GetImageListH**(*ImageListWindow* **As OLE_HANDLE**, *ImageIndex* **As Integer**) |
| C#.NET | **void** *object*.**GetImageListH**(**out** **int** *ImageListWindow*, **out** **short** *ImageIndex*); |
| VC++ | **HRESULT** *object*->**GetImageListH**(**OLE_HANDLE*** *ImageListWindow*, **short*** *ImageIndex*); |
| C | **HRESULT** *object*->raw_**GetImageListH**(**OLE_HANDLE*** *ImageListWindow*, **short*** *ImageIndex*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
ImageListWindow
Returns the ImageList control handle.
ImageIndex
Returns the one-based index of the image in the ImageList control used as graphic.
### Comments
The GetImageListH method retrieves the picture object attributes defined as an ImageList image.
If the current picture object is not based on an ImageList (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) other than [sftTypeImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)), the returned values are not valid.
See Also SftPictureObject Object | Object Hierarchy
## GetImagePosition Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetImagePosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetImagePosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetImagePosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetImagePosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetImagePosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell graphic. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell graphic. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetImagePosition method returns the coordinates of the cell image.
The GetImagePosition and [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) method returns the overall dimensions of a cell. The Cell.[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) method returns the dimensions of the cell text.
See Also SftTreeCell Object | Object Hierarchy
## GetImagePositionPix Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetImagePositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetImagePositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetImagePositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetImagePositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetImagePositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell graphic in pixels.
HeightPix
Returns the height of the cell graphic in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetImagePositionPix method returns the coordinates of the cell image.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) and GetImagePositionPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) method returns the overall dimensions of a cell. The Cell.[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) method returns the dimensions of the cell text.
See Also SftTreeCell Object | Object Hierarchy
## GetItemPictureImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPictureImage*
Defines the graphic displayed as an item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[GetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetItemPictureImage**(**ByVal** *ItemIndex* **As Integer**, **ByRef** *ImgListObj* **As Object**, **ByRef** *ImgIndex* **As Short**) |
| VB | *object*.**GetItemPictureImage**(**ByVal** *ItemIndex* **As Long**, *ImgListObj* **As Object**, *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**GetItemPictureImage**(**int** *ItemIndex*, **out** **object** *ImgListObj*, **out** **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**GetItemPictureImage**(**long** *ItemIndex*, **LPDISPATCH*** *ImgListObj*, **short*** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**GetItemPictureImage**(**long** *ItemIndex*, **LPDISPATCH*** *ImgListObj*, **short*** *ImgIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
ImgListObj
Returns a reference to the ImageList control object.
ImgIndex
Returns the one-based index of the image in the ImageList control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.GetImageList instead
The GetItemPictureImage method defines the graphic displayed as an item's item graphic.
The Item.Image.[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) method is used to set an item's item graphic using an ImageList control.
See Also SftTree Object | Object Hierarchy
## GetItemPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPos*
Returns the coordinates of an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetItemPos**(**ByVal** *ItemIndex* **As Integer**, **ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetItemPos**(**ByVal** *ItemIndex* **As Long**, *Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetItemPos**(**int** *ItemIndex*, **out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetItemPos**(**long** *ItemIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetItemPos**(**long** *ItemIndex*, **float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the item. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the item. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The item specified by *ItemIndex* is displayed and visible. |
| False | The item specified by *ItemIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.GetPosition instead
The GetItemPos method returns the coordinates of an item.
The GetItemPos and [GetItemPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPosPix) methods are synonyms, but may use different coordinate systems.
The position returned includes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (if present). The width of the row header area can be determined using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTree Object | Object Hierarchy
## GetItemPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPosPix*
Returns the coordinates of an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetItemPosPix**(**ByVal** *ItemIndex* **As Integer**, **ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetItemPosPix**(**ByVal** *ItemIndex* **As Long**, *LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetItemPosPix**(**int** *ItemIndex*, **out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetItemPosPix**(**long** *ItemIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetItemPosPix**(**long** *ItemIndex*, **OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the item in pixels.
HeightPix
Returns the height of the item in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The item specified by *ItemIndex* is displayed and visible. |
| False | The item specified by *ItemIndex* is not visible. The returned coordinates are not valid. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.GetPositionPix instead
The GetItemPosPix method returns the coordinates of an item.
The [GetItemPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetItemPos) and GetItemPosPix methods are synonyms, but may use different coordinate systems.
The position returned includes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (if present). The width of the row header area can be determined using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTree Object | Object Hierarchy
## GetNextShown Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetNextShown*
Returns the index of the next [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown) and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *NextItemIndex* = *object*.**GetNextShown**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *NextItemIndex* = *object*.**GetNextShown**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *NextItemIndex* = *object*.**GetNextShown**(**int** *ItemIndex*); |
| VC++ | **long** *NextItemIndex* = *object*->**GetNextShown**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**GetNextShown**(**long** *ItemIndex*, **long*** *NextItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose next item is to be retrieved. If -1 is specified, the index of the first visible item in the tree control is returned.
NextItemIndex
Returns the zero-based index of the next visible item given an item *ItemIndex*. If -1 is returned, if no item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.FirstShown and Item.NextShown instead
The GetNextShown method returns the index of the next visible item.
Dependent items of a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item are skipped using this method.
Use Items.FirstShown, Item.NextShown, Item.[PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown), Items.[LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) to retrieve information about item visibility.
See Also SftTree Object | Object Hierarchy
## GetPosition Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the cell occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the cell merges into an adjacent column, a cell can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the cell.
The GetPosition and [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) method is used to return the dimensions of the cell graphic. The Cell.[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) method returns the dimensions of the cell text.
See Also SftTreeCell Object | Object Hierarchy
## GetPosition Method, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition*
Returns the coordinates of the footer.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters). The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the column footer. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the column footer occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the column footer merges into an adjacent column footer, a column footer can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column footer is displayed and visible. |
| False | The column footer is not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the footer.
The GetPosition and [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column footers, use [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPosition) instead.
See Also SftTreeFooter Object | Object Hierarchy
## GetPosition Method, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPosition*
Returns the coordinates of the combined row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) and all column footers.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the column footer. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the column footer. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the column footer occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the column footer merges into an adjacent column footer, a column footer can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column footers are displayed and visible. |
| False | The column footers are not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the combined row/column footer and all column footers.
The GetPosition and [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPositionPix) methods are synonyms, but may use different coordinate systems.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) method can be used to retrieve the coordinates of one column footer.
See Also SftTreeFooters Object | Object Hierarchy
## GetPosition Method, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition*
Returns the coordinates of the header.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the column header. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the column header occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the column header merges into an adjacent column header, a column header can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column header is displayed and visible. |
| False | The column header is not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the header.
The GetPosition and [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPositionPix) methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column headers, use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) instead.
See Also SftTreeHeader Object | Object Hierarchy
## GetPosition Method, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition*
Returns the coordinates of the combined row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and all column headers.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the column header. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the column header. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Span
Returns the number of columns that the column header occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the column header merges into an adjacent column header, a column header can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column headers are displayed and visible. |
| False | The column headers are not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the combined row/column header and all column headers.
The GetPosition and [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPositionPix) methods are synonyms, but may use different coordinate systems.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) method can be used to retrieve the coordinates of one column header.
See Also SftTreeHeaders Object | Object Hierarchy
## GetPosition Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPosition*
Returns the coordinates of the item.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the item. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the item. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The item is displayed and visible. |
| False | The item is not visible. The returned coordinates are not valid. |
### Comments
The GetPosition method returns the coordinates of the item.
The GetPosition and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPositionPix) methods are synonyms, but may use different coordinate systems.
The position returned includes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (if present). The width of the row header area can be determined using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTreeItem Object | Object Hierarchy
## GetPosition Method, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition*
Returns the coordinates of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) |
| VB | *object*.**GetPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) |
| C#.NET | **void** *object*.**GetPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **HRESULT** *object*->**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the splitter bar. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the splitter bar. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The GetPosition method returns the coordinates of the splitter bar.
The GetPosition and [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPositionPix) methods are synonyms, but may use different coordinate systems.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to define the width of the splitter bar. The Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) defines the horizontal position of the splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## GetPositionPix Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell in pixels.
HeightPix
Returns the height of the cell in pixels.
Span
Returns the number of columns that the cell occupies. If [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) is allowed and the cell merges into an adjacent column, a cell can span more than one column.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) method is used to return the dimensions of the cell graphic. The Cell.[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) method returns the dimensions of the cell text.
See Also SftTreeCell Object | Object Hierarchy
## GetPositionPix Method, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPositionPix*
Returns the coordinates of the footer.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in pixels.
HeightPix
Returns the height of the column footer in pixels.
Span
Returns the number of columns that the column footer occupies.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column footer is displayed and visible. |
| False | The column footer is not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the footer.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column footers, use [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPosition) instead.
See Also SftTreeFooter Object | Object Hierarchy
## GetPositionPix Method, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPositionPix*
Returns the coordinates of the combined row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) and all column footers.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the column footer in pixels.
HeightPix
Returns the height of the column footer in pixels.
Span
Returns the number of columns that the column footer occupies.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column footers are displayed and visible. |
| False | The column footers are not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the combined row/column footer and all column footers.
The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_GetPosition) method can be used to retrieve the coordinates of one column footer.
See Also SftTreeFooters Object | Object Hierarchy
## GetPositionPix Method, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPositionPix*
Returns the coordinates of the header.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**, **ByRef** *Span* **As Short**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**, *Span* **As Integer**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*, **out** **short** *Span*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **short*** *Span*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in pixels.
HeightPix
Returns the height of the column header in pixels.
Span
Returns the number of columns that the column header occupies.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column header is displayed and visible. |
| False | The column header is not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the header.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column headers, use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) instead.
See Also SftTreeHeader Object | Object Hierarchy
## GetPositionPix Method, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPositionPix*
Returns the coordinates of the combined row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and all column headers.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the column header in pixels.
HeightPix
Returns the height of the column header in pixels.
Span
Returns the number of columns that the column header occupies.
Boolean
| Boolean | Description |
| --- | --- |
| True | The column headers are displayed and visible. |
| False | The column headers are not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the combined row/column header and all column headers.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_GetPosition) method can be used to retrieve the coordinates of one column header.
See Also SftTreeHeaders Object | Object Hierarchy
## GetPositionPix Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPositionPix*
Returns the coordinates of the item.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the item in pixels.
HeightPix
Returns the height of the item in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The item is displayed and visible. |
| False | The item is not visible. The returned coordinates are not valid. |
### Comments
The GetPositionPix method returns the coordinates of the item.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
The position returned includes the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (if present). The width of the row header area can be determined using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTreeItem Object | Object Hierarchy
## GetPositionPix Method, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPositionPix*
Returns the coordinates of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) |
| VB | *object*.**GetPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) |
| C#.NET | **void** *object*.**GetPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **HRESULT** *object*->**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the splitter bar in pixels.
HeightPix
Returns the height of the splitter bar in pixels.
### Comments
The GetPositionPix method returns the coordinates of the splitter bar.
The [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition) and GetPositionPix methods are synonyms, but may use different coordinate systems.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to define the width of the splitter bar. The Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) defines the horizontal position of the splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## GetPrevShown Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetPrevShown*
Returns the index of the previous [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *PrevItemIndex* = *object*.**GetPrevShown**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *PrevItemIndex* = *object*.**GetPrevShown**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *PrevItemIndex* = *object*.**GetPrevShown**(**int** *ItemIndex*); |
| VC++ | **long** *PrevItemIndex* = *object*->**GetPrevShown**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**GetPrevShown**(**long** *ItemIndex*, **long*** *PrevItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index whose previous item is to be retrieved. If -1 is specified, the index of the last visible item in the tree control is returned.
PrevItemIndex
Returns the zero-based index of the previous visible item given an item *ItemIndex*. If -1 is returned, if no item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.LastShown and Item.PrevShown instead
The GetPrevShown method returns the index of the previous visible item.
Dependent items of a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item are skipped using this method.
Use Items.[FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown), Item.[NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown), Item.PrevShown, Items.LastShown to retrieve information about item visibility.
See Also SftTree Object | Object Hierarchy
## GetSplitterPos Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPos*
Returns the coordinates of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetSplitterPos**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) |
| VB | *object*.**GetSplitterPos**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) |
| C#.NET | **void** *object*.**GetSplitterPos**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **HRESULT** *object*->**GetSplitterPos**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetSplitterPos**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the splitter bar. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the splitter bar. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.GetPosition instead
The GetSplitterPos method returns the coordinates of the splitter bar.
The GetSplitterPos and [GetSplitterPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPosPix) methods are synonyms, but may use different coordinate systems.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to define the width of the splitter bar. The Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) defines the horizontal position of the splitter bar.
See Also SftTree Object | Object Hierarchy
## GetSplitterPosPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPosPix*
Returns the coordinates of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPositionPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**GetSplitterPosPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) |
| VB | *object*.**GetSplitterPosPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) |
| C#.NET | **void** *object*.**GetSplitterPosPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **HRESULT** *object*->**GetSplitterPosPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetSplitterPosPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the splitter bar in pixels.
HeightPix
Returns the height of the splitter bar in pixels.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.GetPositionPix instead
The GetSplitterPosPix method returns the coordinates of the splitter bar.
The [GetSplitterPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetSplitterPos) and GetSplitterPosPix methods are synonyms, but may use different coordinate systems.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to define the width of the splitter bar. The Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) defines the horizontal position of the splitter bar.
See Also SftTree Object | Object Hierarchy
## GetTextPosition Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetTextPosition**(**ByRef** *Left* **As Single**, **ByRef** *Top* **As Single**, **ByRef** *Width* **As Single**, **ByRef** *Height* **As Single**) **As Boolean** |
| VB | *Boolean* = *object*.**GetTextPosition**(*Left* **As Single**, *Top* **As Single**, *Width* **As Single**, *Height* **As Single**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetTextPosition**(**out** **float** *Left*, **out** **float** *Top*, **out** **float** *Width*, **out** **float** *Height*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetTextPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*); |
| C | **HRESULT** *object*->raw_**GetTextPosition**(**float*** *Left*, **float*** *Top*, **float*** *Width*, **float*** *Height*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Left
Returns the horizontal position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Top
Returns the vertical position relative to the top, left corner of the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Width
Returns the width of the cell text. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Height
Returns the height of the cell text. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetTextPosition method returns the coordinates of the cell text.
The GetTextPosition and [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetTextPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix) methods are synonyms, but may use different coordinate systems.
The Cell.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPosition) method is used to return the overall dimensions of the cell. The Cell.[GetImagePosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePosition) method returns the dimensions of the cell graphic.
See Also SftTreeCell Object | Object Hierarchy
## GetTextPositionPix Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPositionPix*
Returns the coordinates of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
### Syntax
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**GetTextPositionPix**(**ByRef** *LeftPix* **As OLE_XPOS_PIXELS**, **ByRef** *TopPix* **As OLE_YPOS_PIXELS**, **ByRef** *WidthPix* **As OLE_XSIZE_PIXELS**, **ByRef** *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| VB | *Boolean* = *object*.**GetTextPositionPix**(*LeftPix* **As OLE_XPOS_PIXELS**, *TopPix* **As OLE_YPOS_PIXELS**, *WidthPix* **As OLE_XSIZE_PIXELS**, *HeightPix* **As OLE_YSIZE_PIXELS**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**GetTextPositionPix**(**out** **OLE_XPOS_PIXELS** *LeftPix*, **out** **OLE_YPOS_PIXELS** *TopPix*, **out** **OLE_XSIZE_PIXELS** *WidthPix*, **out** **OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**GetTextPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*); |
| C | **HRESULT** *object*->raw_**GetTextPositionPix**(**OLE_XPOS_PIXELS*** *LeftPix*, **OLE_YPOS_PIXELS*** *TopPix*, **OLE_XSIZE_PIXELS*** *WidthPix*, **OLE_YSIZE_PIXELS*** *HeightPix*, **VARIANT_BOOL*** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the cell text in pixels.
HeightPix
Returns the height of the cell text in pixels.
Boolean
| Boolean | Description |
| --- | --- |
| True | The cell is displayed and visible. |
| False | The cell is not visible. The returned coordinates are not valid. |
### Comments
The GetTextPositionPix method returns the coordinates of the cell text.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[GetTextPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetTextPosition) and GetTextPositionPix methods are synonyms, but may use different coordinate systems.
The Cell.[GetPositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetPositionPix) method is used to return the overall dimensions of the cell. The Cell.[GetImagePositionPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_GetImagePositionPix) method returns the dimensions of the cell graphic.
See Also SftTreeCell Object | Object Hierarchy
## GrayedColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GrayedColor*
Defines the text color used to draw items that are disabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw items that are disabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.GrayedColor instead
The GrayedColor property defines the text color used to draw items that are disabled.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property.
Individual [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color for disabled items using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property.
See Also SftTree Object | Object Hierarchy
## GrayedColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_GrayedColor*
Defines the text color used to draw all disabled [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the text color used to draw all disabled column footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw all disabled column footers.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled) property is used to enable and disable individual column footers.
All column footers use the same grayed text color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeFooters Object | Object Hierarchy
## GrayedColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_GrayedColor*
Defines the text color used to draw all disabled [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the text color used to draw all disabled column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw all disabled column headers.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property is used to enable and disable individual column headers.
All column headers use the same grayed text color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeHeaders Object | Object Hierarchy
## GrayedColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor*
Defines the text color used to draw items that are disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the text color used to draw items that are disabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw items that are disabled.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property.
Individual [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color for disabled items using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property.
See Also SftTreeItems Object | Object Hierarchy
## GrayedColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_GrayedColor*
Defines the text color used to draw a disabled row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the text color used to draw a disabled row/column footer. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw a disabled row/column footer.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## GrayedColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor*
Defines the text color used to draw a disabled row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the text color used to draw a disabled row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw a disabled row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## GrayedColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor*
Defines the text color used to draw disabled [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**GrayedColor**(); |
| C | **HRESULT** *object*->get_**GrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**GrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GrayedColor** = *Clr*;
**void** *object*->Put**GrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the text color used to draw disabled row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GrayedColor property defines the text color used to draw disabled row headers.
Row headers can be disabled globally using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property, individual items can be disabled using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowHeaders Object | Object Hierarchy
## GridHorizontalColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridHorizontalColor*
Defines the color used to draw horizontal grid lines.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridHorizontalColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GridHorizontalColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GridHorizontalColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**GridHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GridHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**GridHorizontalColor**(); |
| C | **HRESULT** *object*->get_**GridHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridHorizontalColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**GridHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**GridHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GridHorizontalColor** = *Clr*;
**void** *object*->Put**GridHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GridHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw horizontal grid lines. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.GridHorizontalColor instead
The GridHorizontalColor property defines the color used to draw horizontal grid lines.
Based on the Items.[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) property, grid lines are displayed using the specified color *Clr*.
See Also SftTree Object | Object Hierarchy
## GridHorizontalColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridHorizontalColor*
Defines the color used to draw horizontal grid lines.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GridHorizontalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GridHorizontalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GridHorizontalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GridHorizontalColor**;
**OLE_COLOR** *Clr* = *object*->Get**GridHorizontalColor**(); |
| C | **HRESULT** *object*->get_**GridHorizontalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridHorizontalColor** = *Clr* **As UInteger** |
| VB | *object*.**GridHorizontalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GridHorizontalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GridHorizontalColor** = *Clr*;
**void** *object*->Put**GridHorizontalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GridHorizontalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw horizontal grid lines. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GridHorizontalColor property defines the color used to draw horizontal grid lines.
Based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) property, grid lines are displayed using the specified color *Clr*. If *Clr* is set to -1, a suitable default color is used based on the operating system and current Windows theme used.
See Also SftTreeItems Object | Object Hierarchy
## GridStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridStyle*
Defines the method used to paint grid lines.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**GridStyle** **As [SftTreeGridStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeGridStyleConstants)** |
| VB | *Style* = *object*.**GridStyle** **As SftTreeGridStyleConstants** |
| C#.NET | **SftTreeGridStyleConstants** *Style* = *object*.**GridStyle**; |
| VC++ | **enum SftTreeGridStyleConstants** *Style* = *object*->**GridStyle**;
**enum SftTreeGridStyleConstants** *Style* = *object*->Get**GridStyle**(); |
| C | **HRESULT** *object*->get_**GridStyle**(**enum SftTreeGridStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridStyle** = *Style* **As SftTreeGridStyleConstants** |
| VB | *object*.**GridStyle** = *Style* **As SftTreeGridStyleConstants** |
| C#.NET | **SftTreeGridStyleConstants** *object*.**GridStyle** = *Style*; |
| VC++ | **enum SftTreeGridStyleConstants** *object*->**GridStyle** = *Style*;
**void** *object*->Put**GridStyle**(**enum SftTreeGridStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**GridStyle**(**enum SftTreeGridStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the method used to paint grid lines.
| Style | Value | Description |
| --- | --- | --- |
| gridSftTreeNone | 0 | No grid lines are drawn. |
| gridSftTreeVert | 1 | Vertical grid lines are drawn between columns. |
| gridSftTreeHorz | 2 | Horizontal grid lines are drawn between items. |
| gridSftTreeBoth | 3 | Vertical and horizontal grid lines are drawn. |
| gridSftTreeVertDot | 4 | Vertical dotted grid lines are drawn between columns. |
| gridSftTreeHorzDot | 5 | Horizontal dotted grid lines are drawn between items. |
| gridSftTreeBothDot | 6 | Vertical dotted and horizontal grid lines are drawn. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.GridStyle instead
The GridStyle property defines the method used to paint grid lines.
Horizontal grid lines are not drawn if the Items.[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is set to True.
The grid line colors can be modified using the Items.[GridHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridHorizontalColor) and Items.[GridVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridVerticalColor) properties.
The size of [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) when grid lines are used can be defined using the Items.[ToolTipsUseEntireCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipsUseEntireCell) property.
See Also SftTree Object | Object Hierarchy
## GridStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle*
Defines the method used to paint grid lines.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**GridStyle** **As [SftTreeGridStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeGridStyleConstants)** |
| VB | *Style* = *object*.**GridStyle** **As SftTreeGridStyleConstants** |
| C#.NET | **SftTreeGridStyleConstants** *Style* = *object*.**GridStyle**; |
| VC++ | **enum SftTreeGridStyleConstants** *Style* = *object*->**GridStyle**;
**enum SftTreeGridStyleConstants** *Style* = *object*->Get**GridStyle**(); |
| C | **HRESULT** *object*->get_**GridStyle**(**enum SftTreeGridStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridStyle** = *Style* **As SftTreeGridStyleConstants** |
| VB | *object*.**GridStyle** = *Style* **As SftTreeGridStyleConstants** |
| C#.NET | **SftTreeGridStyleConstants** *object*.**GridStyle** = *Style*; |
| VC++ | **enum SftTreeGridStyleConstants** *object*->**GridStyle** = *Style*;
**void** *object*->Put**GridStyle**(**enum SftTreeGridStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**GridStyle**(**enum SftTreeGridStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the method used to paint grid lines.
| Style | Value | Description |
| --- | --- | --- |
| gridSftTreeNone | 0 | No grid lines are drawn. |
| gridSftTreeVert | 1 | Vertical grid lines are drawn between columns. |
| gridSftTreeHorz | 2 | Horizontal grid lines are drawn between items. |
| gridSftTreeBoth | 3 | Vertical and horizontal grid lines are drawn. |
| gridSftTreeVertDot | 4 | Vertical dotted grid lines are drawn between columns. |
| gridSftTreeHorzDot | 5 | Horizontal dotted grid lines are drawn between items. |
| gridSftTreeBothDot | 6 | Vertical and horizontal dotted grid lines are drawn. |
| gridSftTreeHorzExtendRight | 7 | Horizontal grid lines are drawn and extend to the right edge of the control (beyond the end of the last column). |
| gridSftTreeBothExtendRight | 8 | Vertical and horizontal grid lines are drawn and extend to the right edge of the control (beyond the end of the last column). |
| gridSftTreeHorzDotExtendRight | 9 | Horizontal dotted grid lines are drawn and extend to the right edge of the control (beyond the end of the last column). |
| gridSftTreeBothDotExtendRight | 10 | Vertical and horizontal dotted grid lines are drawn and extend to the right edge of the control (beyond the end of the last column). |
### Comments
The GridStyle property defines the method used to paint grid lines.
Horizontal grid lines are not drawn if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is set to True.
Vertical grid lines are not drawn if all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) have no header text [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text) (except for the first column) and all [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are marked for [cell merging](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging), in which case all cells are handled as one (visually) contiguous cell, even if each cell has individual cell text [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text).
The grid line colors can be modified using the Items.[GridHorizontalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridHorizontalColor) and Items.[GridVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridVerticalColor) properties.
The size of [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) when grid lines are used can be defined using the Items.[ToolTipsUseEntireCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipsUseEntireCell) property.
See Also SftTreeItems Object | Object Hierarchy
## GridVerticalColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GridVerticalColor*
Defines the color used to draw vertical grid lines.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridVerticalColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridVerticalColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GridVerticalColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GridVerticalColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**GridVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GridVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**GridVerticalColor**(); |
| C | **HRESULT** *object*->get_**GridVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridVerticalColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**GridVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**GridVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GridVerticalColor** = *Clr*;
**void** *object*->Put**GridVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GridVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw vertical grid lines. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.GridVerticalColor instead
The GridVerticalColor property defines the color used to draw vertical grid lines.
Based on the Items.[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) property, grid lines are displayed using the specified color *Clr*.
See Also SftTree Object | Object Hierarchy
## GridVerticalColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridVerticalColor*
Defines the color used to draw vertical grid lines.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**GridVerticalColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**GridVerticalColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**GridVerticalColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**GridVerticalColor**;
**OLE_COLOR** *Clr* = *object*->Get**GridVerticalColor**(); |
| C | **HRESULT** *object*->get_**GridVerticalColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**GridVerticalColor** = *Clr* **As UInteger** |
| VB | *object*.**GridVerticalColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**GridVerticalColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**GridVerticalColor** = *Clr*;
**void** *object*->Put**GridVerticalColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**GridVerticalColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw vertical grid lines. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The GridVerticalColor property defines the color used to draw vertical grid lines.
Based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle) property, grid lines are displayed using the specified color *Clr*. If *Clr* is set to -1, a suitable default color is used based on the operating system and current Windows theme used.
See Also SftTreeItems Object | Object Hierarchy
## HandleReturn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HandleReturn*
Defines whether the control accepts and handles the RETURN key.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**HandleReturn** **As Boolean** |
| VB | *Boolean* = *object*.**HandleReturn** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**HandleReturn**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**HandleReturn**;
**VARIANT_BOOL** *Boolean* = *object*->Get**HandleReturn**(); |
| C | **HRESULT** *object*->get_**HandleReturn**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HandleReturn** = *Boolean* **As Boolean** |
| VB | *object*.**HandleReturn** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**HandleReturn** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**HandleReturn** = *Boolean*;
**void** *object*->Put**HandleReturn**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**HandleReturn**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the control accepts and handles the RETURN key.
| Boolean | Description |
| --- | --- |
| True | The control accepts and handles the RETURN key. The RETURN key is equivalent to double-clicking an item, resulting in an [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) event with *AreaType* = [constSftTreeText](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAreaTypeConstants) (also see [AutoRespond](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AutoRespond)). |
| False | The control ignores the RETURN key. This allows an enclosing form's default button to respond to the RETURN key instead. |
### Comments
The HandleReturn property defines whether the control accepts and handles the RETURN key.
See Also SftTree Object | Object Hierarchy
## Header Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header*
Returns a [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object for a given column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refHeaderObj* = *object*.**Header**(**ByVal** *ColIndex* **As Short**) **As SftTreeHeader** |
| VB | **Set** *refHeaderObj* = *object*.**Header**(**ByVal** *ColIndex* **As Integer**) **As SftTreeHeader** |
| C#.NET | **SftTreeHeader** *refHeaderObj* = *object*.get_**Header**(**short** *ColIndex*); |
| VC++ | **ISftTreeHeader*** *refHeaderObj* = *object*->**Header**[**short** *ColIndex*];
**ISftTreeHeader*** *refHeaderObj* = *object*->Get**Header**(**short** *ColIndex*); |
| C | **HRESULT** *object*->get_**Header**(**short** *ColIndex*, **ISftTreeHeader**** *refHeaderObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number.
refHeaderObj
Returns a SftTreeHeader object for a given column.
### Comments
The Header property returns a SftTreeHeader object for a given column.
The SftTreeHeader object represents one [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. Numerous header-specific properties and methods can be accessed using the returned object * refHeaderObj*.
Certain default properties and behavior for all column headers can be defined using the [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
See Also SftTree Object | Object Hierarchy
## Headers Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers*
Returns the [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refHeadersObj* = *object*.**Headers** **As SftTreeHeaders** |
| VB | **Set** *refHeadersObj* = *object*.**Headers** **As SftTreeHeaders** |
| C#.NET | **SftTreeHeaders** *refHeadersObj* = *object*.**Headers**; |
| VC++ | **ISftTreeHeaders*** *refHeadersObj* = *object*->**Headers**;
**ISftTreeHeaders*** *refHeadersObj* = *object*->Get**Headers**(); |
| C | **HRESULT** *object*->get_**Headers**(**ISftTreeHeaders**** *refHeadersObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refHeadersObj
Returns the SftTreeHeaders object.
### Comments
The Headers property returns the SftTreeHeaders object.
The SftTreeHeaders object describes attributes that apply to all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object * refHeadersObj*. A control has only one SftTreeHeaders object.
An individual column's [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object can be accessed through the control's [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header) property.
See Also SftTree Object | Object Hierarchy
## Height Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height*
Defines the desired image height.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *HPix* = *object*.**Height** **As Integer** |
| VB | *HPix* = *object*.**Height** **As Long** |
| C#.NET | **int** *HPix* = *object*.**Height**; |
| VC++ | **long** *HPix* = *object*->**Height**;
**long** *HPix* = *object*->Get**Height**(); |
| C | **HRESULT** *object*->get_**Height**(**long*** *HPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Height** = *HPix* **As Integer** |
| VB | *object*.**Height** = *HPix* **As Long** |
| C#.NET | **int** *object*.**Height** = *HPix*; |
| VC++ | **long** *object*->**Height** = *HPix*;
**void** *object*->Put**Height**(**long** *HPix*); |
| C | **HRESULT** *object*->put_**Height**(**long** *HPix*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
HPix
Defines the desired image height.
### Comments
The Height property defines the desired image height.
The desired image height is only used for built-in images (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) is [sftTypeBuiltin](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)) and color samples (SftPictureObject.Type is sftTypeColorSample). For all image types, the SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image dimensions.
See Also SftPictureObject Object | Object Hierarchy
## Height Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height*
Returns the item's height.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *h* = *object*.**Height** **As Single** |
| VB | *h* = *object*.**Height** **As Single** |
| C#.NET | **float** *h* = *object*.**Height**; |
| VC++ | **float** *h* = *object*->**Height**;
**float** *h* = *object*->Get**Height**(); |
| C | **HRESULT** *object*->get_**Height**(**float*** *h*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
h
Returns the item's height. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Height property returns the item's height.
The Height and [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[HeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_HeightPix) methods are synonyms, but may use different coordinate systems.
In a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items have the same height. Items.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) can be used to determine the height of items in a fixed height tree control.
See Also SftTreeItem Object | Object Hierarchy
## Height Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height*
Returns the height of an item in a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *h* = *object*.**Height** **As Single** |
| VB | *h* = *object*.**Height** **As Single** |
| C#.NET | **float** *h* = *object*.**Height**; |
| VC++ | **float** *h* = *object*->**Height**;
**float** *h* = *object*->Get**Height**(); |
| C | **HRESULT** *object*->get_**Height**(**float*** *h*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
h
Returns the height of an item in a fixed height tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Height property returns the height of an item in a fixed height tree control.
The Height and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HeightPix) properties are synonyms, but may use different coordinate systems.
The Height property applies to a fixed height tree control only (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). In a variable height tree control, the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) property can be used instead.
See Also SftTreeItems Object | Object Hierarchy
## HeightPix Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_HeightPix*
Returns the item's height.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *HPix* = *object*.**HeightPix** **As Integer** |
| VB | *HPix* = *object*.**HeightPix** **As Long** |
| C#.NET | **int** *HPix* = *object*.**HeightPix**; |
| VC++ | **long** *HPix* = *object*->**HeightPix**;
**long** *HPix* = *object*->Get**HeightPix**(); |
| C | **HRESULT** *object*->get_**HeightPix**(**long*** *HPix*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
HPix
Returns the item's height in pixels.
### Comments
The HeightPix property returns the item's height.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) and HeightPix methods are synonyms, but may use different coordinate systems.
In a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items have the same height. Items.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) can be used to determine the height of items in a fixed height tree control.
See Also SftTreeItem Object | Object Hierarchy
## HeightPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HeightPix*
Returns the height of an item in a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *HPix* = *object*.**HeightPix** **As Integer** |
| VB | *HPix* = *object*.**HeightPix** **As Long** |
| C#.NET | **int** *HPix* = *object*.**HeightPix**; |
| VC++ | **long** *HPix* = *object*->**HeightPix**;
**long** *HPix* = *object*->Get**HeightPix**(); |
| C | **HRESULT** *object*->get_**HeightPix**(**long*** *HPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
HPix
Returns the height of an item in a fixed height tree control in pixels.
### Comments
The HeightPix property returns the height of an item in a fixed height tree control.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) and HeightPix properties are synonyms, but may use different coordinate systems.
The HeightPix property applies to a fixed height tree control only (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). In a variable height tree control, the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) property can be used instead.
See Also SftTreeItems Object | Object Hierarchy
## HideExpandCollapseButton Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_HideExpandCollapseButton*
Defines whether the item's [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) is hidden.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**HideExpandCollapseButton** **As Boolean** |
| VB | *Boolean* = *object*.**HideExpandCollapseButton** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**HideExpandCollapseButton**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**HideExpandCollapseButton**;
**VARIANT_BOOL** *Boolean* = *object*->Get**HideExpandCollapseButton**(); |
| C | **HRESULT** *object*->get_**HideExpandCollapseButton**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HideExpandCollapseButton** = *Boolean* **As Boolean** |
| VB | *object*.**HideExpandCollapseButton** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**HideExpandCollapseButton** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**HideExpandCollapseButton** = *Boolean*;
**void** *object*->Put**HideExpandCollapseButton**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**HideExpandCollapseButton**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item's expand/collapse button is hidden.
| Boolean | Description |
| --- | --- |
| True | The item's expand/collapse button is hidden. |
| False | The item's expand/collapse button is shown. |
### Comments
The HideExpandCollapseButton property defines whether the item's expand/collapse button is hidden.
If the item is not [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) and doesn't have an expand/collapse button, this property has no effect.
The [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle) property defines the expand/collapse button display method for all items.
See Also SftTreeItem Object | Object Hierarchy
## HighContrastActive Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastActive*
Returns whether [high contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) is currently active.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**HighContrastActive** **As Boolean** |
| VB | *Boolean* = *object*.**HighContrastActive** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**HighContrastActive**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**HighContrastActive**;
**VARIANT_BOOL** *Boolean* = *object*->Get**HighContrastActive**(); |
| C | **HRESULT** *object*->get_**HighContrastActive**(**VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Returns whether high contrast is currently active.
| Boolean | Description |
| --- | --- |
| True | High contrast rendering is currently active. |
| False | High contrast rendering is not active. |
### Comments
The HighContrastActive property returns whether high contrast is currently active.
The high contrast setting is defined using the [HighContrastMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastMode) property.
See Also SftTree Object | Object Hierarchy | HighContrastMode | [HighContrastChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_HighContrastChange) | High Contrast
## HighContrastChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_HighContrastChange*
The effective [high contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) state has changed (Automatic high contrast only).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**HighContrastChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**HighContrastChange** |
| VB | **Private Sub** *object*_**HighContrastChange**(**ByVal** *Active* **As Boolean**) |
| C#.NET | **void** *object*_**HighContrastChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**HighContrastChange***object*(**VARIANT_BOOL** *Active*); |
| C | **HRESULT** On**HighContrastChange***object*(**VARIANT_BOOL** *Active*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Active
The new effective high contrast state (True if high contrast is now active).
### Comments
The HighContrastChange event occurs when the effective high contrast state changes while [HighContrastMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastMode) is set to [highContrastSftTreeAuto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHighContrastConstants) and the user changes the Windows High Contrast setting.
See Also SftTree Object | Object Hierarchy | HighContrastMode | [HighContrastActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastActive) | High Contrast
## HighContrastMode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastMode*
Defines the [high contrast](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_highcontrast) setting (off, on, or following the Windows setting).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Mode* = *object*.**HighContrastMode** **As [SftTreeHighContrastConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHighContrastConstants)** |
| VB | *Mode* = *object*.**HighContrastMode** **As SftTreeHighContrastConstants** |
| C#.NET | **SftTreeHighContrastConstants** *Mode* = *object*.**HighContrastMode**; |
| VC++ | **enum SftTreeHighContrastConstants** *Mode* = *object*->**HighContrastMode**;
**enum SftTreeHighContrastConstants** *Mode* = *object*->Get**HighContrastMode**(); |
| C | **HRESULT** *object*->get_**HighContrastMode**(**enum SftTreeHighContrastConstants*** *Mode*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HighContrastMode** = *Mode* **As SftTreeHighContrastConstants** |
| VB | *object*.**HighContrastMode** = *Mode* **As SftTreeHighContrastConstants** |
| C#.NET | **SftTreeHighContrastConstants** *object*.**HighContrastMode** = *Mode*; |
| VC++ | **enum SftTreeHighContrastConstants** *object*->**HighContrastMode** = *Mode*;
**void** *object*->Put**HighContrastMode**(**enum SftTreeHighContrastConstants** *Mode*); |
| C | **HRESULT** *object*->put_**HighContrastMode**(**enum SftTreeHighContrastConstants** *Mode*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Mode
Defines the high contrast setting (off, on, or following the Windows setting).
| Name | Value | Description |
| --- | --- | --- |
| highContrastSftTreeOff | 0 | Ignore the Windows High Contrast setting and render normally (the default). |
| highContrastSftTreeOn | 1 | Always use the system palette. |
| highContrastSftTreeAuto | 2 | Follow the Windows High Contrast setting. |
### Comments
The HighContrastMode property defines the high contrast setting (off, on, or following the Windows setting).
When set to highContrastSftTreeAuto, the control follows the Windows High Contrast [accessibility](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_accessibility) setting and re-renders automatically; the [HighContrastChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_HighContrastChange) event is raised when the effective state changes.
Use [HighContrastActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HighContrastActive) to determine whether high contrast is currently active.
See Also SftTree Object | Object Hierarchy | High Contrast
## HilightColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HilightColor*
Defines the color used to draw the highlighted edge of items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HilightColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the highlighted edge of items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HilightColor instead
The HilightColor property defines the color used to draw the highlighted edge of items.
Highlighted item edges are only used if the Items.[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is set to True.
See Also SftTree Object | Object Hierarchy
## HilightColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_HilightColor*
Defines the color used to draw the highlighted edge of all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the color used to draw the highlighted edge of all column footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the color used to draw the highlighted edge of all column footers.
All column footers use the same highlight color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeFooters Object | Object Hierarchy
## HilightColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_HilightColor*
Defines the color used to draw the highlighted edge of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the color used to draw the highlighted edge of all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the color used to draw the highlighted edge of all column headers.
All column headers use the same highlight color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeHeaders Object | Object Hierarchy
## HilightColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HilightColor*
Defines the color used to draw the highlighted edge of items.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw the highlighted edge of items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the color used to draw the highlighted edge of items.
Highlighted item edges are only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is set to True.
See Also SftTreeItems Object | Object Hierarchy
## HilightColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_HilightColor*
Defines the color used to draw the highlighted edge of the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the color used to draw the highlighted edge of the row/column footer. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the color used to draw the highlighted edge of the row/column footer.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## HilightColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_HilightColor*
Defines the color used to draw the highlighted edge of the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the color used to draw the highlighted edge of the row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the color used to draw the highlighted edge of the row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## HilightColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_HilightColor*
Defines the default color used to draw the highlighted edge of [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HilightColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HilightColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**HilightColor**(); |
| C | **HRESULT** *object*->get_**HilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HilightColor** = *Clr* **As UInteger** |
| VB | *object*.**HilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HilightColor** = *Clr*;
**void** *object*->Put**HilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default color used to draw the highlighted edge of row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The HilightColor property defines the default color used to draw the highlighted edge of row headers.
All row headers use the same highlight color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowHeaders Object | Object Hierarchy
## HitTest Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTest*
Returns the index of the item found at given coordinates.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**HitTest**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**) **As Integer** |
| VB | *ItemIndex* = *object*.**HitTest**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**HitTest**(**float** *xPos*, **float** *yPos*); |
| VC++ | **long** *ItemIndex* = *object*->**HitTest**(**float** *xPos*, **float** *yPos*); |
| C | **HRESULT** *object*->raw_**HitTest**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
xPos
The x coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The y coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
ItemIndex
Returns the zero-based index of the item found at the specified coordinates. -1 is returned if no item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HitTest instead
The HitTest method returns the index of the item found at given coordinates.
The HitTest and [HitTestPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTestPix) methods are synonyms, but may use different coordinate systems.
If an item is found at the coordinates (*xPos*, *yPos*), the zero-based index of the item is returned. If the specified coordinates are located in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) or column header area, -1 is returned. If the coordinates are located in the tree control's client area, below the last item displayed, the zero-based index of the last item + 1 is returned, which is equal to the number of items in the tree control.
The HitTest method can be used during a DragOver or [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event to determine which item is currently the target of the [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. The [CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) or [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) methods can also be used.
See Also SftTree Object | Object Hierarchy
## HitTest Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest*
Returns the index of the item found at given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**HitTest**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**) **As Integer** |
| VB | *ItemIndex* = *object*.**HitTest**(**ByVal** *xPos* **As Single**, **ByVal** *yPos* **As Single**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**HitTest**(**float** *xPos*, **float** *yPos*); |
| VC++ | **long** *ItemIndex* = *object*->**HitTest**(**float** *xPos*, **float** *yPos*); |
| C | **HRESULT** *object*->raw_**HitTest**(**float** *xPos*, **float** *yPos*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
xPos
The x coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The y coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
ItemIndex
Returns the zero-based index of the item found at the specified coordinates. -1 is returned if no item is found.
### Comments
The HitTest method returns the index of the item found at given coordinates.
The HitTest and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HitTestPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTestPix) methods are synonyms, but may use different coordinate systems.
If an item is found at the coordinates (*xPos*, *yPos*), the zero-based index of the item is returned. If the specified coordinates are located in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) or column header area, -1 is returned. If the coordinates are located in the tree control's client area, below the last item displayed, the zero-based index of the last item + 1 is returned, which is equal to the number of items in the tree control.
The HitTest method can be used during a DragOver or [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event to determine which item is currently the target of the [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. The [CalcCellFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPos) or [CalcIndexFromPos](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPos) methods can also be used.
See Also SftTreeItems Object | Object Hierarchy
## HitTestPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTestPix*
Returns the index of the item found at given coordinates.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HitTestPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTestPix) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**HitTestPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**) **As Integer** |
| VB | *ItemIndex* = *object*.**HitTestPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*); |
| VC++ | **long** *ItemIndex* = *object*->**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*); |
| C | **HRESULT** *object*->raw_**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
XPosPix
The x coordinate to be tested in pixels.
YPosPix
The y coordinate to be tested in pixels.
ItemIndex
Returns the index of the item found at given coordinates. -1 is returned if no item is found.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HitTestPix instead
The HitTestPix method returns the index of the item found at given coordinates.
The [HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HitTest) and HitTestPix methods are synonyms, but may use different coordinate systems.
If an item is found at the coordinates (*xPosPix*, *yPosPix*), the zero-based index of the item is returned. If the specified coordinates are located in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) or column header area, -1 is returned. If the coordinates are located in the tree control's client area, below the last item displayed, the zero-based index of the last item + 1 is returned, which is equal to the number of items in the tree control.
The HitTestPix method can be used during a DragOver or [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event to determine which item is currently the target of the [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. The [CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) or [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) methods can also be used.
See Also SftTree Object | Object Hierarchy
## HitTestPix Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTestPix*
Returns the index of the item found at given coordinates.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**HitTestPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**) **As Integer** |
| VB | *ItemIndex* = *object*.**HitTestPix**(**ByVal** *XPosPix* **As OLE_XPOS_PIXELS**, **ByVal** *YPosPix* **As OLE_YPOS_PIXELS**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*); |
| VC++ | **long** *ItemIndex* = *object*->**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*); |
| C | **HRESULT** *object*->raw_**HitTestPix**(**OLE_XPOS_PIXELS** *XPosPix*, **OLE_YPOS_PIXELS** *YPosPix*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
XPosPix
The x coordinate to be tested in pixels.
YPosPix
The y coordinate to be tested in pixels.
ItemIndex
Returns the index of the item found at given coordinates. -1 is returned if no item is found.
### Comments
The HitTestPix method returns the index of the item found at given coordinates.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) and HitTestPix methods are synonyms, but may use different coordinate systems.
If an item is found at the coordinates (*xPosPix*, *yPosPix*), the zero-based index of the item is returned. If the specified coordinates are located in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) or column header area, -1 is returned. If the coordinates are located in the tree control's client area, below the last item displayed, the zero-based index of the last item + 1 is returned, which is equal to the number of items in the tree control.
The HitTestPix method can be used during a DragOver or [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event to determine which item is currently the target of the [drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation. The [CalcCellFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcCellFromPosPix) or [CalcIndexFromPosPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CalcIndexFromPosPix) methods can also be used.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalExtent Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalExtent*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Extent* = *object*.**HorizontalExtent** **As Single** |
| VB | *Extent* = *object*.**HorizontalExtent** **As Single** |
| C#.NET | **float** *Extent* = *object*.**HorizontalExtent**; |
| VC++ | **float** *Extent* = *object*->**HorizontalExtent**;
**float** *Extent* = *object*->Get**HorizontalExtent**(); |
| C | **HRESULT** *object*->get_**HorizontalExtent**(**float*** *Extent*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtent** = *Extent* **As Single** |
| VB | *object*.**HorizontalExtent** = *Extent* **As Single** |
| C#.NET | **float** *object*.**HorizontalExtent** = *Extent*; |
| VC++ | **float** *object*->**HorizontalExtent** = *Extent*;
**void** *object*->Put**HorizontalExtent**(**float** *Extent*); |
| C | **HRESULT** *object*->put_**HorizontalExtent**(**float** *Extent*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Extent
Defines the current horizontal scrolling extent. If this value is 0 (or less than the width of the tree control), horizontal scrolling is disabled. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HorizontalExtent instead
The HorizontalExtent property defines the current horizontal scrolling extent.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.HorizontalExtent property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width *Extent* set using this property must be equal to or greater than the combined column widths plus the width returned by the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property.
The HorizontalExtent property defines the horizontal extent of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent property have to be used again to recalculate or redefine the extent.
See Also SftTree Object | Object Hierarchy
## HorizontalExtent Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Extent* = *object*.**HorizontalExtent** **As Single** |
| VB | *Extent* = *object*.**HorizontalExtent** **As Single** |
| C#.NET | **float** *Extent* = *object*.**HorizontalExtent**; |
| VC++ | **float** *Extent* = *object*->**HorizontalExtent**;
**float** *Extent* = *object*->Get**HorizontalExtent**(); |
| C | **HRESULT** *object*->get_**HorizontalExtent**(**float*** *Extent*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtent** = *Extent* **As Single** |
| VB | *object*.**HorizontalExtent** = *Extent* **As Single** |
| C#.NET | **float** *object*.**HorizontalExtent** = *Extent*; |
| VC++ | **float** *object*->**HorizontalExtent** = *Extent*;
**void** *object*->Put**HorizontalExtent**(**float** *Extent*); |
| C | **HRESULT** *object*->put_**HorizontalExtent**(**float** *Extent*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Extent
Defines the current horizontal scrolling extent. If this value is 0 (or less than the width of the tree control), horizontal scrolling is disabled. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The HorizontalExtent property defines the current horizontal scrolling extent.
The HorizontalExtent and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtentPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtentPix) methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width * Extent* set using this property must be equal to or greater than the combined column widths plus the width returned by the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property.
The HorizontalExtent property defines the horizontal extent of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent property have to be used again to recalculate or redefine the extent.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalExtent2 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalExtent2*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Extent* = *object*.**HorizontalExtent2** **As Single** |
| VB | *Extent* = *object*.**HorizontalExtent2** **As Single** |
| C#.NET | **float** *Extent* = *object*.**HorizontalExtent2**; |
| VC++ | **float** *Extent* = *object*->**HorizontalExtent2**;
**float** *Extent* = *object*->Get**HorizontalExtent2**(); |
| C | **HRESULT** *object*->get_**HorizontalExtent2**(**float*** *Extent*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtent2** = *Extent* **As Single** |
| VB | *object*.**HorizontalExtent2** = *Extent* **As Single** |
| C#.NET | **float** *object*.**HorizontalExtent2** = *Extent*; |
| VC++ | **float** *object*->**HorizontalExtent2** = *Extent*;
**void** *object*->Put**HorizontalExtent2**(**float** *Extent*); |
| C | **HRESULT** *object*->put_**HorizontalExtent2**(**float** *Extent*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Extent
Defines the current horizontal scrolling extent in the right pane. If this value is 0 (or less than the width of the columns in the right pane of the tree control), horizontal scrolling is disabled. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HorizontalExtent2 instead
The HorizontalExtent2 property defines the current horizontal scrolling extent in the right pane.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width * Extent* set using this property must be equal to or greater than the combined column widths.
The Items.HorizontalExtent property defines the horizontal extent of the displayable area (or the left pane of a split tree control).
The Items.HorizontalExtent2 property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent2 property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent2 property have to be used again to recalculate or redefine the extent.
See Also SftTree Object | Object Hierarchy
## HorizontalExtent2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Extent* = *object*.**HorizontalExtent2** **As Single** |
| VB | *Extent* = *object*.**HorizontalExtent2** **As Single** |
| C#.NET | **float** *Extent* = *object*.**HorizontalExtent2**; |
| VC++ | **float** *Extent* = *object*->**HorizontalExtent2**;
**float** *Extent* = *object*->Get**HorizontalExtent2**(); |
| C | **HRESULT** *object*->get_**HorizontalExtent2**(**float*** *Extent*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtent2** = *Extent* **As Single** |
| VB | *object*.**HorizontalExtent2** = *Extent* **As Single** |
| C#.NET | **float** *object*.**HorizontalExtent2** = *Extent*; |
| VC++ | **float** *object*->**HorizontalExtent2** = *Extent*;
**void** *object*->Put**HorizontalExtent2**(**float** *Extent*); |
| C | **HRESULT** *object*->put_**HorizontalExtent2**(**float** *Extent*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Extent
Defines the current horizontal scrolling extent in the right pane. If this value is 0 (or less than the width of the columns in the right pane of the tree control), horizontal scrolling is disabled. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The HorizontalExtent2 property defines the current horizontal scrolling extent in the right pane.
The HorizontalExtent2 and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent2Pix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2Pix) methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width * Extent* set using this property must be equal to or greater than the combined column widths.
The Items.HorizontalExtent property defines the horizontal extent of the displayable area (or the left pane of a split tree control).
The Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent2 property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent2 property have to be used again to recalculate or redefine the extent.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalExtent2Pix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2Pix*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ExtentPix* = *object*.**HorizontalExtent2Pix** **As Integer** |
| VB | *ExtentPix* = *object*.**HorizontalExtent2Pix** **As Long** |
| C#.NET | **int** *ExtentPix* = *object*.**HorizontalExtent2Pix**; |
| VC++ | **long** *ExtentPix* = *object*->**HorizontalExtent2Pix**;
**long** *ExtentPix* = *object*->Get**HorizontalExtent2Pix**(); |
| C | **HRESULT** *object*->get_**HorizontalExtent2Pix**(**long*** *ExtentPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtent2Pix** = *ExtentPix* **As Integer** |
| VB | *object*.**HorizontalExtent2Pix** = *ExtentPix* **As Long** |
| C#.NET | **int** *object*.**HorizontalExtent2Pix** = *ExtentPix*; |
| VC++ | **long** *object*->**HorizontalExtent2Pix** = *ExtentPix*;
**void** *object*->Put**HorizontalExtent2Pix**(**long** *ExtentPix*); |
| C | **HRESULT** *object*->put_**HorizontalExtent2Pix**(**long** *ExtentPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ExtentPix
Defines the current horizontal scrolling extent in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in pixels. If this value is 0 (or less than the width of the columns in the right pane of the tree control), horizontal scrolling is disabled.
### Comments
The HorizontalExtent2Pix property defines the current horizontal scrolling extent.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) and HorizontalExtent2Pix methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width * Extent* set using this property must be equal to or greater than the combined column widths.
The Items.HorizontalExtent property defines the horizontal extent of the displayable area (or the left pane of a split tree control).
The Items.HorizontalExtent2 property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent2 property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent2 property have to be used again to recalculate or redefine the extent.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalExtentPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtentPix*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ExtentPix* = *object*.**HorizontalExtentPix** **As Integer** |
| VB | *ExtentPix* = *object*.**HorizontalExtentPix** **As Long** |
| C#.NET | **int** *ExtentPix* = *object*.**HorizontalExtentPix**; |
| VC++ | **long** *ExtentPix* = *object*->**HorizontalExtentPix**;
**long** *ExtentPix* = *object*->Get**HorizontalExtentPix**(); |
| C | **HRESULT** *object*->get_**HorizontalExtentPix**(**long*** *ExtentPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalExtentPix** = *ExtentPix* **As Integer** |
| VB | *object*.**HorizontalExtentPix** = *ExtentPix* **As Long** |
| C#.NET | **int** *object*.**HorizontalExtentPix** = *ExtentPix*; |
| VC++ | **long** *object*->**HorizontalExtentPix** = *ExtentPix*;
**void** *object*->Put**HorizontalExtentPix**(**long** *ExtentPix*); |
| C | **HRESULT** *object*->put_**HorizontalExtentPix**(**long** *ExtentPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ExtentPix
Defines the current horizontal scrolling extent in pixels. If this value is 0 (or less than the width of the tree control), horizontal scrolling is disabled.
### Comments
The HorizontalExtentPix property defines the current horizontal scrolling extent.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) and HorizontalExtentPix methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The width of the displayable area can be set by the application using the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method or the Items.HorizontalExtent property. For performance reasons, the optimal width is not automatically calculated when adding items to a tree control.
The width * Extent* set using this property must be equal to or greater than the combined column widths plus the width returned by the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property.
The Items.HorizontalExtent property defines the horizontal extent of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property defines the horizontal extent of the displayable area in the right pane of a split tree control. The Items.HorizontalExtent2 property can only be used with a split tree control.
If the width set is smaller than the actual window width, the control cannot be scrolled horizontally. The horizontal scroll bar will be disabled or hidden, based on the Scrollbars property.
By default, a tree control does not handle horizontal scrolling, even if the Scrollbars property defines scroll bars to be available. To start horizontal scrolling, an application has to use the Items.RecalcHorizontalExtent method or the Items.HorizontalExtent property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The Items.RecalcHorizontalExtent method or Items.HorizontalExtent property have to be used again to recalculate or redefine the extent.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalOffset Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalOffset*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* = *object*.**HorizontalOffset** **As Single** |
| VB | *Offset* = *object*.**HorizontalOffset** **As Single** |
| C#.NET | **float** *Offset* = *object*.**HorizontalOffset**; |
| VC++ | **float** *Offset* = *object*->**HorizontalOffset**;
**float** *Offset* = *object*->Get**HorizontalOffset**(); |
| C | **HRESULT** *object*->get_**HorizontalOffset**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffset** = *Offset* **As Single** |
| VB | *object*.**HorizontalOffset** = *Offset* **As Single** |
| C#.NET | **float** *object*.**HorizontalOffset** = *Offset*; |
| VC++ | **float** *object*->**HorizontalOffset** = *Offset*;
**void** *object*->Put**HorizontalOffset**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**HorizontalOffset**(**float** *Offset*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Offset
Defines the current horizontal scrolling offset. If this value is greater than the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property, the value is adjusted to scroll to the rightmost position. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HorizontalOffset instead
The HorizontalOffset property defines the current horizontal scrolling offset.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The HorizontalOffset property defines the horizontal scrolling offset of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The Items.HorizontalOffset2 property can only be used with a split tree control.
A tree control can only be scrolled horizontally if its displayable area (see Items.HorizontalExtent property) is wider than the tree control window.
See Also SftTree Object | Object Hierarchy
## HorizontalOffset Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* = *object*.**HorizontalOffset** **As Single** |
| VB | *Offset* = *object*.**HorizontalOffset** **As Single** |
| C#.NET | **float** *Offset* = *object*.**HorizontalOffset**; |
| VC++ | **float** *Offset* = *object*->**HorizontalOffset**;
**float** *Offset* = *object*->Get**HorizontalOffset**(); |
| C | **HRESULT** *object*->get_**HorizontalOffset**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffset** = *Offset* **As Single** |
| VB | *object*.**HorizontalOffset** = *Offset* **As Single** |
| C#.NET | **float** *object*.**HorizontalOffset** = *Offset*; |
| VC++ | **float** *object*->**HorizontalOffset** = *Offset*;
**void** *object*->Put**HorizontalOffset**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**HorizontalOffset**(**float** *Offset*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Offset
Defines the current horizontal scrolling offset. If this value is greater than the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property, the value is adjusted to scroll to the rightmost position. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The HorizontalOffset property defines the current horizontal scrolling offset.
The Items.HorizontalOffset and Items.[HorizontalOffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffsetPix) methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The Items.HorizontalOffset property defines the horizontal scrolling offset of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The Items.HorizontalOffset2 property can only be used with a split tree control.
A tree control can only be scrolled horizontally if its displayable area (see Items.HorizontalExtent property) is wider than the tree control window.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalOffset2 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_HorizontalOffset2*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* = *object*.**HorizontalOffset2** **As Single** |
| VB | *Offset* = *object*.**HorizontalOffset2** **As Single** |
| C#.NET | **float** *Offset* = *object*.**HorizontalOffset2**; |
| VC++ | **float** *Offset* = *object*->**HorizontalOffset2**;
**float** *Offset* = *object*->Get**HorizontalOffset2**(); |
| C | **HRESULT** *object*->get_**HorizontalOffset2**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffset2** = *Offset* **As Single** |
| VB | *object*.**HorizontalOffset2** = *Offset* **As Single** |
| C#.NET | **float** *object*.**HorizontalOffset2** = *Offset*; |
| VC++ | **float** *object*->**HorizontalOffset2** = *Offset*;
**void** *object*->Put**HorizontalOffset2**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**HorizontalOffset2**(**float** *Offset*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Offset
Defines the current horizontal scrolling offset in the right pane. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.HorizontalOffset2 instead
The HorizontalOffset2 property defines the current horizontal scrolling offset in the right pane.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The Items.[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) property defines the horizontal scrolling offset of the displayable area (or the left pane of a split tree control).
The Items.HorizontalOffset2 property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The Items.HorizontalOffset2 property can only be used with a split tree control.
The right pane of a split tree control can only be scrolled horizontally if its displayable area (see Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property) is wider than the right pane.
See Also SftTree Object | Object Hierarchy
## HorizontalOffset2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* = *object*.**HorizontalOffset2** **As Single** |
| VB | *Offset* = *object*.**HorizontalOffset2** **As Single** |
| C#.NET | **float** *Offset* = *object*.**HorizontalOffset2**; |
| VC++ | **float** *Offset* = *object*->**HorizontalOffset2**;
**float** *Offset* = *object*->Get**HorizontalOffset2**(); |
| C | **HRESULT** *object*->get_**HorizontalOffset2**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffset2** = *Offset* **As Single** |
| VB | *object*.**HorizontalOffset2** = *Offset* **As Single** |
| C#.NET | **float** *object*.**HorizontalOffset2** = *Offset*; |
| VC++ | **float** *object*->**HorizontalOffset2** = *Offset*;
**void** *object*->Put**HorizontalOffset2**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**HorizontalOffset2**(**float** *Offset*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Offset
Defines the current horizontal scrolling offset in the right pane. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The HorizontalOffset2 property defines the current horizontal scrolling offset in the right pane.
The HorizontalOffset2 and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalOffset2Pix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2Pix) methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The Items.[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) property defines the horizontal scrolling offset of the displayable area (or the left pane of a split tree control).
The HorizontalOffset2 property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The HorizontalOffset2 property can only be used with a split tree control.
The right pane of a split tree control can only be scrolled horizontally if its displayable area (see Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property) is wider than the right pane.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalOffset2Pix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2Pix*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[OffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix)* = *object*.**HorizontalOffset2Pix** **As Integer** |
| VB | *OffsetPix* = *object*.**HorizontalOffset2Pix** **As Long** |
| C#.NET | **int** *OffsetPix* = *object*.**HorizontalOffset2Pix**; |
| VC++ | **long** *OffsetPix* = *object*->**HorizontalOffset2Pix**;
**long** *OffsetPix* = *object*->Get**HorizontalOffset2Pix**(); |
| C | **HRESULT** *object*->get_**HorizontalOffset2Pix**(**long*** *OffsetPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffset2Pix** = *OffsetPix* **As Integer** |
| VB | *object*.**HorizontalOffset2Pix** = *OffsetPix* **As Long** |
| C#.NET | **int** *object*.**HorizontalOffset2Pix** = *OffsetPix*; |
| VC++ | **long** *object*->**HorizontalOffset2Pix** = *OffsetPix*;
**void** *object*->Put**HorizontalOffset2Pix**(**long** *OffsetPix*); |
| C | **HRESULT** *object*->put_**HorizontalOffset2Pix**(**long** *OffsetPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
OffsetPix
Defines the current horizontal scrolling offset in the right pane in pixels.
### Comments
The HorizontalOffset2Pix property defines the current horizontal scrolling offset in the right pane.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) and HorizontalOffset2Pix methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The Items.[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) property defines the horizontal scrolling offset of the displayable area (or the left pane of a split tree control).
The HorizontalOffset2 property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The Items.HorizontalOffset2 property can only be used with a split tree control.
The right pane of a split tree control can only be scrolled horizontally if its displayable area (see Items.[HorizontalExtent2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent2) property) is wider than the right pane.
See Also SftTreeItems Object | Object Hierarchy
## HorizontalOffsetPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffsetPix*
Defines the current [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[OffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix)* = *object*.**HorizontalOffsetPix** **As Integer** |
| VB | *OffsetPix* = *object*.**HorizontalOffsetPix** **As Long** |
| C#.NET | **int** *OffsetPix* = *object*.**HorizontalOffsetPix**; |
| VC++ | **long** *OffsetPix* = *object*->**HorizontalOffsetPix**;
**long** *OffsetPix* = *object*->Get**HorizontalOffsetPix**(); |
| C | **HRESULT** *object*->get_**HorizontalOffsetPix**(**long*** *OffsetPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HorizontalOffsetPix** = *OffsetPix* **As Integer** |
| VB | *object*.**HorizontalOffsetPix** = *OffsetPix* **As Long** |
| C#.NET | **int** *object*.**HorizontalOffsetPix** = *OffsetPix*; |
| VC++ | **long** *object*->**HorizontalOffsetPix** = *OffsetPix*;
**void** *object*->Put**HorizontalOffsetPix**(**long** *OffsetPix*); |
| C | **HRESULT** *object*->put_**HorizontalOffsetPix**(**long** *OffsetPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
OffsetPix
Defines the current horizontal scrolling offset in pixels. If this value is greater than the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property, the value is adjusted to scroll to the rightmost position.
### Comments
The HorizontalOffsetPix property defines the current horizontal scrolling offset.
The Items.[HorizontalOffset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset) and HorizontalOffsetPix methods are synonyms, but may use different coordinate systems.
A tree control's displayable area can be wider than the tree control's window width. If the displayable area is wider, the tree control can be scrolled horizontally if it has a horizontal scroll bar (see [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property). The current offset determines the amount of horizontal scrolling.
The Items.HorizontalOffset property defines the horizontal scrolling offset of the displayable area (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control).
The Items.[HorizontalOffset2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalOffset2) property defines the horizontal scrolling offset of the displayable area in the right pane of a split tree control. The Items.HorizontalOffset2 property can only be used with a split tree control.
A tree control can only be scrolled horizontally if its displayable area (see Items.HorizontalExtent property) is wider than the tree control window.
See Also SftTreeItems Object | Object Hierarchy
## HotInnerBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerBorderColor*
Defines the inner border color for items when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HotInnerBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HotInnerBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HotInnerBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HotInnerBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**HotInnerBorderColor**(); |
| C | **HRESULT** *object*->get_**HotInnerBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HotInnerBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**HotInnerBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HotInnerBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HotInnerBorderColor** = *Clr*;
**void** *object*->Put**HotInnerBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HotInnerBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the inner border color for items when the mouse cursor is on the item.
### Comments
The HotInnerBorderColor property defines the inner border color for items when the mouse cursor is on the item.
The HotInnerBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## HotInnerFill1 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill1*
Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for items when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HotInnerFill1** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HotInnerFill1** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HotInnerFill1**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HotInnerFill1**;
**OLE_COLOR** *Clr* = *object*->Get**HotInnerFill1**(); |
| C | **HRESULT** *object*->get_**HotInnerFill1**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HotInnerFill1** = *Clr* **As UInteger** |
| VB | *object*.**HotInnerFill1** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HotInnerFill1** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HotInnerFill1** = *Clr*;
**void** *object*->Put**HotInnerFill1**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HotInnerFill1**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the starting color used to fill the selection outline for items when the mouse cursor is on the item.
### Comments
The HotInnerFill1 property defines the starting color used to fill the selection outline for items when the mouse cursor is on the item.
The HotInnerFill1 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## HotInnerFill2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill2*
Defines the ending color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for items when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HotInnerFill2** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HotInnerFill2** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HotInnerFill2**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HotInnerFill2**;
**OLE_COLOR** *Clr* = *object*->Get**HotInnerFill2**(); |
| C | **HRESULT** *object*->get_**HotInnerFill2**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HotInnerFill2** = *Clr* **As UInteger** |
| VB | *object*.**HotInnerFill2** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HotInnerFill2** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HotInnerFill2** = *Clr*;
**void** *object*->Put**HotInnerFill2**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HotInnerFill2**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the ending color used to fill the selection outline for items when the mouse cursor is on the item.
### Comments
The HotInnerFill2 property defines the ending color used to fill the selection outline for items when the mouse cursor is on the item.
The HotInnerFill2 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## HotOutlineBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotOutlineBorderColor*
Defines the outline border color for items when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**HotOutlineBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**HotOutlineBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**HotOutlineBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**HotOutlineBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**HotOutlineBorderColor**(); |
| C | **HRESULT** *object*->get_**HotOutlineBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**HotOutlineBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**HotOutlineBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**HotOutlineBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**HotOutlineBorderColor** = *Clr*;
**void** *object*->Put**HotOutlineBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**HotOutlineBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the outline border color for items when the mouse cursor is on the item.
### Comments
The HotOutlineBorderColor property defines the outline border color for items when the mouse cursor is on the item.
The HotOutlineBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## hWnd Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_hWnd*
Returns the tree control's window handle.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**hWnd** **As Integer** |
| VB | *Handle* = *object*.**hWnd** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**hWnd**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**hWnd**;
**OLE_HANDLE** *Handle* = *object*->Get**hWnd**(); |
| C | **HRESULT** *object*->get_**hWnd**(**OLE_HANDLE*** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
Returns the tree control's window handle.
### Comments
The hWnd property returns the tree control's window handle.
The hWnd property should not be used and may cause incompatibilities with future releases of SftTree/OCX.
See Also SftTree Object | Object Hierarchy
## IconHandle Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IconHandle*
Defines the image object using an icon handle.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *hIcon* = *object*.**IconHandle** **As Integer** |
| VB | *hIcon* = *object*.**IconHandle** **As OLE_HANDLE** |
| C#.NET | **int** *hIcon* = *object*.**IconHandle**; |
| VC++ | **OLE_HANDLE** *hIcon* = *object*->**IconHandle**;
**OLE_HANDLE** *hIcon* = *object*->Get**IconHandle**(); |
| C | **HRESULT** *object*->get_**IconHandle**(**OLE_HANDLE*** *hIcon*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**IconHandle** = *hIcon* **As Integer** |
| VB | *object*.**IconHandle** = *hIcon* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**IconHandle** = *hIcon*; |
| VC++ | **OLE_HANDLE** *object*->**IconHandle** = *hIcon*;
**void** *object*->Put**IconHandle**(**OLE_HANDLE** *hIcon*); |
| C | **HRESULT** *object*->put_**IconHandle**(**OLE_HANDLE** *hIcon*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
hIcon
Defines the image object using an icon handle. The icon handle can be NULL, in which case the SftPictureObject object is cleared.
### Comments
The IconHandle property defines the image object using an icon handle.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeIcon](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the icon size.
See Also SftPictureObject Object | Object Hierarchy
## ID Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID*
Defines the [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids) of the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemID* = *object*.**ID** **As Integer** |
| VB | *ItemID* = *object*.**ID** **As Long** |
| C#.NET | **int** *ItemID* = *object*.**ID**; |
| VC++ | **long** *ItemID* = *object*->**ID**;
**long** *ItemID* = *object*->Get**ID**(); |
| C | **HRESULT** *object*->get_**ID**(**long*** *ItemID*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ID** = *ItemID* **As Integer** |
| VB | *object*.**ID** = *ItemID* **As Long** |
| C#.NET | **int** *object*.**ID** = *ItemID*; |
| VC++ | **long** *object*->**ID** = *ItemID*;
**void** *object*->Put**ID**(**long** *ItemID*); |
| C | **HRESULT** *object*->put_**ID**(**long** *ItemID*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemID
Defines the item ID of the item.
### Comments
The ID property defines the item ID of the item.
The tree control automatically assigns a unique item ID to items as they are added to the control. The item ID defined by the ID property does not change throughout the lifetime of an item. Even if an item changes its index position because other items are deleted or inserted, the item ID remains constant.
An application can change an item's item ID using the ID property. In this case, if a unique item ID is required, the application must insure using its own mechanisms that unique IDs are used.
The item index describes the zero-based position of an item in a tree control.
An item ID can be translated into an item index using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemIndex) property.
See Also SftTreeItem Object | Object Hierarchy
## Ignore Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Ignore*
Defines whether the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) is ignored for optimal column width and extent calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Ignore** **As Boolean** |
| VB | *Boolean* = *object*.**Ignore** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Ignore**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Ignore**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Ignore**(); |
| C | **HRESULT** *object*->get_**Ignore**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Ignore** = *Boolean* **As Boolean** |
| VB | *object*.**Ignore** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Ignore** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Ignore** = *Boolean*;
**void** *object*->Put**Ignore**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Ignore**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Boolean
Defines whether the cell is ignored for optimal column width and extent calculation.
| Boolean | Description |
| --- | --- |
| True | This cell is ignored for optimal column width calculation using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) and [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_MakeOptimal). This can be used if certain cell contents are known to be unusually long, which would make a column too wide. |
| False | This cell is included in the optimal column width calculation using Column.MakeOptimal, Column.OptimalWidth and ColumnsObj.MakeOptimal, unless the item is excluded altogether using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Ignore](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Ignore) property. |
### Comments
The Ignore property defines whether the cell is ignored for optimal column width and extent calculation.
See Also SftTreeCell Object | Object Hierarchy
## Ignore Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Ignore*
Defines whether the item is ignored for optimal column width and extent calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Ignore** **As Boolean** |
| VB | *Boolean* = *object*.**Ignore** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Ignore**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Ignore**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Ignore**(); |
| C | **HRESULT** *object*->get_**Ignore**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Ignore** = *Boolean* **As Boolean** |
| VB | *object*.**Ignore** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Ignore** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Ignore** = *Boolean*;
**void** *object*->Put**Ignore**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Ignore**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is ignored for optimal column width and extent calculation.
| Boolean | Description |
| --- | --- |
| True | All [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) of this item are ignored for optimal column width calculation using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal), Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) and [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_MakeOptimal). This can be used if certain item contents are known to be unusually long, which would make columns too wide. |
| False | This item and all its cells are included in the optimal column width calculation using Column.MakeOptimal, Column.OptimalWidth and ColumnsObj.MakeOptimal, unless individual cells are excluded using their Cell.Ignore property. |
### Comments
The Ignore property defines whether the item is ignored for optimal column width and extent calculation.
See Also SftTreeItem Object | Object Hierarchy
## Image Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image*
Defines the image object using a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *GDIPlusImage* = *object*.**Image** **As Integer** |
| VB | *GDIPlusImage* = *object*.**Image** **As LONG_PTR** |
| C#.NET | **int** *GDIPlusImage* = *object*.**Image**; |
| VC++ | **LONG_PTR** *GDIPlusImage* = *object*->**Image**;
**LONG_PTR** *GDIPlusImage* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**LONG_PTR*** *GDIPlusImage*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *GDIPlusImage* **As Integer** |
| VB | *object*.**Image** = *GDIPlusImage* **As LONG_PTR** |
| C#.NET | **int** *object*.**Image** = *GDIPlusImage*; |
| VC++ | **LONG_PTR** *object*->**Image** = *GDIPlusImage*;
**void** *object*->Put**Image**(**LONG_PTR** *GDIPlusImage*); |
| C | **HRESULT** *object*->put_**Image**(**LONG_PTR** *GDIPlusImage*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
GDIPlusImage
Defines the image object using a GDI+ image.
### Comments
The Image property defines the image object using a GDI+ image. The image remains owned by the application and must remain valid as long as it is used by the tree control. Once it is no longer needed, it must be deleted by the application. Most languages, except C++, automatically delete the object when it is no longer needed so no action is usually necessary.
The Image property offers support for PNG, TIFF, JPEG, GIF, Exif, EMF+, EMF (GDI+ images) with full support for alpha-blended (translucent and semi-transparent) images.
Typically, .NET applications use the [NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) property to define an image, C and C++ applications use [BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle) or [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image), VB6 and other COM applications use the [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) property.
[SetImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImage) can also be used to define the image object using a GDI image, but is also assign ownership of the GDI+ image to the tree control, so it automatically deletes the object when it is no longer needed. This is typically only used by C++ applications that have direct access to GDI+ classes.
See Also SftPictureObject Object | Object Hierarchy
## Image Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image*
Defines the graphic displayed in this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
refImageObj
Defines the graphic displayed in this cell.
### Comments
The Image property defines the graphic displayed in this cell.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as cell graphic at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as cell graphics are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
The Items.ClearCellImages method can be used to remove all cell graphics. The [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image) property can be set to the value Nothing (NULL), which removes the graphic from the cell.
The position of the cell graphics is determined by the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTreeCell Object | Object Hierarchy
## Image Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Image*
Defines the graphic displayed in this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
refImageObj
Defines the graphic displayed in this column footer.
### Comments
The Image property defines the graphic displayed in this column footer.
All graphics used in a tree control as Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the column footers, so graphics used as Image property are never clipped vertically. To change the column footer graphic size, all column footer graphics must be removed first by setting the Image property to Nothing (NULL) for each column before assigning new column footer graphics.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
If a column footer is disabled (see [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The Image property can be set to the value Nothing (NULL), which removes the graphic from the column footer.
The position of the column footer graphic is determined by the Footer.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageHAlign), Footer.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageVAlign) and Footer.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextHAlign) properties.
See Also SftTreeFooter Object | Object Hierarchy
## Image Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image*
Defines the graphic displayed in this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
refImageObj
Defines the graphic displayed in this column header.
### Comments
The Image property defines the graphic displayed in this column header.
All graphics used in a tree control as Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the column headers, so graphics used as Image property are never clipped vertically. To change the column header graphic size, all column header graphics must be removed first by setting the Image property to Nothing (NULL) for each column before assigning new column header graphics.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
If a column header is disabled (see [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The Image property can be set to the value Nothing (NULL), which removes the graphic from the column header.
The position of the column header graphic is determined by the Header.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign), Header.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign) and Header.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) properties.
See Also SftTreeHeader Object | Object Hierarchy
## Image Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image*
Defines the item graphic displayed in this item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
refImageObj
Defines the item graphic displayed in this item.
### Comments
The Image property defines the item graphic displayed in this item.
The Image property is used to override the default item graphic defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties. These default graphics must be defined for item graphics to be shown.
The Image property can be set before the default graphics have been defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties, but item graphics are not shown until these default graphics are defined.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as Image, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as Image property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The Image property can be set to the value Nothing (NULL), which restores the default graphic.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTreeItem Object | Object Hierarchy
## Image Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Image*
Defines the graphic displayed in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
refImageObj
Defines the graphic displayed in the row/column footer.
### Comments
The Image property defines the graphic displayed in the row/column footer.
The dimensions of the graphics are used to calculate the minimum dimension for the row/column footer, [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) and column footers, so graphics used as Image property are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
The Image property can be set to the value Nothing (NULL), which removes the graphic from the row/column footer.
The position of the row/column footer graphic is determined by the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageHAlign), RowColumnFooter.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageVAlign), RowColumnFooter.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextHAlign) and RowColumnFooter.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextVAlign) properties.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## Image Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image*
Defines the graphic displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
refImageObj
Defines the graphic displayed in the row/column header.
### Comments
The Image property defines the graphic displayed in the row/column header.
The dimensions of the graphics are used to calculate the minimum dimension for the row/column header, [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) and column headers, so graphics used as Image property are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
The Image property can be set to the value Nothing (NULL), which removes the graphic from the row/column header.
The position of the row/column header graphic is determined by the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign), RowColumnHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign), RowColumnHeader.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) properties.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## Image Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image*
Defines the graphic displayed in this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**Image** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**Image** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**Image**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**Image**;
**ISftPictureObject*** *refImageObj* = *object*->Get**Image**(); |
| C | **HRESULT** *object*->get_**Image**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**Image** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**Image** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**Image** = *refImageObj*;
**void** *object*->Put**Image**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**Image**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
refImageObj
Defines the graphic displayed in this row header.
### Comments
The Image property defines the graphic displayed in this row header.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the row headers, so graphics used as Image property are never clipped vertically. To change the row header graphic size, all row header graphics must be removed first using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ClearImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
If row headers are disabled (see RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired. Individual items may be disabled using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property.
The RowHeaders.ClearImages method can be used to remove all row header graphics. The Image property can be set to the value Nothing (NULL), which removes the graphic from the row header.
The position of the row header graphic is determined by the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) and RowHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) properties.
See Also SftTreeRowHeader Object | Object Hierarchy
## ImageHAlign Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign*
Defines the horizontal alignment of the graphic in this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the horizontal alignment of the graphic in this cell.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the cell text. |
| halignSftTreeCenter | 1 | The graphic is centered in the cell. |
| halignSftTreeRight | 2 | The graphic is on the right of the cell text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) property is used to define the vertical alignment of the graphic in this cell. The cell graphic is defined using the Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
See Also SftTreeCell Object | Object Hierarchy
## ImageHAlign Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageHAlign*
Defines the horizontal alignment of the graphic in this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Style
Defines the horizontal alignment of the graphic in this column footer.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the column footer text. |
| halignSftTreeCenter | 1 | The graphic is centered in the column footer. The column footer text is not displayed. |
| halignSftTreeRight | 2 | The graphic is on the right of the column footer text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in this column footer.
The column footer graphic is defined using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Image) property.
See Also SftTreeFooter Object | Object Hierarchy
## ImageHAlign Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageHAlign*
Defines the horizontal alignment of the graphic in this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As **[SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)**** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the horizontal alignment of the graphic in this column header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the column header text. |
| halignSftTreeCenter | 1 | The graphic is centered in the column header. The column header text is not displayed. |
| halignSftTreeRight | 2 | The graphic is on the right of the column header text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in this column header.
The column header graphic is defined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) property.
See Also SftTreeHeader Object | Object Hierarchy
## ImageHAlign Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageHAlign*
Defines the horizontal alignment of the graphic in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Style
Defines the horizontal alignment of the graphic in the row/column footer.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the row/column footer text. |
| halignSftTreeCenter | 1 | The graphic is centered in the row/column footer. The row/column footer text is not displayed. |
| halignSftTreeRight | 2 | The graphic is on the right of the row/column footer text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in the row/column footer.
The row/column footer graphic is defined using the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Image) property.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## ImageHAlign Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign*
Defines the horizontal alignment of the graphic in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Style
Defines the horizontal alignment of the graphic in the row/column header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the row/column header text. |
| halignSftTreeCenter | 1 | The graphic is centered in the row/column header. The row/column header text is not displayed. |
| halignSftTreeRight | 2 | The graphic is on the right of the row/column header text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in the row/column header.
The row/column header graphic is defined using the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) property.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## ImageHAlign Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign*
Defines the horizontal alignment of the graphic in this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**ImageHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**ImageHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**ImageHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**ImageHAlign**(); |
| C | **HRESULT** *object*->get_**ImageHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**ImageHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**ImageHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**ImageHAlign** = *Style*;
**void** *object*->Put**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Style
Defines the horizontal alignment of the graphic in this row header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The graphic is on the left of the row header text. |
| halignSftTreeCenter | 1 | The graphic is centered in the row header. The row header text is not displayed. |
| halignSftTreeRight | 2 | The graphic is on the right of the row header text. |
### Comments
The ImageHAlign property defines the horizontal alignment of the graphic in this row header.
Row header graphics are defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property.
See Also SftTreeRowHeader Object | Object Hierarchy
## ImageScaling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ImageScaling*
Defines whether the control's images are scaled to the current [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Mode* = *object*.**ImageScaling** **As [SftTreeScalingConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScalingConstants)** |
| VB | *Mode* = *object*.**ImageScaling** **As SftTreeScalingConstants** |
| C#.NET | **SftTreeScalingConstants** *Mode* = *object*.**ImageScaling**; |
| VC++ | **enum SftTreeScalingConstants** *Mode* = *object*->**ImageScaling**;
**enum SftTreeScalingConstants** *Mode* = *object*->Get**ImageScaling**(); |
| C | **HRESULT** *object*->get_**ImageScaling**(**enum SftTreeScalingConstants*** *Mode*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageScaling** = *Mode* **As SftTreeScalingConstants** |
| VB | *object*.**ImageScaling** = *Mode* **As SftTreeScalingConstants** |
| C#.NET | **SftTreeScalingConstants** *object*.**ImageScaling** = *Mode*; |
| VC++ | **enum SftTreeScalingConstants** *object*->**ImageScaling** = *Mode*;
**void** *object*->Put**ImageScaling**(**enum SftTreeScalingConstants** *Mode*); |
| C | **HRESULT** *object*->put_**ImageScaling**(**enum SftTreeScalingConstants** *Mode*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Mode
Defines whether the control's images are scaled to the current DPI.
| Name | Value | Description |
| --- | --- | --- |
| scalingSftTreeAsIs | 0 | Draw every image at its native pixel size (the default). |
| scalingSftTreeStretch | 1 | Scale every image by the current DPI. |
### Comments
The ImageScaling property defines whether the control's images are scaled to the current DPI.
This setting is independent of [PixelScaling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PixelScaling).
See Also SftTree Object | Object Hierarchy | Per-Monitor DPI and Scaling
## ImageVAlign Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign*
Defines the vertical alignment of the graphic in this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the vertical alignment of the graphic in this cell.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) property is used to define the horizontal alignment of the graphic in this cell. The cell graphic is defined using the Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) property.
See Also SftTreeCell Object | Object Hierarchy
## ImageVAlign Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ImageVAlign*
Defines the vertical alignment of the graphic in this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Style
Defines the vertical alignment of the graphic in this column footer.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in this column footer.
The column footer graphic is defined using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Image) property.
See Also SftTreeFooter Object | Object Hierarchy
## ImageVAlign Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ImageVAlign*
Defines the vertical alignment of the graphic in this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the vertical alignment of the graphic in this column header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in this column header.
The column header graphic is defined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Image) property.
See Also SftTreeHeader Object | Object Hierarchy
## ImageVAlign Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ImageVAlign*
Defines the vertical alignment of the graphic in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Style
Defines the vertical alignment of the graphic in the row/column footer.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in the row/column footer.
The row/column footer graphic is defined using the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Image) property.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## ImageVAlign Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign*
Defines the vertical alignment of the graphic in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Style
Defines the vertical alignment of the graphic in the row/column header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in the row/column header.
The row/column header graphic is defined using the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) property.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## ImageVAlign Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign*
Defines the vertical alignment of the graphic in this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ImageVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**ImageVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**ImageVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**ImageVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**ImageVAlign**(); |
| C | **HRESULT** *object*->get_**ImageVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**ImageVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**ImageVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**ImageVAlign** = *Style*;
**void** *object*->Put**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**ImageVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Style
Defines the vertical alignment of the graphic in this row header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The graphic is vertically centered. |
| valignSftTreeTop | 1 | The graphic is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The graphic is aligned with the bottom of the available area. |
### Comments
The ImageVAlign property defines the vertical alignment of the graphic in this row header.
Row header graphics are defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property.
See Also SftTreeRowHeader Object | Object Hierarchy
## Indentation Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Indentation*
Defines the indentation for item levels.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Indent* = *object*.**Indentation** **As Single** |
| VB | *Indent* = *object*.**Indentation** **As Single** |
| C#.NET | **float** *Indent* = *object*.**Indentation**; |
| VC++ | **float** *Indent* = *object*->**Indentation**;
**float** *Indent* = *object*->Get**Indentation**(); |
| C | **HRESULT** *object*->get_**Indentation**(**float*** *Indent*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Indentation** = *Indent* **As Single** |
| VB | *object*.**Indentation** = *Indent* **As Single** |
| C#.NET | **float** *object*.**Indentation** = *Indent*; |
| VC++ | **float** *object*->**Indentation** = *Indent*;
**void** *object*->Put**Indentation**(**float** *Indent*); |
| C | **HRESULT** *object*->put_**Indentation**(**float** *Indent*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Indent
Defines the indentation for item levels. If -1 is specified, the tree control determines the best indentation, based on item graphic width, font size, etc. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Indentation property defines the indentation for item levels.
The Indentation and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[IndentationPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_IndentationPix) methods are synonyms, but may use different coordinate systems.
Each item is indented the specified amount for each level.
It is possible to specify a very small value or even 0 for the level indentation. With such a small value, the hierarchy and its components, such as tree lines, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) may no longer have sufficient space and must be turned off by the application.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to define the alignment of connecting tree lines, [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text and cell pictures.
See Also SftTreeItems Object | Object Hierarchy
## IndentationPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_IndentationPix*
Defines the indentation for item levels.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *IndentPix* = *object*.**IndentationPix** **As Integer** |
| VB | *IndentPix* = *object*.**IndentationPix** **As Long** |
| C#.NET | **int** *IndentPix* = *object*.**IndentationPix**; |
| VC++ | **long** *IndentPix* = *object*->**IndentationPix**;
**long** *IndentPix* = *object*->Get**IndentationPix**(); |
| C | **HRESULT** *object*->get_**IndentationPix**(**long*** *IndentPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**IndentationPix** = *IndentPix* **As Integer** |
| VB | *object*.**IndentationPix** = *IndentPix* **As Long** |
| C#.NET | **int** *object*.**IndentationPix** = *IndentPix*; |
| VC++ | **long** *object*->**IndentationPix** = *IndentPix*;
**void** *object*->Put**IndentationPix**(**long** *IndentPix*); |
| C | **HRESULT** *object*->put_**IndentationPix**(**long** *IndentPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
IndentPix
Defines the indentation for item levels in pixels. If -1 is specified, the tree control determines the best indentation, based on item graphic width, font size, etc.
### Comments
The IndentationPix property defines the indentation for item levels.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Indentation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Indentation) and IndentationPix methods are synonyms, but may use different coordinate systems.
Each item is indented the specified amount for each level.
It is possible to specify a very small value or even 0 for the level indentation. With such a small value, the hierarchy and its components, such as tree lines, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) may no longer have sufficient space and must be turned off by the application.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to define the alignment of connecting tree lines, [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text and cell pictures.
See Also SftTreeItems Object | Object Hierarchy
## Index Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Index*
Returns the [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**Index** **As Short** |
| VB | *ColIndex* = *object*.**Index** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**Index**; |
| VC++ | **short** *ColIndex* = *object*->**Index**;
**short** *ColIndex* = *object*->Get**Index**(); |
| C | **HRESULT** *object*->get_**Index**(**short*** *ColIndex*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
ColIndex
Returns the real column number of this column.
### Comments
The Index property returns the real column number of this column.
See Also SftTreeColumn Object | Object Hierarchy
## Index Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Index*
Returns the column number of this footer.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**Index** **As Short** |
| VB | *ColIndex* = *object*.**Index** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**Index**; |
| VC++ | **short** *ColIndex* = *object*->**Index**;
**short** *ColIndex* = *object*->Get**Index**(); |
| C | **HRESULT** *object*->get_**Index**(**short*** *ColIndex*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
ColIndex
Returns the column number of this footer.
### Comments
The Index property returns the column number of this footer.
See Also SftTreeFooter Object | Object Hierarchy
## Index Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Index*
Returns the column number of this header.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**Index** **As Short** |
| VB | *ColIndex* = *object*.**Index** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**Index**; |
| VC++ | **short** *ColIndex* = *object*->**Index**;
**short** *ColIndex* = *object*->Get**Index**(); |
| C | **HRESULT** *object*->get_**Index**(**short*** *ColIndex*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
ColIndex
Returns the column number of this header.
### Comments
The Index property returns the column number of this header.
See Also SftTreeHeader Object | Object Hierarchy
## InheritBgColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_InheritBgColor*
Defines whether the area left of the first [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) inherits the cell's background color.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[InheritBgColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_InheritBgColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**InheritBgColor** **As Boolean** |
| VB | *Boolean* = *object*.**InheritBgColor** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**InheritBgColor**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**InheritBgColor**;
**VARIANT_BOOL** *Boolean* = *object*->Get**InheritBgColor**(); |
| C | **HRESULT** *object*->get_**InheritBgColor**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**InheritBgColor** = *Boolean* **As Boolean** |
| VB | *object*.**InheritBgColor** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**InheritBgColor** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**InheritBgColor** = *Boolean*;
**void** *object*->Put**InheritBgColor**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**InheritBgColor**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the area left of the first cell inherits the cell's background color.
| Boolean | Description |
| --- | --- |
| True | The area left of the first column inherits the cell's background color. The column or cell specific colors of the first displayed column are used. The properties used are [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor), Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) and Cell.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor). |
| False | The area left of the first column does not inherit the cell's background color. The colors defined using the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) (Items.[BackColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColorOdd)) and Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) are used. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.InheritBgColor instead
The InheritBgColor property defines whether the area left of the first cell inherits the cell's background color.
See Also SftTree Object | Object Hierarchy
## InheritBgColor Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_InheritBgColor*
Defines whether the area left of the first [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) inherits the cell's background color.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**InheritBgColor** **As Boolean** |
| VB | *Boolean* = *object*.**InheritBgColor** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**InheritBgColor**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**InheritBgColor**;
**VARIANT_BOOL** *Boolean* = *object*->Get**InheritBgColor**(); |
| C | **HRESULT** *object*->get_**InheritBgColor**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**InheritBgColor** = *Boolean* **As Boolean** |
| VB | *object*.**InheritBgColor** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**InheritBgColor** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**InheritBgColor** = *Boolean*;
**void** *object*->Put**InheritBgColor**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**InheritBgColor**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
Boolean
Defines whether the area left of the first cell inherits the cell's background color.
| Boolean | Description |
| --- | --- |
| True | The area left of the first column inherits the cell's background color. The column or cell specific colors of the first displayed column are used. The properties used are [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor), Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) and Cell.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor). |
| False | The area left of the first column does not inherit the cell's background color. The colors defined using the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) (Items.[BackColorOdd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColorOdd)) and Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) are used. |
### Comments
The InheritBgColor property defines whether the area left of the first cell inherits the cell's background color.
See Also SftTreeColumns Object | Object Hierarchy
## Insert Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert*
Inserts a new item at the specified index position.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**Insert**(**ByVal** *AtIndex* **As Integer**, **ByVal** *Text* **As String**) **As Integer** |
| VB | *ItemIndex* = *object*.**Insert**(**ByVal** *AtIndex* **As Long**, **ByVal** *Text* **As String**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**Insert**(**int** *AtIndex*, **string** *Text*); |
| VC++ | **long** *ItemIndex* = *object*->**Insert**(**long** *AtIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->raw_**Insert**(**long** *AtIndex*, **BSTR** *Text*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
AtIndex
The zero-based index of the position where the item will be inserted. If -1 is specified, the item is added at the end of the list.
Text
The text to be used for the item's first (or only) column.
ItemIndex
Returns the zero-based index of the newly inserted item.
### Comments
The Insert method inserts a new item at the specified index position.
By default, new items are added at level 0. Use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property to change an item's level. If many items have to be added, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
Once an item has been added, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property can be used to change the text for any of the available columns.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can be added at the end of the list by using the Items.[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) method. Items can be deleted using the Items.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method.
When a tree control is populated using Items.Add or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert), the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method can be used to have the tree control calculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) area so scroll bars are enabled, depending on the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
Items can also be added using the Items.[InsertAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_InsertAfter) method.
See Also SftTreeItems Object | Object Hierarchy
## InsertAfter Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_InsertAfter*
Inserts a new item following the specified index position.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**InsertAfter**(**ByVal** *AfterIndex* **As Integer**, **ByVal** *Text* **As String**) **As Integer** |
| VB | *ItemIndex* = *object*.**InsertAfter**(**ByVal** *AfterIndex* **As Long**, **ByVal** *Text* **As String**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**InsertAfter**(**int** *AfterIndex*, **string** *Text*); |
| VC++ | **long** *ItemIndex* = *object*->**InsertAfter**(**long** *AfterIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->raw_**InsertAfter**(**long** *AfterIndex*, **BSTR** *Text*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
AfterIndex
The zero-based index of the position after which the item will be inserted. If -1 is specified, the item is added at the end of the list.
Text
The text to be used for the item's first (or only) column.
ItemIndex
Returns the zero-based index of the newly inserted item.
### Comments
The InsertAfter method inserts a new item following the specified index position.
By default, new items are added at level 0. Use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property to change an item's level. If many items have to be added, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
Once an item has been added, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property can be used to change the text for any of the available columns.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can be added at the end of the list by using the Items.[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) method. Items can be deleted using the Items.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method.
When a tree control is populated using Items.Add or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert), the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method can be used to have the tree control calculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) area so scroll bars are enabled, depending on the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
Items can also be added using the Items.Insert method.
See Also SftTreeItems Object | Object Hierarchy
## InsertItem Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_InsertItem*
Inserts a new item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**InsertItem**(**ByVal** *AtIndex* **As Integer**, **ByVal** *Text* **As String**) **As Integer** |
| VB | *ItemIndex* = *object*.**InsertItem**(**ByVal** *AtIndex* **As Long**, **ByVal** *Text* **As String**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**InsertItem**(**int** *AtIndex*, **string** *Text*); |
| VC++ | **long** *ItemIndex* = *object*->**InsertItem**(**long** *AtIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->raw_**InsertItem**(**long** *AtIndex*, **BSTR** *Text*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
AtIndex
The zero-based index of the position where the item will be inserted. If -1 is specified, the item is added at the end of the list.
Text
The text to be used for the item's first (or only) column.
ItemIndex
Returns the zero-based index of the newly inserted item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Insert instead
The InsertItem method inserts a new item.
By default, new items are added at level 0. Use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property to change an item's level. If many items have to be added, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
Once an item has been added, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) property can be used to change the text for any of the available columns.
Items can be added at the end of the list by using the Items.[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) method. Items can be deleted using the Items.[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) method.
When a tree control is populated using Items.Add or Items.Insert, the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method can be used to have the tree control calculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) area so scroll bars are enabled, depending on the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
If a parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), subsequently adding child items will automatically expand the item.
See Also SftTree Object | Object Hierarchy
## IntegralHeight Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_IntegralHeight*
Vertically resizes the tree control so visible items are displayed in their entirety.
> Deprecated - Provided for compatibility with earlier versions only - Use [MakeIntegralHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeight) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**IntegralHeight**(**ByVal** *Height* **As Single**) |
| VB | *object*.**IntegralHeight**(**ByVal** *Height* **As Single**) |
| C#.NET | **void** *object*.**IntegralHeight**(**float** *Height*); |
| VC++ | **HRESULT** *object*->**IntegralHeight**(**float** *Height*); |
| C | **HRESULT** *object*->raw_**IntegralHeight**(**float** *Height*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Height
The height to be used for integral height calculation. If 0 is used, the current tree control height is used. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use MakeIntegralHeight instead
The IntegralHeight method vertically resizes the tree control so visible items are displayed in their entirety.
The * Height* value specifies the maximum height of the tree control to use. The IntegralHeight method calculates the largest height of the tree control (smaller or equal to *Height*) so that no partial items are displayed and resizes the control vertically using the calculated height. This method takes all tree control attributes into consideration, including the presence of a horizontal scroll bar.
The IntegralHeight method should be used after all tree control attributes have been set and all items have been added. If tree control attributes are changed after using the IntegralHeight method, the tree control does not automatically resize if items become partially visible.
The IntegralHeight method has no effect if [variable height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)).
See Also SftTree Object | Object Hierarchy
## IsEmpty Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IsEmpty*
Returns whether the image object is empty.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**IsEmpty** **As Boolean** |
| VB | *Boolean* = *object*.**IsEmpty** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**IsEmpty**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**IsEmpty**;
**VARIANT_BOOL** *Boolean* = *object*->Get**IsEmpty**(); |
| C | **HRESULT** *object*->get_**IsEmpty**(**VARIANT_BOOL*** *Boolean*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Boolean
Returns whether the image object is empty.
| Boolean | Description |
| --- | --- |
| True | The SftPictureObject object is empty and no image is assigned. |
| False | The SftPictureObject object is not empty. The [SftPictureObject.Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property can be used to determine the image contained in the object. |
### Comments
The IsEmpty property returns whether the image object is empty.
See Also SftPictureObject Object | Object Hierarchy
## Item Property, DataObjectFiles Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Item*
Returns a specific filename by index from the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject).[Files collection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Item* = *object*.**Item**(**ByVal** *ItemIndex* **As Integer**) **As String** |
| VB | *Item* = *object*.**Item**(**ByVal** *ItemIndex* **As Long**) **As String** |
| C#.NET | **string** *Item* = *object***[****int** *ItemIndex***]**; |
| VC++ | **_bstr_t** *Item* = *object*->**Item**[**long** *ItemIndex*];
**_bstr_t** *Item* = *object*->Get**Item**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**Item**(**long** *ItemIndex*, **BSTR*** *Item*); |
object
A [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles) object.
ItemIndex
The one-based position of the file name to be retrieved.
Item
Returns a specific filename by index from the DataObject.Files collection (sftCFFiles format only).
### Comments
The Item property returns a specific filename by index from the DataObject.Files collection (sftCFFiles format only).
See Also DataObjectFiles Object | Object Hierarchy
## Item Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item*
Returns a [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object for a given item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refItemObj* = *object*.get_**Item**(**ByVal** *ItemIndex* **As Integer**) **As SftTreeItem** |
| VB | **Set** *refItemObj* = *object*.**Item**(**ByVal** *ItemIndex* **As Long**) **As SftTreeItem** |
| C#.NET | **SftTreeItem** *refItemObj* = *object***[****int** *ItemIndex***]**; |
| VC++ | **ISftTreeItem*** *refItemObj* = *object*->**Item**[**long** *ItemIndex*];
**ISftTreeItem*** *refItemObj* = *object*->Get**Item**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**Item**(**long** *ItemIndex*, **ISftTreeItem**** *refItemObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
refItemObj
Returns a SftTreeItem object for a given item.
### Comments
The Item property returns a SftTreeItem object for a given item.
The SftTreeItem object represents one item in a SftTree/OCX control. Numerous item-specific properties and methods can be accessed using the returned object * refItemObj*.
Certain default properties and behavior for all items can be defined using the [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
See Also SftTree Object | Object Hierarchy
## Item Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item*
Returns the [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object of the item currently requested from the [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refItemObj* = *object*.**Item** **As SftTreeItem** |
| VB | **Set** *refItemObj* = *object*.**Item** **As SftTreeItem** |
| C#.NET | **SftTreeItem** *refItemObj* = *object*; |
| VC++ | **ISftTreeItem*** *refItemObj* = *object*->**Item**;
**ISftTreeItem*** *refItemObj* = *object*->Get**Item**(); |
| C | **HRESULT** *object*->get_**Item**(**ISftTreeItem**** *refItemObj*); |
object
A [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem) object.
refItemObj
Returns the SftTreeItem object of the item currently requested from the virtual data source.
### Comments
The Item property returns the SftTreeItem object of the item currently requested from the virtual data source.
See Also VirtualItem Object | Object Hierarchy
## ItemClick Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick*
A mouse button is clicked.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemClick**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemClick** |
| VB | **Private Sub** *object*_**ItemClick**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *AreaType* **As Integer**, **ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**) |
| C#.NET | **void** *object*_**ItemClick**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemClick***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *AreaType*, **short** *Button*, **short** *Shift*); |
| C | **HRESULT** On**ItemClick***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *AreaType*, **short** *Button*, **short** *Shift*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item at the mouse-cursor location when the mouse button was clicked. If the area described by *AreaType* doesn't require item information, this value is undefined.
ColIndex
The column number of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) at the mouse-cursor location when the mouse button was clicked. If the area described by *AreaType* doesn't require column information, this value is undefined.
AreaType
Defines the area where the mouse button was clicked (see [SftTreeAreaTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAreaTypeConstants)).
| AreaType | Value | Description |
| --- | --- | --- |
| constSftTreeLabel | 0 | The mouse button was pressed on the label graphic. *ColIndex* is undefined. |
| constSftTreePlusMinus 2) | 1 | The mouse button was pressed on the plus/minus graphic. *ColIndex* is undefined. |
| constSftTreeTree | 2 | The mouse button was pressed in the area where the connecting tree lines are shown. *ColIndex* is undefined. |
| constSftTreeButton 2) | 3 | The mouse button was pressed on the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons). *ColIndex* is undefined. |
| constSftTreeItem | 4 | The mouse button was pressed on the item graphic. *ColIndex* is undefined. |
| constSftTreeText | 5 | The mouse button was pressed inside a cell (text or graphic). To distinguish between cell text and cell graphic use constSftTreeCellText or constSftTreeCellGraphic instead. Preceding the ItemClick event with this *AreaType* value, an ItemClick event occurs with an *AreaType* value of constSftTreeCellText or constSftTreeCellGraphic. |
| constSftTreeColumnHeader | 6 | The mouse button was pressed on the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). *ItemIndex* is undefined. |
| constSftTreeColumn | 6 | Deprecated - Use constSftTreeColumnHeader instead. The mouse button was pressed on the column header. *ItemIndex* is undefined. |
| constSftTreeRowColumnHeader | 7 | The mouse button was pressed on the row/column header. *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeRowColumn | 7 | Deprecated - Use constSftTreeRowColumnHeader instead. The mouse button was pressed on the row/column header. *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeRow | 8 | The mouse button was pressed on the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders). *ColIndex* is undefined. |
| constSftTreeCellText | 9 | The mouse button was pressed inside a cell, but not on the cell graphic. |
| constSftTreeCellGraphic | 10 | The mouse button was pressed inside a cell on the cell graphic. |
| constSftTreeColumnRes | 11 | Not used. |
| constSftTreeExpandAll | 12 | The ExpandAll key (the * on the numeric keypad) was pressed.* ItemIndex* and *ColIndex* are undefined. |
| constSftTreeRowColumnFooter | 14 | The mouse button was pressed on the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters). *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeColumnFooter | 15 | The mouse button was pressed on the column footer. *ItemIndex* is undefined. |
| constSftTreeColumnHeaderButton | 16 | The [header dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) was clicked. |
| constSftTreeColumnFooterButton | 17 | The footer dropdown/filter button was clicked. |
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
### Comments
The ItemClick event occurs when a mouse button is clicked.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) or [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) properties, this event may not be generated for the middle and right mouse buttons.
2) If the [AutoRespond](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AutoRespond) property is set to True, the areas constSftTreePlusMinus, constSftTreeButton do not generate an ItemClick event for the left mouse button. The tree control responds by expanding/[collapsing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) the items automatically. The middle and right mouse buttons still generate the event in those areas.
Please note that the ItemClick event reflects mouse button events. The [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) event should be used when selection changes need to be tracked, as these can also occur though keyboard input, which is not reflected by the ItemClick event.
The ItemClick event supplies all the necessary information to the application so appropriate action can be taken. The application can start [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting), expand or collapse an item or display application specific information based on the event and the area clicked.
The [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) event can be used to respond to a mouse button that is pressed twice within a short time. An ItemDblClick event is always preceded by an ItemClick event. If the pause between mouse click events is sufficiently long, the [ItemClickAgain](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClickAgain) event may be generated instead of the ItemDblClick event.
The ItemClick event with * AreaType* constSftTreeColumnHeader is only generated if column headers are displayed as buttons ([Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property), the header button is enabled ([Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Enabled) property) and is not currently in its "down" position (Headers.[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) property). The ItemClick event with * AreaType* constSftTreeColumnFooter is only generated if column footers are displayed as buttons ([Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance) property), the footer button is enabled ([Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Enabled) property) and is not currently in its "down" position (Footers.[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Pressed) property).
The ItemClick event with * AreaType* constSftTreeRowColumnHeader is only generated if a row/column header is currently displayed as a button ([RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property) and is enabled (RowColumnHeader.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled) property). The ItemClick event with * AreaType* constSftTreeRowColumnFooter is only generated if a row/column footer is currently displayed as a button ([RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance) property) and is enabled (RowColumnFooter.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Enabled) property).
The ItemClick event with * AreaType* constSftTreeRow is only generated if row headers are displayed as buttons ([RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and are enabled (RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property). An ItemClick in this area acts as a selection.
If the ItemClick event is used to display a context sensitive menu (popup menu), the [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) method must be used before displaying the context menu.
See Also SftTree Object | Object Hierarchy
## ItemClickAgain Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClickAgain*
An already [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) has been clicked.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemClickAgain**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemClickAgain** |
| VB | **Private Sub** *object*_**ItemClickAgain**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *Button* **As Integer**) |
| C#.NET | **void** *object*_**ItemClickAgain**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemClickAgain***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *Button*); |
| C | **HRESULT** On**ItemClickAgain***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *Button*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item at the mouse-cursor location when the mouse button was clicked.
ColIndex
The column number of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) at the mouse-cursor location when the mouse button was clicked.
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
### Comments
The ItemClickAgain event occurs when an already selected item has been clicked.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) or [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) properties, this event may not be generated for the middle and right mouse buttons.
The ItemClickAgain event is generated when the user clicks on an already selected item. The event is only generated if there is a sufficiently long pause between the first click to select the item and the second click. If the pause is not long enough, the [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) event is generated instead.
The ItemClickAgain event supplies all the necessary information to the application, so appropriate action can be taken, such as to start [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
See Also SftTree Object | Object Hierarchy
## ItemCollapsed Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemCollapsed*
An item has been [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemCollapsed**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemCollapsed** |
| VB | **Private Sub** *object*_**ItemCollapsed**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**ItemCollapsed**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemCollapsed***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**ItemCollapsed***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item being collapsed.
### Comments
The ItemCollapsed event occurs when an item has been collapsed.
This is a notification only. No tree control items or [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) should be manipulated while handling this event.
See Also SftTree Object | Object Hierarchy
## ItemData Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemData*
Defines an item's application specific value.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Data* = *object*.get_**ItemData**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *Data* = *object*.**ItemData**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *Data* = *object*.get_**ItemData**(**int** *ItemIndex*); |
| VC++ | **long** *Data* = *object*->**ItemData**[**long** *ItemIndex*];
**long** *Data* = *object*->Get**ItemData**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemData**(**long** *ItemIndex*, **long*** *Data*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemData**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Data* **As Integer**) |
| VB | *object*.**ItemData**(**ByVal** *ItemIndex* **As Long**) = *Data* **As Long** |
| C#.NET | **void** *object*.set_**ItemData**(**int** *ItemIndex*, **int** *Data*); |
| VC++ | **long** *object*->**ItemData**[**long** *ItemIndex*] = *Data*;
**void** *object*->Put**ItemData**(**long** *ItemIndex*, **long** *Data*); |
| C | **HRESULT** *object*->put_**ItemData**(**long** *ItemIndex*, **long** *Data*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Data
Defines an item's application specific value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Data instead
The ItemData property defines an item's application specific value.
The ItemData property can be used to store an application specific value with an item. Possible uses include storing values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
Additional properties used to associate an application defined value with an item are Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTree Object | Object Hierarchy
## ItemData Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemData*
Defines the item's application specific value.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemData** = *Data* **As Integer** |
| VB | *object*.**ItemData** = *Data* **As Long** |
| C#.NET | **int** *object*.**ItemData** = *Data*; |
| VC++ | **long** *object*->**ItemData** = *Data*;
**void** *object*->Put**ItemData**(**long** *(null)*); |
| C | **HRESULT** *object*->put_**ItemData**(**long** *(null)*); |
object
A VirtualItem object.
Data
Defines the item's application specific value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Data instead
The ItemData property defines the item's application specific value.
The ItemData property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's application specific value. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemDataFloat Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataFloat*
Defines an item's application specific floating point value.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Data* = *object*.get_**ItemDataFloat**(**ByVal** *ItemIndex* **As Integer**) **As Single** |
| VB | *Data* = *object*.**ItemDataFloat**(**ByVal** *ItemIndex* **As Long**) **As Single** |
| C#.NET | **float** *Data* = *object*.get_**ItemDataFloat**(**int** *ItemIndex*); |
| VC++ | **float** *Data* = *object*->**ItemDataFloat**[**long** *ItemIndex*];
**float** *Data* = *object*->Get**ItemDataFloat**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemDataFloat**(**long** *ItemIndex*, **float*** *Data*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemDataFloat**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Data* **As Single**) |
| VB | *object*.**ItemDataFloat**(**ByVal** *ItemIndex* **As Long**) = *Data* **As Single** |
| C#.NET | **void** *object*.set_**ItemDataFloat**(**int** *ItemIndex*, **float** *Data*); |
| VC++ | **float** *object*->**ItemDataFloat**[**long** *ItemIndex*] = *Data*;
**void** *object*->Put**ItemDataFloat**(**long** *ItemIndex*, **float** *Data*); |
| C | **HRESULT** *object*->put_**ItemDataFloat**(**long** *ItemIndex*, **float** *Data*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Data
Defines an item's application specific floating point value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DataFloat instead
The ItemDataFloat property defines an item's application specific floating point value.
The ItemDataFloat property can be used to store an application specific value with an item. Possible uses include storing values used for [sorting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) purposes (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).SortDependents method).
Additional properties used to associate an application defined value with an item are Item.[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTree Object | Object Hierarchy
## ItemDataFloat Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataFloat*
Defines the item's application specific floating point value.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemDataFloat** = *Data* **As Single** |
| VB | *object*.**ItemDataFloat** = *Data* **As Single** |
| C#.NET | **float** *object*.**ItemDataFloat** = *Data*; |
| VC++ | **float** *object*->**ItemDataFloat** = *Data*;
**void** *object*->Put**ItemDataFloat**(**float** *Data*); |
| C | **HRESULT** *object*->put_**ItemDataFloat**(**float** *Data*); |
object
A VirtualItem object.
Data
Defines the item's application specific floating point value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.DataFloat instead
The ItemDataFloat property defines the item's application specific floating point value.
The ItemDataFloat property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's application specific floating point value. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemDataObject Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataObject*
Defines an item's application specific object.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refObject* = *object*.get_**ItemDataObject**(**ByVal** *ItemIndex* **As Integer**) **As Object** |
| VB | *refObject* = *object*.**ItemDataObject**(**ByVal** *ItemIndex* **As Long**) **As Object** |
| C#.NET | **object** *refObject* = *object*.get_**ItemDataObject**(**int** *ItemIndex*); |
| VC++ | **LPDISPATCH** *refObject* = *object*->**ItemDataObject**[**long** *ItemIndex*];
**LPDISPATCH** *refObject* = *object*->Get**ItemDataObject**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemDataObject**(**long** *ItemIndex*, **LPDISPATCH*** *refObject*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemDataObject**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refObject* **As Object**) |
| VB | **Set** *object*.**ItemDataObject**(**ByVal** *ItemIndex* **As Long**) = *refObject* **As Object** |
| C#.NET | **void** *object*.set_**ItemDataObject**(**int** *ItemIndex*, **object** *refObject*); |
| VC++ | **LPDISPATCH** *object*->**ItemDataObject**[**long** *ItemIndex*] = *refObject*;
**void** *object*->PutRef**ItemDataObject**(**long** *ItemIndex*, **LPDISPATCH** *refObject*); |
| C | **HRESULT** *object*->putref_**ItemDataObject**(**long** *ItemIndex*, **LPDISPATCH** *refObject*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
refObject
Defines an item's application specific object.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DataObject instead
The ItemDataObject property defines an item's application specific object.
Additional properties used to associate an application defined value with an item are Item.[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTree Object | Object Hierarchy
## ItemDataObject Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataObject*
Defines the item's application specific object.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) instead
### Syntax
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemDataObject** = *Data* **As Object** |
| VB | **Set** *object*.**ItemDataObject** = *Data* **As Object** |
| C#.NET | **object** *object*.**ItemDataObject** = *Data*; |
| VC++ | **LPDISPATCH** *object*->**ItemDataObject** = *Data*;
**void** *object*->PutRef**ItemDataObject**(**LPDISPATCH** *Data*); |
| C | **HRESULT** *object*->putref_**ItemDataObject**(**LPDISPATCH** *Data*); |
object
A VirtualItem object.
Data
Defines the item's application specific object.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.DataObject instead
The ItemDataObject property defines the item's application specific object.
The VirtualItem.[ItemDataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataObject) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's application specific object. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemDataString Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataString*
Defines an item's application specific string value.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.get_**ItemDataString**(**ByVal** *ItemIndex* **As Integer**) **As String** |
| VB | *Text* = *object*.**ItemDataString**(**ByVal** *ItemIndex* **As Long**) **As String** |
| C#.NET | **string** *Text* = *object*.get_**ItemDataString**(**int** *ItemIndex*); |
| VC++ | **_bstr_t** *Text* = *object*->**ItemDataString**[**long** *ItemIndex*];
**_bstr_t** *Text* = *object*->Get**ItemDataString**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemDataString**(**long** *ItemIndex*, **BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemDataString**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Text* **As String**) |
| VB | *object*.**ItemDataString**(**ByVal** *ItemIndex* **As Long**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**ItemDataString**(**int** *ItemIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**ItemDataString**[**long** *ItemIndex*] = *Text*;
**void** *object*->Put**ItemDataString**(**long** *ItemIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**ItemDataString**(**long** *ItemIndex*, **BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Text
Defines an item's application specific string value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DataString instead
The ItemDataString property defines an item's application specific string value.
Additional properties used to associate an application defined value with an item are Item.[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) and Item.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTree Object | Object Hierarchy
## ItemDataString Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataString*
Defines the item's application specific string value.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemDataString** = *Data* **As String** |
| VB | *object*.**ItemDataString** = *Data* **As String** |
| C#.NET | **string** *object*.**ItemDataString** = *Data*; |
| VC++ | **_bstr_t** *object*->**ItemDataString** = *Data*;
**void** *object*->Put**ItemDataString**(**_bstr_t** *Data*); |
| C | **HRESULT** *object*->put_**ItemDataString**(**BSTR** *Data*); |
object
A VirtualItem object.
Data
Defines the item's application specific string value.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.DataString instead
The ItemDataString property defines the item's application specific string value.
The ItemDataString property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's application specific string value. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemDataTag Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemDataTag*
Defines an application defined value associated with an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Data* = *object*.get_**ItemDataTag**(**ByVal** *ItemIndex* **As Integer**) **As Object** |
| VB | *Data* = *object*.**ItemDataTag**(**ByVal** *ItemIndex* **As Long**) **As Variant** |
| C#.NET | **object** *Data* = *object*.get_**ItemDataTag**(**int** *ItemIndex*); |
| VC++ | **_variant_t** *Data* = *object*->**ItemDataTag**[**long** *ItemIndex*];
**_variant_t** *Data* = *object*->Get**ItemDataTag**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemDataTag**(**long** *ItemIndex*, **VARIANT*** *Data*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemDataTag**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Data* **As Object**) |
| VB | *object*.**ItemDataTag**(**ByVal** *ItemIndex* **As Long**) = *Data* **As Variant** |
| C#.NET | **void** *object*.set_**ItemDataTag**(**int** *ItemIndex*, **object** *Data*); |
| VC++ | **_variant_t** *object*->**ItemDataTag**[**long** *ItemIndex*] = *Data*;
**void** *object*->Put**ItemDataTag**(**long** *ItemIndex*, **const _variant_t**&**** *Data*); |
| C | **HRESULT** *object*->put_**ItemDataTag**(**long** *ItemIndex*, **VARIANT** *Data*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Data
Defines an application defined value associated with an item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.DataTag instead
The ItemDataTag property defines an application defined value associated with an item.
Additional properties used to associate an application defined value with an item are Item.[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat), Item.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataObject) and Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString). These are distinct properties and can be used at the same time.
[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) related data can be saved using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data), Cell.[DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataObject), Cell.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataString) and Cell.[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_DataTag) properties.
See Also SftTree Object | Object Hierarchy
## ItemDataTag Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemDataTag*
Defines an application defined value associated with the item.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[DataTag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataTag) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemDataTag**(**ByVal** *Data* **As Object**) |
| VB | *object*.**ItemDataTag** = *Data* **As Variant** |
| C#.NET | **void** *object*.let_**ItemDataTag**(**object** *Data*); |
| VC++ | **_variant_t** *object*->**ItemDataTag** = *Data*;
**void** *object*->Put**ItemDataTag**(**const _variant_t**&**** *Data*); |
| C | **HRESULT** *object*->put_**ItemDataTag**(**VARIANT** *Data*); |
object
A VirtualItem object.
Data
Defines an application defined value associated with the item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.DataTag instead
The ItemDataTag property defines an application defined value associated with the item.
The ItemDataTag property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's application defined value. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemDblClick Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick*
A mouse button is double-clicked.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemDblClick**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemDblClick** |
| VB | **Private Sub** *object*_**ItemDblClick**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *AreaType* **As Integer**, **ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**) |
| C#.NET | **void** *object*_**ItemDblClick**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemDblClick***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *AreaType*, **short** *Button*, **short** *Shift*); |
| C | **HRESULT** On**ItemDblClick***object*(**long** *ItemIndex*, **short** *ColIndex*, **short** *AreaType*, **short** *Button*, **short** *Shift*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item at the mouse-cursor location when the mouse button was double-clicked. If the area described by *AreaType* doesn't require item information, this value is undefined.
ColIndex
The column number of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) at the mouse-cursor location when the mouse button was double-clicked. If the area described by *AreaType* doesn't require column information, this value is undefined.
AreaType
Defines the area where the mouse button was double-clicked (see [SftTreeAreaTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAreaTypeConstants)).
| AreaType | Value | Description |
| --- | --- | --- |
| constSftTreeLabel 2) | 0 | The mouse button was double-clicked on the label graphic. *ColIndex* is undefined. |
| constSftTreePlusMinus 2) | 1 | The mouse button was double-clicked on the plus/minus graphic. *ColIndex* is undefined. |
| constSftTreeTree | 2 | The mouse button was double-clicked in the area where the connecting tree lines are shown. *ColIndex* is undefined. |
| constSftTreeButton 2) | 3 | The mouse button was double-clicked on the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons). *ColIndex* is undefined. |
| constSftTreeItem 2) | 4 | The mouse button was double-clicked on the item graphic. *ColIndex* is undefined. |
| constSftTreeText 2) | 5 | The mouse button was double-clicked inside a cell (text or graphic). To distinguish between cell text and cell graphic use constSftTreeCellText or constSftTreeCellGraphic instead. Preceding the ItemDblClick event with this *AreaType* value, an ItemDblClick event occurs with an *AreaType* value of constSftTreeCellText or constSftTreeCellGraphic. |
| constSftTreeColumnHeader | 6 | The mouse button was double-clicked on the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders). *ItemIndex* is undefined. |
| constSftTreeColumn | 6 | Deprecated - Use constSftTreeColumnHeader instead. The mouse button was pressed on the column header. *ItemIndex* is undefined. |
| constSftTreeRowColumnHeader | 7 | The mouse button was double-clicked on the row/column header. *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeRowColumn | 7 | Deprecated - Use constSftTreeRowColumnHeader instead. The mouse button was pressed on the row/column header. *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeRow | 8 | The mouse button was double-clicked on the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders). *ColIndex* is undefined. |
| constSftTreeCellText | 9 | The mouse button was double-clicked inside a cell, but not on the cell graphic. |
| constSftTreeCellGraphic | 10 | The mouse button was double-clicked inside a cell on the cell graphic. |
| constSftTreeColumnRes | 11 | The mouse button was double-clicked in the column header resizing area. If *ColIndex* is -1, the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) was double clicked. *ItemIndex* is undefined. |
| constSftTreeExpandAll | 12 | Not used. |
| constSftTreeRowColumnFooter | 14 | The mouse button was double-clicked on the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters). *ItemIndex* and *ColIndex* are undefined. |
| constSftTreeColumnFooter | 15 | The mouse button was double-clicked on the column footer. *ItemIndex* is undefined. |
| constSftTreeColumnHeaderButton | 16 | The [header dropdown/filter button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dropdown) was clicked. |
| constSftTreeColumnFooterButton | 17 | The footer dropdown/filter button was clicked. |
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
### Comments
The ItemDblClick event occurs when a mouse button is double-clicked.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) or [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) properties, this event may not be generated for the middle and right mouse buttons.
2) If the [AutoRespond](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_AutoRespond) property is set to True, the areas constSftTreeLabel, constSftTreePlusMinus, constSftTreeButton, constSftTreeItem and constSftTreeText do not generate an ItemDblClick event for the left mouse button. The tree control responds by expanding/[collapsing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) the item automatically. The middle and right mouse buttons still generate the event in those areas.
The ItemDblClick event supplies all the necessary information to the application, so appropriate action can be taken. The application can start [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting), expand or collapse an item or display application specific information based on the event and the area double-clicked.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event can be used to respond to a single mouse button click.
If the ItemDblClick event is used to display a context sensitive menu (popup menu), the [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) method must be used before displaying the context menu.
See Also SftTree Object | Object Hierarchy
## ItemDeleted Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDeleted*
An item is about to be deleted.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemDeleted**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemDeleted** |
| VB | **Private Sub** *object*_**ItemDeleted**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**ItemDeleted**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemDeleted***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**ItemDeleted***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item being deleted.
### Comments
The ItemDeleted event occurs when an item is about to be deleted.
This event can be used to perform application-specific cleanup processing as items are deleted. If data is attached to items using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) or [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) properties, this event can be used to perform the necessary cleanup action, which may be required by the application.
The ItemDeleted event is generated each time an item is deleted.
No items or [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) may be modified, inserted or deleted while this event is handled.
See Also SftTree Object | Object Hierarchy
## ItemEditFont Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont*
Defines the font used for [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**ItemEditFont** **As System.Drawing.Font[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**ItemEditFont** **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *refFontObj* = *object*.**ItemEditFont**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**ItemEditFont**(); |
| C | **HRESULT** *object*->get_**ItemEditFont**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemEditFont**(**ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | *object*.**ItemEditFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**ItemEditFont**(**System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->Put**ItemEditFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**ItemEditFont**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemEditFont** = *refFontObj* **As System.Drawing.Font** |
| VB | **Set** *object*.**ItemEditFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *object*.**ItemEditFont** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**ItemEditFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**ItemEditFont**(**IFontDisp*** *refFontObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refFontObj
Defines the font used for cell editing. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The ItemEditFont property defines the font used for cell editing.
The ItemEditFont property is used to change the font used for cell editing using edit controls and combo boxes. The font specified is used for the edit control and combo box when editing [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using the [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) and [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) methods. It is not used for cell editing started using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit) method.
Depending on the [CellEditStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle) property, the controls used for cell editing can adjust to the font defined using the ItemEditFont property.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ItemExpand Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpand*
Defines whether an item is [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or collapsed.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expanded) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.get_**ItemExpand**(**ByVal** *ItemIndex* **As Integer**) **As Boolean** |
| VB | *Boolean* = *object*.**ItemExpand**(**ByVal** *ItemIndex* **As Long**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.get_**ItemExpand**(**int** *ItemIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ItemExpand**[**long** *ItemIndex*];
**VARIANT_BOOL** *Boolean* = *object*->Get**ItemExpand**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemExpand**(**long** *ItemIndex*, **VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemExpand**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Boolean* **As Boolean**) |
| VB | *object*.**ItemExpand**(**ByVal** *ItemIndex* **As Long**) = *Boolean* **As Boolean** |
| C#.NET | **void** *object*.set_**ItemExpand**(**int** *ItemIndex*, **bool** *Boolean*); |
| VC++ | **VARIANT_BOOL** *object*->**ItemExpand**[**long** *ItemIndex*] = *Boolean*;
**void** *object*->Put**ItemExpand**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ItemExpand**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to be expanded or collapsed.
Boolean
Defines whether the item is expanded or collapsed.
| Boolean | Description |
| --- | --- |
| True | The item is expanded. |
| False | The item is collapsed. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Expanded instead
The ItemExpand property defines whether an item is expanded or collapsed.
When setting ItemExpand to True, only an item's immediate dependents are made visible. [Dependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) of items that are made visible are not automatically made visible. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand) and Item.[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) method can be used to expand all immediate and indirect dependents.
If an item is already expanded when setting ItemExpand to True, the item remains unchanged. It does not hide any indirect dependents. To make sure that an item's indirect dependents are not shown, ItemExpand can be set to False first, which collapses the item (and all dependents), followed by setting ItemExpand to True. Now only immediate dependents are visible.
An item has to be currently shown to be expanded or collapsed. If the item is not shown, its state cannot be modified. The Item.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown) property can be used to determine if an item is shown.
The Item.[DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) property can be used to determine if an item can be expanded. If an item doesn't have any dependents, it is a leaf item and cannot be expanded. However, it is not an error to use ItemExpand with a leaf item.
The ItemExpand property does not preserve or restore the expand/collapse state of its dependent items. Use Items.Expand, Item.Expand, Items.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) and Item.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse) to preserve or restore this information.
If a parent item is collapsed, subsequently adding child items will automatically expand the item.
See Also SftTree Object | Object Hierarchy
## ItemExpandable Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpandable*
Defines whether an item is [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expandable) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Expandable* = *object*.get_**ItemExpandable**(**ByVal** *ItemIndex* **As Integer**) **As Boolean** |
| VB | *Expandable* = *object*.**ItemExpandable**(**ByVal** *ItemIndex* **As Long**) **As Boolean** |
| C#.NET | **bool** *Expandable* = *object*.get_**ItemExpandable**(**int** *ItemIndex*); |
| VC++ | **VARIANT_BOOL** *Expandable* = *object*->**ItemExpandable**[**long** *ItemIndex*];
**VARIANT_BOOL** *Expandable* = *object*->Get**ItemExpandable**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemExpandable**(**long** *ItemIndex*, **VARIANT_BOOL*** *Expandable*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemExpandable**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Expandable* **As Boolean**) |
| VB | *object*.**ItemExpandable**(**ByVal** *ItemIndex* **As Long**) = *Expandable* **As Boolean** |
| C#.NET | **void** *object*.set_**ItemExpandable**(**int** *ItemIndex*, **bool** *Expandable*); |
| VC++ | **VARIANT_BOOL** *object*->**ItemExpandable**[**long** *ItemIndex*] = *Expandable*;
**void** *object*->Put**ItemExpandable**(**long** *ItemIndex*, **VARIANT_BOOL** *Expandable*); |
| C | **HRESULT** *object*->put_**ItemExpandable**(**long** *ItemIndex*, **VARIANT_BOOL** *Expandable*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to be made Expandable.
Expandable
Defines whether the item is Expandable.
| Boolean | Description |
| --- | --- |
| True | The item is Expandable. |
| False | The item is not Expandable. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Expandable instead
The ItemExpandable property defines whether an item is Expandable.
Normally, only a parent item (with dependents) is Expandable. An Expandable item displays an [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) and other attributes, such as the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable) graphic.
A leaf item can be made a "temporary" parent item by setting the item's ItemExpandable property to True. The item now displays an expand/collapse button and other attributes, such as the Items.ItemImageExpandable graphic. The item can now also generate an [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event to expand the item. The application can then add child items as the user expands this "temporary" parent item, making it into a real parent item.
When setting the ItemExpandable property, an item's dependents are always removed, unless the item is already expanded.
If an item's ItemExpandable property is set to False, the item is collapsed (and its dependents are removed).
If an item is already expanded or has dependents when setting ItemExpandable to True, the item remains unchanged. It is not expanded.
See Also SftTree Object | Object Hierarchy
## ItemExpandAll Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemExpandAll*
Defines an item and all its dependents as [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or collapsed.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expand) or Item.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Collapse) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemExpandAll**(**ByVal** *ItemIndex* **As Integer**) = *(null)* **As Boolean** |
| VB | *object*.**ItemExpandAll**(**ByVal** *ItemIndex* **As Long**) = *(null)* **As Boolean** |
| C#.NET | **void** *object*.set_**ItemExpandAll**(**int** *ItemIndex*, **bool** *(null)*); |
| VC++ | **VARIANT_BOOL** *object*->**ItemExpandAll**[**long** *ItemIndex*] = *(null)*;
**void** *object*->Put**ItemExpandAll**(**long** *ItemIndex*, **VARIANT_BOOL** *(null)*); |
| C | **HRESULT** *object*->put_**ItemExpandAll**(**long** *ItemIndex*, **VARIANT_BOOL** *(null)*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to be expanded or collapsed.
Boolean
Defines whether the item is expanded or collapsed.
| Boolean | Description |
| --- | --- |
| True | The item is expanded. All immediate and indirect dependents of the specified item are made visible. |
| False | The item is collapsed. All immediate and indirect dependents of the specified item are hidden. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Expand or Item.Collapse instead
The ItemExpandAll property defines an item and all its dependents as expanded or collapsed.
If an item is already expanded when setting ItemExpandAll to True, the item remains unchanged. It does not make any indirect dependents visible. To make sure that an item's indirect dependents are shown, ItemExpandAll can be set to False first, which collapses the item (and all dependents), followed by setting ItemExpandAll to True. Now all dependents are visible.
An item has to be currently shown to be expanded or collapsed. If the item is not shown, its state cannot be modified. The Item.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown) property can be used to determine if an item is shown.
The Item.[DependentCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DependentCount) property can be used to determine if an item can be expanded. If an item doesn't have any dependents, it is a leaf item and cannot be expanded. However, it is not an error to use ItemExpandAll with a leaf item.
The ItemExpandAll property does not restore the expand/collapse state of its [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) items. Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Expand](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Expand), Item.Expand, Items.[Collapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Collapse) and Item.Collapse to preserve or restore this information.
See Also SftTree Object | Object Hierarchy
## ItemExpanded Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemExpanded*
An item has been [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems).
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ItemExpanded**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ItemExpanded** |
| VB | **Private Sub** *object*_**ItemExpanded**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**ItemExpanded**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ItemExpanded***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**ItemExpanded***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item being expanded.
### Comments
The ItemExpanded event occurs when an item has been expanded.
This is a notification only. No tree control items or [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) should be manipulated while handling this event.
See Also SftTree Object | Object Hierarchy
## ItemHeight Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight*
Returns the height of one item in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Height* = *object*.get_**ItemHeight**(**ByVal** *ItemIndex* **As Object**) **As Single** |
| VB | *Height* = *object*.**ItemHeight**(**ByVal** *ItemIndex* **As Variant**) **As Single** |
| C#.NET | **float** *Height* = *object*.get_**ItemHeight**(**object** *ItemIndex*); |
| VC++ | **float** *Height* = *object*->**ItemHeight**[**const _variant_t**&**** *ItemIndex*];
**float** *Height* = *object*->Get**ItemHeight**(**const _variant_t**&**** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemHeight**(**VARIANT** *ItemIndex*, **float*** *Height*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose height is to be returned. In a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control, -1 can be specified to retrieve the height for all items.** Visual Basic:** This is an optional parameter and can only be used if variable height items are used (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)).
Height
Returns the height of one item in the tree control. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Height or Item.Height instead
The ItemHeight property returns the height of one item in the tree control.
ItemHeight applies to a tree control with variable height items only (see Items.Style). For fixed height items, the [ItemHeight1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight1) property can be used instead.
See Also SftTree Object | Object Hierarchy
## ItemHeight1 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight1*
Returns the height of an item in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Height) or [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Height) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Height* = *object*.**ItemHeight1** **As Single** |
| VB | *Height* = *object*.**ItemHeight1** **As Single** |
| C#.NET | **float** *Height* = *object*.**ItemHeight1**; |
| VC++ | **float** *Height* = *object*->**ItemHeight1**;
**float** *Height* = *object*->Get**ItemHeight1**(); |
| C | **HRESULT** *object*->get_**ItemHeight1**(**float*** *Height*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Height
Returns the height of an item in a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree tree control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Height or Item.Height instead
The ItemHeight1 property returns the height of an item in the tree control.
ItemHeight1 applies to a tree control with fixed height items only (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). For variable height items, the [ItemHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemHeight) property can be used instead.
See Also SftTree Object | Object Hierarchy
## ItemID Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemID*
Returns the [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids) of an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ID* = *object*.get_**ItemID**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *ID* = *object*.**ItemID**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *ID* = *object*.get_**ItemID**(**int** *ItemIndex*); |
| VC++ | **long** *ID* = *object*->**ItemID**[**long** *ItemIndex*];
**long** *ID* = *object*->Get**ItemID**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemID**(**long** *ItemIndex*, **long*** *ID*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose item ID is to be returned.
ID
Returns the item ID of the item.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.ID instead
The ItemID property returns the item ID of an item.
The item ID returned by the ItemID property does not change throughout the lifetime of an item. Even if an item changes its index position because other items are deleted or inserted, the item ID remains constant. The item index describes the zero-based position of an item in a tree control.
An item ID can be translated into an item index using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemIndex) property.
See Also SftTree Object | Object Hierarchy
## ItemID Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemID*
Defines the item's [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemID** = *ID* **As Integer** |
| VB | *object*.**ItemID** = *ID* **As Long** |
| C#.NET | **int** *object*.**ItemID** = *ID*; |
| VC++ | **long** *object*->**ItemID** = *ID*;
**void** *object*->Put**ItemID**(**long** *ID*); |
| C | **HRESULT** *object*->put_**ItemID**(**long** *ID*); |
object
A VirtualItem object.
ID
Defines the item's item ID.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.ID instead
The ItemID property defines the item's item ID.
The VirtualItem.[ItemID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemID) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's item ID. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemImageAlign Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign*
Defines whether item graphics are aligned with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ItemImageAlign** **As Boolean** |
| VB | *Boolean* = *object*.**ItemImageAlign** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ItemImageAlign**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ItemImageAlign**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ItemImageAlign**(); |
| C | **HRESULT** *object*->get_**ItemImageAlign**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemImageAlign** = *Boolean* **As Boolean** |
| VB | *object*.**ItemImageAlign** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ItemImageAlign** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ItemImageAlign** = *Boolean*;
**void** *object*->Put**ItemImageAlign**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ItemImageAlign**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether item graphics are aligned with higher level cells.
| Boolean | Description |
| --- | --- |
| True | Item graphics of items at a lower level are aligned with the cell of the immediate parent level. |
| False | Item graphics are not aligned, resulting in a still indented, but narrower look. The width of the indentation is determined by the width of the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) bitmaps, the width of the item pictures and the default font used for the tree control. |
### Comments
The ItemImageAlign property defines whether item graphics are aligned with higher level cells.
In a [variable height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control, item graphics may be of varying widths and heights. If item bitmaps are smaller than the largest item bitmap used, the item bitmaps are horizontally centered within the space available for item bitmaps. This results in (smaller) item bitmaps not aligned with the cells of the parent level.
If the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Indentation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Indentation) property is used to define the exact indentation for item levels, the ItemImageAlign property defines whether tree lines are connected to the parent's item graphic or simply centered within the parent's cell.
See Also SftTreeItems Object | Object Hierarchy
## ItemImageExpandable Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable*
Defines the default graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ItemImageExpandable** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ItemImageExpandable** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ItemImageExpandable**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ItemImageExpandable**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ItemImageExpandable**(); |
| C | **HRESULT** *object*->get_**ItemImageExpandable**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemImageExpandable** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ItemImageExpandable** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ItemImageExpandable** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ItemImageExpandable** = *refImageObj*;
**void** *object*->Put**ItemImageExpandable**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ItemImageExpandable**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the default graphic used to display an expandable item's item image.
### Comments
The ItemImageExpandable property defines the default graphic used to display an expandable item's item image.
The [ItemPictureExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandable) property is used to define the default item graphic displayed for an expandable item, which is currently collapsed. Item graphics are not shown until the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).ItemImageExpandable, Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
Sample bitmaps can be found in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images. E.g., ItemExp.bmp and ItemExp2.bmp contain suitable sample images for the ItemImageExpandable property.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpandable property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTreeItems Object | Object Hierarchy
## ItemImageExpanded Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded*
Defines the default graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ItemImageExpanded** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ItemImageExpanded** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ItemImageExpanded**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ItemImageExpanded**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ItemImageExpanded**(); |
| C | **HRESULT** *object*->get_**ItemImageExpanded**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemImageExpanded** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ItemImageExpanded** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ItemImageExpanded** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ItemImageExpanded** = *refImageObj*;
**void** *object*->Put**ItemImageExpanded**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ItemImageExpanded**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the default graphic used to display an expanded item's item image.
### Comments
The ItemImageExpanded property defines the default graphic used to display an expanded item's item image.
The [ItemPictureExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpanded) property is used to define the default item graphic displayed for an expanded item, which is currently expanded. Item graphics are not shown until the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.ItemImageExpanded and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
Sample bitmaps can be found in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images. E.g., ItemExpD.bmp and ItemExpD2.bmp contain suitable sample images for the ItemImageExpanded property.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpanded property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTreeItems Object | Object Hierarchy
## ItemImageLeaf Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf*
Defines the default graphic used to display a leaf item's item image.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**ItemImageLeaf** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**ItemImageLeaf** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**ItemImageLeaf**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**ItemImageLeaf**;
**ISftPictureObject*** *refImageObj* = *object*->Get**ItemImageLeaf**(); |
| C | **HRESULT** *object*->get_**ItemImageLeaf**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemImageLeaf** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**ItemImageLeaf** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**ItemImageLeaf** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**ItemImageLeaf** = *refImageObj*;
**void** *object*->Put**ItemImageLeaf**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**ItemImageLeaf**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the default graphic used to display a leaf item's item image.
### Comments
The ItemImageLeaf property defines the default graphic used to display a leaf item's item image.
The [ItemPictureLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeaf) property is used to define the default item graphic displayed for an item which doesn't have any dependents. Item graphics are not shown until the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.ItemImageLeaf define valid graphics.
Sample bitmaps can be found in the directory \Program [Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files)\Softelvdm\SftTree OCX 8.0\Images. E.g., ItemLeaf.bmp and ItemLeaf2.bmp contain suitable sample images for the ItemImageExpanded property.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureLeaf property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTreeItems Object | Object Hierarchy
## ItemIndex Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemIndex*
Returns the item index given an [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemIndex) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.get_**ItemIndex**(**ByVal** *[ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID)* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**ItemIndex**(**ByVal** *ID* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.get_**ItemIndex**(**int** *ID*); |
| VC++ | **long** *ItemIndex* = *object*->**ItemIndex**[**long** *ID*];
**long** *ItemIndex* = *object*->Get**ItemIndex**(**long** *ID*); |
| C | **HRESULT** *object*->get_**ItemIndex**(**long** *ID*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ID
The item ID of the item whose index is to be returned.
ItemIndex
Returns the item index given an item ID. -1 is returned if no item has a matching *ID*.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemIndex instead
The ItemIndex property returns the item index given an item ID.
The item ID returned by the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).ID (or [ItemID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemID)) property does not change throughout the lifetime of an item. Even if an item changes its index position because other items are deleted or inserted, the item ID remains constant. The item index describes the zero-based position of an item in a tree control.
See Also SftTree Object | Object Hierarchy
## ItemIndex Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ItemIndex*
Returns the item index of this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Value* = *object*.**ItemIndex** **As Integer** |
| VB | *Value* = *object*.**ItemIndex** **As Long** |
| C#.NET | **int** *Value* = *object*.**ItemIndex**; |
| VC++ | **long** *Value* = *object*->**ItemIndex**;
**long** *Value* = *object*->Get**ItemIndex**(); |
| C | **HRESULT** *object*->get_**ItemIndex**(**long*** *Value*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Value
Returns the item index of this cell.
### Comments
The ItemIndex property returns the item index of this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ColumnIndex) property can be used retrieve the column index of this cell.
See Also SftTreeCell Object | Object Hierarchy
## ItemIndex Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ItemIndex*
Returns the item index of this item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Value* = *object*.**ItemIndex** **As Integer** |
| VB | *Value* = *object*.**ItemIndex** **As Long** |
| C#.NET | **int** *Value* = *object*.**ItemIndex**; |
| VC++ | **long** *Value* = *object*->**ItemIndex**;
**long** *Value* = *object*->Get**ItemIndex**(); |
| C | **HRESULT** *object*->get_**ItemIndex**(**long*** *Value*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Value
Returns the item index of this item.
### Comments
The ItemIndex property returns the item index of this item.
See Also SftTreeItem Object | Object Hierarchy
## ItemIndex Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemIndex*
Returns the item index given an [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**ItemIndex**(**ByVal** *[ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID)* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**ItemIndex**(**ByVal** *ID* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.get_**ItemIndex**(**int** *ID*); |
| VC++ | **long** *ItemIndex* = *object*->**ItemIndex**[**long** *ID*];
**long** *ItemIndex* = *object*->Get**ItemIndex**(**long** *ID*); |
| C | **HRESULT** *object*->get_**ItemIndex**(**long** *ID*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ID
The item ID of the item whose index is to be returned.
ItemIndex
Returns the item index given an item ID. -1 is returned if no item has a matching *ID*.
### Comments
The ItemIndex property returns the item index given an item ID.
The item ID returned by the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).ID property does not change throughout the lifetime of an item. Even if an item changes its index position because other items are deleted or inserted, the item ID remains constant. The item index describes the zero-based position of an item in a tree control.
See Also SftTreeItems Object | Object Hierarchy
## ItemIndex Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ItemIndex*
Returns the item index of this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Value* = *object*.**ItemIndex** **As Integer** |
| VB | *Value* = *object*.**ItemIndex** **As Long** |
| C#.NET | **int** *Value* = *object*.**ItemIndex**; |
| VC++ | **long** *Value* = *object*->**ItemIndex**;
**long** *Value* = *object*->Get**ItemIndex**(); |
| C | **HRESULT** *object*->get_**ItemIndex**(**long*** *Value*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Value
Returns the item index of this row header.
### Comments
The ItemIndex property returns the item index of this row header.
See Also SftTreeRowHeader Object | Object Hierarchy
## ItemLevel Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemLevel*
Defines an item's level number.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Level* = *object*.get_**ItemLevel**(**ByVal** *ItemIndex* **As Integer**) **As Short** |
| VB | *Level* = *object*.**ItemLevel**(**ByVal** *ItemIndex* **As Long**) **As Integer** |
| C#.NET | **short** *Level* = *object*.get_**ItemLevel**(**int** *ItemIndex*); |
| VC++ | **short** *Level* = *object*->**ItemLevel**[**long** *ItemIndex*];
**short** *Level* = *object*->Get**ItemLevel**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemLevel**(**long** *ItemIndex*, **short*** *Level*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemLevel**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Level* **As Short**) |
| VB | *object*.**ItemLevel**(**ByVal** *ItemIndex* **As Long**) = *Level* **As Integer** |
| C#.NET | **void** *object*.set_**ItemLevel**(**int** *ItemIndex*, **short** *Level*); |
| VC++ | **short** *object*->**ItemLevel**[**long** *ItemIndex*] = *Level*;
**void** *object*->Put**ItemLevel**(**long** *ItemIndex*, **short** *Level*); |
| C | **HRESULT** *object*->put_**ItemLevel**(**long** *ItemIndex*, **short** *Level*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to be accessed.
Level
Defines the item's level number. The valid range is 0 through 63.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Level instead
The ItemLevel property defines an item's level number.
The ItemLevel property determines the "indentation" of an item. By changing an item's level number, its parent relation is automatically adjusted by the tree control. Using this method, the application does not have to manipulate any parent/child relationships, but can instead treat the entire list of items in a tree control as a linear list, an array of items.
The root (or highest) level is level 0, dependents are on levels 1, 2, 3 and lower. The valid range of levels is 0 through 63.
When changing an item's level using the [ItemLevel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemLevel) property, its (current and new) parent items will automatically be [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) to make the item visible.
While logically the first item in the tree control should be at level 0, this is not necessary. Also, a parent item does not necessarily require an immediate [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) (on the next lower level); its first dependent could be on a much lower level. While this is very application specific, SftTree/OCX does allow you to build hierarchies of items where parent/child relationships don't have to follow strict rules.
See Also SftTree Object | Object Hierarchy
## ItemLines Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemLines*
Defines the number of text lines used for item height calculation.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**ItemLines** **As Short** |
| VB | *Count* = *object*.**ItemLines** **As Integer** |
| C#.NET | **short** *Count* = *object*.**ItemLines**; |
| VC++ | **short** *Count* = *object*->**ItemLines**;
**short** *Count* = *object*->Get**ItemLines**(); |
| C | **HRESULT** *object*->get_**ItemLines**(**short*** *Count*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemLines** = *Count* **As Short** |
| VB | *object*.**ItemLines** = *Count* **As Integer** |
| C#.NET | **short** *object*.**ItemLines** = *Count*; |
| VC++ | **short** *object*->**ItemLines** = *Count*;
**void** *object*->Put**ItemLines**(**short** *Count*); |
| C | **HRESULT** *object*->put_**ItemLines**(**short** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Defines the number of text lines used for item height calculation.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Lines instead
The ItemLines property defines the number of text lines used for item height calculation.
If [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items in a tree control have the same height. The best height for items is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired, the Items.Lines property should be used to set the expected (maximum) number of lines per item. This insures that multiple lines of text will fit within the vertical space allocated to each item. Some properties which override default properties are not taken into consideration when calculating the item height. E.g., the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).Font property does not affect the item height. It must be chosen to be smaller or equal to the size of the [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) property, otherwise text may be clipped vertically.
If variable height items are used (see Items.Style), items in a tree control can have varying heights. The best height for each item is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired, the Items.Lines property should be used to set the maximum number of lines to be displayed. This insures that multiple lines of text will fit within the vertical space allocated to each item. If a cell has more text lines than defined using the Items.Lines property, the lines are not visible. All properties of an item, including cell properties such as the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties, also affect the item height.
In order to enable multi-line text or [word wrap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap), the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) and Column.CellWordWrap properties have to be set.
If fixed height items are used (see Items.Style), a tree control defaults to one text line. If the Column.CellMultiline property is set, multi-line text is added and the text exceeds the number of lines defined using the Items.Lines property, the text will be truncated vertically.
If variable height items are used (see Items.Style), a tree control defaults to one text line. If the Column.CellMultiline property is set, if more text lines need to be displayed than are defined using the Items.Lines property, only the specified number of text lines are displayed followed by a '+', indicating that text lines have been truncated.
See Also SftTree Object | Object Hierarchy
## ItemPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPicture*
Defines the graphic displayed as the item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.get_**ItemPicture**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ItemPicture**(**ByVal** *ItemIndex* **As Long**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.get_**ItemPicture**(**int** *ItemIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ItemPicture**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemPicture**(**long** *ItemIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ItemPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ItemPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ItemPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ItemPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | **Set** *object*.**ItemPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**ItemPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**ItemPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ItemPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
refPictureObj
Defines the graphic displayed as the item's item graphic. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.Picture instead
The ItemPicture property defines the graphic displayed as the item's item graphic.
The ItemPicture and [ItemPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The ItemPicture property is used to override the default item graphic defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties. These default graphics must be defined for item graphics to be shown.
The ItemPicture property can be set before the default graphics have been defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties, but item graphics are not shown until these default graphics are defined.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as ItemPicture, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as ItemPicture property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPicture property can be set to the value Nothing (NULL), which restores the default graphic.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ItemPicture Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPicture*
Defines the graphic displayed as the item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**ItemPicture** **As stdole.IPictureDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ItemPicture** **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *refPictureObj* = *object*.**ItemPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ItemPicture**(); |
| C | **HRESULT** *object*->get_**ItemPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemPicture**(**ByVal** *refPictureObj* **As stdole.IPictureDisp**) |
| VB | *object*.**ItemPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ItemPicture**(**stdole.IPictureDisp** *refPictureObj*); |
| VC++ | **void** *object*->Put**ItemPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ItemPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemPicture** = *refPictureObj* **As stdole.IPictureDisp** |
| VB | **Set** *object*.**ItemPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *object*.**ItemPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**ItemPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ItemPicture**(**IPictureDisp*** *refPictureObj*); |
object
A VirtualItem object.
refPictureObj
Defines the graphic displayed as the item's item graphic. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Image.Picture instead
The ItemPicture property defines the graphic displayed as the item's item graphic.
The VirtualItem.[ItemPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPicture) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's item graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemPictureAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureAlign*
Defines whether item graphics are aligned with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ItemPictureAlign** **As Boolean** |
| VB | *Boolean* = *object*.**ItemPictureAlign** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ItemPictureAlign**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ItemPictureAlign**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ItemPictureAlign**(); |
| C | **HRESULT** *object*->get_**ItemPictureAlign**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureAlign** = *Boolean* **As Boolean** |
| VB | *object*.**ItemPictureAlign** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ItemPictureAlign** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ItemPictureAlign** = *Boolean*;
**void** *object*->Put**ItemPictureAlign**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ItemPictureAlign**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether item graphics are aligned with higher level cells.
| Boolean | Description |
| --- | --- |
| True | Item graphics of items at a lower level are aligned with the cell of the immediate parent level. |
| False | Item graphics are not aligned, resulting in a still indented, but narrower look. The width of the indentation is determined by the width of the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) bitmaps, the width of the item pictures and the default font used for the tree control. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageAlign instead
The ItemPictureAlign property defines whether item graphics are aligned with higher level cells.
In a [variable height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control, item graphics may be of varying widths and heights. If item bitmaps are smaller than the largest item bitmap used, the item bitmaps are horizontally centered within the space available for item bitmaps. This results in (smaller) item bitmaps not aligned with the cells of the parent level.
See Also SftTree Object | Object Hierarchy
## ItemPictureExpandable Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandable*
Defines the default graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**ItemPictureExpandable** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ItemPictureExpandable** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**ItemPictureExpandable**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ItemPictureExpandable**(); |
| C | **HRESULT** *object*->get_**ItemPictureExpandable**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemPictureExpandable**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ItemPictureExpandable** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ItemPictureExpandable**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ItemPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ItemPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureExpandable** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**ItemPictureExpandable** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**ItemPictureExpandable** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**ItemPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ItemPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the default graphic used to display an expandable item's item graphic. The *refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageExpandable.Picture instead
The ItemPictureExpandable property defines the default graphic used to display an expandable item's item graphic.
The ItemPictureExpandable and [ItemPictureExpandableH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandableH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The ItemPictureExpandable property is used to define the default item graphic displayed for an expandable item, which is currently collapsed. Item graphics are not shown until the properties Items.ItemImageExpandable, Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpandable property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ItemPictureExpandableH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandableH*
Defines the default graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**ItemPictureExpandableH** **As Integer** |
| VB | *Handle* = *object*.**ItemPictureExpandableH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**ItemPictureExpandableH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ItemPictureExpandableH**;
**OLE_HANDLE** *Handle* = *object*->Get**ItemPictureExpandableH**(); |
| C | **HRESULT** *object*->get_**ItemPictureExpandableH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureExpandableH** = *Handle* **As Integer** |
| VB | *object*.**ItemPictureExpandableH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**ItemPictureExpandableH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**ItemPictureExpandableH** = *Handle*;
**void** *object*->Put**ItemPictureExpandableH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ItemPictureExpandableH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle defining the default graphic used to display an expandable item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageExpandable.PictureH instead
The ItemPictureExpandableH property defines the default graphic used to display an expandable item's item graphic.
The [ItemPictureExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandable) and ItemPictureExpandableH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The ItemPictureExpandableH property is used to define the default item graphic displayed for an expandable item, which is currently collapsed. Item graphics are not shown until the properties Items.ItemImageExpandable, Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpandableH property can be set to the value 0 (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTree Object | Object Hierarchy
## ItemPictureExpanded Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpanded*
Defines the default graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**ItemPictureExpanded** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ItemPictureExpanded** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**ItemPictureExpanded**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ItemPictureExpanded**(); |
| C | **HRESULT** *object*->get_**ItemPictureExpanded**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemPictureExpanded**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ItemPictureExpanded** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ItemPictureExpanded**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ItemPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ItemPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureExpanded** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**ItemPictureExpanded** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**ItemPictureExpanded** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**ItemPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ItemPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the default graphic used to display an expanded item's item graphic. The *refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageExpanded.Picture instead
The ItemPictureExpanded property defines the default graphic used to display an expanded item's item graphic.
The ItemPictureExpanded and [ItemPictureExpandedH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandedH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The ItemPictureExpanded property is used to define the default item graphic displayed for an expanded item, which is currently expanded. Item graphics are not shown until the properties Items.[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.ItemImageExpanded and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpanded property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ItemPictureExpandedH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpandedH*
Defines the default graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**ItemPictureExpandedH** **As Integer** |
| VB | *Handle* = *object*.**ItemPictureExpandedH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**ItemPictureExpandedH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ItemPictureExpandedH**;
**OLE_HANDLE** *Handle* = *object*->Get**ItemPictureExpandedH**(); |
| C | **HRESULT** *object*->get_**ItemPictureExpandedH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureExpandedH** = *Handle* **As Integer** |
| VB | *object*.**ItemPictureExpandedH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**ItemPictureExpandedH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**ItemPictureExpandedH** = *Handle*;
**void** *object*->Put**ItemPictureExpandedH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ItemPictureExpandedH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the default graphic used to display an expanded item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageExpanded.PictureH instead
The ItemPictureExpandedH property defines the default graphic used to display an expanded item's item graphic.
The [ItemPictureExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureExpanded) and ItemPictureExpandedH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The ItemPictureExpandedH property is used to define the default item graphic displayed for an expanded item, which is currently expanded. Item graphics are not shown until the properties Items.[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.ItemImageExpanded and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureExpandedH property can be set to the value 0 (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTree Object | Object Hierarchy
## ItemPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureH*
Defines the graphic displayed as the item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.get_**ItemPictureH**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *Handle* = *object*.**ItemPictureH**(**ByVal** *ItemIndex* **As Long**) **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.get_**ItemPictureH**(**int** *ItemIndex*); |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ItemPictureH**[**long** *ItemIndex*];
**OLE_HANDLE** *Handle* = *object*->Get**ItemPictureH**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemPictureH**(**long** *ItemIndex*, **OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemPictureH**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Handle* **As Integer**) |
| VB | *object*.**ItemPictureH**(**ByVal** *ItemIndex* **As Long**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**ItemPictureH**(**int** *ItemIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**ItemPictureH**[**long** *ItemIndex*] = *Handle*;
**void** *object*->Put**ItemPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ItemPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Handle
A bitmap handle. Defines the graphic displayed as the item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.PictureH instead
The ItemPictureH property defines the graphic displayed as the item's item graphic.
The [ItemPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPicture) and ItemPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The ItemPictureH property is used to override the default item graphic defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties. These default graphics must be defined for item graphics to be shown.
The ItemPictureH property can be set before the default graphics have been defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties, but item graphics are not shown until these default graphics are defined.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as ItemPicture, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as ItemPicture property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureH property can be set to the value 0 (NULL), which restores the default graphic.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTree Object | Object Hierarchy
## ItemPictureH Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPictureH*
Defines the graphic displayed as the item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureH** = *Handle* **As Integer** |
| VB | *object*.**ItemPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**ItemPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**ItemPictureH** = *Handle*;
**void** *object*->Put**ItemPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ItemPictureH**(**OLE_HANDLE** *Handle*); |
object
A VirtualItem object.
Handle
A bitmap handle. Defines the graphic displayed as the item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Image.PictureH instead
The ItemPictureH property defines the graphic displayed as the item's item graphic.
The VirtualItem.[ItemPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_ItemPictureH) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's item graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## ItemPictureLeaf Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeaf*
Defines the default graphic used to display a leaf item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**ItemPictureLeaf** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**ItemPictureLeaf** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**ItemPictureLeaf**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**ItemPictureLeaf**(); |
| C | **HRESULT** *object*->get_**ItemPictureLeaf**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**ItemPictureLeaf**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**ItemPictureLeaf** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**ItemPictureLeaf**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**ItemPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**ItemPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureLeaf** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**ItemPictureLeaf** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**ItemPictureLeaf** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**ItemPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**ItemPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the default graphic used to display a leaf item's item graphic. The *refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageLeaf.Picture instead
The ItemPictureLeaf property defines the default graphic used to display a leaf item's item graphic.
The ItemPictureLeaf and [ItemPictureLeafH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeafH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The ItemPictureLeaf property is used to define the default item graphic displayed for an item which doesn't have any dependents. Item graphics are not shown until the properties Items.[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.ItemImageLeaf define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureLeaf property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## ItemPictureLeafH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeafH*
Defines the default graphic used to display a leaf item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**ItemPictureLeafH** **As Integer** |
| VB | *Handle* = *object*.**ItemPictureLeafH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**ItemPictureLeafH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**ItemPictureLeafH**;
**OLE_HANDLE** *Handle* = *object*->Get**ItemPictureLeafH**(); |
| C | **HRESULT** *object*->get_**ItemPictureLeafH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemPictureLeafH** = *Handle* **As Integer** |
| VB | *object*.**ItemPictureLeafH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**ItemPictureLeafH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**ItemPictureLeafH** = *Handle*;
**void** *object*->Put**ItemPictureLeafH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**ItemPictureLeafH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the default graphic used to display a leaf item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageLeaf.PictureH instead
The ItemPictureLeafH property defines the default graphic used to display a leaf item's item graphic.
The [ItemPictureLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemPictureLeaf) and ItemPictureLeafH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The ItemPictureLeafH property is used to define the default item graphic displayed for an item which doesn't have any dependents. Item graphics are not shown until the properties Items.[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.ItemImageLeaf define valid graphics.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image), Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as item graphics are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If an item is disabled (see Item.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The ItemPictureLeafH property can be set to the value 0 (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.
The Items.[ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of item graphics.
See Also SftTree Object | Object Hierarchy
## Items Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items*
Returns the [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refItemsObj* = *object*.**Items** **As SftTreeItems** |
| VB | **Set** *refItemsObj* = *object*.**Items** **As SftTreeItems** |
| C#.NET | **SftTreeItems** *refItemsObj* = *object*.**Items**; |
| VC++ | **ISftTreeItems*** *refItemsObj* = *object*->**Items**;
**ISftTreeItems*** *refItemsObj* = *object*->Get**Items**(); |
| C | **HRESULT** *object*->get_**Items**(**ISftTreeItems**** *refItemsObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refItemsObj
Returns the SftTreeItems object.
### Comments
The Items property returns the SftTreeItems object.
The SftTreeItems object describes attributes that apply to all items in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object * refItemsObj*. A control has only one SftTreeItems object.
An individual item's [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object can be accessed through the control's Item property.
See Also SftTree Object | Object Hierarchy
## ItemShown Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemShown*
Defines whether an item is shown.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Shown* = *object*.get_**ItemShown**(**ByVal** *ItemIndex* **As Integer**) **As Boolean** |
| VB | *Shown* = *object*.**ItemShown**(**ByVal** *ItemIndex* **As Long**) **As Boolean** |
| C#.NET | **bool** *Shown* = *object*.get_**ItemShown**(**int** *ItemIndex*); |
| VC++ | **VARIANT_BOOL** *Shown* = *object*->**ItemShown**[**long** *ItemIndex*];
**VARIANT_BOOL** *Shown* = *object*->Get**ItemShown**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemShown**(**long** *ItemIndex*, **VARIANT_BOOL*** *Shown*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemShown**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Shown* **As Boolean**) |
| VB | *object*.**ItemShown**(**ByVal** *ItemIndex* **As Long**) = *Shown* **As Boolean** |
| C#.NET | **void** *object*.set_**ItemShown**(**int** *ItemIndex*, **bool** *Shown*); |
| VC++ | **VARIANT_BOOL** *object*->**ItemShown**[**long** *ItemIndex*] = *Shown*;
**void** *object*->Put**ItemShown**(**long** *ItemIndex*, **VARIANT_BOOL** *Shown*); |
| C | **HRESULT** *object*->put_**ItemShown**(**long** *ItemIndex*, **VARIANT_BOOL** *Shown*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Shown
Defines whether an item is shown.
| Boolean | Description |
| --- | --- |
| True | The item is shown. |
| False | The item is not shown. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Shown instead
The ItemShown property defines whether an item is shown.
An item is considered shown (or visible) if its immediate parent item and all its indirect parent items are [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or if the item doesn't have a parent item. If a parent item is collapsed, its dependents are considered not shown.
The Item.Shown property is used to determine if an item is currently visible, i.e., its parent items are expanded and visible themselves. The Item.Shown property does NOT control whether the item is currently in the range of items visible to the user in the tree control's client area. The Item.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used to display an item in the tree control's client area.
By setting the Item.Shown property to True, an item is made visible by expanding all its direct and indirect parent items. To display the item in the tree control's client area, use the Item.MakeVisible method.
See Also SftTree Object | Object Hierarchy
## ItemsShown Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemsShown*
Returns the number of completely and partially visible items in the client area.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Shown) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**ItemsShown** **As Integer** |
| VB | *Count* = *object*.**ItemsShown** **As Long** |
| C#.NET | **int** *Count* = *object*.**ItemsShown**; |
| VC++ | **long** *Count* = *object*->**ItemsShown**;
**long** *Count* = *object*->Get**ItemsShown**(); |
| C | **HRESULT** *object*->get_**ItemsShown**(**long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Returns the number of completely and partially visible items in the client area.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Shown instead
The ItemsShown property returns the number of completely and partially visible items in the client area.
The ItemsShown property returns the total number of visible items in the tree control's client area, including partially visible items. The Items.[ShownComplete](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShownComplete) property returns the number of completely visible items, not including partial items.
See Also SftTree Object | Object Hierarchy
## ItemsShownComplete Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemsShownComplete*
Returns the number of completely visible items in the client area.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ShownComplete](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShownComplete) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**ItemsShownComplete** **As Integer** |
| VB | *Count* = *object*.**ItemsShownComplete** **As Long** |
| C#.NET | **int** *Count* = *object*.**ItemsShownComplete**; |
| VC++ | **long** *Count* = *object*->**ItemsShownComplete**;
**long** *Count* = *object*->Get**ItemsShownComplete**(); |
| C | **HRESULT** *object*->get_**ItemsShownComplete**(**long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Returns the number of completely visible items in the client area.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ShownComplete instead
The ItemsShownComplete property returns the number of completely visible items in the client area.
The ItemsShownComplete property returns the total number of completely visible items in the tree control's client area, not including partially visible items. The Items.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Shown) property returns the number of visible items, including partial items.
See Also SftTree Object | Object Hierarchy
## ItemStatus Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemStatus*
Defines an item's enabled/disabled status.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.get_**ItemStatus**(**ByVal** *ItemIndex* **As Integer**) **As Boolean** |
| VB | *Boolean* = *object*.**ItemStatus**(**ByVal** *ItemIndex* **As Long**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.get_**ItemStatus**(**int** *ItemIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ItemStatus**[**long** *ItemIndex*];
**VARIANT_BOOL** *Boolean* = *object*->Get**ItemStatus**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**ItemStatus**(**long** *ItemIndex*, **VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**ItemStatus**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Boolean* **As Boolean**) |
| VB | *object*.**ItemStatus**(**ByVal** *ItemIndex* **As Long**) = *Boolean* **As Boolean** |
| C#.NET | **void** *object*.set_**ItemStatus**(**int** *ItemIndex*, **bool** *Boolean*); |
| VC++ | **VARIANT_BOOL** *object*->**ItemStatus**[**long** *ItemIndex*] = *Boolean*;
**void** *object*->Put**ItemStatus**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ItemStatus**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Boolean
Defines an item's enabled/disabled status.
| Boolean | Description |
| --- | --- |
| True | The item is enabled. |
| False | The item is disabled. It is drawn in a "grayed" manner indicating its status. Except for the visual difference, a disabled item is treated exactly like an enabled item. It is up to the application to implement a different behavior if an item is disabled. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Enabled instead
The ItemStatus property defines an item's enabled/disabled status.
See Also SftTree Object | Object Hierarchy
## ItemStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemStyle*
Defines the item style.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Style* = *object*.**ItemStyle** **As [SftTreeItemStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeItemStyleConstants)** |
| VB | *Style* = *object*.**ItemStyle** **As SftTreeItemStyleConstants** |
| C#.NET | **SftTreeItemStyleConstants** *Style* = *object*.**ItemStyle**; |
| VC++ | **enum SftTreeItemStyleConstants** *Style* = *object*->**ItemStyle**;
**enum SftTreeItemStyleConstants** *Style* = *object*->Get**ItemStyle**(); |
| C | **HRESULT** *object*->get_**ItemStyle**(**enum SftTreeItemStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ItemStyle** = *Style* **As SftTreeItemStyleConstants** |
| VB | *object*.**ItemStyle** = *Style* **As SftTreeItemStyleConstants** |
| C#.NET | **SftTreeItemStyleConstants** *object*.**ItemStyle** = *Style*; |
| VC++ | **enum SftTreeItemStyleConstants** *object*->**ItemStyle** = *Style*;
**void** *object*->Put**ItemStyle**(**enum SftTreeItemStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**ItemStyle**(**enum SftTreeItemStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the item style.
| Style | Value | Description |
| --- | --- | --- |
| itemSftTreeFixed | 0 | All items in the tree control have the same height. |
| itemSftTreeVariable | 1 | The height of each item in the tree control may vary based on item attributes, such as fonts used, graphics sizes, etc. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Style instead
The ItemStyle property defines the item style.
It determines whether [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) or variable height items are used.
See Also SftTree Object | Object Hierarchy
## KeepPosition Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_KeepPosition*
Defines whether this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) must remain in its current position and cannot be reordered.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**KeepPosition** **As Boolean** |
| VB | *Boolean* = *object*.**KeepPosition** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**KeepPosition**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**KeepPosition**;
**VARIANT_BOOL** *Boolean* = *object*->Get**KeepPosition**(); |
| C | **HRESULT** *object*->get_**KeepPosition**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**KeepPosition** = *Boolean* **As Boolean** |
| VB | *object*.**KeepPosition** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**KeepPosition** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**KeepPosition** = *Boolean*;
**void** *object*->Put**KeepPosition**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**KeepPosition**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Boolean
Defines whether this column header must remain in its current position and cannot be reordered.
| Boolean | Description |
| --- | --- |
| True | The column must remain in the current column position. [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) on the left can be reordered but cannot be moved to the right of the column and vice versa. This is usually used with the first column, to prevent the user from changing its position when using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop). |
| False | The column is not restricted to its current position. |
### Comments
The KeepPosition property defines whether this column header must remain in its current position and cannot be reordered.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Reorderable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Reorderable) property can be used to define whether columns can be reordered using column drag & drop.
See Also SftTreeHeader Object | Object Hierarchy
## KeyDown Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyDown*
A key is pressed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**KeyDownEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**KeyDownEvent** |
| VB | **Private Sub** *object*_**KeyDown**(*KeyCode* **As Integer**, **ByVal** *Shift* **As Integer**) |
| C#.NET | **void** *object*_**KeyDownEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**KeyDown***object*(**short*** *KeyCode*, **short** *Shift*); |
| C | **HRESULT** On**KeyDown***object*(**short*** *KeyCode*, **short** *Shift*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
KeyCode
The virtual key pressed. See your development environment documentation for available key code constants.
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
### Comments
The KeyDown event occurs when a key is pressed.
The KeyDown event is generated when the user presses a key while the tree control has the input focus. The KeyDown event is not generated during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
If the tree control is part of a parent window (form, dialog, etc.) which has a default button (OK, Cancel) and the user presses the ENTER or ESCAPE keys, this event is not generated.
The KeyDown event is never generated for the TAB key.
To interpret keyboard characters (ANSI characters) use the [KeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress) event.
The key typed by the user can be suppressed by setting *KeyCode* to 0. It can be modified by assigning a new value to the variable.
See Also SftTree Object | Object Hierarchy
## KeyPress Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress*
An ANSI key is pressed or released.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**KeyPressEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**KeyPressEvent** |
| VB | **Private Sub** *object*_**KeyPress**(*KeyAscii* **As Integer**) |
| C#.NET | **void** *object*_**KeyPressEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**KeyPress***object*(**short*** *KeyAscii*); |
| C | **HRESULT** On**KeyPress***object*(**short*** *KeyAscii*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
KeyAscii
Describes a standard numeric ANSI key code.
### Comments
The KeyPress event occurs when an ANSI key is pressed or released.
The KeyPress event is generated when the user presses a key while the tree control has the input focus. The KeyPress event is not generated during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
Use [KeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyDown) and [KeyUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyUp) events to handle any keystroke not recognized by KeyPress, such as function keys, editing keys, navigation keys, and any combination of these with keyboard modifiers, such as SHIFT, CONTROL and ALT keys. Unlike the KeyDown and KeyUp events, KeyPress doesn't indicate the physical state of the keyboard; it passes a character instead.
The key typed by the user can be suppressed by setting * KeyAscii* to 0. It can be modified by assigning a new value to the *KeyAscii* variable.
See Also SftTree Object | Object Hierarchy
## KeyUp Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyUp*
A key is released.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**KeyUpEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**KeyUpEvent** |
| VB | **Private Sub** *object*_**KeyUp**(*KeyCode* **As Integer**, **ByVal** *Shift* **As Integer**) |
| C#.NET | **void** *object*_**KeyUpEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**KeyUp***object*(**short*** *KeyCode*, **short** *Shift*); |
| C | **HRESULT** On**KeyUp***object*(**short*** *KeyCode*, **short** *Shift*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
KeyCode
The virtual key released. See your development environment documentation for available key code constants.
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
### Comments
The KeyUp event occurs when a key is released.
The KeyUp event is generated when the user releases a key while the tree control has the input focus. The KeyUp event is not generated during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
If the tree control is part of a parent window (form, dialog, etc.) which has a default button (OK, Cancel) and the user releases the ENTER or ESCAPE keys, this event is not generated.
The KeyUp event is never generated for the TAB key.
To interpret keyboard characters (ANSI characters) use the [KeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_KeyPress) event.
The key typed by the user can be suppressed by setting *KeyCode* to 0. It can be modified by assigning a new value to the variable.
See Also SftTree Object | Object Hierarchy
## LabelImage Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage*
Defines the label graphic displayed in this item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**LabelImage** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**LabelImage** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**LabelImage**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**LabelImage**;
**ISftPictureObject*** *refImageObj* = *object*->Get**LabelImage**(); |
| C | **HRESULT** *object*->get_**LabelImage**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**LabelImage** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**LabelImage** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**LabelImage** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**LabelImage** = *refImageObj*;
**void** *object*->Put**LabelImage**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**LabelImage**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
refImageObj
Defines the label graphic displayed in this item.
### Comments
The LabelImage property defines the label graphic displayed in this item.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as LabelImage property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as LabelImage property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.[ClearLabelImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If the image object *refImageObj* defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see [Bitmap Transparency](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_bitmap_transparency)).
The Items.ClearLabelImages method can be used to remove all label graphics. The LabelImage property can be set to the value Nothing (NULL), which removes the graphic from the item.
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of label graphics.
See Also SftTreeItem Object | Object Hierarchy
## LabelPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPicture*
Defines the graphic displayed as an item's label graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.get_**LabelPicture**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**LabelPicture**(**ByVal** *ItemIndex* **As Long**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.get_**LabelPicture**(**int** *ItemIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**LabelPicture**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**LabelPicture**(**long** *ItemIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**LabelPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**LabelPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**LabelPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**LabelPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**LabelPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**LabelPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | **Set** *object*.**LabelPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**LabelPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**LabelPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**LabelPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
refPictureObj
Defines the graphic displayed as an item's label graphic. The *Picture* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.LabelImage.Picture instead
The LabelPicture property defines the graphic displayed as an item's label graphic.
The LabelPicture and [LabelPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as LabelPicture property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as LabelPicture property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.[ClearLabelImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearLabelImages method can be used to remove all label graphics. The LabelPicture property can be set to the value Nothing (NULL), which removes the graphic from the item.
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of label graphics.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## LabelPicture Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPicture*
Defines the graphic displayed as the item's label graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**LabelPicture** **As stdole.IPictureDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**LabelPicture** **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *refPictureObj* = *object*.**LabelPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**LabelPicture**(); |
| C | **HRESULT** *object*->get_**LabelPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**LabelPicture**(**ByVal** *refPictureObj* **As stdole.IPictureDisp**) |
| VB | *object*.**LabelPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**LabelPicture**(**stdole.IPictureDisp** *refPictureObj*); |
| VC++ | **void** *object*->Put**LabelPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**LabelPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**LabelPicture** = *refPictureObj* **As stdole.IPictureDisp** |
| VB | **Set** *object*.**LabelPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *object*.**LabelPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**LabelPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**LabelPicture**(**IPictureDisp*** *refPictureObj*); |
object
A VirtualItem object.
refPictureObj
Defines the graphic displayed as the item's label graphic. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.LabelImage.Picture instead
The LabelPicture property defines the graphic displayed as the item's label graphic.
The VirtualItem.[LabelPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPicture) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's label graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## LabelPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPictureH*
Defines the graphic displayed as an item's label graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.get_**LabelPictureH**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *Handle* = *object*.**LabelPictureH**(**ByVal** *ItemIndex* **As Long**) **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.get_**LabelPictureH**(**int** *ItemIndex*); |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**LabelPictureH**[**long** *ItemIndex*];
**OLE_HANDLE** *Handle* = *object*->Get**LabelPictureH**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**LabelPictureH**(**long** *ItemIndex*, **OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**LabelPictureH**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Handle* **As Integer**) |
| VB | *object*.**LabelPictureH**(**ByVal** *ItemIndex* **As Long**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**LabelPictureH**(**int** *ItemIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**LabelPictureH**[**long** *ItemIndex*] = *Handle*;
**void** *object*->Put**LabelPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**LabelPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Handle
A bitmap handle. Defines the graphic displayed as an item's label graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.LabelImage.PictureH instead
The LabelPictureH property defines the graphic displayed as an item's label graphic.
The [LabelPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LabelPicture) and LabelPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as LabelPictureH property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as LabelPicture property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.[ClearLabelImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearLabelImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearLabelImages method can be used to remove all label graphics. The LabelPictureH property can be set to the value 0 (NULL), which removes the graphic from the item.
The [VAlignStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle) property can be used to define the vertical alignment of label graphics.
See Also SftTree Object | Object Hierarchy
## LabelPictureH Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPictureH*
Defines the graphic displayed as the item's label graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[LabelImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LabelImage).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**LabelPictureH** = *Handle* **As Integer** |
| VB | *object*.**LabelPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**LabelPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**LabelPictureH** = *Handle*;
**void** *object*->Put**LabelPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**LabelPictureH**(**OLE_HANDLE** *Handle*); |
object
A VirtualItem object.
Handle
A bitmap handle. Defines the graphic displayed as the item's label graphic. Defines the graphic displayed as the item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.LabelImage.PictureH instead
The LabelPictureH property defines the graphic displayed as the item's label graphic.
The VirtualItem.[LabelPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_LabelPictureH) property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's label graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## LastDependent Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDependent*
Returns the index of an item's last [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents).
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LastDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastDependent) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DependentIndex* = *object*.get_**LastDependent**(**ByVal** *ItemIndex* **As Integer**) **As Integer**
*DependentIndex* = *object*.**LastDependent**(**ByVal** *ItemIndex* **As Integer**) **As Integer** Note |
| VB | *DependentIndex* = *object*.**LastDependent**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *DependentIndex* = *object*.get_**LastDependent**(**int** *ItemIndex*); |
| VC++ | **long** *DependentIndex* = *object*->**LastDependent**[**long** *ItemIndex*];
**long** *DependentIndex* = *object*->Get**LastDependent**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**LastDependent**(**long** *ItemIndex*, **long*** *DependentIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose last dependent item is to be returned.
DependentIndex
Returns the index of the item's last dependent. If the item doesn't have a dependent, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.LastDependent instead
The LastDependent property returns the index of an item's last dependent.
The Item.[FirstDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstDependent) property can be used to retrieve an item's first dependent.
See Also SftTree Object | Object Hierarchy
## LastDependent Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastDependent*
Returns the item's last [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**LastDependent** **As Integer** |
| VB | *ItemIndex* = *object*.**LastDependent** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**LastDependent**; |
| VC++ | **long** *ItemIndex* = *object*->**LastDependent**;
**long** *ItemIndex* = *object*->Get**LastDependent**(); |
| C | **HRESULT** *object*->get_**LastDependent**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's last dependent. If the item doesn't have a dependent, -1 is returned.
### Comments
The LastDependent property returns the item's last dependent.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[FirstDependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstDependent) property can be used to retrieve an item's first dependent.
See Also SftTreeItem Object | Object Hierarchy
## LastDisplayColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDisplayColumn*
Returns the index of the last displayed column.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**LastDisplayColumn** **As Short** |
| VB | *DispColIndex* = *object*.**LastDisplayColumn** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**LastDisplayColumn**; |
| VC++ | **short** *DispColIndex* = *object*->**LastDisplayColumn**;
**short** *DispColIndex* = *object*->Get**LastDisplayColumn**(); |
| C | **HRESULT** *object*->get_**LastDisplayColumn**(**short*** *DispColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DispColIndex
Returns the index of the last displayed column.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.LastDisplayColumn instead
The LastDisplayColumn property returns the index of the last displayed column.
The last column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the last displayed column. It is not necessarily displayed or visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
In a [split tree control](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar), the last displayed column of the left pane is returned.
The first displayed column can be determined using the ColumnsObj.[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the LastDisplayColumn property returns the display column number of the last displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) property returns the zero-based column number of the last displayed column of the right pane in a split tree control.
See Also SftTree Object | Object Hierarchy
## LastDisplayColumn Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn*
Returns the index of the last displayed column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**LastDisplayColumn** **As Short** |
| VB | *DispColIndex* = *object*.**LastDisplayColumn** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**LastDisplayColumn**; |
| VC++ | **short** *DispColIndex* = *object*->**LastDisplayColumn**;
**short** *DispColIndex* = *object*->Get**LastDisplayColumn**(); |
| C | **HRESULT** *object*->get_**LastDisplayColumn**(**short*** *DispColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
DispColIndex
Returns the index of the last displayed column.
### Comments
The LastDisplayColumn property returns the index of the last displayed column.
The last column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the last displayed column. It is not necessarily displayed or visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
In a [split tree control](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar), the last displayed column of the left pane is returned.
The first displayed column can be determined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the LastDisplayColumn property returns the display column number of the last displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) property returns the zero-based column number of the last displayed column of the right pane in a split tree control.
See Also SftTreeColumns Object | Object Hierarchy
## LastDisplayColumn2 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastDisplayColumn2*
Returns the index of the last displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[LastDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**LastDisplayColumn2** **As Short** |
| VB | *DispColIndex* = *object*.**LastDisplayColumn2** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**LastDisplayColumn2**; |
| VC++ | **short** *DispColIndex* = *object*->**LastDisplayColumn2**;
**short** *DispColIndex* = *object*->Get**LastDisplayColumn2**(); |
| C | **HRESULT** *object*->get_**LastDisplayColumn2**(**short*** *DispColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DispColIndex
Returns the index of the last displayed column in the right pane.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.LastDisplayColumn2 instead
The LastDisplayColumn2 property returns the index of the last displayed column in the right pane.
The last column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the last displayed column. It is not necessarily displayed or visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The first displayed column in the right pane can be determined using the ColumnsObj.[FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the LastDisplayColumn2 property returns the display column number of the last displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property returns the zero-based column number of the last displayed column of the left pane in a split tree control.
See Also SftTree Object | Object Hierarchy
## LastDisplayColumn2 Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn2*
Returns the index of the last displayed column in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *DispColIndex* = *object*.**LastDisplayColumn2** **As Short** |
| VB | *DispColIndex* = *object*.**LastDisplayColumn2** **As Integer** |
| C#.NET | **short** *DispColIndex* = *object*.**LastDisplayColumn2**; |
| VC++ | **short** *DispColIndex* = *object*->**LastDisplayColumn2**;
**short** *DispColIndex* = *object*->Get**LastDisplayColumn2**(); |
| C | **HRESULT** *object*->get_**LastDisplayColumn2**(**short*** *DispColIndex*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
DispColIndex
Returns the index of the last displayed column in the right pane.
### Comments
The LastDisplayColumn2 property returns the index of the last displayed column in the right pane.
The last column with a width greater than 0 ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) is considered the last displayed column. It is not necessarily displayed or visible if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is in effect. A column can be made visible using the Column.[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method.
The first displayed column in the right pane can be determined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[FirstDisplayColumn2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn2) property.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the LastDisplayColumn2 property returns the display column number of the last displayed column. The display column number can be translated to a real column number using the ColumnsObj.[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) property.
The ColumnsObj.[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property returns the zero-based column number of the last displayed column of the left pane in a split tree control.
See Also SftTreeColumns Object | Object Hierarchy
## LastShown Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown*
Returns the index of the last [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus) in the tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**LastShown** **As Integer** |
| VB | *ItemIndex* = *object*.**LastShown** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**LastShown**; |
| VC++ | **long** *ItemIndex* = *object*->**LastShown**;
**long** *ItemIndex* = *object*->Get**LastShown**(); |
| C | **HRESULT** *object*->get_**LastShown**(**long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
Returns the index of the last visible item in the tree control. -1 is returned, if no item is found.
### Comments
The LastShown property returns the index of the last visible item in the tree control.
Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown), Item.[PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown) to retrieve information about item visibility.
See Also SftTreeItems Object | Object Hierarchy
## LastSibling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LastSibling*
Returns the index of an item's last sibling item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *SiblingIndex* = *object*.get_**LastSibling**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *SiblingIndex* = *object*.**LastSibling**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *SiblingIndex* = *object*.get_**LastSibling**(**int** *ItemIndex*); |
| VC++ | **long** *SiblingIndex* = *object*->**LastSibling**[**long** *ItemIndex*];
**long** *SiblingIndex* = *object*->Get**LastSibling**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**LastSibling**(**long** *ItemIndex*, **long*** *SiblingIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose last sibling item is to be returned.
SiblingIndex
Returns the index of an item's last sibling item. If the item doesn't have a sibling item, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.LastSibling instead
The LastSibling property returns the index of an item's last sibling item.
The last sibling of item *ItemIndex* is found by scanning towards the end of the tree control and locating an item on the same level (Item.[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as item *ItemIndex* without encountering a new parent item.
The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) property can be used to retrieve an item's first sibling. The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) and Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) properties can be used to retrieve an item's next or previous sibling.
See Also SftTree Object | Object Hierarchy
## LastSibling Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling*
Returns the item's last sibling.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**LastSibling** **As Integer** |
| VB | *ItemIndex* = *object*.**LastSibling** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**LastSibling**; |
| VC++ | **long** *ItemIndex* = *object*->**LastSibling**;
**long** *ItemIndex* = *object*->Get**LastSibling**(); |
| C | **HRESULT** *object*->get_**LastSibling**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's last sibling. If the item doesn't have a sibling item, -1 is returned.
### Comments
The LastSibling property returns the item's last sibling.
The last sibling of the item is found by scanning towards the end of the tree control and locating an item on the same level ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as the item without encountering a new parent item.
The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) property can be used to retrieve an item's first sibling. The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) and Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) properties can be used to retrieve an item's next or previous sibling.
See Also SftTreeItem Object | Object Hierarchy
## LeftButtonOnly Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly*
Defines whether the tree control responds only to the left mouse button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**LeftButtonOnly** **As Boolean** |
| VB | *Boolean* = *object*.**LeftButtonOnly** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**LeftButtonOnly**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**LeftButtonOnly**;
**VARIANT_BOOL** *Boolean* = *object*->Get**LeftButtonOnly**(); |
| C | **HRESULT** *object*->get_**LeftButtonOnly**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**LeftButtonOnly** = *Boolean* **As Boolean** |
| VB | *object*.**LeftButtonOnly** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**LeftButtonOnly** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**LeftButtonOnly** = *Boolean*;
**void** *object*->Put**LeftButtonOnly**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**LeftButtonOnly**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the tree control responds only to the left mouse button.
| Boolean | Description |
| --- | --- |
| True | Left mouse button clicks are handled by the tree control. [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown), [MouseUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseUp), [Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click), [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick), [ItemClickAgain](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClickAgain) and [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events are only generated for the left mouse button. |
| False | Left mouse button clicks are not handled by the tree control. MouseDown, MouseUp, Click, ItemClick, ItemClickAgain and ItemDblClick events are generated for all mouse buttons. |
### Comments
The LeftButtonOnly property defines whether the tree control responds only to the left mouse button.
The [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) property can be used to ignore the right and middle mouse button, but still allows MouseDown and MouseUp events for these buttons.
See Also SftTree Object | Object Hierarchy
## LeftItemClickOnly Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly*
Defines whether the tree control generates Item(Dbl)[Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click) events only in response to the left mouse button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**LeftItemClickOnly** **As Boolean** |
| VB | *Boolean* = *object*.**LeftItemClickOnly** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**LeftItemClickOnly**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**LeftItemClickOnly**;
**VARIANT_BOOL** *Boolean* = *object*->Get**LeftItemClickOnly**(); |
| C | **HRESULT** *object*->get_**LeftItemClickOnly**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**LeftItemClickOnly** = *Boolean* **As Boolean** |
| VB | *object*.**LeftItemClickOnly** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**LeftItemClickOnly** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**LeftItemClickOnly** = *Boolean*;
**void** *object*->Put**LeftItemClickOnly**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**LeftItemClickOnly**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the tree control generates [Item(Dbl)Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events only in response to the left mouse button.
| Boolean | Description |
| --- | --- |
| True | Click, ItemClick, [ItemClickAgain](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClickAgain) and [ItemDblClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemDblClick) events are only generated for the left mouse button. |
| False | Click, ItemClick, ItemClickAgain and ItemDblClick events are generated for all mouse buttons. |
### Comments
The LeftItemClickOnly property defines whether the tree control generates Item(Dbl)Click events only in response to the left mouse button.
[MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) are [MouseUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseUp) are generated for all mouse buttons (provided the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) property does not further limit these).
The LeftButtonOnly property can be used to completely ignore the right and middle mouse button. If the LeftButtonOnly property is set to True, the LeftItemClickOnly property has no effect.
See Also SftTree Object | Object Hierarchy
## LeftWindow Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftWindow*
Returns the window handle of the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[LeftWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_LeftWindow) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**LeftWindow** **As Integer** |
| VB | *Handle* = *object*.**LeftWindow** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**LeftWindow**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**LeftWindow**;
**OLE_HANDLE** *Handle* = *object*->Get**LeftWindow**(); |
| C | **HRESULT** *object*->get_**LeftWindow**(**OLE_HANDLE*** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
Returns the window handle of the left pane in a split tree control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.LeftWindow instead
The LeftWindow property returns the window handle of the left pane in a split tree control.
The LeftWindow property should not be used and may cause incompatibilities with future releases of SftTree/OCX.
The Splitter.[RightWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_RightWindow) property returns the window handle of the right pane in a split tree control.
See Also SftTree Object | Object Hierarchy
## LeftWindow Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_LeftWindow*
Returns the window handle of the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**LeftWindow** **As Integer** |
| VB | *Handle* = *object*.**LeftWindow** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**LeftWindow**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**LeftWindow**;
**OLE_HANDLE** *Handle* = *object*->Get**LeftWindow**(); |
| C | **HRESULT** *object*->get_**LeftWindow**(**OLE_HANDLE*** *Handle*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Handle
Returns the window handle of the left pane in a split tree control.
### Comments
The LeftWindow property returns the window handle of the left pane in a split tree control.
The LeftWindow property should not be used and may cause incompatibilities with future releases of SftTree/OCX.
The [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[RightWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_RightWindow) property returns the window handle of the right pane in a split tree control.
See Also SftTreeSplitter Object | Object Hierarchy
## Level Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level*
Defines the item's level number.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Lvl* = *object*.**Level** **As Short** |
| VB | *Lvl* = *object*.**Level** **As Integer** |
| C#.NET | **short** *Lvl* = *object*.**Level**; |
| VC++ | **short** *Lvl* = *object*->**Level**;
**short** *Lvl* = *object*->Get**Level**(); |
| C | **HRESULT** *object*->get_**Level**(**short*** *Lvl*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Level** = *Lvl* **As Short** |
| VB | *object*.**Level** = *Lvl* **As Integer** |
| C#.NET | **short** *object*.**Level** = *Lvl*; |
| VC++ | **short** *object*->**Level** = *Lvl*;
**void** *object*->Put**Level**(**short** *Lvl*); |
| C | **HRESULT** *object*->put_**Level**(**short** *Lvl*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Lvl
Defines the item's level number. The valid range is 0 through 63.
### Comments
The Level property defines the item's level number.
The Level property determines the "indentation" of an item. By changing an item's level number, its parent relation is automatically adjusted by the tree control. Using this method, the application does not have to manipulate any parent/child relationships, but can instead treat the entire list of items in a tree control as a linear list, an array of items.
The root (or highest) level is level 0, dependents are on levels 1, 2, 3 and lower. The valid range of levels is 0 through 63.
When changing an item's level using the Level property, its (current and new) parent items will automatically be [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) to make the item visible.
The indentation of item levels can be defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Indentation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Indentation) property.
While logically the first item in the tree control should be at level 0, this is not necessary. Also, a parent item does not necessarily require an immediate [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) (on the next lower level); its first dependent could be on a much lower level. While this is very application specific, SftTree/OCX does allow you to build hierarchies of items where parent/child relationships don't have to follow strict rules.
See Also SftTreeItem Object | Object Hierarchy
## License Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_License*
Returns the product's license number.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**License** **As String** |
| VB | *Text* = *object*.**License** **As String** |
| C#.NET | **string** *Text* = *object*.**License**; |
| VC++ | **_bstr_t** *Text* = *object*->**License**;
**_bstr_t** *Text* = *object*->Get**License**(); |
| C | **HRESULT** *object*->get_**License**(**BSTR*** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
Returns the product's license number.
### Comments
The License property returns the product's license number.
The License property returns the license number of the current installation of SftTree/OCX. A [demo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_demo_application) version of the product does not have a license number.
The license number is used for [product support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contactsoftel). When requesting product support, please always include your license number. Without your license number we will not be able to help you.
See Also SftTree Object | Object Hierarchy
## Lines Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines*
Defines the number of text lines used for item height calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**Lines** **As Short** |
| VB | *Count* = *object*.**Lines** **As Integer** |
| C#.NET | **short** *Count* = *object*.**Lines**; |
| VC++ | **short** *Count* = *object*->**Lines**;
**short** *Count* = *object*->Get**Lines**(); |
| C | **HRESULT** *object*->get_**Lines**(**short*** *Count*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Lines** = *Count* **As Short** |
| VB | *object*.**Lines** = *Count* **As Integer** |
| C#.NET | **short** *object*.**Lines** = *Count*; |
| VC++ | **short** *object*->**Lines** = *Count*;
**void** *object*->Put**Lines**(**short** *Count*); |
| C | **HRESULT** *object*->put_**Lines**(**short** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Defines the number of text lines used for item height calculation.
### Comments
The Lines property defines the number of text lines used for item height calculation.
If [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items in a tree control have the same height. The best height for items is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired, the Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property should be used to set the expected (maximum) number of lines per item. This insures that multiple lines of text will fit within the vertical space allocated to each item. Some properties which override default properties are not taken into consideration when calculating the item height. E.g., the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) property does not affect the item height. It must be chosen to be smaller or equal to the size of the [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) property, otherwise text may be clipped vertically.
If variable height items are used (see Items.Style), items in a tree control can have varying heights. The best height for each item is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired, the Items.Lines property should be used to set the maximum number of lines to be displayed. This insures that multiple lines of text will fit within the vertical space allocated to each item. If a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) has more text lines than defined using the Items.Lines property, the lines are not visible. All properties of an item, including cell properties such as the Cell.Font and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties, also affect the item height.
In order to enable multi-line text or [word wrap](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellWordWrap), the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) and Column.CellWordWrap properties have to be set.
If fixed height items are used (see Items.Style), a tree control defaults to one text line. If the Column.CellMultiline property is set, multi-line text is added and the text exceeds the number of lines defined using the Items.Lines property, the text will be truncated vertically.
If variable height items are used (see Items.Style), a tree control defaults to one text line. If the Column.CellMultiline property is set, if more text lines need to be displayed than are defined using the Items.Lines property, only the specified number of text lines are displayed followed by a '+', indicating that text lines have been truncated.
See Also SftTreeItems Object | Object Hierarchy
## Lines Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Lines*
Defines the number of [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text lines used for height calculation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Lines* = *object*.**Lines** **As Short** |
| VB | *Lines* = *object*.**Lines** **As Integer** |
| C#.NET | **short** *Lines* = *object*.**Lines**; |
| VC++ | **short** *Lines* = *object*->**Lines**;
**short** *Lines* = *object*->Get**Lines**(); |
| C | **HRESULT** *object*->get_**Lines**(**short*** *Lines*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Lines** = *Lines* **As Short** |
| VB | *object*.**Lines** = *Lines* **As Integer** |
| C#.NET | **short** *object*.**Lines** = *Lines*; |
| VC++ | **short** *object*->**Lines** = *Lines*;
**void** *object*->Put**Lines**(**short** *Lines*); |
| C | **HRESULT** *object*->put_**Lines**(**short** *Lines*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Lines
Defines the number of row header text lines used for height calculation.
### Comments
The Lines property defines the number of row header text lines used for height calculation.
If [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items in a tree control have the same height. The best height for items is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired for row headers, the Lines property should be used to set the expected (maximum) number of lines per item. This insures that multiple lines of text will fit within the vertical space allocated to each item. Some properties which override default properties are not taken into consideration when calculating the item height. E.g., the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) property does not affect the item height. It must be chosen to be smaller or equal to the size of the Font property, otherwise text may be clipped vertically.
If variable height items are used (see Items.Style), items in a tree control can have varying heights. The best height for each item is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired for row headers, the Lines property should be used to set the maximum number of lines to be displayed. This insures that multiple lines of text will fit within the vertical space allocated to each item. If a row header has more text lines than defined using the Lines property, the lines are not visible. All properties of an item, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) properties such as the Cell.Font and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties, also affect the item height.
Row headers support multi-line text using new-line characters (CR-LF). Word-wrap is not supported.
If fixed height items are used (see Items.Style), a tree control defaults to one text line. If multi-line text is added and the text exceeds the number of lines defined using the Lines property, the text will be truncated vertically.
If variable height items are used (see Items.Style), a tree control defaults to one text line. If more text lines need to be displayed than are defined using the Lines property, only the specified number of text lines are displayed followed by a '+', indicating that text lines have been truncated.
See Also SftTreeRowHeaders Object | Object Hierarchy
## List Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_List*
Defines an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.get_**List**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) **As String** |
| VB | *Text* = *object*.**List**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) **As String** |
| C#.NET | **string** *Text* = *object*.get_**List**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **_bstr_t** *Text* = *object*->**List**[**long** *ItemIndex*][**short** *ColIndex*];
**_bstr_t** *Text* = *object*->Get**List**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->get_**List**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**List**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Text* **As String**) |
| VB | *object*.**List**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**List**(**int** *ItemIndex*, **short** *ColIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**List**[**long** *ItemIndex*][**short** *ColIndex*] = *Text*;
**void** *object*->Put**List**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**List**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Text
Defines an item's cell text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Text instead
The List property defines an item's cell text.
The List property cannot be used to add or insert new items. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) and Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) methods add new items. The text specified when adding new items always defines the cell text for the first or only column (column 0).
The cell text may contain new-line characters (CR-LF) if [multi-line cell text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_multilinecelltext) is enabled (see Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline)).
If the cell text is empty, the cell in the preceding column may merge into the empty cell, based on the Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings.
The cell text alignment can be defined using the Column.[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties.
See Also SftTree Object | Object Hierarchy
## ListCount Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListCount*
Returns the number of items in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Count) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**ListCount** **As Integer** |
| VB | *Count* = *object*.**ListCount** **As Long** |
| C#.NET | **int** *Count* = *object*.**ListCount**; |
| VC++ | **long** *Count* = *object*->**ListCount**;
**long** *Count* = *object*->Get**ListCount**(); |
| C | **HRESULT** *object*->get_**ListCount**(**long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Returns the number of items in the tree control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Count instead
The ListCount property returns the number of items in the tree control.
The Items.[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) and Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) methods add new items.
See Also SftTree Object | Object Hierarchy
## ListIndex Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListIndex*
Defines the current item (caret location).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**ListIndex** **As Integer** |
| VB | *ItemIndex* = *object*.**ListIndex** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**ListIndex**; |
| VC++ | **long** *ItemIndex* = *object*->**ListIndex**;
**long** *ItemIndex* = *object*->Get**ListIndex**(); |
| C | **HRESULT** *object*->get_**ListIndex**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ListIndex** = *ItemIndex* **As Integer** |
| VB | *object*.**ListIndex** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**ListIndex** = *ItemIndex*; |
| VC++ | **long** *object*->**ListIndex** = *ItemIndex*;
**void** *object*->Put**ListIndex**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**ListIndex**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
Defines the current item (caret location).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Current instead
The ListIndex property defines the current item (caret location).
The ListIndex property describes the current item, which is the item that has the focus rectangle. This item is not necessarily also selected. The current item is described by the ListIndex property, the currently [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is described by the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property. These are not necessarily the same even in a single-selection tree control (see Items.[NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection) property).
If the tree control is empty, the ListIndex property returns -1. An application must set the property to a valid, existing item. It cannot set it to -1.
The focus rectangle can be hidden using the Items.[ShowFocusRectangle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShowFocusRectangle) property.
See Also SftTree Object | Object Hierarchy
## ListSelection Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListSelection*
Returns the [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.get_**ListSelection**(**ByVal** *SelectionIndex* **As Object**) **As Integer** |
| VB | *ItemIndex* = *object*.**ListSelection**(**ByVal** *SelectionIndex* **As Variant**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.get_**ListSelection**(**object** *SelectionIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**ListSelection**[**const _variant_t**&**** *SelectionIndex*];
**long** *ItemIndex* = *object*->Get**ListSelection**(**const _variant_t**&**** *SelectionIndex*); |
| C | **HRESULT** *object*->get_**ListSelection**(**VARIANT** *SelectionIndex*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
SelectionIndex
The entry number of the selected item index to return. **Visual Basic:** If this parameter is omitted, the index of the first (or only) selected item is returned.
ItemIndex
Returns the item index of the *n*th selected item as specified by *SelectionIndex*. -1 is returned if no item is selected.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Selection instead
The ListSelection property returns the selected item.
The ListSelection property returns the zero-based index of the *n*th selected item as specified by *SelectionIndex*. In a single selection tree control (see Items.[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property), *SelectionIndex* may be omitted or can be specified as 0. The first (and only) selected item is returned or -1 if no item is selected.
In a multiple selection tree control, the index of all selected items can be retrieved. The Items.[SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount) property returns the number of selected items. The Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties are used to retrieve groups of selected items.
See Also SftTree Object | Object Hierarchy
## ListSelection1 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ListSelection1*
Returns the [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.get_**ListSelection1**(**ByVal** *SelectionIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**ListSelection1**(**ByVal** *SelectionIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.get_**ListSelection1**(**int** *SelectionIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**ListSelection1**[**long** *SelectionIndex*];
**long** *ItemIndex* = *object*->Get**ListSelection1**(**long** *SelectionIndex*); |
| C | **HRESULT** *object*->get_**ListSelection1**(**long** *SelectionIndex*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
SelectionIndex
The entry number of the selected item index to return.
ItemIndex
Returns the item index of the *n*th selected item as specified by *SelectionIndex*. -1 is returned if no item is selected.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Selection instead
The ListSelection1 property returns the selected item.
The ListSelection1 property returns the zero-based index of the *n*th selected item as specified by *SelectionIndex*. In a single selection tree control (see Items.[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property), *SelectionIndex* can only be specified as 0. The first (and only) selected item is returned or -1 if no item is selected.
In a multiple selection tree control, the index of all selected items can be retrieved. The Items.[SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount) property returns the number of selected items. The Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties are used to retrieve groups of selected items.
See Also SftTree Object | Object Hierarchy
## Load Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Load*
Loads the control contents.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Load**(**ByVal** *Filename* **As String**, **ByVal** *StreamName* **As String**, **ByVal** *Format* **As [SftTreeSaveFormatConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSaveFormatConstants)**, **ByRef** *PropertiesLoaded* **As Object**, **ByVal** *Stream* **As IStream**) |
| VB | *object*.**Load**(**ByVal** *Filename* **As String**, **ByVal** *StreamName* **As String**, **ByVal** *Format* **As SftTreeSaveFormatConstants**, *PropertiesLoaded* **As Variant**, *Stream* **As IStream**) |
| C#.NET | **void** *object*.**Load**(**string** *Filename*, **string** *StreamName*, **SftTreeSaveFormatConstants** *Format*, **out** **object** *PropertiesLoaded*, **IStream** *Stream*); |
| VC++ | **HRESULT** *object*->**Load**(**_bstr_t** *Filename*, **_bstr_t** *StreamName*, **enum SftTreeSaveFormatConstants** *Format*, **const _variant_t**&***** *PropertiesLoaded*, **IStream*** *Stream*); |
| C | **HRESULT** *object*->raw_**Load**(**BSTR** *Filename*, **BSTR** *StreamName*, **enum SftTreeSaveFormatConstants** *Format*, **VARIANT*** *PropertiesLoaded*, **IStream*** *Stream*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Filename
A file name, from where the contents are to be loaded. If* *the *Filename* argument is not NULL/Nothing, the *Stream*, *StreamName* arguments must be NULL/Nothing.
StreamName
Reserved for future use - Ignored. A stream name (part of the compound file *FileName)*, from where the contents are to be loaded.
Format
Defines the format of the data being loaded.
| Name | Value | Description |
| --- | --- | --- |
| saveFormatSftTreeStream | 0 | Stream |
| saveFormatSftTreePropertyPages | 1 | Stream as used by Property Page dialog (Load/[Save](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Save) Properties) - always saves all properties. The filename must be specified and the *PropertiesLoaded* argument is ignored. |
PropertiesLoaded
Set to True to load tree control properties (in addition to items and their attributes), False to load just the items and their attributes. If the saved data doesn't contain data matching the requested data, an error occurs. This value must match the *Properties* argument of the Save method used to save the data.
Stream
The stream (IStream interface) from where the data is loaded. The * Stream *argument must be NULL/Nothing, if* *the *Filename* argument is not NULL/Nothing.
### Comments
The Load method loads the control contents.
The Save method can be used to save the control contents in a format suitable for the Load method.
The Save/Load methods are intended for design-time property saving/loading to transfer the settings between controls. While items are also transferred, this is not recommended to be exploited by applications for quick data loading, as any images used in the control are saved in their entirety. Images shared between items (i.e., using the same image reference) will be individually copied resulting in excessive memory/windows handle use.
See Also SftTree Object | Object Hierarchy
## LoadGDIPlusImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImage*
Loads a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image from a file.
### Syntax
| | |
| --- | --- |
| VB.NET | *pGDIPlusImage* = *object*.**LoadGDIPlusImage**(**ByVal** *Filename* **As String**, **ByVal** *UseEmbeddedColorManagement* **As Boolean**) **As Integer** |
| VB | *pGDIPlusImage* = *object*.**LoadGDIPlusImage**(**ByVal** *Filename* **As String**, **ByVal** *UseEmbeddedColorManagement* **As Boolean**) **As LONG_PTR** |
| C#.NET | **int** *pGDIPlusImage* = *object*.**LoadGDIPlusImage**(**string** *Filename*, **bool** *UseEmbeddedColorManagement*); |
| VC++ | **LONG_PTR** *pGDIPlusImage* = *object*->**LoadGDIPlusImage**(**_bstr_t** *Filename*, **VARIANT_BOOL** *UseEmbeddedColorManagement*); |
| C | **HRESULT** *object*->raw_**LoadGDIPlusImage**(**BSTR** *Filename*, **VARIANT_BOOL** *UseEmbeddedColorManagement*, **LONG_PTR*** *pGDIPlusImage*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Filename
Specifies the name of the file containing the image to be loaded.
UseEmbeddedColorManagement
Defines whether the new image object applies color correction according to color management information that is embedded in the image file. Embedded information can include International Color Consortium (ICC) profiles, gamma values, and chromaticity information. True specifies that color correction is enabled, and False specifies that color correction is not enabled.
pGDIPlusImage
Returns a Gdiplus::Image pointer or NULL/Nothing if the function failed.
### Comments
The LoadGDIPlusImage method loads a GDI+ image from a file.
A GDI+ image created using LoadGDIPlusImage or [LoadGDIPlusImageFromResource](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImageFromResource) must be freed using [DeleteGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteGDIPlusImage) (or the equivalent "delete Gdiplus::Image*", which is usually accessible to C++ applications only).
This method is mainly intended for applications written using a language that does not have direct access to GDI+ (such as VB6). Other languages usually have direct access to GDI+ (such as C++) or have other mechanisms ([NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) for .NET applications).
See Also SftTree Object | Object Hierarchy
## LoadGDIPlusImageFromResource Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImageFromResource*
Loads a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image from a resource.
### Syntax
| | |
| --- | --- |
| VB.NET | *pGDIPlusImage* = *object*.**LoadGDIPlusImageFromResource**(**ByVal** *ResourceHandle* **As Integer**, **ByVal** *ResourceType* **As String**, **ByVal** *ResourceName* **As String**) **As Integer** |
| VB | *pGDIPlusImage* = *object*.**LoadGDIPlusImageFromResource**(**ByVal** *ResourceHandle* **As LONG_PTR**, **ByVal** *ResourceType* **As String**, **ByVal** *ResourceName* **As String**) **As LONG_PTR** |
| C#.NET | **int** *pGDIPlusImage* = *object*.**LoadGDIPlusImageFromResource**(**int** *ResourceHandle*, **string** *ResourceType*, **string** *ResourceName*); |
| VC++ | **LONG_PTR** *pGDIPlusImage* = *object*->**LoadGDIPlusImageFromResource**(**LONG_PTR** *ResourceHandle*, **_bstr_t** *ResourceType*, **_bstr_t** *ResourceName*); |
| C | **HRESULT** *object*->raw_**LoadGDIPlusImageFromResource**(**LONG_PTR** *ResourceHandle*, **BSTR** *ResourceType*, **BSTR** *ResourceName*, **LONG_PTR*** *pGDIPlusImage*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ResourceHandle
The instance handle of the application or DLL containing the resource.
ResourceType
The resource type. Can be a string or an identifier using the MAKEINTRESOURCE macro.
ResourceName
The resource name. Can be a string or an identifier using the MAKEINTRESOURCE macro.
pGDIPlusImage
Returns a Gdiplus::Image pointer or NULL/Nothing if the function failed.
### Comments
The LoadGDIPlusImageFromResource method loads a GDI+ image from a resource.
A GDI+ image created using [LoadGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadGDIPlusImage) or LoadGDIPlusImageFromResource must be freed using [DeleteGDIPlusImage](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DeleteGDIPlusImage) (or the equivalent "delete Gdiplus::Image*", which is usually accessible to C++ applications only).
This method is mainly intended for applications written using a language that does not have direct access to GDI+ (such as VB6). Other languages usually have direct access to GDI+ (such as C++) or have other mechanisms ([NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) for .NET applications).
See Also SftTree Object | Object Hierarchy
## LoadImage Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImage*
Loads an image from a file as a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**LoadImage**(**ByVal** *Filename* **As String**, **ByVal** *UseEmbeddedColorManagement* **As Boolean**) |
| VB | *object*.**LoadImage**(**ByVal** *Filename* **As String**, **ByVal** *UseEmbeddedColorManagement* **As Boolean**) |
| C#.NET | **void** *object*.**LoadImage**(**string** *Filename*, **bool** *UseEmbeddedColorManagement*); |
| VC++ | **HRESULT** *object*->**LoadImageSftTree**(**_bstr_t** *Filename*, **VARIANT_BOOL** *UseEmbeddedColorManagement*); |
| C | **HRESULT** *object*->raw_**LoadImageSftTree**(**BSTR** *Filename*, **VARIANT_BOOL** *UseEmbeddedColorManagement*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Filename
The name of the file containing a GDI+ image.
UseEmbeddedColorManagement
Defines whether the Image object applies color correction according to color management information that is embedded in the image file. Embedded information can include International Color Consortium (ICC) profiles, gamma values, and chromaticity information. True to enable color correction, False otherwise.
### Comments
The LoadImage method loads an image from a file as a GDI+ image.
The image object is owned by the tree control and will be deleted when it is no longer used.
**C/C++ Only:** The LoadImage method is renamed to LoadImageSftTree by the #import statement used (see "[Using SftTree/OCX with Visual Studio (Unmanaged C/C++)](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_vc7)") to avoid a conflict with the Windows LoadImage macro.
See Also SftPictureObject Object | Object Hierarchy
## LoadImageFromHBITMAP Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImageFromHBITMAP*
Loads an image from a bitmap handle as a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**LoadImageFromHBITMAP**(**ByVal** *hBitmap* **As Integer**, **ByVal** *hPalette* **As Integer**) |
| VB | *object*.**LoadImageFromHBITMAP**(**ByVal** *hBitmap* **As LONG_PTR**, **ByVal** *hPalette* **As LONG_PTR**) |
| C#.NET | **void** *object*.**LoadImageFromHBITMAP**(**int** *hBitmap*, **int** *hPalette*); |
| VC++ | **HRESULT** *object*->**LoadImageFromHBITMAP**(**LONG_PTR** *hBitmap*, **LONG_PTR** *hPalette*); |
| C | **HRESULT** *object*->raw_**LoadImageFromHBITMAP**(**LONG_PTR** *hBitmap*, **LONG_PTR** *hPalette*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
hBitmap
A bitmap handle, used to create a GDI+ image.
hPalette
A palette handle, used to create a GDI+ image. This value may be NULL/Nothing to omit the palette information.
### Comments
The LoadImageFromHBITMAP method loads an image from a bitmap handle as a GDI+ image.
The image object is owned by the tree control and will be deleted when it is no longer used.
See Also SftPictureObject Object | Object Hierarchy
## LoadImageFromResource Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_LoadImageFromResource*
Loads an image from a resource as a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**LoadImageFromResource**(**ByVal** *ResourceHandle* **As Integer**, **ByVal** *ResourceType* **As String**, **ByVal** *ResourceName* **As String**) |
| VB | *object*.**LoadImageFromResource**(**ByVal** *ResourceHandle* **As LONG_PTR**, **ByVal** *ResourceType* **As String**, **ByVal** *ResourceName* **As String**) |
| C#.NET | **void** *object*.**LoadImageFromResource**(**int** *ResourceHandle*, **string** *ResourceType*, **string** *ResourceName*); |
| VC++ | **HRESULT** *object*->**LoadImageFromResource**(**LONG_PTR** *ResourceHandle*, **_bstr_t** *ResourceType*, **_bstr_t** *ResourceName*); |
| C | **HRESULT** *object*->raw_**LoadImageFromResource**(**LONG_PTR** *ResourceHandle*, **BSTR** *ResourceType*, **BSTR** *ResourceName*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
ResourceHandle
The handle to an instance of the module containing the resource.
ResourceType
The resource type. Can be a string or an identifier using the MAKEINTRESOURCE macro.
ResourceName
The resource name. Can be a string or an identifier using the MAKEINTRESOURCE macro.
### Comments
The LoadImageFromResource method loads an image from a resource as a GDI+ image.
This function is identical to the GDI+ function Gdiplus::Bitmap::FromResource().
The image object is owned by the tree control and will be deleted when it is no longer used.
See Also SftPictureObject Object | Object Hierarchy
## LoadPicture Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LoadPicture*
Loads a picture from a file/URL.
### Syntax
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**LoadPicture**(**ByVal** *FileURL* **As String**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *refPictureObj* = *object*.**LoadPicture**(**ByVal** *FileURL* **As String**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**LoadPicture**(**string** *FileURL*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->**LoadPicture**(**_bstr_t** *FileURL*); |
| C | **HRESULT** *object*->raw_**LoadPicture**(**BSTR** *FileURL*, **IPictureDisp**** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FileURL
The filename or URL of a file containing a picture (bitmap, Windows metafile, icon, jpeg or gif format). A URL must start with "http://" in which case the picture is loaded from the specified location. Otherwise, *FileURL* defines the location of a file on the local file system.
refPictureObj
Returns the graphic loaded from the specified file/URL *FileURL*. Nothing (NULL) is returned if the file/URL is inaccessible or if it is an invalid picture format.
### Comments
The LoadPicture method loads a picture from a file/URL.
The specified filename *FileURL* can contain a bitmap, Windows metafile, icon, jpeg or gif image.
This method is mainly used to load pictures used as part of SftTree/OCX. Other environments usually offer picture, image or ImageList controls which can be used to hold pictures used by SftTree/OCX.
See Also SftTree Object | Object Hierarchy
## Locked Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Locked*
Defines whether this column's size is locked so the user cannot resize the column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Locked** **As Boolean** |
| VB | *Boolean* = *object*.**Locked** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Locked**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Locked**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Locked**(); |
| C | **HRESULT** *object*->get_**Locked**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Locked** = *Boolean* **As Boolean** |
| VB | *object*.**Locked** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Locked** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Locked** = *Boolean*;
**void** *object*->Put**Locked**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Locked**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Boolean
Defines whether this column's size is locked so the user cannot resize the column.
| Boolean | Description |
| --- | --- |
| True | The column width is locked and the user cannot resize the column. This can be used to hide certain columns. By setting a column's width to 0 and locking it, a user cannot make the column visible. |
| False | The column width is not locked and the user can resize the column. |
### Comments
The Locked property defines whether this column's size is locked so the user cannot resize the column.
An application can always resize a column by changing its [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property, regardless of the settings of this property.
The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Resizable) property can be used to define whether [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) can be resized by the user.
See Also SftTreeFooter Object | Object Hierarchy
## Locked Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked*
Defines whether this column's size is locked so the user cannot resize the column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Locked** **As Boolean** |
| VB | *Boolean* = *object*.**Locked** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Locked**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Locked**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Locked**(); |
| C | **HRESULT** *object*->get_**Locked**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Locked** = *Boolean* **As Boolean** |
| VB | *object*.**Locked** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Locked** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Locked** = *Boolean*;
**void** *object*->Put**Locked**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Locked**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Boolean
Defines whether this column's size is locked so the user cannot resize the column.
| Boolean | Description |
| --- | --- |
| True | The column width is locked and the user cannot resize the column. This can be used to hide certain columns. By setting a column's width to 0 and locking it, a user cannot make the column visible. |
| False | The column width is not locked and the user can resize the column. |
### Comments
The Locked property defines whether this column's size is locked so the user cannot resize the column.
An application can always resize a column by changing its [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property, regardless of the settings of this property.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable) property can be used to define whether [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) can be resized by the user.
See Also SftTreeHeader Object | Object Hierarchy
## MakeCellVisible Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeCellVisible*
Horizontally and vertically scrolls the specified [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) into view so it is displayed in the tree control's client area.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeCellVisible**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) |
| VB | *object*.**MakeCellVisible**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*.**MakeCellVisible**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **HRESULT** *object*->**MakeCellVisible**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->raw_**MakeCellVisible**(**long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the cell to be scrolled into view. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.MakeVisible instead
The MakeCellVisible method horizontally and vertically scrolls the specified cell into view so it is displayed in the tree control's client area.
The MakeCellVisible method can be used to make a cell visible by scrolling it into view (horizontally and vertically). The user normally scrolls the tree control items horizontally or vertically using the scroll bars, but if an application wants to insure that a cell is visible, this method can be used.
To make a particular column visible, the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method can be used. To make a particular item visible, the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used.
See Also SftTree Object | Object Hierarchy
## MakeColumnOptimal Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeColumnOptimal*
Sets the optimal column width so that the text and graphics of all items can be displayed.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) or [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_MakeOptimal) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeColumnOptimal**(**ByVal** *ColIndex* **As Short**) |
| VB | *object*.**MakeColumnOptimal**(**ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*.**MakeColumnOptimal**(**short** *ColIndex*); |
| VC++ | **HRESULT** *object*->**MakeColumnOptimal**(**short** *ColIndex*); |
| C | **HRESULT** *object*->raw_**MakeColumnOptimal**(**short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number to resize. If -1 is specified, all columns are resized.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.MakeOptimal or ColumnsObj.MakeOptimal instead
The MakeColumnOptimal method sets the optimal column width so that the text and graphics of all items can be displayed.
This method resizes a specified column or all columns to the optimal width so that the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can be completely displayed without being truncated or clipped. The Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) method can be used to calculate a column's optimal width without resizing the column. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
The last (or only) column may be an "[open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded)" column. If the ColumnsObj.OpenEnded property is set to True, the last displayed column will always use the space remaining between the previous column and the right edge of the tree control window.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property can be used to limit the maximum number of items to consider for optimal column width calculation. MakeColumnOptimal scans all items to determine the best column width, but can be limited to a specific number of items using the Items.CalcLimit property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTree Object | Object Hierarchy
## MakeColumnVisible Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeColumnVisible*
Horizontally scrolls the specified column into view so it is displayed in the tree control's client area.
> Deprecated - Provided for compatibility with earlier versions only - Use [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeColumnVisible**(**ByVal** *ColIndex* **As Short**) |
| VB | *object*.**MakeColumnVisible**(**ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*.**MakeColumnVisible**(**short** *ColIndex*); |
| VC++ | **HRESULT** *object*->**MakeColumnVisible**(**short** *ColIndex*); |
| C | **HRESULT** *object*->raw_**MakeColumnVisible**(**short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
The zero-based column number to make visible.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Column.MakeVisible instead
The MakeColumnVisible method horizontally scrolls the specified column into view so it is displayed in the tree control's client area.
The user normally scrolls the tree control items horizontally using the scroll bar, but if an application wants to insure that a column is visible, this method can be used.
To make a particular [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) visible, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) method can be used.
See Also SftTree Object | Object Hierarchy
## MakeIntegralHeight Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeight*
Vertically resizes the tree control so visible items are displayed in their entirety.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeIntegralHeight**(**ByVal** *Height* **As Single**) |
| VB | *object*.**MakeIntegralHeight**(**ByVal** *Height* **As Single**) |
| C#.NET | **void** *object*.**MakeIntegralHeight**(**float** *Height*); |
| VC++ | **HRESULT** *object*->**MakeIntegralHeight**(**float** *Height*); |
| C | **HRESULT** *object*->raw_**MakeIntegralHeight**(**float** *Height*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Height
The height to be used for integral height calculation. If 0 is used, the current tree control height is used.
### Comments
The MakeIntegralHeight method vertically resizes the tree control so visible items are displayed in their entirety.
The MakeIntegralHeight and [MakeIntegralHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeightPix) methods are synonyms, but may use different coordinate systems.
The * Height* value specifies the maximum height of the tree control to use. The MakeIntegralHeight method calculates the largest height of the tree control (smaller or equal to *Height*) so that no partial items are displayed and resizes the control vertically using the calculated height. This method takes all tree control attributes into consideration, including the presence of a horizontal scroll bar.
The MakeIntegralHeight method should be used after all tree control attributes have been set and all items have been added. If tree control attributes are changed after using the MakeIntegralHeight method, the tree control does not automatically resize if items become partially visible.
The MakeIntegralHeight method has no effect if [variable height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)).
See Also SftTree Object | Object Hierarchy
## MakeIntegralHeightPix Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeightPix*
Vertically resizes the tree control so visible items are displayed in their entirety.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeIntegralHeightPix**(**ByVal** *HeightPix* **As OLE_YSIZE_PIXELS**) |
| VB | *object*.**MakeIntegralHeightPix**(**ByVal** *HeightPix* **As OLE_YSIZE_PIXELS**) |
| C#.NET | **void** *object*.**MakeIntegralHeightPix**(**OLE_YSIZE_PIXELS** *HeightPix*); |
| VC++ | **HRESULT** *object*->**MakeIntegralHeightPix**(**OLE_YSIZE_PIXELS** *HeightPix*); |
| C | **HRESULT** *object*->raw_**MakeIntegralHeightPix**(**OLE_YSIZE_PIXELS** *HeightPix*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
HeightPix
The height to be used for integral height calculation in pixels. If 0 is used, the current tree control height is used.
### Comments
The MakeIntegralHeightPix method vertically resizes the tree control so visible items are displayed in their entirety.
The [MakeIntegralHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeIntegralHeight) and MakeIntegralHeightPix methods are synonyms, but may use different coordinate systems.
The * Height* value specifies the maximum height of the tree control to use. The MakeIntegralHeight method calculates the largest height of the tree control (smaller or equal to *Height*) so that no partial items are displayed and resizes the control vertically using the calculated height. This method takes all tree control attributes into consideration, including the presence of a horizontal scroll bar.
The MakeIntegralHeight method should be used after all tree control attributes have been set and all items have been added. If tree control attributes are changed after using the MakeIntegralHeight method, the tree control does not automatically resize if items become partially visible.
The MakeIntegralHeight method has no effect if [variable height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)).
See Also SftTree Object | Object Hierarchy
## MakeOptimal Method, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal*
Sets the column's optimal width so that the text and graphics of all items can be displayed without being clipped horizontally.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeOptimal**() |
| VB | *object*.**MakeOptimal** |
| C#.NET | **void** *object*.**MakeOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeOptimal**(); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
### Comments
The MakeOptimal method sets the column's optimal width so that the text and graphics of all items can be displayed without being clipped horizontally.
This method resizes the column to the optimal width so that the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can be completely displayed without being truncated or clipped. The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) method can be used to calculate a column's optimal width without resizing the column. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_MakeOptimal) method can be used to set the optimal column width of all columns.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
The last (or only) column may be an "[open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded)" column. If the ColumnsObj.OpenEnded property is set to True, the last displayed column will always use the space remaining between the previous column and the right edge of the tree control window.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property can be used to limit the maximum number of items to consider for optimal column width calculation. MakeOptimal scans all items to determine the best column width, but can be limited to a specific number of items using the Items.CalcLimit property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeColumn Object | Object Hierarchy
## MakeOptimal Method, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_MakeOptimal*
Sets the optimal column width of all columns so that the text and graphics of all items can be displayed without being clipped horizontally.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeOptimal**() |
| VB | *object*.**MakeOptimal** |
| C#.NET | **void** *object*.**MakeOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeOptimal**(); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
### Comments
The MakeOptimal method sets the optimal column width of all columns so that the text and graphics of all items can be displayed without being clipped horizontally.
This method resizes all columns to their optimal widths so that the [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can be completely displayed without being truncated or clipped. The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) method can be used to calculate a column's optimal width without resizing the column. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property.
The Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) method can be used to set the optimal column width of just one column.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
The last (or only) column may be an "[open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded)" column. If the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded property is set to True, the last displayed column will always use the space remaining between the previous column and the right edge of the tree control window.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property can be used to limit the maximum number of items to consider for optimal column width calculation. MakeOptimal scans all items to determine the best column width, but can be limited to a specific number of items using the Items.CalcLimit property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeColumns Object | Object Hierarchy
## MakeOptimal Method, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal*
Sets the optimal [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) width so that the text and graphics of all row headers can be displayed without being clipped horizontally.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeOptimal**() |
| VB | *object*.**MakeOptimal** |
| C#.NET | **void** *object*.**MakeOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeOptimal**(); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
### Comments
The MakeOptimal method sets the optimal row header width so that the text and graphics of all row headers can be displayed without being clipped horizontally.
This method resizes the row header area so that the row headers and row header graphics can be completely displayed without being truncated or clipped. The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) method can be used to calculate the row header area's optimal width without resizing the row header area. The row header width can be changed using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
By changing tree control properties, the optimal row header width may change. Adding items, setting new row header graphics and changing row header text are a few of the actions that can affect the optimal row header width. The row header width may have to be set again to allow items to be completely visible. The tree control does not automatically adjust the row header width.
Calculating the optimal row header width can be a time consuming operation, particularly if many items have been added to the tree control. RowHeaders.OptimalWidth scans all items to determine the best row header width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeRowHeaders Object | Object Hierarchy
## MakeOptimal Method, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal*
Positions the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) optimally.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeOptimal**() |
| VB | *object*.**MakeOptimal** |
| C#.NET | **void** *object*.**MakeOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeOptimal**(); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
### Comments
The MakeOptimal method positions the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar.
MakeOptimal is only available for a split tree control (see [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible)).
Before using MakeOptimal, the best horizontal extent for the panes must be set using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property or the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method. Once set, MakeOptimal can then be used to position the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar.
MakeOptimal uses the current width of the tree control window to determine the allowable position of the splitter bar. If the tree control window is too small, the splitter bar may not be optimally set. This is particularly noticeable if the tree control window is resized after MakeOptimal is used.
The coordinates of the splitter bar can be retrieved using the Splitter.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition) method.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to change the width of the splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## MakeRowHeaderOptimal Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeRowHeaderOptimal*
Sets the optimal [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) width so that the text and graphics of all row headers can be displayed.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeRowHeaderOptimal**() |
| VB | *object*.**MakeRowHeaderOptimal** |
| C#.NET | **void** *object*.**MakeRowHeaderOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeRowHeaderOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeRowHeaderOptimal**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.MakeOptimal instead
The MakeRowHeaderOptimal method sets the optimal row header width so that the text and graphics of all row headers can be displayed.
This method resizes the row header area so that the row headers and row header graphics can be completely displayed without being truncated or clipped. The RowHeaders.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) method can be used to calculate the row header area's optimal width without resizing the row header area. The row header width can be changed using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
By changing tree control properties, the optimal row header width may change. Adding items, setting new row header graphics and changing row header text are a few of the actions that can affect the optimal row header width. The row header width may have to be set again to allow items to be completely visible. The tree control does not automatically adjust the row header width.
Calculating the optimal row header width can be a time consuming operation, particularly if many items have been added to the tree control. RowHeaders.OptimalWidth scans all items to determine the best row header width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTree Object | Object Hierarchy
## MakeRowVisible Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeRowVisible*
Vertically scrolls the specified item into view so it is displayed in the tree control's client area.
> Deprecated - Provided for compatibility with earlier versions only - Use Item.MakeVisible instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeRowVisible**(**ByVal** *ItemIndex* **As Integer**) |
| VB | *object*.**MakeRowVisible**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*.**MakeRowVisible**(**int** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**MakeRowVisible**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**MakeRowVisible**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to be scrolled into view.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) instead
The MakeRowVisible method vertically scrolls the specified item into view so it is displayed in the tree control's client area.
The MakeRowVisible method can be used to make an item visible by scrolling it into view (vertically). The user normally scrolls the tree control items vertically using the scroll bar, but if an application wants to insure that an item is visible, this method can be used.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex) property is used to make a specific item the very first item shown in the tree control area.
To make a particular [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) visible, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) method can be used.
See Also SftTree Object | Object Hierarchy
## MakeSplitterOptimal Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MakeSplitterOptimal*
Positions the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) optimally.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeSplitterOptimal**() |
| VB | *object*.**MakeSplitterOptimal** |
| C#.NET | **void** *object*.**MakeSplitterOptimal**(); |
| VC++ | **HRESULT** *object*->**MakeSplitterOptimal**(); |
| C | **HRESULT** *object*->raw_**MakeSplitterOptimal**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.MakeOptimal instead
The MakeSplitterOptimal method positions the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar.
MakeSplitterOptimal is only available for a split tree control (see Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible)).
Before using MakeSplitterOptimal, the best horizontal extent for the panes must be set using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property or the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method. Once set, MakeSplitterOptimal can then be used to position the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar.
MakeSplitterOptimal uses the current width of the tree control window to determine the allowable position of the splitter bar. If the tree control window is too small, the splitter bar may not be optimally set. This is particularly noticeable if the tree control window is resized after MakeSplitterOptimal is used.
The coordinates of the splitter bar can be retrieved using the Splitter.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition) method.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to change the width of the splitter bar.
See Also SftTree Object | Object Hierarchy
## MakeVisible Method, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible*
Horizontally and vertically scrolls the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) into view so it is displayed in the tree control's client area.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeVisible**() |
| VB | *object*.**MakeVisible** |
| C#.NET | **void** *object*.**MakeVisible**(); |
| VC++ | **HRESULT** *object*->**MakeVisible**(); |
| C | **HRESULT** *object*->raw_**MakeVisible**(); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
### Comments
The MakeVisible method horizontally and vertically scrolls the cell into view so it is displayed in the tree control's client area.
The MakeVisible method can be used to make a cell visible by scrolling it into view (horizontally and vertically). The user normally scrolls the tree control items horizontally or vertically using the scroll bars, but if an application wants to insure that a cell is visible, this method can be used.
To make a particular column visible, the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible) method can be used. To make a particular item visible, the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used.
See Also SftTreeCell Object | Object Hierarchy
## MakeVisible Method, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeVisible*
Horizontally scrolls the column into view so it is displayed in the tree control's client area.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeVisible**() |
| VB | *object*.**MakeVisible** |
| C#.NET | **void** *object*.**MakeVisible**(); |
| VC++ | **HRESULT** *object*->**MakeVisible**(); |
| C | **HRESULT** *object*->raw_**MakeVisible**(); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
### Comments
The MakeVisible method horizontally scrolls the column into view so it is displayed in the tree control's client area.
The user normally scrolls the tree control items horizontally using the scroll bar, but if an application wants to insure that a column is visible, this method can be used.
To make a particular [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) visible, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) method can be used.
See Also SftTreeColumn Object | Object Hierarchy
## MakeVisible Method, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible*
Vertically scrolls the item into view so it is displayed in the tree control's client area.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MakeVisible**() |
| VB | *object*.**MakeVisible** |
| C#.NET | **void** *object*.**MakeVisible**(); |
| VC++ | **HRESULT** *object*->**MakeVisible**(); |
| C | **HRESULT** *object*->raw_**MakeVisible**(); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
### Comments
The MakeVisible method vertically scrolls the item into view so it is displayed in the tree control's client area.
The MakeVisible method can be used to make an item visible by scrolling it into view (vertically). The user normally scrolls the tree control items vertically using the scroll bar, but if an application wants to insure that an item is visible, this method can be used.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex) property is used to make a specific item the very first item shown in the tree control area.
To make a particular [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) visible, the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_MakeVisible) method can be used.
See Also SftTreeItem Object | Object Hierarchy
## MaxHeightPix Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MaxHeightPix*
Defines the maximum height of the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *MaxPix* = *object*.**MaxHeightPix** **As Integer** |
| VB | *MaxPix* = *object*.**MaxHeightPix** **As Long** |
| C#.NET | **int** *MaxPix* = *object*.**MaxHeightPix**; |
| VC++ | **long** *MaxPix* = *object*->**MaxHeightPix**;
**long** *MaxPix* = *object*->Get**MaxHeightPix**(); |
| C | **HRESULT** *object*->get_**MaxHeightPix**(**long*** *MaxPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MaxHeightPix** = *MaxPix* **As Integer** |
| VB | *object*.**MaxHeightPix** = *MaxPix* **As Long** |
| C#.NET | **int** *object*.**MaxHeightPix** = *MaxPix*; |
| VC++ | **long** *object*->**MaxHeightPix** = *MaxPix*;
**void** *object*->Put**MaxHeightPix**(**long** *MaxPix*); |
| C | **HRESULT** *object*->put_**MaxHeightPix**(**long** *MaxPix*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
MaxPix
Defines the maximum height of the item in pixels. If 0 is specified, the item uses the height required, so the item is not clipped vertically.
### Comments
The MaxHeightPix property defines the maximum height of the item.
If the item is larger than the defined maximum height, it is truncated and clipped.
This property has no effect when [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). The Items.[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MinHeightPix) and Items.[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MaxHeightPix) properties can be used for fixed height items to define the minimum and maximum height for all item.
The Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to define the number of text lines used for item height calculation.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MinHeightPix) property defines the minimum height of an item.
See Also SftTreeItem Object | Object Hierarchy
## MaxHeightPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MaxHeightPix*
Defines the maximum height of all items.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *MaxPix* = *object*.**MaxHeightPix** **As Integer** |
| VB | *MaxPix* = *object*.**MaxHeightPix** **As Long** |
| C#.NET | **int** *MaxPix* = *object*.**MaxHeightPix**; |
| VC++ | **long** *MaxPix* = *object*->**MaxHeightPix**;
**long** *MaxPix* = *object*->Get**MaxHeightPix**(); |
| C | **HRESULT** *object*->get_**MaxHeightPix**(**long*** *MaxPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MaxHeightPix** = *MaxPix* **As Integer** |
| VB | *object*.**MaxHeightPix** = *MaxPix* **As Long** |
| C#.NET | **int** *object*.**MaxHeightPix** = *MaxPix*; |
| VC++ | **long** *object*->**MaxHeightPix** = *MaxPix*;
**void** *object*->Put**MaxHeightPix**(**long** *MaxPix*); |
| C | **HRESULT** *object*->put_**MaxHeightPix**(**long** *MaxPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
MaxPix
Defines the maximum height of all items in pixels. If 0 is specified, items use the height required, so items are not clipped vertically.
### Comments
The MaxHeightPix property defines the maximum height of all items.
If items are larger than the defined maximum height, they are truncated and clipped.
This property has no effect when [variable height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MinHeightPix) and Item.[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MaxHeightPix) properties can be used for variable height items to define the minimum and maximum height for each individual item.
The Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to define the number of text lines used for item height calculation.
The Items.[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MinHeightPix) property defines the minimum height of all items.
See Also SftTreeItems Object | Object Hierarchy
## Merge Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge*
Defines whether the contents of this column can merge into the next displayed column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Merge** **As Boolean** |
| VB | *Boolean* = *object*.**Merge** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Merge**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Merge**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Merge**(); |
| C | **HRESULT** *object*->get_**Merge**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Merge** = *Boolean* **As Boolean** |
| VB | *object*.**Merge** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Merge** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Merge** = *Boolean*;
**void** *object*->Put**Merge**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Merge**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Boolean
Defines whether the contents of this column can merge into the next displayed column.
| Boolean | Description |
| --- | --- |
| True | Allows the contents of this column to merge into the next displayed column if the contents of the next [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) (or [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)) are empty and the next column allows being [merged into](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellmerging) (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto)). |
| False | The contents of this column do not merge into the next column. |
### Comments
The Merge property defines whether the contents of this column can merge into the next displayed column.
This property applies to all cells in this column and also the column header.
See Also SftTreeColumn Object | Object Hierarchy
## MergeInto Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto*
Defines whether the contents of the previous column can merge into this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**MergeInto** **As Boolean** |
| VB | *Boolean* = *object*.**MergeInto** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**MergeInto**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**MergeInto**;
**VARIANT_BOOL** *Boolean* = *object*->Get**MergeInto**(); |
| C | **HRESULT** *object*->get_**MergeInto**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MergeInto** = *Boolean* **As Boolean** |
| VB | *object*.**MergeInto** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**MergeInto** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**MergeInto** = *Boolean*;
**void** *object*->Put**MergeInto**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**MergeInto**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Boolean
Defines whether the contents of the previous column can merge into this column
| Boolean | Description |
| --- | --- |
| True | Allows the contents of the previous column to merge into this column if the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) (or [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)) in this column is empty. The previous column's [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) property must be suitably defined. |
| False | The contents of the previous column cannot merge into the this column. |
### Comments
The MergeInto property defines whether the contents of the previous column can merge into this column.
This property applies to all cells in this column and also the column header.
See Also SftTreeColumn Object | Object Hierarchy
## MinHeightPix Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MinHeightPix*
Defines the minimum height of the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *MinPix* = *object*.**MinHeightPix** **As Integer** |
| VB | *MinPix* = *object*.**MinHeightPix** **As Long** |
| C#.NET | **int** *MinPix* = *object*.**MinHeightPix**; |
| VC++ | **long** *MinPix* = *object*->**MinHeightPix**;
**long** *MinPix* = *object*->Get**MinHeightPix**(); |
| C | **HRESULT** *object*->get_**MinHeightPix**(**long*** *MinPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MinHeightPix** = *MinPix* **As Integer** |
| VB | *object*.**MinHeightPix** = *MinPix* **As Long** |
| C#.NET | **int** *object*.**MinHeightPix** = *MinPix*; |
| VC++ | **long** *object*->**MinHeightPix** = *MinPix*;
**void** *object*->Put**MinHeightPix**(**long** *MinPix*); |
| C | **HRESULT** *object*->put_**MinHeightPix**(**long** *MinPix*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
MinPix
Defines the minimum height of the item in pixels. If 0 is specified, no minimum height is defined.
### Comments
The MinHeightPix property defines the minimum height of the item.
If the item is smaller than the defined minimum height, it is extended and uses the defined minimum height.
This property has no effect when [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). The Items.[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MinHeightPix) and Items.[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MaxHeightPix) properties can be used for fixed height items to define the minimum and maximum height for all item.
The Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to define the number of text lines used for item height calculation.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MaxHeightPix) property defines the maximum height of an item.
See Also SftTreeItem Object | Object Hierarchy
## MinHeightPix Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MinHeightPix*
Defines the minimum height of all items.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *MinPix* = *object*.**MinHeightPix** **As Integer** |
| VB | *MinPix* = *object*.**MinHeightPix** **As Long** |
| C#.NET | **int** *MinPix* = *object*.**MinHeightPix**; |
| VC++ | **long** *MinPix* = *object*->**MinHeightPix**;
**long** *MinPix* = *object*->Get**MinHeightPix**(); |
| C | **HRESULT** *object*->get_**MinHeightPix**(**long*** *MinPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MinHeightPix** = *MinPix* **As Integer** |
| VB | *object*.**MinHeightPix** = *MinPix* **As Long** |
| C#.NET | **int** *object*.**MinHeightPix** = *MinPix*; |
| VC++ | **long** *object*->**MinHeightPix** = *MinPix*;
**void** *object*->Put**MinHeightPix**(**long** *MinPix*); |
| C | **HRESULT** *object*->put_**MinHeightPix**(**long** *MinPix*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
MinPix
Defines the minimum height of all items in pixels. If 0 is specified, no minimum height is defined.
### Comments
The MinHeightPix property defines the minimum height of all items.
If items are smaller than the defined minimum height, they are extended and use the defined minimum height.
This property has no effect when [variable height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)). The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MinHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MinHeightPix) and Item.[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MaxHeightPix) properties can be used for variable height items to define the minimum and maximum height for each individual item.
The Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property can be used to define the number of text lines used for item height calculation.
The Items.[MaxHeightPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MaxHeightPix) property defines the maximum height of all items.
See Also SftTreeItems Object | Object Hierarchy
## MinWidth Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth*
Defines the minimum width of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**MinWidth** **As Single** |
| VB | *W* = *object*.**MinWidth** **As Single** |
| C#.NET | **float** *W* = *object*.**MinWidth**; |
| VC++ | **float** *W* = *object*->**MinWidth**;
**float** *W* = *object*->Get**MinWidth**(); |
| C | **HRESULT** *object*->get_**MinWidth**(**float*** *W*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MinWidth** = *W* **As Single** |
| VB | *object*.**MinWidth** = *W* **As Single** |
| C#.NET | **float** *object*.**MinWidth** = *W*; |
| VC++ | **float** *object*->**MinWidth** = *W*;
**void** *object*->Put**MinWidth**(**float** *W*); |
| C | **HRESULT** *object*->put_**MinWidth**(**float** *W*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
W
Defines the minimum width of this column. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The MinWidth property defines the minimum width of this column.
The MinWidth and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MinWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidthPix) properties are synonyms, but may use different coordinate systems.
The MinWidth property is used to change the minimum width of a column. The minimum column width must be less than or equal to the column's defined width. The column width can be defined using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The minimum column width is only used to prevent the user from resizing the column and making it smaller than the defined minimum width.
See Also SftTreeColumn Object | Object Hierarchy
## MinWidthPix Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidthPix*
Defines the minimum width of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**MinWidthPix** **As Integer** |
| VB | *WPix* = *object*.**MinWidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**MinWidthPix**; |
| VC++ | **long** *WPix* = *object*->**MinWidthPix**;
**long** *WPix* = *object*->Get**MinWidthPix**(); |
| C | **HRESULT** *object*->get_**MinWidthPix**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MinWidthPix** = *WPix* **As Integer** |
| VB | *object*.**MinWidthPix** = *WPix* **As Long** |
| C#.NET | **int** *object*.**MinWidthPix** = *WPix*; |
| VC++ | **long** *object*->**MinWidthPix** = *WPix*;
**void** *object*->Put**MinWidthPix**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**MinWidthPix**(**long** *WPix*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
WPix
Defines the minimum width of this column in pixels.
### Comments
The MinWidthPix property defines the minimum width of this column.
The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) and MinWidthPix properties are synonyms, but may use different coordinate systems.
The MinWidthPix property is used to change the minimum width of a column. The minimum column width must be less than or equal to the column's defined width. The column width can be defined using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The minimum column width is only used to prevent the user from resizing the column and making it smaller than the defined minimum width.
See Also SftTreeColumn Object | Object Hierarchy
## MouseDown Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown*
A mouse button is pressed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**MouseDownEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**MouseDownEvent** |
| VB | **Private Sub** *object*_**MouseDown**(**ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, **ByVal** *x* **As OLE_XPOS_PIXELS**, **ByVal** *y* **As OLE_YPOS_PIXELS**) |
| C#.NET | **void** *object*_**MouseDownEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**MouseDown***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
| C | **HRESULT** On**MouseDown***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor when the button was pressed.
y
The y coordinate of the mouse cursor when the button was pressed.
### Comments
The MouseDown event occurs when a mouse button is pressed.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) or [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) properties, this event may not be generated for the middle and right mouse buttons.
The MouseDown event can be used by an application to handle mouse button clicks in combination with keyboard modifiers such as the SHIFT, CONTROL and ALT keys.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event should be used if specific information about the logical position of the mouse cursor is needed.
If the MouseDown event is used to display a context sensitive menu (popup menu), the [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) method must be used before displaying the context menu.
See Also SftTree Object | Object Hierarchy
## MouseEnterControl Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseEnterControl*
The mouse cursor is entering the control.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**MouseEnterControl**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**MouseEnterControl** |
| VB | **Private Sub** *object*_**MouseEnterControl**() |
| C#.NET | **void** *object*_**MouseEnterControl**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**MouseEnterControl***object*(); |
| C | **HRESULT** On**MouseEnterControl***object*(); |
object
A SftTreeEvents object.
### Comments
The MouseEnterControl event occurs when the mouse cursor is entering the control.
Many containers such as .NET provide their own events which signal that the mouse cursor is entering or leaving the control. For containers where such a facility is not available, the MouseEnterControl and [MouseLeaveControl](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseLeaveControl) events can be used instead. It is preferable to use events or mechanisms offered by the container rather than the MouseEnterControl and MouseLeaveControl events.
Updating control properties or changing the input focus to another control while handling this event is not supported.
Once the mouse cursor leaves the control, the MouseLeaveControl event occurs.
See Also SftTreeEvents Object | Object Hierarchy
## MouseIcon Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIcon*
Defines a custom mouse icon.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**MouseIcon** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**MouseIcon** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**MouseIcon**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**MouseIcon**(); |
| C | **HRESULT** *object*->get_**MouseIcon**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**MouseIcon**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**MouseIcon** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**MouseIcon**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**MouseIcon**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**MouseIcon**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**MouseIcon** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**MouseIcon** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**MouseIcon** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**MouseIcon**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**MouseIcon**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines a custom mouse icon. This icon contains the graphic used as the custom mouse icon. This icon handle has to remain valid until the tree control no longer uses it. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The MouseIcon property defines a custom mouse icon.
The MouseIcon property provides a custom icon that is used when the [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property is set to [sftCustom](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftMousePointerConstants) (99). This mouse pointer is displayed when the cursor is located anywhere on the control.
The MouseIcon and [MouseIconH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIconH) properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows icon handle).
Even though the class wrapper generated by Visual Studio for .NET applications (C#, VB.NET) includes the MouseIcon property, it is not usable as the System.Drawing.Image type does not support icons. For managed .NET applications the MouseIconH property must be used instead by assigning an icon's handle to the MouseIconH property as in
```
axSftTree1.MouseIconH = (int)icon1.Handle;
```
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## MouseIconH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIconH*
Defines a custom mouse icon.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**MouseIconH** **As Integer** |
| VB | *Handle* = *object*.**MouseIconH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**MouseIconH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**MouseIconH**;
**OLE_HANDLE** *Handle* = *object*->Get**MouseIconH**(); |
| C | **HRESULT** *object*->get_**MouseIconH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MouseIconH** = *Handle* **As Integer** |
| VB | *object*.**MouseIconH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**MouseIconH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**MouseIconH** = *Handle*;
**void** *object*->Put**MouseIconH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**MouseIconH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
An icon handle. Defines a custom mouse icon. This icon handle has to remain valid until the tree control no longer uses it.
### Comments
The MouseIconH property defines a custom mouse icon.
The MouseIconH property provides a custom icon that is used when the [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property is set to [sftCustom](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftMousePointerConstants) (99). This mouse pointer is displayed when the cursor is located anywhere on the control.
The [MouseIcon](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIcon) and MouseIconH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
Even though the class wrapper generated by Visual Studio for .NET applications (C#, VB.NET) includes the MouseIcon property, it is not usable as the System.Drawing.Image type does not support icons. For managed .NET applications the MouseIconH property must be used instead by assigning an icon's handle to the MouseIconH property as in
```
axSftTree1.MouseIconH = (int)icon1.Handle;
```
See Also SftTree Object | Object Hierarchy
## MouseLeaveControl Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseLeaveControl*
The mouse cursor is leaving the control.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**MouseLeaveControl**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**MouseLeaveControl** |
| VB | **Private Sub** *object*_**MouseLeaveControl**() |
| C#.NET | **void** *object*_**MouseLeaveControl**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**MouseLeaveControl***object*(); |
| C | **HRESULT** On**MouseLeaveControl***object*(); |
object
A SftTreeEvents object.
### Comments
The MouseLeaveControl event occurs when the mouse cursor is leaving the control.
Many containers such as .NET provide their own events which signal that the mouse cursor is entering or leaving the control. For containers where such a facility is not available, the [MouseEnterControl](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseEnterControl) and MouseLeaveControl events can be used instead. It is preferable to use events or mechanisms offered by the container rather than the MouseEnterControl and MouseLeaveControl events.
Updating control properties or changing the input focus to another control while handling this event is not supported.
When the mouse cursor enters the control, the MouseEnterControl event occurs.
See Also SftTreeEvents Object | Object Hierarchy
## MouseMove Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseMove*
The mouse is moved.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**MouseMoveEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**MouseMoveEvent** |
| VB | **Private Sub** *object*_**MouseMove**(**ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, **ByVal** *x* **As OLE_XPOS_PIXELS**, **ByVal** *y* **As OLE_YPOS_PIXELS**) |
| C#.NET | **void** *object*_**MouseMoveEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**MouseMove***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
| C | **HRESULT** On**MouseMove***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor.
y
The y coordinate of the mouse cursor.
### Comments
The MouseMove event occurs when the mouse is moved.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HitTest](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HitTest) method can be used to determine where the mouse cursor is located.
The [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) event can be used by an application to handle mouse button clicks in combination with keyboard modifiers such as the SHIFT, CONTROL and ALT keys.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event should be used if specific information about the logical position of the mouse cursor is needed.
See Also SftTree Object | Object Hierarchy
## MouseOverTransitionEffect Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseOverTransitionEffect*
Defines the transition effects used when the mouse enters/leaves the tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**MouseOverTransitionEffect** **As [SftTreeMouseOverTransitionEffectConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMouseOverTransitionEffectConstants)** |
| VB | *Style* = *object*.**MouseOverTransitionEffect** **As SftTreeMouseOverTransitionEffectConstants** |
| C#.NET | **SftTreeMouseOverTransitionEffectConstants** *Style* = *object*.**MouseOverTransitionEffect**; |
| VC++ | **enum SftTreeMouseOverTransitionEffectConstants** *Style* = *object*->**MouseOverTransitionEffect**;
**enum SftTreeMouseOverTransitionEffectConstants** *Style* = *object*->Get**MouseOverTransitionEffect**(); |
| C | **HRESULT** *object*->get_**MouseOverTransitionEffect**(**enum SftTreeMouseOverTransitionEffectConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MouseOverTransitionEffect** = *Style* **As SftTreeMouseOverTransitionEffectConstants** |
| VB | *object*.**MouseOverTransitionEffect** = *Style* **As SftTreeMouseOverTransitionEffectConstants** |
| C#.NET | **SftTreeMouseOverTransitionEffectConstants** *object*.**MouseOverTransitionEffect** = *Style*; |
| VC++ | **enum SftTreeMouseOverTransitionEffectConstants** *object*->**MouseOverTransitionEffect** = *Style*;
**void** *object*->Put**MouseOverTransitionEffect**(**enum SftTreeMouseOverTransitionEffectConstants** *Style*); |
| C | **HRESULT** *object*->put_**MouseOverTransitionEffect**(**enum SftTreeMouseOverTransitionEffectConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the transition effects used when the mouse enters/leaves the tree control.
| Name | Value | Description |
| --- | --- | --- |
| transitionSftTreeNone | 0 | None - no transition effects are used. |
| transitionSftTreeVistaNoFocus | 1 | Vista+, No Focus - transition effects are only used on Windows Vista and above and only when the control does not have the input focus. |
| transitionSftTreeVista | 2 | Vista+ - transition effects are only used on Windows Vista and above. |
| transitionSftTreeAlwaysNoFocus | 3 | Always, No Focus - transition effects are used on all Windows versions, but only when the control does not have the input focus. |
| transitionSftTreeAlways | 4 | Always - transition effects are used on all Windows versions. |
### Comments
The MouseOverTransitionEffect property defines the transition effects used when the mouse enters/leaves the tree control.
A gradual, visual transition is used to show/hide the [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) and tree lines when the mouse cursor enters/leaves the tree control.
Expand/collapse buttons and tree lines must be suitably defined to be visible (using [ButtonStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ButtonStyle) and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle)), otherwise this setting has no effect.
[GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) support is required for transition effects, otherwise the MouseOverTransitionEffect property is ignored.
Transition effects are only shown at runtime. At design-time, expand/collapse buttons and tree lines are shown if defined to be visible (using ButtonStyle and Items.TreeLineStyle).
See Also SftTree Object | Object Hierarchy
## MousePointer Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer*
Defines the mouse pointer used.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Icon* = *object*.**MousePointer** **As [SftMousePointerConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftMousePointerConstants)** |
| VB | *Icon* = *object*.**MousePointer** **As SftMousePointerConstants** |
| C#.NET | **SftMousePointerConstants** *Icon* = *object*.**MousePointer**; |
| VC++ | **enum SftMousePointerConstants** *Icon* = *object*->**MousePointer**;
**enum SftMousePointerConstants** *Icon* = *object*->Get**MousePointer**(); |
| C | **HRESULT** *object*->get_**MousePointer**(**enum SftMousePointerConstants*** *Icon*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MousePointer** = *Icon* **As SftMousePointerConstants** |
| VB | *object*.**MousePointer** = *Icon* **As SftMousePointerConstants** |
| C#.NET | **SftMousePointerConstants** *object*.**MousePointer** = *Icon*; |
| VC++ | **enum SftMousePointerConstants** *object*->**MousePointer** = *Icon*;
**void** *object*->Put**MousePointer**(**enum SftMousePointerConstants** *Icon*); |
| C | **HRESULT** *object*->put_**MousePointer**(**enum SftMousePointerConstants** *Icon*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Icon
Defines the mouse pointer used.
| Icon | Value | Description |
| --- | --- | --- |
| sftDefault | 0 | (Default) |
| sftArrow | 1 | Arrow |
| sftCross | 2 | Cross |
| sftIBeam | 3 | IBeam |
| sftIcon | 4 | Icon ( Obsolete) |
| sftSize | 5 | Size |
| sftSizeNESW | 6 | Size NW SW |
| sftSizeNS | 7 | Size N S |
| sftSizeNWSE | 8 | Size NW SE |
| sftSizeWE | 9 | Size W E |
| sftUpArrow | 10 | Up Arrow |
| sftHourglass | 11 | Hourglass |
| sftNoDrop | 12 | No Drop |
| sftArrowHourglass | 13 | Arrow and Hourglass |
| sftArrowQuestion | 14 | Arrow and Question Mark |
| sftSizeAll | 15 | Size All |
| sftCustom | 99 | Custom icon (defined using the [MouseIcon](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MouseIcon) property) |
### Comments
The MousePointer property defines the mouse pointer used when the mouse cursor is over a SftTree control.
See Also SftTree Object | Object Hierarchy
## MouseUp Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseUp*
A mouse button is released.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**MouseUpEvent**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**MouseUpEvent** |
| VB | **Private Sub** *object*_**MouseUp**(**ByVal** *Button* **As Integer**, **ByVal** *Shift* **As Integer**, **ByVal** *x* **As OLE_XPOS_PIXELS**, **ByVal** *y* **As OLE_YPOS_PIXELS**) |
| C#.NET | **void** *object*_**MouseUpEvent**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**MouseUp***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
| C | **HRESULT** On**MouseUp***object*(**short** *Button*, **short** *Shift*, **OLE_XPOS_PIXELS** *x*, **OLE_YPOS_PIXELS** *y*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor when the button was released.
y
The y coordinate of the mouse cursor when the button was released.
### Comments
The MouseUp event occurs when a mouse button is released.
1) Depending on the settings of the [LeftButtonOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftButtonOnly) or [LeftItemClickOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_LeftItemClickOnly) properties, this event may not be generated for the middle and right mouse buttons.
The MouseUp event can be used by an application to handle mouse button clicks in combination with keyboard modifiers such as the SHIFT, CONTROL and ALT keys.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event should be used if specific information about the logical position of the mouse cursor is needed.
If the MouseUp event is used to display a context sensitive menu (popup menu), the [CancelMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CancelMode) method must be used before displaying the context menu.
See Also SftTree Object | Object Hierarchy
## Move Method, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move*
Moves a column to a new position.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Move**(**ByVal** *FromDisplayColumn* **As Short**, **ByVal** *ToDisplayColumn* **As Short**) |
| VB | *object*.**Move**(**ByVal** *FromDisplayColumn* **As Integer**, **ByVal** *ToDisplayColumn* **As Integer**) |
| C#.NET | **void** *object*.**Move**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
| VC++ | **HRESULT** *object*->**Move**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
| C | **HRESULT** *object*->raw_**Move**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
FromDisplayColumn
The zero-based column number to be moved.
ToDisplayColumn
The zero-based column number of the position where the column is to be inserted. If *ToDisplayColumn* is -1, the column will be moved to the end and become the last column.
### Comments
The Move method moves a column to a new position.
The Move method moves the entire column, including all attributes and contents.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the Move method requires the use of display column numbers. The first displayed column number can be retrieved using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property. The last displayed column number is described by the ColumnsObj.[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property. The ColumnsObj.[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property returns the number of columns defined.
Even hidden columns ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) is 0) can be moved using the Move method.
See Also SftTreeColumns Object | Object Hierarchy
## Move Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move*
Moves items to a new position in the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | *CountMoved* = *object*.**Move**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *InsertIndex* **As Integer**) **As Integer** |
| VB | *CountMoved* = *object*.**Move**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *InsertIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountMoved* = *object*.**Move**(**int** *FromIndex*, **int** *Count*, **int** *InsertIndex*); |
| VC++ | **long** *CountMoved* = *object*->**Move**(**long** *FromIndex*, **long** *Count*, **long** *InsertIndex*); |
| C | **HRESULT** *object*->raw_**Move**(**long** *FromIndex*, **long** *Count*, **long** *InsertIndex*, **long*** *CountMoved*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
FromIndex
The zero-based index of the first item to be moved.
Count
The number of items to be moved.
InsertIndex
The zero-based index of the position where the items are to be inserted. If * InsertIndex* is -1, the items will be moved to the end of the list.
CountMoved
Returns the number of items moved.
### Comments
The Move method moves items to a new position in the tree control.
The Move method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. All application specific data is moved (such as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc.). The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target item *InsertIndex* cannot be inside the group of items to be moved.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can also be moved using the Items.[MoveAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter) method.
Items can be copied using the Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) method.
See Also SftTreeItems Object | Object Hierarchy
## MoveAfter Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MoveAfter*
Moves items to a new position in the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | *CountMoved* = *object*.**MoveAfter**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *AfterIndex* **As Integer**) **As Integer** |
| VB | *CountMoved* = *object*.**MoveAfter**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *AfterIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountMoved* = *object*.**MoveAfter**(**int** *FromIndex*, **int** *Count*, **int** *AfterIndex*); |
| VC++ | **long** *CountMoved* = *object*->**MoveAfter**(**long** *FromIndex*, **long** *Count*, **long** *AfterIndex*); |
| C | **HRESULT** *object*->raw_**MoveAfter**(**long** *FromIndex*, **long** *Count*, **long** *AfterIndex*, **long*** *CountMoved*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
FromIndex
The zero-based index of the first item to be moved.
Count
The number of items to be moved.
AfterIndex
The zero-based index of the position after which the items are to be inserted. If *InsertIndex* is -1, the items will be moved to the end of the list.
CountMoved
Moves items to a new position in the tree control.
### Comments
The MoveAfter method moves items to a new position in the tree control.
The MoveAfter method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. All application specific data is moved (such as [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc.). The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target item *AfterIndex* cannot be inside the group of items to be moved.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can also be moved using the Items.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) method.
Items can be copied using the Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) method.
See Also SftTreeItems Object | Object Hierarchy
## MoveColumn Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveColumn*
Moves a column to a new position.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**MoveColumn**(**ByVal** *FromDisplayColumn* **As Short**, **ByVal** *ToDisplayColumn* **As Short**) |
| VB | *object*.**MoveColumn**(**ByVal** *FromDisplayColumn* **As Integer**, **ByVal** *ToDisplayColumn* **As Integer**) |
| C#.NET | **void** *object*.**MoveColumn**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
| VC++ | **HRESULT** *object*->**MoveColumn**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
| C | **HRESULT** *object*->raw_**MoveColumn**(**short** *FromDisplayColumn*, **short** *ToDisplayColumn*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FromDisplayColumn
The zero-based column number to be moved.
ToDisplayColumn
The zero-based column number of the position where the column is to be inserted. If *ToDisplayColumn* is -1, the column will be moved to the end and become the last column.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.Move instead
The MoveColumn method moves a column to a new position.
The MoveColumn method moves the entire column, including all attributes and contents.
While most other methods, events and properties use [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers, the MoveColumn method requires the use of display column numbers. The first displayed column number can be retrieved using the ColumnsObj.[FirstDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_FirstDisplayColumn) property. The last displayed column number is described by the ColumnsObj.[LastDisplayColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_LastDisplayColumn) property. The ColumnsObj.[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property returns the number of columns defined.
Even hidden columns ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) is 0) can be moved using the MoveColumn method.
See Also SftTree Object | Object Hierarchy
## MoveItem Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItem*
Moves an item to a new position in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *NewIndex* = *object*.**MoveItem**(**ByVal** *FromIndex* **As Integer**, **ByVal** *ToIndex* **As Integer**) **As Integer** |
| VB | *NewIndex* = *object*.**MoveItem**(**ByVal** *FromIndex* **As Long**, **ByVal** *ToIndex* **As Long**) **As Long** |
| C#.NET | **int** *NewIndex* = *object*.**MoveItem**(**int** *FromIndex*, **int** *ToIndex*); |
| VC++ | **long** *NewIndex* = *object*->**MoveItem**(**long** *FromIndex*, **long** *ToIndex*); |
| C | **HRESULT** *object*->raw_**MoveItem**(**long** *FromIndex*, **long** *ToIndex*, **long*** *NewIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FromIndex
The zero-based index of the item to be moved.
ToIndex
The zero-based index of the position where the item is to be inserted. If *ToIndex* is -1, the item will be added at the end of the list.
NewIndex
Returns the zero-based index of the moved item's new position.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Move instead
The MoveItem method moves an item to a new position in the tree control.
The MoveItem method moves all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property may not be moved, depending on the [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property.
A group of items can be moved using the Items.Move method. Items can be copied using the Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) method.
The MoveItem method does not preserve the [item ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_itemids) (see Item.[ID](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ID) property). The Items.Move method should be used if the item id needs to be preserved.
See Also SftTree Object | Object Hierarchy
## MoveItems Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MoveItems*
Moves items to a new position in the tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Move) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *CountMoved* = *object*.**MoveItems**(**ByVal** *FromIndex* **As Integer**, **ByVal** *Count* **As Integer**, **ByVal** *ToIndex* **As Integer**) **As Integer** |
| VB | *CountMoved* = *object*.**MoveItems**(**ByVal** *FromIndex* **As Long**, **ByVal** *Count* **As Long**, **ByVal** *ToIndex* **As Long**) **As Long** |
| C#.NET | **int** *CountMoved* = *object*.**MoveItems**(**int** *FromIndex*, **int** *Count*, **int** *ToIndex*); |
| VC++ | **long** *CountMoved* = *object*->**MoveItems**(**long** *FromIndex*, **long** *Count*, **long** *ToIndex*); |
| C | **HRESULT** *object*->raw_**MoveItems**(**long** *FromIndex*, **long** *Count*, **long** *ToIndex*, **long*** *CountMoved*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
FromIndex
The zero-based index of the first item to be moved.
Count
The number of items to be moved.
ToIndex
The zero-based index of the position where the items are to be inserted. If *ToIndex* is -1, the items will be moved to the end of the list.
CountMoved
Returns the number of items moved.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Move instead
The MoveItems method moves items to a new position in the tree control.
The MoveItems method copies all item attributes, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text, graphics, level, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) contents, etc. All application specific data is moved (such as the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data), etc.). The [CopyItemDataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CopyItemDataString) property has no effect.
The target item *ToIndex* cannot be inside the group of items to be moved.
Items can be copied using the Items.[Copy](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Copy) method.
See Also SftTree Object | Object Hierarchy
## Multiline Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Multiline*
Defines whether [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Multiline** **As Boolean** |
| VB | *Boolean* = *object*.**Multiline** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Multiline**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Multiline**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Multiline**(); |
| C | **HRESULT** *object*->get_**Multiline**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Multiline** = *Boolean* **As Boolean** |
| VB | *object*.**Multiline** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Multiline** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Multiline** = *Boolean*;
**void** *object*->Put**Multiline**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Multiline**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Boolean
Defines whether column footer titles can consist of multiple text lines.
| Boolean | Description |
| --- | --- |
| True | Column footer titles can consist of multiple text lines. |
| False | Column footer titles can consist of a single line of text only. |
### Comments
The Multiline property defines whether column footer titles can consist of multiple text lines.
Column footer text can be defined using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Text) property. By including new-line characters in the title text, multiple lines of text can be displayed in each column footer. The column footer height is automatically adjusted.
See Also SftTreeFooters Object | Object Hierarchy
## Multiline Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline*
Defines whether [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Multiline** **As Boolean** |
| VB | *Boolean* = *object*.**Multiline** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Multiline**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Multiline**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Multiline**(); |
| C | **HRESULT** *object*->get_**Multiline**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Multiline** = *Boolean* **As Boolean** |
| VB | *object*.**Multiline** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Multiline** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Multiline** = *Boolean*;
**void** *object*->Put**Multiline**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Multiline**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Boolean
Defines whether column header titles can consist of multiple text lines.
| Boolean | Description |
| --- | --- |
| True | Column header titles can consist of multiple text lines. |
| False | Column header titles can consist of a single line of text only. |
### Comments
The Multiline property defines whether column header titles can consist of multiple text lines.
Column header text can be defined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text) property. By including new-line characters in the title text, multiple lines of text can be displayed in each column header. The column header height is automatically adjusted.
See Also SftTreeHeaders Object | Object Hierarchy
## MultilineHeader Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MultilineHeader*
Defines whether [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) titles can consist of [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**MultilineHeader** **As Boolean** |
| VB | *Boolean* = *object*.**MultilineHeader** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**MultilineHeader**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**MultilineHeader**;
**VARIANT_BOOL** *Boolean* = *object*->Get**MultilineHeader**(); |
| C | **HRESULT** *object*->get_**MultilineHeader**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MultilineHeader** = *Boolean* **As Boolean** |
| VB | *object*.**MultilineHeader** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**MultilineHeader** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**MultilineHeader** = *Boolean*;
**void** *object*->Put**MultilineHeader**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**MultilineHeader**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether column header titles can consist of multiple text lines.
| Boolean | Description |
| --- | --- |
| True | Column header titles can consist of multiple text lines. |
| False | Column header titles can consist of a single line of text only. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Multiline instead
The MultilineHeader property defines whether column header titles can consist of multiple text lines.
Column header text can be defined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text) property. By including new-line characters in the title text, multiple lines of text can be displayed in each column header. The column header height is automatically adjusted.
See Also SftTree Object | Object Hierarchy
## MultiSelect Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MultiSelect*
Defines whether one or multiple items can be selected at a time.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**MultiSelect** **As [SftTreeMultiSelectConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMultiSelectConstants)** |
| VB | *Style* = *object*.**MultiSelect** **As SftTreeMultiSelectConstants** |
| C#.NET | **SftTreeMultiSelectConstants** *Style* = *object*.**MultiSelect**; |
| VC++ | **enum SftTreeMultiSelectConstants** *Style* = *object*->**MultiSelect**;
**enum SftTreeMultiSelectConstants** *Style* = *object*->Get**MultiSelect**(); |
| C | **HRESULT** *object*->get_**MultiSelect**(**enum SftTreeMultiSelectConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MultiSelect** = *Style* **As SftTreeMultiSelectConstants** |
| VB | *object*.**MultiSelect** = *Style* **As SftTreeMultiSelectConstants** |
| C#.NET | **SftTreeMultiSelectConstants** *object*.**MultiSelect** = *Style*; |
| VC++ | **enum SftTreeMultiSelectConstants** *object*->**MultiSelect** = *Style*;
**void** *object*->Put**MultiSelect**(**enum SftTreeMultiSelectConstants** *Style*); |
| C | **HRESULT** *object*->put_**MultiSelect**(**enum SftTreeMultiSelectConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines whether one or multiple items can be selected at a time.
| Style | Value | Description |
| --- | --- | --- |
| selectSftTreeSingle | 0 | Only one item can be selected at a time. A new selection automatically deselects the previously [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). |
| selectSftTreeMulti | 1 | One or more items can be selected using the mouse. Using the CONTROL key causes additional items to be selected without removing previous selections. Using the SHIFT key causes ranges of items to be selected, starting at the last position. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.MultiSelect instead
The MultiSelect property defines whether one or multiple items can be selected at a time.
Any selections made before changing the MultiSelect property are lost.
See Also SftTree Object | Object Hierarchy
## MultiSelect Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect*
Defines whether one or multiple items can be selected at a time.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**MultiSelect** **As [SftTreeMultiSelectConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMultiSelectConstants)** |
| VB | *Style* = *object*.**MultiSelect** **As SftTreeMultiSelectConstants** |
| C#.NET | **SftTreeMultiSelectConstants** *Style* = *object*.**MultiSelect**; |
| VC++ | **enum SftTreeMultiSelectConstants** *Style* = *object*->**MultiSelect**;
**enum SftTreeMultiSelectConstants** *Style* = *object*->Get**MultiSelect**(); |
| C | **HRESULT** *object*->get_**MultiSelect**(**enum SftTreeMultiSelectConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**MultiSelect** = *Style* **As SftTreeMultiSelectConstants** |
| VB | *object*.**MultiSelect** = *Style* **As SftTreeMultiSelectConstants** |
| C#.NET | **SftTreeMultiSelectConstants** *object*.**MultiSelect** = *Style*; |
| VC++ | **enum SftTreeMultiSelectConstants** *object*->**MultiSelect** = *Style*;
**void** *object*->Put**MultiSelect**(**enum SftTreeMultiSelectConstants** *Style*); |
| C | **HRESULT** *object*->put_**MultiSelect**(**enum SftTreeMultiSelectConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines whether one or multiple items can be selected at a time.
| Style | Value | Description |
| --- | --- | --- |
| selectSftTreeSingle | 0 | Only one item can be selected at a time. A new selection automatically deselects the previously [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). |
| selectSftTreeMulti | 1 | One or more items can be selected using the mouse. Using the CONTROL key causes additional items to be selected without removing previous selections. Using the SHIFT key causes ranges of items to be selected, starting at the last position. |
### Comments
The MultiSelect property defines whether one or multiple items can be selected at a time.
Any selections made before changing the MultiSelect property are lost.
See Also SftTreeItems Object | Object Hierarchy
## NETImageObject Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject*
Defines the image object using a .NET image object (IUnknown interface).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *pUnknown* = *object*.**NETImageObject** **As VT_UNKNOWN** |
| VB | *pUnknown* = *object*.**NETImageObject** **As VT_UNKNOWN** |
| C#.NET | **VT_UNKNOWN** *pUnknown* = *object*.**NETImageObject**; |
| VC++ | **VT_UNKNOWN** *pUnknown* = *object*->**NETImageObject**;
**VT_UNKNOWN** *pUnknown* = *object*->Get**NETImageObject**(); |
| C | **HRESULT** *object*->get_**NETImageObject**(**VT_UNKNOWN*** *pUnknown*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**NETImageObject** = *pUnknown* **As VT_UNKNOWN** |
| VB | **Set** *object*.**NETImageObject** = *pUnknown* **As VT_UNKNOWN** |
| C#.NET | **VT_UNKNOWN** *object*.**NETImageObject** = *pUnknown*; |
| VC++ | **VT_UNKNOWN** *object*->**NETImageObject** = *pUnknown*;
**void** *object*->PutRef**NETImageObject**(**VT_UNKNOWN** *pUnknown*); |
| C | **HRESULT** *object*->putref_**NETImageObject**(**VT_UNKNOWN** *pUnknown*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
pUnknown
Defines the image object using a .NET image object (IUnknown interface).
### Comments
The NETImageObject property defines the image object using a .NET image object (IUnknown interface).
Typically, .NET applications use the NETImageObject property to define an image, C and C++ applications use [BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle) or [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image), VB6 and other COM applications use the [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) property.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeGDIPlus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
Use of this property requires the [SftHelperComponent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet) component, which is added to each project (see "Using SftTree/OCX with .NET").
See Also SftPictureObject Object | Object Hierarchy
## NextShown Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown*
Returns the index of the next [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**NextShown** **As Integer** |
| VB | *ItemIndex* = *object*.**NextShown** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**NextShown**; |
| VC++ | **long** *ItemIndex* = *object*->**NextShown**;
**long** *ItemIndex* = *object*->Get**NextShown**(); |
| C | **HRESULT** *object*->get_**NextShown**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the index of the next visible item. -1 is returned, if no item is found.
### Comments
The NextShown property returns the index of the next visible item.
Dependent items of a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item are skipped using this method.
Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[PrevShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown), Items.[LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) to retrieve information about item visibility.
See Also SftTreeItem Object | Object Hierarchy
## NextSibling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NextSibling*
Returns the index of an item's next sibling item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *SiblingIndex* = *object*.get_**NextSibling**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *SiblingIndex* = *object*.**NextSibling**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *SiblingIndex* = *object*.get_**NextSibling**(**int** *ItemIndex*); |
| VC++ | **long** *SiblingIndex* = *object*->**NextSibling**[**long** *ItemIndex*];
**long** *SiblingIndex* = *object*->Get**NextSibling**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**NextSibling**(**long** *ItemIndex*, **long*** *SiblingIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose next sibling item is to be returned.
SiblingIndex
Returns the index of the item's next sibling item. -1 is returned if the item doesn't have a next sibling.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.NextSibling instead
The NextSibling property returns the index of an item's next sibling item.
The next sibling of item *ItemIndex* is found by scanning towards the end of the tree control and locating an item on the same level (Item.[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as item *ItemIndex* without encountering a parent item.
The Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) property can be used to retrieve an item's previous sibling. The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) and Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) properties can be used to retrieve an item's first or last sibling.
See Also SftTree Object | Object Hierarchy
## NextSibling Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling*
Returns the item's next sibling.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**NextSibling** **As Integer** |
| VB | *ItemIndex* = *object*.**NextSibling** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**NextSibling**; |
| VC++ | **long** *ItemIndex* = *object*->**NextSibling**;
**long** *ItemIndex* = *object*->Get**NextSibling**(); |
| C | **HRESULT** *object*->get_**NextSibling**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's next sibling. -1 is returned if the item doesn't have a next sibling.
### Comments
The NextSibling property returns the item's next sibling.
The next sibling of the item is found by scanning towards the end of the tree control and locating an item on the same level ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as the item without encountering a parent item.
The Item.[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) property can be used to retrieve an item's previous sibling. The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) and Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) properties can be used to retrieve an item's first or last sibling.
See Also SftTreeItem Object | Object Hierarchy
## NoFocusStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NoFocusStyle*
Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**NoFocusStyle** **As [SftTreeNoFocusStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants)** |
| VB | *Style* = *object*.**NoFocusStyle** **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *Style* = *object*.**NoFocusStyle**; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *Style* = *object*->**NoFocusStyle**;
**enum SftTreeNoFocusStyleConstants** *Style* = *object*->Get**NoFocusStyle**(); |
| C | **HRESULT** *object*->get_**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**NoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| VB | *object*.**NoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *object*.**NoFocusStyle** = *Style*; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *object*->**NoFocusStyle** = *Style*;
**void** *object*->Put**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the display style of selected items when the tree control does not have the input focus.
| Style | Value | Description |
| --- | --- | --- |
| noFocusSftTreeKeepSel | 0 | The selected items are drawn the same way as for a tree control that has the input focus, so the user cannot distinguish between selected items in an active tree control and an inactive control. The Items.[SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus) and Items.[SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus) properties can be used to define the colors used for selected items in this case. |
| noFocusSftTreeFrame | 1 | The selected items are drawn as items that are not selected, but are framed by a rectangle drawn using the color specified by the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property. |
| noFocusSftTreeNothing | 2 | The selected items are drawn as items that are not selected. The user cannot distinguish between selected items and items that are not selected in an inactive tree control. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.NoFocusStyle instead
The NoFocusStyle property defines the display style of selected items when the tree control does not have the input focus.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is used to change the appearance of selected items in a tree control that has the input focus.
See Also SftTree Object | Object Hierarchy
## NoFocusStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle*
Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**NoFocusStyle** **As [SftTreeNoFocusStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants)** |
| VB | *Style* = *object*.**NoFocusStyle** **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *Style* = *object*.**NoFocusStyle**; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *Style* = *object*->**NoFocusStyle**;
**enum SftTreeNoFocusStyleConstants** *Style* = *object*->Get**NoFocusStyle**(); |
| C | **HRESULT** *object*->get_**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**NoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| VB | *object*.**NoFocusStyle** = *Style* **As SftTreeNoFocusStyleConstants** |
| C#.NET | **SftTreeNoFocusStyleConstants** *object*.**NoFocusStyle** = *Style*; |
| VC++ | **enum SftTreeNoFocusStyleConstants** *object*->**NoFocusStyle** = *Style*;
**void** *object*->Put**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**NoFocusStyle**(**enum SftTreeNoFocusStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the display style of selected items when the tree control does not have the input focus.
| Style | Value | Description |
| --- | --- | --- |
| noFocusSftTreeKeepSel | 0 | The selected items are drawn the same way as for a tree control that has the input focus, so the user cannot distinguish between selected items in an active tree control and an inactive control. The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus) and Items.[SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus) properties can be used to define the colors used for selected items in this case. |
| noFocusSftTreeFrame | 1 | The selected items are drawn as items that are not selected, but are framed by a rectangle drawn using the color specified by the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property. |
| noFocusSftTreeNothing | 2 | The selected items are drawn as items that are not selected. The user cannot distinguish between selected items and items that are not selected in an inactive tree control. |
### Comments
The NoFocusStyle property defines the display style of selected items when the tree control does not have the input focus.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is used to change the appearance of selected items in a tree control that has the input focus.
The Items.[EditNoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_EditNoFocusStyle) property can be used to define the display style of selected items during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
See Also SftTreeItems Object | Object Hierarchy
## NoSelection Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_NoSelection*
Defines whether the selection changes when the caret location changes.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**[NoSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection)** **As Boolean** |
| VB | *Boolean* = *object*.**NoSelection** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**NoSelection**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**NoSelection**;
**VARIANT_BOOL** *Boolean* = *object*->Get**NoSelection**(); |
| C | **HRESULT** *object*->get_**NoSelection**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**NoSelection** = *Boolean* **As Boolean** |
| VB | *object*.**NoSelection** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**NoSelection** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**NoSelection** = *Boolean*;
**void** *object*->Put**NoSelection**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**NoSelection**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the selection changes when the caret location changes.
| Boolean | Description |
| --- | --- |
| True | The selection doesn't change when the caret location changes. |
| False | The selection changes when the caret location changes. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionArea instead
The NoSelection property defines whether the selection changes when the caret location changes.
If the NoSelection property is set to True, the selection does not automatically follow the caret location when the user clicks outside of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). If the CONTROL key is used with a directional key (such as an arrow key), the caret location changes, but the current selection remains. This allows a user to click on an [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) without changing the currently [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections)(s).
In a multiple selection tree control, the selection never follows the caret location when the user clicks outside of a cell, regardless of the setting of this property.
See Also SftTree Object | Object Hierarchy
## NoSelection Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoSelection*
Defines whether the selection changes when the caret location changes.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**NoSelection** **As Boolean** |
| VB | *Boolean* = *object*.**NoSelection** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**NoSelection**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**NoSelection**;
**VARIANT_BOOL** *Boolean* = *object*->Get**NoSelection**(); |
| C | **HRESULT** *object*->get_**NoSelection**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**NoSelection** = *Boolean* **As Boolean** |
| VB | *object*.**NoSelection** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**NoSelection** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**NoSelection** = *Boolean*;
**void** *object*->Put**NoSelection**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**NoSelection**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether the selection changes when the caret location changes.
| Boolean | Description |
| --- | --- |
| True | The selection doesn't change when the caret location changes. |
| False | The selection changes when the caret location changes. |
### Comments
The NoSelection property defines whether the selection changes when the caret location changes.
If the NoSelection property is set to True, the selection does not automatically follow the caret location when the user clicks outside of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells). If the CONTROL key is used with a directional key (such as an arrow key), the caret location changes, but the current selection remains. This allows a user to click on an [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) without changing the currently [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections)(s).
In a multiple selection tree control, the selection never follows the caret location when the user clicks outside of a cell, regardless of the setting of this property.
See Also SftTreeItems Object | Object Hierarchy
## Offset Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset*
Defines the horizontal offset of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Offset* = *object*.**Offset** **As Single** |
| VB | *Offset* = *object*.**Offset** **As Single** |
| C#.NET | **float** *Offset* = *object*.**Offset**; |
| VC++ | **float** *Offset* = *object*->**Offset**;
**float** *Offset* = *object*->Get**Offset**(); |
| C | **HRESULT** *object*->get_**Offset**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Offset** = *Offset* **As Single** |
| VB | *object*.**Offset** = *Offset* **As Single** |
| C#.NET | **float** *object*.**Offset** = *Offset*; |
| VC++ | **float** *object*->**Offset** = *Offset*;
**void** *object*->Put**Offset**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**Offset**(**float** *Offset*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Offset
Defines the horizontal offset of the splitter bar in a split tree control. If -1 is specified, the splitter bar is centered in the tree control's client area making each pane the same size and the Offset property is updated with the actual offset. If the offset specified falls outside of the client area, the splitter bar is aligned with the left or right edge, whichever is closer to the offset specified. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Offset property defines the horizontal offset of the splitter bar in a split tree control.
The Offset and [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[OffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix) properties are synonyms, but may use different coordinate systems.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
Splitter.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal) can be used to position the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar (based on the left pane's [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property).
The coordinates of the splitter bar can be retrieved using Splitter.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition).
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to change the width of the splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## OffsetChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OffsetChange*
The user scrolls the tree control horizontally.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OffsetChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OffsetChange** |
| VB | **Private Sub** *object*_**OffsetChange**(**ByVal** *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* **As Single**) |
| C#.NET | **void** *object*_**OffsetChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OffsetChange***object*(**float** *Offset*); |
| C | **HRESULT** On**OffsetChange***object*(**float** *Offset*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Offset
The new horizontal offset.
### Comments
The OffsetChange event occurs when the user scrolls the tree control horizontally.
The OffsetChange event notifies an application that the [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) offset has been changed by the user.
The [TopChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_TopChange) event can be used to determine vertical scrolling by the user.
See Also SftTree Object | Object Hierarchy
## OffsetMin Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMin*
Defines the minimum splitter offset so the user cannot hide the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) entirely.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset)* = *object*.**OffsetMin** **As Single** |
| VB | *Offset* = *object*.**OffsetMin** **As Single** |
| C#.NET | **float** *Offset* = *object*.**OffsetMin**; |
| VC++ | **float** *Offset* = *object*->**OffsetMin**;
**float** *Offset* = *object*->Get**OffsetMin**(); |
| C | **HRESULT** *object*->get_**OffsetMin**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OffsetMin** = *Offset* **As Single** |
| VB | *object*.**OffsetMin** = *Offset* **As Single** |
| C#.NET | **float** *object*.**OffsetMin** = *Offset*; |
| VC++ | **float** *object*->**OffsetMin** = *Offset*;
**void** *object*->Put**OffsetMin**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**OffsetMin**(**float** *Offset*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Offset
Defines the minimum splitter offset so the user cannot hide the left pane entirely.
### Comments
The OffsetMin property defines the minimum splitter offset so the user cannot hide the left pane entirely.
The OffsetMin and [OffsetMinPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMinPix) properties are synonyms, but may use different coordinate systems.
The minimum applies to mouse dragging, keyboard resizing, and the Offset property. The default is 0 (no minimum).
See Also SftTreeSplitter Object | Object Hierarchy
## OffsetMinPix Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMinPix*
Defines the minimum splitter offset so the user cannot hide the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) entirely.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *OffsetMinPix* = *object*.**OffsetMinPix** **As Integer** |
| VB | *OffsetMinPix* = *object*.**OffsetMinPix** **As Long** |
| C#.NET | **int** *OffsetMinPix* = *object*.**OffsetMinPix**; |
| VC++ | **long** *OffsetMinPix* = *object*->**OffsetMinPix**;
**long** *OffsetMinPix* = *object*->Get**OffsetMinPix**(); |
| C | **HRESULT** *object*->get_**OffsetMinPix**(**long*** *OffsetMinPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OffsetMinPix** = *OffsetMinPix* **As Integer** |
| VB | *object*.**OffsetMinPix** = *OffsetMinPix* **As Long** |
| C#.NET | **int** *object*.**OffsetMinPix** = *OffsetMinPix*; |
| VC++ | **long** *object*->**OffsetMinPix** = *OffsetMinPix*;
**void** *object*->Put**OffsetMinPix**(**long** *OffsetMinPix*); |
| C | **HRESULT** *object*->put_**OffsetMinPix**(**long** *OffsetMinPix*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
OffsetMinPix
Defines the minimum splitter offset so the user cannot hide the left pane entirely.
### Comments
The OffsetMinPix property defines the minimum splitter offset so the user cannot hide the left pane entirely.
The [OffsetMin](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetMin) and OffsetMinPix properties are synonyms, but may use different coordinate systems.
The minimum applies to mouse dragging, keyboard resizing, and the [OffsetPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix) property. The default is 0 (no minimum).
See Also SftTreeSplitter Object | Object Hierarchy
## OffsetPix Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_OffsetPix*
Defines the horizontal offset of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *OffsetPix* = *object*.**OffsetPix** **As Integer** |
| VB | *OffsetPix* = *object*.**OffsetPix** **As Long** |
| C#.NET | **int** *OffsetPix* = *object*.**OffsetPix**; |
| VC++ | **long** *OffsetPix* = *object*->**OffsetPix**;
**long** *OffsetPix* = *object*->Get**OffsetPix**(); |
| C | **HRESULT** *object*->get_**OffsetPix**(**long*** *OffsetPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OffsetPix** = *OffsetPix* **As Integer** |
| VB | *object*.**OffsetPix** = *OffsetPix* **As Long** |
| C#.NET | **int** *object*.**OffsetPix** = *OffsetPix*; |
| VC++ | **long** *object*->**OffsetPix** = *OffsetPix*;
**void** *object*->Put**OffsetPix**(**long** *OffsetPix*); |
| C | **HRESULT** *object*->put_**OffsetPix**(**long** *OffsetPix*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
OffsetPix
Defines the horizontal offset of the splitter bar in a split tree control in pixels. If -1 is specified, the splitter bar is centered in the tree control's client area making each pane the same size and the [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) property is updated with the actual offset. If the offset specified falls outside of the client area, the splitter bar is aligned with the left or right edge, whichever is closer to the offset specified.
### Comments
The OffsetPix property defines the horizontal offset of the splitter bar in a split tree control.
The Splitter.Offset and OffsetPix properties are synonyms, but may use different coordinate systems.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
Splitter.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal) can be used to position the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar (based on the left pane's [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property).
The coordinates of the splitter bar can be retrieved using Splitter.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition).
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to change the width of the splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## OLECompleteDrag Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLECompleteDrag*
The [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation has ended.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLECompleteDrag**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLECompleteDrag** |
| VB | **Private Sub** *object*_**OLECompleteDrag**(*Effect* **As Long**) |
| C#.NET | **void** *object*_**OLECompleteDrag**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLECompleteDrag***object*(**long*** *Effect*); |
| C | **HRESULT** On**OLECompleteDrag***object*(**long*** *Effect*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Effect
A value set by the target object identifying the action that has been performed, thus allowing the source to take appropriate action if the component was moved (such as the source deleting data if it is moved from one component to another).
| Effect | Value | Description |
| --- | --- | --- |
| vbDropEffectNone | 0 | [Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
**Note**: Only Visual Basic offers the predefined constants vbDropEffectNone, etc. When using other languages, the constants have to be defined explicitly by the application.
### Comments
The OLECompleteDrag event occurs when the OLE drag & drop operation has ended.
The OLECompleteDrag event occurs when source object is notified that the OLE drag & drop operation is ending.
The OLECompleteDrag event is the final event to be called in an OLE drag & drop operation. This event informs the source component of the action that was performed when the object was dropped onto the target component. The target sets this value through the *Effect* parameter of the [OLEDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragDrop) event. Based on this, the source can then determine the appropriate action it needs to take. For example, if the object was moved into the target (vbDropEffectMove), the source needs to delete the object from itself after the move.
See Also SftTree Object | Object Hierarchy
## OLEDrag Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDrag*
Initiates an [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**OLEDrag**() |
| VB | *object*.**OLEDrag** |
| C#.NET | **void** *object*.**OLEDrag**(); |
| VC++ | **HRESULT** *object*->**OLEDrag**(); |
| C | **HRESULT** *object*->raw_**OLEDrag**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The OLEDrag method initiates an OLE drag & drop operation.
When the OLEDrag method is called, the [OLEStartDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEStartDrag) event occurs, allowing the application to supply data to a target component.
An application can invoke an OLE drag & drop operation explicitly using the OLEDrag method.
If the [DragMethod](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragMethod) property is set to [dragSftTreeOLE](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeDragMethodConstants), the OLEDrag method is automatically invoked when a drag & drop operation is started by the user, depending on the [DragType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_DragType) property.
See Also SftTree Object | Object Hierarchy
## OLEDragDrop Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragDrop*
An [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) event indicating something has been dropped over the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLEDragDrop**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLEDragDrop** |
| VB | **Private Sub** *object*_**OLEDragDrop**(*Data* **As [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject)**, *Effect* **As Long**, *Button* **As Integer**, *Shift* **As Integer**, *x* **As Single**, *y* **As Single**) |
| C#.NET | **void** *object*_**OLEDragDrop**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLEDragDrop***object*(**struct IVDMDataObject**** *Data*, **long*** *Effect*, **short*** *Button*, **short*** *Shift*, **float*** *x*, **float*** *y*); |
| C | **HRESULT** On**OLEDragDrop***object*(**struct IVDMDataObject**** *Data*, **long*** *Effect*, **short*** *Button*, **short*** *Shift*, **float*** *x*, **float*** *y*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Data
A DataObject object containing formats that the source will provide and, in addition, possibly the data for those formats. If no data is contained in the DataObject, it is provided when the control calls the DataObject.[GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) method. The DataObject.[SetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData) and DataObject.[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear) methods cannot be used here.
Effect
Set by the target component identifying the action that has been performed (if any), thus allowing the source to take appropriate action if the component was moved (such as the source deleting the data).
| Effect | Value | Description |
| --- | --- | --- |
| vbDropEffectNone | 0 | [Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
**Note**: Only Visual Basic offers the predefined constants vbDropEffectNone, etc. When using other languages, the constants have to be defined explicitly by the application.
Button
The button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor.
y
The y coordinate of the mouse cursor.
### Comments
The OLEDragDrop event occurs indicating something has been dropped over the tree control.
The OLEDragDrop event only occurs if the [OLEDropMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDropMode) property is set to [OLEDropSftTreeManual](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDropModeConstants).
The source control should always mask values from the *Effect* parameter to ensure compatibility with future implementations of drag & drop. Presently, only three bits in the *Effect* parameter are used. In future versions other bits may be used. As a precaution against future problems, drag sources and drop targets should mask these values appropriately before performing any comparisons.
For example, a source component should not compare an *Effect*** **against, for example, vbDropEffectCopy, such as:
```
If Effect = vbDropEffectCopy...
```
Instead, the source component should mask the value or values being sought, as here:
```
If Effect And vbDropEffectCopy = vbDropEffectCopy...
```
-or-
```
If (Effect And vbDropEffectCopy)...
```
This allows for the definition of new drop effects in future versions while preserving compatibility with your existing code.
See Also SftTree Object | Object Hierarchy
## OLEDragOver Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver*
An [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) event indicating something is being dragged over the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLEDragOver**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLEDragOver** |
| VB | **Private Sub** *object*_**OLEDragOver**(*Data* **As [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject)**, *Effect* **As Long**, *Button* **As Integer**, *Shift* **As Integer**, *x* **As Single**, *y* **As Single**, *State* **As Integer**) |
| C#.NET | **void** *object*_**OLEDragOver**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLEDragOver***object*(**struct IVDMDataObject**** *Data*, **long*** *Effect*, **short*** *Button*, **short*** *Shift*, **float*** *x*, **float*** *y*, **short*** *State*); |
| C | **HRESULT** On**OLEDragOver***object*(**struct IVDMDataObject**** *Data*, **long*** *Effect*, **short*** *Button*, **short*** *Shift*, **float*** *x*, **float*** *y*, **short*** *State*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Data
A DataObject object containing formats that the source will provide and, in addition, possibly the data for those formats. If no data is contained in the DataObject, it is provided when the control calls the DataObject.[GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) method. The DataObject.[SetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData) and DataObject.[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear) methods cannot be used here.
Effect
Set by the source object identifying all effects it supports. This parameter must be correctly set by the target component during this event. The value of *Effect* is determined by logically Or'ing together all active effects. The target component should check these effects and other parameters to determine which actions are appropriate for it, and then set this parameter to one of the allowable effects (as specified by the source) to specify which actions will be performed if the user drops the selection on the component.
| Effect | Value | Description |
| --- | --- | --- |
| vbDropEffectNone | 0 | [Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
**Note**: Only Visual Basic offers the predefined constants vbDropEffectNone, etc. When using other languages, the constants have to be defined explicitly by the application.
Button
An Integer variable describing the button that is pressed during the event (see [SftTreeButtonConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeButtonConstants)). The button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
| --- | --- | --- |
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see [SftTreeKeyConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeKeyConstants)). A bit is set if the key is down. The *Shift* argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The *Shift* variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
| --- | --- | --- |
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor.
y
The y coordinate of the mouse cursor.
State
The transition state of the control being dragged in relation to the target control.
| State | Value | Description |
| --- | --- | --- |
| vbEnter | 0 | Source component is being dragged within the range of a target. |
| vbLeave | 1 | Source component is being dragged out of the range of a target. |
| vbOver | 2 | Source component has moved from one position in the target to another. |
**Note**: Only Visual Basic offers the predefined constants vbEnter, etc. When using other languages, the constants have to be defined explicitly by the application.
### Comments
The OLEDragOver event occurs indicating something is being dragged over the tree control.
The OLEDragOver event only occurs if the [OLEDropMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDropMode) property is set to [OLEDropSftTreeManual](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDropModeConstants).
The source control should always mask values from the *Effect* parameter to ensure compatibility with future implementations of drag & drop. Presently, only three bits in the *Effect* parameter are used. In future versions other bits may be used. As a precaution against future problems, drag sources and drop targets should mask these values appropriately before performing any comparisons.
For example, a source component should not compare an *Effect*** **against, for example, vbDropEffectCopy, such as:
```
If Effect = vbDropEffectCopy...
```
Instead, the source component should mask the value or values being sought, as here:
```
If Effect And vbDropEffectCopy = vbDropEffectCopy...
```
-or-
```
If (Effect And vbDropEffectCopy)...
```
This allows for the definition of new drop effects in future versions while preserving compatibility with your existing code.
See Also SftTree Object | Object Hierarchy
## OLEDropMode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDropMode*
Defines whether the tree control can act as an OLE [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**OLEDropMode** **As [SftTreeOLEDropModeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOLEDropModeConstants)** |
| VB | *Style* = *object*.**OLEDropMode** **As SftTreeOLEDropModeConstants** |
| C#.NET | **SftTreeOLEDropModeConstants** *Style* = *object*.**OLEDropMode**; |
| VC++ | **enum SftTreeOLEDropModeConstants** *Style* = *object*->**OLEDropMode**;
**enum SftTreeOLEDropModeConstants** *Style* = *object*->Get**OLEDropMode**(); |
| C | **HRESULT** *object*->get_**OLEDropMode**(**enum SftTreeOLEDropModeConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OLEDropMode** = *Style* **As SftTreeOLEDropModeConstants** |
| VB | *object*.**OLEDropMode** = *Style* **As SftTreeOLEDropModeConstants** |
| C#.NET | **SftTreeOLEDropModeConstants** *object*.**OLEDropMode** = *Style*; |
| VC++ | **enum SftTreeOLEDropModeConstants** *object*->**OLEDropMode** = *Style*;
**void** *object*->Put**OLEDropMode**(**enum SftTreeOLEDropModeConstants** *Style*); |
| C | **HRESULT** *object*->put_**OLEDropMode**(**enum SftTreeOLEDropModeConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines whether the tree control can act as an OLE drop target.
| Style | Value | Description |
| --- | --- | --- |
| OLEDropSftTreeNone | 0 | The tree control is not a valid drop target. |
| OLEDropSftTreeManual | 1 | The tree control is a valid drop target and triggers the OLE drop events, allowing the application to handle the OLE drop operation. |
### Comments
The OLEDropMode property defines whether the tree control can act as an OLE drop target.
The events [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) and [OLEDragDrop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragDrop) occur when an item is dragged over the tree control or when an item is dropped.
See Also SftTree Object | Object Hierarchy
## OLEGiveFeedback Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEGiveFeedback*
The [OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) operation is in progress, used for visual feedback.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLEGiveFeedback**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLEGiveFeedback** |
| VB | **Private Sub** *object*_**OLEGiveFeedback**(*Effect* **As Long**, *DefaultCursors* **As Boolean**) |
| C#.NET | **void** *object*_**OLEGiveFeedback**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLEGiveFeedback***object*(**long*** *Effect*, **VARIANT_BOOL*** *DefaultCursors*); |
| C | **HRESULT** On**OLEGiveFeedback***object*(**long*** *Effect*, **VARIANT_BOOL*** *DefaultCursors*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Effect
Set by the target component in the [OLEDragOver](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEDragOver) event specifying the action to be performed if the user drops the selection on it. This allows the source to take the appropriate action (such as giving visual feedback).
| Effect | Value | Description |
| --- | --- | --- |
| vbDropEffectNone | 0 | [Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
**Note**: Only Visual Basic offers the predefined constants vbDropEffectNone, etc. When using other languages, the constants have to be defined explicitly by the application.
DefaultCursors
Determines whether the default mouse cursor provided by the component is used, or a user-defined mouse cursor is used. If set to True, the default mouse cursor is used, otherwise the mouse cursor defined using the [MousePointer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_MousePointer) property (of the Screen object) is used instead.
### Comments
The OLEGiveFeedback event occurs when the OLE drag & drop operation is in progress, used for visual feedback.
The OLEGiveFeedback event occurs after every OLEDragOver event. OLEGiveFeedback allows the source component to provide visual feedback to the user, such as changing the mouse cursor to indicate what will happen if the user drops the object, or provide visual feedback on the selection (in the source component) to indicate what will happen.
If there is no code in the OLEGiveFeedback event, or if the *DefaultCursors* parameter is set to True, the default cursor provided by the component is used as the mouse cursor.
The source control should always mask values from the *Effect* parameter to ensure compatibility with future implementations of drag & drop. Presently, only three bits in the *Effect* parameter are used. In future versions other bits may be used. As a precaution against future problems, drag sources and drop targets should mask these values appropriately before performing any comparisons.
For example, a source component should not compare an *Effect*** **against, for example, vbDropEffectCopy, such as:
```
If Effect = vbDropEffectCopy...
```
Instead, the source component should mask the value or values being sought, as here:
```
If Effect And vbDropEffectCopy = vbDropEffectCopy...
```
-or-
```
If (Effect And vbDropEffectCopy)...
```
This allows for the definition of new drop effects in future versions while preserving compatibility with your existing code.
See Also SftTree Object | Object Hierarchy
## OLESetData Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLESetData*
[OLE drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dragdrop) data needs to be provided.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLESetData**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLESetData** |
| VB | **Private Sub** *object*_**OLESetData**(*Data* **As [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject)**, *Format* **As Integer**) |
| C#.NET | **void** *object*_**OLESetData**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLESetData***object*(**struct IVDMDataObject**** *Data*, **short*** *Format*); |
| C | **HRESULT** On**OLESetData***object*(**struct IVDMDataObject**** *Data*, **short*** *Format*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Data
A DataObject object used to define formats that the source provides and optionally, the data for those formats. If no data is contained in the DataObject *Data*, it is provided when the target control calls the DataObject.[GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) method and you should provide the values for the *Data* parameter.
Format
Defines the format of the data that the target component is requesting. The source component uses this value to determine what to load into the DataObject object.
### Comments
The OLESetData event occurs when OLE drag & drop data needs to be provided.
In certain cases, you may wish to defer loading data into the DataObject object of a source component to save time, especially if the source component supports many formats. This event allows the source to respond to only one request for a given format of data. When this event is called, the source should check the *Format* parameter to determine what needs to be loaded and then perform the DataObject.[SetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData) method on the DataObject object to load the data which is then passed back to the target component.
See Also SftTree Object | Object Hierarchy
## OLEStartDrag Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLEStartDrag*
The tree control's [OLEDrag](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OLEDrag) method has been invoked.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**OLEStartDrag**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**OLEStartDrag** |
| VB | **Private Sub** *object*_**OLEStartDrag**(*Data* **As [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject)**, *AllowedEffects* **As Long**) |
| C#.NET | **void** *object*_**OLEStartDrag**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**OLEStartDrag***object*(**struct IVDMDataObject**** *Data*, **long*** *AllowedEffects*); |
| C | **HRESULT** On**OLEStartDrag***object*(**struct IVDMDataObject**** *Data*, **long*** *AllowedEffects*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Data
A DataObject object used to define formats that the source provides and optionally, the data for those formats. If no data is contained in the DataObject *Data*, it is provided when the target control calls the DataObject.[GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) method and you should provide the values for the *Data* parameter.
AllowedEffects
Defines the effects that the source component supports. The source component should logically Or together the supported values and place the result in the *AllowedEffects* parameter. The target component can use this value to determine the appropriate action, and what the appropriate user feedback should be.
| Effect | Value | Description |
| --- | --- | --- |
| vbDropEffectNone | 0 | [Drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) cannot accept the data. |
| vbDropEffectCopy | 1 | Drop results in a copy of data from the source to the target. The original data is unaltered by the drag operation. |
| vbDropEffectMove | 2 | Drop results in data being moved from the drag source to the drop source. The drag source should remove the data from itself after the move. |
**Note**: Only Visual Basic offers the predefined constants vbDropEffectNone, etc. When using other languages, the constants have to be defined explicitly by the application.
### Comments
The OLEStartDrag event occurs when the tree control's OLEDrag method has been invoked.
This event specifies the data formats and drop effects that the source component supports. It can also be used to insert data into the DataObject object.
You may want to defer placing data into the DataObject object until the target component requests it. This allows the source component to save time by not loading multiple data formats. When the target performs the DataObject.GetData method on the DataObject, the source's [OLESetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLESetData) event will occur if the requested data is not contained in the DataObject. At this point, the data can be loaded into the DataObject, which will in turn provide the data to the target.
If the user does not load any formats into the DataObject, then the drag/drop operation is cancelled.
See Also SftTree Object | Object Hierarchy
## OpenEnded Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OpenEnded*
Defines whether the last column is [open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded).
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OpenEnded** **As Boolean** |
| VB | *Boolean* = *object*.**OpenEnded** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OpenEnded**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OpenEnded**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OpenEnded**(); |
| C | **HRESULT** *object*->get_**OpenEnded**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OpenEnded** = *Boolean* **As Boolean** |
| VB | *object*.**OpenEnded** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OpenEnded** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OpenEnded** = *Boolean*;
**void** *object*->Put**OpenEnded**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OpenEnded**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the last column is open-ended.
| Boolean | Description |
| --- | --- |
| True | The last column is open-ended. |
| False | The last column is not open-ended and uses the defined column width. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.OpenEnded instead
The OpenEnded property defines whether the last column is open-ended.
Using the OpenEnded property, the last displayed column can be defined as *open-ended*, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A *fixed-width* last column is defined with a specified width (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) and any data which doesn't fit is truncated.
The OpenEnded property defines the last column (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control) as open-ended.
The ColumnsObj.[OpenEnded2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded2) property defines the last column of the right pane of a split tree control. The ColumnsObj.OpenEnded2 property can only be used with a split tree control.
See Also SftTree Object | Object Hierarchy
## OpenEnded Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded*
Defines whether the last column is open-ended.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OpenEnded** **As Boolean** |
| VB | *Boolean* = *object*.**OpenEnded** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OpenEnded**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OpenEnded**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OpenEnded**(); |
| C | **HRESULT** *object*->get_**OpenEnded**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OpenEnded** = *Boolean* **As Boolean** |
| VB | *object*.**OpenEnded** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OpenEnded** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OpenEnded** = *Boolean*;
**void** *object*->Put**OpenEnded**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OpenEnded**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
Boolean
Defines whether the last column is open-ended.
| Boolean | Description |
| --- | --- |
| True | The last column is open-ended. |
| False | The last column is not open-ended and uses the defined column width. |
### Comments
The OpenEnded property defines whether the last column is open-ended.
Using the OpenEnded property, the last displayed column can be defined as *open-ended*, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A *fixed-width* last column is defined with a specified width (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) and any data which doesn't fit is truncated.
The OpenEnded property defines the last column (or the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control) as open-ended.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OpenEnded2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded2) property defines the last column of the right pane of a split tree control. The ColumnsObj.OpenEnded2 property can only be used with a split tree control.
See Also SftTreeColumns Object | Object Hierarchy
## OpenEnded2 Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OpenEnded2*
Defines whether the last column is [open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OpenEnded2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded2) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OpenEnded2** **As Boolean** |
| VB | *Boolean* = *object*.**OpenEnded2** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OpenEnded2**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OpenEnded2**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OpenEnded2**(); |
| C | **HRESULT** *object*->get_**OpenEnded2**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OpenEnded2** = *Boolean* **As Boolean** |
| VB | *object*.**OpenEnded2** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OpenEnded2** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OpenEnded2** = *Boolean*;
**void** *object*->Put**OpenEnded2**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OpenEnded2**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the last column is open-ended in the right pane.
| Boolean | Description |
| --- | --- |
| True | The last column is open-ended. |
| False | The last column is not open-ended and uses the defined column width. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.OpenEnded2 instead
The OpenEnded2 property defines whether the last column is open-ended in the right pane.
Using the OpenEnded2 property, the last displayed column of the right pane of a split tree control can be defined as *open-ended*, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A *fixed-width* last column is defined with a specified width (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) and any data which doesn't fit is truncated.
The OpenEnded2 property defines the last column of the right pane of a split tree control. The OpenEnded2 property can only be used with a split tree control.
The ColumnsObj.OpenEnded property defines the last column (or the left pane of a split tree control) as open-ended.
See Also SftTree Object | Object Hierarchy
## OpenEnded2 Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded2*
Defines whether the last column is [open-ended](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) in the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OpenEnded2** **As Boolean** |
| VB | *Boolean* = *object*.**OpenEnded2** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OpenEnded2**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OpenEnded2**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OpenEnded2**(); |
| C | **HRESULT** *object*->get_**OpenEnded2**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OpenEnded2** = *Boolean* **As Boolean** |
| VB | *object*.**OpenEnded2** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OpenEnded2** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OpenEnded2** = *Boolean*;
**void** *object*->Put**OpenEnded2**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OpenEnded2**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
Boolean
Defines whether the last column is open-ended in the right pane.
| Boolean | Description |
| --- | --- |
| True | The last column is open-ended. |
| False | The last column is not open-ended and uses the defined column width. |
### Comments
The OpenEnded2 property defines whether the last column is open-ended in the right pane.
Using the OpenEnded2 property, the last displayed column of the right pane of a split tree control can be defined as *open-ended*, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A *fixed-width* last column is defined with a specified width (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width)) and any data which doesn't fit is truncated.
The OpenEnded2 property defines the last column of the right pane of a split tree control. The OpenEnded2 property can only be used with a split tree control.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded property defines the last column (or the left pane of a split tree control) as open-ended.
See Also SftTreeColumns Object | Object Hierarchy
## OptimalWidth Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth*
Returns the column's optimal width based on its contents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**OptimalWidth** **As Single** |
| VB | *W* = *object*.**OptimalWidth** **As Single** |
| C#.NET | **float** *W* = *object*.**OptimalWidth**; |
| VC++ | **float** *W* = *object*->**OptimalWidth**;
**float** *W* = *object*->Get**OptimalWidth**(); |
| C | **HRESULT** *object*->get_**OptimalWidth**(**float*** *W*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
W
Returns the column's optimal width based on its contents. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The OptimalWidth property returns the column's optimal width based on its contents.
The OptimalWidth and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidthPix) properties are synonyms, but may use different coordinate systems.
This property calculates the optimal width of the column so that the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text and graphic can be completely displayed without being truncated or clipped. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) method can be used to set a column's optimal width without having to calculate it first.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control.
Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeColumn Object | Object Hierarchy
## OptimalWidth Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth*
Returns the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area's optimal width based on its contents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**OptimalWidth** **As Single** |
| VB | *W* = *object*.**OptimalWidth** **As Single** |
| C#.NET | **float** *W* = *object*.**OptimalWidth**; |
| VC++ | **float** *W* = *object*->**OptimalWidth**;
**float** *W* = *object*->Get**OptimalWidth**(); |
| C | **HRESULT** *object*->get_**OptimalWidth**(**float*** *W*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
W
Returns the row header area's optimal width based on its contents. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The OptimalWidth property returns the row header area's optimal width based on its contents.
The OptimalWidth and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidthPix) properties are synonyms, but may use different coordinate systems.
This method calculates the optimal width of the row header area so that the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text and graphic and the row header text and graphics can be completely displayed without being truncated or clipped. The row header width can be changed using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property. The RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) method can be used to set the optimal row header width without having to calculate it first.
By changing tree control properties, the optimal row header width may change. Adding items, setting new row header graphics and changing row header text are a few of the actions that can affect the optimal row header width. The row header width may have to be set again to allow items to be completely visible. The tree control does not automatically adjust the row header width.
Calculating the optimal row header width can be a time consuming operation, particularly if many items have been added to the tree control. OptimalWidth scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeRowHeaders Object | Object Hierarchy
## OptimalWidthPix Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidthPix*
Returns the column's optimal width based on its contents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**OptimalWidthPix** **As Integer** |
| VB | *WPix* = *object*.**OptimalWidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**OptimalWidthPix**; |
| VC++ | **long** *WPix* = *object*->**OptimalWidthPix**;
**long** *WPix* = *object*->Get**OptimalWidthPix**(); |
| C | **HRESULT** *object*->get_**OptimalWidthPix**(**long*** *WPix*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
WPix
Returns the column's optimal width based on its contents.
### Comments
The OptimalWidthPix property returns the column's optimal width based on its contents.
The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) and OptimalWidthPix properties are synonyms, but may use different coordinate systems.
This property calculates the optimal width of the column so that the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s and each [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text and graphic can be completely displayed without being truncated or clipped. The column width can be changed using the Column.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) property. The Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) method can be used to set a column's optimal width without having to calculate it first.
By changing tree control properties, the optimal column width may change. Adding items, setting new cell graphics and changing cell text are a few of the actions that can affect the optimal column width. The column width may have to be set again to allow items to be completely visible.
The tree control does not automatically adjust column widths.
Cells which merge into an adjacent column are not considered when calculating the optimal column width.
Calculating the optimal column width can be a time consuming operation, particularly if many items have been added to the tree control.
OptimalWidth scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeColumn Object | Object Hierarchy
## OptimalWidthPix Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidthPix*
Returns the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area's optimal width based on its contents.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**OptimalWidthPix** **As Integer** |
| VB | *WPix* = *object*.**OptimalWidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**OptimalWidthPix**; |
| VC++ | **long** *WPix* = *object*->**OptimalWidthPix**;
**long** *WPix* = *object*->Get**OptimalWidthPix**(); |
| C | **HRESULT** *object*->get_**OptimalWidthPix**(**long*** *WPix*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
WPix
Returns the row header area's optimal width in pixels based on its content.
### Comments
The OptimalWidthPix property returns the row header area's optimal width based on its contents.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) and OptimalWidthPix properties are synonyms, but may use different coordinate systems.
This method calculates the optimal width of the row header area so that the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text and graphic and the row header text and graphics can be completely displayed without being truncated or clipped. The row header width can be changed using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property. The RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) method can be used to set the optimal row header width without having to calculate it first.
By changing tree control properties, the optimal row header width may change. Adding items, setting new row header graphics and changing row header text are a few of the actions that can affect the optimal row header width. The row header width may have to be set again to allow items to be completely visible. The tree control does not automatically adjust the row header width.
Calculating the optimal row header width can be a time consuming operation, particularly if many items have been added to the tree control. OptimalWidth scans all items to determine the best column width, but can be limited to a specific number of items using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
If items are not visible because their parent items are [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems), these can be excluded from the optimal width calculation by setting the Items.[CalcVisibleOnly](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcVisibleOnly) property to True.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Order Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Order*
Defines the column order, usually used to save/load an existing column layout.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Order** **As String** |
| VB | *String* = *object*.**Order** **As String** |
| C#.NET | **string** *String* = *object*.**Order**; |
| VC++ | **_bstr_t** *String* = *object*->**Order**;
**_bstr_t** *String* = *object*->Get**Order**(); |
| C | **HRESULT** *object*->get_**Order**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Order** = *String* **As String** |
| VB | *object*.**Order** = *String* **As String** |
| C#.NET | **string** *object*.**Order** = *String*; |
| VC++ | **_bstr_t** *object*->**Order** = *String*;
**void** *object*->Put**Order**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Order**(**BSTR** *String*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
String
Defines the column order, usually used to save/load an existing column layout.
### Comments
The Order property defines the column order, usually used to save/load an existing column layout.
The property returns a comma-delimited list of [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) numbers in the order in which they are displayed.
The value returned by the Order property could be saved in the Windows Registry or a data file. By assigning the saved value to the Order property at a later time, the display order of the columns can be restored.
The [Widths](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Widths) property can be used to save/restore the widths of all columns.
See Also SftTreeColumns Object | Object Hierarchy
## OutlineStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle*
Defines the display style of the selection outline.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**OutlineStyle** **As [SftTreeOutlineStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants)** |
| VB | *Style* = *object*.**OutlineStyle** **As SftTreeOutlineStyleConstants** |
| C#.NET | **SftTreeOutlineStyleConstants** *Style* = *object*.**OutlineStyle**; |
| VC++ | **enum SftTreeOutlineStyleConstants** *Style* = *object*->**OutlineStyle**;
**enum SftTreeOutlineStyleConstants** *Style* = *object*->Get**OutlineStyle**(); |
| C | **HRESULT** *object*->get_**OutlineStyle**(**enum SftTreeOutlineStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OutlineStyle** = *Style* **As SftTreeOutlineStyleConstants** |
| VB | *object*.**OutlineStyle** = *Style* **As SftTreeOutlineStyleConstants** |
| C#.NET | **SftTreeOutlineStyleConstants** *object*.**OutlineStyle** = *Style*; |
| VC++ | **enum SftTreeOutlineStyleConstants** *object*->**OutlineStyle** = *Style*;
**void** *object*->Put**OutlineStyle**(**enum SftTreeOutlineStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**OutlineStyle**(**enum SftTreeOutlineStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the display style of the selection outline.
| Name | Value | Description |
| --- | --- | --- |
| OutlineStyleSftTreeRect | 0 | Rectangle - The selection display style, defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property is rendered using a rectangle. The colors used for the selection rectangle are based on the definitions for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections), [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns (see Items.SelectStyle). An item highlighted due to [flyby highlighting](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_flybyhiglighting) is rendered by underlining the cell text. A [drop target](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlight) is rendered using the color defined using Items.[DropHighlightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropHighlightColor). |
| OutlineStyleSftTreeRectGradient | 1 | Rectangle with borders and gradient fill - The selection display style, defined using the Items.SelectStyle property, is rendered using a rounded rectangle, with a gradient fill. The colors used for the selection outline are defined using the Items.[SelectOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectOutlineBorderColor), Items.[SelectInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerBorderColor), Items.[SelectInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill1), Items.[SelectInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill2) or Items.[SelectNoFocusOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusOutlineBorderColor), Items.[SelectNoFocusInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerBorderColor), Items.[SelectNoFocusInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill1), Items.[SelectNoFocusInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill2) properties. The selection outline of items highlighted due to flyby highlighting is rendered using the colors Items.[SelectHotOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotOutlineBorderColor), Items.[SelectHotInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerBorderColor), Items.[SelectHotInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill1) and Items.[SelectHotInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill2) or Items.[HotOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotOutlineBorderColor), Items.[HotInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerBorderColor), Items.[HotInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill1) and Items.[HotInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HotInnerFill2). The selection outline of items as drop targets is rendered using the colors Items.[DropTargetOutlineBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetOutlineBorderColor), Items.[DropTargetInnerBorderColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerBorderColor), Items.[DropTargetInnerFill1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill1) and Items.[DropTargetInnerFill2](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_DropTargetInnerFill2). |
### Comments
The OutlineStyle property defines the display style of the selection outline.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## OverheadWidth Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_OverheadWidth*
Returns the width of the area added to the first column for hierarchical graphics components.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**OverheadWidth** **As Single** |
| VB | *Width* = *object*.**OverheadWidth** **As Single** |
| C#.NET | **float** *Width* = *object*.**OverheadWidth**; |
| VC++ | **float** *Width* = *object*->**OverheadWidth**;
**float** *Width* = *object*->Get**OverheadWidth**(); |
| C | **HRESULT** *object*->get_**OverheadWidth**(**float*** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Width
Returns the width of the area added to the first column for hierarchical graphics components. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.OverheadWidth instead
The OverheadWidth property returns the width of the area added to the first column for hierarchical graphics components.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum value.
The OverheadWidth property returns the width of the area reserved for non-[cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) displays, such as label graphics, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons), tree lines and item graphics for all items. If more levels are added to a hierarchy, the OverheadWidth value increases.
See Also SftTree Object | Object Hierarchy
## OverheadWidth Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth*
Returns the width of the area added to the first column for hierarchical graphics components.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**OverheadWidth** **As Single** |
| VB | *Width* = *object*.**OverheadWidth** **As Single** |
| C#.NET | **float** *Width* = *object*.**OverheadWidth**; |
| VC++ | **float** *Width* = *object*->**OverheadWidth**;
**float** *Width* = *object*->Get**OverheadWidth**(); |
| C | **HRESULT** *object*->get_**OverheadWidth**(**float*** *Width*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
Width
Returns the width of the area added to the first column for hierarchical graphics components. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The OverheadWidth property returns the width of the area added to the first column for hierarchical graphics components.
The OverheadWidth and [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidthPix) properties are synonyms, but may use different coordinate systems.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum value.
The OverheadWidth property returns the width of the area reserved for non-[cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) displays, such as label graphics, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons), tree lines and item graphics for all items. If more levels are added to a hierarchy, the OverheadWidth value increases.
See Also SftTreeColumns Object | Object Hierarchy
## OverheadWidthPix Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidthPix*
Returns the width of the area added to the first column for hierarchical graphics components.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WidthPix* = *object*.**OverheadWidthPix** **As Integer** |
| VB | *WidthPix* = *object*.**OverheadWidthPix** **As Long** |
| C#.NET | **int** *WidthPix* = *object*.**OverheadWidthPix**; |
| VC++ | **long** *WidthPix* = *object*->**OverheadWidthPix**;
**long** *WidthPix* = *object*->Get**OverheadWidthPix**(); |
| C | **HRESULT** *object*->get_**OverheadWidthPix**(**long*** *WidthPix*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
WidthPix
Returns the width of the area added to the first column for hierarchical graphics components in pixels.
### Comments
The OverheadWidthPix property returns the width of the area added to the first column for hierarchical graphics components.
The [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) and OverheadWidthPix properties are synonyms, but may use different coordinate systems.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum value.
The OverheadWidthPix property returns the width of the area reserved for non-[cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) displays, such as label graphics, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons), tree lines and item graphics for all items. If more levels are added to a hierarchy, the OverheadWidthPix value increases.
See Also SftTreeColumns Object | Object Hierarchy
## OverrideTheme Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme*
Defines whether the [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| VB | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OverrideTheme**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OverrideTheme**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OverrideTheme**(); |
| C | **HRESULT** *object*->get_**OverrideTheme**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| VB | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OverrideTheme** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OverrideTheme** = *Boolean*;
**void** *object*->Put**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Boolean
Defines whether the column footer's color definitions override Windows themes.
| Boolean | Description |
| --- | --- |
| True | The column footer is rendered without Windows themes, if any of the properties [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor), Footer.[BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColorDisabled), Footer.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor), Footer.[ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColorDisabled), Footer.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectBackColor), Footer.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectForeColor) are defined. |
| False | The column footer is rendered with Windows themes (based on the [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) property). |
### Comments
The OverrideTheme property defines whether the column footer's color definitions override Windows themes.
See Also SftTreeFooter Object | Object Hierarchy
## OverrideTheme Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme*
Defines whether the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| VB | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OverrideTheme**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OverrideTheme**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OverrideTheme**(); |
| C | **HRESULT** *object*->get_**OverrideTheme**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| VB | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OverrideTheme** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OverrideTheme** = *Boolean*;
**void** *object*->Put**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Boolean
Defines whether the column header's color definitions override Windows themes.
| Boolean | Description |
| --- | --- |
| True | The column header is rendered without Windows themes, if any of the properties [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor), Header.[BackColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColorDisabled), Header.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor), Header.[ForeColorDisabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColorDisabled), Header.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectBackColor), Header.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectForeColor) are defined. |
| False | The column header is rendered with Windows themes (based on the [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) property). |
### Comments
The OverrideTheme property defines whether the column header's color definitions override Windows themes.
See Also SftTreeHeader Object | Object Hierarchy
## OverrideTheme Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_OverrideTheme*
Defines whether the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| VB | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OverrideTheme**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OverrideTheme**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OverrideTheme**(); |
| C | **HRESULT** *object*->get_**OverrideTheme**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| VB | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OverrideTheme** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OverrideTheme** = *Boolean*;
**void** *object*->Put**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Boolean
Defines whether the row/column footer's color definitions override Windows themes.
| Boolean | Description |
| --- | --- |
| True | The properties defining row/column footer colors override Windows themes and the row/column footer is rendered without Windows themes. |
| False | The row/column footer is rendered with Windows themes (based on the [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) property). |
### Comments
The OverrideTheme property defines whether the row/column footer's color definitions override Windows themes.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## OverrideTheme Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_OverrideTheme*
Defines whether the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| VB | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OverrideTheme**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OverrideTheme**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OverrideTheme**(); |
| C | **HRESULT** *object*->get_**OverrideTheme**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| VB | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OverrideTheme** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OverrideTheme** = *Boolean*;
**void** *object*->Put**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Boolean
Defines whether the row/column header's color definitions override Windows themes.
| Boolean | Description |
| --- | --- |
| True | The properties defining row/column header colors override Windows themes and the row/column header is rendered without Windows themes. |
| False | The row/column header is rendered with Windows themes (based on the [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) property). |
### Comments
The OverrideTheme property defines whether the row/column header's color definitions override Windows themes.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## OverrideTheme Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme*
Defines whether the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s color definitions override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| VB | *Boolean* = *object*.**OverrideTheme** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**OverrideTheme**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**OverrideTheme**;
**VARIANT_BOOL** *Boolean* = *object*->Get**OverrideTheme**(); |
| C | **HRESULT** *object*->get_**OverrideTheme**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| VB | *object*.**OverrideTheme** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**OverrideTheme** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**OverrideTheme** = *Boolean*;
**void** *object*->Put**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**OverrideTheme**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Boolean
Defines whether the row header's color definitions override Windows themes.
| Boolean | Description |
| --- | --- |
| True | The row header is rendered without Windows themes, if any of the properties [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor), RowHeader.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor), RowHeader.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor), RowHeader.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) are defined. |
| False | The row header is rendered with Windows themes (based on the [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) property). |
### Comments
The OverrideTheme property defines whether the row header's color definitions override Windows themes.
See Also SftTreeRowHeader Object | Object Hierarchy
## Parent Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Parent*
Returns the index of an item's parent item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Parent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Parent) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ParentIndex* = *object*.get_**Parent**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *ParentIndex* = *object*.**Parent**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *ParentIndex* = *object*.get_**Parent**(**int** *ItemIndex*); |
| VC++ | **long** *ParentIndex* = *object*->**Parent**[**long** *ItemIndex*];
**long** *ParentIndex* = *object*->Get**Parent**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**Parent**(**long** *ItemIndex*, **long*** *ParentIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose parent item is to be returned.
ParentIndex
Returns the index of the item's immediate parent item. If the item doesn't have a parent, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Parent instead
The Parent property returns the index of an item's parent item.
To find an item's top-most parent, use the Item.[TopParent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_TopParent) property instead.
**Visual Basic: ** The Parent property implemented by the tree control is hidden by Visual Basic's own Parent property. To access the tree control's property use the following construct:
```
parentIndex = Tree1.Object.Parent(9)
```
The "Object" keyword is implemented by Visual Basic to access to an object's properties directly. See the Visual Basic documentation for more information.
**.NET: ** Please note the use of **Ctl**get_**Parent**, instead of Parent. Please see "[Using SftTree/OCX with .NET](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)" for additional information.
See Also SftTree Object | Object Hierarchy
## Parent Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Parent*
Returns the item's parent item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**Parent** **As Integer** |
| VB | *ItemIndex* = *object*.**Parent** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**Parent**; |
| VC++ | **long** *ItemIndex* = *object*->**Parent**;
**long** *ItemIndex* = *object*->Get**Parent**(); |
| C | **HRESULT** *object*->get_**Parent**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's parent item. If the item doesn't have a parent, -1 is returned.
### Comments
The Parent property returns the item's parent item.
To find an item's top-most parent, use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[TopParent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_TopParent) property instead.
See Also SftTreeItem Object | Object Hierarchy
## Picture Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture*
Defines the image object using an OLE Picture object (IPictureDisp interface).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *pPictureDisp* = *object*.**Picture** **As stdole.IPictureDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *pPictureDisp* = *object*.**Picture** **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *pPictureDisp* = *object*.**Picture**; |
| VC++ | **IPictureDisp*** *pPictureDisp* = *object*->Get**Picture**(); |
| C | **HRESULT** *object*->get_**Picture**(**IPictureDisp**** *pPictureDisp*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**Picture**(**ByVal** *pPictureDisp* **As stdole.IPictureDisp**) |
| VB | *object*.**Picture** = *pPictureDisp* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**Picture**(**stdole.IPictureDisp** *pPictureDisp*); |
| VC++ | **void** *object*->Put**Picture**(**IPictureDisp*** *pPictureDisp*); |
| C | **HRESULT** *object*->put_**Picture**(**IPictureDisp*** *pPictureDisp*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**Picture** = *pPictureDisp* **As stdole.IPictureDisp** |
| VB | **Set** *object*.**Picture** = *pPictureDisp* **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *object*.**Picture** = *pPictureDisp*; |
| VC++ | **void** *object*->PutRef**Picture**(**IPictureDisp*** *pPictureDisp*); |
| C | **HRESULT** *object*->putref_**Picture**(**IPictureDisp*** *pPictureDisp*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
pPictureDisp
Defines the image object using an OLE Picture object (IPictureDisp interface). For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The Picture property defines the image object using an OLE Picture object (IPictureDisp interface).
Typically, .NET applications use the [NETImageObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_NETImageObject) property to define an image, C and C++ applications use [BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle) or Image, VB6 and other COM applications use the Picture property.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeIDispatch](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
See Also SftPictureObject Object | Object Hierarchy
## PictureH Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH*
Defines the image object as an OLE [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object (using a bitmap/icon handle).
> Deprecated - Provided for compatibility with earlier versions only - Use [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject).[BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle) or SftPictureObject.[IconHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IconHandle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**PictureH** **As Integer** |
| VB | *Handle* = *object*.**PictureH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**PictureH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**PictureH**;
**OLE_HANDLE** *Handle* = *object*->Get**PictureH**(); |
| C | **HRESULT** *object*->get_**PictureH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PictureH** = *Handle* **As Integer** |
| VB | *object*.**PictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**PictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**PictureH** = *Handle*;
**void** *object*->Put**PictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**PictureH**(**OLE_HANDLE** *Handle*); |
object
A SftPictureObject object.
Handle
Defines the image object as an OLE Picture object using a bitmap or icon handle. The handle can be NULL, in which case the SftPictureObject is cleared.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use SftPictureObject.BitmapHandle or SftPictureObject.IconHandle instead
The PictureH property defines the image object as an OLE Picture object (using a bitmap/icon handle).
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeIDispatch](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
See Also SftPictureObject Object | Object Hierarchy
## PixelScaling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PixelScaling*
Defines whether caller-supplied pixel dimensions are scaled to the current [DPI](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_dpi).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Mode* = *object*.**PixelScaling** **As [SftTreeScalingConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScalingConstants)** |
| VB | *Mode* = *object*.**PixelScaling** **As SftTreeScalingConstants** |
| C#.NET | **SftTreeScalingConstants** *Mode* = *object*.**PixelScaling**; |
| VC++ | **enum SftTreeScalingConstants** *Mode* = *object*->**PixelScaling**;
**enum SftTreeScalingConstants** *Mode* = *object*->Get**PixelScaling**(); |
| C | **HRESULT** *object*->get_**PixelScaling**(**enum SftTreeScalingConstants*** *Mode*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PixelScaling** = *Mode* **As SftTreeScalingConstants** |
| VB | *object*.**PixelScaling** = *Mode* **As SftTreeScalingConstants** |
| C#.NET | **SftTreeScalingConstants** *object*.**PixelScaling** = *Mode*; |
| VC++ | **enum SftTreeScalingConstants** *object*->**PixelScaling** = *Mode*;
**void** *object*->Put**PixelScaling**(**enum SftTreeScalingConstants** *Mode*); |
| C | **HRESULT** *object*->put_**PixelScaling**(**enum SftTreeScalingConstants** *Mode*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Mode
Defines whether caller-supplied pixel dimensions are scaled to the current DPI.
| Name | Value | Description |
| --- | --- | --- |
| scalingSftTreeAsIs | 0 | Use caller-supplied pixel values verbatim (the default). |
| scalingSftTreeStretch | 1 | Scale caller-supplied pixel values by the current DPI. |
### Comments
The PixelScaling property defines whether caller-supplied pixel dimensions are scaled to the current DPI.
This setting is independent of [ImageScaling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ImageScaling). Stored values and property getters remain in 96-DPI reference units.
See Also SftTree Object | Object Hierarchy | Per-Monitor DPI and Scaling
## PlusMinusImageExpandable Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable*
Defines the graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**PlusMinusImageExpandable** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**PlusMinusImageExpandable** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**PlusMinusImageExpandable**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**PlusMinusImageExpandable**;
**ISftPictureObject*** *refImageObj* = *object*->Get**PlusMinusImageExpandable**(); |
| C | **HRESULT** *object*->get_**PlusMinusImageExpandable**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusImageExpandable** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**PlusMinusImageExpandable** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**PlusMinusImageExpandable** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**PlusMinusImageExpandable** = *refImageObj*;
**void** *object*->Put**PlusMinusImageExpandable**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**PlusMinusImageExpandable**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the graphic used to display an expandable item's plus/minus graphic. Only bitmaps are supported ([GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) images, icons, metafiles, ImageLists, etc. are not supported).
### Comments
The PlusMinusImageExpandable property defines the graphic used to display an expandable item's plus/minus graphic.
All items which are expandable will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties PlusMinusImageExpandable and [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusImageExpandable property can be set to the value Nothing (NULL). Plus/minus graphics are then no longer displayed.
See Also SftTreeItems Object | Object Hierarchy
## PlusMinusImageExpanded Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded*
Defines the graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**PlusMinusImageExpanded** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**PlusMinusImageExpanded** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**PlusMinusImageExpanded**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**PlusMinusImageExpanded**;
**ISftPictureObject*** *refImageObj* = *object*->Get**PlusMinusImageExpanded**(); |
| C | **HRESULT** *object*->get_**PlusMinusImageExpanded**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusImageExpanded** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**PlusMinusImageExpanded** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**PlusMinusImageExpanded** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**PlusMinusImageExpanded** = *refImageObj*;
**void** *object*->Put**PlusMinusImageExpanded**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**PlusMinusImageExpanded**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the graphic used to display an expanded item's plus/minus graphic. Only bitmaps are supported ([GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) images, icons, metafiles, ImageLists, etc. are not supported).
### Comments
The PlusMinusImageExpanded property defines the graphic used to display an expanded item's plus/minus graphic.
All items which are expanded will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and PlusMinusImageExpanded define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusImageExpanded property can be set to the value Nothing (NULL). Plus/minus graphics are then no longer displayed.
See Also SftTreeItems Object | Object Hierarchy
## PlusMinusImageLeaf Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf*
Defines the graphic used to display a leaf item's plus/minus graphic.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refImageObj* = *object*.**PlusMinusImageLeaf** **As [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject)** |
| VB | **Set** *refImageObj* = *object*.**PlusMinusImageLeaf** **As SftPictureObject** |
| C#.NET | **SftPictureObject** *refImageObj* = *object*.**PlusMinusImageLeaf**; |
| VC++ | **ISftPictureObject*** *refImageObj* = *object*->**PlusMinusImageLeaf**;
**ISftPictureObject*** *refImageObj* = *object*->Get**PlusMinusImageLeaf**(); |
| C | **HRESULT** *object*->get_**PlusMinusImageLeaf**(**ISftPictureObject**** *refImageObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusImageLeaf** = *refImageObj* **As SftPictureObject** |
| VB | *object*.**PlusMinusImageLeaf** = *refImageObj* **As SftPictureObject** |
| C#.NET | **SftPictureObject** *object*.**PlusMinusImageLeaf** = *refImageObj*; |
| VC++ | **ISftPictureObject*** *object*->**PlusMinusImageLeaf** = *refImageObj*;
**void** *object*->Put**PlusMinusImageLeaf**(**ISftPictureObject*** *refImageObj*); |
| C | **HRESULT** *object*->put_**PlusMinusImageLeaf**(**ISftPictureObject*** *refImageObj*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
refImageObj
Defines the graphic used to display a leaf item's plus/minus graphic. Only bitmaps are supported ([GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) images, icons, metafiles, ImageLists, etc. are not supported).
### Comments
The PlusMinusImageLeaf property defines the graphic used to display a leaf item's plus/minus graphic.
The PlusMinusImageLeaf property is used to define the plus/minus graphic displayed for an item which doesn't have any dependents. All items which don't have any dependents will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and Items.[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The PlusMinusImageLeaf property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusImageLeaf property can be set to the value Nothing (NULL).
See Also SftTreeItems Object | Object Hierarchy
## PlusMinusPictureExpandable Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandable*
Defines the graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**PlusMinusPictureExpandable** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**PlusMinusPictureExpandable** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**PlusMinusPictureExpandable**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**PlusMinusPictureExpandable**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureExpandable**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**PlusMinusPictureExpandable**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**PlusMinusPictureExpandable** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**PlusMinusPictureExpandable**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**PlusMinusPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureExpandable** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**PlusMinusPictureExpandable** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**PlusMinusPictureExpandable** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**PlusMinusPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**PlusMinusPictureExpandable**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the graphic used to display an expandable item's plus/minus graphic. The *refPictureObj* object must represent a bitmap and cannot represent an icon or a metafile. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background color when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageExpandable instead
The PlusMinusPictureExpandable property defines the graphic used to display an expandable item's plus/minus graphic.
The PlusMinusPictureExpandable and [PlusMinusPictureExpandableH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandableH) properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
All items which are expandable will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.PlusMinusImageExpandable and Items.[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusPictureExpandable property can be set to the value Nothing (NULL). Plus/minus graphics are then no longer displayed.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## PlusMinusPictureExpandableH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandableH*
Defines the graphic used to display an [expandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**PlusMinusPictureExpandableH** **As Integer** |
| VB | *Handle* = *object*.**PlusMinusPictureExpandableH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**PlusMinusPictureExpandableH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**PlusMinusPictureExpandableH**;
**OLE_HANDLE** *Handle* = *object*->Get**PlusMinusPictureExpandableH**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureExpandableH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureExpandableH** = *Handle* **As Integer** |
| VB | *object*.**PlusMinusPictureExpandableH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**PlusMinusPictureExpandableH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**PlusMinusPictureExpandableH** = *Handle*;
**void** *object*->Put**PlusMinusPictureExpandableH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureExpandableH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the graphic used to display an expandable item's plus/minus graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageExpandable.PictureH instead
The PlusMinusPictureExpandableH property defines the graphic used to display an expandable item's plus/minus graphic.
The [PlusMinusPictureExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandable) and PlusMinusPictureExpandableH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
All items which are expandable will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.PlusMinusImageExpandable and Items.[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusPictureExpandableH property can be set to the value 0 (NULL). Plus/minus graphics are then no longer displayed.
See Also SftTree Object | Object Hierarchy
## PlusMinusPictureExpanded Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpanded*
Defines the graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**PlusMinusPictureExpanded** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**PlusMinusPictureExpanded** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**PlusMinusPictureExpanded**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**PlusMinusPictureExpanded**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureExpanded**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**PlusMinusPictureExpanded**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**PlusMinusPictureExpanded** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**PlusMinusPictureExpanded**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**PlusMinusPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureExpanded** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**PlusMinusPictureExpanded** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**PlusMinusPictureExpanded** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**PlusMinusPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**PlusMinusPictureExpanded**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the graphic used to display an expanded item's plus/minus graphic. The *refPictureObj* object must represent a bitmap and cannot represent an icon or a metafile. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background color when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageExpanded instead
The PlusMinusPictureExpanded property defines the graphic used to display an expanded item's plus/minus graphic.
The PlusMinusPictureExpanded and [PlusMinusPictureExpandedH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandedH) properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
All items which are expanded will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and PlusMinusImageExpanded define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusPictureExpanded property can be set to the value Nothing (NULL). Plus/minus graphics are then no longer displayed.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## PlusMinusPictureExpandedH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpandedH*
Defines the graphic used to display an [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**PlusMinusPictureExpandedH** **As Integer** |
| VB | *Handle* = *object*.**PlusMinusPictureExpandedH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**PlusMinusPictureExpandedH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**PlusMinusPictureExpandedH**;
**OLE_HANDLE** *Handle* = *object*->Get**PlusMinusPictureExpandedH**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureExpandedH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureExpandedH** = *Handle* **As Integer** |
| VB | *object*.**PlusMinusPictureExpandedH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**PlusMinusPictureExpandedH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**PlusMinusPictureExpandedH** = *Handle*;
**void** *object*->Put**PlusMinusPictureExpandedH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureExpandedH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the graphic used to display an expanded item's plus/minus graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageExpanded.PictureH instead
The PlusMinusPictureExpandedH property defines the graphic used to display an expanded item's plus/minus graphic.
The [PlusMinusPictureExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureExpanded) and PlusMinusPictureExpandedH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
All items which are expanded will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and Items.PlusMinusImageExpanded define valid graphics. The Items.[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusPictureExpandedH property can be set to the value 0 (NULL). Plus/minus graphics are then no longer displayed.
See Also SftTree Object | Object Hierarchy
## PlusMinusPictureLeaf Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeaf*
Defines the graphic used to display a leaf item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**PlusMinusPictureLeaf** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**PlusMinusPictureLeaf** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**PlusMinusPictureLeaf**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**PlusMinusPictureLeaf**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureLeaf**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**PlusMinusPictureLeaf**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**PlusMinusPictureLeaf** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**PlusMinusPictureLeaf**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**PlusMinusPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureLeaf** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**PlusMinusPictureLeaf** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**PlusMinusPictureLeaf** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**PlusMinusPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**PlusMinusPictureLeaf**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the graphic used to display a leaf item's plus/minus graphic. The *ref PictureObj* object must represent a bitmap and cannot represent an icon or a metafile. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background color when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageLeaf instead
The PlusMinusPictureLeaf property defines the graphic used to display a leaf item's plus/minus graphic.
The PlusMinusPictureLeaf and [PlusMinusPictureLeafH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeafH) properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The PlusMinusPictureLeaf property is used to define the plus/minus graphic displayed for an item which doesn't have any dependents. All items which don't have any dependents will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and Items.[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The PlusMinusImageLeaf property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusPictureLeaf property can be set to the value Nothing (NULL). Plus/minus graphics are then no longer displayed for leaf items.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## PlusMinusPictureLeafH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeafH*
Defines the graphic used to display a leaf item's plus/minus graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[PlusMinusImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageLeaf).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**PlusMinusPictureLeafH** **As Integer** |
| VB | *Handle* = *object*.**PlusMinusPictureLeafH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**PlusMinusPictureLeafH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**PlusMinusPictureLeafH**;
**OLE_HANDLE** *Handle* = *object*->Get**PlusMinusPictureLeafH**(); |
| C | **HRESULT** *object*->get_**PlusMinusPictureLeafH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**PlusMinusPictureLeafH** = *Handle* **As Integer** |
| VB | *object*.**PlusMinusPictureLeafH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**PlusMinusPictureLeafH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**PlusMinusPictureLeafH** = *Handle*;
**void** *object*->Put**PlusMinusPictureLeafH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**PlusMinusPictureLeafH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the graphic used to display a leaf item's plus/minus graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.PlusMinusImageLeaf.PictureH instead
The PlusMinusPictureLeafH property defines the graphic used to display a leaf item's plus/minus graphic.
The [PlusMinusPictureLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PlusMinusPictureLeaf) and PlusMinusPictureLeafH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The PlusMinusPictureLeafH property is used to define the plus/minus graphic displayed for an item which doesn't have any dependents. All items which don't have any dependents will be displayed with this plus/minus graphic. Individual items cannot override the plus/minus graphic.
Plus/minus graphics are not shown until the properties Items.[PlusMinusImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpandable) and Items.[PlusMinusImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_PlusMinusImageExpanded) define valid graphics. The Items.PlusMinusImageLeaf property is optional.
All graphics used in a tree control as Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as plus/minus graphics are never clipped vertically. To change the plus/minus graphic size, the plus/minus graphics properties Items.PlusMinusImageExpandable, Items.PlusMinusImageExpanded and Items.PlusMinusImageLeaf must be set to the value Nothing (NULL) before assigning new plus/minus graphics.
If an item is disabled (see [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the plus/minus graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
The PlusMinusImageLeafH property can be set to the value 0 (NULL). Plus/minus graphics are then no longer displayed for leaf items.
See Also SftTree Object | Object Hierarchy
## PostEdit Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit*
[Cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting) has ended.
> Deprecated - Provided for compatibility with earlier versions only - Use [EditEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_EditEnded) instead
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**PostEdit**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**PostEdit** |
| VB | **Private Sub** *object*_**PostEdit**(**ByVal** *Accepted* **As Boolean**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**PostEdit**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**PostEdit***object*(**VARIANT_BOOL** *Accepted*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**PostEdit***object*(**VARIANT_BOOL** *Accepted*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Accepted
Set to True if the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) event indicated that the new value is accepted (*Cancel* = False) or False if the user aborted cell editing using the ESCAPE key or by clicking outside of the control used for cell editing.
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use EditEnded instead
The PostEdit event occurs when cell editing has ended.
This event is generated if cell editing has ended normally (or after the application received an AfterEdit event and returned *Cancel* = False). In this case *Accepted* is True.* *If the user has aborted cell editing using the ESCAPE key or by clicking outside of the control used for cell editing, *Accepted* is False (an AfterEdit event was not generated).
The PostEdit event occurs once cell editing has completely ended. If the user is editing a cell and uses cell navigation to edit another cell or clicks on another cell for editing purposes, the PostEdit event does not occur.
The PostEdit event can be used to validate multiple interrelated cells after cell editing has been completed or to prevent a user from exiting cell editing prematurely. If a cell is incomplete or invalid, cell editing can be restarted using the [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) or [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) methods.
See Also SftTree Object | Object Hierarchy
## Pressed Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Pressed*
Defines the currently pressed [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**Pressed** **As Short** |
| VB | *ColIndex* = *object*.**Pressed** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**Pressed**; |
| VC++ | **short** *ColIndex* = *object*->**Pressed**;
**short** *ColIndex* = *object*->Get**Pressed**(); |
| C | **HRESULT** *object*->get_**Pressed**(**short*** *ColIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Pressed** = *ColIndex* **As Short** |
| VB | *object*.**Pressed** = *ColIndex* **As Integer** |
| C#.NET | **short** *object*.**Pressed** = *ColIndex*; |
| VC++ | **short** *object*->**Pressed** = *ColIndex*;
**void** *object*->Put**Pressed**(**short** *ColIndex*); |
| C | **HRESULT** *object*->put_**Pressed**(**short** *ColIndex*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
ColIndex
Defines the currently pressed column footer button. This can be -1 if no column footer button is pressed.
### Comments
The Pressed property defines the currently pressed column footer button.
Only one button can be pressed at a time. All buttons can be reset by specifying -1 as *ColIndex*.
The [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_RemainUp) property can be used to allow header buttons to automatically return to their "up" position, so the [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Pressed) property does not have to be used.
See Also SftTreeFooters Object | Object Hierarchy
## Pressed Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed*
Defines the currently pressed [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**Pressed** **As Short** |
| VB | *ColIndex* = *object*.**Pressed** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**Pressed**; |
| VC++ | **short** *ColIndex* = *object*->**Pressed**;
**short** *ColIndex* = *object*->Get**Pressed**(); |
| C | **HRESULT** *object*->get_**Pressed**(**short*** *ColIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Pressed** = *ColIndex* **As Short** |
| VB | *object*.**Pressed** = *ColIndex* **As Integer** |
| C#.NET | **short** *object*.**Pressed** = *ColIndex*; |
| VC++ | **short** *object*->**Pressed** = *ColIndex*;
**void** *object*->Put**Pressed**(**short** *ColIndex*); |
| C | **HRESULT** *object*->put_**Pressed**(**short** *ColIndex*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
ColIndex
Defines the currently pressed column header button. This can be -1 if no column header button is pressed.
### Comments
The Pressed property defines the currently pressed column header button.
Only one button can be pressed at a time. All buttons can be reset by specifying -1 as *ColIndex*.
The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp) property can be used to allow header buttons to automatically return to their "up" position, so the [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Pressed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Pressed) property does not have to be used.
See Also SftTreeHeaders Object | Object Hierarchy
## PrevShown Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevShown*
Returns the index of the previous [visible item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_visibilitystatus).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**PrevShown** **As Integer** |
| VB | *ItemIndex* = *object*.**PrevShown** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**PrevShown**; |
| VC++ | **long** *ItemIndex* = *object*->**PrevShown**;
**long** *ItemIndex* = *object*->Get**PrevShown**(); |
| C | **HRESULT** *object*->get_**PrevShown**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the index of the previous visible item. -1 is returned, if no item is found.
### Comments
The PrevShown property returns the index of the previous visible item.
Dependent items of a [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) parent item are skipped using this method.
Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[FirstShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_FirstShown), [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[NextShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextShown), Items.[LastShown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_LastShown) to retrieve information about item visibility.
See Also SftTreeItem Object | Object Hierarchy
## PrevSibling Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_PrevSibling*
Returns the index of an item's previous sibling item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[PrevSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *SiblingIndex* = *object*.get_**PrevSibling**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *SiblingIndex* = *object*.**PrevSibling**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *SiblingIndex* = *object*.get_**PrevSibling**(**int** *ItemIndex*); |
| VC++ | **long** *SiblingIndex* = *object*->**PrevSibling**[**long** *ItemIndex*];
**long** *SiblingIndex* = *object*->Get**PrevSibling**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**PrevSibling**(**long** *ItemIndex*, **long*** *SiblingIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose previous sibling item is to be returned.
SiblingIndex
Returns the index of the item's previous sibling item. -1 is returned if the item doesn't have a previous sibling.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.PrevSibling instead
The PrevSibling property returns the index of an item's previous sibling item.
The previous sibling of item *ItemIndex* is found by scanning towards the beginning of the tree control and locating an item on the same level (Item.[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as item *ItemIndex* without encountering a parent item.
The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) property can be used to retrieve an item's next sibling. The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) and Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) properties can be used to retrieve an item's first or last sibling.
See Also SftTree Object | Object Hierarchy
## PrevSibling Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_PrevSibling*
Returns the item's previous sibling.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**PrevSibling** **As Integer** |
| VB | *ItemIndex* = *object*.**PrevSibling** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**PrevSibling**; |
| VC++ | **long** *ItemIndex* = *object*->**PrevSibling**;
**long** *ItemIndex* = *object*->Get**PrevSibling**(); |
| C | **HRESULT** *object*->get_**PrevSibling**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the item's next sibling. -1 is returned if the item doesn't have a previous sibling.
### Comments
The PrevSibling property returns the item's previous sibling.
The previous sibling of the item is found by scanning towards the beginning of the tree control and locating an item on the same level ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Level) property) as the item without encountering a parent item.
The Item.[NextSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_NextSibling) property can be used to retrieve an item's next sibling. The Item.[FirstSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_FirstSibling) and Item.[LastSibling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_LastSibling) properties can be used to retrieve an item's first or last sibling.
See Also SftTreeItem Object | Object Hierarchy
## ProgressColor Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor*
Defines the [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ProgressColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ProgressColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ProgressColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ProgressColor**;
**OLE_COLOR** *Clr* = *object*->Get**ProgressColor**(); |
| C | **HRESULT** *object*->get_**ProgressColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColor** = *Clr* **As UInteger** |
| VB | *object*.**ProgressColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ProgressColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ProgressColor** = *Clr*;
**void** *object*->Put**ProgressColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ProgressColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the progress bar color used for this cell. -1 indicates that there is no defined color and the default defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColor) is used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ProgressColor property defines the progress bar color used for this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) property combined with ProgressColor can be used to define a gradient fill for the progress bar. The orientation of the gradient fill can be defined using the Cell.[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) property.
A progress bar is only shown for the cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeCell Object | Object Hierarchy
## ProgressColor Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColor*
Defines the default [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ProgressColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ProgressColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ProgressColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ProgressColor**;
**OLE_COLOR** *Clr* = *object*->Get**ProgressColor**(); |
| C | **HRESULT** *object*->get_**ProgressColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColor** = *Clr* **As UInteger** |
| VB | *object*.**ProgressColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ProgressColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ProgressColor** = *Clr*;
**void** *object*->Put**ProgressColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ProgressColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the default progress bar color used for cells in this column. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ProgressColor property defines the default progress bar color used for cells in this column.
Cells can override the default progress bar color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) property.
The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressStyle) property can be used to define the default progress bar appearance for cells in this column. The Column.[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorEnd) property combined with ProgressColor can be used to define a gradient fill for progress bars.
A progress bar is only shown for a cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeColumn Object | Object Hierarchy
## ProgressColorEnd Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd*
Defines the [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), combined with [ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ProgressColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ProgressColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ProgressColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ProgressColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**ProgressColorEnd**(); |
| C | **HRESULT** *object*->get_**ProgressColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**ProgressColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ProgressColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ProgressColorEnd** = *Clr*;
**void** *object*->Put**ProgressColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ProgressColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the progress bar color used for this cell, combined with ProgressColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ProgressColorEnd property defines the progress bar color used for this cell, combined with [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).ProgressColor creating a gradient fill.
The ProgressColorEnd property combined with Cell.ProgressColor can be used to define a gradient fill for the progress bar. The orientation of the gradient fill can be defined using the Cell.[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) property. If Cell.ProgressColor is not defined, ProgressColorEnd is ignored and has no effect.
A progress bar is only shown for the cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeCell Object | Object Hierarchy
## ProgressColorEnd Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorEnd*
Defines the default [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) color used for [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column, combined with [ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColor) creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ProgressColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ProgressColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ProgressColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ProgressColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**ProgressColorEnd**(); |
| C | **HRESULT** *object*->get_**ProgressColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**ProgressColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ProgressColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ProgressColorEnd** = *Clr*;
**void** *object*->Put**ProgressColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ProgressColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the default progress bar color used for cells in this column, combined with [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).ProgressColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ProgressColorEnd property defines the default progress bar color used for cells in this column, combined with Column.ProgressColor creating a gradient fill.
Cells can override the default progress bar color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) property.
The Column.[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressStyle) property can be used to define the default progress bar appearance for cells in this column. The ProgressColorEnd property combined with Column.ProgressColor can be used to define a gradient fill for progress bars.
A progress bar is only shown for a cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeColumn Object | Object Hierarchy
## ProgressColorOrientation Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation*
Defines the [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar)'s gradient fill orientation.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ProgressColorOrientation** **As [SftTreeOrientationDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationDefaultConstants)** |
| VB | *Style* = *object*.**ProgressColorOrientation** **As SftTreeOrientationDefaultConstants** |
| C#.NET | **SftTreeOrientationDefaultConstants** *Style* = *object*.**ProgressColorOrientation**; |
| VC++ | **enum SftTreeOrientationDefaultConstants** *Style* = *object*->**ProgressColorOrientation**;
**enum SftTreeOrientationDefaultConstants** *Style* = *object*->Get**ProgressColorOrientation**(); |
| C | **HRESULT** *object*->get_**ProgressColorOrientation**(**enum SftTreeOrientationDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColorOrientation** = *Style* **As SftTreeOrientationDefaultConstants** |
| VB | *object*.**ProgressColorOrientation** = *Style* **As SftTreeOrientationDefaultConstants** |
| C#.NET | **SftTreeOrientationDefaultConstants** *object*.**ProgressColorOrientation** = *Style*; |
| VC++ | **enum SftTreeOrientationDefaultConstants** *object*->**ProgressColorOrientation** = *Style*;
**void** *object*->Put**ProgressColorOrientation**(**enum SftTreeOrientationDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**ProgressColorOrientation**(**enum SftTreeOrientationDefaultConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the progress bar's gradient fill orientation.
| Name | Value | Description |
| --- | --- | --- |
| defaultOrientationSftTree | -1 | (Default) - The default orientation defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorOrientation) is used. |
| horizontalDefaultOrientationSftTree | 0 | Horizontal - The gradient fill orientation is horizontal, starting at the left using [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) and ending at the right edge of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using Cell.[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) (reversed when using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) rendering). |
| verticalDefaultOrientationSftTree | 1 | Vertical - The gradient fill orientation is vertical, starting at the top using Cell.ProgressColor and ending at the bottom using Cell.ProgressColorEnd. |
### Comments
The ProgressColorOrientation property defines the progress bar's gradient fill orientation.
A progress bar is only shown for the cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeCell Object | Object Hierarchy
## ProgressColorOrientation Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorOrientation*
Defines the default gradient fill orientation for [progress bars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ProgressColorOrientation** **As [SftTreeOrientationConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOrientationConstants)** |
| VB | *Style* = *object*.**ProgressColorOrientation** **As SftTreeOrientationConstants** |
| C#.NET | **SftTreeOrientationConstants** *Style* = *object*.**ProgressColorOrientation**; |
| VC++ | **enum SftTreeOrientationConstants** *Style* = *object*->**ProgressColorOrientation**;
**enum SftTreeOrientationConstants** *Style* = *object*->Get**ProgressColorOrientation**(); |
| C | **HRESULT** *object*->get_**ProgressColorOrientation**(**enum SftTreeOrientationConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressColorOrientation** = *Style* **As SftTreeOrientationConstants** |
| VB | *object*.**ProgressColorOrientation** = *Style* **As SftTreeOrientationConstants** |
| C#.NET | **SftTreeOrientationConstants** *object*.**ProgressColorOrientation** = *Style*; |
| VC++ | **enum SftTreeOrientationConstants** *object*->**ProgressColorOrientation** = *Style*;
**void** *object*->Put**ProgressColorOrientation**(**enum SftTreeOrientationConstants** *Style*); |
| C | **HRESULT** *object*->put_**ProgressColorOrientation**(**enum SftTreeOrientationConstants** *Style*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Style
Defines the default gradient fill orientation for progress bars in this column.
| Name | Value | Description |
| --- | --- | --- |
| horizontalOrientationSftTree | 0 | Horizontal - The gradient fill orientation is horizontal, starting at the left using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColor) and ending at the right edge of the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using Column.[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressColorEnd) (reversed when using [RightToLeft](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft) rendering). |
| verticalOrientationSftTree | 1 | Vertical - The gradient fill orientation is vertical, starting at the top using Column.ProgressColor and ending at the bottom using Column.ProgressColorEnd. |
### Comments
The ProgressColorOrientation property defines the default gradient fill orientation for progress bars in this column.
Cells can override the default gradient fill orientation for progress bars using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) property.
A progress bar is only shown for a cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeColumn Object | Object Hierarchy
## ProgressMax Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) maximum value (0 to turn off).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Value* = *object*.**ProgressMax** **As Integer** |
| VB | *Value* = *object*.**ProgressMax** **As Long** |
| C#.NET | **int** *Value* = *object*.**ProgressMax**; |
| VC++ | **long** *Value* = *object*->**ProgressMax**;
**long** *Value* = *object*->Get**ProgressMax**(); |
| C | **HRESULT** *object*->get_**ProgressMax**(**long*** *Value*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressMax** = *Value* **As Integer** |
| VB | *object*.**ProgressMax** = *Value* **As Long** |
| C#.NET | **int** *object*.**ProgressMax** = *Value*; |
| VC++ | **long** *object*->**ProgressMax** = *Value*;
**void** *object*->Put**ProgressMax**(**long** *Value*); |
| C | **HRESULT** *object*->put_**ProgressMax**(**long** *Value*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Value
Defines the cell's background progress bar maximum value. Must be greater or equal to 0 (0 to turn off).
### Comments
The ProgressMax property defines the cell's background progress bar maximum value (0 to turn off).
The progress bar is rendered as cell background, with the cell text and image displayed in the cell as usual. For a partial height progress bar, the cell background is also rendered using the defined background colors.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressValue](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressValue) property defines the current value (between 0 and ProgressMax, inclusive) of the progress bar and the progress bar is rendered proportionally to the size of the cell.
The progress bar for a cell is rendered using the colors defined with the Cell.[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) and Cell.[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) properties. The orientation of the gradient fill can be defined using the Cell.[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) property. The appearance of the progress bar can be defined with the Cell.[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressStyle) property.
A progress bar is only shown for the cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeCell Object | Object Hierarchy
## ProgressStyle Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressStyle*
Defines the [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar)'s appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ProgressStyle** **As [SftTreeProgressStyleDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeProgressStyleDefaultConstants)** |
| VB | *Style* = *object*.**ProgressStyle** **As SftTreeProgressStyleDefaultConstants** |
| C#.NET | **SftTreeProgressStyleDefaultConstants** *Style* = *object*.**ProgressStyle**; |
| VC++ | **enum SftTreeProgressStyleDefaultConstants** *Style* = *object*->**ProgressStyle**;
**enum SftTreeProgressStyleDefaultConstants** *Style* = *object*->Get**ProgressStyle**(); |
| C | **HRESULT** *object*->get_**ProgressStyle**(**enum SftTreeProgressStyleDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressStyle** = *Style* **As SftTreeProgressStyleDefaultConstants** |
| VB | *object*.**ProgressStyle** = *Style* **As SftTreeProgressStyleDefaultConstants** |
| C#.NET | **SftTreeProgressStyleDefaultConstants** *object*.**ProgressStyle** = *Style*; |
| VC++ | **enum SftTreeProgressStyleDefaultConstants** *object*->**ProgressStyle** = *Style*;
**void** *object*->Put**ProgressStyle**(**enum SftTreeProgressStyleDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**ProgressStyle**(**enum SftTreeProgressStyleDefaultConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the progress bar's appearance.
| Name | Value | Description |
| --- | --- | --- |
| defaultProgressStyleSftTree | -1 | The progress bar's appearance is defined using the default setting for this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s column (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressStyle)). |
| fullsizeDefaultProgressStyleSftTree | 0 | Full Size - The progress bar is rendered using the full height of a cell. |
| smallDefaultProgressStyleSftTree | 1 | Small - The progress bar is rendered vertically centered with a height of approximately 1/3 of the cell's height. |
### Comments
The ProgressStyle property defines the progress bar's appearance.
See Also SftTreeCell Object | Object Hierarchy
## ProgressStyle Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ProgressStyle*
Defines the default [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) appearance for [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ProgressStyle** **As [SftTreeProgressStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeProgressStyleConstants)** |
| VB | *Style* = *object*.**ProgressStyle** **As SftTreeProgressStyleConstants** |
| C#.NET | **SftTreeProgressStyleConstants** *Style* = *object*.**ProgressStyle**; |
| VC++ | **enum SftTreeProgressStyleConstants** *Style* = *object*->**ProgressStyle**;
**enum SftTreeProgressStyleConstants** *Style* = *object*->Get**ProgressStyle**(); |
| C | **HRESULT** *object*->get_**ProgressStyle**(**enum SftTreeProgressStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressStyle** = *Style* **As SftTreeProgressStyleConstants** |
| VB | *object*.**ProgressStyle** = *Style* **As SftTreeProgressStyleConstants** |
| C#.NET | **SftTreeProgressStyleConstants** *object*.**ProgressStyle** = *Style*; |
| VC++ | **enum SftTreeProgressStyleConstants** *object*->**ProgressStyle** = *Style*;
**void** *object*->Put**ProgressStyle**(**enum SftTreeProgressStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**ProgressStyle**(**enum SftTreeProgressStyleConstants** *Style*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Style
Defines the default progress bar appearance for cells in this column.
| Name | Value | Description |
| --- | --- | --- |
| fullsizeProgressStyleSftTree | 0 | Full Size - The progress bar is rendered using the full height of a cell. |
| smallProgressStyleSftTree | 1 | Small - The progress bar is rendered vertically centered with a height of approximately 1/3 of the cell's height. |
### Comments
The ProgressStyle property defines the default progress bar appearance for cells in this column.
Cells can override the progress bar appearance using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressStyle) property.
A progress bar is only shown for a cell if its Cell.[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax) property is set to a value other than 0.
See Also SftTreeColumn Object | Object Hierarchy
## ProgressValue Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressValue*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s [progress bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_progressbar) value.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Value* = *object*.**ProgressValue** **As Integer** |
| VB | *Value* = *object*.**ProgressValue** **As Long** |
| C#.NET | **int** *Value* = *object*.**ProgressValue**; |
| VC++ | **long** *Value* = *object*->**ProgressValue**;
**long** *Value* = *object*->Get**ProgressValue**(); |
| C | **HRESULT** *object*->get_**ProgressValue**(**long*** *Value*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ProgressValue** = *Value* **As Integer** |
| VB | *object*.**ProgressValue** = *Value* **As Long** |
| C#.NET | **int** *object*.**ProgressValue** = *Value*; |
| VC++ | **long** *object*->**ProgressValue** = *Value*;
**void** *object*->Put**ProgressValue**(**long** *Value*); |
| C | **HRESULT** *object*->put_**ProgressValue**(**long** *Value*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Value
Defines the cell's background progress bar value (between 0 and [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ProgressMax](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressMax), inclusive).
### Comments
The ProgressValue property defines the cell's background progress bar value.
The progress bar is rendered as cell background, with the cell text and image displayed in the cell as usual. For a partial height progress bar, the cell background is also rendered using the defined background colors.
The ProgressValue property defines the current value (between 0 and Cell.ProgressMax, inclusive) of the progress bar and the progress bar is rendered proportionally to the size of the cell.
The progress bar for a cell is rendered using the colors defined with the Cell.[ProgressColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColor) and Cell.[ProgressColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorEnd) properties. The orientation of the gradient fill can be defined using the Cell.[ProgressColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressColorOrientation) property. The appearance of the progress bar can be defined with the Cell.[ProgressStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ProgressStyle) property.
A progress bar is only shown for the cell if its Cell.ProgressMax property is set to a value other than 0.
See Also SftTreeCell Object | Object Hierarchy
## RealColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RealColumn*
Returns the [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) number given a display column number.
> Deprecated - Provided for compatibility with earlier versions only - Use [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[ColumnIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_ColumnIndex) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.get_**RealColumn**(**ByVal** *DispColIndex* **As Short**) **As Short** |
| VB | *ColIndex* = *object*.**RealColumn**(**ByVal** *DispColIndex* **As Integer**) **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.get_**RealColumn**(**short** *DispColIndex*); |
| VC++ | **short** *ColIndex* = *object*->**RealColumn**[**short** *DispColIndex*];
**short** *ColIndex* = *object*->Get**RealColumn**(**short** *DispColIndex*); |
| C | **HRESULT** *object*->get_**RealColumn**(**short** *DispColIndex*, **short*** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
DispColIndex
The display column number whose real column number is to be returned.
ColIndex
Returns the real column number given a display column number.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use ColumnsObj.ColumnIndex instead
The RealColumn property returns the real column number given a display column number.
As a user reorders columns, this is completely transparent to the application. An application still references [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.
If a user reorders columns using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop), the (display) column numbers, which is the column number as it appears to the user, may need to be translated into the real column number as used by an application.
The ColumnsObj.[Move](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Move) method can be used to reorder columns under program control.
See Also SftTree Object | Object Hierarchy
## RecalcHorizontalExtent Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RecalcHorizontalExtent*
Recalculates the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**RecalcHorizontalExtent**() |
| VB | *object*.**RecalcHorizontalExtent** |
| C#.NET | **void** *object*.**RecalcHorizontalExtent**(); |
| VC++ | **HRESULT** *object*->**RecalcHorizontalExtent**(); |
| C | **HRESULT** *object*->raw_**RecalcHorizontalExtent**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.RecalcHorizontalExtent instead
The RecalcHorizontalExtent method recalculates the optimal horizontal scrolling extent.
By default, a tree control does not handle horizontal scrolling, even if the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property defines scroll bars to be available. To start horizontal scrolling, an application has to use the RecalcHorizontalExtent method or the Items.[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent. Once the horizontal scrolling extent has been set, many tree control methods and properties may invalidate the horizontal extent. E.g., adding a new item may invalidate the extent, so it is best to delay using the RecalcHorizontalExtent method until after all items have been added, all properties have been set and the column widths have been defined.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The RecalcHorizontalExtent method has to be used again to recalculate the extent.
Based on the definition of the last column, different algorithms are used to calculate the optimal scrolling extent. Using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OpenEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) property, the last column can be defined as open-ended, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A fixed-width last column is defined with a specified width and any data which doesn't fit is truncated.
**Open-Ended Last Column**
Recalculating the best horizontal scrolling extent can be a costly operation (in terms of elapsed time). When updating a tree control, it is best to delay using the RecalcHorizontalExtent method as much as possible. It is best done after all items have been added, their levels have been set and all necessary graphics and tree control attributes have been defined, because most changes to the tree control can invalidate the optimal horizontal scrolling extent calculated.
When calculating the optimal scrolling extent, each item will be analyzed and its length calculated using the item's text and graphic components and its level. The widest item determines the horizontal scrolling extent.
Calculating the optimal horizontal extent can be a time consuming operation, particularly if many items have been added to the tree control. RecalcHorizontalExtent scans all items to determine the best column width, but can be limited to a specific number of items using the Items.[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
**Fixed-Width Last Column**
Recalculating the best horizontal scrolling extent is a very quick operation. The width of all columns and some initial overhead (based on the highest level number found) is calculated to determine the horizontal scrolling extent. No [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text is analyzed.
See Also SftTree Object | Object Hierarchy
## RecalcHorizontalExtent Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent*
Recalculates the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**RecalcHorizontalExtent**() |
| VB | *object*.**RecalcHorizontalExtent** |
| C#.NET | **void** *object*.**RecalcHorizontalExtent**(); |
| VC++ | **HRESULT** *object*->**RecalcHorizontalExtent**(); |
| C | **HRESULT** *object*->raw_**RecalcHorizontalExtent**(); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
### Comments
The RecalcHorizontalExtent method recalculates the optimal horizontal scrolling extent.
By default, a tree control does not handle horizontal scrolling, even if the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property defines scroll bars to be available. To start horizontal scrolling, an application has to use the RecalcHorizontalExtent method or the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. They indicate to the tree control that horizontal scrolling support is desired and allows it to determine the horizontal scrolling extent. Once the horizontal scrolling extent has been set, many tree control methods and properties may invalidate the horizontal extent. E.g., adding a new item may invalidate the extent, so it is best to delay using the RecalcHorizontalExtent method until after all items have been added, all properties have been set and the column widths have been defined.
The tree control doesn't automatically update the horizontal extent when items are added or deleted or other methods or properties are used, which may invalidate the horizontal extent. The RecalcHorizontalExtent method has to be used again to recalculate the extent.
Based on the definition of the last column, different algorithms are used to calculate the optimal scrolling extent. Using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[OpenEnded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) property, the last column can be defined as open-ended, which is the default if the application doesn't define any columns. An open-ended last column will display the complete text and graphics specified for the last (or only) column and never truncate any data. A fixed-width last column is defined with a specified width and any data which doesn't fit is truncated.
**Open-Ended Last Column**
Recalculating the best horizontal scrolling extent can be a costly operation (in terms of elapsed time). When updating a tree control, it is best to delay using the RecalcHorizontalExtent method as much as possible. It is best done after all items have been added, their levels have been set and all necessary graphics and tree control attributes have been defined, because most changes to the tree control can invalidate the optimal horizontal scrolling extent calculated.
When calculating the optimal scrolling extent, each item will be analyzed and its length calculated using the item's text and graphic components and its level. The widest item determines the horizontal scrolling extent.
Calculating the optimal horizontal extent can be a time consuming operation, particularly if many items have been added to the tree control. RecalcHorizontalExtent scans all items to determine the best column width, but can be limited to a specific number of items using the Items.[CalcLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_CalcLimit) property. This reduces the time spent to calculate the optimal width, but may still leave some items clipped.
**Fixed-Width Last Column**
Recalculating the best horizontal scrolling extent is a very quick operation. The width of all columns and some initial overhead (based on the highest level number found) is calculated to determine the horizontal scrolling extent. No [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text is analyzed.
See Also SftTreeItems Object | Object Hierarchy
## Refresh Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Refresh*
Forces an immediate repaint of the tree control.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Refresh**()
*object*.**CtlRefresh**() |
| VB | *object*.**Refresh** |
| C#.NET | **void** *object*.**Refresh**();
**void** *object*.**CtlRefresh**(); |
| VC++ | **HRESULT** *object*->**Refresh**(); |
| C | **HRESULT** *object*->raw_**Refresh**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The Refresh method forces an immediate repaint of the tree control.
Painting a control is handled automatically while no events are occurring. However, there may be situations where you want the control updated immediately. The Refresh method causes the control to be immediately repainted.
See Also SftTree Object | Object Hierarchy
## RemainUp Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_RemainUp*
Defines whether this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) button will return to its "up" position when pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RemainUp**(); |
| C | **HRESULT** *object*->get_**RemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RemainUp** = *Boolean*;
**void** *object*->Put**RemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Boolean
Defines whether this column footer button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The column footer button will return to its "up" position when pressed. |
| False | The column footer button remains pressed. |
### Comments
The RemainUp property defines whether this column footer button will return to its "up" position when pressed.
If column footers are not shown or column footers are shown as titles (see [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance) property), this property has no effect.
See Also SftTreeFooter Object | Object Hierarchy
## RemainUp Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_RemainUp*
Defines whether this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button will return to its "up" position when pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RemainUp**(); |
| C | **HRESULT** *object*->get_**RemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RemainUp** = *Boolean*;
**void** *object*->Put**RemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Boolean
Defines whether this column header button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The column header button will return to its "up" position when pressed. |
| False | The column header button remains pressed. |
### Comments
The RemainUp property defines whether this column header button will return to its "up" position when pressed.
If column headers are not shown or column headers are shown as titles (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property), this property has no effect.
See Also SftTreeHeader Object | Object Hierarchy
## RemainUp Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_RemainUp*
Defines whether the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) button will return to its "up" position when pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RemainUp**(); |
| C | **HRESULT** *object*->get_**RemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RemainUp** = *Boolean*;
**void** *object*->Put**RemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Boolean
Defines whether the row/column footer button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The row/column footer button automatically returns to its "up" position when clicked. |
| False | The row/column footer button remains in the "down" position when clicked. |
### Comments
The RemainUp property defines whether the row/column footer button will return to its "up" position when pressed.
The row/column footer is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column footers (see [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column footer button. The RemainUp property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column footer is drawn as a button if the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Appearance) property is set accordingly.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## RemainUp Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp*
Defines whether the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button will return to its "up" position when pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RemainUp**(); |
| C | **HRESULT** *object*->get_**RemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RemainUp** = *Boolean*;
**void** *object*->Put**RemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Boolean
Defines whether the row/column header button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The row/column header button automatically returns to its "up" position when clicked. |
| False | The row/column header button remains in the "down" position when clicked. |
### Comments
The RemainUp property defines whether the row/column header button will return to its "up" position when pressed.
The row/column header is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column headers (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column header button. The RemainUp property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column header is drawn as a button if the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set accordingly.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## RemainUp Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_RemainUp*
Defines whether [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) buttons will return to their "up" position when pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RemainUp**(); |
| C | **HRESULT** *object*->get_**RemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RemainUp** = *Boolean*;
**void** *object*->Put**RemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Boolean
Defines whether row header buttons will return to their "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The row header buttons automatically return to their "up" position when clicked. |
| False | The row header buttons remain in the "down" position when clicked. |
### Comments
The RemainUp property defines whether row header buttons will return to their "up" position when pressed.
Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The RemainUp property applies to all row headers and cannot be changed for individual items.
If row headers are not shown or row headers are shown as titles (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property), this property has no effect.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Remove Method, DataObjectFiles Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObjectFiles_Remove*
Removes a filename from the [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject).[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection ([sftCFFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants) format only).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Remove**(**ByVal** *ItemIndex* **As Object**) |
| VB | *object*.**Remove**(**ByVal** *ItemIndex* **As Variant**) |
| C#.NET | **void** *object*.**Remove**(**object** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**Remove**(**const _variant_t**&**** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**Remove**(**VARIANT** *ItemIndex*); |
object
A [DataObjectFiles](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObjectFiles) object.
ItemIndex
The one-based position of the file name to be removed as an Integer or the filename to be removed as a String.
### Comments
The Remove method removes a filename from the DataObject.Files collection (sftCFFiles format only).
To remove all the file names from the DataObject.Files collection, use the [Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear) method.
See Also DataObjectFiles Object | Object Hierarchy
## Remove Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove*
Removes an item.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Remove**(**ByVal** *ItemIndex* **As Integer**) |
| VB | *object*.**Remove**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*.**Remove**(**int** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**Remove**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**Remove**(**long** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item to remove.
### Comments
The Remove method removes an item.
If a parent item is deleted, dependents are deleted if the parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) (dependents are not visible). If the parent item is expanded when it is deleted, its dependents are not deleted. The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expanded) property can be used to determine if an item is expanded. The Item.[DeleteDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DeleteDependents) method can be used to delete an item's dependents.
If many items have to be deleted, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
See Also SftTreeItems Object | Object Hierarchy
## RemoveItem Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RemoveItem*
Removes an item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Remove](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Remove) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**RemoveItem**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *Count* = *object*.**RemoveItem**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *Count* = *object*.**RemoveItem**(**int** *ItemIndex*); |
| VC++ | **long** *Count* = *object*->**RemoveItem**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**RemoveItem**(**long** *ItemIndex*, **long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item to remove.
Count
Returns the number of items remaining in the tree control after the specified item is deleted.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.Remove instead
The RemoveItem method removes an item.
If a parent item is deleted, dependents are deleted if the parent item is [collapsed](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) (dependents are not visible). If the parent item is expanded when it is deleted, its dependents are not deleted. The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Expanded) property can be used to determine if an item is expanded. The Item.[DeleteDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DeleteDependents) method can be used to delete an item's dependents.
If many items have to be deleted, the [BulkUpdate](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BulkUpdate) property can be used to indicate a mass-update, which is significantly faster.
See Also SftTree Object | Object Hierarchy
## Reorderable Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Reorderable*
Defines whether columns can be reordered using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Reorderable** **As Boolean** |
| VB | *Boolean* = *object*.**Reorderable** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Reorderable**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Reorderable**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Reorderable**(); |
| C | **HRESULT** *object*->get_**Reorderable**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Reorderable** = *Boolean* **As Boolean** |
| VB | *object*.**Reorderable** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Reorderable** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Reorderable** = *Boolean*;
**void** *object*->Put**Reorderable**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Reorderable**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Boolean
Defines whether columns can be reordered using column drag & drop.
| Boolean | Description |
| --- | --- |
| True | [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can be reordered by the user. |
| False | Columns cannot be reordered by the user. |
### Comments
The Reorderable property defines whether columns can be reordered using column drag & drop.
Even if column reordering has been enabled using the Reorderable property, individual columns can be prevented from being reordered by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[KeepPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_KeepPosition) property.
See Also SftTreeHeaders Object | Object Hierarchy
## ReorderColumns Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ReorderColumns*
Defines whether columns can be reordered using [column drag & drop](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columndragdrop).
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Reorderable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Reorderable) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ReorderColumns** **As Boolean** |
| VB | *Boolean* = *object*.**ReorderColumns** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ReorderColumns**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ReorderColumns**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ReorderColumns**(); |
| C | **HRESULT** *object*->get_**ReorderColumns**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ReorderColumns** = *Boolean* **As Boolean** |
| VB | *object*.**ReorderColumns** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ReorderColumns** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ReorderColumns** = *Boolean*;
**void** *object*->Put**ReorderColumns**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ReorderColumns**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether columns can be reordered using column drag & drop.
| Boolean | Description |
| --- | --- |
| True | [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can be reordered by the user. |
| False | Columns cannot be reordered by the user. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Reorderable instead
The ReorderColumns property defines whether columns can be reordered using column drag & drop.
Even if column reordering has been enabled using the ReorderColumns property, individual columns can be prevented from being reordered by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[KeepPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_KeepPosition) property.
See Also SftTree Object | Object Hierarchy
## Resizable Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Resizable*
Defines whether [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) can be resized by the user.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Resizable** **As [SftTreeResizeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeResizeConstants)** |
| VB | *Style* = *object*.**Resizable** **As SftTreeResizeConstants** |
| C#.NET | **SftTreeResizeConstants** *Style* = *object*.**Resizable**; |
| VC++ | **enum SftTreeResizeConstants** *Style* = *object*->**Resizable**;
**enum SftTreeResizeConstants** *Style* = *object*->Get**Resizable**(); |
| C | **HRESULT** *object*->get_**Resizable**(**enum SftTreeResizeConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Resizable** = *Style* **As SftTreeResizeConstants** |
| VB | *object*.**Resizable** = *Style* **As SftTreeResizeConstants** |
| C#.NET | **SftTreeResizeConstants** *object*.**Resizable** = *Style*; |
| VC++ | **enum SftTreeResizeConstants** *object*->**Resizable** = *Style*;
**void** *object*->Put**Resizable**(**enum SftTreeResizeConstants** *Style*); |
| C | **HRESULT** *object*->put_**Resizable**(**enum SftTreeResizeConstants** *Style*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Style
Defines whether column footers can be resized by the user.
| Boolean | Description |
| --- | --- |
| True | Column footers can be resized by the user. |
| False | Column footers cannot be resized by the user. |
### Comments
The Resizable property defines whether column footers can be resized by the user.
Individual columns can be locked in size by using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Locked) property.
See Also SftTreeFooters Object | Object Hierarchy
## Resizable Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable*
Defines whether [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) can be resized by the user.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Resizable** **As [SftTreeResizeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeResizeConstants)** |
| VB | *Style* = *object*.**Resizable** **As SftTreeResizeConstants** |
| C#.NET | **SftTreeResizeConstants** *Style* = *object*.**Resizable**; |
| VC++ | **enum SftTreeResizeConstants** *Style* = *object*->**Resizable**;
**enum SftTreeResizeConstants** *Style* = *object*->Get**Resizable**(); |
| C | **HRESULT** *object*->get_**Resizable**(**enum SftTreeResizeConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Resizable** = *Style* **As SftTreeResizeConstants** |
| VB | *object*.**Resizable** = *Style* **As SftTreeResizeConstants** |
| C#.NET | **SftTreeResizeConstants** *object*.**Resizable** = *Style*; |
| VC++ | **enum SftTreeResizeConstants** *object*->**Resizable** = *Style*;
**void** *object*->Put**Resizable**(**enum SftTreeResizeConstants** *Style*); |
| C | **HRESULT** *object*->put_**Resizable**(**enum SftTreeResizeConstants** *Style*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Style
Defines whether column headers can be resized by the user.
| Boolean | Description |
| --- | --- |
| True | Column headers can be resized by the user. |
| False | Column headers cannot be resized by the user. |
### Comments
The Resizable property defines whether column headers can be resized by the user.
Individual columns can be locked in size by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked) property.
See Also SftTreeHeaders Object | Object Hierarchy
## ResizeColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ResizeColumn*
Returns the column number currently being resized.
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ResizeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ResizeColumn) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ResizeColumn** **As Short** |
| VB | *ColIndex* = *object*.**ResizeColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**ResizeColumn**; |
| VC++ | **short** *ColIndex* = *object*->**ResizeColumn**;
**short** *ColIndex* = *object*->Get**ResizeColumn**(); |
| C | **HRESULT** *object*->get_**ResizeColumn**(**short*** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ColIndex
Returns the zero-based column number currently being resized. -1 is returned if the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) is repositioned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.ResizeColumn instead
The ResizeColumn property returns the column number currently being resized.
This property is only valid while a [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) or [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) event occurs.
See Also SftTree Object | Object Hierarchy
## ResizeColumn Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ResizeColumn*
Returns the column number currently being resized.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ResizeColumn** **As Short** |
| VB | *ColIndex* = *object*.**ResizeColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**ResizeColumn**; |
| VC++ | **short** *ColIndex* = *object*->**ResizeColumn**;
**short** *ColIndex* = *object*->Get**ResizeColumn**(); |
| C | **HRESULT** *object*->get_**ResizeColumn**(**short*** *ColIndex*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
ColIndex
Returns the column number currently being resized. -1 is returned if the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) is repositioned.
### Comments
The ResizeColumn property returns the column number currently being resized.
This property is only valid while a [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) or [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) event occurs.
See Also SftTreeFooters Object | Object Hierarchy
## ResizeColumn Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ResizeColumn*
Returns the column number currently being resized.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**ResizeColumn** **As Short** |
| VB | *ColIndex* = *object*.**ResizeColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**ResizeColumn**; |
| VC++ | **short** *ColIndex* = *object*->**ResizeColumn**;
**short** *ColIndex* = *object*->Get**ResizeColumn**(); |
| C | **HRESULT** *object*->get_**ResizeColumn**(**short*** *ColIndex*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
ColIndex
Returns the column number currently being resized. -1 is returned if the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) is repositioned.
### Comments
The ResizeColumn property returns the column number currently being resized.
This property is only valid while a [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) or [ColumnSizeStarted](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSizeStarted) event occurs.
See Also SftTreeHeaders Object | Object Hierarchy
## ResizeHeader Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ResizeHeader*
Defines whether [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) can be resized by the user.
> Deprecated - Provided for compatibility with earlier versions only - Use [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Resizable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Resizable) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ResizeHeader** **As Boolean** |
| VB | *Boolean* = *object*.**ResizeHeader** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ResizeHeader**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ResizeHeader**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ResizeHeader**(); |
| C | **HRESULT** *object*->get_**ResizeHeader**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ResizeHeader** = *Boolean* **As Boolean** |
| VB | *object*.**ResizeHeader** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ResizeHeader** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ResizeHeader** = *Boolean*;
**void** *object*->Put**ResizeHeader**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ResizeHeader**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether column headers can be resized by the user.
| Boolean | Description |
| --- | --- |
| True | Column headers can be resized by the user. |
| False | Column headers cannot be resized by the user. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Headers.Resizable instead
The ResizeHeader property defines whether column headers can be resized by the user.
Individual columns can be locked in size by using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[Locked](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Locked) property.
See Also SftTree Object | Object Hierarchy
## ResizeMode Method, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_ResizeMode*
Allows the user to resize the panes of a [split tree control](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) using the keyboard.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**ResizeMode**() |
| VB | *object*.**ResizeMode** |
| C#.NET | **void** *object*.**ResizeMode**(); |
| VC++ | **HRESULT** *object*->**ResizeMode**(); |
| C | **HRESULT** *object*->raw_**ResizeMode**(); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
### Comments
The ResizeMode method allows the user to resize the panes of a split tree control using the keyboard.
The splitter bar of a split tree control can always be resized by dragging the splitter bar using the mouse. If an application wants to provide a [keyboard interface](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_keyboardinterface), a menu option could be implemented which invokes ResizeMode.
Once the ResizeMode method is called, the panes of a split tree control can be resized using the left and right arrow keys. When the user presses the ESCAPE key or moves the mouse cursor away from the splitter bar, the resizing operation ends. While the user resizes the panes, the [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) event occurs.
See Also SftTreeSplitter Object | Object Hierarchy
## RightToLeft Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightToLeft*
Defines the display direction and visual appearance on a [bi-directional](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rtl) system.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RightToLeft** **As Boolean**
*Boolean* = *object*.**CtlRightToLeft** **As Boolean** |
| VB | *Boolean* = *object*.**RightToLeft** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RightToLeft**;
**bool** *Boolean* = *object*.**CtlRightToLeft**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RightToLeft**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RightToLeft**(); |
| C | **HRESULT** *object*->get_**RightToLeft**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RightToLeft** = *Boolean* **As Boolean**
*object*.**CtlRightToLeft** = *Boolean* **As Boolean** |
| VB | *object*.**RightToLeft** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RightToLeft** = *Boolean*;
**bool** *object*.**CtlRightToLeft** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RightToLeft** = *Boolean*;
**void** *object*->Put**RightToLeft**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RightToLeft**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines the display direction and visual appearance on a bi-directional system.
| Boolean | Description |
| --- | --- |
| True | The control is used on a bi-directional platform (such as Arabic or Hebrew Windows) and the display direction is right-to-left. |
| False | The display direction is left-to-right. |
### Comments
The RightToLeft property defines the display direction and visual appearance on a bi-directional system.
If the RightToLeft property is set to True and the control is running on a bi-directional platform (such as Arabic Windows or Hebrew Windows), the tree control will support right-to-left reading with the tree hierarchy displayed on the right hand side of the control and the vertical scroll bar displayed on the left side.
The RightToLeft property automatically resets to False if the current system does not support right-to-left representation (i.e., the current platform is not an Arabic or Hebrew Windows version).
Applications that need to support both Left-To-Right and Right-To-Left environments have to update all orientation-specific properties at run-time.
> This property is read/only at run-time.
See Also SftTree Object | Object Hierarchy
## RightWindow Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RightWindow*
Returns the window handle of the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[RightWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_RightWindow) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**RightWindow** **As Integer** |
| VB | *Handle* = *object*.**RightWindow** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**RightWindow**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**RightWindow**;
**OLE_HANDLE** *Handle* = *object*->Get**RightWindow**(); |
| C | **HRESULT** *object*->get_**RightWindow**(**OLE_HANDLE*** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
Returns the window handle of the right pane in a split tree control.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.RightWindow instead
The RightWindow property returns the window handle of the right pane in a split tree control.
The RightWindow property should not be used and may cause incompatibilities with future releases of SftTree/OCX.
The Splitter.[LeftWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_LeftWindow) property returns the window handle of the left pane in a split tree control.
See Also SftTree Object | Object Hierarchy
## RightWindow Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_RightWindow*
Returns the window handle of the [right pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**RightWindow** **As Integer** |
| VB | *Handle* = *object*.**RightWindow** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**RightWindow**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**RightWindow**;
**OLE_HANDLE** *Handle* = *object*->Get**RightWindow**(); |
| C | **HRESULT** *object*->get_**RightWindow**(**OLE_HANDLE*** *Handle*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Handle
Returns the window handle of the right pane in a split tree control.
### Comments
The RightWindow property returns the window handle of the right pane in a split tree control.
The RightWindow property should not be used and may cause incompatibilities with future releases of SftTree/OCX.
The [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[LeftWindow](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_LeftWindow) property returns the window handle of the left pane in a split tree control.
See Also SftTreeSplitter Object | Object Hierarchy
## RowBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowBackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw the item when it is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**RowBackColor**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowBackColor**(**ByVal** *ItemIndex* **As Long**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**RowBackColor**(**int** *ItemIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowBackColor**[**long** *ItemIndex*];
**OLE_COLOR** *Clr* = *object*->Get**RowBackColor**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowBackColor**(**long** *ItemIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**RowBackColor**(**ByVal** *ItemIndex* **As Long**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**RowBackColor**(**int** *ItemIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**RowBackColor**[**long** *ItemIndex*] = *Clr*;
**void** *object*->Put**RowBackColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowBackColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Clr
Defines the row header background color used to draw the item when it is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.BackColor instead
The RowBackColor property defines the row header background color used to draw the item when it is not selected.
The row header described by *ItemI**ndex* has the background color attribute *Clr*. This color is used as background color when the item is not selected. If the item is selected, the RowHeader.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) property is used instead.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowBackColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowBackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw the item when it is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowBackColor** = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**RowBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**RowBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowBackColor** = *Clr*;
**void** *object*->Put**RowBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowBackColor**(**OLE_COLOR** *Clr*); |
object
A [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem) object.
Clr
Defines the row header background color used to draw the item when it is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.BackColor instead
The RowBackColor property defines the row header background color used to draw the item when it is not selected.
The VirtualItem.RowBackColor property is used while handling a VirtualItem event to define the item's background color. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowColButtonDown Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColButtonDown*
Defines whether the row/column button is currently down (pressed).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ButtonDown) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RowColButtonDown** **As Boolean** |
| VB | *Boolean* = *object*.**RowColButtonDown** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RowColButtonDown**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RowColButtonDown**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RowColButtonDown**(); |
| C | **HRESULT** *object*->get_**RowColButtonDown**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColButtonDown** = *Boolean* **As Boolean** |
| VB | *object*.**RowColButtonDown** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RowColButtonDown** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RowColButtonDown** = *Boolean*;
**void** *object*->Put**RowColButtonDown**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RowColButtonDown**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the row/column button is currently down (pressed).
| Boolean | Description |
| --- | --- |
| True | The row/column button is pressed. |
| False | The row/column button is not pressed. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.ButtonDown instead
The RowColButtonDown property defines whether the row/column button is currently down (pressed).
The row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column headers (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column header button. The RowColumnHeader.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column header is drawn as a button if the RowColumnHeader.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set accordingly.
See Also SftTree Object | Object Hierarchy
## RowColButtonRemainUp Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColButtonRemainUp*
Defines whether the row/column button will return to its "up" position when pressed.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RowColButtonRemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RowColButtonRemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RowColButtonRemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RowColButtonRemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RowColButtonRemainUp**(); |
| C | **HRESULT** *object*->get_**RowColButtonRemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColButtonRemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RowColButtonRemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RowColButtonRemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RowColButtonRemainUp** = *Boolean*;
**void** *object*->Put**RowColButtonRemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RowColButtonRemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the row/column button will return to its "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) button automatically returns to its "up" position when clicked. |
| False | The row/column header button remains in the "down" position when clicked. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.RemainUp instead
The RowColButtonRemainUp property defines whether the row/column button will return to its "up" position when pressed.
The row/column header is only available if both [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property) and column headers (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) property) are shown.
The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event is generated when the user clicks on the row/column header button. The RowColumnHeader.RemainUp property can be used to define the button to automatically return to its "up" position after being pressed.
The row/column header is drawn as a button if the RowColumnHeader.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set accordingly.
See Also SftTree Object | Object Hierarchy
## RowColHeaderAppearance Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderAppearance*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s appearance.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**RowColHeaderAppearance** **As [SftTreeHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**RowColHeaderAppearance** **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *Style* = *object*.**RowColHeaderAppearance**; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *Style* = *object*->**RowColHeaderAppearance**;
**enum SftTreeHeaderAppearanceConstants** *Style* = *object*->Get**RowColHeaderAppearance**(); |
| C | **HRESULT** *object*->get_**RowColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderAppearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| VB | *object*.**RowColHeaderAppearance** = *Style* **As SftTreeHeaderAppearanceConstants** |
| C#.NET | **SftTreeHeaderAppearanceConstants** *object*.**RowColHeaderAppearance** = *Style*; |
| VC++ | **enum SftTreeHeaderAppearanceConstants** *object*->**RowColHeaderAppearance** = *Style*;
**void** *object*->Put**RowColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**RowColHeaderAppearance**(**enum SftTreeHeaderAppearanceConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the row/column header's appearance.
| Style | Value | Description |
| --- | --- | --- |
| headerSftTreeNone | 0 | The row/column header, column headers and [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) are not displayed. The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Appearance) and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) properties are set to headerSftTreeNone and [rowheaderSftTreeNone](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants). |
| headerSftTreeButton | 1 | Displays the row/column header as a button. The row/column header is displayed as a button, which can be clicked by the user. The status of the row/column header button can be controlled using the RowColumnHeader.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled) and RowColumnHeader.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_RemainUp) properties. The current button status can be defined using the RowColumnHeader.[ButtonDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ButtonDown) property. |
| headerSftTreeText | 2 | Displays the row/column header as a title. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.Appearance instead
The RowColHeaderAppearance property defines the row/column header's appearance.
The width of the row/column header (and row header area) is defined using the RowHeaders.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) property.
See Also SftTree Object | Object Hierarchy
## RowColHeaderBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderBackColor*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s background color.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowColHeaderBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowColHeaderBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowColHeaderBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowColHeaderBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowColHeaderBackColor**(); |
| C | **HRESULT** *object*->get_**RowColHeaderBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowColHeaderBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowColHeaderBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowColHeaderBackColor** = *Clr*;
**void** *object*->Put**RowColHeaderBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowColHeaderBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the row/column header's background color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.BackColor instead
The RowColHeaderBackColor property defines the row/column header's background color.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowColHeaderEnabled Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderEnabled*
Defines whether the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) is enabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Enabled) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RowColHeaderEnabled** **As Boolean** |
| VB | *Boolean* = *object*.**RowColHeaderEnabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RowColHeaderEnabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RowColHeaderEnabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RowColHeaderEnabled**(); |
| C | **HRESULT** *object*->get_**RowColHeaderEnabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderEnabled** = *Boolean* **As Boolean** |
| VB | *object*.**RowColHeaderEnabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RowColHeaderEnabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RowColHeaderEnabled** = *Boolean*;
**void** *object*->Put**RowColHeaderEnabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RowColHeaderEnabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the row/column header is enabled.
| Boolean | Description |
| --- | --- |
| True | The row/column header is enabled. |
| False | The row/column header is disabled. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.Enabled instead
The RowColHeaderEnabled property defines whether the row/column header is enabled.
A disabled row/column header is drawn using the RowColumnHeader.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor) property value as text color and the row/column header graphic (see RowColumnHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) property) is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
A disabled row/column header button does not generate [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events.
See Also SftTree Object | Object Hierarchy
## RowColHeaderForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderForeColor*
Defines the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text color.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowColHeaderForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowColHeaderForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowColHeaderForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowColHeaderForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowColHeaderForeColor**(); |
| C | **HRESULT** *object*->get_**RowColHeaderForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowColHeaderForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowColHeaderForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowColHeaderForeColor** = *Clr*;
**void** *object*->Put**RowColHeaderForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowColHeaderForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the row/column header's text color. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.ForeColor instead
The RowColHeaderForeColor property defines the row/column header's text color.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowColHeaderGrayedColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderGrayedColor*
Defines the text color used to draw a disabled row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_GrayedColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowColHeaderGrayedColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowColHeaderGrayedColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowColHeaderGrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowColHeaderGrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowColHeaderGrayedColor**(); |
| C | **HRESULT** *object*->get_**RowColHeaderGrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderGrayedColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowColHeaderGrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowColHeaderGrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowColHeaderGrayedColor** = *Clr*;
**void** *object*->Put**RowColHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowColHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw a disabled row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.GrayedColor instead
The RowColHeaderGrayedColor property defines the text color used to draw a disabled row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowColHeaderHilightColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderHilightColor*
Defines the color used to draw the highlighted edge of the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_HilightColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowColHeaderHilightColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowColHeaderHilightColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowColHeaderHilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowColHeaderHilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowColHeaderHilightColor**(); |
| C | **HRESULT** *object*->get_**RowColHeaderHilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderHilightColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowColHeaderHilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowColHeaderHilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowColHeaderHilightColor** = *Clr*;
**void** *object*->Put**RowColHeaderHilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowColHeaderHilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the highlighted edge of the row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.HilightColor instead
The RowColHeaderHilightColor property defines the color used to draw the highlighted edge of the row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowColHeaderShadowColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColHeaderShadowColor*
Defines the color used to draw the dark edge of the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ShadowColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowColHeaderShadowColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowColHeaderShadowColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowColHeaderShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowColHeaderShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowColHeaderShadowColor**(); |
| C | **HRESULT** *object*->get_**RowColHeaderShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColHeaderShadowColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowColHeaderShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowColHeaderShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowColHeaderShadowColor** = *Clr*;
**void** *object*->Put**RowColHeaderShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowColHeaderShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the dark edge of the row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.ShadowColor instead
The RowColHeaderShadowColor property defines the color used to draw the dark edge of the row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowColPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPicture*
Defines the graphic displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**RowColPicture** **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**RowColPicture** **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.**RowColPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**RowColPicture**(); |
| C | **HRESULT** *object*->get_**RowColPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**RowColPicture**(**ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**RowColPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**RowColPicture**(**System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**RowColPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**RowColPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**RowColPicture** = *refPictureObj* **As System.Drawing.Image** |
| VB | **Set** *object*.**RowColPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *object*.**RowColPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**RowColPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**RowColPicture**(**IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refPictureObj
Defines the graphic displayed in the row/column header. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.Image.Picture instead
The RowColPicture property defines the graphic displayed in the row/column header.
The RowColPicture and [RowColPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
The dimensions of the graphics are used to calculate the minimum dimension for the row/column, [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) and column headers, so graphics used as RowColPicture property are never clipped vertically.
The RowColPicture property can be set to the value Nothing (NULL), which removes the graphic from the row/column header.
The position of the row/column header graphic is determined by the RowColumnHeader.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign), RowColumnHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign), RowColumnHeader.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) properties.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## RowColPictureAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPictureAlign*
Defines the position of the graphic displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign) and RowColumnHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.**RowColPictureAlign** **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**RowColPictureAlign** **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.**RowColPictureAlign**; |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**RowColPictureAlign**;
**enum SftTreeAlignConstants** *Align* = *object*->Get**RowColPictureAlign**(); |
| C | **HRESULT** *object*->get_**RowColPictureAlign**(**enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColPictureAlign** = *Align* **As SftTreeAlignConstants** |
| VB | *object*.**RowColPictureAlign** = *Align* **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *object*.**RowColPictureAlign** = *Align*; |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowColPictureAlign** = *Align*;
**void** *object*->Put**RowColPictureAlign**(**enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowColPictureAlign**(**enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Align
Defines the position of the graphic displayed in the row/column header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the row/column header text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the row/column header. The row/column header text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the row/column header text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.ImageHAlign and RowColumnHeader.ImageVAlign instead
The RowColPictureAlign property defines the position of the graphic displayed in the row/column header.
The row/column header graphic is defined using the RowColumnHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image) property.
See Also SftTree Object | Object Hierarchy
## RowColPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPictureH*
Defines the graphic displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.**RowColPictureH** **As Integer** |
| VB | *Handle* = *object*.**RowColPictureH** **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.**RowColPictureH**; |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**RowColPictureH**;
**OLE_HANDLE** *Handle* = *object*->Get**RowColPictureH**(); |
| C | **HRESULT** *object*->get_**RowColPictureH**(**OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColPictureH** = *Handle* **As Integer** |
| VB | *object*.**RowColPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**RowColPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**RowColPictureH** = *Handle*;
**void** *object*->Put**RowColPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**RowColPictureH**(**OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Handle
A bitmap handle. Defines the graphic displayed in the row/column header. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.Image.PictureH instead
The RowColPictureH property defines the graphic displayed in the row/column header.
The [RowColPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColPicture) and RowColPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
The dimensions of the graphics are used to calculate the minimum dimension for the row/column, [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) and column headers, so graphics used as RowColPicture property are never clipped vertically.
The RowColPictureH property can be set to the value 0 (NULL), which removes the graphic from the row/column header.
The position of the row/column header graphic is determined by the RowColumnHeader.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageHAlign), RowColumnHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ImageVAlign), RowColumnHeader.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) properties.
See Also SftTree Object | Object Hierarchy
## RowColText Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColText*
Defines the text displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**RowColText** **As String** |
| VB | *Text* = *object*.**RowColText** **As String** |
| C#.NET | **string** *Text* = *object*.**RowColText**; |
| VC++ | **_bstr_t** *Text* = *object*->**RowColText**;
**_bstr_t** *Text* = *object*->Get**RowColText**(); |
| C | **HRESULT** *object*->get_**RowColText**(**BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColText** = *Text* **As String** |
| VB | *object*.**RowColText** = *Text* **As String** |
| C#.NET | **string** *object*.**RowColText** = *Text*; |
| VC++ | **_bstr_t** *object*->**RowColText** = *Text*;
**void** *object*->Put**RowColText**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**RowColText**(**BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
Defines the text displayed in the row/column header.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.Text instead
The RowColText property defines the text displayed in the row/column header.
The alignment of the row/column header text can be defined using the RowColumnHeader.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) properties.
The row/column header supports [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) by using new-line characters (CR-LF) to start a new line. Word-wrap is not supported.
See Also SftTree Object | Object Hierarchy
## RowColTextStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColTextStyle*
Defines the style used to display the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**RowColTextStyle** **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Style* = *object*.**RowColTextStyle** **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Style* = *object*.**RowColTextStyle**; |
| VC++ | **enum SftTreeAlignConstants** *Style* = *object*->**RowColTextStyle**;
**enum SftTreeAlignConstants** *Style* = *object*->Get**RowColTextStyle**(); |
| C | **HRESULT** *object*->get_**RowColTextStyle**(**enum SftTreeAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowColTextStyle** = *Style* **As SftTreeAlignConstants** |
| VB | *object*.**RowColTextStyle** = *Style* **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *object*.**RowColTextStyle** = *Style*; |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowColTextStyle** = *Style*;
**void** *object*->Put**RowColTextStyle**(**enum SftTreeAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**RowColTextStyle**(**enum SftTreeAlignConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the style used to display the row/column header text.
One value of each of the following tables can be combined and used as *Style* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| alignSftTreeCenter | 1 | The text and graphic component are centered. |
| alignSftTreeRight | 2 | The text and graphic component are right aligned. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The text is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The text is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The text is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowColumnHeader.TextHAlign and RowColumnHeader.TextVAlign instead
The RowColTextStyle property defines the style used to display the row/column header text.
The RowColumnHeader.[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text) property can be used to define the text displayed in the row/column header.
See Also SftTree Object | Object Hierarchy
## RowColumnFooter Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter*
Returns the [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refRowColumnFooterObj* = *object*.**RowColumnFooter** **As SftTreeRowColumnFooter** |
| VB | **Set** *refRowColumnFooterObj* = *object*.**RowColumnFooter** **As SftTreeRowColumnFooter** |
| C#.NET | **SftTreeRowColumnFooter** *refRowColumnFooterObj* = *object*.**RowColumnFooter**; |
| VC++ | **ISftTreeRowColumnFooter*** *refRowColumnFooterObj* = *object*->**RowColumnFooter**;
**ISftTreeRowColumnFooter*** *refRowColumnFooterObj* = *object*->Get**RowColumnFooter**(); |
| C | **HRESULT** *object*->get_**RowColumnFooter**(**ISftTreeRowColumnFooter**** *refRowColumnFooterObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refRowColumnFooterObj
Returns the SftTreeRowColumnFooter object.
### Comments
The RowColumnFooter property returns the SftTreeRowColumnFooter object.
The SftTreeRowColumnFooter object describes the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) in a SftTree/OCX control. The SftTreeRowColumnFooter object can be accessed through the control's RowColumnFooter property. A control has only one SftTreeRowColumnFooter object.
See Also SftTree Object | Object Hierarchy
## RowColumnHeader Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader*
Returns the [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refRowColumnHeaderObj* = *object*.**RowColumnHeader** **As SftTreeRowColumnHeader** |
| VB | **Set** *refRowColumnHeaderObj* = *object*.**RowColumnHeader** **As SftTreeRowColumnHeader** |
| C#.NET | **SftTreeRowColumnHeader** *refRowColumnHeaderObj* = *object*.**RowColumnHeader**; |
| VC++ | **ISftTreeRowColumnHeader*** *refRowColumnHeaderObj* = *object*->**RowColumnHeader**;
**ISftTreeRowColumnHeader*** *refRowColumnHeaderObj* = *object*->Get**RowColumnHeader**(); |
| C | **HRESULT** *object*->get_**RowColumnHeader**(**ISftTreeRowColumnHeader**** *refRowColumnHeaderObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refRowColumnHeaderObj
Returns the SftTreeRowColumnHeader object.
### Comments
The RowColumnHeader property returns the SftTreeRowColumnHeader object.
The SftTreeRowColumnHeader object describes the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) in a SftTree/OCX control. The SftTreeRowColumnHeader object can be accessed through the control's RowColumnHeader property. A control has only one SftTreeRowColumnHeader object.
See Also SftTree Object | Object Hierarchy
## RowForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text color used to draw the item when it is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**RowForeColor**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowForeColor**(**ByVal** *ItemIndex* **As Long**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**RowForeColor**(**int** *ItemIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowForeColor**[**long** *ItemIndex*];
**OLE_COLOR** *Clr* = *object*->Get**RowForeColor**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowForeColor**(**long** *ItemIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**RowForeColor**(**ByVal** *ItemIndex* **As Long**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**RowForeColor**(**int** *ItemIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**RowForeColor**[**long** *ItemIndex*] = *Clr*;
**void** *object*->Put**RowForeColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowForeColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Clr
Defines the row header text color used to draw the item when it is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.ForeColor instead
The RowForeColor property defines the row header text color used to draw the item when it is not selected.
The row header described by *ItemIndex* has the foreground color attribute *Clr*. This color is used as foreground color when the item is not selected. If the item is selected, the RowHeader.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) property is used instead.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowForeColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) foreground color used to draw the item when it is not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowForeColor** = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**RowForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**RowForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowForeColor** = *Clr*;
**void** *object*->Put**RowForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowForeColor**(**OLE_COLOR** *Clr*); |
object
A VirtualItem object.
Clr
Defines the row header foreground color used to draw the item when it is not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.ForeColor instead
The RowForeColor property defines the row header foreground color used to draw the item when it is not selected.
The VirtualItem.RowForeColor property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's background color. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowHeader Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader*
Returns the item's [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refRowHeaderObj* = *object*.**RowHeader** **As SftTreeRowHeader** |
| VB | **Set** *refRowHeaderObj* = *object*.**RowHeader** **As SftTreeRowHeader** |
| C#.NET | **SftTreeRowHeader** *refRowHeaderObj* = *object*.**RowHeader**; |
| VC++ | **ISftTreeRowHeader*** *refRowHeaderObj* = *object*->**RowHeader**;
**ISftTreeRowHeader*** *refRowHeaderObj* = *object*->Get**RowHeader**(); |
| C | **HRESULT** *object*->get_**RowHeader**(**ISftTreeRowHeader**** *refRowHeaderObj*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
refRowHeaderObj
Returns the item's SftTreeRowHeader object.
### Comments
The RowHeader property returns the item's SftTreeRowHeader object.
The SftTreeRowHeader object represents one item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) in a SftTree/OCX control. Numerous row header-specific properties and methods can be accessed using the returned object * refRowHeaderObj*.
Certain default properties and behavior for row headers can be defined using the [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
See Also SftTreeItem Object | Object Hierarchy
## RowHeaderAppearance Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderAppearance*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) appearance.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**RowHeaderAppearance** **As [SftTreeRowHeaderAppearanceConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeRowHeaderAppearanceConstants)** |
| VB | *Style* = *object*.**RowHeaderAppearance** **As SftTreeRowHeaderAppearanceConstants** |
| C#.NET | **SftTreeRowHeaderAppearanceConstants** *Style* = *object*.**RowHeaderAppearance**; |
| VC++ | **enum SftTreeRowHeaderAppearanceConstants** *Style* = *object*->**RowHeaderAppearance**;
**enum SftTreeRowHeaderAppearanceConstants** *Style* = *object*->Get**RowHeaderAppearance**(); |
| C | **HRESULT** *object*->get_**RowHeaderAppearance**(**enum SftTreeRowHeaderAppearanceConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderAppearance** = *Style* **As SftTreeRowHeaderAppearanceConstants** |
| VB | *object*.**RowHeaderAppearance** = *Style* **As SftTreeRowHeaderAppearanceConstants** |
| C#.NET | **SftTreeRowHeaderAppearanceConstants** *object*.**RowHeaderAppearance** = *Style*; |
| VC++ | **enum SftTreeRowHeaderAppearanceConstants** *object*->**RowHeaderAppearance** = *Style*;
**void** *object*->Put**RowHeaderAppearance**(**enum SftTreeRowHeaderAppearanceConstants** *Style*); |
| C | **HRESULT** *object*->put_**RowHeaderAppearance**(**enum SftTreeRowHeaderAppearanceConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the row header appearance.
| Style | Value | Description |
| --- | --- | --- |
| rowheaderSftTreeNone | 0 | No row headers. The row headers and row/[column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) are not displayed. The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Appearance) property is set to [headerSftTreeNone](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderAppearanceConstants). |
| rowheaderSftTreeButton | 1 | Displays row headers as buttons. The row header text is defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) property. |
| rowheaderSftTreeText | 2 | Displays row headers as titles. The row header text is defined using the RowHeader.Text property. |
| rowheaderSftTreeButtonCnt0 | 3 | Displays row headers as buttons. The row header text defaults to the zero-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeTextCnt0 | 4 | Displays row headers as titles. The row header text defaults to the zero-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeButtonCnt1 | 5 | Displays row headers as buttons. The row header text defaults to the one-based index of the item and can be specified using the RowHeader.Text property. |
| rowheaderSftTreeTextCnt1 | 6 | Displays row headers as titles. The row header text defaults to the one-based index of the item and can be specified using the RowHeader.Text property. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.Appearance instead
The RowHeaderAppearance property defines the row header appearance.
If the RowHeaderAppearance property is set to rowheaderSftTreeButton, rowheaderSftTreeButtonCnt0 or rowheaderSftTreeButtonCnt1, the row headers are displayed as buttons, which can be clicked by the user. Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The RowHeaderAppearance property applies to all row headers and cannot be changed for individual items.
The status of the row header buttons can be controlled using the RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) and RowHeaders.[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_RemainUp) properties.
See Also SftTree Object | Object Hierarchy
## RowHeaderBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderBackColor*
Defines the default background color used to draw [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) of items that are not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_BackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderBackColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderBackColor** = *Clr*;
**void** *object*->Put**RowHeaderBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default background color used to draw row headers of items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.BackColor instead
The RowHeaderBackColor property defines the default background color used to draw row headers of items that are not selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header background color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderButtonRemainUp Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderButtonRemainUp*
Defines whether [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) buttons will return to their "up" position when pressed.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[RemainUp](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_RemainUp) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RowHeaderButtonRemainUp** **As Boolean** |
| VB | *Boolean* = *object*.**RowHeaderButtonRemainUp** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RowHeaderButtonRemainUp**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RowHeaderButtonRemainUp**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RowHeaderButtonRemainUp**(); |
| C | **HRESULT** *object*->get_**RowHeaderButtonRemainUp**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderButtonRemainUp** = *Boolean* **As Boolean** |
| VB | *object*.**RowHeaderButtonRemainUp** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RowHeaderButtonRemainUp** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RowHeaderButtonRemainUp** = *Boolean*;
**void** *object*->Put**RowHeaderButtonRemainUp**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RowHeaderButtonRemainUp**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether row header buttons will return to their "up" position when pressed.
| Boolean | Description |
| --- | --- |
| True | The row header buttons automatically return to their "up" position when clicked. |
| False | The row header buttons remain in the "down" position when clicked. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.RemainUp instead
The RowHeaderButtonRemainUp property defines whether row header buttons will return to their "up" position when pressed.
Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The RowHeaderButtonRemainUp property applies to all row headers and cannot be changed for individual items.
If row headers are not shown or row headers are shown as titles (see RowHeaders.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property), this property has no effect.
See Also SftTree Object | Object Hierarchy
## RowHeaderEnabled Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderEnabled*
Defines whether [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) are enabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RowHeaderEnabled** **As Boolean** |
| VB | *Boolean* = *object*.**RowHeaderEnabled** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RowHeaderEnabled**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RowHeaderEnabled**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RowHeaderEnabled**(); |
| C | **HRESULT** *object*->get_**RowHeaderEnabled**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderEnabled** = *Boolean* **As Boolean** |
| VB | *object*.**RowHeaderEnabled** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RowHeaderEnabled** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RowHeaderEnabled** = *Boolean*;
**void** *object*->Put**RowHeaderEnabled**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RowHeaderEnabled**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether row headers are enabled.
| Boolean | Description |
| --- | --- |
| True | Row headers are enabled. |
| False | Row headers are disabled. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.Enabled instead
The RowHeaderEnabled property defines whether row headers are enabled.
Row header buttons reflect the selection status ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property) of each item.
The RowHeaderEnabled property applies to all row headers and cannot be changed for individual items.
Disabled row headers are drawn using the RowHeaders.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor) property value as text color and row header graphics (see [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).Image property) are drawn in a "grayed" fashion, if based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.
See Also SftTree Object | Object Hierarchy
## RowHeaderFont Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderFont*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) font.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Font) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refFontObj* = *object*.**RowHeaderFont** **As System.Drawing.Font[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refFontObj* = *object*.**RowHeaderFont** **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *refFontObj* = *object*.**RowHeaderFont**; |
| VC++ | **IFontDisp*** *refFontObj* = *object*->Get**RowHeaderFont**(); |
| C | **HRESULT** *object*->get_**RowHeaderFont**(**IFontDisp**** *refFontObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**RowHeaderFont**(**ByVal** *refFontObj* **As System.Drawing.Font**) |
| VB | *object*.**RowHeaderFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **void** *object*.let_**RowHeaderFont**(**System.Drawing.Font** *refFontObj*); |
| VC++ | **void** *object*->Put**RowHeaderFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->put_**RowHeaderFont**(**IFontDisp*** *refFontObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderFont** = *refFontObj* **As System.Drawing.Font** |
| VB | **Set** *object*.**RowHeaderFont** = *refFontObj* **As IFontDisp** |
| C#.NET | **System.Drawing.Font** *object*.**RowHeaderFont** = *refFontObj*; |
| VC++ | **void** *object*->PutRef**RowHeaderFont**(**IFontDisp*** *refFontObj*); |
| C | **HRESULT** *object*->putref_**RowHeaderFont**(**IFontDisp*** *refFontObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refFontObj
Defines the row header font. For information about font properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.Font instead
The RowHeaderFont property defines the row header font.
All row headers use the defined font. Individual items cannot override the default font.
Using *PutRef* (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using *Put* instead causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## RowHeaderForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderForeColor*
Defines the default text color used to draw [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) of items that are not selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderForeColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderForeColor** = *Clr*;
**void** *object*->Put**RowHeaderForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default text color used to draw row headers of items that are not selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.ForeColor instead
The RowHeaderForeColor property defines the default text color used to draw row headers of items that are not selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header foreground color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) property.
See Also SftTree Object | Object Hierarchy
## RowHeaderGrayedColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderGrayedColor*
Defines the text color used to draw disabled [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_GrayedColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderGrayedColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderGrayedColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderGrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderGrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderGrayedColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderGrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderGrayedColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderGrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderGrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderGrayedColor** = *Clr*;
**void** *object*->Put**RowHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderGrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw disabled row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.GrayedColor instead
The RowHeaderGrayedColor property defines the text color used to draw disabled row headers.
Row headers can be disabled globally using the RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property, individual items can be disabled using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderHilightColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderHilightColor*
Defines the default color used to draw the highlighted edge of [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[HilightColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_HilightColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderHilightColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderHilightColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderHilightColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderHilightColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderHilightColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderHilightColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderHilightColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderHilightColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderHilightColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderHilightColor** = *Clr*;
**void** *object*->Put**RowHeaderHilightColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderHilightColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default color used to draw the highlighted edge of row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.HilightColor instead
The RowHeaderHilightColor property defines the default color used to draw the highlighted edge of row headers.
All row headers use the same highlight color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderLines Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderLines*
Defines the number of [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text lines used for height calculation.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Lines) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Lines* = *object*.**RowHeaderLines** **As Short** |
| VB | *Lines* = *object*.**RowHeaderLines** **As Integer** |
| C#.NET | **short** *Lines* = *object*.**RowHeaderLines**; |
| VC++ | **short** *Lines* = *object*->**RowHeaderLines**;
**short** *Lines* = *object*->Get**RowHeaderLines**(); |
| C | **HRESULT** *object*->get_**RowHeaderLines**(**short*** *Lines*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderLines** = *Lines* **As Short** |
| VB | *object*.**RowHeaderLines** = *Lines* **As Integer** |
| C#.NET | **short** *object*.**RowHeaderLines** = *Lines*; |
| VC++ | **short** *object*->**RowHeaderLines** = *Lines*;
**void** *object*->Put**RowHeaderLines**(**short** *Lines*); |
| C | **HRESULT** *object*->put_**RowHeaderLines**(**short** *Lines*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Lines
Defines the number of row header text lines used for height calculation.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.Lines instead
The RowHeaderLines property defines the number of row header text lines used for height calculation.
If [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) are used (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all items in a tree control have the same height. The best height for items is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired for row headers, the RowHeaderLines property should be used to set the expected (maximum) number of lines per item. This insures that multiple lines of text will fit within the vertical space allocated to each item. Some properties which override default properties are not taken into consideration when calculating the item height. E.g., the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Font) property does not affect the item height. It must be chosen to be smaller or equal to the size of the [Font](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Font) property, otherwise text may be clipped vertically.
If variable height items are used (see Items.Style), items in a tree control can have varying heights. The best height for each item is automatically calculated based on the font, graphics and text components used. If multi-line text entries are desired for row headers, the RowHeaderLines property should be used to set the maximum number of lines to be displayed. This insures that multiple lines of text will fit within the vertical space allocated to each item. If a row header has more text lines than defined using the RowHeaderLines property, the lines are not visible. All properties of an item, including [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) properties such as the Cell.Font and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties, also affect the item height.
Row headers support multi-line text using new-line characters (CR-LF). Word-wrap is not supported.
If fixed height items are used (see Items.Style), a tree control defaults to one text line. If multi-line text is added and the text exceeds the number of lines defined using the RowHeaderLines property, the text will be truncated vertically.
If variable height items are used (see Items.Style), a tree control defaults to one text line. If more text lines need to be displayed than are defined using the RowHeaderLines property, only the specified number of text lines are displayed followed by a '+', indicating that text lines have been truncated.
See Also SftTree Object | Object Hierarchy
## RowHeaders Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders*
Returns the [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refRowHeadersObj* = *object*.**RowHeaders** **As SftTreeRowHeaders** |
| VB | **Set** *refRowHeadersObj* = *object*.**RowHeaders** **As SftTreeRowHeaders** |
| C#.NET | **SftTreeRowHeaders** *refRowHeadersObj* = *object*.**RowHeaders**; |
| VC++ | **ISftTreeRowHeaders*** *refRowHeadersObj* = *object*->**RowHeaders**;
**ISftTreeRowHeaders*** *refRowHeadersObj* = *object*->Get**RowHeaders**(); |
| C | **HRESULT** *object*->get_**RowHeaders**(**ISftTreeRowHeaders**** *refRowHeadersObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refRowHeadersObj
Returns the SftTreeRowHeaders object.
### Comments
The RowHeaders property returns the SftTreeRowHeaders object.
The SftTreeRowHeaders object describes attributes that apply to all [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object * refRowHeadersObj*. A control has only one SftTreeRowHeaders object.
An individual item's [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object can be accessed through the control's [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader) property.
See Also SftTree Object | Object Hierarchy
## RowHeaderSelectBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderSelectBackColor*
Defines the default [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw items that are selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderSelectBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderSelectBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderSelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderSelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderSelectBackColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderSelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderSelectBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderSelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderSelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderSelectBackColor** = *Clr*;
**void** *object*->Put**RowHeaderSelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderSelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default row header background color used to draw items that are selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.SelectBackColor instead
The RowHeaderSelectBackColor property defines the default row header background color used to draw items that are selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header's background color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderSelectForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderSelectForeColor*
Defines the default [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text color used to draw items that are selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderSelectForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderSelectForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderSelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderSelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderSelectForeColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderSelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderSelectForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderSelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderSelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderSelectForeColor** = *Clr*;
**void** *object*->Put**RowHeaderSelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderSelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default row header text color used to draw items that are selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.SelectForeColor instead
The RowHeaderSelectForeColor property defines the default row header text color used to draw items that are selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header's foreground color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderShadowColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderShadowColor*
Defines the default color used to draw the dark edge of [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ShadowColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**RowHeaderShadowColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowHeaderShadowColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**RowHeaderShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowHeaderShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**RowHeaderShadowColor**(); |
| C | **HRESULT** *object*->get_**RowHeaderShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderShadowColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**RowHeaderShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**RowHeaderShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowHeaderShadowColor** = *Clr*;
**void** *object*->Put**RowHeaderShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowHeaderShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the default color used to draw the dark edge of row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.ShadowColor instead
The RowHeaderShadowColor property defines the default color used to draw the dark edge of row headers.
All row headers use the same shadow color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowHeaderTextStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderTextStyle*
Defines the default alignment for [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) and RowHeaders.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.**RowHeaderTextStyle** **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**RowHeaderTextStyle** **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.**RowHeaderTextStyle**; |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**RowHeaderTextStyle**;
**enum SftTreeAlignConstants** *Align* = *object*->Get**RowHeaderTextStyle**(); |
| C | **HRESULT** *object*->get_**RowHeaderTextStyle**(**enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderTextStyle** = *Align* **As SftTreeAlignConstants** |
| VB | *object*.**RowHeaderTextStyle** = *Align* **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *object*.**RowHeaderTextStyle** = *Align*; |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowHeaderTextStyle** = *Align*;
**void** *object*->Put**RowHeaderTextStyle**(**enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowHeaderTextStyle**(**enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Align
Defines the default alignment for row header text.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| alignSftTreeCenter | 1 | The text and graphic component are centered. |
| alignSftTreeRight | 2 | The text and graphic component are right aligned. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The text is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The text is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The text is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.TextHAlign and RowHeaders.TextVAlign instead
The RowHeaderTextStyle property defines the default alignment for row header text.
Individual row headers can override this default using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) properties.
See Also SftTree Object | Object Hierarchy
## RowHeaderWidth Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaderWidth*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**RowHeaderWidth** **As Single** |
| VB | *Width* = *object*.**RowHeaderWidth** **As Single** |
| C#.NET | **float** *Width* = *object*.**RowHeaderWidth**; |
| VC++ | **float** *Width* = *object*->**RowHeaderWidth**;
**float** *Width* = *object*->Get**RowHeaderWidth**(); |
| C | **HRESULT** *object*->get_**RowHeaderWidth**(**float*** *Width*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowHeaderWidth** = *Width* **As Single** |
| VB | *object*.**RowHeaderWidth** = *Width* **As Single** |
| C#.NET | **float** *object*.**RowHeaderWidth** = *Width*; |
| VC++ | **float** *object*->**RowHeaderWidth** = *Width*;
**void** *object*->Put**RowHeaderWidth**(**float** *Width*); |
| C | **HRESULT** *object*->put_**RowHeaderWidth**(**float** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Width
Defines the width of the row header area. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeaders.Width instead
The RowHeaderWidth property defines the width of the row header area.
The RowHeaderWidth property is used to change the width of the row header and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) area.
The RowHeaders.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTree Object | Object Hierarchy
## RowIndex Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex*
Returns the item index of the item currently requested from the [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[ItemIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_ItemIndex) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**RowIndex** **As Integer** |
| VB | *ItemIndex* = *object*.**RowIndex** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**RowIndex**; |
| VC++ | **long** *ItemIndex* = *object*->**RowIndex**;
**long** *ItemIndex* = *object*->Get**RowIndex**(); |
| C | **HRESULT** *object*->get_**RowIndex**(**long*** *ItemIndex*); |
object
A VirtualItem object.
ItemIndex
Returns the item index of the item currently requested from the virtual data source.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.ItemIndex instead
The RowIndex property returns the item index of the item currently requested from the virtual data source.
The VirtualItem.RowIndex property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to retrieve the item index of the item currently requested from the virtual data source. The returned value is identical to the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowPicture Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPicture*
Defines the graphic displayed in an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.get_**RowPicture**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**RowPicture**(**ByVal** *ItemIndex* **As Long**) **As IPictureDisp** |
| C#.NET | **System.Drawing.Image** *refPictureObj* = *object*.get_**RowPicture**(**int** *ItemIndex*); |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**RowPicture**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowPicture**(**long** *ItemIndex*, **IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**RowPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | *object*.**RowPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**RowPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->Put**RowPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**RowPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.set_**RowPicture**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *refPictureObj* **As System.Drawing.Image**) |
| VB | **Set** *object*.**RowPicture**(**ByVal** *ItemIndex* **As Long**) = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.set_**RowPicture**(**int** *ItemIndex*, **System.Drawing.Image** *refPictureObj*); |
| VC++ | **void** *object*->PutRef**RowPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**RowPicture**(**long** *ItemIndex*, **IPictureDisp*** *refPictureObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
refPictureObj
Defines the graphic displayed in the item's row header. The * refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.Image.Picture instead
The RowPicture property defines the graphic displayed in an item's row header.
The RowPicture and [RowPictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPictureH) properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as RowPicture property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the row headers, so graphics used as RowPicture property are never clipped vertically. To change the row header graphic size, all row header graphics must be removed first using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ClearImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If row headers are disabled (see RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired. Individual items may be disabled using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property.
The RowHeaders.ClearImages method can be used to remove all row header graphics. The RowPicture property can be set to the value Nothing (NULL), which removes the graphic from the row header.
The position of the row header graphic is determined by the RowHeader.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) and RowHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) properties.
Using *PutRef* (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using *Put* instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of *Put*, *PutRef* is the preferred method.
See Also SftTree Object | Object Hierarchy
## RowPicture Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPicture*
Defines the graphic displayed in the item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image).[Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refPictureObj* = *object*.**RowPicture** **As stdole.IPictureDisp[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | **Set** *refPictureObj* = *object*.**RowPicture** **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *refPictureObj* = *object*.**RowPicture**; |
| VC++ | **IPictureDisp*** *refPictureObj* = *object*->Get**RowPicture**(); |
| C | **HRESULT** *object*->get_**RowPicture**(**IPictureDisp**** *refPictureObj*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.let_**RowPicture**(**ByVal** *refPictureObj* **As stdole.IPictureDisp**) |
| VB | *object*.**RowPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **void** *object*.let_**RowPicture**(**stdole.IPictureDisp** *refPictureObj*); |
| VC++ | **void** *object*->Put**RowPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->put_**RowPicture**(**IPictureDisp*** *refPictureObj*); |
PutRef
| | |
| --- | --- |
| VB.NET | *object*.**RowPicture** = *refPictureObj* **As stdole.IPictureDisp** |
| VB | **Set** *object*.**RowPicture** = *refPictureObj* **As IPictureDisp** |
| C#.NET | **stdole.IPictureDisp** *object*.**RowPicture** = *refPictureObj*; |
| VC++ | **void** *object*->PutRef**RowPicture**(**IPictureDisp*** *refPictureObj*); |
| C | **HRESULT** *object*->putref_**RowPicture**(**IPictureDisp*** *refPictureObj*); |
object
A VirtItem object.
refPictureObj
Defines the graphic displayed in the item's row header. The *refPictureObj* object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.Image.Picture instead
The RowPicture property defines the graphic displayed in the item's row header.
The VirtualItem.RowPicture property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's row header graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowPictureAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPictureAlign*
Defines the position of the graphic displayed in an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) and RowHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**RowPictureAlign**(**ByVal** *ItemIndex* **As Integer**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**RowPictureAlign**(**ByVal** *ItemIndex* **As Long**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**RowPictureAlign**(**int** *ItemIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**RowPictureAlign**[**long** *ItemIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**RowPictureAlign**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowPictureAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowPictureAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**RowPictureAlign**(**ByVal** *ItemIndex* **As Long**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**RowPictureAlign**(**int** *ItemIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowPictureAlign**[**long** *ItemIndex*] = *Align*;
**void** *object*->Put**RowPictureAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowPictureAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Align
Defines the position of the graphic displayed in the item's row header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the row header text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the row header. The row header text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the row header text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.ImageHAlign and RowHeader.ImageVAlign instead
The RowPictureAlign property defines the position of the graphic displayed in an item's row header.
Row header graphics are defined using the RowHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) property.
See Also SftTree Object | Object Hierarchy
## RowPictureAlign Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPictureAlign*
Defines the position of the graphic displayed in an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) and VirtualItem.Item.RowHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowPictureAlign** = *Align* **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *object*.**RowPictureAlign** = *Align* **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *object*.**RowPictureAlign** = *Align*; |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowPictureAlign** = *Align*;
**void** *object*->Put**RowPictureAlign**(**enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowPictureAlign**(**enum SftTreeAlignConstants** *Align*); |
object
A VirtualItem object.
Align
Defines the position of the graphic displayed in the item's row header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The graphic is on the left of the row header text. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The graphic is centered in the row header. The row header text is not displayed. |
| alignSftTreeRight | 2 | The graphic is on the right of the row header text. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The graphic is vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The graphic is aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The graphic is aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.ImageHAlign and VirtualItem.Item.RowHeader.ImageVAlign instead
The RowPictureAlign property defines the position of the graphic displayed in an item's row header.
The VirtualItem.RowPictureAlign property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the position of the graphic displayed in the item's row header. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowPictureH Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPictureH*
Defines the graphic displayed in an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Handle* = *object*.get_**RowPictureH**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *Handle* = *object*.**RowPictureH**(**ByVal** *ItemIndex* **As Long**) **As OLE_HANDLE** |
| C#.NET | **int** *Handle* = *object*.get_**RowPictureH**(**int** *ItemIndex*); |
| VC++ | **OLE_HANDLE** *Handle* = *object*->**RowPictureH**[**long** *ItemIndex*];
**OLE_HANDLE** *Handle* = *object*->Get**RowPictureH**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowPictureH**(**long** *ItemIndex*, **OLE_HANDLE*** *Handle*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowPictureH**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Handle* **As Integer**) |
| VB | *object*.**RowPictureH**(**ByVal** *ItemIndex* **As Long**) = *Handle* **As OLE_HANDLE** |
| C#.NET | **void** *object*.set_**RowPictureH**(**int** *ItemIndex*, **int** *Handle*); |
| VC++ | **OLE_HANDLE** *object*->**RowPictureH**[**long** *ItemIndex*] = *Handle*;
**void** *object*->Put**RowPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**RowPictureH**(**long** *ItemIndex*, **OLE_HANDLE** *Handle*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Handle
A bitmap handle. Defines the graphic displayed in an item's row header. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.Image.PictureH instead
The RowPictureH property defines the graphic displayed in an item's row header.
The [RowPicture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowPicture) and RowPictureH properties are synonyms, but accept different value types ([Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object reference or Windows bitmap handle).
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as RowPicture property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for the row headers, so graphics used as RowPicture property are never clipped vertically. To change the row header graphic size, all row header graphics must be removed first using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[ClearImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ClearImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
If row headers are disabled (see RowHeaders.[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Enabled) property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired. Individual items may be disabled using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property.
The RowHeaders.ClearImages method can be used to remove all row header graphics. The RowPictureH property can be set to the value 0 (NULL), which removes the graphic from the row header.
The position of the row header graphic is determined by the RowHeader.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageHAlign) and RowHeader.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ImageVAlign) properties.
See Also SftTree Object | Object Hierarchy
## RowPictureH Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowPictureH*
Defines the graphic displayed in the item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image).[PictureH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_PictureH) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowPictureH** = *Handle* **As Integer** |
| VB | *object*.**RowPictureH** = *Handle* **As OLE_HANDLE** |
| C#.NET | **int** *object*.**RowPictureH** = *Handle*; |
| VC++ | **OLE_HANDLE** *object*->**RowPictureH** = *Handle*;
**void** *object*->Put**RowPictureH**(**OLE_HANDLE** *Handle*); |
| C | **HRESULT** *object*->put_**RowPictureH**(**OLE_HANDLE** *Handle*); |
object
A VirtualItem object.
Handle
A bitmap handle. Defines the graphic displayed as the control's background. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.Image.PictureH instead f
The RowPictureH property defines the graphic displayed in the item's row header.
The VirtualItem.RowPictureH property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the item's row header graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowSelectBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowSelectBackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw the item when it is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**RowSelectBackColor**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowSelectBackColor**(**ByVal** *ItemIndex* **As Long**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**RowSelectBackColor**(**int** *ItemIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowSelectBackColor**[**long** *ItemIndex*];
**OLE_COLOR** *Clr* = *object*->Get**RowSelectBackColor**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowSelectBackColor**(**long** *ItemIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowSelectBackColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**RowSelectBackColor**(**ByVal** *ItemIndex* **As Long**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**RowSelectBackColor**(**int** *ItemIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**RowSelectBackColor**[**long** *ItemIndex*] = *Clr*;
**void** *object*->Put**RowSelectBackColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowSelectBackColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Clr
Defines the row header background color used to draw the item when it is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.SelectBackColor instead
The RowSelectBackColor property defines the row header background color used to draw the item when it is selected.
The row header described by *ItemIndex* has the background color attribute *Clr*. This color is used as background color when the item is selected. If the item is not selected, the RowHeader.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) property is used instead.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowSelectBackColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowSelectBackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw the item when it is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowSelectBackColor** = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**RowSelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**RowSelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowSelectBackColor** = *Clr*;
**void** *object*->Put**RowSelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowSelectBackColor**(**OLE_COLOR** *Clr*); |
object
A VirtualItem object.
Clr
Defines the row header background color used to draw the item when it is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.SelectBackColor instead
The RowSelectBackColor property defines the row header background color used to draw the item when it is selected.
The VirtualItem.RowSelectBackColor property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the row header background color used to draw the item when it is selected. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowSelectForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowSelectForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text color used to draw the item when it is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.get_**RowSelectForeColor**(**ByVal** *ItemIndex* **As Integer**) **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**RowSelectForeColor**(**ByVal** *ItemIndex* **As Long**) **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.get_**RowSelectForeColor**(**int** *ItemIndex*); |
| VC++ | **OLE_COLOR** *Clr* = *object*->**RowSelectForeColor**[**long** *ItemIndex*];
**OLE_COLOR** *Clr* = *object*->Get**RowSelectForeColor**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowSelectForeColor**(**long** *ItemIndex*, **OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowSelectForeColor**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Clr* **As System.Drawing.Color**) |
| VB | *object*.**RowSelectForeColor**(**ByVal** *ItemIndex* **As Long**) = *Clr* **As OLE_COLOR** |
| C#.NET | **void** *object*.set_**RowSelectForeColor**(**int** *ItemIndex*, **uint** *Clr*); |
| VC++ | **OLE_COLOR** *object*->**RowSelectForeColor**[**long** *ItemIndex*] = *Clr*;
**void** *object*->Put**RowSelectForeColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowSelectForeColor**(**long** *ItemIndex*, **OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Clr
Defines the row header text color used to draw the item when it is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.SelectForeColor instead
The RowSelectForeColor property defines the row header text color used to draw the item when it is selected.
The row header described by *ItemIndex* has the foreground color attribute *Clr*. This color is used as foreground color when the item is selected. If the item is not selected, the RowHeader.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) property is used instead.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTree Object | Object Hierarchy
## RowSelectForeColor Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowSelectForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) foreground color used to draw the item when it is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowSelectForeColor** = *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *object*.**RowSelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**RowSelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**RowSelectForeColor** = *Clr*;
**void** *object*->Put**RowSelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**RowSelectForeColor**(**OLE_COLOR** *Clr*); |
object
A VirtualItem object.
Clr
Defines the row header foreground color used to draw the item when it is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.SelectForeColor instead
The RowSelectForeColor property defines the row header foreground color used to draw the item when it is selected.
The VirtualItem.RowSelectForeColor property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the row header foreground color used to draw the item when it is selected. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowText Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowText*
Defines an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.get_**RowText**(**ByVal** *ItemIndex* **As Integer**) **As String** |
| VB | *Text* = *object*.**RowText**(**ByVal** *ItemIndex* **As Long**) **As String** |
| C#.NET | **string** *Text* = *object*.get_**RowText**(**int** *ItemIndex*); |
| VC++ | **_bstr_t** *Text* = *object*->**RowText**[**long** *ItemIndex*];
**_bstr_t** *Text* = *object*->Get**RowText**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowText**(**long** *ItemIndex*, **BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowText**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Text* **As String**) |
| VB | *object*.**RowText**(**ByVal** *ItemIndex* **As Long**) = *Text* **As String** |
| C#.NET | **void** *object*.set_**RowText**(**int** *ItemIndex*, **string** *Text*); |
| VC++ | **_bstr_t** *object*->**RowText**[**long** *ItemIndex*] = *Text*;
**void** *object*->Put**RowText**(**long** *ItemIndex*, **_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**RowText**(**long** *ItemIndex*, **BSTR** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Text
Defines the item's row header text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.Text instead
The RowText property defines an item's row header text.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) and Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) methods add new items. The default text of the row header depends on the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property.
Row headers can support [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) (see RowHeaders.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Lines)) by using new-line characters (CR-LF) to start a new line. Word-wrap is not supported.
The default alignment for all row headers is defined using the RowHeaders.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) and RowHeaders.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) properties. A row header can override the default using the RowHeader.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) properties.
See Also SftTree Object | Object Hierarchy
## RowText Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowText*
Defines the item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowText** = *Text* **As String** |
| VB | *object*.**RowText** = *Text* **As String** |
| C#.NET | **string** *object*.**RowText** = *Text*; |
| VC++ | **_bstr_t** *object*->**RowText** = *Text*;
**void** *object*->Put**RowText**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**RowText**(**BSTR** *Text*); |
object
A VirtualItem object.
Text
Defines the item's row header text.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.Text instead
The RowText property defines the item's row header text.
The VirtualItem.RowText property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the row header text. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RowTextAlign Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowTextAlign*
Defines the position of the text displayed in an item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Align* = *object*.get_**RowTextAlign**(**ByVal** *ItemIndex* **As Integer**) **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *Align* = *object*.**RowTextAlign**(**ByVal** *ItemIndex* **As Long**) **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *Align* = *object*.get_**RowTextAlign**(**int** *ItemIndex*); |
| VC++ | **enum SftTreeAlignConstants** *Align* = *object*->**RowTextAlign**[**long** *ItemIndex*];
**enum SftTreeAlignConstants** *Align* = *object*->Get**RowTextAlign**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**RowTextAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants*** *Align*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**RowTextAlign**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Align* **As SftTreeAlignConstants**) |
| VB | *object*.**RowTextAlign**(**ByVal** *ItemIndex* **As Long**) = *Align* **As SftTreeAlignConstants** |
| C#.NET | **void** *object*.set_**RowTextAlign**(**int** *ItemIndex*, **SftTreeAlignConstants** *Align*); |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowTextAlign**[**long** *ItemIndex*] = *Align*;
**void** *object*->Put**RowTextAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowTextAlign**(**long** *ItemIndex*, **enum SftTreeAlignConstants** *Align*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Align
Defines the position of the text displayed in the item's row header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The text and graphic are left aligned within the available area. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The text and graphic are centered within the available area. |
| alignSftTreeRight | 2 | The text and graphic are right aligned within the available area. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The text and graphic are vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The text and graphic are aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The text and graphic are aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.TextHAlign and RowHeader.TextVAlign instead
The RowTextAlign property defines the position of the text displayed in an item's row header.
Row header text and graphics are defined using the RowHeader.[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) and RowHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) properties.
The default alignment for all row headers is defined using the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) and RowHeaders.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) properties.
See Also SftTree Object | Object Hierarchy
## RowTextAlign Property, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowTextAlign*
Defines the position of the text displayed in the item's [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and VirtualItem.Item.RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) instead
### Syntax
Put
| | |
| --- | --- |
| VB.NET | *object*.**RowTextAlign** = *Align* **As [SftTreeAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAlignConstants)** |
| VB | *object*.**RowTextAlign** = *Align* **As SftTreeAlignConstants** |
| C#.NET | **SftTreeAlignConstants** *object*.**RowTextAlign** = *Align*; |
| VC++ | **enum SftTreeAlignConstants** *object*->**RowTextAlign** = *Align*;
**void** *object*->Put**RowTextAlign**(**enum SftTreeAlignConstants** *Align*); |
| C | **HRESULT** *object*->put_**RowTextAlign**(**enum SftTreeAlignConstants** *Align*); |
object
A VirtualItem object.
Align
Defines the position of the text displayed in the item's row header.
One value of each of the following tables can be combined and used as *Align* value:
| Horizontal Alignment | Value | Description |
| --- | --- | --- |
| alignSftTreeLeft | 0 | The text and graphic are left aligned within the available area. If no horizontal alignment value is specified, this is the default. |
| alignSftTreeCenter | 1 | The text and graphic are centered within the available area. |
| alignSftTreeRight | 2 | The text and graphic are right aligned within the available area. |
| Vertical Alignment | Value | Description |
| alignSftTreeVCenter | 16 | The text and graphic are vertically centered. If no vertical alignment value is specified, this is the default. |
| alignSftTreeTop | 32 | The text and graphic are aligned with the top of the available area. |
| alignSftTreeBottom | 64 | The text and graphic are aligned with the bottom of the available area. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.RowHeader.TextHAlign and VirtualItem.Item.RowHeader.TextVAlign instead
The RowTextAlign property defines the position of the text displayed in the item's row header.
The VirtualItem.RowTextAlign property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the position of the text displayed in the item's row header. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## RubberbandSelection Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RubberbandSelection*
Defines whether [rubberband selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is enabled (multiple selection only).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**RubberbandSelection** **As Boolean** |
| VB | *Boolean* = *object*.**RubberbandSelection** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**RubberbandSelection**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**RubberbandSelection**;
**VARIANT_BOOL** *Boolean* = *object*->Get**RubberbandSelection**(); |
| C | **HRESULT** *object*->get_**RubberbandSelection**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**RubberbandSelection** = *Boolean* **As Boolean** |
| VB | *object*.**RubberbandSelection** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**RubberbandSelection** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**RubberbandSelection** = *Boolean*;
**void** *object*->Put**RubberbandSelection**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**RubberbandSelection**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether rubberband selection is enabled (multiple selection only).
| Boolean | Description |
| --- | --- |
| True | Enables click-drag selection of multiple items using a selection rectangle. |
| False | [Click](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_Click)-drag selection of multiple items using a selection rectangle is not available. |
### Comments
The RubberbandSelection property defines whether rubberband selection is enabled (multiple selection only).
> In a single selection tree control this property has no effect. Click-drag selection is only available in a multiple selection tree control and only if [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) is set to [selectSftTreeCell1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants), selectSftTreeCellCurrent or selectSftTreeCell1Full. If Items.SelectStyle is set to selectSftTreeCellCurrent, click-dragging cannot start in the first column, it must be initiated from another column.
Click-drag selection with a "rubberband" selection rectangle can be initiated by pressing the mouse button on the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) background (not the cell text) of a cell and dragging the mouse cursor. All items between the starting and ending point are selected. If the mouse cursor approaches the edge of the tree control, scrolling will start, allowing selection of additional items. Once the mouse button is released, the currently selected items remain selected.
See Also SftTreeItems Object | Object Hierarchy
## SampleColor Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SampleColor*
Defines the picture object as a color sample.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SampleColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SampleColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SampleColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SampleColor**;
**OLE_COLOR** *Clr* = *object*->Get**SampleColor**(); |
| C | **HRESULT** *object*->get_**SampleColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SampleColor** = *Clr* **As UInteger** |
| VB | *object*.**SampleColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SampleColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SampleColor** = *Clr*;
**void** *object*->Put**SampleColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SampleColor**(**OLE_COLOR** *Clr*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Clr
Defines the picture object as a color sample. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SampleColor property defines the picture object as a color sample.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants).
The SftPictureObject.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) and SftPictureObject.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) properties should be used to define the requested image size.
The SftPictureObject.[FrameColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_FrameColor) property can be used to define the border color of the color sample.
See Also SftPictureObject Object | Object Hierarchy
## Save Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Save*
Saves the control contents.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**Save**(**ByVal** *Filename* **As String**, **ByVal** *StreamName* **As String**, **ByVal** *Format* **As [SftTreeSaveFormatConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSaveFormatConstants)**, **ByVal** *Properties* **As Boolean**, **ByRef** *Stream* **As IStream**) |
| VB | *object*.**Save**(**ByVal** *Filename* **As String**, **ByVal** *StreamName* **As String**, **ByVal** *Format* **As SftTreeSaveFormatConstants**, **ByVal** *Properties* **As Boolean**, *Stream* **As IStream**) |
| C#.NET | **void** *object*.**Save**(**string** *Filename*, **string** *StreamName*, **SftTreeSaveFormatConstants** *Format*, **bool** *Properties*, **out** **IStream** *Stream*); |
| VC++ | **HRESULT** *object*->**Save**(**_bstr_t** *Filename*, **_bstr_t** *StreamName*, **enum SftTreeSaveFormatConstants** *Format*, **VARIANT_BOOL** *Properties*, **IStream**** *Stream*); |
| C | **HRESULT** *object*->raw_**Save**(**BSTR** *Filename*, **BSTR** *StreamName*, **enum SftTreeSaveFormatConstants** *Format*, **VARIANT_BOOL** *Properties*, **IStream**** *Stream*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Filename
A file name, where the contents are saved. If this file exists, it is overwritten. If* *the *Filename* argument is not NULL/Nothing, the *Stream*, *StreamName* arguments must be NULL/Nothing.
StreamName
Reserved for future use - Ignored. A stream name (part of the compound file *FileName)*, where the contents are saved. If this stream exists, it is overwritten.
Format
Defines the format of the saved data.
| Name | Value | Description |
| --- | --- | --- |
| saveFormatSftTreeStream | 0 | Stream |
| saveFormatSftTreePropertyPages | 1 | Stream as used by Property Page dialog ([Load](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Load)/Save Properties) - always saves all properties. The filename must be specified and the *PropertiesLoaded* argument is ignored. |
Properties
Set to True to save tree control properties (in addition to items and their attributes), False to save just the items and their attributes.
Stream
The stream (IStream interface) where the data is saved. The *Stream *argument must be NULL/Nothing, if* *the *Filename* argument is not NULL/Nothing.
### Comments
The Save method saves the control contents.
The Load method can be used to load the control contents saved using the Save method.
The Save/Load methods are intended for design-time property saving/loading to transfer the settings between controls. While items are also transferred, this is not recommended to be exploited by applications for quick data loading, as any images used in the control are saved in their entirety. Images shared between items (i.e., using the same image reference) will be individually copied resulting in excessive memory/windows handle use.
See Also SftTree Object | Object Hierarchy
## Scrollbars Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars*
Defines the presence of horizontal and vertical scroll bars.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Scrollbars** **As [SftTreeScrollbarsConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScrollbarsConstants)** |
| VB | *Style* = *object*.**Scrollbars** **As SftTreeScrollbarsConstants** |
| C#.NET | **SftTreeScrollbarsConstants** *Style* = *object*.**Scrollbars**; |
| VC++ | **enum SftTreeScrollbarsConstants** *Style* = *object*->**Scrollbars**;
**enum SftTreeScrollbarsConstants** *Style* = *object*->Get**Scrollbars**(); |
| C | **HRESULT** *object*->get_**Scrollbars**(**enum SftTreeScrollbarsConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Scrollbars** = *Style* **As SftTreeScrollbarsConstants** |
| VB | *object*.**Scrollbars** = *Style* **As SftTreeScrollbarsConstants** |
| C#.NET | **SftTreeScrollbarsConstants** *object*.**Scrollbars** = *Style*; |
| VC++ | **enum SftTreeScrollbarsConstants** *object*->**Scrollbars** = *Style*;
**void** *object*->Put**Scrollbars**(**enum SftTreeScrollbarsConstants** *Style*); |
| C | **HRESULT** *object*->put_**Scrollbars**(**enum SftTreeScrollbarsConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the presence of horizontal and vertical scroll bars.
| Style | Value | Description |
| --- | --- | --- |
| scrollSftTreeNone | 0 | No scroll bars are shown. |
| scrollSftTreeHorz | 1 | A horizontal scroll bar is shown if [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) is possible, because the horizontal extent is wider than the display area of the tree control, otherwise the horizontal scroll bar is not shown. For more information, see the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property. |
| scrollSftTreeVert | 2 | A vertical scroll bar is shown if vertical scrolling is possible, because more items are visible than fit into the display area of the tree control, otherwise the vertical scroll bar is not shown. |
| scrollSftTreeBoth | 3 | The horizontal and vertical scroll bars are shown if needed. See scrollSftTreeHorz and scrollSftTreeVert. |
| scrollSftTreeHorzDis | 4 | The horizontal scroll bar is always shown. The scroll bar is enabled if horizontal scrolling is possible, because the horizontal extent is wider than the display area of the tree control, otherwise the horizontal scroll bar is disabled. For more information, see the Items.HorizontalExtent property. |
| scrollSftTreeVertDis | 5 | The vertical scroll bar is always shown. The scroll bar is enabled if more items are visible than fit into the display area of the tree control, otherwise the vertical scroll bar is disabled. |
| scrollSftTreeBothDis | 6 | The scroll bars are always shown. The scroll bars may be enabled and disabled as described with scrollSftTreeHorzDis and scrollSftTreeVertDis. |
### Comments
The Scrollbars property defines the presence of horizontal and vertical scroll bars.
Horizontal scrolling is also [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) on the settings of the Items.HorizontalExtent property or the use of the Items.[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method.
The visual appearance of the scroll bars can be defined using the [ScrollbarStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ScrollbarStyle) property.
> This property is read/only at run-time.
See Also SftTree Object | Object Hierarchy
## ScrollbarStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ScrollbarStyle*
Defines the appearance of the scroll bars.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**ScrollbarStyle** **As [SftTreeScrollbarStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeScrollbarStyleConstants)** |
| VB | *Style* = *object*.**ScrollbarStyle** **As SftTreeScrollbarStyleConstants** |
| C#.NET | **SftTreeScrollbarStyleConstants** *Style* = *object*.**ScrollbarStyle**; |
| VC++ | **enum SftTreeScrollbarStyleConstants** *Style* = *object*->**ScrollbarStyle**;
**enum SftTreeScrollbarStyleConstants** *Style* = *object*->Get**ScrollbarStyle**(); |
| C | **HRESULT** *object*->get_**ScrollbarStyle**(**enum SftTreeScrollbarStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ScrollbarStyle** = *Style* **As SftTreeScrollbarStyleConstants** |
| VB | *object*.**ScrollbarStyle** = *Style* **As SftTreeScrollbarStyleConstants** |
| C#.NET | **SftTreeScrollbarStyleConstants** *object*.**ScrollbarStyle** = *Style*; |
| VC++ | **enum SftTreeScrollbarStyleConstants** *object*->**ScrollbarStyle** = *Style*;
**void** *object*->Put**ScrollbarStyle**(**enum SftTreeScrollbarStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**ScrollbarStyle**(**enum SftTreeScrollbarStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the appearance of the scroll bars.
| Style | Value | Description |
| --- | --- | --- |
| scrollstyleSftTreeStandard | 0 | The scroll bar is a standard scroll bar (the default appearance used by the operating system). |
| scrollstyleSftTreeFlat | 1 | The scroll bar has a flat appearance. |
| scrollstyleSftTreeFlat3D | 2 | The scroll bar has a flat appearance. The scroll bar portion where the mouse cursor is located will be displayed in a 3D fashion. |
### Comments
The ScrollbarStyle property defines the appearance of the scroll bars.
The presence of scroll bars is also [dependent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) on the settings of the [Scrollbars](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Scrollbars) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are available (even if [UseThemes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes) is set to False).
See Also SftTree Object | Object Hierarchy
## ScrollTips Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ScrollTips*
Defines whether [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) are shown.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ScrollTips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ScrollTips) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ScrollTips** **As Boolean** |
| VB | *Boolean* = *object*.**ScrollTips** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ScrollTips**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ScrollTips**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ScrollTips**(); |
| C | **HRESULT** *object*->get_**ScrollTips**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ScrollTips** = *Boolean* **As Boolean** |
| VB | *object*.**ScrollTips** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ScrollTips** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ScrollTips** = *Boolean*;
**void** *object*->Put**ScrollTips**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ScrollTips**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether Scroll Tips are shown.
| Boolean | Description |
| --- | --- |
| True | Scroll Tips are shown during vertical scrolling. |
| False | Scroll Tips are not shown during vertical scrolling. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ScrollTips instead
The Scroll Tips property defines whether Scroll Tips are shown.
If enabled, Scroll Tips are displayed when the user drags the vertical scroll bar's scroll box using the mouse. By default, the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text of the first displayed item in the client area (see Items.[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex)) is shown as a [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) next to the scroll bar. An application can override the text displayed using in the [ToolTipVScroll](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipVScroll) event.
See Also SftTree Object | Object Hierarchy
## ScrollTips Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ScrollTips*
Defines whether [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) are shown.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ScrollTips** **As Boolean** |
| VB | *Boolean* = *object*.**ScrollTips** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ScrollTips**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ScrollTips**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ScrollTips**(); |
| C | **HRESULT** *object*->get_**ScrollTips**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ScrollTips** = *Boolean* **As Boolean** |
| VB | *object*.**ScrollTips** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ScrollTips** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ScrollTips** = *Boolean*;
**void** *object*->Put**ScrollTips**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ScrollTips**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether Scroll Tips are shown.
| Boolean | Description |
| --- | --- |
| True | Scroll Tips are shown during vertical scrolling. |
| False | Scroll Tips are not shown during vertical scrolling. |
### Comments
The ScrollTips property defines whether Scroll Tips are shown.
If enabled, Scroll Tips are displayed when the user drags the vertical scroll bar's scroll box using the mouse. By default, the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text of the first displayed item in the client area (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex)) is shown as a [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) next to the scroll bar. An application can override the text displayed using in the [ToolTipVScroll](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipVScroll) event.
See Also SftTreeItems Object | Object Hierarchy
## SelCount Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelCount*
Returns the number of currently [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**SelCount** **As Integer** |
| VB | *Count* = *object*.**SelCount** **As Long** |
| C#.NET | **int** *Count* = *object*.**SelCount**; |
| VC++ | **long** *Count* = *object*->**SelCount**;
**long** *Count* = *object*->Get**SelCount**(); |
| C | **HRESULT** *object*->get_**SelCount**(**long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Returns the number of currently selected items.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionCount instead
The SelCount property returns the number of currently selected items.
The Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTree Object | Object Hierarchy
## SelectBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectBackColor*
Defines the background color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the background color used to draw selected items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectBackColor instead
The SelectBackColor property defines the background color used to draw selected items.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the SelectBackColor property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectBackColor property for only portions of the item, the Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## SelectBackColor Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s background color when the item is selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's background color when the item is selected. -1 indicates that there is no defined color and the default color defined using [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) is used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the cell's background color when the item is selected.
The cell has the background color attribute *Clr*. This color is used as background color when the item is selected. If the item is not selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColor) property is used instead.
The Cell.[SelectBackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColorEnd) property can be used to define the cell's background color, combined with SelectBackColor creating a gradient fill. The orientation of the gradient fill can be defined using the Cell.[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) property.
See Also SftTreeCell Object | Object Hierarchy
## SelectBackColor Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor*
Defines the background color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the background color of selected items in this column. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the background color of selected items in this column.
[Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the Column.SelectBackColor property for only portions of the item, the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_BackColor) property is used for the remainder of the item.
The SelectBackColor property can be used to define the default background color of cells in this column, combined with Column.[SelectBackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColorEnd) creating a gradient fill.
See Also SftTreeColumn Object | Object Hierarchy
## SelectBackColor Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectBackColor*
Defines the background color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), when it is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the background color for this column footer, when it is pressed. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the background color for this column footer, when it is pressed.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_BackColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
The color defined overrides the default color for column footers defined using [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Footer.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
See Also SftTreeFooter Object | Object Hierarchy
## SelectBackColor Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectBackColor*
Defines the background color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), when it is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the background color for this column header, when it is pressed. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the background color for this column header, when it is pressed.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).BackColor, the value -1 is saved, indicating that there is no defined color and default colors are used.
The color defined overrides the default color for column headers defined using [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_BackColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Header.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
See Also SftTreeHeader Object | Object Hierarchy
## SelectBackColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor*
Defines the background color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the background color used to draw selected items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the background color used to draw selected items.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectBackColor property for only portions of the item, the Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## SelectBackColor Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s background color when the item is selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Clr
Defines the row header's background color when the item is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the row header's background color when the item is selected.
The row header has the background color attribute *Clr*. This color is used as background color when the item is selected. If the item is not selected, the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_BackColor) property is used instead.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectBackColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. The RowHeader.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme) property can be used to override Windows themes so defined colors are used instead.
See Also SftTreeRowHeader Object | Object Hierarchy
## SelectBackColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectBackColor*
Defines the default [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) background color used to draw items that are selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColor**(); |
| C | **HRESULT** *object*->get_**SelectBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColor** = *Clr*;
**void** *object*->Put**SelectBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default row header background color used to draw items that are selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColor property defines the default row header background color used to draw items that are selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header's background color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectBackColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowHeaders Object | Object Hierarchy
## SelectBackColorEnd Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColorEnd*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s background color when the item is selected, combined with [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColorEnd**(); |
| C | **HRESULT** *object*->get_**SelectBackColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColorEnd** = *Clr*;
**void** *object*->Put**SelectBackColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's background color when the item is selected, combined with SelectBackColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColorEnd property defines the cell's background color when the item is selected, combined with SelectBackColor creating a gradient fill.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).SelectBackColor property can be used to define the cell's background color, combined with SelectBackColorEnd creating a gradient fill. The orientation of the gradient fill can be defined using the Cell.[BackColorOrientation](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_BackColorOrientation) property. If Cell.SelectBackColor is not defined, SelectBackColorEnd is ignored and has no effect.
See Also SftTreeCell Object | Object Hierarchy
## SelectBackColorEnd Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColorEnd*
Defines the background color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in this column, combined with [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) creating a gradient fill.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColorEnd** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColorEnd** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColorEnd**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColorEnd**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColorEnd**(); |
| C | **HRESULT** *object*->get_**SelectBackColorEnd**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColorEnd** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColorEnd** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColorEnd** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColorEnd** = *Clr*;
**void** *object*->Put**SelectBackColorEnd**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColorEnd**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the background color of selected items in this column, combined with SelectBackColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColorEnd property defines the background color of selected items in this column, combined with SelectBackColor creating a gradient fill.
[Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the ending background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColorEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColorEnd) property.
See Also SftTreeColumn Object | Object Hierarchy
## SelectBackColorNoFocus Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectBackColorNoFocus*
Defines the background color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the control doesn't have the input focus.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectBackColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColorNoFocus** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColorNoFocus** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**SelectBackColorNoFocus**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColorNoFocus**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColorNoFocus**(); |
| C | **HRESULT** *object*->get_**SelectBackColorNoFocus**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColorNoFocus** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**SelectBackColorNoFocus** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**SelectBackColorNoFocus** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColorNoFocus** = *Clr*;
**void** *object*->Put**SelectBackColorNoFocus**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColorNoFocus**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the background color used to draw selected items when the control doesn't have the input focus. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectBackColorNoFocus instead
The SelectBackColorNoFocus property defines the background color used to draw selected items when the control doesn't have the input focus.
This property is only used if the Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is set to [noFocusSftTreeKeepSel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants) (0). If the control has the input focus, the [SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectBackColor) property is used instead. [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectBackColorNoFocus property for only portions of the item, the [BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_BackColor) property is used for the remainder of the item.
The SelectBackColorNoFocus only applies if the Items.NoFocusStyle property is set to noFocusSftTreeKeepSel (0).
See Also SftTree Object | Object Hierarchy
## SelectBackColorNoFocus Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColorNoFocus*
Defines the background color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the control doesn't have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectBackColorNoFocus** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectBackColorNoFocus** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectBackColorNoFocus**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectBackColorNoFocus**;
**OLE_COLOR** *Clr* = *object*->Get**SelectBackColorNoFocus**(); |
| C | **HRESULT** *object*->get_**SelectBackColorNoFocus**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectBackColorNoFocus** = *Clr* **As UInteger** |
| VB | *object*.**SelectBackColorNoFocus** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectBackColorNoFocus** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectBackColorNoFocus** = *Clr*;
**void** *object*->Put**SelectBackColorNoFocus**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectBackColorNoFocus**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the background color used to draw selected items when the control doesn't have the input focus. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectBackColorNoFocus property defines the background color used to draw selected items when the control doesn't have the input focus.
This property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is set to [noFocusSftTreeKeepSel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants) (0). If the control has the input focus, the Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor) property is used instead. [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default background color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the background color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor) property. If a selected item uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectBackColorNoFocus property for only portions of the item, the Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor) property is used for the remainder of the item.
The SelectBackColorNoFocus only applies if the Items.NoFocusStyle property is set to noFocusSftTreeKeepSel (0).
See Also SftTreeItems Object | Object Hierarchy
## Selected Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Selected*
Defines whether an item is selected.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.get_**Selected**(**ByVal** *ItemIndex* **As Integer**) **As Boolean** |
| VB | *Boolean* = *object*.**Selected**(**ByVal** *ItemIndex* **As Long**) **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.get_**Selected**(**int** *ItemIndex*); |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Selected**[**long** *ItemIndex*];
**VARIANT_BOOL** *Boolean* = *object*->Get**Selected**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**Selected**(**long** *ItemIndex*, **VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.set_**Selected**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *Boolean* **As Boolean**) |
| VB | *object*.**Selected**(**ByVal** *ItemIndex* **As Long**) = *Boolean* **As Boolean** |
| C#.NET | **void** *object*.set_**Selected**(**int** *ItemIndex*, **bool** *Boolean*); |
| VC++ | **VARIANT_BOOL** *object*->**Selected**[**long** *ItemIndex*] = *Boolean*;
**void** *object*->Put**Selected**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Selected**(**long** *ItemIndex*, **VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
Boolean
Defines whether the item is selected.
| Boolean | Description |
| --- | --- |
| True | The item is selected. |
| False | The item is not selected. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Selected instead
The Selected property defines whether an item is selected.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectRange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectRange) method can be used to select a range of items at one time. Items can be selected individually using the Item.Selected property.
The Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns the index of one or more [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). The Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties are used to retrieve groups of selected items.
See Also SftTree Object | Object Hierarchy
## Selected Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected*
Defines whether the item is selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Selected** **As Boolean** |
| VB | *Boolean* = *object*.**Selected** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Selected**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Selected**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Selected**(); |
| C | **HRESULT** *object*->get_**Selected**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Selected** = *Boolean* **As Boolean** |
| VB | *object*.**Selected** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Selected** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Selected** = *Boolean*;
**void** *object*->Put**Selected**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Selected**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is selected.
| Boolean | Description |
| --- | --- |
| True | The item is selected. |
| False | The item is not selected. |
### Comments
The Selected property defines whether the item is selected.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectRange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectRange) method can be used to select a range of items at one time. Items can be selected individually using the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Selected](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Selected) property.
The Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns the index of one or more [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). The Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties are used to retrieve groups of selected items.
See Also SftTreeItem Object | Object Hierarchy
## SelectForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectForeColor*
Defines the text color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw selected items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectForeColor instead
The SelectForeColor property defines the text color used to draw selected items.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the Items.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the Items.SelectForeColor property. If a selected item uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectForeColor property for only portions of the item, the Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) property is used for the remainder of the item.
See Also SftTree Object | Object Hierarchy
## SelectForeColor Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s foreground color when the item is selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Clr
Defines the cell's foreground color when the item is selected. -1 indicates that there is no defined color and the default color defined using Column.SelectForeColor is used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the cell's foreground color when the item is selected.
The cell has the foreground color attribute *Clr*. This color is used as text color when the item is selected. If the item is not selected and uses a suitable selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)), the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ForeColor) property is used instead.
See Also SftTreeCell Object | Object Hierarchy
## SelectForeColor Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor*
Defines the text color of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Clr
Defines the text color of selected items in this column.
### Comments
The SelectForeColor property defines the text color of selected items in this column. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
[Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If a selected item uses a selection style ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) property for only portions of the item, the Column.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ForeColor) property is used for the remainder of the item.
See Also SftTreeColumn Object | Object Hierarchy
## SelectForeColor Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_SelectForeColor*
Defines the foreground color for this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters), when it is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Clr
Defines the foreground color for this column footer, when it is pressed. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the foreground color for this column footer, when it is pressed.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
The color defined overrides the default color for column footers defined using [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Footer.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_OverrideTheme) property is set accordingly.
See Also SftTreeFooter Object | Object Hierarchy
## SelectForeColor Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SelectForeColor*
Defines the foreground color for this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), when it is pressed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Clr
Defines the foreground color for this column header, when it is pressed. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the foreground color for this column header, when it is pressed.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
The color defined overrides the default color for column headers defined using [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_ForeColor). This color can also override [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes), if the Header.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_OverrideTheme) property is set accordingly.
See Also SftTreeHeader Object | Object Hierarchy
## SelectForeColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor*
Defines the text color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the text color used to draw selected items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the text color used to draw selected items.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the Items.SelectForeColor property. If a selected item uses a selection style (Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property) that uses the SelectForeColor property for only portions of the item, the Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor) property is used for the remainder of the item.
See Also SftTreeItems Object | Object Hierarchy
## SelectForeColor Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s foreground color when the item is selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Clr
Defines the row header's foreground color when the item is selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the row header's foreground color when the item is selected.
The row header has the foreground color attribute *Clr*. This color is used as foreground color when the item is selected. If the item is not selected, the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_ForeColor) property is used instead.
When updating this property and the specified color *Clr* is the same value as the color currently defined using [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectForeColor), the value -1 is saved, indicating that there is no defined color and default colors are used.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used. The RowHeader.[OverrideTheme](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_OverrideTheme) property can be used to override Windows themes so defined colors are used instead.
See Also SftTreeRowHeader Object | Object Hierarchy
## SelectForeColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_SelectForeColor*
Defines the default [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) text color used to draw items that are selected.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColor**(); |
| C | **HRESULT** *object*->get_**SelectForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColor** = *Clr*;
**void** *object*->Put**SelectForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default row header text color used to draw items that are selected. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColor property defines the default row header text color used to draw items that are selected.
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) can override the row header's foreground color using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_SelectForeColor) property.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowHeaders Object | Object Hierarchy
## SelectForeColorNoFocus Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectForeColorNoFocus*
Defines the text color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the control doesn't have the input focus.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectForeColorNoFocus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColorNoFocus** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColorNoFocus** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**SelectForeColorNoFocus**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColorNoFocus**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColorNoFocus**(); |
| C | **HRESULT** *object*->get_**SelectForeColorNoFocus**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColorNoFocus** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**SelectForeColorNoFocus** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**SelectForeColorNoFocus** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColorNoFocus** = *Clr*;
**void** *object*->Put**SelectForeColorNoFocus**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColorNoFocus**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw selected items when the control doesn't have the input focus. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectForeColorNoFocus instead
The SelectForeColorNoFocus property defines the text color used to draw selected items when the control doesn't have the input focus.
This property is only used if the Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is set to [noFocusSftTreeKeepSel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants) (0). [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the Items.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the SelectForeColorNoFocus property.
The SelectForeColorNoFocus only applies if the Items.NoFocusStyle property is set to noFocusSftTreeKeepSel (0).
See Also SftTree Object | Object Hierarchy
## SelectForeColorNoFocus Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColorNoFocus*
Defines the text color used to draw [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the control doesn't have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectForeColorNoFocus** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectForeColorNoFocus** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectForeColorNoFocus**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectForeColorNoFocus**;
**OLE_COLOR** *Clr* = *object*->Get**SelectForeColorNoFocus**(); |
| C | **HRESULT** *object*->get_**SelectForeColorNoFocus**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectForeColorNoFocus** = *Clr* **As UInteger** |
| VB | *object*.**SelectForeColorNoFocus** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectForeColorNoFocus** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectForeColorNoFocus** = *Clr*;
**void** *object*->Put**SelectForeColorNoFocus**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectForeColorNoFocus**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the text color used to draw selected items when the control doesn't have the input focus. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The SelectForeColorNoFocus property defines the text color used to draw selected items when the control doesn't have the input focus.
This property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is set to [noFocusSftTreeKeepSel](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeNoFocusStyleConstants) (0). [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) can override the default foreground color using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor) property. [Cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can override the foreground color using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) property. If an item is disabled ([Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Enabled](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Enabled) property), the Items.[GrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GrayedColor) property is used instead of the SelectForeColorNoFocus property.
The SelectForeColorNoFocus only applies if the Items.NoFocusStyle property is set to noFocusSftTreeKeepSel (0).
See Also SftTreeItems Object | Object Hierarchy
## SelectHotInnerBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerBorderColor*
Defines the inner border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectHotInnerBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectHotInnerBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectHotInnerBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectHotInnerBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectHotInnerBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectHotInnerBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectHotInnerBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectHotInnerBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectHotInnerBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectHotInnerBorderColor** = *Clr*;
**void** *object*->Put**SelectHotInnerBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectHotInnerBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the inner border color for selected items when the mouse cursor is on the item.
### Comments
The SelectHotInnerBorderColor property defines the inner border color for selected items when the mouse cursor is on the item.
The SelectHotInnerBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectHotInnerFill1 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill1*
Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectHotInnerFill1** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectHotInnerFill1** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectHotInnerFill1**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectHotInnerFill1**;
**OLE_COLOR** *Clr* = *object*->Get**SelectHotInnerFill1**(); |
| C | **HRESULT** *object*->get_**SelectHotInnerFill1**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectHotInnerFill1** = *Clr* **As UInteger** |
| VB | *object*.**SelectHotInnerFill1** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectHotInnerFill1** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectHotInnerFill1** = *Clr*;
**void** *object*->Put**SelectHotInnerFill1**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectHotInnerFill1**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the starting color used to fill the selection outline for selected items when the mouse cursor is on the item.
### Comments
The SelectHotInnerFill1 property defines the starting color used to fill the selection outline for selected items when the mouse cursor is on the item.
The SelectHotInnerFill1 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectHotInnerFill2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotInnerFill2*
Defines the ending color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectHotInnerFill2** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectHotInnerFill2** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectHotInnerFill2**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectHotInnerFill2**;
**OLE_COLOR** *Clr* = *object*->Get**SelectHotInnerFill2**(); |
| C | **HRESULT** *object*->get_**SelectHotInnerFill2**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectHotInnerFill2** = *Clr* **As UInteger** |
| VB | *object*.**SelectHotInnerFill2** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectHotInnerFill2** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectHotInnerFill2** = *Clr*;
**void** *object*->Put**SelectHotInnerFill2**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectHotInnerFill2**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the ending color used to fill the selection outline for selected items when the mouse cursor is on the item.
### Comments
The SelectHotInnerFill2 property defines the ending color used to fill the selection outline for selected items when the mouse cursor is on the item.
The SelectHotInnerFill2 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectHotOutlineBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectHotOutlineBorderColor*
Defines the outline border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the mouse cursor is on the item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectHotOutlineBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectHotOutlineBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectHotOutlineBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectHotOutlineBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectHotOutlineBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectHotOutlineBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectHotOutlineBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectHotOutlineBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectHotOutlineBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectHotOutlineBorderColor** = *Clr*;
**void** *object*->Put**SelectHotOutlineBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectHotOutlineBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the outline border color for selected items when the mouse cursor is on the item.
### Comments
The SelectHotOutlineBorderColor property defines the outline border color for selected items when the mouse cursor is on the item.
The SelectHotOutlineBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in the first displayed column is shown underlined instead.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectInnerBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerBorderColor*
Defines the inner border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectInnerBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectInnerBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectInnerBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectInnerBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectInnerBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectInnerBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectInnerBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectInnerBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectInnerBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectInnerBorderColor** = *Clr*;
**void** *object*->Put**SelectInnerBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectInnerBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the inner border color for selected items.
### Comments
The SelectInnerBorderColor property defines the inner border color for selected items.
The SelectInnerBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectInnerFill1 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill1*
Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectInnerFill1** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectInnerFill1** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectInnerFill1**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectInnerFill1**;
**OLE_COLOR** *Clr* = *object*->Get**SelectInnerFill1**(); |
| C | **HRESULT** *object*->get_**SelectInnerFill1**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectInnerFill1** = *Clr* **As UInteger** |
| VB | *object*.**SelectInnerFill1** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectInnerFill1** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectInnerFill1** = *Clr*;
**void** *object*->Put**SelectInnerFill1**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectInnerFill1**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the starting color used to fill the selection outline for selected items.
### Comments
The SelectInnerFill1 property defines the starting color used to fill the selection outline for selected items.
The SelectInnerFill1 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectInnerFill2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectInnerFill2*
Defines the ending color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectInnerFill2** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectInnerFill2** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectInnerFill2**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectInnerFill2**;
**OLE_COLOR** *Clr* = *object*->Get**SelectInnerFill2**(); |
| C | **HRESULT** *object*->get_**SelectInnerFill2**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectInnerFill2** = *Clr* **As UInteger** |
| VB | *object*.**SelectInnerFill2** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectInnerFill2** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectInnerFill2** = *Clr*;
**void** *object*->Put**SelectInnerFill2**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectInnerFill2**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the ending color used to fill the selection outline for selected items.
### Comments
The SelectInnerFill2 property defines the ending color used to fill the selection outline for selected items.
The SelectInnerFill2 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## Selection Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection*
Returns the [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**Selection**(**ByVal** *SelectionIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**Selection**(**ByVal** *SelectionIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**Selection**(**int** *SelectionIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**Selection**(**long** *SelectionIndex*); |
| C | **HRESULT** *object*->raw_**Selection**(**long** *SelectionIndex*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
SelectionIndex
The entry number of the selected item index to return.
ItemIndex
Returns the item index of the *n*th selected item as specified by *SelectionIndex*. -1 is returned if no item is selected.
### Comments
The Selection method returns the selected item.
The Selection property returns the zero-based index of the *n*th selected item as specified by *SelectionIndex*. In a single selection tree control (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property), *SelectionIndex* is specified as 0. The first (and only) selected item is returned or -1 if no item is selected.
In a multiple selection tree control, the index of all selected items can be retrieved. The Items.[SelectionCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount) property returns the number of selected items. The Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties are used to retrieve groups of selected items.
See Also SftTreeItems Object | Object Hierarchy
## SelectionArea Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionArea*
Defines the area where selection changes occur.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Area* = *object*.**SelectionArea** **As [SftTreeSelectionAreaConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectionAreaConstants)** |
| VB | *Area* = *object*.**SelectionArea** **As SftTreeSelectionAreaConstants** |
| C#.NET | **SftTreeSelectionAreaConstants** *Area* = *object*.**SelectionArea**; |
| VC++ | **enum SftTreeSelectionAreaConstants** *Area* = *object*->**SelectionArea**;
**enum SftTreeSelectionAreaConstants** *Area* = *object*->Get**SelectionArea**(); |
| C | **HRESULT** *object*->get_**SelectionArea**(**enum SftTreeSelectionAreaConstants*** *Area*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectionArea** = *Area* **As SftTreeSelectionAreaConstants** |
| VB | *object*.**SelectionArea** = *Area* **As SftTreeSelectionAreaConstants** |
| C#.NET | **SftTreeSelectionAreaConstants** *object*.**SelectionArea** = *Area*; |
| VC++ | **enum SftTreeSelectionAreaConstants** *object*->**SelectionArea** = *Area*;
**void** *object*->Put**SelectionArea**(**enum SftTreeSelectionAreaConstants** *Area*); |
| C | **HRESULT** *object*->put_**SelectionArea**(**enum SftTreeSelectionAreaConstants** *Area*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Area
Defines the area where selection changes occur.
| Area | Value | Description |
| --- | --- | --- |
| selSftTreeAll | 0 | Clicking anywhere on an item (all [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), tree lines, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), etc.) will change the selection. |
| selSftTreeCells | 1 | Clicking on any cell of an item will change the selection. |
| selSftTreeCell1 | 2 | Clicking on the cell in the first column will change the selection. |
| selSftTreeCellText1 | 3 | Clicking on the cell text in the first column will change the selection. |
| selSftTreeCellsRow | 4 | Clicking on the row header or any cell of an item will change the selection. |
| selSftTreeCell1Row | 5 | Clicking on the row header or the cell in the first column will change the selection. |
| selSftTreeCellText1Row | 6 | Clicking on the row header or the cell text in the first column will change the selection. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionArea instead
The SelectionArea property defines the area where selection changes occur.
The [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) event occurs every time a selection change takes place.
By using the SelectionArea property, the application can specify which areas of an item can cause a selection change when clicked. If the defined area is clicked, the selection changes (Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection)). If an area of the item outside the defined area is clicked, only the current item (Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current)) is changed.
When using a limited area, such as selSftTreeCellText1, which only changes [selections](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the cell text is clicked, it is preferable to visually indicate this using the selection style [selectSftTreeCell1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants) (see Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)).
In a multiple selection tree control, the CONTROL key (in combination with directional keys) can be used to move the caret location without moving the current selection, unless the style selSftTreeAll is used, in which case the CONTROL key is ignored.
See Also SftTree Object | Object Hierarchy
## SelectionArea Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea*
Defines the area where selection changes occur.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Area* = *object*.**SelectionArea** **As [SftTreeSelectionAreaConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectionAreaConstants)** |
| VB | *Area* = *object*.**SelectionArea** **As SftTreeSelectionAreaConstants** |
| C#.NET | **SftTreeSelectionAreaConstants** *Area* = *object*.**SelectionArea**; |
| VC++ | **enum SftTreeSelectionAreaConstants** *Area* = *object*->**SelectionArea**;
**enum SftTreeSelectionAreaConstants** *Area* = *object*->Get**SelectionArea**(); |
| C | **HRESULT** *object*->get_**SelectionArea**(**enum SftTreeSelectionAreaConstants*** *Area*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectionArea** = *Area* **As SftTreeSelectionAreaConstants** |
| VB | *object*.**SelectionArea** = *Area* **As SftTreeSelectionAreaConstants** |
| C#.NET | **SftTreeSelectionAreaConstants** *object*.**SelectionArea** = *Area*; |
| VC++ | **enum SftTreeSelectionAreaConstants** *object*->**SelectionArea** = *Area*;
**void** *object*->Put**SelectionArea**(**enum SftTreeSelectionAreaConstants** *Area*); |
| C | **HRESULT** *object*->put_**SelectionArea**(**enum SftTreeSelectionAreaConstants** *Area*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Area
Defines the area where selection changes occur.
| Area | Value | Description |
| --- | --- | --- |
| selSftTreeAll | 0 | Clicking anywhere on an item (all [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), tree lines, [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders), etc.) will change the selection. |
| selSftTreeCells | 1 | Clicking on any cell of an item will change the selection. |
| selSftTreeCell1 | 2 | Clicking on the cell in the first column will change the selection. |
| selSftTreeCellText1 | 3 | Clicking on the cell text in the first column will change the selection. |
| selSftTreeCellsRow | 4 | Clicking on the row header or any cell of an item will change the selection. |
| selSftTreeCell1Row | 5 | Clicking on the row header or the cell in the first column will change the selection. |
| selSftTreeCellText1Row | 6 | Clicking on the row header or the cell text in the first column will change the selection. |
### Comments
The SelectionArea property defines the area where selection changes occur.
The [SelectionChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange) event occurs every time a selection change takes place.
By using the SelectionArea property, the application can specify which areas of an item can cause a selection change when clicked. If the defined area is clicked, the selection changes ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection)). If an area of the item outside the defined area is clicked, only the current item (Items.[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current)) is changed. In addition, the Items.[UpdateCurrentExpandCollapse](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_UpdateCurrentExpandCollapse) defines whether the current item (Items.Current) is updated when the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) is clicked.
When using a limited area, such as selSftTreeCellText1, which only changes [selections](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the cell text is clicked, it is preferable to visually indicate this using the selection style [selectSftTreeCell1](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants) (see Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle)).
In a multiple selection tree control, the CONTROL key (in combination with directional keys) can be used to move the caret location without moving the current selection, unless the style selSftTreeAll is used, in which case the CONTROL key is ignored.
See Also SftTreeItems Object | Object Hierarchy
## SelectionChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SelectionChange*
The selection changes.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**SelectionChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**SelectionChange** |
| VB | **Private Sub** *object*_**SelectionChange**() |
| C#.NET | **void** *object*_**SelectionChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**SelectionChange***object*(); |
| C | **HRESULT** On**SelectionChange***object*(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
The SelectionChange event occurs when the selection changes.
The SelectionChange event is not limited to mouse events as the selection can change through keyboard input also. To determine which mouse button was pressed and/or in which area of the tree control the mouse button was pressed, use the [MouseDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_MouseDown) or [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) events.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) property can be used to control the areas that cause a selection change.
See Also SftTree Object | Object Hierarchy
## SelectionCount Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionCount*
Returns the number of currently [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**SelectionCount** **As Integer** |
| VB | *Count* = *object*.**SelectionCount** **As Long** |
| C#.NET | **int** *Count* = *object*.**SelectionCount**; |
| VC++ | **long** *Count* = *object*->**SelectionCount**;
**long** *Count* = *object*->Get**SelectionCount**(); |
| C | **HRESULT** *object*->get_**SelectionCount**(**long*** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Returns the number of currently selected items.
### Comments
The SelectionCount property returns the number of currently selected items.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTreeItems Object | Object Hierarchy
## SelectionGroupEnd Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroupEnd*
Returns the index of the last [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in a group of selected items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**SelectionGroupEnd**(**ByVal** *GroupIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**SelectionGroupEnd**(**ByVal** *GroupIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**SelectionGroupEnd**(**int** *GroupIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**SelectionGroupEnd**(**long** *GroupIndex*); |
| C | **HRESULT** *object*->raw_**SelectionGroupEnd**(**long** *GroupIndex*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
GroupIndex
The zero-based group number for which the last selected item is to be retrieved.
ItemIndex
Returns the index of the last selected item in a group of selected items.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionGroupEnd instead
The SelectionGroupEnd method returns the index of the last selected item in a group of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.SelectionGroupEnd properties return each group of selected items. For a large number of selected items this is the preferred method.
The Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTree Object | Object Hierarchy
## SelectionGroupEnd Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd*
Returns the index of the last [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in a group of selected items.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**SelectionGroupEnd**(**ByVal** *GroupIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**SelectionGroupEnd**(**ByVal** *GroupIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**SelectionGroupEnd**(**int** *GroupIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**SelectionGroupEnd**(**long** *GroupIndex*); |
| C | **HRESULT** *object*->raw_**SelectionGroupEnd**(**long** *GroupIndex*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
GroupIndex
The zero-based group number for which the last selected item is to be retrieved.
ItemIndex
Returns the index of the last selected item in a group of selected items.
### Comments
The SelectionGroupEnd method returns the index of the last selected item in a group of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and SelectionGroupEnd properties return each group of selected items. For a large number of selected items this is the preferred method.
The Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTreeItems Object | Object Hierarchy
## SelectionGroups Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroups*
Returns the number of groups of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**SelectionGroups** **As Integer** |
| VB | *Count* = *object*.**SelectionGroups** **As Long** |
| C#.NET | **int** *Count* = *object*.**SelectionGroups**; |
| VC++ | **long** *Count* = *object*->**SelectionGroups**;
**long** *Count* = *object*->Get**SelectionGroups**(); |
| C | **HRESULT** *object*->get_**SelectionGroups**(**long*** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Returns the number of groups of selected items.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionGroups instead
The SelectionGroups property returns the number of groups of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties return each group of selected items. For a large number of selected items this is the preferred method.
See Also SftTree Object | Object Hierarchy
## SelectionGroups Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups*
Returns the number of groups of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**SelectionGroups** **As Integer** |
| VB | *Count* = *object*.**SelectionGroups** **As Long** |
| C#.NET | **int** *Count* = *object*.**SelectionGroups**; |
| VC++ | **long** *Count* = *object*->**SelectionGroups**;
**long** *Count* = *object*->Get**SelectionGroups**(); |
| C | **HRESULT** *object*->get_**SelectionGroups**(**long*** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Returns the number of groups of selected items.
### Comments
The SelectionGroups property returns the number of groups of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the Items.[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties return each group of selected items. For a large number of selected items this is the preferred method.
See Also SftTreeItems Object | Object Hierarchy
## SelectionGroupStart Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectionGroupStart*
Returns the index of the first [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in a group of selected items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectionGroupStart](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**SelectionGroupStart**(**ByVal** *GroupIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**SelectionGroupStart**(**ByVal** *GroupIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**SelectionGroupStart**(**int** *GroupIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**SelectionGroupStart**(**long** *GroupIndex*); |
| C | **HRESULT** *object*->raw_**SelectionGroupStart**(**long** *GroupIndex*, **long*** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
GroupIndex
The zero-based group number for which the first selected item is to be retrieved.
ItemIndex
Returns the index of the first selected item in a group of selected items.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectionGroupStart instead
The SelectionGroupStart method returns the index of the first selected item in a group of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the Items.[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the Items.SelectionGroupStart and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties return each group of selected items. For a large number of selected items this is the preferred method.
The Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTree Object | Object Hierarchy
## SelectionGroupStart Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupStart*
Returns the index of the first [selected item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) in a group of selected items.
### Syntax
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**SelectionGroupStart**(**ByVal** *GroupIndex* **As Integer**) **As Integer** |
| VB | *ItemIndex* = *object*.**SelectionGroupStart**(**ByVal** *GroupIndex* **As Long**) **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**SelectionGroupStart**(**int** *GroupIndex*); |
| VC++ | **long** *ItemIndex* = *object*->**SelectionGroupStart**(**long** *GroupIndex*); |
| C | **HRESULT** *object*->raw_**SelectionGroupStart**(**long** *GroupIndex*, **long*** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
GroupIndex
The zero-based group number for which the first selected item is to be retrieved.
ItemIndex
Returns the index of the first selected item in a group of selected items.
### Comments
The SelectionGroupStart method returns the index of the first selected item in a group of selected items.
In a multiple selection tree control, many discontiguous groups of items may be selected. While the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Selection) property returns an index for each selected item, the SelectionGroupStart and Items.[SelectionGroupEnd](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroupEnd) properties return each group of selected items. For a large number of selected items this is the preferred method.
The Items.[SelectionGroups](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionGroups) property returns the number of groups of selected items.
See Also SftTreeItems Object | Object Hierarchy
## SelectNoFocusInnerBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerBorderColor*
Defines the inner border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectNoFocusInnerBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectNoFocusInnerBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectNoFocusInnerBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectNoFocusInnerBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectNoFocusInnerBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectNoFocusInnerBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectNoFocusInnerBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectNoFocusInnerBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectNoFocusInnerBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectNoFocusInnerBorderColor** = *Clr*;
**void** *object*->Put**SelectNoFocusInnerBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectNoFocusInnerBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the inner border color for selected items when the tree control does not have the input focus.
### Comments
The SelectNoFocusInnerBorderColor property defines the inner border color for selected items when the tree control does not have the input focus.
The SelectNoFocusInnerBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectNoFocusInnerFill1 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill1*
Defines the starting color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectNoFocusInnerFill1** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectNoFocusInnerFill1** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectNoFocusInnerFill1**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectNoFocusInnerFill1**;
**OLE_COLOR** *Clr* = *object*->Get**SelectNoFocusInnerFill1**(); |
| C | **HRESULT** *object*->get_**SelectNoFocusInnerFill1**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectNoFocusInnerFill1** = *Clr* **As UInteger** |
| VB | *object*.**SelectNoFocusInnerFill1** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectNoFocusInnerFill1** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectNoFocusInnerFill1** = *Clr*;
**void** *object*->Put**SelectNoFocusInnerFill1**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectNoFocusInnerFill1**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the starting color used to fill the selection outline for selected items when the tree control does not have the input focus.
### Comments
The SelectNoFocusInnerFill1 property defines the starting color used to fill the selection outline for selected items when the tree control does not have the input focus.
The SelectNoFocusInnerFill1 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectNoFocusInnerFill2 Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusInnerFill2*
Defines the ending color used to fill the [selection outline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectNoFocusInnerFill2** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectNoFocusInnerFill2** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectNoFocusInnerFill2**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectNoFocusInnerFill2**;
**OLE_COLOR** *Clr* = *object*->Get**SelectNoFocusInnerFill2**(); |
| C | **HRESULT** *object*->get_**SelectNoFocusInnerFill2**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectNoFocusInnerFill2** = *Clr* **As UInteger** |
| VB | *object*.**SelectNoFocusInnerFill2** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectNoFocusInnerFill2** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectNoFocusInnerFill2** = *Clr*;
**void** *object*->Put**SelectNoFocusInnerFill2**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectNoFocusInnerFill2**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the ending color used to fill the selection outline for selected items when the tree control does not have the input focus.
### Comments
The SelectNoFocusInnerFill2 property defines the ending color used to fill the selection outline for selected items when the tree control does not have the input focus.
The SelectNoFocusInnerFill2 property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).OutlineStyle property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectNoFocusOutlineBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectNoFocusOutlineBorderColor*
Defines the outline border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control does not have the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectNoFocusOutlineBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectNoFocusOutlineBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectNoFocusOutlineBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectNoFocusOutlineBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectNoFocusOutlineBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectNoFocusOutlineBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectNoFocusOutlineBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectNoFocusOutlineBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectNoFocusOutlineBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectNoFocusOutlineBorderColor** = *Clr*;
**void** *object*->Put**SelectNoFocusOutlineBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectNoFocusOutlineBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the outline border color for selected items when the tree control does not have the input focus.
### Comments
The SelectNoFocusOutlineBorderColor property defines the outline border color for selected items when the tree control does not have the input focus.
The SelectNoFocusOutlineBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectOutlineBorderColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectOutlineBorderColor*
Defines the outline border color for [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**SelectOutlineBorderColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**SelectOutlineBorderColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**SelectOutlineBorderColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**SelectOutlineBorderColor**;
**OLE_COLOR** *Clr* = *object*->Get**SelectOutlineBorderColor**(); |
| C | **HRESULT** *object*->get_**SelectOutlineBorderColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectOutlineBorderColor** = *Clr* **As UInteger** |
| VB | *object*.**SelectOutlineBorderColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**SelectOutlineBorderColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**SelectOutlineBorderColor** = *Clr*;
**void** *object*->Put**SelectOutlineBorderColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**SelectOutlineBorderColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the outline border color for selected items.
### Comments
The SelectOutlineBorderColor property defines the outline border color for selected items.
The SelectOutlineBorderColor property is only used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property is set to [OutlineStyleSftTreeRectGradient](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeOutlineStyleConstants). Otherwise, it is ignored and the colors depending on the Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) property settings are used.
The Items.SelectStyle and Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) properties work in conjunction with the Items.OutlineStyle property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
See Also SftTreeItems Object | Object Hierarchy
## SelectRange Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectRange*
Selects or deselects a range of items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectRange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectRange) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SelectRange**(**ByVal** *IndexStart* **As Integer**, **ByVal** *IndexEnd* **As Integer**, **ByVal** *Status* **As Boolean**) |
| VB | *object*.**SelectRange**(**ByVal** *IndexStart* **As Long**, **ByVal** *IndexEnd* **As Long**, **ByVal** *Status* **As Boolean**) |
| C#.NET | **void** *object*.**SelectRange**(**int** *IndexStart*, **int** *IndexEnd*, **bool** *Status*); |
| VC++ | **HRESULT** *object*->**SelectRange**(**long** *IndexStart*, **long** *IndexEnd*, **VARIANT_BOOL** *Status*); |
| C | **HRESULT** *object*->raw_**SelectRange**(**long** *IndexStart*, **long** *IndexEnd*, **VARIANT_BOOL** *Status*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
IndexStart
The zero-based index of the first item to be de-/selected.
IndexEnd
The zero-based index of the last item to be de-/selected. *IndexEnd* must be greater or equal to *IndexStart*.
Status
Set to True to select the items, False to deselect them.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectRange instead
The SelectRange method selects or deselects a range of items.
The SelectRange method can only be used if the Items.[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property is set to [selectSftTreeMulti](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMultiSelectConstants), indicating that [multiple selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is supported.
See Also SftTree Object | Object Hierarchy
## SelectRange Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectRange*
Selects or deselects a range of items.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SelectRange**(**ByVal** *IndexStart* **As Integer**, **ByVal** *IndexEnd* **As Integer**, **ByVal** *Status* **As Boolean**) |
| VB | *object*.**SelectRange**(**ByVal** *IndexStart* **As Long**, **ByVal** *IndexEnd* **As Long**, **ByVal** *Status* **As Boolean**) |
| C#.NET | **void** *object*.**SelectRange**(**int** *IndexStart*, **int** *IndexEnd*, **bool** *Status*); |
| VC++ | **HRESULT** *object*->**SelectRange**(**long** *IndexStart*, **long** *IndexEnd*, **VARIANT_BOOL** *Status*); |
| C | **HRESULT** *object*->raw_**SelectRange**(**long** *IndexStart*, **long** *IndexEnd*, **VARIANT_BOOL** *Status*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
IndexStart
The zero-based index of the first item to be de-/selected.
IndexEnd
The zero-based index of the last item to be de-/selected. *IndexEnd* must be greater or equal to *IndexStart*.
Status
Set to True to select the items, False to deselect them.
### Comments
The SelectRange method selects or deselects a range of items.
The SelectRange method can only be used if the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[MultiSelect](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_MultiSelect) property is set to [selectSftTreeMulti](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeMultiSelectConstants), indicating that [multiple selection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) is supported.
See Also SftTreeItems Object | Object Hierarchy
## SelectStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SelectStyle*
Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control has the input focus.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**SelectStyle** **As [SftTreeSelectStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants)** |
| VB | *Style* = *object*.**SelectStyle** **As SftTreeSelectStyleConstants** |
| C#.NET | **SftTreeSelectStyleConstants** *Style* = *object*.**SelectStyle**; |
| VC++ | **enum SftTreeSelectStyleConstants** *Style* = *object*->**SelectStyle**;
**enum SftTreeSelectStyleConstants** *Style* = *object*->Get**SelectStyle**(); |
| C | **HRESULT** *object*->get_**SelectStyle**(**enum SftTreeSelectStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectStyle** = *Style* **As SftTreeSelectStyleConstants** |
| VB | *object*.**SelectStyle** = *Style* **As SftTreeSelectStyleConstants** |
| C#.NET | **SftTreeSelectStyleConstants** *object*.**SelectStyle** = *Style*; |
| VC++ | **enum SftTreeSelectStyleConstants** *object*->**SelectStyle** = *Style*;
**void** *object*->Put**SelectStyle**(**enum SftTreeSelectStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**SelectStyle**(**enum SftTreeSelectStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the display style of selected items when the tree control has the input focus.
| Style | Value | Description |
| --- | --- | --- |
| selectSftTreeAll | 0 | The entire item is highlighted. A selected item is drawn using the colors specified using the color properties Items.[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor), Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor), [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor), Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) and Cell.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor). |
| selectSftTreeText | 1 | Only [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are highlighted. A selected item is drawn using the colors specified using the color properties Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor), Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor), Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. |
| selectSftTreeCell1 | 2 | Only the first displayed cell is highlighted. The first displayed cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. The text's background color extends a few pixels around the text, not necessarily to the top and bottom of the cell. |
| selectSftTreeCellCurrent | 3 | Highlights the entire current cell only. The current cell is always the cell in the first displayed column of the selected item(s). The current cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. |
| selectSftTreeCell1Full | 4 | Only the first displayed cell is highlighted. The first displayed cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. The text's background color extends to the top and bottom of the cell. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SelectStyle instead
The SelectStyle property defines the display style of selected items when the tree control has the input focus.
The Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is used to change the appearance of selected items in a tree control that does not have the input focus.
The Items.[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) property defines the area where selection changes occur.
See Also SftTree Object | Object Hierarchy
## SelectStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle*
Defines the display style of [selected items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) when the tree control has the input focus.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**SelectStyle** **As [SftTreeSelectStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSelectStyleConstants)** |
| VB | *Style* = *object*.**SelectStyle** **As SftTreeSelectStyleConstants** |
| C#.NET | **SftTreeSelectStyleConstants** *Style* = *object*.**SelectStyle**; |
| VC++ | **enum SftTreeSelectStyleConstants** *Style* = *object*->**SelectStyle**;
**enum SftTreeSelectStyleConstants** *Style* = *object*->Get**SelectStyle**(); |
| C | **HRESULT** *object*->get_**SelectStyle**(**enum SftTreeSelectStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SelectStyle** = *Style* **As SftTreeSelectStyleConstants** |
| VB | *object*.**SelectStyle** = *Style* **As SftTreeSelectStyleConstants** |
| C#.NET | **SftTreeSelectStyleConstants** *object*.**SelectStyle** = *Style*; |
| VC++ | **enum SftTreeSelectStyleConstants** *object*->**SelectStyle** = *Style*;
**void** *object*->Put**SelectStyle**(**enum SftTreeSelectStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**SelectStyle**(**enum SftTreeSelectStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the display style of selected items when the tree control has the input focus.
| Style | Value | Description |
| --- | --- | --- |
| selectSftTreeAll | 0 | The entire item is highlighted. A selected item is drawn using the colors specified using the color properties [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectForeColor), Items.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectBackColor), [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectForeColor), Column.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_SelectBackColor), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[SelectForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectForeColor) and Cell.[SelectBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_SelectBackColor). |
| selectSftTreeText | 1 | Only [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) are highlighted. A selected item is drawn using the colors specified using the color properties Items.[ForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ForeColor), Items.[BackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_BackColor), Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. |
| selectSftTreeCell1 | 2 | Only the first displayed cell is highlighted. The first displayed cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. The text's background color extends a few pixels around the text, not necessarily to the top and bottom of the cell. |
| selectSftTreeCellCurrent | 3 | Highlights the entire current cell only. The current cell is always the cell in the first displayed column of the selected item(s). The current cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. |
| selectSftTreeCell1Full | 4 | Only the first displayed cell is highlighted. The first displayed cell is drawn using the colors specified using the color properties Items.SelectForeColor, Items.SelectBackColor, Column.SelectForeColor, Column.SelectBackColor, Cell.SelectForeColor and Cell.SelectBackColor. The text's background color extends to the top and bottom of the cell. |
### Comments
The SelectStyle property defines the display style of selected items when the tree control has the input focus.
The Items.[NoFocusStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_NoFocusStyle) property is used to change the appearance of selected items in a tree control that does not have the input focus.
The Items.[SelectStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectStyle) and Items.NoFocusStyle properties work in conjunction with the Items.[OutlineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_OutlineStyle) property to determine the exact appearance of selected items. The highlighted portion of an item is rendered using the outline style defined by the Items.OutlineStyle property.
The Items.[SelectionArea](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SelectionArea) property defines the area where selection changes occur.
See Also SftTreeItems Object | Object Hierarchy
## SetCellColorSample Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellColorSample*
Defines the color sample displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[SetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetCellColorSample**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByVal** *FrameClr* **As System.Drawing.Color**, **ByVal** *WidthPix* **As Short**, **ByVal** *HeightPix* **As Short**) |
| VB | *object*.**SetCellColorSample**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *Clr* **As OLE_COLOR**, **ByVal** *FrameClr* **As OLE_COLOR**, **ByVal** *WidthPix* **As Integer**, **ByVal** *HeightPix* **As Integer**) |
| C#.NET | **void** *object*.**SetCellColorSample**(**int** *ItemIndex*, **short** *ColIndex*, **System.Drawing.Color** *Clr*, **System.Drawing.Color** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
| VC++ | **HRESULT** *object*->**SetCellColorSample**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*, **OLE_COLOR** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
| C | **HRESULT** *object*->raw_**SetCellColorSample**(**long** *ItemIndex*, **short** *ColIndex*, **OLE_COLOR** *Clr*, **OLE_COLOR** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Clr
Defines the color sample displayed as the item's cell graphic. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
FrameClr
Defines the color value used to outline the color sample rectangle. If -1 is used, no outline is drawn. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".
WidthPix
The width of the color sample rectangle in pixels.
HeightPix
The height of the color sample rectangle in pixels.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.SetColorSample instead
The SetCellColorSample method defines the color sample displayed as an item's cell graphic.
The SetCellColorSample method is used to define a cell's optional graphic component to display a color sample rectangle. The settings can be retrieved using the [GetCellColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellColorSample) method.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as Cell.Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as Cell.Image property are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearCellImages method can be used to remove all cell graphics. The * WidthPix* and * HeightPix* parameters can be set to the value 0, which removes the graphic from the cell.
The position of the cell graphics relative to the cell text is determined by the Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTree Object | Object Hierarchy
## SetCellColorSample Method, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetCellColorSample*
Defines the color sample displayed as the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[SetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetCellColorSample**(**ByVal** *ColIndex* **As Short**, **ByVal** *Clr* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByVal** *FrameClr* **As UInteger**, **ByVal** *WidthPix* **As Short**, **ByVal** *HeightPix* **As Short**) |
| VB | *object*.**SetCellColorSample**(**ByVal** *ColIndex* **As Integer**, **ByVal** *Clr* **As OLE_COLOR**, **ByVal** *FrameClr* **As OLE_COLOR**, **ByVal** *WidthPix* **As Integer**, **ByVal** *HeightPix* **As Integer**) |
| C#.NET | **void** *object*.**SetCellColorSample**(**short** *ColIndex*, **uint** *Clr*, **uint** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
| VC++ | **HRESULT** *object*->**SetCellColorSample**(**short** *ColIndex*, **OLE_COLOR** *Clr*, **OLE_COLOR** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
| C | **HRESULT** *object*->raw_**SetCellColorSample**(**short** *ColIndex*, **OLE_COLOR** *Clr*, **OLE_COLOR** *FrameClr*, **short** *WidthPix*, **short** *HeightPix*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
Clr
Defines the color sample displayed as the item's cell graphic.
FrameClr
Defines the color value used to outline the color sample rectangle. If -1 is used, no outline is drawn. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
WidthPix
The width of the color sample rectangle in pixels.
HeightPix
The height of the color sample rectangle in pixels.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Image.SetColorSample instead
The SetCellColorSample method defines the color sample displayed as the item's cell graphic.
The VirtualItem.SetCellColorSample property is used while handling a VirtualItem event to define the color sample displayed as the item's cell graphic. The item is described by the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## SetCellEditSelection Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellEditSelection*
Sets the position of the selection during [cell editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting).
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetCellEditSelection**(**ByVal** *iStart* **As Integer**, **ByVal** *iEnd* **As Integer**) |
| VB | *object*.**SetCellEditSelection**(**ByVal** *iStart* **As Long**, **ByVal** *iEnd* **As Long**) |
| C#.NET | **void** *object*.**SetCellEditSelection**(**int** *iStart*, **int** *iEnd*); |
| VC++ | **HRESULT** *object*->**SetCellEditSelection**(**long** *iStart*, **long** *iEnd*); |
| C | **HRESULT** *object*->raw_**SetCellEditSelection**(**long** *iStart*, **long** *iEnd*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
iStart
The zero-based starting position of the first selected character of the edit control used for cell editing. If *iStart* is 0 and *iEnd* is -1, all the text in the control is selected.
iEnd
The zero-based ending position, i.e. the position of the first character that is not selected. If *iStart* is 0 and *iEnd* is -1, all the text in the control is selected.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The SetCellEditSelection method sets the position of the selection during cell editing.
The SetCellEditSelection method is only available if cell editing has been started using [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit), [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) or [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) and cannot be used if cell editing has been initiated using [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Edit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Edit).
Use [GetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_GetCellEditSelection) to retrieve the position of the current selection.
See Also SftTree Object | Object Hierarchy
## SetCellPictureImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellPictureImage*
Defines the graphic displayed as an item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetCellPictureImage**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Short**) |
| VB | *object*.**SetCellPictureImage**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetCellPictureImage**(**int** *ItemIndex*, **short** *ColIndex*, **object** *ImgListObj*, **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**SetCellPictureImage**(**long** *ItemIndex*, **short** *ColIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**SetCellPictureImage**(**long** *ItemIndex*, **short** *ColIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ImgListObj
An ImageList control supporting the IImageList interface. This ImageList object contains the graphics used to display the cell's graphic component. May be set to the value Nothing (NULL), which removes the graphic from the cell.
ImgIndex
The one-based index of the image in the ImageList control to be used as the cell's graphic component.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.SetImageList instead
The SetCellPictureImage method defines the graphic displayed as an item's cell graphic.
The SetCellPictureImage method is used to set a cell's optional graphic component using an ImageList control. It can be retrieved using the Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[GetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageList) method.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as Cell.Image property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as Cell.Image property are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.[ClearCellImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearCellImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The Items.ClearCellImages method can be used to remove all cell graphics. The *ImgListObj* parameter can be set to the value Nothing (NULL), which removes the graphic from the cell.
The position of the cell graphics relative to the cell text is determined by the Cell.[ImageHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageHAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign) properties.
See Also SftTree Object | Object Hierarchy
## SetCellPictureImage Method, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetCellPictureImage*
Defines the graphic displayed as the item's [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Cell).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image).[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetCellPictureImage**(**ByVal** *ColIndex* **As Short**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Short**) |
| VB | *object*.**SetCellPictureImage**(**ByVal** *ColIndex* **As Integer**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetCellPictureImage**(**short** *ColIndex*, **object** *ImgListObj*, **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**SetCellPictureImage**(**short** *ColIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**SetCellPictureImage**(**short** *ColIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
object
A VirtualItem object.
ColIndex
The zero-based column number. The combination of *ColIndex* and the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem)'s *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter describes an individual cell.
ImgListObj
An ImageList control supporting the IImageList interface. This ImageList object contains the graphics used to display the cell's graphic component. May be set to the value Nothing (NULL), which removes the graphic from the cell.
ImgIndex
The one-based index of the image in the ImageList control to be used as the cell's graphic component.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Cell.Image.SetImageList instead
The SetCellPictureImage method defines the graphic displayed as the item's cell graphic.
The VirtualItem.SetCellPictureImage property is used while handling a VirtualItem event to define the graphic displayed as the item's cell graphic. The item is described by the VirtualItem event's *RowIndex* parameter.
See Also VirtualItem Object | Object Hierarchy
## SetColorSample Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample*
Defines the picture object as a color sample.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetColorSample**(**ByVal** *[SampleColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SampleColor)* **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByVal** *[FrameColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_FrameColor)* **As UInteger**) |
| VB | *object*.**SetColorSample**(**ByVal** *SampleColor* **As OLE_COLOR**, **ByVal** *FrameColor* **As OLE_COLOR**) |
| C#.NET | **void** *object*.**SetColorSample**(**uint** *SampleColor*, **uint** *FrameColor*); |
| VC++ | **HRESULT** *object*->**SetColorSample**(**OLE_COLOR** *SampleColor*, **OLE_COLOR** *FrameColor*); |
| C | **HRESULT** *object*->raw_**SetColorSample**(**OLE_COLOR** *SampleColor*, **OLE_COLOR** *FrameColor*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
SampleColor
Defines the color sample. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
FrameColor
Defines the border color. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".
### Comments
The SetColorSample method defines the picture object as a color sample.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants).
The SftPictureObject.[Height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Height) and SftPictureObject.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width) properties should be used to define the requested image size.
The color sample can also be defined using the SftPictureObject.SampleColor and SftPictureObject.FrameColor properties.
See Also SftPictureObject Object | Object Hierarchy
## SetData Method, DataObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_SetData*
Adds a supported format and possibly its data to a [DataObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_DataObject) object.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetData**([ **ByVal** *Data* **As Object** ] , [ **ByVal** *Format* **As Object** ] ) |
| VB | *object*.**SetData**([ **ByVal** *Data* **As Variant** ] , [ **ByVal** *Format* **As Variant** ] ) |
| C#.NET | **void** *object*.**SetData**(**object** *Data*, **object** *Format*); |
| VC++ | **HRESULT** *object*->**SetData**(**const _variant_t**&**** *Data* = **vtMissing**, **const _variant_t**&**** *Format* = **vtMissing**); |
| C | **HRESULT** *object*->raw_**SetData**(**VARIANT** *Data*, **VARIANT** *Format*); |
object
A DataObject object.
Data
The data to be passed to the DataObject object. The *Data* argument is optional.
Format
The data format (see [SftOLEClipboardConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftOLEClipboardConstants)). The *Format* argument is optional.
| Format | Value | Description |
| --- | --- | --- |
| sftCFText | 1 | Text (as a String value) |
| sftCFBitmap | 2 | Bitmap (as [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object) |
| sftCFMetafile | 3 | Metafile (as Picture object) |
| sftCFDIB | 8 | Device independent bitmap (as Picture object) |
| sftCFFiles | 15 | [List](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_List) of files. SetData cannot be used to supply data for this format. Use the DataObject.[Files](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Files) collection instead. |
| sftCFRTF | -16639 | Rich text format (as String value) |
### Comments
The SetData method adds a supported format and possibly its data to a DataObject object.
The *Data* argument is optional. This allows you to set several different formats that the source component can support without having to load the data separately for each format. Multiple formats are set by calling SetData several times, each time using a different format. If you wish to start fresh, use the DataObject.[Clear](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_Clear) method to clear all data and format information from the DataObject.
The *Format* argument is also optional, but either the *Data* or *Format* argument must be specified. If *Data* is specified, but not *Format*, the format of the data is determined automatically. If this is unsuccessful, then an error is generated. When the target requests the data and a format was specified, but no data was provided, the source's [OLESetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OLESetData) event occurs, and the source can then provide the requested data type.
It is possible for the DataObject.[GetData](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/DataObject_GetData) method and SetData method to use data formats other than those listed as valid *Format* argument, including user-defined formats registered with Windows via the RegisterClipboardFormat() API function. The SetData method requires the data to be in the form of a byte array when it does not recognize the data format specified. The DataObject.GetData method always returns data in a byte array when it is in a format that it doesn't recognize, although this may be transparently converted into other data types, such as strings. The byte array returned by DataObject.GetData will be larger than the actual data when running on some operating systems, with arbitrary bytes at the end of the array. This allocation of memory is often larger than is actually required for the data. Therefore, there may be extraneous bytes near the end of the allocated memory segment.
See Also DataObject Object | Object Hierarchy
## SetImage Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImage*
Defines the picture object attributes defined as a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetImage**(**ByVal** *GDIPlusImage* **As Integer**, **ByVal** *Owned* **As Boolean**) |
| VB | *object*.**SetImage**(**ByVal** *GDIPlusImage* **As LONG_PTR**, **ByVal** *Owned* **As Boolean**) |
| C#.NET | **void** *object*.**SetImage**(**int** *GDIPlusImage*, **bool** *Owned*); |
| VC++ | **HRESULT** *object*->**SetImage**(**LONG_PTR** *GDIPlusImage*, **VARIANT_BOOL** *Owned*); |
| C | **HRESULT** *object*->raw_**SetImage**(**LONG_PTR** *GDIPlusImage*, **VARIANT_BOOL** *Owned*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
GDIPlusImage
A pointer to a Gdiplus::Image object.
Owned
Set to True if the GDI+ image is owned by the tree control, False otherwise.
### Comments
The SetImage method defines the picture object attributes defined as a GDI+ image.
The SetImage property offers support for PNG, TIFF, JPEG, GIF, Exif, EMF+, EMF (GDI+ images) with full support for alpha-blended (translucent and semi-transparent) images.
If *Owned* is set to False, the image remains owned by the application and must remain valid as long as it is used by the tree control. Once it is no longer needed, it must be deleted by the application. Most languages, except C++, automatically delete the object when it is no longer needed so no action is usually necessary.
If *Owned* is set to True, the tree control automatically deletes the image object when it is no longer needed.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeGDIPlus](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
The [Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Image) property can also be used to define the image object using a GDI+ image, but it does not assign ownership of the GDI+ image to the tree control. SetImage(image, False) is identical to the use of the Image property.
See Also SftPictureObject Object | Object Hierarchy
## SetImageList Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList*
Defines the picture object as an ImageList image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetImageList**(**ByVal** *ImageList* **As Object**, **ByVal** *ImageIndex* **As Short**) |
| VB | *object*.**SetImageList**(**ByVal** *ImageList* **As Object**, **ByVal** *ImageIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetImageList**(**object** *ImageList*, **short** *ImageIndex*); |
| VC++ | **HRESULT** *object*->**SetImageList**(**LPDISPATCH** *ImageList*, **short** *ImageIndex*); |
| C | **HRESULT** *object*->raw_**SetImageList**(**LPDISPATCH** *ImageList*, **short** *ImageIndex*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
ImageList
An ImageList control (supporting the IImageList interface).
ImageIndex
The one-based index of the image in the ImageList control to be used as graphic.
### Comments
The SetImageList method defines the picture object as an ImageList image.
SetImageList only supports ActiveX ImageList controls that offer an IImageList interface. [GetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_GetImageListH) and [SetImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageListH) support a window handle based ImageList control (Common Controls).
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
See Also SftPictureObject Object | Object Hierarchy
## SetImageListH Method, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageListH*
Defines the picture object as an ImageList image.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetImageListH**(**ByVal** *ImageListWindow* **As Integer**, **ByVal** *ImageIndex* **As Short**) |
| VB | *object*.**SetImageListH**(**ByVal** *ImageListWindow* **As OLE_HANDLE**, **ByVal** *ImageIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetImageListH**(**int** *ImageListWindow*, **short** *ImageIndex*); |
| VC++ | **HRESULT** *object*->**SetImageListH**(**OLE_HANDLE** *ImageListWindow*, **short** *ImageIndex*); |
| C | **HRESULT** *object*->raw_**SetImageListH**(**OLE_HANDLE** *ImageListWindow*, **short** *ImageIndex*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
ImageListWindow
An ImageList control handle.
ImageIndex
The one-based index of the image in the ImageList control to be used as graphic.
### Comments
The SetImageListH method defines the picture object as an ImageList image.
The SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) property is set to [sftTypeImageListH](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants). The SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image size.
See Also SftPictureObject Object | Object Hierarchy
## SetItemPictureImage Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetItemPictureImage*
Defines the graphic displayed as an item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetItemPictureImage**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Short**) |
| VB | *object*.**SetItemPictureImage**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetItemPictureImage**(**int** *ItemIndex*, **object** *ImgListObj*, **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**SetItemPictureImage**(**long** *ItemIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**SetItemPictureImage**(**long** *ItemIndex*, **LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index.
ImgListObj
An ImageList control (supporting the IImageList interface). This ImageList object contains the graphics used to display the item graphic.
ImgIndex
The one-based index of the image in the ImageList control to be used as the item graphic.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.SetImageList instead
The SetItemPictureImage method defines the graphic displayed as an item's item graphic.
The SetItemPictureImage method is used to override the default item graphic (defined using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ItemImageExpandable](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpandable), Items.[ItemImageExpanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageExpanded) and Items.[ItemImageLeaf](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageLeaf) properties) using an image from an ImageList control. These default graphics must be defined for item graphics to be shown.
When using [fixed height items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) (see Items.[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)), all graphics used in a tree control as Item.Image, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as Item.Image property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.[ClearItemImages](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ClearItemImages) method.
When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.
The *ImgListObj* parameter can be set to the value Nothing (NULL), which restores the default graphic.
The [ItemImageAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ItemImageAlign) property can be used to align item graphics on lower levels with higher level [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
See Also SftTree Object | Object Hierarchy
## SetItemPictureImage Method, VirtualItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_SetItemPictureImage*
Defines the graphic displayed as the item's item graphic.
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem).[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item).[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Image).[SetImageList](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetImageList) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetItemPictureImage**(**ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Short**) |
| VB | *object*.**SetItemPictureImage**(**ByVal** *ImgListObj* **As Object**, **ByVal** *ImgIndex* **As Integer**) |
| C#.NET | **void** *object*.**SetItemPictureImage**(**object** *ImgListObj*, **short** *ImgIndex*); |
| VC++ | **HRESULT** *object*->**SetItemPictureImage**(**LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
| C | **HRESULT** *object*->raw_**SetItemPictureImage**(**LPDISPATCH** *ImgListObj*, **short** *ImgIndex*); |
object
A VirtualItem object.
ImgListObj
An ImageList control (supporting the IImageList interface). This ImageList object contains the graphics used to display the item graphic.
ImgIndex
The one-based index of the image in the ImageList control to be used as the item graphic.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualItem.Item.Image.SetImageList instead
The SetItemPictureImage method defines the graphic displayed as the item's item graphic.
The VirtualItem.SetItemPictureImage property is used while handling a [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem) to define the graphic displayed as the item's item graphic. The item is described by the VirtualItem event's *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* parameter.
See Also VirtualItem Object | Object Hierarchy
## SetRuntimeLicense Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetRuntimeLicense*
> This method is for internal use only.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SetRuntimeLicense**(**ByVal** *[License](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_License)* **As String**, **ByVal** *Key* **As Integer**) |
| VB | *object*.**SetRuntimeLicense**(**ByVal** *License* **As String**, **ByVal** *Key* **As Long**) |
| C#.NET | **void** *object*.**SetRuntimeLicense**(**string** *License*, **int** *Key*); |
| VC++ | **HRESULT** *object*->**SetRuntimeLicense**(**_bstr_t** *License*, **long** *Key*); |
| C | **HRESULT** *object*->raw_**SetRuntimeLicense**(**BSTR** *License*, **long** *Key*); |
See Also [SftTree](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree) Object | Object Hierarchy
## ShadowColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShadowColor*
Defines the color used to draw the dark edge of items.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ShadowColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShadowColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw the dark edge of items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ShadowColor instead
The ShadowColor property defines the color used to draw the dark edge of items.
Defines the color used to draw the shadow edge of items when the Items.[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is used.
See Also SftTree Object | Object Hierarchy
## ShadowColor Property, SftTreeFooters Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_ShadowColor*
Defines the color used to draw the dark edge of all [column footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeFooters](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooters) object.
Clr
Defines the color used to draw the dark edge of all column footers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the color used to draw the dark edge of all column footers.
All column footers use the same shadow color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeFooters Object | Object Hierarchy
## ShadowColor Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_ShadowColor*
Defines the color used to draw the dark edge of all [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Clr
Defines the color used to draw the dark edge of all column headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the color used to draw the dark edge of all column headers.
All column headers use the same shadow color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeHeaders Object | Object Hierarchy
## ShadowColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShadowColor*
Defines the color used to draw the dark edge of items.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw the dark edge of items. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the color used to draw the dark edge of items.
Defines the color used to draw the shadow edge of items when the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Cell3D](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Cell3D) property is used.
See Also SftTreeItems Object | Object Hierarchy
## ShadowColor Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_ShadowColor*
Defines the color used to draw the dark edge of the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Clr
Defines the color used to draw the dark edge of the row/column footer. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the color used to draw the dark edge of the row/column footer.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## ShadowColor Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_ShadowColor*
Defines the color used to draw the dark edge of the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Clr
Defines the color used to draw the dark edge of the row/column header. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the color used to draw the dark edge of the row/column header.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## ShadowColor Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_ShadowColor*
Defines the default color used to draw the dark edge of [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ShadowColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ShadowColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ShadowColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ShadowColor**;
**OLE_COLOR** *Clr* = *object*->Get**ShadowColor**(); |
| C | **HRESULT** *object*->get_**ShadowColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShadowColor** = *Clr* **As UInteger** |
| VB | *object*.**ShadowColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ShadowColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ShadowColor** = *Clr*;
**void** *object*->Put**ShadowColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ShadowColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Clr
Defines the default color used to draw the dark edge of row headers. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ShadowColor property defines the default color used to draw the dark edge of row headers.
All row headers use the same shadow color and cannot be defined individually.
This property has no effect if [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
See Also SftTreeRowHeaders Object | Object Hierarchy
## ShowFocusRectangle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShowFocusRectangle*
Defines whether the focus rectangle is displayed.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ShowFocusRectangle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShowFocusRectangle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ShowFocusRectangle** **As Boolean** |
| VB | *Boolean* = *object*.**ShowFocusRectangle** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ShowFocusRectangle**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ShowFocusRectangle**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ShowFocusRectangle**(); |
| C | **HRESULT** *object*->get_**ShowFocusRectangle**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShowFocusRectangle** = *Boolean* **As Boolean** |
| VB | *object*.**ShowFocusRectangle** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ShowFocusRectangle** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ShowFocusRectangle** = *Boolean*;
**void** *object*->Put**ShowFocusRectangle**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ShowFocusRectangle**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the focus rectangle is displayed.
| Boolean | Description |
| --- | --- |
| True | The focus rectangle is displayed when the tree control has the input focus. |
| False | the focus rectangle is never displayed. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ShowFocusRectangle instead
The ShowFocusRectangle property defines whether the focus rectangle is displayed.
The ShowFocusRectangle property can be used to turn off the display of the focus rectangle. This could be useful for applications that wish to implement [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) selection, rather than the tree control's standard item selection (i.e. an entire row is selected).
See Also SftTree Object | Object Hierarchy
## ShowFocusRectangle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShowFocusRectangle*
Defines whether the focus rectangle is displayed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ShowFocusRectangle** **As Boolean** |
| VB | *Boolean* = *object*.**ShowFocusRectangle** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ShowFocusRectangle**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ShowFocusRectangle**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ShowFocusRectangle**(); |
| C | **HRESULT** *object*->get_**ShowFocusRectangle**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShowFocusRectangle** = *Boolean* **As Boolean** |
| VB | *object*.**ShowFocusRectangle** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ShowFocusRectangle** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ShowFocusRectangle** = *Boolean*;
**void** *object*->Put**ShowFocusRectangle**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ShowFocusRectangle**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether the focus rectangle is displayed.
| Boolean | Description |
| --- | --- |
| True | The focus rectangle is displayed when the tree control has the input focus. |
| False | the focus rectangle is never displayed. |
### Comments
The ShowFocusRectangle property defines whether the focus rectangle is displayed.
The ShowFocusRectangle property can be used to turn off the display of the focus rectangle. This could be useful for applications that wish to implement [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) selection, rather than the tree control's standard item selection (i.e. an entire row is selected).
See Also SftTreeItems Object | Object Hierarchy
## Shown Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Shown*
Defines whether the item is shown.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Shown** **As Boolean** |
| VB | *Boolean* = *object*.**Shown** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Shown**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Shown**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Shown**(); |
| C | **HRESULT** *object*->get_**Shown**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Shown** = *Boolean* **As Boolean** |
| VB | *object*.**Shown** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Shown** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Shown** = *Boolean*;
**void** *object*->Put**Shown**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Shown**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
Boolean
Defines whether the item is shown.
| Boolean | Description |
| --- | --- |
| True | The item is shown. |
| False | The item is not shown. |
### Comments
The Shown property defines whether the item is shown.
An item is considered shown (or visible) if its immediate parent item and all its indirect parent items are [expanded](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapseitems) or if the item doesn't have a parent item. If a parent item is collapsed, its dependents are considered not shown.
The Item.Shown property is used to determine if an item is currently visible, i.e., its parent items are expanded and visible themselves. The Item.Shown property does NOT control whether the item is currently in the range of items visible to the user in the tree control's client area. The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used to display an item in the tree control's client area.
By setting the Item.Shown property to True, an item is made visible by expanding all its direct and indirect parent items. To display the item in the tree control's client area, use the Item.MakeVisible method.
See Also SftTreeItem Object | Object Hierarchy
## Shown Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Shown*
Returns the number of completely and partially visible items in the client area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**Shown** **As Integer** |
| VB | *Count* = *object*.**Shown** **As Long** |
| C#.NET | **int** *Count* = *object*.**Shown**; |
| VC++ | **long** *Count* = *object*->**Shown**;
**long** *Count* = *object*->Get**Shown**(); |
| C | **HRESULT** *object*->get_**Shown**(**long*** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Returns the number of completely and partially visible items in the client area.
### Comments
The Shown property returns the number of completely and partially visible items in the client area.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).Shown property returns the total number of visible items in the tree control's client area, including partially visible items. The Items.[ShownComplete](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShownComplete) property returns the number of completely visible items, not including partial items.
See Also SftTreeItems Object | Object Hierarchy
## ShownComplete Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ShownComplete*
Returns the number of completely visible items in the client area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**ShownComplete** **As Integer** |
| VB | *Count* = *object*.**ShownComplete** **As Long** |
| C#.NET | **int** *Count* = *object*.**ShownComplete**; |
| VC++ | **long** *Count* = *object*->**ShownComplete**;
**long** *Count* = *object*->Get**ShownComplete**(); |
| C | **HRESULT** *object*->get_**ShownComplete**(**long*** *Count*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Count
Returns the number of completely visible items in the client area.
### Comments
The ShownComplete property returns the number of completely visible items in the client area.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).ShownComplete property returns the total number of completely visible items in the tree control's client area, not including partially visible items. The Items.[Shown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Shown) property returns the number of visible items, including partial items.
See Also SftTreeItems Object | Object Hierarchy
## ShowTruncated Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ShowTruncated*
Defines whether text is clipped or truncated using trailing '...'.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ShowTruncated** **As Boolean** |
| VB | *Boolean* = *object*.**ShowTruncated** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ShowTruncated**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ShowTruncated**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ShowTruncated**(); |
| C | **HRESULT** *object*->get_**ShowTruncated**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ShowTruncated** = *Boolean* **As Boolean** |
| VB | *object*.**ShowTruncated** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ShowTruncated** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ShowTruncated** = *Boolean*;
**void** *object*->Put**ShowTruncated**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ShowTruncated**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether text is clipped or truncated using trailing '...'.
| Boolean | Description |
| --- | --- |
| True | Truncated text should be shown using trailing "...". |
| False | Truncated text is clipped. |
### Comments
The ShowTruncated property defines whether text is clipped or truncated using trailing '...'.
The ShowTruncated property applies to all text components in a tree control. By setting it to True, text that is too large (horizontally) to fit in the space allocated will be truncated by showing trailing periods ("..."). If set to False, text will be clipped if too large and displayed in the available area.
See Also SftTree Object | Object Hierarchy
## SizeBox Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBox*
Defines whether a size box (resize grip) is shown in the lower-right corner so the user can resize the control.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**SizeBox** **As Boolean** |
| VB | *Boolean* = *object*.**SizeBox** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**SizeBox**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**SizeBox**;
**VARIANT_BOOL** *Boolean* = *object*->Get**SizeBox**(); |
| C | **HRESULT** *object*->get_**SizeBox**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SizeBox** = *Boolean* **As Boolean** |
| VB | *object*.**SizeBox** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**SizeBox** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**SizeBox** = *Boolean*;
**void** *object*->Put**SizeBox**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**SizeBox**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether a size box (resize grip) is shown in the lower-right corner so the user can resize the control.
| Boolean | Description |
| --- | --- |
| True | A size box is shown and the user can resize the control. |
| False | No size box is shown (the default). |
### Comments
The SizeBox property defines whether a size box (resize grip) is shown in the lower-right corner so the user can resize the control.
The size box is only useful when the tree control is used as a stand-alone window, for example as a drop-down window the user can resize. When the tree control is embedded in a dialog or another window, its size is controlled by the parent window, so the size box cannot be used.
Use [SizeBoxActive](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBoxActive) to determine whether the user is currently resizing the control.
See Also SftTree Object | Object Hierarchy
## SizeBoxActive Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBoxActive*
Returns whether the user is currently resizing the control using the size box.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**SizeBoxActive** **As Boolean** |
| VB | *Boolean* = *object*.**SizeBoxActive** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**SizeBoxActive**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**SizeBoxActive**;
**VARIANT_BOOL** *Boolean* = *object*->Get**SizeBoxActive**(); |
| C | **HRESULT** *object*->get_**SizeBoxActive**(**VARIANT_BOOL*** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Returns whether the user is currently resizing the control using the size box.
| Boolean | Description |
| --- | --- |
| True | The user is currently dragging the size box to resize the control. |
| False | The user is not resizing the control. |
### Comments
The SizeBoxActive property returns whether the user is currently resizing the control using the size box.
The size box is enabled using the [SizeBox](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SizeBox) property.
See Also SftTree Object | Object Hierarchy
## SmoothScroll Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SmoothScroll*
Defines whether items are scrolled pixel by pixel (for small scrolling increments only).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**SmoothScroll** **As Boolean** |
| VB | *Boolean* = *object*.**SmoothScroll** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**SmoothScroll**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**SmoothScroll**;
**VARIANT_BOOL** *Boolean* = *object*->Get**SmoothScroll**(); |
| C | **HRESULT** *object*->get_**SmoothScroll**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SmoothScroll** = *Boolean* **As Boolean** |
| VB | *object*.**SmoothScroll** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**SmoothScroll** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**SmoothScroll** = *Boolean*;
**void** *object*->Put**SmoothScroll**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**SmoothScroll**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether items are scrolled pixel by pixel (for small scrolling increments only).
| Boolean | Description |
| --- | --- |
| True | Smooth scrolling is used for small vertical scrolling increments. |
| False | Smooth scrolling is never used. |
### Comments
The SmoothScroll property defines whether items are scrolled pixel by pixel (for small scrolling increments only).
Smooth scrolling is only used when the entire window is scrolled vertically by a small amount. If [column headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) are shown, smooth scrolling is not used. Smooth scrolling can also be disabled using Control Panel.
See Also SftTree Object | Object Hierarchy
## SortCompare Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SortCompare*
[Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) are being sorted.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**SortCompare**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**SortCompare** |
| VB | **Private Sub** *object*_**SortCompare**(**ByVal** *StringVal1* **As String**, **ByVal** *StringVal2* **As String**, **ByVal** *ItemData1* **As Long**, **ByVal** *ItemData2* **As Long**, *RetVal* **As Integer**) |
| C#.NET | **void** *object*_**SortCompare**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**SortCompare***object*(**_bstr_t** *StringVal1*, **_bstr_t** *StringVal2*, **long** *ItemData1*, **long** *ItemData2*, **short*** *RetVal*); |
| C | **HRESULT** On**SortCompare***object*(**BSTR** *StringVal1*, **BSTR** *StringVal2*, **long** *ItemData1*, **long** *ItemData2*, **short*** *RetVal*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
StringVal1
The [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text of the item to be compared to the cell text *StringVal2* of the second item.
StringVal2
The cell text of the item to be compared to the cell text *StringVal1* of the first item.
ItemData1
The value of the item to be compared to the value *ItemData2* of the second item. Depending on the * SortType* argument of the Items.[SortDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) method, the *ItemData1* parameter contains the following value:
| SortType | Description |
| --- | --- |
| [sortSftTreeEvent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortTypeConstants) | *ItemData1* contains the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property value of the item being sorted. |
| sortSftTreeEventCell | *ItemData1* contains the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) property value of the item being sorted. |
| sortSftTreeEventWithIndex | *ItemData1* contains the index of the item being sorted. An application can retrieve property values from the item if necessary for comparison purposes. |
ItemData2
The value of the item to be compared to the value *ItemData1* of the first item. Depending on the * SortType* argument of the Items.SortDependents method, the *ItemData2* parameter contains the following value:
| SortType | Description |
| --- | --- |
| sortSftTreeEvent | *ItemData2* contains the Item.Data property value of the item being sorted. |
| sortSftTreeEventCell | *ItemData2* contains the Cell.Data property value of the item being sorted. |
| sortSftTreeEventWithIndex | *ItemData2* contains the index of the item being sorted. An application can retrieve property values from the item if necessary for comparison purposes. |
RetVal
Returns the collating sequence. Return a value greater than zero to indicate that *StringVal1* is greater than *StringVal2* (or *ItemData1* > *ItemData2*), equal to 0 to indicate that the values are equal, a value less than zero to indicate *StringVal1* is less than *StringVal2* (or *ItemData1* < *ItemData2*).
### Comments
The SortCompare event occurs when items are being sorted.
The SortCompare event is generated to compare two items. The return value set in *RetVal* determines the collating sequence of the items being compared. The SortCompare event is only generated when the Items.SortDependents method is used with a *SortType* of sortSftTreeEvent, sortSftTreeEventCell and sortSftTreeEventWithIndex. The immediate dependents are sorted in a fashion determined by the SortCompare event.
See Also SftTree Object | Object Hierarchy
## SortDependents Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SortDependents*
Sorts an item's dependents.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SortDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *Result* = *object*.**SortDependents**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SortType* **As [SftTreeSortTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortTypeConstants)**) **As Boolean** |
| VB | *Result* = *object*.**SortDependents**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SortType* **As SftTreeSortTypeConstants**) **As Boolean** |
| C#.NET | **bool** *Result* = *object*.**SortDependents**(**int** *ItemIndex*, **short** *ColIndex*, **SftTreeSortTypeConstants** *SortType*); |
| VC++ | **VARIANT_BOOL** *Result* = *object*->**SortDependents**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeSortTypeConstants** *SortType*); |
| C | **HRESULT** *object*->raw_**SortDependents**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeSortTypeConstants** *SortType*, **VARIANT_BOOL*** *Result*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose immediate dependents are to be sorted. If *ItemIndex* is -1, the items on the [root level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_rootlevel) (level 0) are sorted.
ColIndex
The zero-based column number to be sorted.
SortType
The sort method to be used.
| SortType | Value | Description |
| --- | --- | --- |
| sortSftTreeAscending | 0 | The immediate dependents are sorted in an ascending fashion (not case sensitive) based on their [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in column *ColIndex*. |
| sortSftTreeDescending | 1 | The immediate dependents are sorted in a descending fashion (not case sensitive) based on their cell text in column *ColIndex*. |
| sortSftTreeAscItemData | 2 | The immediate dependents are sorted in an ascending fashion based on their [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemData | 3 | The immediate dependents are sorted in a descending fashion based on their Item.Data property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeAscItemDataFloat | 4 | The immediate dependents are sorted in an ascending fashion based on their Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemDataFloat | 5 | The immediate dependents are sorted in a descending fashion based on their Item.DataFloat property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeEvent | 6 | The immediate dependents are sorted in a fashion determined by the [SortCompare](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SortCompare) event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
| sortSftTreeEventCell | 7 | The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
| sortSftTreeAscCellItemData | 8 | The immediate dependents are sorted in an ascending fashion based on their [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) property value. |
| sortSftTreeDscCellItemData | 9 | The immediate dependents are sorted in a descending fashion based on their Cell.Data property value. |
| sortSftTreeAscItemDataString | 10 | The immediate dependents are sorted in an ascending fashion based on their Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemDataString | 11 | The immediate dependents are sorted in a descending fashion based on their Item.DataString property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeEventWithIndex | 12 | The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
Result
Returns True if sorting was successful, False if the sorting process ran out of memory.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.SortDependents instead
The SortDependents method sorts an item's dependents.
Based on the specified column number *ColIndex*, the immediate dependents of the specified item *ItemIndex* are sorted according to the *SortType* specified.
When sorting dependents, only immediate dependents are sorted, i.e., items on the immediate lower level. [Dependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) of items being sorted are moved with their parent item, but are not sorted. Invoke the SortDependents method separately for each parent item to be sorted.
See Also SftTree Object | Object Hierarchy
## SortDependents Method, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents*
Sorts an item's dependents.
### Syntax
| | |
| --- | --- |
| VB.NET | *Result* = *object*.**SortDependents**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *SortType* **As [SftTreeSortTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortTypeConstants)**) **As Boolean** |
| VB | *Result* = *object*.**SortDependents**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *SortType* **As SftTreeSortTypeConstants**) **As Boolean** |
| C#.NET | **bool** *Result* = *object*.**SortDependents**(**int** *ItemIndex*, **short** *ColIndex*, **SftTreeSortTypeConstants** *SortType*); |
| VC++ | **VARIANT_BOOL** *Result* = *object*->**SortDependents**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeSortTypeConstants** *SortType*); |
| C | **HRESULT** *object*->raw_**SortDependents**(**long** *ItemIndex*, **short** *ColIndex*, **enum SftTreeSortTypeConstants** *SortType*, **VARIANT_BOOL*** *Result*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
The zero-based index of the item whose immediate dependents are to be sorted. If *ItemIndex* is -1, the items on the [root level](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_rootlevel) (level 0) are sorted.
ColIndex
The zero-based column number to be sorted.
SortType
The sort method to be used.
| SortType | Value | Description |
| --- | --- | --- |
| sortSftTreeAscending | 0 | The immediate dependents are sorted in an ascending fashion (not case sensitive) based on their [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text in column *ColIndex*. |
| sortSftTreeDescending | 1 | The immediate dependents are sorted in a descending fashion (not case sensitive) based on their cell text in column *ColIndex*. |
| sortSftTreeAscItemData | 2 | The immediate dependents are sorted in an ascending fashion based on their [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Data) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemData | 3 | The immediate dependents are sorted in a descending fashion based on their Item.Data property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeAscItemDataFloat | 4 | The immediate dependents are sorted in an ascending fashion based on their Item.[DataFloat](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataFloat) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemDataFloat | 5 | The immediate dependents are sorted in a descending fashion based on their Item.DataFloat property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeEvent | 6 | The immediate dependents are sorted in a fashion determined by the [SortCompare](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_SortCompare) event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
| sortSftTreeEventCell | 7 | The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
| sortSftTreeAscCellItemData | 8 | The immediate dependents are sorted in an ascending fashion based on their [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[Data](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Data) property value. |
| sortSftTreeDscCellItemData | 9 | The immediate dependents are sorted in a descending fashion based on their Cell.Data property value. |
| sortSftTreeAscItemDataString | 10 | The immediate dependents are sorted in an ascending fashion based on their Item.[DataString](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_DataString) property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeDscItemDataString | 11 | The immediate dependents are sorted in a descending fashion based on their Item.DataString property value (*ColIndex* is ignored, but must be valid). |
| sortSftTreeEventWithIndex | 12 | The immediate dependents are sorted in a fashion determined by the SortCompare event. The SortCompare event is generated to compare two items. It is only generated for a *SortType* of sortSftTreeEvent, sortSftTreeEventCell or sortSftTreeEventWithIndex. For other *SortType* values, the event is not generated. |
Result
Returns True if sorting was successful, False if the sorting process ran out of memory.
### Comments
The SortDependents method sorts an item's dependents.
Based on the specified column number *ColIndex*, the immediate dependents of the specified item *ItemIndex* are sorted according to the *SortType* specified.
When sorting dependents, only immediate dependents are sorted, i.e., items on the immediate lower level. [Dependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_dependents) of items being sorted are moved with their parent item, but are not sorted. Invoke the SortDependents method separately for each parent item to be sorted.
See Also SftTreeItems Object | Object Hierarchy
## SortedColumn Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_SortedColumn*
Returns the column number of the first column with a [sort indicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ColIndex* = *object*.**SortedColumn** **As Short** |
| VB | *ColIndex* = *object*.**SortedColumn** **As Integer** |
| C#.NET | **short** *ColIndex* = *object*.**SortedColumn**; |
| VC++ | **short** *ColIndex* = *object*->**SortedColumn**;
**short** *ColIndex* = *object*->Get**SortedColumn**(); |
| C | **HRESULT** *object*->get_**SortedColumn**(**short*** *ColIndex*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
ColIndex
Returns the column number of the first column with a sort indicator. -1 is returned if none of the columns has a sort indicator.
### Comments
The SortedColumn property returns the column number of the first column with a sort indicator.
The sort direction of the sort indicator can be determined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[SortIndicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SortIndicator) property.
See Also SftTreeHeaders Object | Object Hierarchy
## SortIndicator Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SortIndicator*
Defines the [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s [sort indicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) appearance.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**SortIndicator** **As **[SftTreeSortIndicatorConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeSortIndicatorConstants)**** |
| VB | *Style* = *object*.**SortIndicator** **As SftTreeSortIndicatorConstants** |
| C#.NET | **SftTreeSortIndicatorConstants** *Style* = *object*.**SortIndicator**; |
| VC++ | **enum SftTreeSortIndicatorConstants** *Style* = *object*->**SortIndicator**;
**enum SftTreeSortIndicatorConstants** *Style* = *object*->Get**SortIndicator**(); |
| C | **HRESULT** *object*->get_**SortIndicator**(**enum SftTreeSortIndicatorConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SortIndicator** = *Style* **As SftTreeSortIndicatorConstants** |
| VB | *object*.**SortIndicator** = *Style* **As SftTreeSortIndicatorConstants** |
| C#.NET | **SftTreeSortIndicatorConstants** *object*.**SortIndicator** = *Style*; |
| VC++ | **enum SftTreeSortIndicatorConstants** *object*->**SortIndicator** = *Style*;
**void** *object*->Put**SortIndicator**(**enum SftTreeSortIndicatorConstants** *Style*); |
| C | **HRESULT** *object*->put_**SortIndicator**(**enum SftTreeSortIndicatorConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the column header's sort indicator appearance.
| Name | Value | Description |
| --- | --- | --- |
| sortIndicatorSftTreeNone | 0 | None. No sort indicator is shown for this column. |
| sortIndicatorSftTreeAscending | 1 | Ascending. A sort indicator is shown for this column indicating an ascending sort. |
| sortIndicatorSftTreeDescending | 2 | Descending. A sort indicator is shown for this column indicating a descending sort. |
### Comments
The SortIndicator property defines the column header's sort indicator appearance.
See Also SftTreeHeader Object | Object Hierarchy
## SortIndicators Property, SftTreeHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_SortIndicators*
Defines whether [sort indicators](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/pop_sortindicator) are shown.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**SortIndicators** **As [SftTreeHeaderSortIndicatorsConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHeaderSortIndicatorsConstants)** |
| VB | *Style* = *object*.**SortIndicators** **As SftTreeHeaderSortIndicatorsConstants** |
| C#.NET | **SftTreeHeaderSortIndicatorsConstants** *Style* = *object*.**SortIndicators**; |
| VC++ | **enum SftTreeHeaderSortIndicatorsConstants** *Style* = *object*->**SortIndicators**;
**enum SftTreeHeaderSortIndicatorsConstants** *Style* = *object*->Get**SortIndicators**(); |
| C | **HRESULT** *object*->get_**SortIndicators**(**enum SftTreeHeaderSortIndicatorsConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SortIndicators** = *Style* **As SftTreeHeaderSortIndicatorsConstants** |
| VB | *object*.**SortIndicators** = *Style* **As SftTreeHeaderSortIndicatorsConstants** |
| C#.NET | **SftTreeHeaderSortIndicatorsConstants** *object*.**SortIndicators** = *Style*; |
| VC++ | **enum SftTreeHeaderSortIndicatorsConstants** *object*->**SortIndicators** = *Style*;
**void** *object*->Put**SortIndicators**(**enum SftTreeHeaderSortIndicatorsConstants** *Style*); |
| C | **HRESULT** *object*->put_**SortIndicators**(**enum SftTreeHeaderSortIndicatorsConstants** *Style*); |
object
A [SftTreeHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeaders) object.
Style
Defines whether sort indicators are shown.
| Style | Value | Description |
| --- | --- | --- |
| headerSortIndicatorsSftTreeNone | 0 | None. Sort indicators are not displayed. |
| headerSortIndicatorsSftTreeAuto | 1 | Automatic. Sort indicators are displayed and the tree control automatically responds to mouse button clicks to change sort order and sorted column. |
| headerSortIndicatorsSftTreeManual | 2 | Manual. Sort indicators are displayed but the tree control does not automatically respond to mouse button clicks to change sort order and sorted column. |
### Comments
The SortIndicators property defines whether sort indicators are shown.
**The tree control will never automatically sort the data.**
With headerSortIndicatorsSftTreeAuto the tree control automatically updates sort indicators in response to mouse clicks. The [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event (AreaType = [constSftTreeColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeAreaTypeConstants)) can be used to determine when the header was clicked, meaning the sort indicator was clicked. The [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[SortIndicator](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_SortIndicator) property can be used to determine the status of sort indicators when handling the ItemClick event. The application has to sort the data based on the sort indicators, usually using the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[SortDependents](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_SortDependents) method.
With headerSortIndicatorsSftTreeManual the application must change sort indicators explicitly. The Header.SortIndicator property can be used to update the status of sort indicators. The application has to sort the data based on the sort indicators, usually using the Items.SortDependents method.
See Also SftTreeHeaders Object | Object Hierarchy
## SplitColumn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitColumn*
Defines the number of columns displayed in the [left pane](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) of a split tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Column) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Count* = *object*.**SplitColumn** **As Short** |
| VB | *Count* = *object*.**SplitColumn** **As Integer** |
| C#.NET | **short** *Count* = *object*.**SplitColumn**; |
| VC++ | **short** *Count* = *object*->**SplitColumn**;
**short** *Count* = *object*->Get**SplitColumn**(); |
| C | **HRESULT** *object*->get_**SplitColumn**(**short*** *Count*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SplitColumn** = *Count* **As Short** |
| VB | *object*.**SplitColumn** = *Count* **As Integer** |
| C#.NET | **short** *object*.**SplitColumn** = *Count*; |
| VC++ | **short** *object*->**SplitColumn** = *Count*;
**void** *object*->Put**SplitColumn**(**short** *Count*); |
| C | **HRESULT** *object*->put_**SplitColumn**(**short** *Count*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Count
Defines the number of columns displayed in the left pane of a split tree control. The number specified must be between 1 and the total number of columns-1.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.Column instead
The SplitColumn property defines the number of columns displayed in the left pane of a split tree control.
The total number of columns is defined using the [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property.
See Also SftTree Object | Object Hierarchy
## Splitter Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter*
Returns the [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *refSplitterObj* = *object*.**Splitter** **As SftTreeSplitter** |
| VB | **Set** *refSplitterObj* = *object*.**Splitter** **As SftTreeSplitter** |
| C#.NET | **SftTreeSplitter** *refSplitterObj* = *object*.**Splitter**; |
| VC++ | **ISftTreeSplitter*** *refSplitterObj* = *object*->**Splitter**;
**ISftTreeSplitter*** *refSplitterObj* = *object*->Get**Splitter**(); |
| C | **HRESULT** *object*->get_**Splitter**(**ISftTreeSplitter**** *refSplitterObj*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
refSplitterObj
Returns the SftTreeSplitter object.
### Comments
The Splitter property returns the SftTreeSplitter object.
The SftTreeSplitter object describes the vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a SftTree/OCX control. Numerous properties and methods can be accessed using the returned object * refSplitterObj*. A control has only one SftTreeSplitter object.
See Also SftTree Object | Object Hierarchy
## SplitterBar Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterBar*
Defines whether a vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) is present.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**SplitterBar** **As Boolean** |
| VB | *Boolean* = *object*.**SplitterBar** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**SplitterBar**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**SplitterBar**;
**VARIANT_BOOL** *Boolean* = *object*->Get**SplitterBar**(); |
| C | **HRESULT** *object*->get_**SplitterBar**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SplitterBar** = *Boolean* **As Boolean** |
| VB | *object*.**SplitterBar** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**SplitterBar** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**SplitterBar** = *Boolean*;
**void** *object*->Put**SplitterBar**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**SplitterBar**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether a vertical splitter bar is present.
| Boolean | Description |
| --- | --- |
| True | A vertical splitter bar is present. |
| False | No vertical splitter bar is present. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.Visible instead
The SplitterBar property defines whether a vertical splitter bar is present.
A splitter bar is only available if two or more columns have been defined (see [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property).
The Splitter.[Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Column) property is used to define the position of the splitter bar.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) and Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) properties can be used to define the size and location of the splitter bar.
See Also SftTree Object | Object Hierarchy
## SplitterOffset Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterOffset*
Defines the horizontal offset of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in a split tree control.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Offset* = *object*.**SplitterOffset** **As Single** |
| VB | *Offset* = *object*.**SplitterOffset** **As Single** |
| C#.NET | **float** *Offset* = *object*.**SplitterOffset**; |
| VC++ | **float** *Offset* = *object*->**SplitterOffset**;
**float** *Offset* = *object*->Get**SplitterOffset**(); |
| C | **HRESULT** *object*->get_**SplitterOffset**(**float*** *Offset*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SplitterOffset** = *Offset* **As Single** |
| VB | *object*.**SplitterOffset** = *Offset* **As Single** |
| C#.NET | **float** *object*.**SplitterOffset** = *Offset*; |
| VC++ | **float** *object*->**SplitterOffset** = *Offset*;
**void** *object*->Put**SplitterOffset**(**float** *Offset*); |
| C | **HRESULT** *object*->put_**SplitterOffset**(**float** *Offset*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Offset
Defines the horizontal offset of the splitter bar in a split tree control. If -1 is specified, the splitter bar is centered in the tree control's client area making each pane the same size and the SplitterOffset property is updated with the actual offset. If the offset specified falls outside of the client area, the splitter bar is aligned with the left or right edge, whichever is closer to the offset specified. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.Offset instead
The SplitterOffset property defines the horizontal offset of the splitter bar in a split tree control.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
Splitter.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_MakeOptimal) can be used to position the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar (based on the left pane's [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[HorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_HorizontalExtent) property).
The coordinates of the splitter bar can be retrieved using Splitter.[GetPosition](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_GetPosition).
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) property is used to change the width of the splitter bar.
See Also SftTree Object | Object Hierarchy
## SplitterResizeMode Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterResizeMode*
Allows the user to resize the panes of a [split tree control](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) using the keyboard.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[ResizeMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_ResizeMode) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**SplitterResizeMode**() |
| VB | *object*.**SplitterResizeMode** |
| C#.NET | **void** *object*.**SplitterResizeMode**(); |
| VC++ | **HRESULT** *object*->**SplitterResizeMode**(); |
| C | **HRESULT** *object*->raw_**SplitterResizeMode**(); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.ResizeMode instead
The SplitterResizeMode method allows the user to resize the panes of a split tree control using the keyboard.
The splitter bar of a split tree control can always be resized by dragging the splitter bar using the mouse. If an application wants to provide a [keyboard interface](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_keyboardinterface), a menu option could be implemented which invokes SplitterResizeMode.
Once the SplitterResizeMode method is called, the panes of a split tree control can be resized using the left and right arrow keys. When the user presses the ESCAPE key or moves the mouse cursor away from the splitter bar, the resizing operation ends. While the user resizes the panes, the [ColumnSize](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ColumnSize) event occurs.
See Also SftTree Object | Object Hierarchy
## SplitterWidth Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SplitterWidth*
Defines the width of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in pixels.
> Deprecated - Provided for compatibility with earlier versions only - Use [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_WidthPix) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**SplitterWidth** **As Short** |
| VB | *Width* = *object*.**SplitterWidth** **As Integer** |
| C#.NET | **short** *Width* = *object*.**SplitterWidth**; |
| VC++ | **short** *Width* = *object*->**SplitterWidth**;
**short** *Width* = *object*->Get**SplitterWidth**(); |
| C | **HRESULT** *object*->get_**SplitterWidth**(**short*** *Width*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**SplitterWidth** = *Width* **As Short** |
| VB | *object*.**SplitterWidth** = *Width* **As Integer** |
| C#.NET | **short** *object*.**SplitterWidth** = *Width*; |
| VC++ | **short** *object*->**SplitterWidth** = *Width*;
**void** *object*->Put**SplitterWidth**(**short** *Width*); |
| C | **HRESULT** *object*->put_**SplitterWidth**(**short** *Width*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Width
Defines the width of the splitter bar in pixels. The valid range is 3..7 pixels.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Splitter.WidthPix instead
The SplitterWidth property defines the width of the splitter bar in pixels.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
See Also SftTree Object | Object Hierarchy
## StartCombo Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo*
Starts editing the specified [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using a combo box.
> Deprecated - Provided for compatibility with earlier versions only - See [Cell Editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**StartCombo**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Strings* **As String**, **ByVal** *Delim* **As String**) |
| VB | *object*.**StartCombo**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *Strings* **As String**, **ByVal** *Delim* **As String**) |
| C#.NET | **void** *object*.**StartCombo**(**int** *ItemIndex*, **short** *ColIndex*, **string** *Strings*, **string** *Delim*); |
| VC++ | **HRESULT** *object*->**StartCombo**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *Strings*, **_bstr_t** *Delim*); |
| C | **HRESULT** *object*->raw_**StartCombo**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *Strings*, **BSTR** *Delim*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Strings
The contents of the combo box drop-down list. The string specifies all possible [selections](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) by separating each substring using the first character identified by *Delim*.
Delim
The delimiter separating each substring in *Strings*.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The StartCombo method starts editing the specified cell using a combo box.
A combo box is displayed in the cell specified by *ItemIndex* and *ColIndex*. If the cell is not currently displayed, it is scrolled into view first. The combo box is initialized with the substrings specified by the * Strings* value. If the current cell text matches one of the substrings, that string is selected in the combo box. The drop-down portion of the combo box is made visible. The user can make a selection from the offered substrings. Text cannot be entered using the keyboard. The [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) method allows data entry in addition to offering a selection. The [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit) method allows data entry without offering a selection.
The delimiter specified by *Delim* should be a String containing one character. Any additional characters are ignored.
The [ItemEditFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont) property can be used to define the font used for cell editing. Using the [CellEditStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle) property, the combo box control's height can be controlled.
There are two methods to handle cell editing events based on the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property:
**CellEventHandling = False**
If the user clicks a mouse button outside of the cell being edited or presses the TAB or ENTER key, the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) event is generated.
**CellEventHandling = True**
If the user clicks a mouse button outside of the cell being edited, the AfterEdit event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended. The ENTER or TAB keys do not end cell editing and must be handled by the [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) or [CEKeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress) event. Using these events, an application can implement cell motion, moving from one cell to the next in response to keystrokes.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the PostEdit event is generated.
See Also SftTree Object | Object Hierarchy
## StartComboEdit Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit*
Starts editing the specified [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using a combo box with edit capability.
> Deprecated - Provided for compatibility with earlier versions only - See [Cell Editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**StartComboEdit**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**, **ByVal** *Strings* **As String**, **ByVal** *Delim* **As String**) |
| VB | *object*.**StartComboEdit**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**, **ByVal** *Strings* **As String**, **ByVal** *Delim* **As String**) |
| C#.NET | **void** *object*.**StartComboEdit**(**int** *ItemIndex*, **short** *ColIndex*, **string** *Strings*, **string** *Delim*); |
| VC++ | **HRESULT** *object*->**StartComboEdit**(**long** *ItemIndex*, **short** *ColIndex*, **_bstr_t** *Strings*, **_bstr_t** *Delim*); |
| C | **HRESULT** *object*->raw_**StartComboEdit**(**long** *ItemIndex*, **short** *ColIndex*, **BSTR** *Strings*, **BSTR** *Delim*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
Strings
The contents of the combo box drop-down list. The string specifies all possible [selections](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections) by separating each substring using the first character identified by *Delim*.
Delim
The delimiter separating each substring in *Strings*.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The StartComboEdit method starts editing the specified cell using a combo box with edit capability.
A combo box is displayed in the cell specified by *ItemIndex* and *ColIndex*. If the cell is not currently displayed, it is scrolled into view first. The combo box is initialized with the substrings specified by the * Strings* value. If the current cell text matches one of the substrings, that string is selected in the combo box. The drop-down portion of the combo box is made visible. The user can make a selection from the offered substrings or enter text using the keyboard. The [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) method offers selection without data entry. The [StartEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit) method allows data entry without offering a selection.
The delimiter specified by *Delim* should be a String containing one character. Any additional characters are ignored.
The [ItemEditFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont) property can be used to define the font used for cell editing. Using the [CellEditStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle) property, the combo box control's height can be controlled.
Use the [CellEditLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditLimit) property to limit the allowable input to a certain number of characters. The [SetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellEditSelection) method can be used to select (highlight) all or portions of the text in the control.
There are two methods to handle cell editing events based on the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property:
**CellEventHandling = False**
If the user clicks a mouse button outside of the cell being edited or presses the TAB or ENTER key, the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) event is generated.
**CellEventHandling = True**
If the user clicks a mouse button outside of the cell being edited, the AfterEdit event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended. The ENTER or TAB keys do not end cell editing and must be handled by the [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) or [CEKeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress) event. Using these events, an application can implement cell motion, moving from one cell to the next in response to keystrokes.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the PostEdit event is generated.
See Also SftTree Object | Object Hierarchy
## StartEdit Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartEdit*
Starts editing the specified [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) using an edit control.
> Deprecated - Provided for compatibility with earlier versions only - See [Cell Editing](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cellediting)
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**StartEdit**(**ByVal** *ItemIndex* **As Integer**, **ByVal** *ColIndex* **As Short**) |
| VB | *object*.**StartEdit**(**ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*.**StartEdit**(**int** *ItemIndex*, **short** *ColIndex*); |
| VC++ | **HRESULT** *object*->**StartEdit**(**long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** *object*->raw_**StartEdit**(**long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - See Cell Editing
The StartEdit method starts editing the specified cell using an edit control.
An edit control is displayed in the cell specified by *ItemIndex* and *ColIndex*. If the cell is not currently displayed, it is scrolled into view first. The edit control is initialized with the current cell text. The user can enter text using the keyboard. The [StartCombo](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartCombo) method offers selection without data entry. The [StartComboEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_StartComboEdit) method allows data entry and selection.
If the column where the cell is located has the style [ColumnStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnStyle) [colstyleSftTreeMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeColumnStyleConstants) ([Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) property) and the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) property is set to a value greater than one line per item, the edit control allows multi-line data entry. A new-line character (CR-LF) can be entered by pressing the CONTROL and ENTER key at the same time. A vertical scroll bar is also added if needed.
The [ItemEditFont](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ItemEditFont) property can be used to define the font used for cell editing. Using the [CellEditStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditStyle) property, the combo box control's height can be controlled.
Use the [CellEditLimit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEditLimit) property to limit the allowable input to a certain number of characters. The [SetCellEditSelection](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_SetCellEditSelection) method can be used to select (highlight) all or portions of the text in the control.
There are two methods to handle cell editing events based on the [CellEventHandling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_CellEventHandling) property:
**CellEventHandling = False**
If the user clicks a mouse button outside of the cell being edited or presses the TAB or ENTER key, the [AfterEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_AfterEdit) event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the [PostEdit](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_PostEdit) event is generated.
**CellEventHandling = True**
If the user clicks a mouse button outside of the cell being edited, the AfterEdit event is generated. This allows the application to perform input validation and other cleanup processing. If *Cancel* = False, the text selected replaces the cell's text. If *Cancel* = True, cell editing is not ended. The ENTER or TAB keys do not end cell editing and must be handled by the [CEKeyDown](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyDown) or [CEKeyPress](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_CEKeyPress) event. Using these events, an application can implement cell motion, moving from one cell to the next in response to keystrokes.
If the user presses the ESCAPE key, cell editing is ended and the original cell text is restored. An AfterEdit event is not generated. Any data the user entered or selected is lost.
Once cell editing has ended (or was aborted by the user), the PostEdit event is generated.
See Also SftTree Object | Object Hierarchy
## Style Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style*
Defines the item style.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Style* = *object*.**Style** **As [SftTreeItemStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeItemStyleConstants)** |
| VB | *Style* = *object*.**Style** **As SftTreeItemStyleConstants** |
| C#.NET | **SftTreeItemStyleConstants** *Style* = *object*.**Style**; |
| VC++ | **enum SftTreeItemStyleConstants** *Style* = *object*->**Style**;
**enum SftTreeItemStyleConstants** *Style* = *object*->Get**Style**(); |
| C | **HRESULT** *object*->get_**Style**(**enum SftTreeItemStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Style** = *Style* **As SftTreeItemStyleConstants** |
| VB | *object*.**Style** = *Style* **As SftTreeItemStyleConstants** |
| C#.NET | **SftTreeItemStyleConstants** *object*.**Style** = *Style*; |
| VC++ | **enum SftTreeItemStyleConstants** *object*->**Style** = *Style*;
**void** *object*->Put**Style**(**enum SftTreeItemStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**Style**(**enum SftTreeItemStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the item style.
| Style | Value | Description |
| --- | --- | --- |
| itemSftTreeFixed | 0 | All items in the tree control have the same height. |
| itemSftTreeVariable | 1 | The height of each item in the tree control may vary based on item attributes, such as fonts used, graphics sizes, etc. |
### Comments
The Style property defines the item style.
It determines whether [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) or variable height items are used.
See Also SftTreeItems Object | Object Hierarchy
## Text Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text*
Defines the [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells)'s text.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Text** **As String** |
| VB | *String* = *object*.**Text** **As String** |
| C#.NET | **string** *String* = *object*.**Text**; |
| VC++ | **_bstr_t** *String* = *object*->**Text**;
**_bstr_t** *String* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *String* **As String** |
| VB | *object*.**Text** = *String* **As String** |
| C#.NET | **string** *object*.**Text** = *String*; |
| VC++ | **_bstr_t** *object*->**Text** = *String*;
**void** *object*->Put**Text**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *String*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
String
Defines the cell's text.
### Comments
The Text property defines the cell's text.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add), Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) and Items.[InsertAfter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_InsertAfter) methods add new items. The text specified when adding new items always defines the cell text for the first or only column (column 0).
The cell text may contain new-line characters (CR-LF) if [multi-line cell text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_multilinecelltext) is enabled (see Items.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Lines) and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellMultiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline)).
If the cell text is empty, the cell in the preceding column may merge into the empty cell, based on the Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings.
The default cell text alignment for a column is defined using the Column.[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties. A cell can override the default using the [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) and Cell.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) properties.
See Also SftTreeCell Object | Object Hierarchy
## Text Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_Text*
Defines this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)'s text.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Text** **As String** |
| VB | *String* = *object*.**Text** **As String** |
| C#.NET | **string** *String* = *object*.**Text**; |
| VC++ | **_bstr_t** *String* = *object*->**Text**;
**_bstr_t** *String* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *String* **As String** |
| VB | *object*.**Text** = *String* **As String** |
| C#.NET | **string** *object*.**Text** = *String*; |
| VC++ | **_bstr_t** *object*->**Text** = *String*;
**void** *object*->Put**Text**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *String*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
String
Defines this column footer's text.
### Comments
The Text property defines this column footer's text.
The alignment of the column footer text can be defined using the [Footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footer).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextHAlign) and Footer.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextVAlign) properties.
The column footer text may contain new-line characters (CR-LF) if multi-line header text is enabled (see [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Multiline)).
If the column footer text is empty, the column footer of the preceding column may merge into the empty column footer, based on the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) and Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings. The row/column footer never merges into a column footer.
When defining column footer text using the [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) [property page](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_property_dialog), any trailing empty lines are automatically removed. To preserve a trailing empty line, add a space character to the line.
See Also SftTreeFooter Object | Object Hierarchy
## Text Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_Text*
Defines this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders)'s text.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Text** **As String** |
| VB | *String* = *object*.**Text** **As String** |
| C#.NET | **string** *String* = *object*.**Text**; |
| VC++ | **_bstr_t** *String* = *object*->**Text**;
**_bstr_t** *String* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *String* **As String** |
| VB | *object*.**Text** = *String* **As String** |
| C#.NET | **string** *object*.**Text** = *String*; |
| VC++ | **_bstr_t** *object*->**Text** = *String*;
**void** *object*->Put**Text**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *String*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
String
Defines this column header's text.
### Comments
The Text property defines this column header's text.
The alignment of the column header text can be defined using the [Header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Header).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign) and Header.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign) properties.
The column header text may contain new-line characters (CR-LF) if multi-line header text is enabled (see [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline)).
If the column header text is empty, the column header of the preceding column may merge into the empty column header, based on the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Merge](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Merge) and Column.[MergeInto](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MergeInto) property settings. The row/column header never merges into a column header.
When defining column header text using the [Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) [property page](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_property_dialog), any trailing empty lines are automatically removed. To preserve a trailing empty line, add a space character to the line.
See Also SftTreeHeader Object | Object Hierarchy
## Text Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Text*
Defines the text displayed in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**Text** **As String** |
| VB | *Text* = *object*.**Text** **As String** |
| C#.NET | **string** *Text* = *object*.**Text**; |
| VC++ | **_bstr_t** *Text* = *object*->**Text**;
**_bstr_t** *Text* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *Text* **As String** |
| VB | *object*.**Text** = *Text* **As String** |
| C#.NET | **string** *object*.**Text** = *Text*; |
| VC++ | **_bstr_t** *object*->**Text** = *Text*;
**void** *object*->Put**Text**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *Text*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Text
Defines the text displayed in the row/column footer.
### Comments
The Text property defines the text displayed in the row/column footer.
The alignment of the row/column footer text can be defined using the [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextHAlign) and RowColumnFooter.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextVAlign) properties.
The row/column footer supports [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) by using new-line characters (CR-LF) to start a new line. Word-wrap is not supported.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## Text Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text*
Defines the text displayed in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**Text** **As String** |
| VB | *Text* = *object*.**Text** **As String** |
| C#.NET | **string** *Text* = *object*.**Text**; |
| VC++ | **_bstr_t** *Text* = *object*->**Text**;
**_bstr_t** *Text* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *Text*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *Text* **As String** |
| VB | *object*.**Text** = *Text* **As String** |
| C#.NET | **string** *object*.**Text** = *Text*; |
| VC++ | **_bstr_t** *object*->**Text** = *Text*;
**void** *object*->Put**Text**(**_bstr_t** *Text*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *Text*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Text
Defines the text displayed in the row/column header.
### Comments
The Text property defines the text displayed in the row/column header.
The alignment of the row/column header text can be defined using the [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign) and RowColumnHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign) properties.
The row/column header supports [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) by using new-line characters (CR-LF) to start a new line. Word-wrap is not supported.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## Text Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text*
Defines the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders)'s text.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Text** **As String** |
| VB | *String* = *object*.**Text** **As String** |
| C#.NET | **string** *String* = *object*.**Text**; |
| VC++ | **_bstr_t** *String* = *object*->**Text**;
**_bstr_t** *String* = *object*->Get**Text**(); |
| C | **HRESULT** *object*->get_**Text**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Text** = *String* **As String** |
| VB | *object*.**Text** = *String* **As String** |
| C#.NET | **string** *object*.**Text** = *String*; |
| VC++ | **_bstr_t** *object*->**Text** = *String*;
**void** *object*->Put**Text**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Text**(**BSTR** *String*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
String
Defines the row header's text.
### Comments
The Text property defines the row header's text.
The [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) and Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert) methods add new items. The default text of the row header depends on the [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Appearance) property.
Row headers can support [multiple text lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellMultiline) (see RowHeaders.[Lines](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Lines)) by using new-line characters (CR-LF) to start a new line. Word-wrap is not supported.
The default alignment for all row headers is defined using the RowHeaders.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) and RowHeaders.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) properties. A row header can override the default using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) properties.
See Also SftTreeRowHeader Object | Object Hierarchy
## TextHAlign Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign*
Defines the horizontal alignment of the text in this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignDefaultConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignDefaultConstants** |
| C#.NET | **SftTreeHAlignDefaultConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignDefaultConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignDefaultConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignDefaultConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignDefaultConstants** |
| C#.NET | **SftTreeHAlignDefaultConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignDefaultConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignDefaultConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the horizontal alignment of the text in this cell.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeDefault | -1 | The text is aligned as defined using the default settings for this cell's column (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign)). |
| halignSftTreeDefaultLeft | 0 | The cell text is left aligned. |
| halignSftTreeDefaultCenter | 1 | The cell text is centered in the cell. |
| halignSftTreeDefaultRight | 2 | The cell text is right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) property is used to define the vertical alignment of the text in this cell.
The TextHAlign property determines the position of the cell text and graphic, defined using the Cell.[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties. It overrides the column's default alignment defined using the Column.CellHAlign property.
See Also SftTreeCell Object | Object Hierarchy
## TextHAlign Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextHAlign*
Defines the horizontal alignment of the text in this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Style
Defines the horizontal alignment of the text in this column footer.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in this column footer.
To change the default alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text use the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties instead.
The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Multiline) property can be used to enable multi-line column footer text.
See Also SftTreeFooter Object | Object Hierarchy
## TextHAlign Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextHAlign*
Defines the horizontal alignment of the text in this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the horizontal alignment of the text in this column header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in this column header.
To change the default alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text use the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties instead.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline) property can be used to enable multi-line column header text.
See Also SftTreeHeader Object | Object Hierarchy
## TextHAlign Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextHAlign*
Defines the horizontal alignment of the text in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Style
Defines the horizontal alignment of the text in the row/column footer.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in the row/column footer.
The [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Text) property can be used to define the text displayed in the row/column footer.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## TextHAlign Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextHAlign*
Defines the horizontal alignment of the text in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Style
Defines the horizontal alignment of the text in the row/column header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in the row/column header.
The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text) property can be used to define the text displayed in the row/column header.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## TextHAlign Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign*
Defines the horizontal alignment of the text in this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignDefaultConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignDefaultConstants** |
| C#.NET | **SftTreeHAlignDefaultConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignDefaultConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignDefaultConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignDefaultConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignDefaultConstants** |
| C#.NET | **SftTreeHAlignDefaultConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignDefaultConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignDefaultConstants** *Style*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Style
Defines the horizontal alignment of the text in this row header.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeDefault | -1 | The text is aligned as defined using the default settings for all row headers (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign)). |
| halignSftTreeDefaultLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeDefaultCenter | 1 | The text and graphic component are centered. |
| halignSftTreeDefaultRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of the text in this row header.
Row header text and graphics are defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) and RowHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) properties.
The default alignment for all row headers is defined using the RowHeaders.TextHAlign and RowHeaders.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign) properties.
See Also SftTreeRowHeader Object | Object Hierarchy
## TextHAlign Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign*
Defines the horizontal alignment of text in all [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextHAlign** **As [SftTreeHAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeHAlignConstants)** |
| VB | *Style* = *object*.**TextHAlign** **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *Style* = *object*.**TextHAlign**; |
| VC++ | **enum SftTreeHAlignConstants** *Style* = *object*->**TextHAlign**;
**enum SftTreeHAlignConstants** *Style* = *object*->Get**TextHAlign**(); |
| C | **HRESULT** *object*->get_**TextHAlign**(**enum SftTreeHAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| VB | *object*.**TextHAlign** = *Style* **As SftTreeHAlignConstants** |
| C#.NET | **SftTreeHAlignConstants** *object*.**TextHAlign** = *Style*; |
| VC++ | **enum SftTreeHAlignConstants** *object*->**TextHAlign** = *Style*;
**void** *object*->Put**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextHAlign**(**enum SftTreeHAlignConstants** *Style*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Style
Defines the horizontal alignment of text in all row headers.
| Name | Value | Description |
| --- | --- | --- |
| halignSftTreeLeft | 0 | The text and graphic component are left aligned. |
| halignSftTreeCenter | 1 | The text and graphic component are centered. |
| halignSftTreeRight | 2 | The text and graphic component are right aligned. |
### Comments
The TextHAlign property defines the horizontal alignment of text in all row headers.
Individual row headers can override this default using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) properties.
See Also SftTreeRowHeaders Object | Object Hierarchy
## TextVAlign Property, SftTreeCell Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign*
Defines the vertical alignment of the text in this [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignDefaultConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignDefaultConstants** |
| C#.NET | **SftTreeVAlignDefaultConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignDefaultConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignDefaultConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignDefaultConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignDefaultConstants** |
| C#.NET | **SftTreeVAlignDefaultConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignDefaultConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignDefaultConstants** *Style*); |
object
A [SftTreeCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeCell) object.
Style
Defines the vertical alignment of the text in this cell.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeDefault | -1 | The text is aligned as defined using the default settings for this cell's column (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign)). |
| valignSftTreeDefaultCenter | 0 | The cell text is vertically centered. |
| valignSftTreeDefaultTop | 1 | The cell text is aligned with the top of the available area. |
| valignSftTreeDefaultBottom | 2 | The cell text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in this cell.
The [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextHAlign) property is used to define the horizontal alignment of the text in this cell.
The TextVAlign property determines the position of the cell text and graphic, defined using the Cell.[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Text) and Cell.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_Image) properties. It overrides the column's default alignment defined using the Column.CellVAlign property.
See Also SftTreeCell Object | Object Hierarchy
## TextVAlign Property, SftTreeFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooter_TextVAlign*
Defines the vertical alignment of the text in this [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeFooter) object.
Style
Defines the vertical alignment of the text in this column footer.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in this column footer.
To change the default alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text use the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties instead.
The [Footers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Footers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeFooters_Multiline) property can be used to enable multi-line column footer text.
See Also SftTreeFooter Object | Object Hierarchy
## TextVAlign Property, SftTreeHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeader_TextVAlign*
Defines the vertical alignment of the text in this [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeHeader) object.
Style
Defines the vertical alignment of the text in this column header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in this column header.
To change the default alignment of [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text use the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellHAlign) and Column.[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign) properties instead.
The [Headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Headers).[Multiline](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeHeaders_Multiline) property can be used to enable multi-line column header text.
See Also SftTreeHeader Object | Object Hierarchy
## TextVAlign Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_TextVAlign*
Defines the vertical alignment of the text in the row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
Style
Defines the vertical alignment of the text in the row/column footer.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in the row/column footer.
The [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Text) property can be used to define the text displayed in the row/column footer.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## TextVAlign Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_TextVAlign*
Defines the vertical alignment of the text in the row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
Style
Defines the vertical alignment of the text in the row/column header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in the row/column header.
The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Text) property can be used to define the text displayed in the row/column header.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## TextVAlign Property, SftTreeRowHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign*
Defines the vertical alignment of the text in this [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignDefaultConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignDefaultConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignDefaultConstants** |
| C#.NET | **SftTreeVAlignDefaultConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignDefaultConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignDefaultConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignDefaultConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignDefaultConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignDefaultConstants** |
| C#.NET | **SftTreeVAlignDefaultConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignDefaultConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignDefaultConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignDefaultConstants** *Style*); |
object
A [SftTreeRowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeader) object.
Style
Defines the vertical alignment of the text in this row header.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeDefault | -1 | The text is aligned as defined using the default settings for all row headers (see [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign)). |
| valignSftTreeDefaultCenter | 0 | The text is vertically centered. |
| valignSftTreeDefaultTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeDefaultBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of the text in this row header.
Row header text and graphics are defined using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[Text](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Text) and RowHeader.[Image](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_Image) properties.
The default alignment for all row headers is defined using the RowHeaders.[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextHAlign) and RowHeaders.TextVAlign properties.
See Also SftTreeRowHeader Object | Object Hierarchy
## TextVAlign Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_TextVAlign*
Defines the vertical alignment of text in all [row headers](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TextVAlign** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *Style* = *object*.**TextVAlign** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *Style* = *object*.**TextVAlign**; |
| VC++ | **enum SftTreeVAlignConstants** *Style* = *object*->**TextVAlign**;
**enum SftTreeVAlignConstants** *Style* = *object*->Get**TextVAlign**(); |
| C | **HRESULT** *object*->get_**TextVAlign**(**enum SftTreeVAlignConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| VB | *object*.**TextVAlign** = *Style* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**TextVAlign** = *Style*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**TextVAlign** = *Style*;
**void** *object*->Put**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
| C | **HRESULT** *object*->put_**TextVAlign**(**enum SftTreeVAlignConstants** *Style*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
Style
Defines the vertical alignment of text in all row headers.
| Name | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The text is vertically centered. |
| valignSftTreeTop | 1 | The text is aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The text is aligned with the bottom of the available area. |
### Comments
The TextVAlign property defines the vertical alignment of text in all row headers.
Individual row headers can override this default using the [RowHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_RowHeader).[TextHAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextHAlign) and RowHeader.[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeader_TextVAlign) properties.
See Also SftTreeRowHeaders Object | Object Hierarchy
## ToolTip Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip*
Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are used for [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) in this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ToolTip** **As Boolean** |
| VB | *Boolean* = *object*.**ToolTip** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ToolTip**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ToolTip**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ToolTip**(); |
| C | **HRESULT** *object*->get_**ToolTip**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTip** = *Boolean* **As Boolean** |
| VB | *object*.**ToolTip** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ToolTip** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ToolTip** = *Boolean*;
**void** *object*->Put**ToolTip**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ToolTip**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
Boolean
Defines whether Tool Tips are used for cells in this column.
| Boolean | Description |
| --- | --- |
| True | Tool Tips are displayed for cells in this column if the cell text and/or graphic component are clipped. Also see the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways) property. |
| False | No Tool Tips are displayed for cells in this column. |
### Comments
The ToolTip property defines whether Tool Tips are used for cells in this column.
See Also SftTreeColumn Object | Object Hierarchy
## ToolTipAlways Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipAlways*
Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are shown, even if [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text is completely visible.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ToolTipAlways** **As Boolean** |
| VB | *Boolean* = *object*.**ToolTipAlways** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ToolTipAlways**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ToolTipAlways**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ToolTipAlways**(); |
| C | **HRESULT** *object*->get_**ToolTipAlways**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipAlways** = *Boolean* **As Boolean** |
| VB | *object*.**ToolTipAlways** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ToolTipAlways** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ToolTipAlways** = *Boolean*;
**void** *object*->Put**ToolTipAlways**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ToolTipAlways**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether Tool Tips are shown, even if cell text is completely visible.
| Boolean | Description |
| --- | --- |
| True | Tool Tips are shown, even if cell text is completely visible. |
| False | Tool Tips are only shown, if cell text is partially visible. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ToolTipAlways instead
The ToolTipAlways property defines whether Tool Tips are shown, even if cell text is completely visible.
Individual columns can enable or disable Tool Tips by using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip) property.
See Also SftTree Object | Object Hierarchy
## ToolTipAlways Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways*
Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are shown, even if [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) text is completely visible.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ToolTipAlways** **As Boolean** |
| VB | *Boolean* = *object*.**ToolTipAlways** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ToolTipAlways**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ToolTipAlways**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ToolTipAlways**(); |
| C | **HRESULT** *object*->get_**ToolTipAlways**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipAlways** = *Boolean* **As Boolean** |
| VB | *object*.**ToolTipAlways** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ToolTipAlways** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ToolTipAlways** = *Boolean*;
**void** *object*->Put**ToolTipAlways**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ToolTipAlways**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether Tool Tips are shown, even if cell text is completely visible.
| Boolean | Description |
| --- | --- |
| True | Tool Tips are shown, even if cell text is completely visible. |
| False | Tool Tips are only shown, if cell text is partially visible. |
### Comments
The ToolTipAlways property defines whether Tool Tips are shown, even if cell text is completely visible.
Individual columns can enable or disable Tool Tips by using the [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip) property.
See Also SftTreeItems Object | Object Hierarchy
## ToolTipBackColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipBackColor*
Defines the background color used to draw [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) and [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipBackColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipBackColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ToolTipBackColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ToolTipBackColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ToolTipBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ToolTipBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**ToolTipBackColor**(); |
| C | **HRESULT** *object*->get_**ToolTipBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipBackColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ToolTipBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ToolTipBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ToolTipBackColor** = *Clr*;
**void** *object*->Put**ToolTipBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ToolTipBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the background color used to draw Tool Tips and Scroll Tips. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ToolTipBackColor instead
The ToolTipBackColor property defines the background color used to draw Tool Tips and Scroll Tips.
See Also SftTree Object | Object Hierarchy
## ToolTipBackColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipBackColor*
Defines the background color used to draw [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) and [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ToolTipBackColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ToolTipBackColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ToolTipBackColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ToolTipBackColor**;
**OLE_COLOR** *Clr* = *object*->Get**ToolTipBackColor**(); |
| C | **HRESULT** *object*->get_**ToolTipBackColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipBackColor** = *Clr* **As UInteger** |
| VB | *object*.**ToolTipBackColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ToolTipBackColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ToolTipBackColor** = *Clr*;
**void** *object*->Put**ToolTipBackColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ToolTipBackColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the background color used to draw Tool Tips and Scroll Tips. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ToolTipBackColor property defines the background color used to draw Tool Tips and Scroll Tips.
See Also SftTreeItems Object | Object Hierarchy
## ToolTipCell Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipCell*
A [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) is about to be displayed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ToolTipCell**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ToolTipCell** |
| VB | **Private Sub** *object*_**ToolTipCell**(*Text* **As String**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**ToolTipCell**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ToolTipCell***object*(**_bstr_t*** *Text*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**ToolTipCell***object*(**BSTR*** *Text*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
The default cell Tool Tip text. An application can override the default text by assigning a new string to the *Text* parameter. This string is displayed as an explanatory Tool Tip relative to the mouse cursor. It is not possible to override Tool Tip text that is displayed in the cell's location. If *Text* is set to an empty string, no Tool Tip is displayed. A maximum string length of 1000 characters is supported.
ItemIndex
The zero-based item index. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
ColIndex
The zero-based column number. The combination of *ItemIndex* and *ColIndex* describes an individual cell.
### Comments
The ToolTipCell event occurs when a cell Tool Tip is about to be displayed.
Tool Tips are enabled for each column individually (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[ToolTip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_ToolTip)). It is also possible to display Tool Tips even if the cells are already completely visible (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipAlways](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipAlways) property).
See Also SftTree Object | Object Hierarchy
## ToolTipColumn Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumn*
A [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) is about to be displayed.
> Deprecated - Provided for compatibility with earlier versions only - Use the [ToolTipColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumnHeader) event instead
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ToolTipColumn**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ToolTipColumn** |
| VB | **Private Sub** *object*_**ToolTipColumn**(*Text* **As String**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**ToolTipColumn**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ToolTipColumn***object*(**_bstr_t*** *Text*, **short** *ColIndex*); |
| C | **HRESULT** On**ToolTipColumn***object*(**BSTR*** *Text*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
The Tool Tip text. If *Text* is set to an empty string (the default), no Tool Tip is displayed. A maximum string length of 1000 characters is supported.
ColIndex
The zero-based number of the column for which a Tool Tip is about to be displayed.
### Comments
The [ToolTipColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumn) event occurs when a column header Tool Tip is about to be displayed.
> Deprecated - Provided for compatibility with earlier versions only - Use the ToolTipColumnHeader event instead
The ToolTipColumn event occurs when the mouse cursor pauses above a column header. By implementing the ToolTipColumn event, an application can provide text in the * Text* parameter, which is used to display a Tool Tip for the column header *ColIndex*. The Tool Tip is displayed as an explanatory Tool Tip relative to the mouse cursor.
See Also SftTree Object | Object Hierarchy
## ToolTipColumnFooter Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumnFooter*
A [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) is about to be displayed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ToolTipColumnFooter**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ToolTipColumnFooter** |
| VB | **Private Sub** *object*_**ToolTipColumnFooter**(*Text* **As String**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**ToolTipColumnFooter**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ToolTipColumnFooter***object*(**_bstr_t*** *Text*, **short** *ColIndex*); |
| C | **HRESULT** On**ToolTipColumnFooter***object*(**BSTR*** *Text*, **short** *ColIndex*); |
object
A SftTreeEvents object.
Text
The Tool Tip text. If *Text* is set to an empty string (the default), no Tool Tip is displayed. A maximum string length of 1000 characters is supported.
ColIndex
The zero-based number of the column for which a Tool Tip is about to be displayed.
### Comments
The ToolTipColumnFooter event occurs when a column footer Tool Tip is about to be displayed.
The ToolTipColumnFooter event occurs when the mouse cursor pauses above a column footer. By implementing the ToolTipColumnFooter event, an application can provide text in the * Text* parameter, which is used to display a Tool Tip for the column footer *ColIndex*. The Tool Tip is displayed as an explanatory Tool Tip relative to the mouse cursor.
See Also SftTreeEvents Object | Object Hierarchy
## ToolTipColumnHeader Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipColumnHeader*
A [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) is about to be displayed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ToolTipColumnHeader**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ToolTipColumnHeader** |
| VB | **Private Sub** *object*_**ToolTipColumnHeader**(*Text* **As String**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**ToolTipColumnHeader**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ToolTipColumnHeader***object*(**_bstr_t*** *Text*, **short** *ColIndex*); |
| C | **HRESULT** On**ToolTipColumnHeader***object*(**BSTR*** *Text*, **short** *ColIndex*); |
object
A SftTreeEvents object.
Text
The Tool Tip text. If *Text* is set to an empty string (the default), no Tool Tip is displayed. A maximum string length of 1000 characters is supported.
ColIndex
The zero-based number of the column for which a Tool Tip is about to be displayed.
### Comments
The ToolTipColumnHeader event occurs when a column header Tool Tip is about to be displayed.
The ToolTipColumnHeader event occurs when the mouse cursor pauses above a column header. By implementing the ToolTipColumnHeader event, an application can provide text in the * Text* parameter, which is used to display a Tool Tip for the column header *ColIndex*. The Tool Tip is displayed as an explanatory Tool Tip relative to the mouse cursor.
See Also SftTreeEvents Object | Object Hierarchy
## ToolTipForeColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipForeColor*
Defines the text color used to draw [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) and [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipForeColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipForeColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ToolTipForeColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ToolTipForeColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**ToolTipForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ToolTipForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ToolTipForeColor**(); |
| C | **HRESULT** *object*->get_**ToolTipForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipForeColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**ToolTipForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**ToolTipForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ToolTipForeColor** = *Clr*;
**void** *object*->Put**ToolTipForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ToolTipForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the text color used to draw Tool Tips and Scroll Tips. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ToolTipForeColor instead
The ToolTipForeColor property defines the text color used to draw Tool Tips and Scroll Tips.
See Also SftTree Object | Object Hierarchy
## ToolTipForeColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipForeColor*
Defines the text color used to draw [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) and [Scroll Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**ToolTipForeColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**ToolTipForeColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**ToolTipForeColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**ToolTipForeColor**;
**OLE_COLOR** *Clr* = *object*->Get**ToolTipForeColor**(); |
| C | **HRESULT** *object*->get_**ToolTipForeColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipForeColor** = *Clr* **As UInteger** |
| VB | *object*.**ToolTipForeColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**ToolTipForeColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**ToolTipForeColor** = *Clr*;
**void** *object*->Put**ToolTipForeColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**ToolTipForeColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the text color used to draw Tool Tips and Scroll Tips. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The ToolTipForeColor property defines the text color used to draw Tool Tips and Scroll Tips.
See Also SftTreeItems Object | Object Hierarchy
## ToolTipIntervalOff Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipIntervalOff*
Defines the delay (in milliseconds) after which [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are removed.
> This property is identical to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipIntervalOff](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOff), which should be used instead.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**ToolTipIntervalOff** **As Integer** |
| VB | *milliSeconds* = *object*.**ToolTipIntervalOff** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**ToolTipIntervalOff**; |
| VC++ | **long** *milliSeconds* = *object*->**ToolTipIntervalOff**;
**long** *milliSeconds* = *object*->Get**ToolTipIntervalOff**(); |
| C | **HRESULT** *object*->get_**ToolTipIntervalOff**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipIntervalOff** = *milliSeconds* **As Integer** |
| VB | *object*.**ToolTipIntervalOff** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**ToolTipIntervalOff** = *milliSeconds*; |
| VC++ | **long** *object*->**ToolTipIntervalOff** = *milliSeconds*;
**void** *object*->Put**ToolTipIntervalOff**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**ToolTipIntervalOff**(**long** *milliSeconds*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
milliSeconds
Defines the delay (in milliseconds) after which Tool Tips are removed.
### Comments
> This property is identical to Items.ToolTipIntervalOff, which should be used instead.
The ToolTipIntervalOff property defines the delay (in milliseconds) after which Tool Tips are removed.
See Also SftTree Object | Object Hierarchy
## ToolTipIntervalOff Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOff*
Defines the delay (in milliseconds) after which [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are removed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**ToolTipIntervalOff** **As Integer** |
| VB | *milliSeconds* = *object*.**ToolTipIntervalOff** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**ToolTipIntervalOff**; |
| VC++ | **long** *milliSeconds* = *object*->**ToolTipIntervalOff**;
**long** *milliSeconds* = *object*->Get**ToolTipIntervalOff**(); |
| C | **HRESULT** *object*->get_**ToolTipIntervalOff**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipIntervalOff** = *milliSeconds* **As Integer** |
| VB | *object*.**ToolTipIntervalOff** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**ToolTipIntervalOff** = *milliSeconds*; |
| VC++ | **long** *object*->**ToolTipIntervalOff** = *milliSeconds*;
**void** *object*->Put**ToolTipIntervalOff**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**ToolTipIntervalOff**(**long** *milliSeconds*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
milliSeconds
Defines the delay (in milliseconds) after which Tool Tips are removed. If 0 is specified, the default of 100 milliseconds is used instead.
### Comments
The ToolTipIntervalOff property defines the delay (in milliseconds) after which Tool Tips are removed.
The ToolTipIntervalOff applies to all Tool Tips ([cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) ToolTips).
The [ToolTipIntervalOn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOn) property is used to define the delay (in milliseconds) after which Tool Tips are displayed.
See Also SftTreeItems Object | Object Hierarchy
## ToolTipIntervalOn Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipIntervalOn*
Defines the delay (in milliseconds) after which [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are displayed.
> This property is identical to [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipIntervalOn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOn), which should be used instead.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**ToolTipIntervalOn** **As Integer** |
| VB | *milliSeconds* = *object*.**ToolTipIntervalOn** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**ToolTipIntervalOn**; |
| VC++ | **long** *milliSeconds* = *object*->**ToolTipIntervalOn**;
**long** *milliSeconds* = *object*->Get**ToolTipIntervalOn**(); |
| C | **HRESULT** *object*->get_**ToolTipIntervalOn**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipIntervalOn** = *milliSeconds* **As Integer** |
| VB | *object*.**ToolTipIntervalOn** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**ToolTipIntervalOn** = *milliSeconds*; |
| VC++ | **long** *object*->**ToolTipIntervalOn** = *milliSeconds*;
**void** *object*->Put**ToolTipIntervalOn**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**ToolTipIntervalOn**(**long** *milliSeconds*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
milliSeconds
Defines the delay (in milliseconds) after which Tool Tips are displayed.
### Comments
> This property is identical to Items.ToolTipIntervalOn, which should be used instead.
The ToolTipIntervalOn property defines the delay (in milliseconds) after which Tool Tips are displayed.
See Also SftTree Object | Object Hierarchy
## ToolTipIntervalOn Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOn*
Defines the delay (in milliseconds) after which [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) are displayed.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *milliSeconds* = *object*.**ToolTipIntervalOn** **As Integer** |
| VB | *milliSeconds* = *object*.**ToolTipIntervalOn** **As Long** |
| C#.NET | **int** *milliSeconds* = *object*.**ToolTipIntervalOn**; |
| VC++ | **long** *milliSeconds* = *object*->**ToolTipIntervalOn**;
**long** *milliSeconds* = *object*->Get**ToolTipIntervalOn**(); |
| C | **HRESULT** *object*->get_**ToolTipIntervalOn**(**long*** *milliSeconds*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipIntervalOn** = *milliSeconds* **As Integer** |
| VB | *object*.**ToolTipIntervalOn** = *milliSeconds* **As Long** |
| C#.NET | **int** *object*.**ToolTipIntervalOn** = *milliSeconds*; |
| VC++ | **long** *object*->**ToolTipIntervalOn** = *milliSeconds*;
**void** *object*->Put**ToolTipIntervalOn**(**long** *milliSeconds*); |
| C | **HRESULT** *object*->put_**ToolTipIntervalOn**(**long** *milliSeconds*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
milliSeconds
Defines the delay (in milliseconds) after which Tool Tips are displayed. If 0 is specified, the default of 200 milliseconds is used instead.
### Comments
The ToolTipIntervalOn property defines the delay (in milliseconds) after which Tool Tips are displayed.
The ToolTipIntervalOn applies to all Tool Tips ([cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells), [column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and [column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) ToolTips).
The [ToolTipIntervalOff](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipIntervalOff) property is used to define the delay (in milliseconds) after which Tool Tips are removed.
See Also SftTreeItems Object | Object Hierarchy
## ToolTipsUseEntireCell Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ToolTipsUseEntireCell*
Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) use the entire [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[ToolTipsUseEntireCell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipsUseEntireCell) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ToolTipsUseEntireCell** **As Boolean** |
| VB | *Boolean* = *object*.**ToolTipsUseEntireCell** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ToolTipsUseEntireCell**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ToolTipsUseEntireCell**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ToolTipsUseEntireCell**(); |
| C | **HRESULT** *object*->get_**ToolTipsUseEntireCell**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipsUseEntireCell** = *Boolean* **As Boolean** |
| VB | *object*.**ToolTipsUseEntireCell** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ToolTipsUseEntireCell** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ToolTipsUseEntireCell** = *Boolean*;
**void** *object*->Put**ToolTipsUseEntireCell**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ToolTipsUseEntireCell**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether Tool Tips use the entire cell.
| Boolean | Description |
| --- | --- |
| True | Tool Tips use the entire cell. |
| False | Tool Tips are optimized in height and width and only use the minimum required space. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.ToolTipsUseEntireCell instead
The ToolTipsUseEntireCell property defines whether Tool Tips use the entire cell.
Tool Tips are normally optimized in size to use a minimal amount of space vertically or horizontally to display the cell contents. By setting ToolTipsUseEntireCell to True, a cell Tool Tip will always use the entire cell height and width.
ToolTipsUseEntireCell has no effect if grid lines are not shown (see Items.[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle)).
See Also SftTree Object | Object Hierarchy
## ToolTipsUseEntireCell Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_ToolTipsUseEntireCell*
Defines whether [Tool Tips](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) use the entire [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**ToolTipsUseEntireCell** **As Boolean** |
| VB | *Boolean* = *object*.**ToolTipsUseEntireCell** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**ToolTipsUseEntireCell**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**ToolTipsUseEntireCell**;
**VARIANT_BOOL** *Boolean* = *object*->Get**ToolTipsUseEntireCell**(); |
| C | **HRESULT** *object*->get_**ToolTipsUseEntireCell**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**ToolTipsUseEntireCell** = *Boolean* **As Boolean** |
| VB | *object*.**ToolTipsUseEntireCell** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**ToolTipsUseEntireCell** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**ToolTipsUseEntireCell** = *Boolean*;
**void** *object*->Put**ToolTipsUseEntireCell**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**ToolTipsUseEntireCell**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether Tool Tips use the entire cell.
| Boolean | Description |
| --- | --- |
| True | Tool Tips use the entire cell. |
| False | Tool Tips are optimized in height and width and only use the minimum required space. |
### Comments
The ToolTipsUseEntireCell property defines whether Tool Tips use the entire cell.
Tool Tips are normally optimized in size to use a minimal amount of space vertically or horizontally to display the cell contents. By setting ToolTipsUseEntireCell to True, a cell Tool Tip will always use the entire cell height and width.
ToolTipsUseEntireCell has no effect if grid lines are not shown (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[GridStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_GridStyle)).
See Also SftTreeItems Object | Object Hierarchy
## ToolTipVScroll Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ToolTipVScroll*
A ScrollTip is about to be displayed.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**ToolTipVScroll**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**ToolTipVScroll** |
| VB | **Private Sub** *object*_**ToolTipVScroll**(*Text* **As String**, **ByVal** *ItemIndex* **As Long**, **ByVal** *ColIndex* **As Integer**) |
| C#.NET | **void** *object*_**ToolTipVScroll**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**ToolTipVScroll***object*(**_bstr_t*** *Text*, **long** *ItemIndex*, **short** *ColIndex*); |
| C | **HRESULT** On**ToolTipVScroll***object*(**BSTR*** *Text*, **long** *ItemIndex*, **short** *ColIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
The default [Scroll Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_scrolltips) text. The application can override the default text by assigning a new string to the *Text* parameter. This string is displayed as the [Tool Tip](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_tooltips) instead. If *Text* is set to an empty string, no Tool Tip is displayed. A maximum string length of 1000 characters is supported.
ItemIndex
The zero-based index of the first item currently displayed in the tree control client area (see [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex)).
ColIndex
The zero-based column number of the first column displayed.
### Comments
The ToolTipVScroll event occurs when a ScrollTip is about to be displayed.
The ToolTipVScroll event occurs when the user scrolls the tree control contents vertically by dragging the vertical scroll bar's scroll box using the mouse.
See Also SftTree Object | Object Hierarchy
## TopChange Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_TopChange*
The user scrolls the tree control vertically.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**TopChange**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**TopChange** |
| VB | **Private Sub** *object*_**TopChange**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*_**TopChange**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**TopChange***object*(**long** *ItemIndex*); |
| C | **HRESULT** On**TopChange***object*(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index number of the new first item displayed in the tree control's client area.
### Comments
The TopChange event occurs when the user scrolls the tree control vertically.
The TopChange event notifies an application that the user has caused the tree contents to be scrolled vertically.
The [OffsetChange](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_OffsetChange) event can be used to determine [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) by the user.
See Also SftTree Object | Object Hierarchy
## TopIndex Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TopIndex*
Defines the index of the first item displayed in the tree control's client area.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TopIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**TopIndex** **As Integer** |
| VB | *ItemIndex* = *object*.**TopIndex** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**TopIndex**; |
| VC++ | **long** *ItemIndex* = *object*->**TopIndex**;
**long** *ItemIndex* = *object*->Get**TopIndex**(); |
| C | **HRESULT** *object*->get_**TopIndex**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TopIndex** = *ItemIndex* **As Integer** |
| VB | *object*.**TopIndex** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**TopIndex** = *ItemIndex*; |
| VC++ | **long** *object*->**TopIndex** = *ItemIndex*;
**void** *object*->Put**TopIndex**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**TopIndex**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
Defines the index of the first item displayed in the tree control's client area.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.TopIndex instead
The TopIndex property defines the index of the first item displayed in the tree control's client area.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used to insure that an item is displayed anywhere in the tree control area. The TopIndex property is used to make the item specified the very first item shown in the tree control area.
See Also SftTree Object | Object Hierarchy
## TopIndex Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TopIndex*
Defines the index of the first item displayed in the tree control's client area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**TopIndex** **As Integer** |
| VB | *ItemIndex* = *object*.**TopIndex** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**TopIndex**; |
| VC++ | **long** *ItemIndex* = *object*->**TopIndex**;
**long** *ItemIndex* = *object*->Get**TopIndex**(); |
| C | **HRESULT** *object*->get_**TopIndex**(**long*** *ItemIndex*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TopIndex** = *ItemIndex* **As Integer** |
| VB | *object*.**TopIndex** = *ItemIndex* **As Long** |
| C#.NET | **int** *object*.**TopIndex** = *ItemIndex*; |
| VC++ | **long** *object*->**TopIndex** = *ItemIndex*;
**void** *object*->Put**TopIndex**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->put_**TopIndex**(**long** *ItemIndex*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
ItemIndex
Defines the index of the first item displayed in the tree control's client area.
### Comments
The TopIndex property defines the index of the first item displayed in the tree control's client area.
The [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[MakeVisible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_MakeVisible) method can be used to insure that an item is displayed anywhere in the tree control area. The TopIndex property is used to make the item specified the very first item shown in the tree control area.
See Also SftTreeItems Object | Object Hierarchy
## TopParent Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TopParent*
Returns the index of an item's top-most parent item.
> Deprecated - Provided for compatibility with earlier versions only - Use [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[TopParent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_TopParent) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ParentIndex* = *object*.get_**TopParent**(**ByVal** *ItemIndex* **As Integer**) **As Integer** |
| VB | *ParentIndex* = *object*.**TopParent**(**ByVal** *ItemIndex* **As Long**) **As Long** |
| C#.NET | **int** *ParentIndex* = *object*.get_**TopParent**(**int** *ItemIndex*); |
| VC++ | **long** *ParentIndex* = *object*->**TopParent**[**long** *ItemIndex*];
**long** *ParentIndex* = *object*->Get**TopParent**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->get_**TopParent**(**long** *ItemIndex*, **long*** *ParentIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item whose top-most parent item index is to be returned.
ParentIndex
Returns the zero-based index of the item's top-most parent item (which itself doesn't have a parent). If the item doesn't have a parent, -1 is returned.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Item.TopParent instead
The TopParent property returns the index of an item's top-most parent item.
To find an item's immediate parent, use the Item.[Parent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Parent) property instead.
See Also SftTree Object | Object Hierarchy
## TopParent Property, SftTreeItem Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_TopParent*
Returns the item's top-most parent item.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *ItemIndex* = *object*.**TopParent** **As Integer** |
| VB | *ItemIndex* = *object*.**TopParent** **As Long** |
| C#.NET | **int** *ItemIndex* = *object*.**TopParent**; |
| VC++ | **long** *ItemIndex* = *object*->**TopParent**;
**long** *ItemIndex* = *object*->Get**TopParent**(); |
| C | **HRESULT** *object*->get_**TopParent**(**long*** *ItemIndex*); |
object
A [SftTreeItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItem) object.
ItemIndex
Returns the zero-based index of the item's top-most parent item (which itself doesn't have a parent). If the item doesn't have a parent, -1 is returned.
### Comments
The TopParent property returns the item's top-most parent item.
To find an item's immediate parent, use the [Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Item).[Parent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItem_Parent) property instead.
See Also SftTreeItem Object | Object Hierarchy
## TreeLineColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineColor*
Defines the color used to draw connecting tree lines when the tree control is enabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**TreeLineColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**TreeLineColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**TreeLineColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**TreeLineColor**;
**OLE_COLOR** *Clr* = *object*->Get**TreeLineColor**(); |
| C | **HRESULT** *object*->get_**TreeLineColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**TreeLineColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**TreeLineColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**TreeLineColor** = *Clr*;
**void** *object*->Put**TreeLineColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**TreeLineColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw connecting tree lines when the tree control is enabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.TreeLineColor instead
The TreeLineColor property defines the color used to draw connecting tree lines when the tree control is enabled.
Based on the Items.[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) property, connecting tree lines are displayed using the specified color *Clr*.
See Also SftTree Object | Object Hierarchy
## TreeLineColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineColor*
Defines the color used to draw connecting tree lines when the tree control is enabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**TreeLineColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**TreeLineColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**TreeLineColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**TreeLineColor**;
**OLE_COLOR** *Clr* = *object*->Get**TreeLineColor**(); |
| C | **HRESULT** *object*->get_**TreeLineColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineColor** = *Clr* **As UInteger** |
| VB | *object*.**TreeLineColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**TreeLineColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**TreeLineColor** = *Clr*;
**void** *object*->Put**TreeLineColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**TreeLineColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw connecting tree lines when the tree control is enabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The TreeLineColor property defines the color used to draw connecting tree lines when the tree control is enabled.
Based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) property, connecting tree lines are displayed using the specified color *Clr*.
See Also SftTreeItems Object | Object Hierarchy
## TreeLineGrayedColor Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineGrayedColor*
Defines the color used to draw connecting tree lines when the tree control is disabled.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineGrayedColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineGrayedColor) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**TreeLineGrayedColor** **As System.Drawing.Color[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**TreeLineGrayedColor** **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *Clr* = *object*.**TreeLineGrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**TreeLineGrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**TreeLineGrayedColor**(); |
| C | **HRESULT** *object*->get_**TreeLineGrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineGrayedColor** = *Clr* **As System.Drawing.Color** |
| VB | *object*.**TreeLineGrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **System.Drawing.Color** *object*.**TreeLineGrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**TreeLineGrayedColor** = *Clr*;
**void** *object*->Put**TreeLineGrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**TreeLineGrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Clr
Defines the color used to draw connecting tree lines when the tree control is disabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.TreeLineGrayedColor instead
The TreeLineGrayedColor property defines the color used to draw connecting tree lines when the tree control is disabled.
Based on the Items.[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) property, connecting tree lines are displayed using the specified color *Clr* when the tree control is disabled.
See Also SftTree Object | Object Hierarchy
## TreeLineGrayedColor Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineGrayedColor*
Defines the color used to draw connecting tree lines when the tree control is disabled.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Clr* = *object*.**TreeLineGrayedColor** **As UInteger[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)** |
| VB | *Clr* = *object*.**TreeLineGrayedColor** **As OLE_COLOR** |
| C#.NET | **uint** *Clr* = *object*.**TreeLineGrayedColor**; |
| VC++ | **OLE_COLOR** *Clr* = *object*->**TreeLineGrayedColor**;
**OLE_COLOR** *Clr* = *object*->Get**TreeLineGrayedColor**(); |
| C | **HRESULT** *object*->get_**TreeLineGrayedColor**(**OLE_COLOR*** *Clr*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineGrayedColor** = *Clr* **As UInteger** |
| VB | *object*.**TreeLineGrayedColor** = *Clr* **As OLE_COLOR** |
| C#.NET | **uint** *object*.**TreeLineGrayedColor** = *Clr*; |
| VC++ | **OLE_COLOR** *object*->**TreeLineGrayedColor** = *Clr*;
**void** *object*->Put**TreeLineGrayedColor**(**OLE_COLOR** *Clr*); |
| C | **HRESULT** *object*->put_**TreeLineGrayedColor**(**OLE_COLOR** *Clr*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Clr
Defines the color used to draw connecting tree lines when the tree control is disabled. For information about color properties, please visit the applicable section "[Using SftTree/OCX with ...](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using)".
### Comments
The TreeLineGrayedColor property defines the color used to draw connecting tree lines when the tree control is disabled.
Based on the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) property, connecting tree lines are displayed using the specified color *Clr* when the tree control is disabled.
See Also SftTreeItems Object | Object Hierarchy
## TreeLineStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_TreeLineStyle*
Defines the current tree line display style.
> Deprecated - Provided for compatibility with earlier versions only - Use [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[TreeLineStyle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle) instead
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TreeLineStyle** **As [SftTreeTreeLineStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeTreeLineStyleConstants)** |
| VB | *Style* = *object*.**TreeLineStyle** **As SftTreeTreeLineStyleConstants** |
| C#.NET | **SftTreeTreeLineStyleConstants** *Style* = *object*.**TreeLineStyle**; |
| VC++ | **enum SftTreeTreeLineStyleConstants** *Style* = *object*->**TreeLineStyle**;
**enum SftTreeTreeLineStyleConstants** *Style* = *object*->Get**TreeLineStyle**(); |
| C | **HRESULT** *object*->get_**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineStyle** = *Style* **As SftTreeTreeLineStyleConstants** |
| VB | *object*.**TreeLineStyle** = *Style* **As SftTreeTreeLineStyleConstants** |
| C#.NET | **SftTreeTreeLineStyleConstants** *object*.**TreeLineStyle** = *Style*; |
| VC++ | **enum SftTreeTreeLineStyleConstants** *object*->**TreeLineStyle** = *Style*;
**void** *object*->Put**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants** *Style*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Style
Defines the current tree line display style.
| Style | Value | Description |
| --- | --- | --- |
| treeSftTreeNone | 0 | Connecting tree lines are not shown. |
| treeSftTreeShown | 1 | Connecting tree lines are shown between all items on levels 1 and lower. Items on level 0 (i.e., top-most items) are not connected to their child items. |
| treeSftTreeDotted | 2 | Connecting dotted tree lines are shown between all items on levels 1 and lower. Items on level 0 (i.e., top-most items) are not connected to their child items. |
| treeSftTreeDotted0 | 3 | Connecting dotted tree lines are shown between all items. |
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use Items.TreeLineStyle instead
The TreeLineStyle property defines the current tree line display style.
The Items.[TreeLineColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineColor) defines the color used to draw connecting tree lines.
See Also SftTree Object | Object Hierarchy
## TreeLineStyle Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineStyle*
Defines the current tree line display style.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**TreeLineStyle** **As [SftTreeTreeLineStyleConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeTreeLineStyleConstants)** |
| VB | *Style* = *object*.**TreeLineStyle** **As SftTreeTreeLineStyleConstants** |
| C#.NET | **SftTreeTreeLineStyleConstants** *Style* = *object*.**TreeLineStyle**; |
| VC++ | **enum SftTreeTreeLineStyleConstants** *Style* = *object*->**TreeLineStyle**;
**enum SftTreeTreeLineStyleConstants** *Style* = *object*->Get**TreeLineStyle**(); |
| C | **HRESULT** *object*->get_**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants*** *Style*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**TreeLineStyle** = *Style* **As SftTreeTreeLineStyleConstants** |
| VB | *object*.**TreeLineStyle** = *Style* **As SftTreeTreeLineStyleConstants** |
| C#.NET | **SftTreeTreeLineStyleConstants** *object*.**TreeLineStyle** = *Style*; |
| VC++ | **enum SftTreeTreeLineStyleConstants** *object*->**TreeLineStyle** = *Style*;
**void** *object*->Put**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants** *Style*); |
| C | **HRESULT** *object*->put_**TreeLineStyle**(**enum SftTreeTreeLineStyleConstants** *Style*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Style
Defines the current tree line display style.
| Style | Value | Description |
| --- | --- | --- |
| treeSftTreeNone | 0 | Connecting tree lines are not shown. |
| treeSftTreeShown | 1 | Connecting tree lines are shown between all items on levels 1 and lower. [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items) on level 0 (i.e., top-most items) are not connected to their child items. |
| treeSftTreeDotted | 2 | Connecting dotted tree lines are shown between all items on levels 1 and lower. Items on level 0 (i.e., top-most items) are not connected to their child items. |
| treeSftTreeDotted0 | 3 | Connecting dotted tree lines are shown between all items. |
| treeSftTreeInvisible | 4 | Connecting tree lines are not shown, but all layout and formatting is calculated as if they were present. This only affects the horizontal indentation of levels. |
| treeSftTreeAutomatic | 5 | On all supported Windows platforms, connecting dotted tree lines are not shown (using treeSftTreeInvisible). |
| treeSftTreeAutomatic0 | 6 | On all supported Windows platforms, connecting dotted tree lines are not shown (using treeSftTreeInvisible). |
### Comments
The TreeLineStyle property defines the current tree line display style.
The Items.[TreeLineColor](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_TreeLineColor) defines the color used to draw connecting tree lines.
See Also SftTreeItems Object | Object Hierarchy
## Type Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type*
Returns the defined image type.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[Style](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Style)* = *object*.**Type** **As [SftPictureTypeConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)** |
| VB | *Style* = *object*.**Type** **As SftPictureTypeConstants** |
| C#.NET | **SftPictureTypeConstants** *Style* = *object*.**Type**; |
| VC++ | **enum SftPictureTypeConstants** *Style* = *object*->**Type**;
**enum SftPictureTypeConstants** *Style* = *object*->Get**Type**(); |
| C | **HRESULT** *object*->get_**Type**(**enum SftPictureTypeConstants*** *Style*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
Style
Returns the defined image type.
| Name | Value | Description |
| --- | --- | --- |
| sftTypeNone | 0 | None - The SftPictureObject is empty. |
| sftTypeIDispatch | 1 | IDispatch - Contains an OLE [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object (supporting the IPicture or IPictureDisp interface). |
| sftTypeBitmap | 2 | Bitmap - Contains a Windows bitmap. |
| sftTypeIcon | 3 | Icon - Contains an icon. |
| sftTypeImageList | 4 | ImageList - Contains an image from an ImageList control. |
| sftTypeColorSample | 5 | Color Sample - Contains a color sample. |
| sftTypeBuiltin | 6 | Built-In Appearance - Contains a predefined built-in image. |
| sftTypeImageListH | 7 | ImageListH - Contains an image from an ImageList control. |
| sftTypeGDIPlus | 8 | GDIPlus - Contains a [GDI+](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_gdiplus) image |
### Comments
The Type property returns the defined image type.
The Type property reflects the type of the current image. It is modified by assigning an image to the SftPictureObject using a property such as SftPictureObject.[Appearance](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Appearance), SftPictureObject.[BitmapHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_BitmapHandle), SftPictureObject.[IconHandle](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_IconHandle), SftPictureObject.[SetColorSample](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_SetColorSample), etc.
See Also SftPictureObject Object | Object Hierarchy
## UpdateCurrentExpandCollapse Property, SftTreeItems Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_UpdateCurrentExpandCollapse*
Defines whether the current item ([Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Current](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Current)) is updated when the [expand/collapse button](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons) is clicked.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**UpdateCurrentExpandCollapse** **As Boolean** |
| VB | *Boolean* = *object*.**UpdateCurrentExpandCollapse** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**UpdateCurrentExpandCollapse**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**UpdateCurrentExpandCollapse**;
**VARIANT_BOOL** *Boolean* = *object*->Get**UpdateCurrentExpandCollapse**(); |
| C | **HRESULT** *object*->get_**UpdateCurrentExpandCollapse**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**UpdateCurrentExpandCollapse** = *Boolean* **As Boolean** |
| VB | *object*.**UpdateCurrentExpandCollapse** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**UpdateCurrentExpandCollapse** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**UpdateCurrentExpandCollapse** = *Boolean*;
**void** *object*->Put**UpdateCurrentExpandCollapse**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**UpdateCurrentExpandCollapse**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeItems](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeItems) object.
Boolean
Defines whether the current item (Items.Current) is updated when the expand/collapse button is clicked.
| Boolean | Description |
| --- | --- |
| True | The current item is updated when the expand/collapse button is clicked. The Items.Current property is updated and the *ItemIndex* argument of the [ItemClick](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_ItemClick) event indicates which item's expand/collapse button has been clicked. |
| False | The current item is not updated when the expand/collapse button is clicked. The * ItemIndex* argument of the ItemClick event indicates which item's expand/collapse button has been clicked. |
### Comments
The UpdateCurrentExpandCollapse property defines whether the current item (Items.Current) is updated when the expand/collapse button is clicked.
See Also SftTreeItems Object | Object Hierarchy
## UseThemes Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_UseThemes*
Defines whether [Windows themes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_themes) are used.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**UseThemes** **As Boolean** |
| VB | *Boolean* = *object*.**UseThemes** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**UseThemes**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**UseThemes**;
**VARIANT_BOOL** *Boolean* = *object*->Get**UseThemes**(); |
| C | **HRESULT** *object*->get_**UseThemes**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**UseThemes** = *Boolean* **As Boolean** |
| VB | *object*.**UseThemes** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**UseThemes** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**UseThemes** = *Boolean*;
**void** *object*->Put**UseThemes**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**UseThemes**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether Windows themes are used.
| Boolean | Description |
| --- | --- |
| True | Windows themes can be used, if available. |
| False | Windows themes are never used. |
### Comments
The UseThemes property defines whether Windows themes are used.
See Also SftTree Object | Object Hierarchy
## VAlignStyle Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VAlignStyle*
Defines the vertical alignment of tree lines, [expand/collapse buttons](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_expandcollapsebuttons), label, plus/minus and item graphics.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *VAlign* = *object*.**VAlignStyle** **As [SftTreeVAlignConstants](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftTreeVAlignConstants)** |
| VB | *VAlign* = *object*.**VAlignStyle** **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *VAlign* = *object*.**VAlignStyle**; |
| VC++ | **enum SftTreeVAlignConstants** *VAlign* = *object*->**VAlignStyle**;
**enum SftTreeVAlignConstants** *VAlign* = *object*->Get**VAlignStyle**(); |
| C | **HRESULT** *object*->get_**VAlignStyle**(**enum SftTreeVAlignConstants*** *VAlign*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**VAlignStyle** = *VAlign* **As SftTreeVAlignConstants** |
| VB | *object*.**VAlignStyle** = *VAlign* **As SftTreeVAlignConstants** |
| C#.NET | **SftTreeVAlignConstants** *object*.**VAlignStyle** = *VAlign*; |
| VC++ | **enum SftTreeVAlignConstants** *object*->**VAlignStyle** = *VAlign*;
**void** *object*->Put**VAlignStyle**(**enum SftTreeVAlignConstants** *VAlign*); |
| C | **HRESULT** *object*->put_**VAlignStyle**(**enum SftTreeVAlignConstants** *VAlign*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
VAlign
Defines the vertical alignment of tree lines, expand/collapse buttons, label, plus/minus and item graphics.
| Align | Value | Description |
| --- | --- | --- |
| valignSftTreeCenter | 0 | The tree lines, expand/collapse buttons, label graphics, plus/minus graphics and item graphics are vertically centered. If no alignment value is specified, this is the default. |
| valignSftTreeTop | 1 | The tree lines, expand/collapse buttons, label graphics, plus/minus graphics and item graphics are aligned with the top of the available area. |
| valignSftTreeBottom | 2 | The tree lines, expand/collapse buttons, label graphics, plus/minus graphics and item graphics are aligned with the bottom of the available area. |
### Comments
The VAlignStyle property defines the vertical alignment of tree lines, expand/collapse buttons, label graphics, plus/minus graphics and item graphics.
[Columns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Columns) and [cells](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) can further define the vertical alignment of cell contents (see [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[CellVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_CellVAlign), [Cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Cell).[TextVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_TextVAlign) and Cell.[ImageVAlign](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeCell_ImageVAlign)).
See Also SftTree Object | Object Hierarchy
## Version Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Version*
Returns the product's exact version.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Text* = *object*.**Version** **As String** |
| VB | *Text* = *object*.**Version** **As String** |
| C#.NET | **string** *Text* = *object*.**Version**; |
| VC++ | **_bstr_t** *Text* = *object*->**Version**;
**_bstr_t** *Text* = *object*->Get**Version**(); |
| C | **HRESULT** *object*->get_**Version**(**BSTR*** *Text*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Text
Returns the product's exact version.
### Comments
The Version property returns the product's exact version.
This information is used for [product support](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_contactsoftel) and can be displayed using the [property dialogs](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_property_dialog).
The Version property returns the product name and the exact version number. The [_Version](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree__Version) property (with a leading underscore character) returns the exact version number only.
See Also SftTree Object | Object Hierarchy
## VirtualCount Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualCount*
Defines the number of items in the control in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**VirtualCount**(**ByVal** *Total* **As Integer**) |
| VB | *object*.**VirtualCount**(**ByVal** *Total* **As Long**) |
| C#.NET | **void** *object*.**VirtualCount**(**int** *Total*); |
| VC++ | **HRESULT** *object*->**VirtualCount**(**long** *Total*); |
| C | **HRESULT** *object*->raw_**VirtualCount**(**long** *Total*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Total
The number of items in the control in virtual mode.
### Comments
The VirtualCount method defines the number of items in the control in virtual mode.
The VirtualCount method defines the number of items when using a [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource). It specifies the current number of items to be managed by the tree control (including visible and hidden items).
If the tree control is not a virtual tree control (items have been added using [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert)), this method will fail.
Whenever the number of items in the virtual data source changes, the application can call this method to notify the tree control.
If the number of items is changed using VirtualCount, the tree control does not preserve the current index or the current [selections](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_selections). It is up to the application to preserve or update these.
The Items.[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Count) property can be used to retrieve the current number of items.
Only flat lists (without hierarchy) are supported in virtual mode.
See Also SftTree Object | Object Hierarchy
## VirtualImageSizes Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualImageSizes*
Defines the maximum graphics sizes when using a [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource).
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**VirtualImageSizes**(**ByVal** *ItemImageWidth* **As Integer**, **ByVal** *ItemImageHeight* **As Integer**, **ByVal** *CellImageWidth* **As Integer**, **ByVal** *CellImageHeight* **As Integer**, **ByVal** *LabelImageWidth* **As Integer**, **ByVal** *LabelImageHeight* **As Integer**, **ByVal** *RowHeaderImageWidth* **As Integer**, **ByVal** *RowHeaderImageHeight* **As Integer**) |
| VB | *object*.**VirtualImageSizes**(**ByVal** *ItemImageWidth* **As Integer**, **ByVal** *ItemImageHeight* **As Integer**, **ByVal** *CellImageWidth* **As Integer**, **ByVal** *CellImageHeight* **As Integer**, **ByVal** *LabelImageWidth* **As Integer**, **ByVal** *LabelImageHeight* **As Integer**, **ByVal** *RowHeaderImageWidth* **As Integer**, **ByVal** *RowHeaderImageHeight* **As Integer**) |
| C#.NET | **void** *object*.**VirtualImageSizes**(**int** *ItemImageWidth*, **int** *ItemImageHeight*, **int** *CellImageWidth*, **int** *CellImageHeight*, **int** *LabelImageWidth*, **int** *LabelImageHeight*, **int** *RowHeaderImageWidth*, **int** *RowHeaderImageHeight*); |
| VC++ | **HRESULT** *object*->**VirtualImageSizes**(**int** *ItemImageWidth*, **int** *ItemImageHeight*, **int** *CellImageWidth*, **int** *CellImageHeight*, **int** *LabelImageWidth*, **int** *LabelImageHeight*, **int** *RowHeaderImageWidth*, **int** *RowHeaderImageHeight*); |
| C | **HRESULT** *object*->raw_**VirtualImageSizes**(**int** *ItemImageWidth*, **int** *ItemImageHeight*, **int** *CellImageWidth*, **int** *CellImageHeight*, **int** *LabelImageWidth*, **int** *LabelImageHeight*, **int** *RowHeaderImageWidth*, **int** *RowHeaderImageHeight*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemImageWidth
The maximum width of an item graphic. 0 can be specified if item graphics are not used.
ItemImageHeight
The maximum height of an item graphic. 0 can be specified if item graphics are not used.
CellImageWidth
The maximum width of a [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic. 0 can be specified if cell graphics are not used.
CellImageHeight
The maximum height of a cell graphic. 0 can be specified if cell graphics are not used.
LabelImageWidth
The maximum width of a label graphic. 0 can be specified if label graphics are not used.
LabelImageHeight
The maximum height of a label graphic. 0 can be specified if label graphics are not used.
RowHeaderImageWidth
The maximum width of a [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) graphic. 0 can be specified if row headers are not used.
RowHeaderImageHeight
The maximum height of a row header graphic. 0 can be specified if row headers are not used.
### Comments
The VirtualImageSizes method defines the maximum graphics sizes when using a virtual data source.
After defining a tree control as a virtual tree control using the [VirtualMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualMode) property, the (maximum) graphics sizes must be defined using the VirtualImageSizes method, so the graphics are enabled and so the control can reserve sufficient space for each graphics component.
In a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control, VirtualImageSizes defines the exact size of each graphics component. In a variable height tree control, the graphics must define the maximum size of each graphics component.
If a graphic component is not used, 0 can be specified as its height and width. In this case the graphic component is not displayed even if the virtual data source callback provides a valid image.
If the tree control is not a virtual tree control (items have been added using [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert)), this method will fail.
See Also SftTree Object | Object Hierarchy
## VirtualItem Event, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem*
The [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource) is called to provide item information.
### Syntax
| | |
| --- | --- |
| VB.NET | **Private Sub** *object*_**VirtualItem**(**ByVal** *sender* **As Object**, **ByVal** *e* **As ***[EventArgumentType](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/r_EventArgumentType)*) **Handles** *object*.**VirtualItem** |
| VB | **Private Sub** *object*_**VirtualItem**(**ByVal** *[RowIndex](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_RowIndex)* **As Long**, *ItemObject* **As [VirtualItem](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_VirtItem)**) |
| C#.NET | **void** *object*_**VirtualItem**(**object** *sender*, *EventArgumentType e*); |
| VC++ | **void** On**VirtualItem***object*(**long** *RowIndex*, **IVirtItem*** *ItemObject*); |
| C | **HRESULT** On**VirtualItem***object*(**long** *RowIndex*, **IVirtItem*** *ItemObject*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
RowIndex
The zero-based index number of the item for which item information is requested.
ItemObject
A VirtualItem object which should be updated by the application to reflect the item attributes.
### Comments
The VirtualItem event occurs when the virtual data source is called to provide item information.
The VirtualItem event occurs when the tree control is in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode) (see [VirtualMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualMode)). The event must be implemented by the application to provide information and item attributes to SftTree/OCX.
SftTree/OCX caches the items that are currently displayed in the tree control's client area. If an item is changed by the application's virtual data source (i.e. its external data source), the [VirtualItemChanged](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualItemChanged) method should be called to notify SftTree/OCX.
To enable graphics components, the [VirtualPictures](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualPictures) method must be used. The [VirtualCount](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualCount) method is used to define the number of items represented by the tree control.
The VirtualItem object is used by the application to set all properties for the requested item *RowIndex*. The application provides all data for the requested item *RowIndex* using the VirtualItem.[Item](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/VirtItem_Item) property.
While handling the VirtualItem event, the application cannot modify or retrieve any tree control attributes.
See Also SftTree Object | Object Hierarchy
## VirtualItemChanged Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualItemChanged*
Notifies the control that one or all items of the [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource) have changed.
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**VirtualItemChanged**(**ByVal** *ItemIndex* **As Integer**) |
| VB | *object*.**VirtualItemChanged**(**ByVal** *ItemIndex* **As Long**) |
| C#.NET | **void** *object*.**VirtualItemChanged**(**int** *ItemIndex*); |
| VC++ | **HRESULT** *object*->**VirtualItemChanged**(**long** *ItemIndex*); |
| C | **HRESULT** *object*->raw_**VirtualItemChanged**(**long** *ItemIndex*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemIndex
The zero-based index of the item which has been modified in the virtual data source. If -1 is used, all items in the virtual data source are considered altered.
### Comments
The VirtualItemChanged method notifies the control that one or all items of the virtual data source have changed.
By notifying the tree control that items in the virtual data source have changed, the items in the tree control can be repainted if needed, reflecting their new attributes.
If the tree control is not a virtual tree control (items have been added using [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert)), this method will fail.
See Also SftTree Object | Object Hierarchy
## VirtualMode Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualMode*
Defines whether the tree control is in [virtual mode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualmode).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**VirtualMode** **As Boolean** |
| VB | *Boolean* = *object*.**VirtualMode** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**VirtualMode**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**VirtualMode**;
**VARIANT_BOOL** *Boolean* = *object*->Get**VirtualMode**(); |
| C | **HRESULT** *object*->get_**VirtualMode**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**VirtualMode** = *Boolean* **As Boolean** |
| VB | *object*.**VirtualMode** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**VirtualMode** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**VirtualMode** = *Boolean*;
**void** *object*->Put**VirtualMode**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**VirtualMode**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
Boolean
Defines whether the tree control is in virtual mode.
| Boolean | Description |
| --- | --- |
| True | The tree control is in virtual mode. |
| False | The tree control is not in virtual mode. |
### Comments
The VirtualMode property defines whether the tree control is in virtual mode.
In virtual mode, the tree control can be used to display flat lists (without hierarchy) with up to 2,000,000,000 items.
If virtual mode is used, graphics, colors and all tree control data and attributes are provided by the [VirtualItem event](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeEvents_VirtualItem), which the application must implement to use a [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource). This eliminates lengthy initialization when many items are to be displayed.
See Also SftTree Object | Object Hierarchy
## VirtualPictures Method, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualPictures*
Defines the maximum graphics sizes when using a [virtual data source](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_virtualdatasource).
> Deprecated - Provided for compatibility with earlier versions only - Use [VirtualImageSizes](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualImageSizes) instead
### Syntax
| | |
| --- | --- |
| VB.NET | *object*.**VirtualPictures**(**ByVal** *ItemPic* **As System.Drawing.Image[](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_using_dotnet)**, **ByVal** *CellPic* **As System.Drawing.Image**, **ByVal** *LabelPic* **As System.Drawing.Image**, **ByVal** *RowPic* **As System.Drawing.Image**) |
| VB | *object*.**VirtualPictures**(*ItemPic* **As IPictureDisp**, *CellPic* **As IPictureDisp**, *LabelPic* **As IPictureDisp**, *RowPic* **As IPictureDisp**) |
| C#.NET | **void** *object*.**VirtualPictures**(**System.Drawing.Image** *ItemPic*, **System.Drawing.Image** *CellPic*, **System.Drawing.Image** *LabelPic*, **System.Drawing.Image** *RowPic*); |
| VC++ | **HRESULT** *object*->**VirtualPictures**(**IPictureDisp*** *ItemPic*, **IPictureDisp*** *CellPic*, **IPictureDisp*** *LabelPic*, **IPictureDisp*** *RowPic*); |
| C | **HRESULT** *object*->raw_**VirtualPictures**(**IPictureDisp*** *ItemPic*, **IPictureDisp*** *CellPic*, **IPictureDisp*** *LabelPic*, **IPictureDisp*** *RowPic*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
ItemPic
A [Picture](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Picture) object. This Picture object represents the maximum size of any item graphic. Specify Nothing (NULL) to omit item graphics.
CellPic
A Picture object. This Picture object represents the maximum size of any [cell](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_cells) graphic. Specify Nothing (NULL) to omit cell graphics.
LabelPic
A Picture object. This Picture object represents the maximum size of any label graphic. Specify Nothing (NULL) to omit label graphics.
RowPic
A Picture object. This Picture object represents the maximum size of any [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) graphic. Specify Nothing (NULL) to omit row header graphics.
### Comments
> Deprecated - Provided for compatibility with earlier versions only - Use VirtualImageSizes instead
The VirtualPictures method defines the maximum graphics sizes when using a virtual data source.
After defining a tree control as a virtual tree control using the [VirtualMode](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_VirtualMode) property, the (maximum) graphics sizes must be defined using the VirtualPictures method, so the graphics are enabled and so the control can reserve sufficient space for each graphics component.
In a [fixed height](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_fixedvariableitems) tree control, VirtualPictures defines the exact size of each graphics component. In a variable height tree control, the graphics must define the maximum size of each graphics component.
*ItemPic* defines the item graphic size, * CellPic* defines the cell graphic size, * LabelPic* defines the label graphic size and * RowPic* defines the row header graphic size. If a graphic component is not used, Nothing (or NULL) can be passed as Picture object. In this case the graphic component is not displayed even if the virtual data source callback provides a valid image.
If the tree control is not a virtual tree control (items have been added using [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[Add](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Add) or Items.[Insert](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_Insert)), this method will fail.
See Also SftTree Object | Object Hierarchy
## Visible Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible*
Defines whether a vertical [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) is present.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Boolean* = *object*.**Visible** **As Boolean** |
| VB | *Boolean* = *object*.**Visible** **As Boolean** |
| C#.NET | **bool** *Boolean* = *object*.**Visible**; |
| VC++ | **VARIANT_BOOL** *Boolean* = *object*->**Visible**;
**VARIANT_BOOL** *Boolean* = *object*->Get**Visible**(); |
| C | **HRESULT** *object*->get_**Visible**(**VARIANT_BOOL*** *Boolean*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Visible** = *Boolean* **As Boolean** |
| VB | *object*.**Visible** = *Boolean* **As Boolean** |
| C#.NET | **bool** *object*.**Visible** = *Boolean*; |
| VC++ | **VARIANT_BOOL** *object*->**Visible** = *Boolean*;
**void** *object*->Put**Visible**(**VARIANT_BOOL** *Boolean*); |
| C | **HRESULT** *object*->put_**Visible**(**VARIANT_BOOL** *Boolean*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Boolean
Defines whether a vertical splitter bar is present.
| Boolean | Description |
| --- | --- |
| True | A vertical splitter bar is present. |
| False | No vertical splitter bar is present. |
### Comments
The Visible property defines whether a vertical splitter bar is present.
A splitter bar is only available if two or more columns have been defined (see [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).[Count](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Count) property).
The [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Column) property is used to define the position of the splitter bar.
The Splitter.[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) and Splitter.[Offset](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Offset) properties can be used to define the size and location of the splitter bar.
> This property is read/only at run-time. Changing the Visible property at run-time will clear the tree control contents.
See Also SftTreeSplitter Object | Object Hierarchy
## WebLicense Property, SftTree Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_WebLicense*
Defines the license information for use on one web site.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *[License](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_License)* = *object*.**WebLicense** **As String** |
| VB | *License* = *object*.**WebLicense** **As String** |
| C#.NET | **string** *License* = *object*.**WebLicense**; |
| VC++ | **_bstr_t** *License* = *object*->**WebLicense**;
**_bstr_t** *License* = *object*->Get**WebLicense**(); |
| C | **HRESULT** *object*->get_**WebLicense**(**BSTR*** *License*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WebLicense** = *License* **As String** |
| VB | *object*.**WebLicense** = *License* **As String** |
| C#.NET | **string** *object*.**WebLicense** = *License*; |
| VC++ | **_bstr_t** *object*->**WebLicense** = *License*;
**void** *object*->Put**WebLicense**(**_bstr_t** *License*); |
| C | **HRESULT** *object*->put_**WebLicense**(**BSTR** *License*); |
object
A [SftTree object](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTree).
License
Defines the license information for use on one web site.
### Comments
The WebLicense property defines the license information for use on one web site.
> The use of the WebLicense property is no longer required and this property has no effect.
See Also SftTree Object | Object Hierarchy
## Width Property, SftPictureObject Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Width*
Defines the desired image width.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**Width** **As Integer** |
| VB | *WPix* = *object*.**Width** **As Long** |
| C#.NET | **int** *WPix* = *object*.**Width**; |
| VC++ | **long** *WPix* = *object*->**Width**;
**long** *WPix* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *WPix* **As Integer** |
| VB | *object*.**Width** = *WPix* **As Long** |
| C#.NET | **int** *object*.**Width** = *WPix*; |
| VC++ | **long** *object*->**Width** = *WPix*;
**void** *object*->Put**Width**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**Width**(**long** *WPix*); |
object
A [SftPictureObject](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftPictureObject) object.
WPix
Defines the desired image width.
### Comments
The Width property defines the desired image width.
The desired image width is only used for built-in images (SftPictureObject.[Type](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_Type) is [sftTypeBuiltin](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/constants_SftPictureTypeConstants)) and color samples (SftPictureObject.Type is sftTypeColorSample). For all image types, the SftPictureObject.[ActualHeight](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualHeight) and SftPictureObject.[ActualWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftPictureObject_ActualWidth) properties reflect the image dimensions.
See Also SftPictureObject Object | Object Hierarchy
## Width Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width*
Defines the width of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**Width** **As Single** |
| VB | *W* = *object*.**Width** **As Single** |
| C#.NET | **float** *W* = *object*.**Width**; |
| VC++ | **float** *W* = *object*->**Width**;
**float** *W* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**float*** *W*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *W* **As Single** |
| VB | *object*.**Width** = *W* **As Single** |
| C#.NET | **float** *object*.**Width** = *W*; |
| VC++ | **float** *object*->**Width** = *W*;
**void** *object*->Put**Width**(**float** *W*); |
| C | **HRESULT** *object*->put_**Width**(**float** *W*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
W
Defines the width of this column. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Width property defines the width of this column.
The Width and [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_WidthPix) properties are synonyms, but may use different coordinate systems.
The column width must be greater or equal to the column's minimum width. The minimum width can be defined using the Column.[MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) property.
The last column in a tree control may be defined as an [open-ended column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) (see [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded). An open-ended column cannot be resized, because an open-ended column doesn't have a defined width. An open-ended column will always use the space remaining between the previous column and the right edge of the tree control window.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum width. The text portion of the first column will always be at least of the specified width, no matter what level the item is on. This can result in the first column being much wider than the defined width. To calculate the actual width of column 0, add the value returned by the ColumnsObj.[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property to the value returned by Column(0).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width).
When changing column widths, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method may have to be used to recalculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
The Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) or Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) methods can be used to calculate or define the optimal width for a column. An optimal width allows all text and graphic components in a column to be displayed in their entirety, without being clipped.
See Also SftTreeColumn Object | Object Hierarchy
## Width Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Width*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**Width** **As Single** |
| VB | *W* = *object*.**Width** **As Single** |
| C#.NET | **float** *W* = *object*.**Width**; |
| VC++ | **float** *W* = *object*->**Width**;
**float** *W* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**float*** *W*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *W* **As Single** |
| VB | *object*.**Width** = *W* **As Single** |
| C#.NET | **float** *object*.**Width** = *W*; |
| VC++ | **float** *object*->**Width** = *W*;
**void** *object*->Put**Width**(**float** *W*); |
| C | **HRESULT** *object*->put_**Width**(**float** *W*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
W
Defines the width of the row header (and row/column header, row/column footer) area. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Width property defines the width of the row header (and row/column header, row/column footer) area.
The Width and [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_WidthPix) properties are synonyms, but may use different coordinate systems.
The Width property is used to change the width of the row header, row/column header and row/column footer area.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers, row/column footers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## Width Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Width*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**Width** **As Single** |
| VB | *W* = *object*.**Width** **As Single** |
| C#.NET | **float** *W* = *object*.**Width**; |
| VC++ | **float** *W* = *object*->**Width**;
**float** *W* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**float*** *W*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *W* **As Single** |
| VB | *object*.**Width** = *W* **As Single** |
| C#.NET | **float** *object*.**Width** = *W*; |
| VC++ | **float** *object*->**Width** = *W*;
**void** *object*->Put**Width**(**float** *W*); |
| C | **HRESULT** *object*->put_**Width**(**float** *W*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
W
Defines the width of the row header (and row/column header, row/column footer) area. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Width property defines the width of the row header (and row/column header, row/column footer) area.
The Width and [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_WidthPix) properties are synonyms, but may use different coordinate systems.
The Width property is used to change the width of the row header, row/column header and row/column footer area.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers, row/column footers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## Width Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *W* = *object*.**Width** **As Single** |
| VB | *W* = *object*.**Width** **As Single** |
| C#.NET | **float** *W* = *object*.**Width**; |
| VC++ | **float** *W* = *object*->**Width**;
**float** *W* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**float*** *W*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *W* **As Single** |
| VB | *object*.**Width** = *W* **As Single** |
| C#.NET | **float** *object*.**Width** = *W*; |
| VC++ | **float** *object*->**Width** = *W*;
**void** *object*->Put**Width**(**float** *W*); |
| C | **HRESULT** *object*->put_**Width**(**float** *W*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
W
Defines the width of the row header area. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
### Comments
The Width property defines the width of the row header area.
The Width and [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_WidthPix) properties are synonyms, but may use different coordinate systems.
The Width property is used to change the width of the row header, row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) and row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters) area.
The RowHeaders.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers, row/column footers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowHeaders Object | Object Hierarchy
## Width Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width*
Defines the width of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar).
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *Width* = *object*.**Width** **As Single** |
| VB | *Width* = *object*.**Width** **As Single** |
| C#.NET | **float** *Width* = *object*.**Width**; |
| VC++ | **float** *Width* = *object*->**Width**;
**float** *Width* = *object*->Get**Width**(); |
| C | **HRESULT** *object*->get_**Width**(**float*** *Width*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Width** = *Width* **As Single** |
| VB | *object*.**Width** = *Width* **As Single** |
| C#.NET | **float** *object*.**Width** = *Width*; |
| VC++ | **float** *object*->**Width** = *Width*;
**void** *object*->Put**Width**(**float** *Width*); |
| C | **HRESULT** *object*->put_**Width**(**float** *Width*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
Width
Defines the width of the splitter bar. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used. The valid range is 3..7 pixels.
### Comments
The Width property defines the width of the splitter bar in pixels.
The Width and [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_WidthPix) properties are synonyms, but may use different coordinate systems.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## WidthPix Property, SftTreeColumn Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_WidthPix*
Defines the width of this column.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**WidthPix** **As Integer** |
| VB | *WPix* = *object*.**WidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**WidthPix**; |
| VC++ | **long** *WPix* = *object*->**WidthPix**;
**long** *WPix* = *object*->Get**WidthPix**(); |
| C | **HRESULT** *object*->get_**WidthPix**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WidthPix** = *WPix* **As Integer** |
| VB | *object*.**WidthPix** = *WPix* **As Long** |
| C#.NET | **int** *object*.**WidthPix** = *WPix*; |
| VC++ | **long** *object*->**WidthPix** = *WPix*;
**void** *object*->Put**WidthPix**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**WidthPix**(**long** *WPix*); |
object
A [SftTreeColumn](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumn) object.
WPix
Defines the width of this column in pixels.
### Comments
The WidthPix property defines the width of this column.
The [Column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Column).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_Width) and WidthPix properties are synonyms, but may use different coordinate systems.
The column width must be greater or equal to the column's minimum width. The minimum width can be defined using the Column.[MinWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MinWidth) property.
The last column in a tree control may be defined as an [open-ended column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OpenEnded) (see [ColumnsObj](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_ColumnsObj).OpenEnded). An open-ended column cannot be resized, because an open-ended column doesn't have a defined width. An open-ended column will always use the space remaining between the previous column and the right edge of the tree control window.
Due to the variable number of levels and the resulting hierarchical display, the width of the first column is always treated as a minimum width. The text portion of the first column will always be at least of the specified width, no matter what level the item is on. This can result in the first column being much wider than the defined width. To calculate the actual width of column 0, add the value returned by the ColumnsObj.[OverheadWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_OverheadWidth) property to the value returned by Column(0).[WidthPix](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_WidthPix).
When changing column widths, the [Items](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Items).[RecalcHorizontalExtent](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeItems_RecalcHorizontalExtent) method may have to be used to recalculate the optimal [horizontal scrolling](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_horizontalscrolling) extent.
The Column.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_OptimalWidth) or Column.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumn_MakeOptimal) methods can be used to calculate or define the optimal width for a column. An optimal width allows all text and graphic components in a column to be displayed in their entirety, without being clipped.
See Also SftTreeColumn Object | Object Hierarchy
## WidthPix Property, SftTreeRowColumnFooter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_WidthPix*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) ( and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**WidthPix** **As Integer** |
| VB | *WPix* = *object*.**WidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**WidthPix**; |
| VC++ | **long** *WPix* = *object*->**WidthPix**;
**long** *WPix* = *object*->Get**WidthPix**(); |
| C | **HRESULT** *object*->get_**WidthPix**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WidthPix** = *WPix* **As Integer** |
| VB | *object*.**WidthPix** = *WPix* **As Long** |
| C#.NET | **int** *object*.**WidthPix** = *WPix*; |
| VC++ | **long** *object*->**WidthPix** = *WPix*;
**void** *object*->Put**WidthPix**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**WidthPix**(**long** *WPix*); |
object
A [SftTreeRowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnFooter) object.
WPix
Defines the width of the row header (and row/column header, row/column footer) area in pixels.
### Comments
The WidthPix property defines the width of the row header (and row/column header, row/column footer) area.
The [RowColumnFooter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnFooter).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnFooter_Width) and WidthPix properties are synonyms, but may use different coordinate systems.
The WidthPix property is used to change the width of the row header, row/column header and row/column footer area.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers, row/column footers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowColumnFooter Object | Object Hierarchy
## WidthPix Property, SftTreeRowColumnHeader Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_WidthPix*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) (and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders), row/[column footer](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnfooters)) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**WidthPix** **As Integer** |
| VB | *WPix* = *object*.**WidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**WidthPix**; |
| VC++ | **long** *WPix* = *object*->**WidthPix**;
**long** *WPix* = *object*->Get**WidthPix**(); |
| C | **HRESULT** *object*->get_**WidthPix**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WidthPix** = *WPix* **As Integer** |
| VB | *object*.**WidthPix** = *WPix* **As Long** |
| C#.NET | **int** *object*.**WidthPix** = *WPix*; |
| VC++ | **long** *object*->**WidthPix** = *WPix*;
**void** *object*->Put**WidthPix**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**WidthPix**(**long** *WPix*); |
object
A [SftTreeRowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowColumnHeader) object.
WPix
Defines the width of the row header (and row/column header, row/column footer) area in pixels.
### Comments
The WidthPix property defines the width of the row header (and row/column header, row/column footer) area.
The [RowColumnHeader](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowColumnHeader).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowColumnHeader_Width) and WidthPix properties are synonyms, but may use different coordinate systems.
The WidthPix property is used to change the width of the row header, row/column header and row/column footer area.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers, row/column footers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowColumnHeader Object | Object Hierarchy
## WidthPix Property, SftTreeRowHeaders Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_WidthPix*
Defines the width of the [row header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_rowheaders) area.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WPix* = *object*.**WidthPix** **As Integer** |
| VB | *WPix* = *object*.**WidthPix** **As Long** |
| C#.NET | **int** *WPix* = *object*.**WidthPix**; |
| VC++ | **long** *WPix* = *object*->**WidthPix**;
**long** *WPix* = *object*->Get**WidthPix**(); |
| C | **HRESULT** *object*->get_**WidthPix**(**long*** *WPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WidthPix** = *WPix* **As Integer** |
| VB | *object*.**WidthPix** = *WPix* **As Long** |
| C#.NET | **int** *object*.**WidthPix** = *WPix*; |
| VC++ | **long** *object*->**WidthPix** = *WPix*;
**void** *object*->Put**WidthPix**(**long** *WPix*); |
| C | **HRESULT** *object*->put_**WidthPix**(**long** *WPix*); |
object
A [SftTreeRowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeRowHeaders) object.
WPix
Defines the width of the row header area in pixels.
### Comments
The WidthPix property defines the width of the row header area.
The [RowHeaders](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_RowHeaders).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_Width) and WidthPix properties are synonyms, but may use different coordinate systems.
The WidthPix property is used to change the width of the row header and row/[column header](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_columnheaders) area.
The RowHeaders.[OptimalWidth](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_OptimalWidth) or RowHeaders.[MakeOptimal](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeRowHeaders_MakeOptimal) methods can be used to calculate or define the optimal width for the row headers (and row/column headers). An optimal width allows all text and graphic components in the row headers to be displayed in their entirety, without being clipped.
See Also SftTreeRowHeaders Object | Object Hierarchy
## WidthPix Property, SftTreeSplitter Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_WidthPix*
Defines the width of the [splitter bar](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_splitterbar) in pixels.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *WidthPix* = *object*.**WidthPix** **As Integer** |
| VB | *WidthPix* = *object*.**WidthPix** **As Long** |
| C#.NET | **int** *WidthPix* = *object*.**WidthPix**; |
| VC++ | **long** *WidthPix* = *object*->**WidthPix**;
**long** *WidthPix* = *object*->Get**WidthPix**(); |
| C | **HRESULT** *object*->get_**WidthPix**(**long*** *WidthPix*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**WidthPix** = *WidthPix* **As Integer** |
| VB | *object*.**WidthPix** = *WidthPix* **As Long** |
| C#.NET | **int** *object*.**WidthPix** = *WidthPix*; |
| VC++ | **long** *object*->**WidthPix** = *WidthPix*;
**void** *object*->Put**WidthPix**(**long** *WidthPix*); |
| C | **HRESULT** *object*->put_**WidthPix**(**long** *WidthPix*); |
object
A [SftTreeSplitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeSplitter) object.
WidthPix
Defines the width of the splitter bar in pixels. The valid range is 3..7 pixels.
### Comments
The WidthPix property defines the width of the splitter bar in pixels.
The [Splitter](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTree_Splitter).[Width](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Width) and WidthPix properties are synonyms, but may use different coordinate systems.
The Splitter.[Visible](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeSplitter_Visible) property is used to define a splitter bar.
See Also SftTreeSplitter Object | Object Hierarchy
## Widths Property, SftTreeColumns Object
*Source: https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Widths*
Defines the widths of all columns, usually used to save/load an existing column layout.
### Syntax
Get
| | |
| --- | --- |
| VB.NET | *String* = *object*.**Widths** **As String** |
| VB | *String* = *object*.**Widths** **As String** |
| C#.NET | **string** *String* = *object*.**Widths**; |
| VC++ | **_bstr_t** *String* = *object*->**Widths**;
**_bstr_t** *String* = *object*->Get**Widths**(); |
| C | **HRESULT** *object*->get_**Widths**(**BSTR*** *String*); |
Put
| | |
| --- | --- |
| VB.NET | *object*.**Widths** = *String* **As String** |
| VB | *object*.**Widths** = *String* **As String** |
| C#.NET | **string** *object*.**Widths** = *String*; |
| VC++ | **_bstr_t** *object*->**Widths** = *String*;
**void** *object*->Put**Widths**(**_bstr_t** *String*); |
| C | **HRESULT** *object*->put_**Widths**(**BSTR** *String*); |
object
A [SftTreeColumns](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/index_SftTreeColumns) object.
String
Defines the widths of all columns, usually used to save/load an existing column layout.
### Comments
The Widths property defines the widths of all columns, usually used to save/load an existing column layout.
The property returns a comma-delimited list of column widths ordered by [real column](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/g_displayvsrealcolumns) (not the displayed order).
The value returned by the Widths property could be saved in the Windows Registry or a data file. By assigning the saved value to the Widths property at a later time, the widths of all columns can be restored.
The [Order](https://softelvdm.com/Documentation/SftTree%20OCX%208%200/Topic/SftTreeColumns_Order) property can be used to save/restore the column order.
See Also SftTreeColumns Object | Object Hierarchy