Links

VisListBoxExtension

PPJ.Runtime.Vis.VisListBoxExtension
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
Common list box extension class
C#
VB.NET
public class VisListBoxExtension : SalGeneralWindow
Public Class VisListBoxExtension
Inherits SalGeneralWindow

Constructors

VisListBoxExtension(derived)

Multiple Inheritance Constructor
Name
Type
Description
derived

Fields

Name
Type
Description
hFont
SalNumber
hItem
SalNumber
hPicNormal
SalNumber
hPicSelect
SalNumber
nColor
SalNumber
nFlags
SalNumber
from cOutline
nIdx
SalNumber
from cOutline
nIndex
SalNumber
nItemFlags
SalNumber
nLevel
SalNumber
nStyle
SalNumber
nValue
SalNumber
sText
SalString

Methods

AddColor(sText, nColor)

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

AddColorValue(sText, nColor, nValue)

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

AddFont(sText, hFont)

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

AddFontValue(sText, hFont, nValue)

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

AddPicture(sText, hPicNormal, hPicSelected)

Adds an item to the list control and specified an image for the normal and selected state.
Parameter
Type
Description
sText
SalString
hPicNormal
SalNumber
hPicSelected
SalNumber
Returns: SalNumber.

AddPictureValue(sText, hPicNormal, hPicSelected, nValue)

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
sText
SalString
hPicNormal
SalNumber
hPicSelected
SalNumber
nValue
SalNumber
Returns: SalNumber.

Collapse(nIndex)

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

DeleteChild(nIndex)

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

DeleteDescendents(nIndex)

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

Demote(nIndex, hPicNormal, hPicSelected)

Moves an item and all descendants right in the outline by making the item become the last child of the previous sibling. If the new parent node was not already a parent, the images are also updated. Otherwise the images are ignored.
Parameter
Type
Description
nIndex
SalNumber
hPicNormal
SalNumber
hPicSelected
SalNumber
Returns: SalBoolean.

DisableItem(nIndex, nColor)

Disables the specified item.
Parameter
Type
Description
nIndex
SalNumber
nColor
SalNumber
Returns: SalNumber.

DoDragDrop(nSourceIndex, target, nTargetIndex, nDropMode)

Moves the source item to the new location, providing support for dragging tree items.
Parameter
Type
Description
nSourceIndex
SalNumber
target
Control
nTargetIndex
SalNumber
nDropMode
SalNumber
Returns: SalBoolean.

EnableItem(nIndex, nColor)

Enables the specified item.
Parameter
Type
Description
nIndex
SalNumber
nColor
SalNumber
Returns: SalNumber.

EnumChildren(hItem, hItems)

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

EnumDescendents(hItem, hItems)

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

Expand(nIndex)

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

ExpandDescendents(nIndex)

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

FindItemValue(hItem, nValue)

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

FreeChild(hItem)

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

FreeDescendents(hItem)

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

FromHandle(hWnd)

Fully qualified expressions operator.
Parameter
Type
Description
hWnd

FromItemHandle(handle)

Returns the instance of VisListBoxExtension from the item handle.
Parameter
Type
Description
handle
SalNumber

GetChildNodeCount(hItem, bDirectChildrenOnly)

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

GetColor(nIndex)

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

GetFlags(nIndex)

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

GetFont(nIndex)

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

GetIndexFromPoint(nXPos, nYPos)

Returns the index of the item at the indicated screen coordinates.
Parameter
Type
Description
nXPos
SalNumber
nYPos
SalNumber
Returns: SalNumber.

GetItemColor(hItem)

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

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter
Type
Description
hItem
SalNumber
sText
nValue
nItemFlags
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(nIndex)

Retrieves the item handle based on an index specified.
Parameter
Type
Description
nIndex
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, hPicNormal, hPicSelected)

Parameter
Type
Description
hItem
SalNumber
hPicNormal
hPicSelected
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(nIndex, hPicNormal, hPicSelected)

Parameter
Type
Description
nIndex
SalNumber
hPicNormal
hPicSelected
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(nIndex, nTop, nLeft, nBottom, nRight)

Parameter
Type
Description
nIndex
SalNumber
nTop
nLeft