VisOutlineComboBox
PPJ.Runtime.Vis.VisOutlineComboBox
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
Combo box which supports hierarchical tree outlines.
public class VisOutlineComboBox : VisDropDownBase
Constructors
VisOutlineComboBox()

Default Constructor.
Properties
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
hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.
hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.
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.
Sorted

Boolean: Gets/Sets the sorted property.
sText

SalString: Multiple Inheritance: Wrapper property.
Methods
AddColor(text, color)

Adds an item to the list and displays it in the specified color.
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.
Returns: SalNumber.
AddFont(text, hFont)

Adds an item to the list control and displays it in the specified font.
Returns: SalNumber.
AddFontValue(text, hFont, value)

Adds a new item with the specified font and value.
Returns: SalNumber.
AddPicture(text, picNormal, picSelect)

Adds an item to the list control and specified an image for the normal and selected state.
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.
Returns: SalNumber.
Collapse(index)

Collapses all descendant items.
Returns: SalBoolean.
DeleteChild(index)

Deletes the child item from the tree control.
Returns: SalNumber.
DeleteDescendents(index)

Deletes all descendants (children, grandchildren, and so on) of the specified child.
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.
Returns: SalBoolean.
DisableItem(index, color)

Disables the specified item.
Returns: SalNumber.
DragDrop(sourceIndex, target, targetIndex, dropMode)

Moves the source item to the new location, providing support for dragging tree items.
Returns: SalBoolean.
EnableItem(index, color)

Enables the specified item.
Returns: SalNumber.
EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.
Returns: SalNumber.
EnumDescendents(hItemParent, hItems)

Enumerates descendant (children, grandchildren, and so on) item handles for a specified item.
Returns: SalNumber.
Expand(index)

Expands an outline one level at the index specified.
Returns: SalNumber.
ExpandDescendents(index)

Displays all descendants of an item.
Returns: SalBoolean.
FindItemValue(hItem, value)

Finds the item with the specified value in the descendants of the specified node.
Returns: SalNumber.
FreeChild(hItemChild)

Frees memory for the item specified and for all its descendants.
Returns: SalBoolean.
FreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.
Returns: SalBoolean.
FromHandle(handle)

Returns the control associated with the handle.
Returns: VisOutlineComboBox.
GetChildNodeCount(hItem, directChildrenOnly)

Gets the number of children for a specified item.
Returns: SalNumber.
GetColor(index)

Returns the current color of the list item.
Returns: SalNumber.
GetFlags(index)

Returns the item's flags.
Returns: SalNumber.
GetFont(index)

Returns the current font of the list control item.
Returns: SalNumber.
GetIndexFromPoint(xPos, yPos)

Returns the index of the item at the indicated screen coordinates.
Returns: SalNumber.
GetItemColor(hItem)

Retrieves the color associated with an outline item.
Returns: SalNumber.
GetItemData(hItem, text, value, itemFlags)

Returns: SalBoolean.
GetItemFlags(hItem)

Returns the items's flags.
Returns: SalNumber.
GetItemFont(hItem)

Retrieves the font associated with an outline item.
Returns: SalNumber.
GetItemHandle(index)

Retrieves the item handle based on an index specified.
Returns: SalNumber.
GetItemIndex(hItem)

Retrieves the index associated with an outline item based on an item handle.
Returns: SalNumber.
GetItemPicture(hItem, picNormal, picSelect)

Returns: SalBoolean.
GetItemText(hItem)

Returns the text for the outline item.
Returns: SalString.
GetItemValue(hItem)

Returns the value saved with the outline item.
Returns: SalNumber.
GetLevel(hItem)

Returns the indentation level of the specified item.
Returns: SalNumber.
GetNextSibling(hItem)

Retrieves the item handle for the next sibling of the specified item.
Returns: SalNumber.
GetParent(hItem)

Retrieves the item handle for the parent of the specified item.
Returns: SalNumber.
GetPicture(index, picNormal, picSelect)

Returns: SalNumber.
GetPrevSibling(hItem)

Retrieves the item handle for the previous sibling of the specified item.
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)

Returns: SalBoolean.
InsertColor(index, text, color)

Inserts an item to the list control at the specified position and displays it in the specified color.
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.
Returns: SalNumber.
InsertFont(index, text, hFont)

Adds an item to a list control at the specified index and displays it in the specified font.
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.
Returns: SalNumber.
InsertPicture(index, text, picNormal, picSelect)

Inserts an item at the specified position and specifies an image for the normal and selected state.
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.
Returns: SalNumber.
LoadChild(hItemParent, picNormal, picSelect, text, value, itemFlags)

Inserts an item as the last child of the specified parent.
Returns: SalNumber.
LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

Inserts multiple items as the last children of the specified parent item.
Returns: SalNumber.
LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

Inserts multiple items as the last children of the specified parent item.
Returns: SalNumber.
LoadOutline(blob)

Deserializes the entire outline tree from the specified string.
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.
Returns: SalNumber.
LoadSibling(hItemBefore, picNormal, picSelect, text, value, itemFlags)

Loads a new tree node as a sibling of the specified item.
Returns: SalNumber.
MoveDown(index)

Moves the specified item down one position in the tree.
Returns: SalBoolean.
MoveUp(index)

Moves an item and its descendants up in the list.
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.
Returns: SalBoolean.
SaveOutline(blob)

Returns: SalNumber.
SetColor(index, color)

Sets the color of a list item.
Returns: SalNumber.
SetFlags(index, flags, state)

Sets the item's flags.
Returns: SalBoolean.
SetFont(index, hFont)

Sets the font of the list control item.
Returns: SalNumber.
SetIndent(width)

Gets or sets the distance to indent each of the child tree node levels.
Returns: SalBoolean.
SetItemColor(hItem, color)

Sets the color of the outline item.
Returns: SalBoolean.
SetItemData(hItem, text, value, itemFlags)

Updates the specified item.
Returns: SalNumber.
SetItemFlags(hItem, flags, state)

Sets the item's flags.
Returns: SalBoolean.
SetItemFont(hItem, hFont)

Sets the font of the outline item.
Returns: SalBoolean.
SetItemPicture(hItem, picNormal, picSelect)

Assigns new bitmaps to the specified item.
Returns: SalBoolean.
SetItemText(hItem, text)

Sets the text of the outline item.
Returns: SalBoolean.
SetItemValue(hItem, value)

Sets the value associated to the outline item.
Returns: SalBoolean.
SetOutlineRedraw(state)

Enables or disables drawing.
Returns: SalBoolean.
SetPicture(index, picNormal, picSelect)

Changes the normal and selected images for the specified item.
Returns: SalNumber.
SetStyle(style)

Sets the style flags for the control.
Returns: SalBoolean.
ShowOutline(level)

Expands list items up to the specified level.
Returns: SalBoolean.
Implements
Last updated