VisListBoxExtension

PPJ.Runtime.Vis.VisListBoxExtension

Namespace: PPJ.Runtime.Vis

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

Common list box extension class

C#

public class VisListBoxExtension : SalGeneralWindow

VB.NET

Constructors

VisListBoxExtension(derived)

Multiple Inheritance Constructor

Name	Type	Description
derived	ISalWindow

Fields

Name	Type	Description
hFont	SalNumber
hItem	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber
nColor	SalNumber
nFlags	SalNumber	from cOutline
nIdx	SalNumber	from cOutline
nIndex	SalNumber
nItemFlags	SalNumber
nLevel	SalNumber
nStyle	SalNumber
nValue	SalNumber
sText	SalString

Methods

AddColor(sText, nColor)

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

Parameter	Type	Description
sText	SalString
nColor	SalNumber

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
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddFont(sText, hFont)

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

Parameter	Type	Description
sText	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

Parameter	Type	Description
sText	SalString
hFont	SalNumber
nValue	SalNumber

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
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

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
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

Collapse(nIndex)

Collapses all descendant items.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

DeleteChild(nIndex)

Deletes the child item from the tree control.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DeleteDescendents(nIndex)

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

Parameter	Type	Description
nIndex	SalNumber

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	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Disables the specified item.

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

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	SalNumber
target	Control
nTargetIndex	SalNumber
nDropMode	SalNumber

Returns: SalBoolean.

EnableItem(nIndex, nColor)

Enables the specified item.

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItem, hItems)

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

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

Expand(nIndex)

Expands an outline one level at the index specified.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

ExpandDescendents(nIndex)

Displays all descendants of an item.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

FindItemValue(hItem, nValue)

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

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalNumber.

FreeChild(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalBoolean.

FreeDescendents(hItem)

Frees memory for all descendants of the item specified.

Parameter	Type	Description
hItem	SalNumber

Returns: SalBoolean.

FromHandle(hWnd)

Fully qualified expressions operator.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: VisListBoxExtension.

FromItemHandle(handle)

Returns the instance of VisListBoxExtension from the item handle.

Parameter	Type	Description
handle	SalNumber

Returns: VisListBoxExtension.

GetChildNodeCount(hItem, bDirectChildrenOnly)

Gets the number of children for a specified item.

Parameter	Type	Description
hItem	SalNumber
bDirectChildrenOnly	SalBoolean

Returns: SalNumber.

GetColor(nIndex)

Returns the current color of the list item.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFlags(nIndex)

Returns the item's flags.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFont(nIndex)

Returns the current font of the list control item.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetIndexFromPoint(nXPos, nYPos)

Returns the index of the item at the indicated screen coordinates.

Parameter	Type	Description
nXPos	SalNumber
nYPos	SalNumber

Returns: SalNumber.

GetItemColor(hItem)

Retrieves the color associated with an outline item.

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)

Returns the items's flags.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Retrieves the font associated with an outline item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemHandle(nIndex)

Retrieves the item handle based on an index specified.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemIndex(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelected)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber&
hPicSelected	SalNumber&

Returns: SalBoolean.

GetItemText(hItem)

Returns the text for the outline item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalString.

GetItemValue(hItem)

Returns the value saved with the outline item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetLevel(hItem)

Returns the indentation level of the specified item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetNextSibling(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetPicture(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber&
hPicSelected	SalNumber&

Returns: SalNumber.

GetPrevSibling(hItem)

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

Parameter	Type	Description
hItem	SalNumber

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)

Parameter	Type	Description
nIndex	SalNumber
nTop	SalNumber&
nLeft	SalNumber&
nBottom	SalNumber&
nRight	SalNumber&

Returns: SalBoolean.

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
nIndex	SalNumber
sText	SalString
nColor	SalNumber

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
nIndex	SalNumber
sText	SalString
nColor	SalNumber
nValue	SalNumber

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
nIndex	SalNumber
sText	SalString
hFont	SalNumber

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
nIndex	SalNumber
sText	SalString
hFont	SalNumber
nValue	SalNumber

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	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

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	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

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

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

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

Returns: SalNumber.

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

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

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

Returns: SalNumber.

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

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

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

Returns: SalNumber.

LoadOutline(xml)

Deserializes the entire outline tree from the specified XML string.

Parameter	Type	Description
xml	SalString

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	SalString
hPicParentNormal	SalNumber
hPicParentSelect	SalNumber
hPicChildNormal	SalNumber
hPicChildSelect	SalNumber

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	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

MoveDown(nIndex)

Moves the specified item down one position in the tree.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

MoveUp(nIndex)

Moves an item and its descendants up in the list.

Parameter	Type	Description
nIndex	SalNumber

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	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SaveOutline(xml)

Parameter	Type	Description
xml	SalString&

Returns: SalNumber.

SetColor(nIndex, nColor)

Sets the color of a list item.

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

SetFlags(nIndex, nFlags, bState)

Sets the item's flags.

Parameter	Type	Description
nIndex	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetFont(nIndex, hFont)

Sets the font of the list control item.

Parameter	Type	Description
nIndex	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetIndent(nWidth)

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

Parameter	Type	Description
nWidth	SalNumber

Returns: SalBoolean.

SetItemColor(hItem, nColor)

Sets the color of the outline item.

Parameter	Type	Description
hItem	SalNumber
nColor	SalNumber

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

Parameter	Type	Description
hItem	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelected)

Assigns new bitmaps to the specified item.

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SetItemText(hItem, sText)

Sets the text of the outline item.

Parameter	Type	Description
hItem	SalNumber
sText	SalString

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Sets the value associated to the outline item.

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalBoolean.

SetOutlineRedraw(bRedraw)

Enables or disables drawing.

Parameter	Type	Description
bRedraw	SalBoolean

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelected)

Changes the normal and selected images for the specified item.

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

SetStyle(nStyle)

Sets the style flags for the control.

Parameter	Type	Description
nStyle	SalNumber

Returns: SalBoolean.

ShowOutline(nLevel)

Expands list items up to the specified level.

Parameter	Type	Description
nLevel	SalNumber

Returns: SalBoolean.

Implements

Name	Description
ISalWindow