SalListBox

PPJ.Runtime.Windows.SalListBox

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

ListBox implementation.

public class SalListBox : ListBox, ISalWindow, ISalControl, ISalListControl, IConvertible

Constructors

Constructs a SalListBox object.

Properties

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

SalNamedProperties: Returns the collection of named properties.

Boolean: Returns/Sets the ReadOnly flag for the ListBox control. When the ListBox is ReadOnly, it can still get the focus and be scrolled. (Default: False)

Int32: Index of selected item. -1 if none

Methods

Adds a string to a list box or combo box.

ParameterTypeDescription

sName

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

type

Returns: SalBoolean.

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Deletes a list box or combo box entry.

ParameterTypeDescription

nIndex

Returns: SalNumber.

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

Returns: SalBoolean.

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.

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.

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

ParameterTypeDescription

windowName

The name of the child window to find.

Returns: SalWindowHandle.

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

ParameterTypeDescription

msg

mywParam

mylParam

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.

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

Returns: SalString.

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.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

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 number of list box or combo box entries.

Returns: SalNumber.

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

ParameterTypeDescription

index

Returns: SalBoolean.

ParameterTypeDescription

index

text

Returns: SalNumber.

Returns the text of the specified item.

ParameterTypeDescription

index

Returns: SalString.

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

ParameterTypeDescription

index

Returns: SalNumber.

ParameterTypeDescription

fileName

Returns: SalBoolean.

Fetches the selected directory or file name from a list box or combo box.

Returns: SalString. Name of the selected file in t he control.

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.

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

ParameterTypeDescription

name

value

Returns: SalBoolean.

Gets the value of a named property.

ParameterTypeDescription

name

Returns: SalString.

ParameterTypeDescription

width

height

Returns: SalBoolean.

ParameterTypeDescription

text

maxLen

Returns: SalNumber.

Retrieves the text of a window.

ParameterTypeDescription

maxLen

Returns: SalString.

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 entry into a list box or combo box at a specified position.

ParameterTypeDescription

nIndex

sAdd

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.

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

ParameterTypeDescription

xOffset

yOffset

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

numPixels

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.

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.

ParameterTypeDescription

ctrlPath

pathName

attributes

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

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

msg

mywParam

mylParam

Returns: SalBoolean.

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

ParameterTypeDescription

sMenuName

nFlags

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

redraw

Returns: SalBoolean.

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

ParameterTypeDescription

index

Returns: SalBoolean.

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

ParameterTypeDescription

index

select

Returns: SalBoolean.

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

ParameterTypeDescription

indexStart

text

Returns: SalNumber.

Sets tabs in a list box.

ParameterTypeDescription

tabStops

Returns: SalBoolean.

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.

Sets the value of a named property.

ParameterTypeDescription

name

value

length

Returns: SalBoolean.

Resizes a window.

ParameterTypeDescription

width

height

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

colorIndex

color

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

flags

x

y

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

EventHandler Fired when the ReadOnly property is altered.

WindowActionsEventHandler Window Actions

Inherited By

Implements

NameDescription

All SAL controls implement this interface.

SAL List controls implement this interface.

All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.

Last updated