VisComboBoxBase

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Runtime.Vis.50 (5.0.0.0)

Provides an owner-drawn combo box with Visual Toolchest item colors, fonts, images, and item data.

C#

public class VisComboBoxBase : SalComboBox

VB.NET

Public Class VisComboBoxBase
    Inherits SalComboBox

Example:

void AddItem(PPJ.Runtime.Vis.VisComboBoxBase list)
{
    list.AddColor("First item", PPJ.Runtime.Sys.COLOR_Red);
}

Constructors

VisComboBoxBase()

Initializes the item extension and designer components.

Properties

hFont

SalNumber:

Reads or updates the value held by this control's list extension.

hItem

SalNumber:

Reads or updates the value held by this control's list extension.

hPicNormal

SalNumber:

Reads or updates the value held by this control's list extension.

hPicSelect

SalNumber:

Reads or updates the value held by this control's list extension.

ItemImageSize

Size: Gets or sets the size used to draw item images.

Changing the size invalidates an existing control handle.

nColor

SalNumber:

Reads or updates the value held by this control's list extension.

nIndex

SalNumber:

Reads or updates the value held by this control's list extension.

nItemFlags

SalNumber:

Reads or updates the value held by this control's list extension.

nLevel

SalNumber:

Reads or updates the value held by this control's list extension.

nStyle

SalNumber:

Reads or updates the value held by this control's list extension.

nValue

SalNumber:

Reads or updates the value held by this control's list extension.

SelectedIndex

Int32: Gets or sets the selected item index.

The getter reports no selection when the selected item is disabled. The setter delegates to the base control.

sText

SalString:

Reads or updates the value held by this control's list extension.

Methods

AddColor(text, color)

Parameter	Type	Description
text	SalString
color	SalNumber

Returns: SalNumber.

AddColorValue(text, color, value)

Parameter	Type	Description
text	SalString
color	SalNumber
value	SalNumber

Returns: SalNumber.

AddFont(text, hFont)

Parameter	Type	Description
text	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(text, hFont, value)

Parameter	Type	Description
text	SalString
hFont	SalNumber
value	SalNumber

Returns: SalNumber.

AddPicture(text, picNormal, picSelect)

Parameter	Type	Description
text	SalString
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

AddPictureValue(text, picNormal, picSelect, value)

Parameter	Type	Description
text	SalString
picNormal	SalNumber
picSelect	SalNumber
value	SalNumber

Returns: SalNumber.

Collapse(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

DeleteChild(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

DeleteDescendents(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

Demote(index, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

DisableItem(index, color)

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

DragDrop(sourceIndex, target, targetIndex, dropMode)

Moves an outline node into another outline tree.

Parameter	Type	Description
sourceIndex	SalNumber	The source item index.
target	SalWindowHandle	The destination VisOutlineListBox.
targetIndex	SalNumber	The destination item index.
dropMode	SalNumber	DROP_Child to append under the target, or DROP_Sibling to insert after it.

Returns: SalBoolean. True if the node moves; false for invalid nodes, unsupported targets/modes, or a move onto itself or a descendant.

EnableItem(index, color)

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

EnumChildren(hItem, hItems)

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

Parameter	Type	Description
hItemParent	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

Expand(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

ExpandDescendents(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

FindItemValue(hItem, value)

Parameter	Type	Description
hItem	SalNumber
value	SalNumber

Returns: SalNumber.

FreeChild(hItemChild)

Parameter	Type	Description
hItemChild	SalNumber

Returns: SalBoolean.

FreeDescendents(hItemParent)

Parameter	Type	Description
hItemParent	SalNumber

Returns: SalBoolean.

GetColor(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetFlags(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetFont(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetIndexFromPoint(xPos, yPos)

Parameter	Type	Description
xPos	SalNumber
yPos	SalNumber

Returns: SalNumber.

GetItemColor(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemData(item, text, value, itemFlags)

Reads an outline node's text, application value, and flags.

Parameter	Type	Description
item	SalNumber	The outline node handle.
text	SalString	Receives the node text.
value	SalNumber	Receives the application value.
itemFlags	SalNumber	Receives the node flags.

Returns: SalBoolean. True if the handle resolves; false otherwise. The root returns empty text and zero values.

GetItemFlags(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemHandle(index)

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetItemIndex(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemPicture(hItem, picNormal, picSelect)

Parameter	Type	Description
hItem	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

GetItemText(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalString.

GetItemValue(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetLevel(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetNextSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetPicture(index, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

GetPrevSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetRoot()

Returns: SalNumber.

GetStyle()

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)

Parameter	Type	Description
index	SalNumber
text	SalString
color	SalNumber

Returns: SalNumber.

InsertColorValue(index, text, color, value)

Parameter	Type	Description
index	SalNumber
text	SalString
color	SalNumber
value	SalNumber

Returns: SalNumber.

InsertFont(index, text, font)

Inserts an extended list item with font handle.

Parameter	Type	Description
index	SalNumber	The requested insertion position; -1 appends through the SAL list contract.
text	SalString	The displayed item text.
font	SalNumber	The font handle to associate with the item.

Returns: SalNumber. The list insertion result, or Sys.LB_Err when the delegated control lacks SAL list support.

InsertFontValue(index, text, hFont, value)

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber
value	SalNumber

Returns: SalNumber.

InsertPicture(index, text, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
text	SalString
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

LoadOutline(blob)

Parameter	Type	Description
blob	SalString

Returns: SalNumber.

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

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

Returns: SalNumber.

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

Inserts a new node immediately after an existing sibling.

Parameter	Type	Description
hItemBefore	SalNumber	The preceding sibling handle; the root is not accepted.
picNormal	SalNumber	The normal-state picture handle.
picSelect	SalNumber	The selected-state picture handle.
text	SalString	The new node label.
value	SalNumber	The application-defined numeric value.
itemFlags	SalNumber	The initial item flags, applied after insertion.

Returns: SalNumber. The new node handle, or zero when the tree or preceding sibling is unavailable.

MoveDown(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

MoveUp(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

Promote(index, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SaveOutline(blob)

Parameter	Type	Description
blob	SalString

Returns: SalNumber.

SetColor(index, color)

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

SetFlags(index, flags, state)

Parameter	Type	Description
index	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetFont(index, hFont)

Parameter	Type	Description
index	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetIndent(width)

Parameter	Type	Description
width	SalNumber

Returns: SalBoolean.

SetItemColor(hItem, color)

Parameter	Type	Description
hItem	SalNumber
color	SalNumber

Returns: SalBoolean.

SetItemData(hItem, text, value, itemFlags)

Parameter	Type	Description
hItem	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, flags, state)

Parameter	Type	Description
hItem	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, picNormal, picSelect)

Parameter	Type	Description
hItem	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SetItemText(hItem, text)

Parameter	Type	Description
hItem	SalNumber
text	SalString

Returns: SalBoolean.

SetItemValue(hItem, value)

Parameter	Type	Description
hItem	SalNumber
value	SalNumber

Returns: SalBoolean.

SetOutlineRedraw(state)

Parameter	Type	Description
state	SalBoolean

Returns: SalBoolean.

SetPicture(index, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

SetStyle(style)

Parameter	Type	Description
style	SalNumber

Returns: SalBoolean.

ShowOutline(level)

Parameter	Type	Description
level	SalNumber

Returns: SalBoolean.

WndProc(m)

Posts VTM_Click after keyboard or left mouse button release and dispatches the native message.

Parameter	Type	Description
m	Message	The native message to process; its result can be updated.

Inherited By

Name	Description
VisColorComboBox	Displays combo-box items with individual text colors.
VisFontComboBox	Displays combo-box items with individual fonts.
VisFontNameComboBox	Lists installed font names in a combo box.
VisPictureComboBox	Displays combo-box items with associated images.

Implements

Name	Description
ISalControl
ISalEditControl
ISalListControl
ISalWindow