VisListBoxBase

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Web.Vis.50 (5.0.0.0)

Provides extended item colors, pictures, fonts, values, and compatibility outline operations for Visual Toolchest list boxes.

C#

public class VisListBoxBase : SalListBox

VB.NET

Public Class VisListBoxBase
    Inherits SalListBox

The associated VisListBoxExtension implements the item operations. Disabled selected items are reported as having no selection.

Example:

VisListBoxBase list = new VisColorListBox();
list.AddColorValue("Ready", Sys.COLOR_Green, 1);

Constructors

VisListBoxBase()

Creates the list extension and initializes the control.

Properties

AllowHtml

Boolean: Gets the fixed HTML-rendering setting for extended list items. (Default: True)

Always . Setting this property has no effect.

hFont

SalNumber:

Reads or updates the value held by this control's list extension.

hItem

SalNumber:

Reads or updates the value held by this control's list extension.

hPicNormal

SalNumber:

Reads or updates the value held by this control's list extension.

hPicSelect

SalNumber:

Reads or updates the value held by this control's list extension.

nColor

SalNumber:

Reads or updates the value held by this control's list extension.

nIndex

SalNumber:

Reads or updates the value held by this control's list extension.

nItemFlags

SalNumber:

Reads or updates the value held by this control's list extension.

nLevel

SalNumber:

Reads or updates the value held by this control's list extension.

nStyle

SalNumber:

Reads or updates the value held by this control's list extension.

nValue

SalNumber:

Reads or updates the value held by this control's list extension.

SelectedIndex

Int32: Gets or sets the zero-based selected-item index.

The getter returns -1 when the underlying selected item is disabled. The setter delegates selection to the base control.

sText

SalString:

Reads or updates the value held by this control's list extension.

Methods

AddColor(sText, nColor)

Parameter	Type	Description
sText	SalString
nColor	SalNumber

Returns: SalNumber.

AddColorValue(sText, nColor, nValue)

Parameter	Type	Description
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddFont(sText, hFont)

Parameter	Type	Description
sText	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Parameter	Type	Description
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddPicture(sText, hPicNormal, hPicSelected)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

AddPictureValue(sText, hPicNormal, hPicSelected, nValue)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

Collapse(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

DeleteChild(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DeleteDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Demote(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

DragDrop(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

Moves an outline node to another outline position.

Parameter	Type	Description
nSourceIndex	SalNumber	The source visible-item index; -1 denotes the root.
hWndTarget	SalWindowHandle	The target outline-list control handle.
nTargetIndex	SalNumber	The target visible-item index; -1 denotes the root.
nDropMode	SalNumber	DROP_Child to append beneath the target, or DROP_Sibling to insert after it.

Returns: SalBoolean. True when the node is moved; false for an unsupported target, invalid nodes, a self/descendant drop, or an unsupported mode.

The delegated operation requires an outline-tree source. Ordinary list and combo items cannot be moved by this tree operation.

EnableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

EnumChildren(hItem, hItems)

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

Parameter	Type	Description
hItemParent	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

Expand(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

ExpandDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

FindItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalNumber.

FreeChild(hItemChild)

Parameter	Type	Description
hItemChild	SalNumber

Returns: SalBoolean.

FreeDescendents(hItemParent)

Parameter	Type	Description
hItemParent	SalNumber

Returns: SalBoolean.

GetColor(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFlags(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFont(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemColor(hItem)

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)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemHandle(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemIndex(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelected)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

GetItemText(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalString.

GetItemValue(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetLevel(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetNextSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetPicture(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

GetPrevSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetRoot()

Returns: SalNumber.

GetStyle()

Returns: SalNumber.

InsertColor(nIndex, sText, nColor)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber

Returns: SalNumber.

InsertColorValue(nIndex, sText, nColor, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertFont(nIndex, sText, hFont)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber

Returns: SalNumber.

InsertFontValue(nIndex, sText, hFont, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertPicture(nIndex, sText, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

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

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelected	SalNumber
nValue	SalNumber

Returns: SalNumber.

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

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

Returns: SalNumber.

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

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

Returns: SalNumber.

LoadOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

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

Parameter	Type	Description
sFileName	SalString
hPicParentNormal	SalNumber
hPicParentSelect	SalNumber
hPicChildNormal	SalNumber
hPicChildSelect	SalNumber

Returns: SalNumber.

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

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

Returns: SalNumber.

MoveDown(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

MoveUp(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

OnWebRender(config)

Adds the Visual Toolchest client class to the browser configuration.

Parameter	Type	Description
config	Object	The mutable browser configuration.

Chooses the virtual-list client class when virtual scrolling is enabled.

Promote(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SaveOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

SetColor(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

SetFlags(nIndex, nFlags, bState)

Parameter	Type	Description
nIndex	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetFont(nIndex, hFont)

Parameter	Type	Description
nIndex	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetItemColor(hItem, nColor)

Parameter	Type	Description
hItem	SalNumber
nColor	SalNumber

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Parameter	Type	Description
hItem	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelected)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalBoolean.

SetItemText(hItem, sText)

Parameter	Type	Description
hItem	SalNumber
sText	SalString

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalBoolean.

SetOutlineRedraw(bState)

Parameter	Type	Description
bState	SalBoolean

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelected)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelected	SalNumber

Returns: SalNumber.

SetStyle(nStyle)

Parameter	Type	Description
nStyle	SalNumber

Returns: SalBoolean.

ShowOutline(nLevel)

Parameter	Type	Description
nLevel	SalNumber

Returns: SalBoolean.

Inherited By

Name	Description
VisColorListBox	A SAL list box whose items can display individual text colors.
VisDirListBox	Displays the current server directory, its ancestors, and its immediate subdirectories.
VisDriveListBox	Lists logical drives available to the application server with their drive-type pictures.
VisFileListBox	Displays server files and directories with type pictures and tab-separated metadata.
VisFontListBox	A SAL list box that associates font handles with its items.
VisFontNameListBox	A named Visual Toolchest list box specialization for application-supplied font names.
VisPictureListBox	A SAL list box that associates normal and selected pictures with its items.
VisRadioListBox	Displays list selections using radio-button or checkbox pictures.

Implements

Name	Description
ISalControl
ISalListControl
ISalWindow