The VisOutlineListBox type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | VisOutlineListBox |
Default Constructor.
|
Methods
| Name | Description | |
|---|---|---|
| AddColor |
Adds an item to the list and displays it in the specified color.
|
| AddColorValue |
Adds an item to the list, displays it in the specified color and associates the specified value with the item.
|
| AddFont |
Adds an item to the list control and displays it in the specified font.
|
| AddFontValue |
Adds a new item with the speicifed font and value.
|
| AddListItem |
Adds a string to a list box or combo box.
|
| AddPicture |
Adds an item to the list control and specified an image for the
normal and selected state.
|
| AddPictureValue |
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.
|
| BringWindowToTop |
Brings a window to the top of all overlapping windows.
|
| 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.
|
| Clear |
Clears the value from a data field, multiline field, or table window column.
|
| ClearCursor |
Clears a window's cursor.
|
| ClearList |
Deletes all entries from a list box or combo box.
|
| Collapse |
Collapses all descendent items.
|
| DeleteChild |
Deletes the child item from the tree control.
|
| DeleteDescendents |
Deletes all descendants (children, grandchildren, and so on) of the specified child.
|
| DeleteListItem |
Deletes a list box or combo box entry.
|
| Demote |
Moves an item and all descendants right in the outline by making the
item become the last child of the previous sibling.
|
| DestroyWindow |
Destroys a form window, a top-level table window, or a modeless dialog box created
with SalCreateWindow.
|
| DisableItem |
Disables the specified item.
|
| 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.
|
| 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.
|
| DoDragDrop |
Moves the source item to the new location, providing support for dragging tree items.
|
| DragDrop | Obsolete. |
| EnableItem |
Enables the specified item.
|
| EnableWindow |
Enables keyboard and mouse input to a window.
|
| 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.
|
| EnumChildren |
Enumerates child item handles for a specified item.
|
| EnumDescendents |
Enumerates descendent (children, grandchildren, and so on) item handles for a specified item.
|
| Expand |
Expands an outline one level at the index specified.
|
| ExpandDescendents |
Displays all descendants of an item.
|
| FindChild |
This function finds a child window of a given name in the specified window.
|
| FindItemValue |
Finds the item with the specified value in the descendants of
the specified node.
|
| FormUnitsToPixels |
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.
|
| FreeChild |
Frees memory for the item specified and for all its descendants.
|
| FreeDescendents |
Frees memory for all descendants of the item specified.
|
 | FromHandle |
Returns the control associated with the handle.
|
| GetClassName |
Return the name of a window's class as a string.
|
| GetColor |
Returns the current color of the list item.
|
| GetControlType |
Returns an object's type.
|
| GetDataType |
Returns a data field's or table window column's data type.
|
| GetFirstChild |
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.
|
| GetFlags |
Returns the item's flags.
|
| GetFont(SalNumber) |
Returns the current font of the list control item.
|
| GetFont(SalString%, SalNumber%, SalNumber%) |
Gets a window's font name, size, and enhancements.
|
| GetIndexFromPoint |
Returns the index of the item at the indicated screen coordinates.
|
| GetItemColor |
Retrieves the color associated with an outline item.
|
| GetItemData |
Returns information about the specified item.
|
| GetItemFlags |
Returns the items's flags.
|
| GetItemFont |
Retrieves the font associated with an outline item.
|
| GetItemHandle |
Retrieves the item handle based on an index specified.
|
| GetItemIndex |
Retrieves the index associated with an outline item based on an item handle.
|
| GetItemPicture |
Returns the pictures for the outline item.
|
| GetItemText |
Returns the text for the outline item.
|
| GetItemValue |
Returns the value saved with the outline item.
|
| 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.
|
| GetLabelText(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.
|
| GetLabelText(SalString%, 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.
|
| GetLevel |
Returns the indentation level of the specified item.
|
| GetListItemsCount |
Returns the number of list box or combo box entries.
|
| GetListItemState |
Determines whether the specified list box or combo box entry is selected.
|
| GetListItemText(SalNumber) |
Returns the text of the specified item.
|
| GetListItemText(SalNumber, SalString%) |
Returns the text of the specified item.
|
| GetListItemTextLength |
Returns the length of a list box or combo box entry.
|
| GetListSelectedIndex |
Returns the index of the selected entry in a combo box or single-selection list box.
|
| GetListSelectedItems |
Returns an array of index numbers of selected list box entries.
|
| GetListSelectedItemsCount |
Returns the number of selected entries in a multiple-selection list box. Specify
single- or multiple-selection in the list box's customizer.
|
| GetLocation |
Returns a window's current position on the X and Y axes.
|
| GetName()()()() |
Gets the name of an object.
|
| GetName(SalString%) |
Gets the name of an object.
|
| GetNextChild |
Returns the handle of the next child window that matches a specified type.
|
| GetNextSibling |
Retrieves the item handle for the next sibling of the specified item.
|
| GetParent()()()() |
Returns the handle of an object's parent window.
|
| GetParent(SalNumber) |
Retrieves the item handle for the parent of the specified item.
|
| GetPicture |
Returns the pictures associated with the item.
|
| GetPrevSibling |
Retrieves the item handle for the previous sibling of the specified item.
|
| GetProperty(SalString) |
Gets the value of a named property.
|
| GetProperty(SalString, SalString%) |
Gets the value of a named property.
|
| GetRoot |
Returns the handle for the root node.
|
| GetSize |
Returns a window's size.
|
| GetStyle |
Returns the style flags for the control.
|
| GetText(SalNumber) |
Retrieves the text of a window.
|
| GetText(SalString%, SalNumber) |
Retrieves the text of a window.
|
| GetTextRectangle |
Returns the rectangle for the specified tree node.
|
| GetWindowColor |
Gets a window's color.
|
| GetWindowState |
Returns a window's current state.
|
| HideWindow |
Hides a window.
|
| HideWindowAndLabel |
Hides a window and its associated label.
|
| InsertColor |
Inserts an item to the list control at the specified position and displays it in the specified color.
|
| InsertColorValue |
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.
|
| InsertFont |
Adds an item to a list control at the specified index and displays it in the specified font.
|
| InsertFontValue |
Adds an item to the list control, displays it in the specified font, and
associates the specified value with the item.
|
| InsertListItem |
Inserts an entry into a list box or combo box at a specified position.
|
| InsertPicture |
Inserts an item at the specified postion and specifies an image for
the normal and selected state.
|
| InsertPictureValue |
Inserts an item at the specified postion and specifies an image for
the normal and selected state, and associates a value to the item.
|
| InvalidateWindow |
Causes a window to be repainted.
|
| IsDerivedFromClass |
Determines whether a window is an instance of the specified class.
|
| IsEnabled |
Determines whether a window is enabled for mouse and keyboard input.
|
| 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.
|
| IsVisible |
Determines whether a window is currently visible.
|
| KillTimer |
Destroys an object's system timer.
|
| LoadChild |
Inserts an item as the last child of the specified parent.
|
| LoadChildren |
Inserts multiple items as the last children of the specified parent item.
|
| LoadOutline |
Deserializes the entire outline tree from the specified string.
|
| LoadOutlineFile |
Loads the serialized outline structure from the file and creates the new items
as children of the specified node.
|
| LoadSibling |
Loads a new tree node as a sibling of the specified item.
|
| MoveDown |
Moves the specified item down one position in the tree.
|
| MoveUp |
Moves an item and its descendants up in the list.
|
| MoveWindow |
Moves a window a given number of form units on the X and Y axes relative to its current
position.
|
 | OnAfterSelect | (Overrides TreeView..::..OnAfterSelect(TreeViewEventArgs).) |
| OnBeforeSelect | (Overrides TreeView..::..OnBeforeSelect(TreeViewCancelEventArgs).) |
| OnDragDrop | (Overrides Control..::..OnDragDrop(DragEventArgs).) |
| OnDragLeave | (Overrides Control..::..OnDragLeave(EventArgs).) |
| OnItemDrag | (Overrides TreeView..::..OnItemDrag(ItemDragEventArgs).) |
| OnKeyDown | (Overrides TreeView..::..OnKeyDown(KeyEventArgs).) |
| OnKeyUp | (Overrides TreeView..::..OnKeyUp(KeyEventArgs).) |
| OnMouseUp | (Overrides Control..::..OnMouseUp(MouseEventArgs).) |
| PixelsToFormUnits |
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.
|
| PopulateList(SalSqlHandle, SalString) |
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.
|
| PopulateList(SalSqlHandle, SalString, WhenSqlErrorHandler) |
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.
|
| PostMessage |
Posts the specified message to a window by adding nMsg to hWndReceiver's message
queue.
|
| Promote |
Moves an item and its descendants left in the outline by making it
the last sibling of the parent item.
|
| SaveOutline |
Serializes the entire outline tree into the specified string.
|
| SendMessage |
Sends the specified message to a window. SalSendMsg does not return until the processing
for the message is complete.
|
| SendMessageToChildren |
Sends a message to all child items of a form window, dialog box, table window, or
MDI window.
|
| SetColor |
Sets the color of a list item.
|
| SetContextMenu(Type, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| SetContextMenu(SalString, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| SetCursor(Int32, SalNumber) |
Sets a window's cursor.
|
| SetCursor(SalResourceCursor, SalNumber) |
Sets a window's cursor.
|
| SetCursor(SalString, SalNumber) |
Sets a window's cursor from a string variable.
|
| SetCursorFile |
Sets an application-defined cursor for the specified window. Use this function to
set the cursor from an image stored in a file.
|
| SetFlags |
Sets the item's flags.
|
| SetFocus |
Sets the focus to a specified window.
|
| SetFont(SalNumber, SalNumber) |
Sets the font of the list control item.
|
| SetFont(SalString, SalNumber, SalNumber) |
Sets a window's font, font size, and font enhancements.
|
| SetIndent |
Gets or sets the distance to indent each of the child tree node levels.
|
| SetItemColor |
Sets the color of the outline item.
|
| SetItemData |
Updates the specified item.
|
| SetItemFlags |
Sets the item's flags.
|
| SetItemFont |
Sets the font of the outline item.
|
| SetItemPicture |
Assigns new bitmaps to the specified item.
|
| SetItemText |
Sets the text of the outline item.
|
| SetItemValue |
Sets the value associated to the outline item.
|
| SetLabelText |
Sets the text of the associaetd label control.
|
| SetListRedraw |
Redraws entries in a list box or combo box, or prevents them from being redrawn.
|
| SetListSelectedIndex |
Selects or deselects a combo box or single-selection list box entry.
|
| SetListSelectedItems |
Selects or deselects a combo box or multiple-selection list box entry.
|
| SetListSelectedText |
Finds and selects a combo box or single-selection list box entry.
|
| SetLocation |
Moves a window to a new position (x, y) on the X and Y axes.
|
| SetModified |
Sets or clears the field edit flag for an editable data field, combo box, multiline
text field, table window column, or picture.
|
| SetOutlineRedraw |
Enables or disables drawing.
|
| SetPicture |
Changes the normal and selected images for the specified item.
|
| SetProperty |
Sets the value of a named property.
|
| SetSelected |
Selects/Deselects the specified node.
|
| SetSize |
Resizes a window.
|
| SetStyle |
Sets the style flags for the control.
|
| SetText |
Sets the text of a window.
|
| SetTimer |
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.
|
| SetWindowColor |
Sets a window's color.
|
| SetVisibleCore | (Overrides Control..::..SetVisibleCore(Boolean).) |
| ShowOutline |
Expands list items up to the specified level.
|
| ShowWindow |
Makes a window visible.
|
| ShowWindowAndLabel |
Makes a window and its associated label visible. A label is the label control that
immediately precedes the window in the outline.
|
| TrackPopupMenu(Type, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| TrackPopupMenu(SalString, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| UpdateWindow |
Forces the update of a window.
|
| WinHelp |
Starts the Windows help system.
|
| WndProc |
Redirect Windows message to the implementation object.
(Overrides TreeView..::..WndProc(Message%).) |
| Yield |
Processes messages for this control.
|
Operators
| Name | Description | |
|---|---|---|
 | ExplicitNarrowingExplicitExplicitExplicit(SalWindowHandle to VisOutlineListBox) |
Fully qualified expressions operator.
|
| ImplicitWideningImplicitImplicitImplicit(VisOutlineListBox to VisListBoxExtension) |
Multiple Inheritance: Overloaded casting operator.
|
Fields
| Name | Description | |
|---|---|---|
 | _derived |
Instance of the derived object that inherits this class
as a second base in a multiple inheritance tree.
|
| hWndSource | |
| hWndTarget | |
| nFlags | |
| nIdx | |
| nIndexSource | |
| nIndexTarget | |
| nXPos | |
| nYPos |
Properties
| Name | Description | |
|---|---|---|
 | CreateParams |
Modifies the CreateParams to implement the TVS_NOHSCROLL style.
(Overrides TreeView..::..CreateParams.) |
 | DesigntimeVisible |
Returns true if the object was designed as visible.
|
| hFont |
Multiple Inheritance: Wrapper property.
|
| hItem |
Multiple Inheritance: Wrapper property.
|
| HorizontalScrollbar |
Shows/Hides the horizontal scrollbar.
Supported starting from Common Controls v. 5.80
|
| hPicNormal |
Multiple Inheritance: Wrapper property.
|
| hPicSelect |
Multiple Inheritance: Wrapper property.
|
| Label |
Returns/Sets the label associated with this control.
|
| NamedProperties |
Returns the collection of named properties.
|
| nColor |
Multiple Inheritance: Wrapper property.
|
| nIndex |
Multiple Inheritance: Wrapper property.
|
| nItemFlags |
Multiple Inheritance: Wrapper property.
|
| nLevel |
Multiple Inheritance: Wrapper property.
|
| nStyle |
Multiple Inheritance: Wrapper property.
|
| nValue |
Multiple Inheritance: Wrapper property.
|
| SelectedNodes |
Returns the collection of all selected nodes.
|
| SelectionMode |
Returns/Sets the selection mode.
|
| sText |
Multiple Inheritance: Wrapper property.
|
Events
| Name | Description | |
|---|---|---|
 | MessageActions |
