VisOutlineListBox

PPJ.Runtime.Vis.VisOutlineListBox

Namespace: PPJ.Runtime.Vis

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

public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl

Constructors

VisOutlineListBox()

Default Constructor.

Properties

hFont

SalNumber: Multiple Inheritance: Wrapper property.

hItem

SalNumber: Multiple Inheritance: Wrapper property.

hPicNormal

SalNumber: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumber: Multiple Inheritance: Wrapper property.

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.

sText

SalString: Multiple Inheritance: Wrapper property.

Methods

AddColor(sText, nColor)

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

Parameter
Type
Description

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

Returns: SalNumber.

AddFont(sText, hFont)

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

Parameter
Type
Description

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

Parameter
Type
Description

Returns: SalNumber.

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter
Type
Description

Returns: SalNumber.

AddPicture(sText, hPicNormal, hPicSelect)

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

Parameter
Type
Description

hPicNormal

hPicSelect

Returns: SalNumber.

AddPictureValue(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.

Parameter
Type
Description

hPicNormal

hPicSelect

nValue

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, multiline field, or table window column.

Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Collapse(nIndex)

Collapses all descendant items.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

DeleteChild(nIndex)

Deletes the child item from the tree control.

Parameter
Type
Description

nIndex

Returns: SalNumber.

DeleteDescendents(nIndex)

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

Parameter
Type
Description

nIndex

Returns: SalNumber.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter
Type
Description

nIndex

Returns: SalNumber.

Demote(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.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

Returns: SalBoolean.

DestroyWindow()

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

Returns: SalBoolean.

DisableItem(nIndex, nColor)

Disables the specified item.

Parameter
Type
Description

nIndex

nColor

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(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

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

Parameter
Type
Description

nSourceIndex

hWndTarget

nTargetIndex

nDropMode

Returns: SalBoolean.

EnableItem(nIndex, nColor)

Enables the specified item.

Parameter
Type
Description

nIndex

nColor

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

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

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

Parameter
Type
Description

Returns: SalNumber.

Expand(nIndex)

Expands an outline one level at the index specified.

Parameter
Type
Description

nIndex

Returns: SalNumber.

ExpandDescendents(nIndex)

Displays all descendants of an item.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

FindChild(sWindowName)

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

Parameter
Type
Description

sWindowName

Returns: SalWindowHandle.

FindItemValue(hItem, nValue)

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

Parameter
Type
Description

Returns: SalNumber.

FormUnitsToPixels(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.

Parameter
Type
Description

nFormUnits

bVertical

Returns: SalNumber.

FreeChild(hItemChild)

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

Parameter
Type
Description

hItemChild

Returns: SalBoolean.

FreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.

Parameter
Type
Description

hItemParent

Returns: SalBoolean.

FromHandle(hWnd)

Returns the control associated with the handle.

Parameter
Type
Description

Returns: VisOutlineListBox.

GetClassName()

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

Returns: SalString.

GetColor(nIndex)

Returns the current color of the list item.

Parameter
Type
Description

nIndex

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

Parameter
Type
Description

nTypeMask

Returns: SalWindowHandle.

GetFlags(nIndex)

Returns the item's flags.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetFont(sName, nSize, nEnhancement)

Parameter
Type
Description

nEnhancement

Returns: SalBoolean.

GetFont(nIndex)

Returns the current font of the list control item.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetItemColor(hItem)

Retrieves the color associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter
Type
Description

nItemFlags

Returns: SalBoolean.

GetItemFlags(hItem)

Returns the items's flags.

Parameter
Type
Description

Returns: SalNumber.

GetItemFont(hItem)

Retrieves the font associated with an outline item.

Parameter
Type
Description

Returns: SalNumber.

GetItemHandle(nIndex)

Retrieves the item handle based on an index specified.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetItemIndex(hItem)

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

Parameter
Type
Description

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelect)

Parameter
Type
Description

hPicNormal

hPicSelect

Returns: SalBoolean.

GetItemText(hItem)

Returns the text for the outline item.

Parameter
Type
Description

Returns: SalString.

GetItemValue(hItem)

Returns the value saved with the outline item.

Parameter
Type
Description

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

nMaxLength

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

Returns: SalString.

GetLevel(hItem)

Returns the indentation level of the specified item.

Parameter
Type
Description

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

Returns: SalBoolean.

GetListItemText(nIndex, sText)

Parameter
Type
Description

Returns: SalNumber.

GetListItemText(nIndex)

Returns the text of the specified item.

Parameter
Type
Description

nIndex

Returns: SalString.

GetListItemTextLength(nIndex)

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

Parameter
Type
Description

nIndex

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

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(nX, nY)

Parameter
Type
Description

Returns: SalBoolean.

GetName(sText)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

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

Parameter
Type
Description

nTypeMask

Returns: SalWindowHandle.

GetNextSibling(hItem)

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

Parameter
Type
Description

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

Returns: SalNumber.

GetPicture(nIndex, hPicNormal, hPicSelect)

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

Returns: SalNumber.

GetPrevSibling(hItem)

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

Parameter
Type
Description

Returns: SalNumber.

GetProperty(sName, sValue)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetRoot()

Returns the handle for the root node.

Returns: SalNumber.

GetSize(nWidth, nHeight)

Parameter
Type
Description

Returns: SalBoolean.

GetStyle()

Returns the style flags for the control.

Returns: SalNumber.

GetText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter
Type
Description

nColorIndex

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(nIndex, sText, nColor)

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

Parameter
Type
Description

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

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

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

Returns: SalNumber.

InsertListItem(nIndex, sAdd)

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

Parameter
Type
Description

Returns: SalNumber.

InsertPicture(nIndex, sText, hPicNormal, hPicSelect)

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

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

Returns: SalNumber.

InsertPictureValue(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.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

nValue

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(tClass)

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

Parameter
Type
Description

tClass

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, multiline field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(nIDEvent)

Destroys an object's system timer.

Parameter
Type
Description

nIDEvent

Returns: SalBoolean.

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

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

Parameter
Type
Description

hItemParent

hPicNormal

hPicSelect

nValue

nItemFlags

Returns: SalNumber.

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

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

Parameter
Type
Description

Returns: SalNumber.

LoadOutline(sBlob)

Deserializes the entire outline tree from the specified string.

Parameter
Type
Description

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

hPicParentNormal

hPicParentSelect

hPicChildNormal

hPicChildSelect

Returns: SalNumber.

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

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

Parameter
Type
Description

hItemBefore

hPicNormal

hPicSelect

nValue

nItemFlags

Returns: SalNumber.

MoveDown(nIndex)

Moves the specified item down one position in the tree.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

MoveUp(nIndex)

Moves an item and its descendants up in the list.

Parameter
Type
Description

nIndex

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

nYOffset

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

bVertical

Returns: SalNumber.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

Promote(nIndex, hPicNormal, hPicSelect)

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

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

Returns: SalBoolean.

SaveOutline(sBlob)

Parameter
Type
Description

Returns: SalNumber.

SendMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

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

nMywParam

nMylParam

Returns: SalBoolean.

SetColor(nIndex, nColor)

Sets the color of a list item.

Parameter
Type
Description

nIndex

nColor

Returns: SalNumber.

SetContextMenu(sMenuName, nFlags)

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

Parameter
Type
Description

sMenuName

nFlags

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

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

Parameter
Type
Description

menuType

nFlags

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter
Type
Description

nResourceId

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

SetCursorFile(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.

Parameter
Type
Description

Returns: SalBoolean.

SetFlags(nIndex, nFlags, bState)

Sets the item's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(sName, nSize, nEnhancement)

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

Parameter
Type
Description

nEnhancement

Returns: SalBoolean.

SetFont(nIndex, hFont)

Sets the font of the list control item.

Parameter
Type
Description

Returns: SalNumber.

SetItemColor(hItem, nColor)

Sets the color of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

Parameter
Type
Description

nValue

nItemFlags

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelect)

Assigns new bitmaps to the specified item.

Parameter
Type
Description

hPicNormal

hPicSelect

Returns: SalBoolean.

SetItemText(hItem, sText)

Sets the text of the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Sets the value associated to the outline item.

Parameter
Type
Description

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter
Type
Description

Returns: SalBoolean.

SetListSelectedIndex(nIndex)

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

Parameter
Type
Description

nIndex

Returns: SalBoolean.

SetListSelectedItems(nIndex, bSelect)

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

Parameter
Type
Description

nIndex

bSelect

Returns: SalBoolean.

SetListSelectedText(nIndexStart, sText)

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

Parameter
Type
Description

nIndexStart

Returns: SalNumber.

SetLocation(nX, nY)

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

Parameter
Type
Description

Returns: SalBoolean.

SetModified(bSet)

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

Parameter
Type
Description

Returns: SalBoolean.

SetOutlineRedraw(bState)

Enables or disables drawing.

Parameter
Type
Description

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelect)

Changes the normal and selected images for the specified item.

Parameter
Type
Description

nIndex

hPicNormal

hPicSelect

Returns: SalNumber.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter
Type
Description

sValue

nLength

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter
Type
Description

nWidth

nHeight

Returns: SalBoolean.

SetStyle(nStyle)

Sets the style flags for the control.

Parameter
Type
Description

nStyle

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

SetTimer(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.

Parameter
Type
Description

nIDEvent

nElapseMilliSec

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter
Type
Description

nColorIndex

nColor

Returns: SalBoolean.

ShowOutline(nLevel)

Expands list items up to the specified level.

Parameter
Type
Description

nLevel

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(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

WindowActions

WindowActionsEventHandler

Inherited By

Name
Description

Displays directory tree in a listbox similar to Win95

Displays directory tree outline in a listbox.

Implements

Last updated