Links

VisOutlineComboBox

PPJ.Runtime.Vis.VisOutlineComboBox
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
Combo box which supports hierarchical tree outlines.
C#
VB.NET
public class VisOutlineComboBox : VisDropDownBase
Public Class VisOutlineComboBox
Inherits VisDropDownBase

Constructors

VisOutlineComboBox()

Default Constructor.

Properties

hFont

SalNumber: Multiple Inheritance: Wrapper property.

hItem

SalNumber: Multiple Inheritance: Wrapper property.

HorizontalScrollbar

Boolean: Shows/Hides the horizontal scrollbar. Supported starting from Common Controls v. 5.80

hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

nColor

SalNumber: Multiple Inheritance: Wrapper property.

nIndex

SalNumber: Multiple Inheritance: Wrapper property.

nItemFlags

SalNumber: Multiple Inheritance: Wrapper property.

nLevel

SalNumber: Multiple Inheritance: Wrapper property.

nStyle

SalNumber: Multiple Inheritance: Wrapper property.

nValue

SalNumber: Multiple Inheritance: Wrapper property.

Sorted

Boolean: Gets/Sets the sorted property.

sText

SalString: Multiple Inheritance: Wrapper property.

Methods

AddColor(text, color)

Adds an item to the list and displays it in the specified color.
Parameter
Type
Description
text
SalString
color
SalNumber
Returns: SalNumber.

AddColorValue(text, color, value)

Adds an item to the list, displays it in the specified color and associates the specified value with the item.
Parameter
Type
Description
text
SalString
color
SalNumber
value
SalNumber
Returns: SalNumber.

AddFont(text, hFont)

Adds an item to the list control and displays it in the specified font.
Parameter
Type
Description
text
SalString
hFont
SalNumber
Returns: SalNumber.

AddFontValue(text, hFont, value)

Adds a new item with the specified font and value.
Parameter
Type
Description
text
SalString
hFont
SalNumber
value
SalNumber
Returns: SalNumber.

AddPicture(text, picNormal, picSelect)

Adds an item to the list control and specified an image for the normal and selected state.
Parameter
Type
Description
text
SalString
picNormal
SalNumber
picSelect
SalNumber
Returns: SalNumber.

AddPictureValue(text, picNormal, picSelect, value)

Adds an item to the list control and specified an image for the normal and selected state, and a value to associate with the item.
Parameter
Type
Description
text
SalString
picNormal
SalNumber
picSelect
SalNumber
value
SalNumber
Returns: SalNumber.

Collapse(index)

Collapses all descendant items.
Parameter
Type
Description
index
SalNumber
Returns: SalBoolean.

DeleteChild(index)

Deletes the child item from the tree control.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

DeleteDescendents(index)

Deletes all descendants (children, grandchildren, and so on) of the specified child.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

Demote(index, picNormal, picSelect)

Moves an item and all descendants right in the outline by making the item become the last child of the previous sibling.
Parameter
Type
Description
index
SalNumber
picNormal
SalNumber
picSelect
SalNumber
Returns: SalBoolean.

DisableItem(index, color)

Disables the specified item.
Parameter
Type
Description
index
SalNumber
color
SalNumber
Returns: SalNumber.

DragDrop(sourceIndex, target, targetIndex, dropMode)

Moves the source item to the new location, providing support for dragging tree items.
Parameter
Type
Description
sourceIndex
SalNumber
target
targetIndex
SalNumber
dropMode
SalNumber
Returns: SalBoolean.

EnableItem(index, color)

Enables the specified item.
Parameter
Type
Description
index
SalNumber
color
SalNumber
Returns: SalNumber.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.
Parameter
Type
Description
hItem
SalNumber
hItems
Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

Enumerates descendant (children, grandchildren, and so on) item handles for a specified item.
Parameter
Type
Description
hItemParent
SalNumber
hItems
Returns: SalNumber.

Expand(index)

Expands an outline one level at the index specified.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

ExpandDescendents(index)

Displays all descendants of an item.
Parameter
Type
Description
index
SalNumber
Returns: SalBoolean.

FindItemValue(hItem, value)

Finds the item with the specified value in the descendants of the specified node.
Parameter
Type
Description
hItem
SalNumber
value
SalNumber
Returns: SalNumber.

FreeChild(hItemChild)

Frees memory for the item specified and for all its descendants.
Parameter
Type
Description
hItemChild
SalNumber
Returns: SalBoolean.

FreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.
Parameter
Type
Description
hItemParent
SalNumber
Returns: SalBoolean.

FromHandle(handle)

Returns the control associated with the handle.
Parameter
Type
Description
handle

GetChildNodeCount(hItem, directChildrenOnly)

Gets the number of children for a specified item.
Parameter
Type
Description
hItem
SalNumber
directChildrenOnly
Returns: SalNumber.

GetColor(index)

Returns the current color of the list item.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

GetFlags(index)

Returns the item's flags.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

GetFont(index)

Returns the current font of the list control item.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

GetIndexFromPoint(xPos, yPos)

Returns the index of the item at the indicated screen coordinates.
Parameter
Type
Description
xPos
SalNumber
yPos
SalNumber
Returns: SalNumber.

GetItemColor(hItem)

Retrieves the color associated with an outline item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetItemData(hItem, text, value, itemFlags)

Parameter
Type
Description
hItem
SalNumber
text
value
itemFlags
Returns: SalBoolean.

GetItemFlags(hItem)

Returns the items's flags.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetItemFont(hItem)

Retrieves the font associated with an outline item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetItemHandle(index)

Retrieves the item handle based on an index specified.
Parameter
Type
Description
index
SalNumber
Returns: SalNumber.

GetItemIndex(hItem)

Retrieves the index associated with an outline item based on an item handle.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetItemPicture(hItem, picNormal, picSelect)

Parameter
Type
Description
hItem
SalNumber
picNormal
picSelect
Returns: SalBoolean.

GetItemText(hItem)

Returns the text for the outline item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalString.

GetItemValue(hItem)

Returns the value saved with the outline item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetLevel(hItem)

Returns the indentation level of the specified item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetNextSibling(hItem)

Retrieves the item handle for the next sibling of the specified item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetParent(hItem)

Retrieves the item handle for the parent of the specified item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetPicture(index, picNormal, picSelect)

Parameter
Type
Description
index
SalNumber
picNormal
picSelect
Returns: SalNumber.

GetPrevSibling(hItem)

Retrieves the item handle for the previous sibling of the specified item.
Parameter
Type
Description
hItem
SalNumber
Returns: SalNumber.

GetRoot()

Returns the handle for the root node.
Returns: SalNumber.

GetStyle()

Returns the style flags for the control.
Returns: SalNumber.

GetTextRectangle(index, top, left, bottom, right)

Parameter
Type
Description
index
SalNumber
top
left
bottom
right
Returns: SalBoolean.

InsertColor(index, text, color)

Inserts an item to the list control at the specified position and displays it in the specified color.
Parameter
Type
Description
index
SalNumber
text
SalString