VisListBoxBase
PPJ.Runtime.Vis.VisListBoxBase
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Web.Vis.49 (4.9.0.0)
Base class for all the extended listbox classes in Vis.
public class VisListBoxBase : SalListBox
Constructors
VisListBoxBase()

Default Constructor.
Properties
AllowHtml

Boolean: Indicates that the control can display html in the Text property. (Default: True
)
hFont

SalNumber: Multiple Inheritance: Wrapper property.
hItem

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

sText

SalString: Multiple Inheritance: Wrapper property.
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.
Returns: SalBoolean.
DisableItem(nIndex, nColor)

Disables the specified item.
Returns: SalNumber.
DragDrop(nSourceIndex, hWndTarget, 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(hItemParent, 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: SalNumber.
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(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.
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.
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.
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(hItemParent, hPicNormal, hPicSelected, sText, nValue, nItemFlags)

Inserts an item as the last child of the specified parent.
Returns: SalNumber.
LoadChildren(hItemParent, hPicNormal, hPicSelect, sTexts, nValues, nItemFlags)

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

Deserializes the entire outline tree from the specified 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.
Returns: SalBoolean.
SaveOutline(sBlob)

Returns: SalNumber.
SetColor(nIndex, nColor)

Sets the color of a list item.
Returns: SalNumber.
SetFlags(nIndex, nFlags, bState)

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

Sets the font of the list control item.
Returns: SalNumber.
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(bState)

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.
Inherited By
Extended ListBox, supports colored items.
Displays collapsible list of directories in a listbox.
Extended ListBox, displays list of available drives.
Extended ListBox, displays the files list and file informations for a directory.
Extended ListBox, supports items of different font.
Extended ListBox, lists the names of all the installed fonts.
Listbox with pictures.
Implements
Last updated