Links

VisOutlineListBox

PPJ.Runtime.Vis.VisOutlineListBox
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
C#
VB.NET
public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl
Public Class VisOutlineListBox
Inherits TreeView
Implements ISalWindow, ISalControl, ISalListControl

Constructors

VisOutlineListBox()

Default Constructor.

Properties

AllowDrag

Boolean: Enabled/Disables automatic drag operations. (Default: True)

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 (Default: True)

hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

ImageSize

Size: Gets or sets the default size for the node images. (Default: "16, 16")

Label

Control: Returns/Sets the label associated with this control.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

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.

SelectedNodes

TreeNode[]: Returns the collection of all selected nodes.

SelectionMode

SelectionMode: Returns/Sets the selection mode. (Default: One)

sText

SalString: Multiple Inheritance: Wrapper property.

UseStateImageList

Boolean: Determines whether the control uses the StateImageList or the default ImageList to render the node images. When using the StateImageList, nodes without a specific image are left aligned without any icon. When using the default ImageList, nodes without an image show the default first image in the list.

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.

AddListItem(sName)

Adds a string to a list box or combo box.
Parameter
Type
Description
sName
SalString
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.

BringWindowToTop()

Brings a window to the top of all overlapping windows.
Returns: SalBoolean.

CenterWindow()

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.
Returns: SalBoolean.

Clear()

Clears the value from a data field, multi line field, or table window column.
Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.
Parameter
Type
Description
nType
SalNumber
Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.
Returns: SalBoolean.

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.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.
Parameter
Type
Description
nIndex
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.

DestroyWindow()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.

DisableItem(index, color)

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

DisableWindow()

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Returns: SalBoolean.

DisableWindowAndLabel()

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Returns: SalBoolean.

DoDragDrop(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.

EnableWindow()

Enables keyboard and mouse input to a window.
Returns: SalBoolean.

EnableWindowAndLabel()

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.
Returns: SalBoolean.

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.

FindChild(windowName)

This function finds a child window of a given name in the specified window.
Parameter
Type
Description
windowName
SalString
Returns: SalWindowHandle.

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.

FormUnitsToPixels(formUnits, vertical)

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.
Parameter
Type
Description
formUnits
SalNumber
The number of form units.
vertical
If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.
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.

GetClassName()

Return the name of a window's class as a string.
Returns: SalString.

GetColor(index)

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

GetControlType()

Returns an object's type.
Returns: SalNumber.

GetDataType()

Returns a data field's or table window column's data type.
Returns: SalNumber.

GetFirstChild(typeMask)

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
Parameter
Type
Description
typeMask
SalNumber
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.

GetFlags(index)

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

GetFont(name, size, enhancement)

Parameter
Type
Description
name
size
enhancement
Returns: SalBoolean.

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