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

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

hItem

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

hPicNormal

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

hPicSelect

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

Label

Controlarrow-up-right: Returns/Sets the label associated with this control.

NamedProperties

SalNamedPropertiesarrow-up-right: Returns the collection of named properties.

nColor

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

nIndex

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

nItemFlags

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

nLevel

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

nStyle

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

nValue

SalNumberarrow-up-right: Multiple Inheritance: Wrapper property.

sText

SalStringarrow-up-right: 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: SalNumberarrow-up-right.

AddColorValue(sText, nColor, nValue)

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

Returns: SalNumberarrow-up-right.

AddFont(sText, hFont)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

AddFontValue(sText, hFont, nValue)

Adds a new item with the specified font and value.

Returns: SalNumberarrow-up-right.

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

AddPicture(sText, hPicNormal, hPicSelect)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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.

Returns: SalNumberarrow-up-right.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

Clear()

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

Returns: SalBooleanarrow-up-right.

ClearCursor(nType)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBooleanarrow-up-right.

Collapse(nIndex)

Collapses all descendant items.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

DeleteChild(nIndex)

Deletes the child item from the tree control.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

DeleteDescendents(nIndex)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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

Returns: SalBooleanarrow-up-right.

DestroyWindow()

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

Returns: SalBooleanarrow-up-right.

DisableItem(nIndex, nColor)

Disables the specified item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

DoDragDrop(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

EnableItem(nIndex, nColor)

Enables the specified item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

EnumChildren(hItem, hItems)

Enumerates child item handles for a specified item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

EnumDescendents(hItemParent, hItems)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

Expand(nIndex)

Expands an outline one level at the index specified.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

ExpandDescendents(nIndex)

Displays all descendants of an item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

FindChild(sWindowName)

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

Parameter
Type
Description

Returns: SalWindowHandlearrow-up-right.

FindItemValue(hItem, nValue)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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

Returns: SalNumberarrow-up-right.

FreeChild(hItemChild)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

FreeDescendents(hItemParent)

Frees memory for all descendants of the item specified.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

FromHandle(hWnd)

Returns the control associated with the handle.

Parameter
Type
Description

Returns: VisOutlineListBoxarrow-up-right.

GetClassName()

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

Returns: SalStringarrow-up-right.

GetColor(nIndex)

Returns the current color of the list item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetControlType()

Returns an object's type.

Returns: SalNumberarrow-up-right.

GetDataType()

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

Returns: SalNumberarrow-up-right.

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

Returns: SalWindowHandlearrow-up-right.

GetFlags(nIndex)

Returns the item's flags.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetFont(sName, nSize, nEnhancement)

Parameter
Type
Description

nEnhancement

Returns: SalBooleanarrow-up-right.

GetFont(nIndex)

Returns the current font of the list control item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemColor(hItem)

Retrieves the color associated with an outline item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetItemFlags(hItem)

Returns the items's flags.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemFont(hItem)

Retrieves the font associated with an outline item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemHandle(nIndex)

Retrieves the item handle based on an index specified.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemIndex(hItem)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetItemPicture(hItem, hPicNormal, hPicSelect)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetItemText(hItem)

Returns the text for the outline item.

Parameter
Type
Description

Returns: SalStringarrow-up-right.

GetItemValue(hItem)

Returns the value saved with the outline item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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: SalWindowHandlearrow-up-right.

GetLabelText(sText, nMaxLength)

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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

Returns: SalStringarrow-up-right.

GetLevel(hItem)

Returns the indentation level of the specified item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumberarrow-up-right.

GetListItemState(nIndex)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetListItemText(nIndex, sText)

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetListItemText(nIndex)

Returns the text of the specified item.

Parameter
Type
Description

Returns: SalStringarrow-up-right.

GetListItemTextLength(nIndex)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetListSelectedIndex()

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

Returns: SalNumberarrow-up-right.

GetListSelectedItems(nSelectedArray)

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

Parameter
Type
Description

nSelectedArray

Returns: SalBooleanarrow-up-right.

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: SalNumberarrow-up-right.

GetLocation(nX, nY)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetName(sText)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetName()

Gets the name of an object.

Returns: SalStringarrow-up-right.

GetNextChild(nTypeMask)

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

Parameter
Type
Description

Returns: SalWindowHandlearrow-up-right.

GetNextSibling(hItem)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandlearrow-up-right.

GetParent(hItem)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetPicture(nIndex, hPicNormal, hPicSelect)

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetPrevSibling(hItem)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetProperty(sName, sValue)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetProperty(sName)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalStringarrow-up-right.

GetRoot()

Returns the handle for the root node.

Returns: SalNumberarrow-up-right.

GetSize(nWidth, nHeight)

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

GetStyle()

Returns the style flags for the control.

Returns: SalNumberarrow-up-right.

GetText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter
Type
Description

Returns: SalStringarrow-up-right.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

GetWindowState()

Returns a window's current state.

Returns: SalNumberarrow-up-right.

HideWindow()

Hides a window.

Returns: SalBooleanarrow-up-right.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBooleanarrow-up-right.

InsertColor(nIndex, sText, nColor)

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

Returns: SalNumberarrow-up-right.

InsertColorValue(nIndex, sText, nColor, nValue)

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

Returns: SalNumberarrow-up-right.

InsertFont(nIndex, sText, hFont)

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

Returns: SalNumberarrow-up-right.

InsertFontValue(nIndex, sText, hFont, nValue)

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

Returns: SalNumberarrow-up-right.

InsertListItem(nIndex, sAdd)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

InsertPicture(nIndex, sText, hPicNormal, hPicSelect)

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

Returns: SalNumberarrow-up-right.

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.

Returns: SalNumberarrow-up-right.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBooleanarrow-up-right.

IsDerivedFromClass(tClass)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

IsEnabled()

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

Returns: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBooleanarrow-up-right.

KillTimer(nIDEvent)

Destroys an object's system timer.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

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

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

Returns: SalNumberarrow-up-right.

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

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

Returns: SalNumberarrow-up-right.

LoadOutline(sBlob)

Deserializes the entire outline tree from the specified string.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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

Returns: SalNumberarrow-up-right.

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

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

Returns: SalNumberarrow-up-right.

MoveDown(nIndex)

Moves the specified item down one position in the tree.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

MoveUp(nIndex)

Moves an item and its descendants up in the list.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

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

Returns: SalBooleanarrow-up-right.

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

Returns: SalNumberarrow-up-right.

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: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

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

Returns: SalBooleanarrow-up-right.

SaveOutline(sBlob)

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

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

Returns: SalNumberarrow-up-right.

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

Returns: SalBooleanarrow-up-right.

SetColor(nIndex, nColor)

Sets the color of a list item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

SetContextMenu(sMenuName, nFlags)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetContextMenu(menuType, nFlags)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

SetFlags(nIndex, nFlags, bState)

Sets the item's flags.

Returns: SalBooleanarrow-up-right.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandlearrow-up-right.

SetFont(sName, nSize, nEnhancement)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetFont(nIndex, hFont)

Sets the font of the list control item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

SetItemColor(hItem, nColor)

Sets the color of the outline item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetItemData(hItem, sText, nValue, nItemFlags)

Updates the specified item.

Returns: SalNumberarrow-up-right.

SetItemFlags(hItem, nFlags, bState)

Sets the item's flags.

Returns: SalBooleanarrow-up-right.

SetItemFont(hItem, hFont)

Sets the font of the outline item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetItemPicture(hItem, hPicNormal, hPicSelect)

Assigns new bitmaps to the specified item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetItemText(hItem, sText)

Sets the text of the outline item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetItemValue(hItem, nValue)

Sets the value associated to the outline item.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetListSelectedIndex(nIndex)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetListSelectedItems(nIndex, bSelect)

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

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetListSelectedText(nIndexStart, sText)

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

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

SetLocation(nX, nY)

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

Returns: SalBooleanarrow-up-right.

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: SalBooleanarrow-up-right.

SetOutlineRedraw(bState)

Enables or disables drawing.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetPicture(nIndex, hPicNormal, hPicSelect)

Changes the normal and selected images for the specified item.

Parameter
Type
Description

Returns: SalNumberarrow-up-right.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Returns: SalBooleanarrow-up-right.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetStyle(nStyle)

Sets the style flags for the control.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

SetText(sText)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

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

Returns: SalBooleanarrow-up-right.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

ShowOutline(nLevel)

Expands list items up to the specified level.

Parameter
Type
Description

Returns: SalBooleanarrow-up-right.

ShowWindow()

Makes a window visible.

Returns: SalBooleanarrow-up-right.

ShowWindowAndLabel()

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

Returns: SalBooleanarrow-up-right.

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

Creates pop-up menus at runtime.

Returns: SalBooleanarrow-up-right.

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

Creates pop-up menus at runtime.

Returns: SalBooleanarrow-up-right.

UpdateWindow()

Forces the update of a window.

Returns: SalBooleanarrow-up-right.

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