Skip to main content

Version: 2025

VisOutlineComboBox

Namespace: PPJ.Runtime.Vis

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

A combo-style SAL field with an expandable outline-tree popup.

C#
VB.NET

public class VisOutlineComboBox : VisDropDownBase

Public Class VisOutlineComboBox
    Inherits VisDropDownBase

Outline methods distinguish node handles from visible-list indices.

Example:

var field = new VisOutlineComboBox();
            SalNumber root = field.GetRoot();
            field.LoadChild(root, 0, 0, "Group", 0, 0);

Constructors

VisOutlineComboBox()

Creates the outline popup and its extension, attaches message and selection handlers, and removes the popup border.

Properties

hFont

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

hItem

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

hPicNormal

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

hPicSelect

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

nColor

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

nIndex

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

nItemFlags

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

nLevel

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

nStyle

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

nValue

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

Sorted

Boolean: Gets or sets whether the popup outline sorts its nodes.

sText

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

Methods

AddColor(sText, nColor)

Parameter	Type	Description
sText	SalString
nColor	SalNumber

Returns: SalNumber.

AddColorValue(sText, nColor, nValue)

Parameter	Type	Description
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddFont(sText, hFont)

Parameter	Type	Description
sText	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Parameter	Type	Description
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddPicture(sText, hPicNormal, hPicSelected)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

AddPictureValue(sText, hPicNormal, hPicSelected, nValue)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

Collapse(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

DeleteChild(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DeleteDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Demote(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

DragDrop(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

Moves an outline node to another outline position.

Parameter	Type	Description
nSourceIndex	SalNumber	The source visible-item index; -1 denotes the root.
hWndTarget	SalWindowHandle	The target outline-list control handle.
nTargetIndex	SalNumber	The target visible-item index; -1 denotes the root.
nDropMode	SalNumber	DROP_Child to append beneath the target, or DROP_Sibling to insert after it.

Returns: SalBoolean. True when the node is moved; false for an unsupported target, invalid nodes, a self/descendant drop, or an unsupported mode.

The delegated operation requires an outline-tree source. Ordinary list and combo items cannot be moved by this tree operation.

EnableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	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(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

ExpandDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

FindItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalNumber.

FreeChild(hItemChild)

Parameter	Type	Description
hItemChild	SalNumber

Returns: SalBoolean.

FreeDescendents(hItemParent)

Parameter	Type	Description
hItemParent	SalNumber

Returns: SalBoolean.

FromHandle(hWnd)

Resolves a SAL handle to an existing VisOutlineComboBox.

Parameter	Type	Description
hWnd	SalWindowHandle	The control handle to resolve.

Returns: VisOutlineComboBox. The associated control, or when no control is resolved.

Throws:

InvalidCastException The handle identifies an incompatible control type.

GetColor(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFlags(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFont(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemColor(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalBoolean.

GetItemFlags(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemHandle(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemIndex(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelected)

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

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

GetPrevSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetRoot()

Returns: SalNumber.

GetStyle()

Returns: SalNumber.

InsertColor(nIndex, sText, nColor)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber

Returns: SalNumber.

InsertColorValue(nIndex, sText, nColor, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertFont(nIndex, sText, hFont)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber

Returns: SalNumber.

InsertFontValue(nIndex, sText, hFont, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertPicture(nIndex, sText, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

InsertPictureValue(nIndex, sText, hPicNormal, hPicSelected, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

LoadChild(hItemParent, hPicNormal, hPicSelected, sText, nValue, nItemFlags)

Parameter	Type	Description
hItemParent	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

LoadChildren(hItemParent, hPicNormal, hPicSelect, sTexts, nValues, nItemFlags)

Parameter	Type	Description
hItemParent	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber
sTexts	SalArray<SalString>
nValues	SalArray<SalNumber>
nItemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

LoadOutlineFile(sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect)

Parameter	Type	Description
sFileName	SalString
hPicParentNormal	SalNumber
hPicParentSelect	SalNumber
hPicChildNormal	SalNumber
hPicChildSelect	SalNumber

Returns: SalNumber.

LoadSibling(hItemBefore, hPicNormal, hPicSelected, sText, nValue, nItemFlags)

Parameter	Type	Description
hItemBefore	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

MoveDown(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

MoveUp(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

OnFontChanged(e)

Raises the inherited event and copies the field font to the popup outline.

Parameter	Type	Description
e	EventArgs	The event data.

Promote(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SaveOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

SetColor(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

SetFlags(nIndex, nFlags, bState)

Parameter	Type	Description
nIndex	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetFont(nIndex, hFont)

Parameter	Type	Description
nIndex	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetItemColor(hItem, nColor)

Parameter	Type	Description
hItem	SalNumber
nColor	SalNumber

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Parameter	Type	Description
hItem	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelected)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SetItemText(hItem, sText)

Parameter	Type	Description
hItem	SalNumber
sText	SalString

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalBoolean.

SetOutlineRedraw(bState)

Parameter	Type	Description
bState	SalBoolean

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

SetStyle(nStyle)

Parameter	Type	Description
nStyle	SalNumber

Returns: SalBoolean.

ShowOutline(nLevel)

Parameter	Type	Description
nLevel	SalNumber

Returns: SalBoolean.

Implements

Name	Description
ISalControl
ISalEditControl
ISalListControl
ISalWindow

Constructors
- VisOutlineComboBox()
Properties
Methods
Implements