VisOutlineListBox

PPJ.Runtime.Vis.VisOutlineListBox

Namespace: PPJ.Runtime.Vis

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

public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl

Constructors

Default Constructor.

Properties

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

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

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

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

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

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

SalNamedProperties: Returns the collection of named properties.

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

SalNumber: Multiple Inheritance: Wrapper property.

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

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

SalString: Multiple Inheritance: Wrapper property.

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

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

ParameterTypeDescription

text

color

Returns: SalNumber.

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

ParameterTypeDescription

text

color

value

Returns: SalNumber.

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

ParameterTypeDescription

text

hFont

Returns: SalNumber.

Adds a new item with the specified font and value.

ParameterTypeDescription

text

hFont

value

Returns: SalNumber.

Adds a string to a list box or combo box.

ParameterTypeDescription

sName

Returns: SalNumber.

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

ParameterTypeDescription

text

picNormal

picSelect

Returns: SalNumber.

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

text

picNormal

picSelect

value

Returns: SalNumber.

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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.

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

Returns: SalBoolean.

Clears a window's cursor.

ParameterTypeDescription

nType

Returns: SalBoolean.

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Collapses all descendant items.

ParameterTypeDescription

index

Returns: SalBoolean.

Deletes the child item from the tree control.

ParameterTypeDescription

index

Returns: SalNumber.

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

ParameterTypeDescription

index

Returns: SalNumber.

Deletes a list box or combo box entry.

ParameterTypeDescription

nIndex

Returns: SalNumber.

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

ParameterTypeDescription

index

picNormal

picSelect

Returns: SalBoolean.

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

Returns: SalBoolean.

Disables the specified item.

ParameterTypeDescription

index

color

Returns: SalNumber.

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.

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.

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

ParameterTypeDescription

sourceIndex

target

targetIndex

dropMode

Returns: SalBoolean.

Enables the specified item.

ParameterTypeDescription

index

color

Returns: SalNumber.

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

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.

Enumerates child item handles for a specified item.

ParameterTypeDescription

hItem

hItems

Returns: SalNumber.

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

ParameterTypeDescription

hItemParent

hItems

Returns: SalNumber.

Expands an outline one level at the index specified.

ParameterTypeDescription

index

Returns: SalNumber.

Displays all descendants of an item.

ParameterTypeDescription

index

Returns: SalBoolean.

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

ParameterTypeDescription

windowName

Returns: SalWindowHandle.

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

ParameterTypeDescription

hItem

value

Returns: SalNumber.

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

formUnits

The number of form units.

vertical

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.

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

ParameterTypeDescription

hItemChild

Returns: SalBoolean.

Frees memory for all descendants of the item specified.

ParameterTypeDescription

hItemParent

Returns: SalBoolean.

Returns the control associated with the handle.

ParameterTypeDescription

handle

Returns: VisOutlineListBox.

Gets the number of children for a specified item.

ParameterTypeDescription

hItem

directChildrenOnly

Returns: SalNumber.

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

Returns: SalString.

Returns the current color of the list item.

ParameterTypeDescription

index

Returns: SalNumber.

Returns an object's type.

Returns: SalNumber.

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

Returns: SalNumber.

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

typeMask

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

Returns: SalWindowHandle.

Returns the item's flags.

ParameterTypeDescription

index

Returns: SalNumber.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

Returns the current font of the list control item.

ParameterTypeDescription

index

Returns: SalNumber.

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

ParameterTypeDescription

xPos

yPos

Returns: SalNumber.

Retrieves the color associated with an outline item.

ParameterTypeDescription

hItem

Returns: SalNumber.

ParameterTypeDescription

hItem

text

value

itemFlags

Returns: SalBoolean.

Returns the items's flags.

ParameterTypeDescription

hItem

Returns: SalNumber.

Retrieves the font associated with an outline item.

ParameterTypeDescription

hItem

Returns: SalNumber.

Retrieves the item handle based on an index specified.

ParameterTypeDescription

index

Returns: SalNumber.

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

ParameterTypeDescription

hItem

Returns: SalNumber.

ParameterTypeDescription

hItem

picNormal

picSelect

Returns: SalBoolean.

Returns the text for the outline item.

ParameterTypeDescription

hItem

Returns: SalString.

Returns the value saved with the outline item.

ParameterTypeDescription

hItem

Returns: SalNumber.

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.

ParameterTypeDescription

sText

nMaxLength

Returns: SalNumber.

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

nMaxLength

Returns: SalString.

Returns the indentation level of the specified item.

ParameterTypeDescription

hItem

Returns: SalNumber.

Returns the number of list box or combo box entries.

Returns: SalNumber.

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

ParameterTypeDescription

nIndex

Returns: SalBoolean.

ParameterTypeDescription

nIndex

sText

Returns: SalNumber.

Returns the text of the specified item.

ParameterTypeDescription

nIndex

Returns: SalString.

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

ParameterTypeDescription

nIndex

Returns: SalNumber.

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

Returns: SalNumber.

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

ParameterTypeDescription

nSelectedArray

Returns: SalBoolean.

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.

ParameterTypeDescription

x

y

Returns: SalBoolean.

ParameterTypeDescription

text

Returns: SalBoolean.

Gets the name of an object.

Returns: SalString.

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

ParameterTypeDescription

typeMask

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

Returns: SalWindowHandle.

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

ParameterTypeDescription

hItem

Returns: SalNumber.

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

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

ParameterTypeDescription

hItem

Returns: SalNumber.

ParameterTypeDescription

index

picNormal

picSelect

Returns: SalNumber.

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

ParameterTypeDescription

hItem

Returns: SalNumber.

ParameterTypeDescription

name

value

Returns: SalBoolean.

Gets the value of a named property.

ParameterTypeDescription

name

Returns: SalString.

Returns the handle for the root node.

Returns: SalNumber.

ParameterTypeDescription

width

height

Returns: SalBoolean.

Returns the style flags for the control.

Returns: SalNumber.

ParameterTypeDescription

sText

nMaxLen

Returns: SalNumber.

Retrieves the text of a window.

ParameterTypeDescription

nMaxLen

Returns: SalString.

ParameterTypeDescription

index

top

left

bottom

right

Returns: SalBoolean.

Gets a window's color.

ParameterTypeDescription

colorIndex

Returns: SalNumber.

Returns a window's current state.

Returns: SalNumber.

Hides a window.

Returns: SalBoolean.

Hides a window and its associated label.

Returns: SalBoolean.

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

ParameterTypeDescription

index

text

color

Returns: SalNumber.

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

index

text

color

value

Returns: SalNumber.

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

ParameterTypeDescription

index

text

hFont

Returns: SalNumber.

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

ParameterTypeDescription

index

text

hFont

value

Returns: SalNumber.

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

ParameterTypeDescription

nIndex

sAdd

Returns: SalNumber.

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

ParameterTypeDescription

index

text

picNormal

picSelect

Returns: SalNumber.

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

index

text

picNormal

picSelect

value

Returns: SalNumber.

Causes a window to be repainted.

Returns: SalBoolean.

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

ParameterTypeDescription

typeClass

Returns: SalBoolean.

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

Returns: SalBoolean.

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.

Determines whether a window is currently visible.

Returns: SalBoolean.

Destroys an object's system timer.

ParameterTypeDescription

idEvent

Returns: SalBoolean.

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

ParameterTypeDescription

hItemParent

picNormal

picSelect

text

value

itemFlags

Returns: SalNumber.

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

ParameterTypeDescription

hItemParent

picNormal

picSelect

text

values

itemFlags

Returns: SalNumber.

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

ParameterTypeDescription

hItemParent

picNormal

picSelect

text

values

itemFlags

Returns: SalNumber.

Deserializes the entire outline tree from the specified string.

ParameterTypeDescription

blob

Returns: SalNumber.

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

ParameterTypeDescription

fileName

picParentNormal

picParentSelect

picChildNormal

picChildSelect

Returns: SalNumber.

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

ParameterTypeDescription

hItemBefore

picNormal

picSelect

text

value

itemFlags

Returns: SalNumber.

Moves the specified item down one position in the tree.

ParameterTypeDescription

index

Returns: SalBoolean.

Moves an item and its descendants up in the list.

ParameterTypeDescription

index

Returns: SalBoolean.

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

ParameterTypeDescription

nXOffset

nYOffset

Returns: SalBoolean.

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

nNumPixels

bVertical

Returns: SalNumber.

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

hSql

sSelect

Returns: SalBoolean.

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

hSql

sSelect

errorHandler

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

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

ParameterTypeDescription

index

picNormal

picSelect

Returns: SalBoolean.

ParameterTypeDescription

blob

Returns: SalNumber.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

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

ParameterTypeDescription

nMsg

nMywParam

nMylParam

Returns: SalBoolean.

Sets the color of a list item.

ParameterTypeDescription

index

color

Returns: SalNumber.

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

ParameterTypeDescription

menuName

flags

Returns: SalBoolean.

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

ParameterTypeDescription

menuType

flags

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resource

type

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resourceId

type

Returns: SalBoolean.

Sets a window's cursor from a string variable.

ParameterTypeDescription

blob

type

Returns: SalBoolean.

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

ParameterTypeDescription

file

type

Returns: SalBoolean.

Sets the item's flags.

ParameterTypeDescription

index

flags

state

Returns: SalBoolean.

Sets the focus to a specified window.

Returns: SalWindowHandle.

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

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

Sets the font of the list control item.

ParameterTypeDescription

index

hFont

Returns: SalNumber.

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

ParameterTypeDescription

width

Returns: SalBoolean.

Sets the color of the outline item.

ParameterTypeDescription

hItem

color

Returns: SalBoolean.

Updates the specified item.

ParameterTypeDescription

hItem

text

value

itemFlags

Returns: SalNumber.

Sets the item's flags.

ParameterTypeDescription

hItem

flags

state

Returns: SalBoolean.

Sets the font of the outline item.

ParameterTypeDescription

hItem

hFont

Returns: SalBoolean.

Assigns new bitmaps to the specified item.

ParameterTypeDescription

hItem

picNormal

picSelect

Returns: SalBoolean.

Sets the text of the outline item.

ParameterTypeDescription

hItem

text

Returns: SalBoolean.

Sets the value associated to the outline item.

ParameterTypeDescription

hItem

value

Returns: SalBoolean.

Sets the text of the associated label control.

ParameterTypeDescription

sText

Returns: SalBoolean.

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

ParameterTypeDescription

bRedraw

Returns: SalBoolean.

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

ParameterTypeDescription

nIndex

Returns: SalBoolean.

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

ParameterTypeDescription

nIndex

bSelect

Returns: SalBoolean.

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

ParameterTypeDescription

nIndexStart

sText

Returns: SalNumber.

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

ParameterTypeDescription

x

y

Returns: SalBoolean.

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

ParameterTypeDescription

bSet

Returns: SalBoolean.

Enables or disables drawing.

ParameterTypeDescription

state

Returns: SalBoolean.

Changes the normal and selected images for the specified item.

ParameterTypeDescription

index

picNormal

picSelect

Returns: SalNumber.

Sets the value of a named property.

ParameterTypeDescription

name

value

length

Returns: SalBoolean.

Selects/Deselects the specified node.

ParameterTypeDescription

node

selected

Resizes a window.

ParameterTypeDescription

width

height

Returns: SalBoolean.

Sets the style flags for the control.

ParameterTypeDescription

style

Returns: SalBoolean.

Sets the text of a window.

ParameterTypeDescription

text

Returns: SalBoolean.

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

idEvent

elapseMilliSec

Returns: SalBoolean.

Sets a window's color.

ParameterTypeDescription

nColorIndex

nColor

Returns: SalBoolean.

Expands list items up to the specified level.

ParameterTypeDescription

level

Returns: SalBoolean.

Makes a window visible.

Returns: SalBoolean.

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

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuName

flags

x

y

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuType

nFlags

nX

nY

Returns: SalBoolean.

Forces the update of a window.

Returns: SalBoolean.

Starts the Windows help system.

ParameterTypeDescription

file

command

numData

strData

Returns: SalBoolean.

Processes messages for this control.

Events

SalMessageHandler Message Actions

WindowActionsEventHandler Window Actions

Inherited By

NameDescription

Displays directory tree in a list box similar to Win95

Displays directory tree outline in a list box.

Implements

Last updated