VisListBoxExtension

PPJ.Runtime.Vis.VisListBoxExtension

Namespace: PPJ.Runtime.Vis

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

Common list box extension class

public class VisListBoxExtension : SalGeneralWindow

Public Class VisListBoxExtension
    Inherits SalGeneralWindow

Constructors

VisListBoxExtension(derived)

Multiple Inheritance Constructor

Name

Type

Description

Fields

Name

Type

Description

Methods

AddColor(sText, nColor)

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

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.

Returns: SalNumber.

AddFont(sText, hFont)

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

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

Returns: SalNumber.

AddPicture(sText, hPicNormal, hPicSelected)

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

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.

Returns: SalNumber.

Collapse(nIndex)

Collapses all descendant items.

Returns: SalBoolean.

DeleteChild(nIndex)

Deletes the child item from the tree control.

Returns: SalNumber.

DeleteDescendents(nIndex)

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

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.

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Disables the specified item.

Returns: SalNumber.

DoDragDrop(nSourceIndex, target, nTargetIndex, nDropMode)

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

Returns: SalBoolean.

EnableItem(nIndex, nColor)

Enables the specified item.

Returns: SalNumber.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

Returns: SalNumber.

EnumDescendents(hItem, hItems)

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

Returns: SalNumber.

Expand(nIndex)

Expands an outline one level at the index specified.

Returns: SalBoolean.

ExpandDescendents(nIndex)

Displays all descendants of an item.

Returns: SalBoolean.

FindItemValue(hItem, nValue)

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

Returns: SalNumber.

FreeChild(hItem)

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

Returns: SalBoolean.

FreeDescendents(hItem)

Frees memory for all descendants of the item specified.

Returns: SalBoolean.

FromHandle(hWnd)

Fully qualified expressions operator.

Returns: VisListBoxExtension.

FromItemHandle(handle)

Returns the instance of VisListBoxExtension from the item handle.

Returns: VisListBoxExtension.

GetChildNodeCount(hItem, bDirectChildrenOnly)

Gets the number of children for a specified item.

Returns: SalNumber.

GetColor(nIndex)

Returns the current color of the list item.

Returns: SalNumber.

GetFlags(nIndex)

Returns the item's flags.

Returns: SalNumber.

GetFont(nIndex)

Returns the current font of the list control item.

Returns: SalNumber.

GetIndexFromPoint(nXPos, nYPos)

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, sText, nValue, nItemFlags)

Returns: SalBoolean.

GetItemFlags(hItem)

Returns the items's flags.

Returns: SalNumber.

GetItemFont(hItem)

Retrieves the font associated with an outline item.

Returns: SalNumber.

GetItemHandle(nIndex)

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, hPicNormal, hPicSelected)

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(nIndex, hPicNormal, hPicSelected)

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(nIndex, nTop, nLeft, nBottom, nRight)

Returns: SalBoolean.

InsertColor(nIndex, sText, nColor)

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

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.

Returns: SalNumber.

InsertFont(nIndex, sText, hFont)

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

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.

Returns: SalNumber.

InsertPicture(nIndex, sText, hPicNormal, hPicSelected)

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

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.

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

LoadOutline(xml)

Deserializes the entire outline tree from the specified XML string.

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.

Returns: SalNumber.

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

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

Returns: SalNumber.

MoveDown(nIndex)

Moves the specified item down one position in the tree.

Returns: SalBoolean.

MoveUp(nIndex)

Moves an item and its descendants up in the list.

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.

Returns: SalBoolean.

SaveOutline(xml)

Returns: SalNumber.

SetColor(nIndex, nColor)

Sets the color of a list item.

Returns: SalBoolean.

SetFlags(nIndex, nFlags, bState)

Sets the item's flags.

Returns: SalBoolean.

SetFont(nIndex, hFont)

Sets the font of the list control item.

Returns: SalBoolean.

SetIndent(nWidth)

Gets or sets the distance to indent each of the child tree node levels.

Returns: SalBoolean.

SetItemColor(hItem, nColor)

Sets the color of the outline item.

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelected)

Assigns new bitmaps to the specified item.

Returns: SalBoolean.

SetItemText(hItem, sText)

Sets the text of the outline item.

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Sets the value associated to the outline item.

Returns: SalBoolean.

SetOutlineRedraw(bRedraw)

Enables or disables drawing.

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelected)

Changes the normal and selected images for the specified item.

Returns: SalNumber.

SetStyle(nStyle)

Sets the style flags for the control.

Returns: SalBoolean.

ShowOutline(nLevel)

Expands list items up to the specified level.

Returns: SalBoolean.

Implements

PreviousVisListBoxBase NextVisListView

Last updated 1 year ago