VisOutlineListBox

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Web.Vis.50 (5.0.0.0)

• Control
  • TreeView
    • VisOutlineListBox

A SAL outline tree with Visual Toolchest node handles, item styling, and drag-and-drop behavior.

C#

public class VisOutlineListBox : TreeView, ISalWindow, ISalControl, ISalListControl

VB.NET

Public Class VisOutlineListBox
    Inherits TreeView
    Implements ISalWindow, ISalControl, ISalListControl

Outline methods distinguish node handles from visible-list indices.

Example:

var tree = new VisOutlineListBox();
            SalNumber group = tree.LoadChild(tree.GetRoot(), 0, 0, "Group", 0, 0);
            tree.LoadChild(group, 0, 0, "Item", 1, 0);
            tree.ShowOutline(2);

Constructors

VisOutlineListBox()

Initializes SAL window and list-extension state, disables sorting, and attaches outline message handlers.

Properties

hFont

SalNumber:

Reads or updates the value held by this control's list extension.

hItem

SalNumber:

Reads or updates the value held by this control's list extension.

hPicNormal

SalNumber:

Reads or updates the value held by this control's list extension.

hPicSelect

SalNumber:

Reads or updates the value held by this control's list extension.

Label

Control: Gets or sets the label associated with this control through its containing SAL form.

NamedProperties

SalNamedProperties: Gets this window's SAL named-property collection.

nColor

SalNumber:

Reads or updates the value held by this control's list extension.

nIndex

SalNumber:

Reads or updates the value held by this control's list extension.

nItemFlags

SalNumber:

Reads or updates the value held by this control's list extension.

nLevel

SalNumber:

Reads or updates the value held by this control's list extension.

nStyle

SalNumber:

Reads or updates the value held by this control's list extension.

nValue

SalNumber:

Reads or updates the value held by this control's list extension.

sText

SalString:

Reads or updates the value held by this control's list extension.

Methods

AddColor(sText, nColor)

Parameter	Type	Description
sText	SalString
nColor	SalNumber

Returns: SalNumber.

AddColorValue(sText, nColor, nValue)

Parameter	Type	Description
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddFont(sText, hFont)

Parameter	Type	Description
sText	SalString
hFont	SalNumber

Returns: SalNumber.

AddFontValue(sText, hFont, nValue)

Parameter	Type	Description
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

AddListItem(sName)

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

AddPicture(sText, hPicNormal, hPicSelect)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalNumber.

AddPictureValue(sText, hPicNormal, hPicSelect, nValue)

Parameter	Type	Description
sText	SalString
hPicNormal	SalNumber
hPicSelect	SalNumber
nValue	SalNumber

Returns: SalNumber.

BringWindowToTop()

Brings this control to the front, or activates it when it is a top-level or MDI form.

Returns: SalBoolean. True if the translated control exists and is not disposed; otherwise, false.

CenterWindow()

Centers this window within its parent, owner, or available screen area.

Returns: SalBoolean. True if the centering operation is accepted; false for an unavailable control, design mode, or unavailable screen bounds.

Clear()

Clears editable text or selection according to the control type.

Returns: SalBoolean. False for an unavailable control or a form; otherwise, true.

Text fields and labels are emptied; check boxes are unchecked; list selections are cleared. Other control types are left unchanged.

ClearCursor(nType)

Restores the default cursor for the requested role.

Parameter	Type	Description
nType	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.

ClearList()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

Collapse(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

DeleteChild(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DeleteDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DeleteListItem(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Applies the referenced SAL operation to this control.

Demote(nIndex, hPicNormal, hPicSelect)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalBoolean.

DestroyWindow()

Closes this window when it is a form, or disposes the control.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

A true result reports that the close or disposal request was made; a form can apply its own closing behavior.

DisableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

DisableWindow()

Disables input to this control, or clears editability for a table column.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

DisableWindowAndLabel()

Disables input to this control and disables its associated label.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

Dispose(disposing)

Marks this SAL window disposed before releasing the base control resources.

Parameter	Type	Description
disposing	Boolean	True to release managed resources; false for finalization cleanup.

DoDragDrop(nSourceIndex, hWndTarget, nTargetIndex, nDropMode)

Moves an outline node to another outline position.

Parameter	Type	Description
nSourceIndex	SalNumber	The source visible-item index; -1 denotes the root.
hWndTarget	SalWindowHandle	The target outline-list control handle.
nTargetIndex	SalNumber	The target visible-item index; -1 denotes the root.
nDropMode	SalNumber	DROP_Child to append beneath the target, or DROP_Sibling to insert after it.

Returns: SalBoolean. True when the node is moved; false for an unsupported target, invalid nodes, a self/descendant drop, or an unsupported mode.

The delegated operation requires an outline-tree source. Ordinary list and combo items cannot be moved by this tree operation.

EnableItem(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

EnableWindow()

Enables input to this control, or enables editing for a table column.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

For text-box controls, this operation also clears the read-only setting.

EnableWindowAndLabel()

Enables input to this control and enables its associated label.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

EnumChildren(hItem, hItems)

Parameter	Type	Description
hItem	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

EnumDescendents(hItemParent, hItems)

Parameter	Type	Description
hItemParent	SalNumber
hItems	SalArray<SalNumber>

Returns: SalNumber.

Expand(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

ExpandDescendents(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

FindChild(sWindowName)

Searches this window for a child control by name.

Parameter	Type	Description
sWindowName	SalString	The child control name to locate.

Returns: SalWindowHandle. The matching child handle, or a null SAL handle if no child is found.

FindItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalNumber.

FormUnitsToPixels(nFormUnits, bVertical)

Converts a length in form units to pixels using this control's form metrics.

Parameter	Type	Description
nFormUnits	SalNumber	The length in form units.
bVertical	SalBoolean	True for a vertical measurement; false for a horizontal measurement.

Returns: SalNumber. The converted pixel length.

FreeChild(hItemChild)

Parameter	Type	Description
hItemChild	SalNumber

Returns: SalBoolean.

FreeDescendents(hItemParent)

Parameter	Type	Description
hItemParent	SalNumber

Returns: SalBoolean.

FromHandle(hWnd)

Resolves a SAL handle to an existing VisOutlineListBox.

Parameter	Type	Description
hWnd	SalWindowHandle	The control handle to resolve.

Returns: VisOutlineListBox. The associated control, or when no control is resolved.

Throws:

• InvalidCastException The handle identifies an incompatible control type.

GetClassName()

Gets the application class name associated with this control.

Returns: SalString. The application class name, an empty string for runtime-defined classes, or a SAL null string when the control cannot be resolved.

Forms are represented by their base type; nested table-window types are resolved to their non-nested base.

GetColor(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetControlType()

Gets the SAL window type of this control.

Returns: SalNumber. The SAL Sys.TYPE_* code for the translated control.

GetDataType()

Gets the SAL data type represented by this control.

Returns: SalNumber. The SAL data-type code, or zero if the translated control does not implement the SAL value contract.

GetFirstChild(nTypeMask)

Finds the first child matching a SAL window-type mask.

Parameter	Type	Description
nTypeMask	SalNumber	The SAL window types to include; zero matches no controls.

Returns: SalWindowHandle. The first matching child handle, or a null SAL handle when none matches.

Ordinary controls use tab order; table columns use their creation order, and MDI forms use their child-form collection.

GetFlags(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFont(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetFont(sName, nSize, nEnhancement)

Reads the control font's family, point size, and style flags.

Parameter	Type	Description
sName	SalString	Receives the font family name.
nSize	SalNumber	Receives the size in points.
nEnhancement	SalNumber	Receives the combined Sys.FONT_Enh* style flags.

Returns: SalBoolean. True if a font was available; otherwise, false.

GetItemColor(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemData(hItem, sText, nValue, nItemFlags)

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalBoolean.

GetItemFlags(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemFont(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemHandle(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetItemIndex(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetItemPicture(hItem, hPicNormal, hPicSelect)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalBoolean.

GetItemText(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalString.

GetItemValue(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetLabel()

Gets the label associated with this control.

Returns: SalWindowHandle. The associated label handle, or a null SAL handle if no label can be found.

GetLabelText(sText, nMaxLength)

Copies the associated label text to a supplied variable.

Parameter	Type	Description
sText	SalString	Receives the label text when it can be read.
nMaxLength	SalNumber	The maximum number of leading characters to copy.

Returns: SalNumber. The number of characters copied, or zero if no label text is available.

GetLabelText(nMaxLength)

Gets this control's associated label text.

Parameter	Type	Description
nMaxLength	SalNumber	The maximum number of leading characters to return.

Returns: SalString. The label text limited to the requested length, or an empty string if no label exists.

GetLevel(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetListItemsCount()

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetListItemState(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

GetListItemText(nIndex, sText)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetListItemText(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalString.

Applies the referenced SAL operation to this control.

GetListItemTextLength(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetListSelectedIndex()

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetListSelectedItems(nSelectedArray)

Parameter	Type	Description
nSelectedArray	SalArray<SalNumber>

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

GetListSelectedItemsCount()

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetLocation(nX, nY)

Reads this control's location in form units.

Parameter	Type	Description
nX	SalNumber	Receives the horizontal location.
nY	SalNumber	Receives the vertical location.

Returns: SalBoolean. Always true; an unresolved control produces zero coordinates.

GetName(sText)

Copies this control's name to the supplied variable.

Parameter	Type	Description
sText	SalString	Receives the control name when the operation succeeds.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

GetName()

Gets this control's name.

Returns: SalString. The control name, or an empty string if the control cannot be resolved.

GetNextChild(nTypeMask)

Finds the next sibling matching a SAL window-type mask.

Parameter	Type	Description
nTypeMask	SalNumber	The SAL window types to include; zero matches no controls.

Returns: SalWindowHandle. The next matching control handle, or a null SAL handle when none matches.

GetNextSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetParent()

Gets the SAL parent form, owner, or table container for this control.

Returns: SalWindowHandle. The parent window handle, or a null SAL handle if no parent can be resolved.

GetPicture(nIndex, hPicNormal, hPicSelect)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalNumber.

GetPrevSibling(hItem)

Parameter	Type	Description
hItem	SalNumber

Returns: SalNumber.

GetProperty(sName, sValue)

Reads a SAL named property into a supplied variable.

Parameter	Type	Description
sName	SalString	The property name.
sValue	SalString	Receives the value only when the property is found.

Returns: SalBoolean. True if a non-null property value was found; otherwise, false.

GetProperty(sName)

Gets the value of a SAL named property.

Parameter	Type	Description
sName	SalString	The property name.

Returns: SalString. The property value, or a SAL null string if the value is unavailable.

GetRoot()

Returns: SalNumber.

GetSize(nWidth, nHeight)

Reads this control's size in form units.

Parameter	Type	Description
nWidth	SalNumber	Receives the width.
nHeight	SalNumber	Receives the height.

Returns: SalBoolean. Always true; an unresolved control produces a zero size.

GetStyle()

Returns: SalNumber.

GetText(sText, nMaxLen)

Copies this control's displayed text or long-string value to a SAL string.

Parameter	Type	Description
sText	SalString	Receives the retrieved text.
nMaxLen	SalNumber	The maximum character count for ordinary text; ignored for a Sys.DT_LongString value.

Returns: SalNumber. The number of characters copied, or zero when no text is available.

GetText(nMaxLen)

Gets this control's displayed text or long-string value.

Parameter	Type	Description
nMaxLen	SalNumber	The maximum character count for ordinary text; ignored for a Sys.DT_LongString value.

Returns: SalString. The retrieved text, or an empty string if the control cannot be resolved.

GetWindowColor(nColorIndex)

Reads a window or cell color as a Win32 color value.

Parameter	Type	Description
nColorIndex	SalNumber	The Sys.COLOR_Index* color component to read.

Returns: SalNumber. The color encoded as a Win32 color value, or zero if the control is unavailable.

GetWindowState()

Gets the visibility and form-state classification of this window.

Returns: SalNumber. A Sys.Window_* state code; visible non-form controls report Sys.Window_Normal.

HideWindow()

Hides this control or table column.

Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.

HideWindowAndLabel()

Hides this control and its associated label.

Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.

InsertColor(nIndex, sText, nColor)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber

Returns: SalNumber.

InsertColorValue(nIndex, sText, nColor, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
nColor	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertFont(nIndex, sText, hFont)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber

Returns: SalNumber.

InsertFontValue(nIndex, sText, hFont, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hFont	SalNumber
nValue	SalNumber

Returns: SalNumber.

InsertListItem(nIndex, sAdd)

Parameter	Type	Description
nIndex	SalNumber
sAdd	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

InsertPicture(nIndex, sText, hPicNormal, hPicSelect)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalNumber.

InsertPictureValue(nIndex, sText, hPicNormal, hPicSelect, nValue)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString
hPicNormal	SalNumber
hPicSelect	SalNumber
nValue	SalNumber

Returns: SalNumber.

InvalidateWindow()

Invalidates this control and its child controls for repainting.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

IsDerivedFromClass(tClass)

Tests this control's runtime type against an application base type.

Parameter	Type	Description
tClass	Type	The type to test, including the framework's emulated inheritance relationships.

Returns: SalBoolean. True if the runtime type derives from the requested type; otherwise, false.

IsEnabled()

Determines whether this control accepts input.

Returns: SalBoolean. The enabled state, or the editable flag for a table column; false if the control cannot be resolved.

IsModified()

Reads this control's SAL modification flag.

Returns: SalBoolean. True if the control reports a modified value; otherwise, false.

IsVisible()

Determines whether this control is visible.

Returns: SalBoolean. The visible state, or the visibility flag for a table column; false if the control cannot be resolved.

KillTimer(nIDEvent)

Stops an existing timer owned by this control.

Parameter	Type	Description
nIDEvent	SalNumber	The identifier used when the timer was started.

Returns: SalBoolean. True if the timer was found and stopped; otherwise, false.

The timer remains registered and can be restarted by SetTimer.

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

Parameter	Type	Description
hItemParent	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

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

Parameter	Type	Description
hItemParent	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber
sTexts	SalArray<SalString>
nValues	SalArray<SalNumber>
nItemFlags	SalArray<SalNumber>

Returns: SalNumber.

LoadOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

LoadOutlineFile(sFileName, hPicParentNormal, hPicParentSelect, hPicChildNormal, hPicChildSelect)

Parameter	Type	Description
sFileName	SalString
hPicParentNormal	SalNumber
hPicParentSelect	SalNumber
hPicChildNormal	SalNumber
hPicChildSelect	SalNumber

Returns: SalNumber.

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

Parameter	Type	Description
hItemBefore	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

MoveDown(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

MoveUp(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

Moves this control by an offset expressed in form units.

Parameter	Type	Description
nXOffset	SalNumber	The horizontal offset to add to the current position.
nYOffset	SalNumber	The vertical offset to add to the current position.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

OnAfterSelect(e)

Marks the outline modified and sends click notifications for keyboard or mouse selection.

Parameter	Type	Description
e	TreeViewEventArgs	The selected node and selection action.

Raises the inherited event first; sends SAM_Click and VTM_Click for user selection actions.

OnBeforeSelect(e)

Cancels selection of a disabled Visual Toolchest item or an item in a tree with SelectionMode.None.

Parameter	Type	Description
e	TreeViewCancelEventArgs	The cancellable selection event, passed to the inherited handler afterwards.

OnDragDrop(e)

Exposes source and target drop context while invoking SAL and inherited drop handlers.

Parameter	Type	Description
e	DragEventArgs	The dropped data and target information.

Clears both window-handle fields in a finally block; retains the computed item indices.

OnDragEnd(e)

Ends SAL drag handling before raising the inherited drag-end event.

Parameter	Type	Description
e	EventArgs	The event data passed to both handlers.

OnDragEnter(e)

Processes the SAL drag-enter notification before raising the inherited event.

Parameter	Type	Description
e	DragEventArgs	The event data passed to both handlers.

OnDragLeave(e)

Processes the SAL drag-leave notification before raising the inherited event.

Parameter	Type	Description
e	EventArgs	The event data passed to both handlers.

OnDragOver(e)

Processes SAL drag feedback before raising the inherited drag-over event.

Parameter	Type	Description
e	DragEventArgs	The event data passed to both handlers.

OnGotFocus(e)

Dispatches SAL focus-gained processing before raising the inherited focus event.

Parameter	Type	Description
e	EventArgs	The focus event data.

OnItemDrag(e)

Asks SAL handlers whether an automatic drag may start, after raising the inherited event.

Parameter	Type	Description
e	ItemDragEventArgs	The item being dragged.

Starts dragging only when SAM_DragCanAutoStart is handled with a nonzero return; records the source index and flags.

OnLostFocus(e)

Dispatches SAL focus-lost processing before raising the inherited focus event.

Parameter	Type	Description
e	EventArgs	The focus event data.

OnNodeMouseClick(e)

Raises the inherited event and sends SAL click messages when the clicked node is selected.

Parameter	Type	Description
e	TreeNodeMouseClickEventArgs	The node click event.

Sends both SAM_Click and VTM_Click.

OnNodeMouseDoubleClick(e)

Raises the inherited event and sends SAM_DoubleClick.

Parameter	Type	Description
e	TreeNodeMouseClickEventArgs	The node double-click event.

OnWebEvent(e)

Processes outline expand/collapse requests in a SAL context, then simulates WinSDK events.

Parameter	Type	Description
e	WisejEventArgs	The browser event.

Other events are passed to the inherited handler within the same context.

OnWebRender(config)

Selects the outline client class and registers critical WinSDK browser events.

Parameter	Type	Description
config	Object	The mutable browser configuration.

Uses the virtual outline client only when virtual scrolling is enabled outside design mode.

PixelsToFormUnits(nNumPixels, bVertical)

Converts a pixel length to form units using this control's form metrics.

Parameter	Type	Description
nNumPixels	SalNumber	The pixel length to convert.
bVertical	SalBoolean	True for a vertical measurement; false for a horizontal measurement.

Returns: SalNumber. The converted length in form units.

PopulateList(hSql, sSelect)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

PopulateList(hSql, sSelect, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

PostMessage(nMsg, nMywParam, nMylParam)

Queues a SAL window action for later dispatch on the application context.

Parameter	Type	Description
nMsg	SalNumber	The SAL or application-defined message code.
nMywParam	SalNumber	The first message parameter.
nMylParam	SalNumber	The second message parameter.

Returns: SalBoolean. True if the action was queued; false if the control is unavailable or disposed.

Promote(nIndex, hPicNormal, hPicSelect)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalBoolean.

SaveOutline(sBlob)

Parameter	Type	Description
sBlob	SalString

Returns: SalNumber.

SendMessage(nMsg, nMywParam, nMylParam)

Dispatches a SAL window action synchronously and returns its result.

Parameter	Type	Description
nMsg	SalNumber	The SAL or application-defined message code.
nMywParam	SalNumber	The first message parameter.
nMylParam	SalNumber	The second message parameter.

Returns: SalNumber. The action's return value, or zero if the target is unavailable or disposed.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Dispatches a SAL message to this control's children.

Parameter	Type	Description
nMsg	SalNumber	The SAL or application-defined message code.
nMywParam	SalNumber	The first message parameter.
nMylParam	SalNumber	The second message parameter.

Returns: SalBoolean. The result of child-message dispatch; false if the parent is unavailable or disposed.

SetColor(nIndex, nColor)

Parameter	Type	Description
nIndex	SalNumber
nColor	SalNumber

Returns: SalNumber.

SetContextMenu(sMenuName, nFlags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
sMenuName	SalString	The name used to resolve the menu type.
nFlags	SalNumber	Use Sys.CM_TableCell to target the associated table column; other values target the control.

Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.

SetContextMenu(menuType, nFlags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
menuType	Type	The type of the menu to create.
nFlags	SalNumber	Use Sys.CM_TableCell to target the associated table column; other values target the control.

Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.

SetCursor(nResourceId, nType)

Assigns a predefined cursor to the requested role.

Parameter	Type	Description
nResourceId	Int32	A supported Sys.CURSOR_* cursor identifier.
nType	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.

SetCursor(sBlob, nType)

Requests a cursor from binary data; this web implementation does not support binary cursor loading.

Parameter	Type	Description
sBlob	SalString	The binary cursor data.
nType	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. Always false.

SetCursorFile(sFile, nType)

Loads a cursor from a file and assigns it to the requested role.

Parameter	Type	Description
sFile	SalString	The cursor file path.
nType	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.

Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.

SetFlags(nIndex, nFlags, bState)

Parameter	Type	Description
nIndex	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetFocus()

Requests keyboard focus for this control.

Returns: SalWindowHandle. The previously focused control's handle, or a null SAL handle when no previous control exists or this target is ineligible.

Hidden or disabled controls and table columns are ineligible.

SetFont(nIndex, hFont)

Parameter	Type	Description
nIndex	SalNumber
hFont	SalNumber

Returns: SalNumber.

SetFont(sName, nSize, nEnhancement)

Creates and assigns a font to this control.

Parameter	Type	Description
sName	SalString	The font family name.
nSize	SalNumber	The font size in points.
nEnhancement	SalNumber	The combined Sys.FONT_Enh* style flags.

Returns: SalBoolean. True if the font was created and assigned; otherwise, false.

SetItemColor(hItem, nColor)

Parameter	Type	Description
hItem	SalNumber
nColor	SalNumber

Returns: SalBoolean.

SetItemData(hItem, sText, nValue, nItemFlags)

Parameter	Type	Description
hItem	SalNumber
sText	SalString
nValue	SalNumber
nItemFlags	SalNumber

Returns: SalNumber.

SetItemFlags(hItem, nFlags, bState)

Parameter	Type	Description
hItem	SalNumber
nFlags	SalNumber
bState	SalBoolean

Returns: SalBoolean.

SetItemFont(hItem, hFont)

Parameter	Type	Description
hItem	SalNumber
hFont	SalNumber

Returns: SalBoolean.

SetItemPicture(hItem, hPicNormal, hPicSelect)

Parameter	Type	Description
hItem	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalBoolean.

SetItemText(hItem, sText)

Parameter	Type	Description
hItem	SalNumber
sText	SalString

Returns: SalBoolean.

SetItemValue(hItem, nValue)

Parameter	Type	Description
hItem	SalNumber
nValue	SalNumber

Returns: SalBoolean.

SetLabelText(sText)

Assigns the text of this control's associated label.

Parameter	Type	Description
sText	SalString	The label text to display.

Returns: SalBoolean. True if an associated label was found and updated; otherwise, false.

SetListSelectedIndex(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

SetListSelectedItems(nIndex, bSelect)

Parameter	Type	Description
nIndex	SalNumber
bSelect	SalBoolean

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

SetListSelectedText(nIndexStart, sText)

Parameter	Type	Description
nIndexStart	SalNumber
sText	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

SetLocation(nX, nY)

Sets this control's location in form units.

Parameter	Type	Description
nX	SalNumber	The new horizontal coordinate.
nY	SalNumber	The new vertical coordinate.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

For forms, this also selects manual startup positioning.

SetModified(bSet)

Sets this control's SAL modification flag.

Parameter	Type	Description
bSet	SalBoolean	True to mark the value modified; false to clear the flag.

Returns: SalBoolean. True if the translated control supports SAL values; otherwise, false.

For editable SAL controls, this also clears the validation flag.

SetOutlineRedraw(bState)

Parameter	Type	Description
bState	SalBoolean

Returns: SalBoolean.

SetPicture(nIndex, hPicNormal, hPicSelect)

Parameter	Type	Description
nIndex	SalNumber
hPicNormal	SalNumber
hPicSelect	SalNumber

Returns: SalNumber.

SetProperty(sName, sValue, nLength)

Assigns a SAL named property after limiting the value's length.

Parameter	Type	Description
sName	SalString	The property name.
sValue	SalString	The value to assign.
nLength	SalNumber	The number of leading characters to retain.

Returns: SalBoolean. True if the translated control implements the SAL window contract; otherwise, false.

SetSize(nWidth, nHeight)

Sets this control's dimensions in form units.

Parameter	Type	Description
nWidth	SalNumber	The new width.
nHeight	SalNumber	The new height.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

SetStyle(nStyle)

Parameter	Type	Description
nStyle	SalNumber

Returns: SalBoolean.

SetText(sText)

Assigns the control's text.

Parameter	Type	Description
sText	SalString	The text to display.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

SetTimer(nIDEvent, nElapseMilliSec)

Starts or restarts a timer that sends SAL timer actions to this control.

Parameter	Type	Description
nIDEvent	SalNumber	The timer identifier sent in the first parameter of each Sys.SAM_Timer action.
nElapseMilliSec	SalNumber	The interval between ticks, in milliseconds.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

SetWindowColor(nColorIndex, nColor)

Assigns a window or table-cell color.

Parameter	Type	Description
nColorIndex	SalNumber	The Sys.COLOR_Index* component to change.
nColor	SalNumber	The SAL color value to translate and assign.

Returns: SalBoolean. True for a supported color index and resolved control; otherwise, false.

Cell colors apply only to table columns. Window colors on table windows also update their grid styles.

ShowOutline(nLevel)

Parameter	Type	Description
nLevel	SalNumber

Returns: SalBoolean.

ShowWindow()

Shows this control or table column.

Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.

ShowWindowAndLabel()

Shows this control and its associated label.

Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.

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

Creates and displays a popup menu, disposing it after it closes.

Parameter	Type	Description
sMenuName	SalString	The name used to resolve the menu type.
nFlags	SalNumber	Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported.
nX	SalNumber	The horizontal screen coordinate in pixels, unless the cursor-X flag is set.
nY	SalNumber	The vertical screen coordinate in pixels, unless the cursor-Y flag is set.
callback	Action<ContextMenu>	An optional callback invoked when the menu closes, before it is disposed.

Returns: SalBoolean. True if the menu was created and shown; otherwise, false.

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

Creates and displays a popup menu, disposing it after it closes.

Parameter	Type	Description
menuType	Type	The menu type to instantiate.
nFlags	SalNumber	Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported.
nX	SalNumber	The horizontal screen coordinate in pixels, unless the cursor-X flag is set.
nY	SalNumber	The vertical screen coordinate in pixels, unless the cursor-Y flag is set.
callback	Action<ContextMenu>	An optional callback invoked when the menu closes, before it is disposed.

Returns: SalBoolean. True if the menu was created and shown; otherwise, false.

UpdateWindow()

Requests an update of this control.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

Events

WindowActions

WindowActionsEventHandler Occurs when the control receives a SAL or application-defined window action.

Inherited By

Name	Description
VisDesktopListBox	Displays a desktop-style outline of the application server's drives and directories.
VisDirTreeListBox	Displays server directories as an outline, loading subdirectories when nodes expand.

Implements

Name	Description
ISalControl
ISalListControl
ISalWindow