VisListBoxBase

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)

Base class for all the extended list box classes in Vis.

C#

public class VisListBoxBase : SalListBox

VB.NET

Public Class VisListBoxBase
    Inherits SalListBox

Constructors

VisListBoxBase()

Default Constructor.

Properties

hFont

SalNumber: Multiple Inheritance: Wrapper property.

hItem

SalNumber: Multiple Inheritance: Wrapper property.

hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

ItemImageSize

Size: Returns or sets the size of the images associated to the items in the list box.

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.

SelectedIndex

Int32: index of selected item or -1 if none is selected

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	SalWindowHandle
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	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

Enumerates descendant (children, grandchildren, and so on) item handles for a specified item.

Parameter	Type	Description
hItemParent	SalNumber
hItems	SalArray<SalNumber>

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.

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	SalString&
value	SalNumber&
itemFlags	SalNumber&

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	SalNumber&
picSelect	SalNumber&

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	SalNumber&
picSelect	SalNumber&

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	SalNumber&
left	SalNumber&
bottom	SalNumber&
right	SalNumber&

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
color	SalNumber

Returns: SalNumber.

InsertColorValue(index, text, color, value)

Inserts an item to the list control at the specified position, displays it in the specified color and associates the specified value to the item.

Parameter	Type	Description
index	SalNumber
text	SalString
color	SalNumber
value	SalNumber

Returns: SalNumber.

InsertFont(index, text, hFont)

Adds an item to a list control at the specified index and displays it in the specified font.

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber

Returns: SalNumber.

InsertFontValue(index, text, hFont, value)

Adds an item to the list control, displays it in the specified font, and associates the specified value with the item.

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber
value	SalNumber

Returns: SalNumber.

InsertPicture(index, text, picNormal, picSelect)

Inserts an item at the specified position and specifies an image for the normal and selected state.

Parameter	Type	Description
index	SalNumber
text	SalString
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

InsertPictureValue(index, text, picNormal, picSelect, value)

Inserts an item at the specified position and specifies an image for the normal and selected state, and associates a value to the item.

Parameter	Type	Description
index	SalNumber
text	SalString
picNormal	SalNumber
picSelect	SalNumber
value	SalNumber

Returns: SalNumber.

LoadChild(hItemParent, picNormal, picSelect, text, value, itemFlags)

Inserts an item as the last child of the specified parent.

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

Inserts multiple items as the last children of the specified parent item.

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalArray<SalNumber>
picSelect	SalArray<SalNumber>
text	SalArray<SalString>
values	SalArray<SalNumber>
itemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

Inserts multiple items as the last children of the specified parent item.

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalArray<SalString>
values	SalArray<SalNumber>
itemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadOutline(blob)

Deserializes the entire outline tree from the specified string.

Parameter	Type	Description
blob	SalString

Returns: SalNumber.

LoadOutlineFile(fileName, picParentNormal, picParentSelect, picChildNormal, picChildSelect)

Loads the serialized outline structure from the file and creates the new items as children of the specified node.

Parameter	Type	Description
fileName	SalString
picParentNormal	SalNumber
picParentSelect	SalNumber
picChildNormal	SalNumber
picChildSelect	SalNumber

Returns: SalNumber.

LoadSibling(hItemBefore, picNormal, picSelect, text, value, itemFlags)

Loads a new tree node as a sibling of the specified item.

Parameter	Type	Description
hItemBefore	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

MoveDown(index)

Moves the specified item down one position in the tree.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

MoveUp(index)

Moves an item and its descendants up in the list.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

Promote(index, picNormal, picSelect)

Moves an item and its descendants left in the outline by making it the last sibling of the parent item.

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SaveOutline(blob)

Parameter	Type	Description
blob	SalString&

Returns: SalNumber.

SetColor(index, color)

Sets the color of a list item.

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

SetFlags(index, flags, state)

Sets the item's flags.

Parameter	Type	Description
index	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetFont(index, hFont)

Sets the font of the list control item.

Parameter	Type	Description
index	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetIndent(width)

Gets or sets the distance to indent each of the child tree node levels.

Parameter	Type	Description
width	SalNumber

Returns: SalBoolean.

SetItemColor(hItem, color)

Sets the color of the outline item.

Parameter	Type	Description
hItem	SalNumber
color	SalNumber

Returns: SalBoolean.

SetItemData(hItem, text, value, itemFlags)

Updates the specified item.

Parameter	Type	Description
hItem	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, flags, state)

Sets the item's flags.

Parameter	Type	Description
hItem	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, picNormal, picSelect)

Assigns new bitmaps to the specified item.

Parameter	Type	Description
hItem	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SetItemText(hItem, text)

Sets the text of the outline item.

Parameter	Type	Description
hItem	SalNumber
text	SalString

Returns: SalBoolean.

SetItemValue(hItem, value)

Sets the value associated to the outline item.

Parameter	Type	Description
hItem	SalNumber
value	SalNumber

Returns: SalBoolean.

SetOutlineRedraw(state)

Enables or disables drawing.

Parameter	Type	Description
state	SalBoolean

Returns: SalBoolean.

SetPicture(index, picNormal, picSelect)

Changes the normal and selected images for the specified item.

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

SetStyle(style)

Sets the style flags for the control.

Parameter	Type	Description
style	SalNumber

Returns: SalBoolean.

ShowOutline(level)

Expands list items up to the specified level.

Parameter	Type	Description
level	SalNumber

Returns: SalBoolean.

Inherited By

Name	Description
VisColorListBox	Extended ListBox, supports colored items.
VisDirListBox	Displays collapsible list of directories in a list box.
VisDriveListBox	Extended ListBox, displays list of available drives.
VisFileListBox	Extended ListBox, displays the files list and file informations for a directory.
VisFontListBox	Extended ListBox, supports items of different font.
VisFontNameListBox	Extended ListBox, lists the names of all the installed fonts.
VisPictureListBox	List box with pictures.
VisRadioListBox

Implements

Name	Description
ISalControl
ISalListControl
ISalWindow