Skip to main content

VisOutlineComboBox

Namespace: PPJ.Runtime.Vis

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

Displays an outline tree in a drop-down combo box.

C#
VB.NET

public class VisOutlineComboBox : VisDropDownBase

Public Class VisOutlineComboBox
    Inherits VisDropDownBase

Example:

using (var outline = new PPJ.Runtime.Vis.VisOutlineComboBox())
{
    outline.HorizontalScrollbar = true;
}

Constructors

VisOutlineComboBox()

Initializes the outline drop-down, selection handlers, and owner drawing.

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.

HorizontalScrollbar

Boolean: Gets or sets whether the outline can display a horizontal scrollbar.

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

FromHandle(handle)

Resolves the managed outline control associated with a native window handle.

Parameter	Type	Description
handle	SalWindowHandle	The native control handle.

Returns: VisOutlineComboBox. The corresponding VisOutlineComboBox, or null when no managed control owns the handle.

A handle owned by another control type causes an InvalidCastException.

GetChildNodeCount(hItem, directChildrenOnly)

Parameter	Type	Description
hItem	SalNumber
directChildrenOnly	SalBoolean

Returns: SalNumber.

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(hItem, text, value, itemFlags)

Parameter	Type	Description
hItem	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalBoolean.

GetItemFlags(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Gets the native font handle for an outline item.

Parameter	Type	Description
hItem	SalNumber	The outline item handle.

Returns: SalNumber. The item font handle, or a newly allocated handle for the control font when the item has no font.

The fallback uses Font.ToHfont; release that native font handle when it is no longer needed.

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)

Retrieves an outline item's text bounds.

Parameter	Type	Description
index	SalNumber	The item index.
top	SalNumber	Receives the top edge in pixels.
left	SalNumber	Receives the left edge in pixels.
bottom	SalNumber	Receives the bottom edge in pixels.
right	SalNumber	Receives the right edge in pixels.

Returns: SalBoolean. True for a resolved item; otherwise, false.

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, hFont)

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber

Returns: SalNumber.

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(hItemParent, picNormal, picSelect, text, values, itemFlags)

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

Returns: SalNumber.

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

Parameter	Type	Description
hItemParent	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)

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

Returns: SalNumber.

MoveDown(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

MoveUp(index)

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

OnDrawItem(e)

Draws the selected node image and text in the combo box, then raises the base draw event.

Parameter	Type	Description
e	DrawItemEventArgs	The drawing surface, bounds, and selection state.

OnDropDown(e)

Saves the selection, sizes the outline drop-down, and sends SAM_DropDown.

Parameter	Type	Description
e	EventArgs	The drop-down event data.

The height accommodates at most 16 items.

OnFontChanged(e)

Updates the drop-down tree to use the combo box font.

Parameter	Type	Description
e	EventArgs	The font-change event data.

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.

Implements

Name	Description
ISalControl
ISalEditControl
ISalListControl
ISalWindow

Constructors
- VisOutlineComboBox()
Properties
Methods
Implements