SalComboBox

PPJ.Runtime.Windows.SalComboBox

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

ComboBox implementation.

C#

public class SalComboBox : ComboBox, ISalWindow, ISalEditControl, ISalControl, ISalListControl, IConvertible

VB.NET

Constructors

SalComboBox()

Constructs a SalComboBox object.

Properties

CultureInfo

CultureInfo: Returns/Sets the culture to use for this control.

EditMask

String: Indicates the edit mask to apply to the text while editing. (Default: "")

EnableSpellChecker

Boolean: Enables/Disables the built-in spell checker. (Default: False)

Label

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

Modified

Boolean: Returns/Sets the modified flag.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

ReadOnly

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

SelectedIndex

Int32: Index of selected item or -1 if none is selected

Text

String: Returns/Sets the text of the combo box. This is overridden remove the edit mask.

Watermark

String: Returns/Sets the watermark to use for this control. (Default: "")

Methods

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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: SalBoolean.

Clear()

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

Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.

Parameter	Type	Description
nType	SalNumber

Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

DestroyWindow()

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

Returns: SalBoolean.

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: SalBoolean.

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: SalBoolean.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

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: SalBoolean.

FindChild(windowName)

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

Parameter	Type	Description
windowName	SalString

Returns: SalWindowHandle.

FireWindowActions(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

FormUnitsToPixels(formUnits, vertical)

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
formUnits	SalNumber	The number of form units.
vertical	SalBoolean	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.

GetClassName()

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

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDataLength()

Returns the maximum length of a data field, multi line text field, or table window column.

Returns: SalNumber.

GetDataType()

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

Returns: SalNumber.

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

Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter	Type	Description
name	SalString&
size	SalNumber&
enhancement	SalNumber&

Returns: SalBoolean.

GetFormat(sPicture)

Parameter	Type	Description
sPicture	SalString&

Returns: SalBoolean.

GetFormat()

Gets the picture format of a data field or table window column.

Returns: SalString.

GetFormatCode()

Returns the current format of a data field or table window column.

Returns: SalNumber.

GetFormattedText(sText, bFormat)

Parameter	Type	Description
sText	SalString&
bFormat	SalBoolean

Returns: SalBoolean.

GetFormattedText(bFormat)

Copies the contents of a data field or table window column to a string. This function also lets you copy the format of the data.

Parameter	Type	Description
bFormat	SalBoolean

Returns: SalString.

GetInputMask(sMask)

Parameter	Type	Description
sMask	SalString&

Returns: SalBoolean.

GetInputMask()

Gets the input mask of a data field or table window column.

Returns: SalString.

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: SalWindowHandle.

GetLabelText(sText, nMaxLength)

Parameter	Type	Description
sText	SalString&
nMaxLength	SalNumber

Returns: SalNumber.

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

Returns: SalString.

GetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumber.

GetListItemState(nIndex)

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

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

GetListItemText(nIndex, sText)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString&

Returns: SalNumber.

GetListItemText(nIndex)

Returns the text of the specified item.

Parameter	Type	Description
nIndex	SalNumber

Returns: SalString.

GetListItemTextLength(nIndex)

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

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

GetListSelectedFile(sFileName)

Parameter	Type	Description
sFileName	SalString&

Returns: SalBoolean.

GetListSelectedFile()

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.

GetListSelectedIndex()

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

Returns: SalNumber.

GetListSelectedItems(nSelectedArray)

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

Parameter	Type	Description
nSelectedArray	SalArray<SalNumber>

Returns: SalBoolean.

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: SalNumber.

GetLocation(x, y)

Parameter	Type	Description
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetName(sText)

Parameter	Type	Description
sText	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

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

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

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter	Type	Description
name	SalString
value	SalString&

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter	Type	Description
name	SalString

Returns: SalString.

GetSize(width, height)

Parameter	Type	Description
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetTextUnmasked(sText)

Parameter	Type	Description
sText	SalString&

Returns: SalBoolean.

GetTextUnmasked()

Unmasks the text from a masked edit control.

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

InsertListItem(nIndex, sAdd)

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

Parameter	Type	Description
nIndex	SalNumber
sAdd	SalString

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter	Type	Description
typeClass	Type

Returns: SalBoolean.

IsEmpty()

Verifies whether a data field, multi line text field, or table window column is null or empty.

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsModified()

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.

IsValid()

Validates the contents of a data field or table window column using the current profile.

Returns: SalBoolean.

IsValidDateTime()

Verifies whether a data field, multi line text field, or table window column contains a valid date/time value. For multi line text fields, the date/time value must be the only item in the field.

Returns: SalBoolean.

IsValidDecimal(nPrecision, nScale)

Verifies whether a data field, multi line text field, or table window column contains a valid decimal value. For multi line text fields, the decimal value must be the only item in the field.

Parameter	Type	Description
nPrecision	SalNumber
nScale	SalNumber

Returns: SalBoolean.

IsValidInteger()

Verifies whether a data field, multi line text field, or table window column contains a valid integer value. For multi line text fields, the integer value must be the only item in the field.

Returns: SalBoolean.

IsValidNumber()

Verifies whether a data field, multi line text field, or table window column contains a valid numeric value. Valid numbers are integers or floating point numbers, negative and positive. For multi line text fields, the numeric value must be the only item in the field.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter	Type	Description
idEvent	SalNumber

Returns: SalBoolean.

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
nXOffset	SalNumber
nYOffset	SalNumber

Returns: SalBoolean.

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
nNumPixels	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

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
hSql	SalSqlHandle
sSelect	SalString

Returns: SalBoolean.

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
hSql	SalSqlHandle
sSelect	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

PopulateListFiles(ctrlPath, sPathName, nAttributes)

Parameter	Type	Description
ctrlPath	Control
sPathName	SalString&
nAttributes	SalNumber

Returns: SalBoolean.

PostMessage(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalBoolean.

SendMessage(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

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

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, flags)

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

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter	Type	Description
resource	SalResourceCursor
type	SalNumber

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
resourceId	Int32
type	SalNumber

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
blob	SalString
type	SalNumber

Returns: SalBoolean.

SetCursorFile(file, type)

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
file	SalString
type	SalNumber

Returns: SalBoolean.

SetDataLength(length)

Sets a limit on the number of characters that a user can enter into a data field, multi line text field, or table window column.

Parameter	Type	Description
length	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

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

Parameter	Type	Description
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

SetFormat(sPicture)

Sets the picture format of a data field or table window column.

Parameter	Type	Description
sPicture	SalString

Returns: SalBoolean.

SetFormatCode(nFormat)

Sets a data field's or table window column's format.

Parameter	Type	Description
nFormat	SalNumber

Returns: SalBoolean.

SetInputMask(sMask)

Sets the input mask of a data field or table window column.

Parameter	Type	Description
sMask	SalString

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetListRedraw(bRedraw)

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

Parameter	Type	Description
bRedraw	SalNumber

Returns: SalBoolean.

SetListSelectedIndex(nIndex)

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

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

SetListSelectedItems(nIndex, bSelect)

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

Parameter	Type	Description
nIndex	SalNumber
bSelect	SalBoolean

Returns: SalBoolean.

SetListSelectedText(nIndexStart, sText)

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

Parameter	Type	Description
nIndexStart	SalNumber
sText	SalString

Returns: SalNumber.

SetListTabStops(nTabStops)

Sets tabs in a list box.

Parameter	Type	Description
nTabStops	SalArray<SalNumber>

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetModified(bSet)

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

Parameter	Type	Description
bSet	SalBoolean

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter	Type	Description
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter	Type	Description
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter	Type	Description
text	SalString

Returns: SalBoolean.

SetText(sValue, bFormat)

Copies a string to a data field or table window column. After copying the string to the field, formats the string.

Parameter	Type	Description
sValue	SalString
bFormat	SalBoolean

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

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
idEvent	SalNumber
elapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

ShowWindowAndLabel()

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

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Validate()

Validates and formats a data field's or table window column's contents.

Returns: SalBoolean.

Validate(validate)

Validates and formats a data field's or table window column's contents.

Parameter	Type	Description
validate	SalNumber

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter	Type	Description
file	SalString
command	SalNumber
numData	SalNumber
strData	SalString

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

ReadOnlyChanged

EventHandler Fired when the ReadOnly property is altered.

WindowActions

WindowActionsEventHandler Window Actions

Inherited By

Name	Description
SalQuickToolTipComboBox	ComboBox with tool tip support
VisColorComboBox
VisColorPaletteDropDown
VisComboBoxBase
VisDropDownBase
VisFontComboBox
VisFontNameComboBox
VisListViewDropDown
VisOutlineComboBox
VisPictureComboBox

Implements

Name	Description
ISalControl	All SAL controls implement this interface.
ISalEditControl	SAL Editable controls implement this interface
ISalListControl	SAL List controls implement this interface.
ISalWindow	All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.