VisListBoxExtension

PPJ.Runtime.Vis.VisListBoxExtension

Namespace: PPJ.Runtime.Vis

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

Common listbox extension class

public class VisListBoxExtension : SalGeneralWindow

Constructors

VisListBoxExtension(derived)

Multiple Inheritance Constructor

Name
Type
Description

derived

Fields

Name
Type
Description

hPicNormal

hPicSelect

nColor

nFlags

nIndex

nItemFlags

nLevel

nStyle

nValue

Methods

AddColor(sText, nColor)

Adds an item to the list and displays it in the specified color.

Parameter
Type
Description

Returns: SalNumber.

AddColorValue(sText, nColor, nValue)

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

Parameter
Type
Description

Returns: SalNumber.

AddFont(sText, hFont)

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

Parameter
Type
Description

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

Parameter
Type
Description

Returns: SalNumber.

AddPicture(sText, hPicNormal, hPicSelected)

Adds an item to the list control and specified an image for the normal and selected state.

Parameter
Type
Description

hPicNormal

hPicSelected

Returns: SalNumber.

AddPictureValue(sText, hPicNormal, hPicSelected, nValue)

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

hPicNormal

hPicSelected

nValue

Returns: SalNumber.

Collapse(nIndex)

Collapses all descendant items.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

DeleteChild(nIndex)

Deletes the child item from the tree control.

Parameter
Type
Description

nIndex

Returns: SalNumber.

DeleteDescendents(nIndex)

Deletes all descendants (children, grandchildren, and so on) of the specified child.

Parameter
Type
Description

nIndex

Returns: SalNumber.

Demote(nIndex, hPicNormal, hPicSelected)

Moves an item and all descendants right in the outline by making the item become the last child of the previous sibling. If the new parent node was not already a parent, the images are also updated. Otherwise the images are ignored.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelected

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Disables the specified item.

Parameter
Type
Description

nIndex

nColor

Returns: SalNumber.

DoDragDrop(nSourceIndex, target, nTargetIndex, nDropMode)

Moves the source item to the new location, providing support for dragging tree items.

Parameter
Type
Description

nSourceIndex

target

nTargetIndex

nDropMode

Returns: SalBoolean.

EnableItem(nIndex, nColor)

Enables the specified item.

Parameter
Type
Description

nIndex

nColor

Returns: SalNumber.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

Parameter
Type
Description

Returns: SalNumber.

EnumDescendents(hItem, hItems)

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

Parameter
Type
Description

Returns: SalNumber.

Expand(nIndex)

Expands an outline one level at the index specified.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

ExpandDescendents(nIndex)

Displays all descendants of an item.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

FindItemValue(hItem, nValue)

Finds the item with the specified value in the descendants of the specified node.

Parameter
Type
Description

Returns: SalNumber.

FreeChild(hItem)

Frees memory for the item specified and for all its descendants.

Parameter
Type
Description

Returns: SalBoolean.

FreeDescendents(hItem)

Frees memory for all descendants of the item specified.

Parameter
Type
Description

Returns: SalBoolean.

FromHandle(hWnd)

Fully qualified expressions operator.

Parameter
Type
Description

Returns: VisListBoxExtension.

FromItemHandle(handle)

Returns the instance of VisListBoxExtension from the item handle.

Parameter
Type
Description

handle

Returns: VisListBoxExtension.

GetColor(nIndex)

Returns the current color of the list item.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetFlags(nIndex)

Returns the item's flags.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetFont(nIndex)

Returns the current font of the list control item.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetItemColor(hItem)

Retrieves the color associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter
Type
Description

nItemFlags

Returns: SalBoolean.

GetItemFlags(hItem)

Returns the items's flags.

Parameter
Type
Description

Returns: SalNumber.

GetItemFont(hItem)

Retrieves the font associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

GetItemHandle(nIndex)

Retrieves the item handle based on an index specified.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetItemIndex(hItem)

Retrieves the index associated with an outline item based on an item handle.

Parameter
Type
Description

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelected)

Parameter
Type
Description

hPicNormal

hPicSelected

Returns: SalBoolean.

GetItemText(hItem)

Returns the text for the outline item.

Parameter
Type
Description

Returns: SalString.

GetItemValue(hItem)

Returns the value saved with the outline item.

Parameter
Type
Description

Returns: SalNumber.

GetLevel(hItem)

Returns the indentation level of the specified item.

Parameter
Type
Description

Returns: SalNumber.

GetNextSibling(hItem)

Retrieves the item handle for the next sibling of the specified item.

Parameter
Type
Description

Returns: SalNumber.

GetParent(hItem)

Retrieves the item handle for the parent of the specified item.

Parameter
Type
Description

Returns: SalNumber.

GetPicture(nIndex, hPicNormal, hPicSelected)

Parameter
Type
Description

nIndex

hPicNormal

hPicSelected

Returns: SalNumber.

GetPrevSibling(hItem)

Retrieves the item handle for the previous sibling of the specified item.

Parameter
Type
Description

Returns: SalNumber.

GetRoot()

Returns the handle for the root node.

Returns: SalNumber.

GetStyle()

Returns the style flags for the control.

Returns: SalNumber.

InsertColor(nIndex, sText, nColor)

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

Parameter
Type
Description

Returns: SalNumber.

InsertColorValue(nIndex, sText, nColor, nValue)

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

Returns: SalNumber.

InsertFont(nIndex, sText, hFont)

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

Parameter
Type
Description

Returns: SalNumber.

InsertFontValue(nIndex, sText, hFont, nValue)

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

Parameter
Type
Description

Returns: SalNumber.

InsertPicture(nIndex, sText, hPicNormal, hPicSelected)

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

Parameter
Type
Description

nIndex

hPicNormal

hPicSelected

Returns: SalNumber.

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

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

nIndex

hPicNormal

hPicSelected

nValue

Returns: SalNumber.

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

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

Parameter
Type
Description

hPicNormal

hPicSelected

nValue

nItemFlags

Returns: SalNumber.

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

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

Parameter
Type
Description

Returns: SalNumber.

LoadOutline(xml)

Deserializes the entire outline tree from the specified XML string.

Parameter
Type
Description

Returns: SalNumber.

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

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

Parameter
Type
Description

sFileName

hPicParentNormal

hPicParentSelect

hPicChildNormal

hPicChildSelect

Returns: SalNumber.

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

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

Parameter
Type
Description

hItemBefore

hPicNormal

hPicSelected

nValue

nItemFlags

Returns: SalNumber.

MoveDown(nIndex)

Moves the specified item down one position in the tree.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

MoveUp(nIndex)

Moves an item and its descendants up in the list.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

Promote(nIndex, hPicNormal, hPicSelected)

Moves an item and its descendants left in the outline by making it the last sibling of the parent item. If the node was the only child, the images of the previous parent node are also updated, otherwise the images are ignored.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelected

Returns: SalBoolean.

SaveOutline(xml)

Parameter
Type
Description

Returns: SalNumber.

SetColor(nIndex, nColor)

Sets the color of a list item.

Parameter
Type
Description

nIndex

nColor

Returns: SalBoolean.

SetFlags(nIndex, nFlags, bState)

Sets the item's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetFont(nIndex, hFont)

Sets the font of the list control item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemColor(hItem, nColor)

Sets the color of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

Parameter
Type
Description

nValue

nItemFlags

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelected)

Assigns new bitmaps to the specified item.

Parameter
Type
Description

hPicNormal

hPicSelected

Returns: SalBoolean.

SetItemText(hItem, sText)

Sets the text of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Sets the value associated to the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetOutlineRedraw(bRedraw)

Enables or disables drawing.

Parameter
Type
Description

bRedraw

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelected)

Changes the normal and selected images for the specified item.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelected

Returns: SalNumber.

SetStyle(nStyle)

Sets the style flags for the control.

Parameter
Type
Description

nStyle

Returns: SalBoolean.

ShowOutline(nLevel)

Expands list items up to the specified level.

Parameter
Type
Description

nLevel

Returns: SalBoolean.

Implements

Name
Description

Last updated