Skip to main content
Version: 2025

VisOutlineListBox

Namespace: PPJ.Runtime.Vis

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

public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl

Constructors

Instance memberVisOutlineListBox()

Default Constructor.

Properties

Instance memberhFont

SalNumber: Multiple Inheritance: Wrapper property.

Instance memberhItem

SalNumber: Multiple Inheritance: Wrapper property.

Instance memberhPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

Instance memberhPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

Instance memberLabel

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

Instance memberNamedProperties

SalNamedProperties: Returns the collection of named properties.

Instance membernColor

SalNumber: Multiple Inheritance: Wrapper property.

Instance membernIndex

SalNumber: Multiple Inheritance: Wrapper property.

Instance membernItemFlags

SalNumber: Multiple Inheritance: Wrapper property.

Instance membernLevel

SalNumber: Multiple Inheritance: Wrapper property.

Instance membernStyle

SalNumber: Multiple Inheritance: Wrapper property.

Instance membernValue

SalNumber: Multiple Inheritance: Wrapper property.

Instance membersText

SalString: Multiple Inheritance: Wrapper property.

Methods

Instance memberAddColor(sText, nColor)

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

ParameterTypeDescription
sTextSalString
nColorSalNumber

Returns: SalNumber.

Instance memberAddColorValue(sText, nColor, nValue)

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

ParameterTypeDescription
sTextSalString
nColorSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberAddFont(sText, hFont)

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

ParameterTypeDescription
sTextSalString
hFontSalNumber

Returns: SalNumber.

Instance memberAddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

ParameterTypeDescription
sTextSalString
hFontSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberAddListItem(sName)

Adds a string to a list box or combo box.

ParameterTypeDescription
sNameSalString

Returns: SalNumber.

Instance memberAddPicture(sText, hPicNormal, hPicSelect)

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

ParameterTypeDescription
sTextSalString
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalNumber.

Instance memberAddPictureValue(sText, hPicNormal, hPicSelect, 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.

ParameterTypeDescription
sTextSalString
hPicNormalSalNumber
hPicSelectSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberBringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

Instance memberCenterWindow()

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.

Instance memberClear()

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

Returns: SalBoolean.

Instance memberClearCursor(nType)

Clears a window's cursor.

ParameterTypeDescription
nTypeSalNumber

Returns: SalBoolean.

Instance memberClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Instance memberCollapse(nIndex)

Collapses all descendant items.

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberDeleteChild(nIndex)

Deletes the child item from the tree control.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberDeleteDescendents(nIndex)

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

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberDeleteListItem(nIndex)

Deletes a list box or combo box entry.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberDemote(nIndex, hPicNormal, hPicSelect)

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

ParameterTypeDescription
nIndexSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Instance memberDestroyWindow()

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

Returns: SalBoolean.

Instance memberDisableItem(nIndex, nColor)

Disables the specified item.

ParameterTypeDescription
nIndexSalNumber
nColorSalNumber

Returns: SalNumber.

Instance memberDisableWindow()

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.

Instance memberDisableWindowAndLabel()

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.

Instance memberDoDragDrop(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

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

ParameterTypeDescription
nSourceIndexSalNumber
hWndTargetSalWindowHandle
nTargetIndexSalNumber
nDropModeSalNumber

Returns: SalBoolean.

Instance memberEnableItem(nIndex, nColor)

Enables the specified item.

ParameterTypeDescription
nIndexSalNumber
nColorSalNumber

Returns: SalNumber.

Instance memberEnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

Instance memberEnableWindowAndLabel()

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.

Instance memberEnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

ParameterTypeDescription
hItemSalNumber
hItemsSalArray<SalNumber>

Returns: SalNumber.

Instance memberEnumDescendents(hItemParent, hItems)

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

ParameterTypeDescription
hItemParentSalNumber
hItemsSalArray<SalNumber>

Returns: SalNumber.

Instance memberExpand(nIndex)

Expands an outline one level at the index specified.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberExpandDescendents(nIndex)

Displays all descendants of an item.

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberFindChild(sWindowName)

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

ParameterTypeDescription
sWindowNameSalString

Returns: SalWindowHandle.

Instance memberFindItemValue(hItem, nValue)

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

ParameterTypeDescription
hItemSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberFormUnitsToPixels(nFormUnits, bVertical)

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.

ParameterTypeDescription
nFormUnitsSalNumber
bVerticalSalBoolean

Returns: SalNumber.

Instance memberFreeChild(hItemChild)

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

ParameterTypeDescription
hItemChildSalNumber

Returns: SalBoolean.

Instance memberFreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.

ParameterTypeDescription
hItemParentSalNumber

Returns: SalBoolean.

Static memberFromHandle(hWnd)

Returns the control associated with the handle.

ParameterTypeDescription
hWndSalWindowHandle

Returns: VisOutlineListBox.

Instance memberGetClassName()

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

Returns: SalString.

Instance memberGetColor(nIndex)

Returns the current color of the list item.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberGetControlType()

Returns an object's type.

Returns: SalNumber.

Instance memberGetDataType()

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

Returns: SalNumber.

Instance memberGetFirstChild(nTypeMask)

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.

ParameterTypeDescription
nTypeMaskSalNumber

Returns: SalWindowHandle.

Instance memberGetFlags(nIndex)

Returns the item's flags.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberGetFont(sName, nSize, nEnhancement)

ParameterTypeDescription
sNameSalString&
nSizeSalNumber&
nEnhancementSalNumber&

Returns: SalBoolean.

Instance memberGetFont(nIndex)

Returns the current font of the list control item.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberGetItemColor(hItem)

Retrieves the color associated with an outline item.

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetItemData(hItem, sText, nValue, nItemFlags)

ParameterTypeDescription
hItemSalNumber
sTextSalString&
nValueSalNumber&
nItemFlagsSalNumber&

Returns: SalBoolean.

Instance memberGetItemFlags(hItem)

Returns the items's flags.

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetItemFont(hItem)

Retrieves the font associated with an outline item.

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetItemHandle(nIndex)

Retrieves the item handle based on an index specified.

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberGetItemIndex(hItem)

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

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetItemPicture(hItem, hPicNormal, hPicSelect)

ParameterTypeDescription
hItemSalNumber
hPicNormalSalNumber&
hPicSelectSalNumber&

Returns: SalBoolean.

Instance memberGetItemText(hItem)

Returns the text for the outline item.

ParameterTypeDescription
hItemSalNumber

Returns: SalString.

Instance memberGetItemValue(hItem)

Returns the value saved with the outline item.

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetLabel()

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.

Instance memberGetLabelText(sText, nMaxLength)

ParameterTypeDescription
sTextSalString&
nMaxLengthSalNumber

Returns: SalNumber.

Instance memberGetLabelText(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.

ParameterTypeDescription
nMaxLengthSalNumber

Returns: SalString.

Instance memberGetLevel(hItem)

Returns the indentation level of the specified item.

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumber.

Instance memberGetListItemState(nIndex)

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

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberGetListItemText(nIndex, sText)

ParameterTypeDescription
nIndexSalNumber
sTextSalString&

Returns: SalNumber.

Instance memberGetListItemText(nIndex)

Returns the text of the specified item.

ParameterTypeDescription
nIndexSalNumber

Returns: SalString.

Instance memberGetListItemTextLength(nIndex)

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

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

Instance memberGetListSelectedIndex()

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

Returns: SalNumber.

Instance memberGetListSelectedItems(nSelectedArray)

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

ParameterTypeDescription
nSelectedArraySalArray<SalNumber>

Returns: SalBoolean.

Instance memberGetListSelectedItemsCount()

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.

Instance memberGetLocation(nX, nY)

ParameterTypeDescription
nXSalNumber&
nYSalNumber&

Returns: SalBoolean.

Instance memberGetName(sText)

ParameterTypeDescription
sTextSalString&

Returns: SalBoolean.

Instance memberGetName()

Gets the name of an object.

Returns: SalString.

Instance memberGetNextChild(nTypeMask)

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

ParameterTypeDescription
nTypeMaskSalNumber

Returns: SalWindowHandle.

Instance memberGetNextSibling(hItem)

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

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

Instance memberGetParent(hItem)

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

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetPicture(nIndex, hPicNormal, hPicSelect)

ParameterTypeDescription
nIndexSalNumber
hPicNormalSalNumber&
hPicSelectSalNumber&

Returns: SalNumber.

Instance memberGetPrevSibling(hItem)

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

ParameterTypeDescription
hItemSalNumber

Returns: SalNumber.

Instance memberGetProperty(sName, sValue)

ParameterTypeDescription
sNameSalString
sValueSalString&

Returns: SalBoolean.

Instance memberGetProperty(sName)

Gets the value of a named property.

ParameterTypeDescription
sNameSalString

Returns: SalString.

Instance memberGetRoot()

Returns the handle for the root node.

Returns: SalNumber.

Instance memberGetSize(nWidth, nHeight)

ParameterTypeDescription
nWidthSalNumber&
nHeightSalNumber&

Returns: SalBoolean.

Instance memberGetStyle()

Returns the style flags for the control.

Returns: SalNumber.

Instance memberGetText(sText, nMaxLen)

ParameterTypeDescription
sTextSalString&
nMaxLenSalNumber

Returns: SalNumber.

Instance memberGetText(nMaxLen)

Retrieves the text of a window.

ParameterTypeDescription
nMaxLenSalNumber

Returns: SalString.

Instance memberGetWindowColor(nColorIndex)

Gets a window's color.

ParameterTypeDescription
nColorIndexSalNumber

Returns: SalNumber.

Instance memberGetWindowState()

Returns a window's current state.

Returns: SalNumber.

Instance memberHideWindow()

Hides a window.

Returns: SalBoolean.

Instance memberHideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

Instance memberInsertColor(nIndex, sText, nColor)

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

ParameterTypeDescription
nIndexSalNumber
sTextSalString
nColorSalNumber

Returns: SalNumber.

Instance memberInsertColorValue(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.

ParameterTypeDescription
nIndexSalNumber
sTextSalString
nColorSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberInsertFont(nIndex, sText, hFont)

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

ParameterTypeDescription
nIndexSalNumber
sTextSalString
hFontSalNumber

Returns: SalNumber.

Instance memberInsertFontValue(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.

ParameterTypeDescription
nIndexSalNumber
sTextSalString
hFontSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberInsertListItem(nIndex, sAdd)

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

ParameterTypeDescription
nIndexSalNumber
sAddSalString

Returns: SalNumber.

Instance memberInsertPicture(nIndex, sText, hPicNormal, hPicSelect)

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

ParameterTypeDescription
nIndexSalNumber
sTextSalString
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalNumber.

Instance memberInsertPictureValue(nIndex, sText, hPicNormal, hPicSelect, 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.

ParameterTypeDescription
nIndexSalNumber
sTextSalString
hPicNormalSalNumber
hPicSelectSalNumber
nValueSalNumber

Returns: SalNumber.

Instance memberInvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

Instance memberIsDerivedFromClass(tClass)

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

ParameterTypeDescription
tClassType

Returns: SalBoolean.

Instance memberIsEnabled()

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

Returns: SalBoolean.

Instance memberIsModified()

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

Returns: SalBoolean.

Instance memberIsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

Instance memberKillTimer(nIDEvent)

Destroys an object's system timer.

ParameterTypeDescription
nIDEventSalNumber

Returns: SalBoolean.

Instance memberLoadChild(hItemParent, hPicNormal, hPicSelect, sText, nValue, nItemFlags)

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

ParameterTypeDescription
hItemParentSalNumber
hPicNormalSalNumber
hPicSelectSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Instance memberLoadChildren(hItemParent, hPicNormal, hPicSelect, sTexts, nValues, nItemFlags)

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

ParameterTypeDescription
hItemParentSalNumber
hPicNormalSalNumber
hPicSelectSalNumber
sTextsSalArray<SalString>
nValuesSalArray<SalNumber>
nItemFlagsSalArray<SalNumber>

Returns: SalNumber.

Instance memberLoadOutline(sBlob)

Deserializes the entire outline tree from the specified string.

ParameterTypeDescription
sBlobSalString

Returns: SalNumber.

Instance memberLoadOutlineFile(sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect)

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

ParameterTypeDescription
sFileNameSalString
hPicParentNormalSalNumber
hPicParentSelectSalNumber
hPicChildNormalSalNumber
hPicChildSelectSalNumber

Returns: SalNumber.

Instance memberLoadSibling(hItemBefore, hPicNormal, hPicSelect, sText, nValue, nItemFlags)

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

ParameterTypeDescription
hItemBeforeSalNumber
hPicNormalSalNumber
hPicSelectSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Instance memberMoveDown(nIndex)

Moves the specified item down one position in the tree.

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberMoveUp(nIndex)

Moves an item and its descendants up in the list.

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberMoveWindow(nXOffset, nYOffset)

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

ParameterTypeDescription
nXOffsetSalNumber
nYOffsetSalNumber

Returns: SalBoolean.

Instance memberPixelsToFormUnits(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.

ParameterTypeDescription
nNumPixelsSalNumber
bVerticalSalBoolean

Returns: SalNumber.

Instance memberPopulateList(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.

ParameterTypeDescription
hSqlSalSqlHandle
sSelectSalString
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

Instance memberPopulateList(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.

ParameterTypeDescription
hSqlSalSqlHandle
sSelectSalString

Returns: SalBoolean.

Instance memberPostMessage(nMsg, nMywParam, nMylParam)

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

ParameterTypeDescription
nMsgSalNumber
nMywParamSalNumber
nMylParamSalNumber

Returns: SalBoolean.

Instance memberPromote(nIndex, hPicNormal, hPicSelect)

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

ParameterTypeDescription
nIndexSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Instance memberSaveOutline(sBlob)

ParameterTypeDescription
sBlobSalString&

Returns: SalNumber.

Instance memberSendMessage(nMsg, nMywParam, nMylParam)

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

ParameterTypeDescription
nMsgSalNumber
nMywParamSalNumber
nMylParamSalNumber

Returns: SalNumber.

Instance memberSendMessageToChildren(nMsg, nMywParam, nMylParam)

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

ParameterTypeDescription
nMsgSalNumber
nMywParamSalNumber
nMylParamSalNumber

Returns: SalBoolean.

Instance memberSetColor(nIndex, nColor)

Sets the color of a list item.

ParameterTypeDescription
nIndexSalNumber
nColorSalNumber

Returns: SalNumber.

Instance memberSetContextMenu(sMenuName, nFlags)

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

ParameterTypeDescription
sMenuNameSalString
nFlagsSalNumber

Returns: SalBoolean.

Instance memberSetContextMenu(menuType, nFlags)

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

ParameterTypeDescription
menuTypeType
nFlagsSalNumber

Returns: SalBoolean.

Instance memberSetCursor(nResourceId, nType)

Sets a window's cursor.

ParameterTypeDescription
nResourceIdInt32
nTypeSalNumber

Returns: SalBoolean.

Instance memberSetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

ParameterTypeDescription
sBlobSalString
nTypeSalNumber

Returns: SalBoolean.

Instance memberSetCursorFile(sFile, nType)

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

ParameterTypeDescription
sFileSalString
nTypeSalNumber

Returns: SalBoolean.

Instance memberSetFlags(nIndex, nFlags, bState)

Sets the item's flags.

ParameterTypeDescription
nIndexSalNumber
nFlagsSalNumber
bStateSalBoolean

Returns: SalBoolean.

Instance memberSetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

Instance memberSetFont(sName, nSize, nEnhancement)

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

ParameterTypeDescription
sNameSalString
nSizeSalNumber
nEnhancementSalNumber

Returns: SalBoolean.

Instance memberSetFont(nIndex, hFont)

Sets the font of the list control item.

ParameterTypeDescription
nIndexSalNumber
hFontSalNumber

Returns: SalNumber.

Instance memberSetItemColor(hItem, nColor)

Sets the color of the outline item.

ParameterTypeDescription
hItemSalNumber
nColorSalNumber

Returns: SalBoolean.

Instance memberSetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

ParameterTypeDescription
hItemSalNumber
sTextSalString
nValueSalNumber
nItemFlagsSalNumber

Returns: SalNumber.

Instance memberSetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

ParameterTypeDescription
hItemSalNumber
nFlagsSalNumber
bStateSalBoolean

Returns: SalBoolean.

Instance memberSetItemFont(hItem, hFont)

Sets the font of the outline item.

ParameterTypeDescription
hItemSalNumber
hFontSalNumber

Returns: SalBoolean.

Instance memberSetItemPicture(hItem, hPicNormal, hPicSelect)

Assigns new bitmaps to the specified item.

ParameterTypeDescription
hItemSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalBoolean.

Instance memberSetItemText(hItem, sText)

Sets the text of the outline item.

ParameterTypeDescription
hItemSalNumber
sTextSalString

Returns: SalBoolean.

Instance memberSetItemValue(hItem, nValue)

Sets the value associated to the outline item.

ParameterTypeDescription
hItemSalNumber
nValueSalNumber

Returns: SalBoolean.

Instance memberSetLabelText(sText)

Sets the text of the associated label control.

ParameterTypeDescription
sTextSalString

Returns: SalBoolean.

Instance memberSetListSelectedIndex(nIndex)

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

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance memberSetListSelectedItems(nIndex, bSelect)

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

ParameterTypeDescription
nIndexSalNumber
bSelectSalBoolean

Returns: SalBoolean.

Instance memberSetListSelectedText(nIndexStart, sText)

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

ParameterTypeDescription
nIndexStartSalNumber
sTextSalString

Returns: SalNumber.

Instance memberSetLocation(nX, nY)

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

ParameterTypeDescription
nXSalNumber
nYSalNumber

Returns: SalBoolean.

Instance memberSetModified(bSet)

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

ParameterTypeDescription
bSetSalBoolean

Returns: SalBoolean.

Instance memberSetOutlineRedraw(bState)

Enables or disables drawing.

ParameterTypeDescription
bStateSalBoolean

Returns: SalBoolean.

Instance memberSetPicture(nIndex, hPicNormal, hPicSelect)

Changes the normal and selected images for the specified item.

ParameterTypeDescription
nIndexSalNumber
hPicNormalSalNumber
hPicSelectSalNumber

Returns: SalNumber.

Instance memberSetProperty(sName, sValue, nLength)

Sets the value of a named property.

ParameterTypeDescription
sNameSalString
sValueSalString
nLengthSalNumber

Returns: SalBoolean.

Instance memberSetSize(nWidth, nHeight)

Resizes a window.

ParameterTypeDescription
nWidthSalNumber
nHeightSalNumber

Returns: SalBoolean.

Instance memberSetStyle(nStyle)

Sets the style flags for the control.

ParameterTypeDescription
nStyleSalNumber

Returns: SalBoolean.

Instance memberSetText(sText)

Sets the text of a window.

ParameterTypeDescription
sTextSalString

Returns: SalBoolean.

Instance memberSetTimer(nIDEvent, nElapseMilliSec)

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.

ParameterTypeDescription
nIDEventSalNumber
nElapseMilliSecSalNumber

Returns: SalBoolean.

Instance memberSetWindowColor(nColorIndex, nColor)

Sets a window's color.

ParameterTypeDescription
nColorIndexSalNumber
nColorSalNumber

Returns: SalBoolean.

Instance memberShowOutline(nLevel)

Expands list items up to the specified level.

ParameterTypeDescription
nLevelSalNumber

Returns: SalBoolean.

Instance memberShowWindow()

Makes a window visible.

Returns: SalBoolean.

Instance memberShowWindowAndLabel()

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

Returns: SalBoolean.

Instance memberTrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

ParameterTypeDescription
sMenuNameSalString
nFlagsSalNumber
nXSalNumber
nYSalNumber
callbackAction<ContextMenu>

Returns: SalBoolean.

Instance memberTrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

ParameterTypeDescription
menuTypeType
nFlagsSalNumber
nXSalNumber
nYSalNumber
callbackAction<ContextMenu>

Returns: SalBoolean.

Instance memberUpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

Instance memberWindowActions

WindowActionsEventHandler

Inherited By

NameDescription
VisDesktopListBoxDisplays directory tree in a listbox similar to Win95
VisDirTreeListBoxDisplays directory tree outline in a listbox.

Implements

NameDescription
ISalControl
ISalListControl
ISalWindow