VisOutlineListBox

PPJ.Runtime.Vis.VisOutlineListBox

Namespace: PPJ.Runtime.Vis

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

C#

public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl

VB.NET

Constructors

VisOutlineListBox()

Default Constructor.

Properties

AllowDrag

Boolean: Enabled/Disables automatic drag operations. (Default: True)

hFont

SalNumber: Multiple Inheritance: Wrapper property.

hItem

SalNumber: Multiple Inheritance: Wrapper property.

HorizontalScrollbar

Boolean: Shows/Hides the horizontal scrollbar. Supported starting from Common Controls v. 5.80 (Default: True)

hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

ImageSize

Size: Gets or sets the default size for the node images. (Default: "16, 16")

Label

Control: Returns/Sets the label associated with this control.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

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.

SelectedNodes

TreeNode[]: Returns the collection of all selected nodes.

SelectionMode

SelectionMode: Returns/Sets the selection mode. (Default: One)

sText

SalString: Multiple Inheritance: Wrapper property.

UseStateImageList

Boolean: Determines whether the control uses the StateImageList or the default ImageList to render the node images. When using the StateImageList, nodes without a specific image are left aligned without any icon. When using the default ImageList, nodes without an image show the default first image in the list.

Methods

AddColor(text, color)

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

Parameter	Type	Description
text	SalString
color	SalNumber

Returns: SalNumber.

AddColorValue(text, color, value)

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

Parameter	Type	Description
text	SalString
color	SalNumber
value	SalNumber

Returns: SalNumber.

AddFont(text, hFont)

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

Parameter	Type	Description
text	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(text, hFont, value)

Adds a new item with the specified font and value.

Parameter	Type	Description
text	SalString
hFont	SalNumber
value	SalNumber

Returns: SalNumber.

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

AddPicture(text, picNormal, picSelect)

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

Parameter	Type	Description
text	SalString
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

AddPictureValue(text, picNormal, picSelect, value)

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
text	SalString
picNormal	SalNumber
picSelect	SalNumber
value	SalNumber

Returns: SalNumber.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

CenterWindow()

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

Returns: SalBoolean.

Clear()

Clears the value from a data field, multi line field, or table window column.

Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.

Parameter	Type	Description
nType	SalNumber

Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Collapse(index)

Collapses all descendant items.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

DeleteChild(index)

Deletes the child item from the tree control.

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

DeleteDescendents(index)

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

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Demote(index, picNormal, picSelect)

Moves an item and all descendants right in the outline by making the item become the last child of the previous sibling.

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

DestroyWindow()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Returns: SalBoolean.

DisableItem(index, color)

Disables the specified item.

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

DisableWindow()

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean.

DisableWindowAndLabel()

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean.

DoDragDrop(sourceIndex, target, targetIndex, dropMode)

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

Parameter	Type	Description
sourceIndex	SalNumber
target	SalWindowHandle
targetIndex	SalNumber
dropMode	SalNumber

Returns: SalBoolean.

EnableItem(index, color)

Enables the specified item.

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

EnableWindowAndLabel()

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

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

Parameter	Type	Description
hItemParent	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

Expand(index)

Expands an outline one level at the index specified.

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

ExpandDescendents(index)

Displays all descendants of an item.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

FindChild(windowName)

This function finds a child window of a given name in the specified window.

Parameter	Type	Description
windowName	SalString

Returns: SalWindowHandle.

FindItemValue(hItem, value)

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

Parameter	Type	Description
hItem	SalNumber
value	SalNumber

Returns: SalNumber.

FormUnitsToPixels(formUnits, vertical)

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

Parameter	Type	Description
formUnits	SalNumber	The number of form units.
vertical	SalBoolean	If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Returns: SalNumber.

FreeChild(hItemChild)

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

Parameter	Type	Description
hItemChild	SalNumber

Returns: SalBoolean.

FreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.

Parameter	Type	Description
hItemParent	SalNumber

Returns: SalBoolean.

FromHandle(handle)

Returns the control associated with the handle.

Parameter	Type	Description
handle	SalWindowHandle

Returns: VisOutlineListBox.

GetChildNodeCount(hItem, directChildrenOnly)

Gets the number of children for a specified item.

Parameter	Type	Description
hItem	SalNumber
directChildrenOnly	SalBoolean

Returns: SalNumber.

GetClassName()

Return the name of a window's class as a string.

Returns: SalString.

GetColor(index)

Returns the current color of the list item.

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDataType()

Returns a data field's or table window column's data type.

Returns: SalNumber.

GetFirstChild(typeMask)

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

Parameter	Type	Description
typeMask	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetFlags(index)

Returns the item's flags.

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetFont(name, size, enhancement)

Parameter	Type	Description
name	SalString&
size	SalNumber&
enhancement	SalNumber&

Returns: SalBoolean.

GetFont(index)

Returns the current font of the list control item.

Parameter	Type	Description
index	SalNumber

Returns: SalNumber.

GetIndexFromPoint(xPos, yPos)

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

Parameter	Type	Description
xPos	SalNumber
yPos	SalNumber

Returns: SalNumber.

GetItemColor(hItem)

Retrieves the color associated with an outline item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemData(hItem, text, value, itemFlags)

Parameter	Type	Description
hItem	SalNumber
text	SalString&
value	SalNumber&
itemFlags	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(index)

Retrieves the item handle based on an index specified.

Parameter	Type	Description
index	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, picNormal, picSelect)

Parameter	Type	Description
hItem	SalNumber
picNormal	SalNumber&
picSelect	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.

GetLabel()

Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.

Returns: SalWindowHandle.

GetLabelText(sText, nMaxLength)

Parameter	Type	Description
sText	SalString&
nMaxLength	SalNumber

Returns: SalNumber.

GetLabelText(nMaxLength)

Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.

Parameter	Type	Description
nMaxLength	SalNumber

Returns: SalString.

GetLevel(hItem)

Returns the indentation level of the specified item.

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumber.

GetListItemState(nIndex)

Determines whether the specified list box or combo box entry is selected.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

GetListItemText(nIndex, sText)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString&

Returns: SalNumber.

GetListItemText(nIndex)

Returns the text of the specified item.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalString.

GetListItemTextLength(nIndex)

Returns the length of a list box or combo box entry.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetListSelectedIndex()

Returns the index of the selected entry in a combo box or single-selection list box.

Returns: SalNumber.

GetListSelectedItems(nSelectedArray)

Returns an array of index numbers of selected list box entries.

Parameter	Type	Description
nSelectedArray	SalArray<SalNumber>

Returns: SalBoolean.

GetListSelectedItemsCount()

Returns the number of selected entries in a multiple-selection list box. Specify single- or multiple-selection in the list box's customizer.

Returns: SalNumber.

GetLocation(x, y)

Parameter	Type	Description
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetName(text)

Parameter	Type	Description
text	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

Returns the handle of the next child window that matches a specified type.

Parameter	Type	Description
typeMask	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetNextSibling(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetParent(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetPicture(index, picNormal, picSelect)

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber&
picSelect	SalNumber&

Returns: SalNumber.

GetPrevSibling(hItem)

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

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetProperty(name, value)

Parameter	Type	Description
name	SalString
value	SalString&

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter	Type	Description
name	SalString

Returns: SalString.

GetRoot()

Returns the handle for the root node.

Returns: SalNumber.

GetSize(width, height)

Parameter	Type	Description
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetStyle()

Returns the style flags for the control.

Returns: SalNumber.

GetText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetTextRectangle(index, top, left, bottom, right)

Parameter	Type	Description
index	SalNumber
top	SalNumber&
left	SalNumber&
bottom	SalNumber&
right	SalNumber&

Returns: SalBoolean.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

InsertColor(index, text, color)

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

Parameter	Type	Description
index	SalNumber
text	SalString
color	SalNumber

Returns: SalNumber.

InsertColorValue(index, text, color, value)

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
index	SalNumber
text	SalString
color	SalNumber
value	SalNumber

Returns: SalNumber.

InsertFont(index, text, hFont)

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

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber

Returns: SalNumber.

InsertFontValue(index, text, hFont, value)

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

Parameter	Type	Description
index	SalNumber
text	SalString
hFont	SalNumber
value	SalNumber

Returns: SalNumber.

InsertListItem(nIndex, sAdd)

Inserts an entry into a list box or combo box at a specified position.

Parameter	Type	Description
nIndex	SalNumber
sAdd	SalString

Returns: SalNumber.

InsertPicture(index, text, picNormal, picSelect)

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

Parameter	Type	Description
index	SalNumber
text	SalString
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

InsertPictureValue(index, text, picNormal, picSelect, value)

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
index	SalNumber
text	SalString
picNormal	SalNumber
picSelect	SalNumber
value	SalNumber

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

Determines whether a window is an instance of the specified class.

Parameter	Type	Description
typeClass	Type

Returns: SalBoolean.

IsEnabled()

Determines whether a window is enabled for mouse and keyboard input.

Returns: SalBoolean.

IsModified()

Returns the setting of the Field Edit Flag for a data field, multi line field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter	Type	Description
idEvent	SalNumber

Returns: SalBoolean.

LoadChild(hItemParent, picNormal, picSelect, text, value, itemFlags)

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

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

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

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalArray<SalString>
values	SalArray<SalNumber>
itemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadChildren(hItemParent, picNormal, picSelect, text, values, itemFlags)

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

Parameter	Type	Description
hItemParent	SalNumber
picNormal	SalArray<SalNumber>
picSelect	SalArray<SalNumber>
text	SalArray<SalString>
values	SalArray<SalNumber>
itemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadOutline(blob)

Deserializes the entire outline tree from the specified string.

Parameter	Type	Description
blob	SalString

Returns: SalNumber.

LoadOutlineFile(fileName, picParentNormal, picParentSelect, picChildNormal, picChildSelect)

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

Parameter	Type	Description
fileName	SalString
picParentNormal	SalNumber
picParentSelect	SalNumber
picChildNormal	SalNumber
picChildSelect	SalNumber

Returns: SalNumber.

LoadSibling(hItemBefore, picNormal, picSelect, text, value, itemFlags)

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

Parameter	Type	Description
hItemBefore	SalNumber
picNormal	SalNumber
picSelect	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

MoveDown(index)

Moves the specified item down one position in the tree.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

MoveUp(index)

Moves an item and its descendants up in the list.

Parameter	Type	Description
index	SalNumber

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter	Type	Description
nXOffset	SalNumber
nYOffset	SalNumber

Returns: SalBoolean.

PixelsToFormUnits(nNumPixels, bVertical)

Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.

Parameter	Type	Description
nNumPixels	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

PopulateList(hSql, sSelect)

Populates a list box or combo box with a result set. SalListPopulate overrides any settings made with SalListSetTabs. If the SELECT statement returns data from multiple columns, each column's data displayed in a list box is separated by tabs. However, due to a Microsoft Windows limitation, each column's data displayed in a combo box is separated by a single '|' character. There is no space between one column's data, the separator character, and another column's data.

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString

Returns: SalBoolean.

PopulateList(hSql, sSelect, errorHandler)

Populates a list box or combo box with a result set. SalListPopulate overrides any settings made with SalListSetTabs. If the SELECT statement returns data from multiple columns, each column's data displayed in a list box is separated by tabs. However, due to a Microsoft Windows limitation, each column's data displayed in a combo box is separated by a single '|' character. There is no space between one column's data, the separator character, and another column's data.

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

PostMessage(msg, mywParam, mylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalBoolean.

Promote(index, picNormal, picSelect)

Moves an item and its descendants left in the outline by making it the last sibling of the parent item.

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SaveOutline(blob)

Parameter	Type	Description
blob	SalString&

Returns: SalNumber.

SendMessage(msg, mywParam, mylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SetColor(index, color)

Sets the color of a list item.

Parameter	Type	Description
index	SalNumber
color	SalNumber

Returns: SalNumber.

SetContextMenu(menuName, flags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
menuName	SalString
flags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, flags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter	Type	Description
resource	SalResourceCursor
type	SalNumber

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
resourceId	Int32
type	SalNumber

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
blob	SalString
type	SalNumber

Returns: SalBoolean.

SetCursorFile(file, type)

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

Parameter	Type	Description
file	SalString
type	SalNumber

Returns: SalBoolean.

SetFlags(index, flags, state)

Sets the item's flags.

Parameter	Type	Description
index	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

Sets a window's font, font size, and font enhancements.

Parameter	Type	Description
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

SetFont(index, hFont)

Sets the font of the list control item.

Parameter	Type	Description
index	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetIndent(width)

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

Parameter	Type	Description
width	SalNumber

Returns: SalBoolean.

SetItemColor(hItem, color)

Sets the color of the outline item.

Parameter	Type	Description
hItem	SalNumber
color	SalNumber

Returns: SalBoolean.

SetItemData(hItem, text, value, itemFlags)

Updates the specified item.

Parameter	Type	Description
hItem	SalNumber
text	SalString
value	SalNumber
itemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, flags, state)

Sets the item's flags.

Parameter	Type	Description
hItem	SalNumber
flags	SalNumber
state	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, picNormal, picSelect)

Assigns new bitmaps to the specified item.

Parameter	Type	Description
hItem	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalBoolean.

SetItemText(hItem, text)

Sets the text of the outline item.

Parameter	Type	Description
hItem	SalNumber
text	SalString

Returns: SalBoolean.

SetItemValue(hItem, value)

Sets the value associated to the outline item.

Parameter	Type	Description
hItem	SalNumber
value	SalNumber

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetListRedraw(bRedraw)

Redraws entries in a list box or combo box, or prevents them from being redrawn.

Parameter	Type	Description
bRedraw	SalNumber

Returns: SalBoolean.

SetListSelectedIndex(nIndex)

Selects or deselects a combo box or single-selection list box entry.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

SetListSelectedItems(nIndex, bSelect)

Selects or deselects a combo box or multiple-selection list box entry.

Parameter	Type	Description
nIndex	SalNumber
bSelect	SalBoolean

Returns: SalBoolean.

SetListSelectedText(nIndexStart, sText)

Finds and selects a combo box or single-selection list box entry.

Parameter	Type	Description
nIndexStart	SalNumber
sText	SalString

Returns: SalNumber.

SetLocation(x, y)

Moves a window to a new position (x, y) on the X and Y axes.

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetModified(bSet)

Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.

Parameter	Type	Description
bSet	SalBoolean

Returns: SalBoolean.

SetOutlineRedraw(state)

Enables or disables drawing.

Parameter	Type	Description
state	SalBoolean

Returns: SalBoolean.

SetPicture(index, picNormal, picSelect)

Changes the normal and selected images for the specified item.

Parameter	Type	Description
index	SalNumber
picNormal	SalNumber
picSelect	SalNumber

Returns: SalNumber.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter	Type	Description
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

SetSelected(node, selected)

Selects/Deselects the specified node.

Parameter	Type	Description
node	TreeNode
selected	Boolean

SetSize(width, height)

Resizes a window.

Parameter	Type	Description
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetStyle(style)

Sets the style flags for the control.

Parameter	Type	Description
style	SalNumber

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter	Type	Description
text	SalString

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

Parameter	Type	Description
idEvent	SalNumber
elapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

ShowOutline(level)

Expands list items up to the specified level.

Parameter	Type	Description
level	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

ShowWindowAndLabel()

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter	Type	Description
file	SalString
command	SalNumber
numData	SalNumber
strData	SalString

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Inherited By

Name	Description
VisDesktopListBox	Displays directory tree in a list box similar to Win95
VisDirTreeListBox	Displays directory tree outline in a list box.

Implements

Name	Description
ISalControl
ISalListControl
ISalWindow