SalComboBox

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.50 (5.0.0.0)

• Control
  • ListControl
    • ComboBox
      • SalComboBox

Combines a selectable item list with SAL editing, formatting, and validation behavior.

C#

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

VB.NET

Public Class SalComboBox
    Inherits ComboBox
    Implements ISalWindow, ISalEditControl, ISalControl, ISalListControl, IConvertible

Example:

using PPJ.Runtime.Windows;

var choices = new SalComboBox();
choices.Items.AddRange(new object[] { "Open", "Closed" });
choices.SelectedIndex = 0;

Constructors

SalComboBox()

Initializes an unmodified, unvalidated combo box with a maximum input length of 100 characters.

Properties

CultureInfo

CultureInfo: Gets or sets the culture used by this control.

At runtime, an unset culture falls back to the containing SalForm and then Sys.CultureInfo. Neutral cultures are rejected. Non-current mutable cultures are stored as read-only cultures. Changing the culture rebuilds the mask provider and reapplies the edit mask.

EditMask

String: Gets or sets the mask applied while editing. (Default: "")

Null becomes an empty mask. A change removes the old mask, resets the mask provider, and reapplies the new mask for editable combo styles. An existing modified flag is preserved.

HidePromptOnLeave

Boolean: Gets or sets whether the browser hides mask prompts when focus leaves the editor. (Default: False)

MaskedTextProvider

MaskedTextProvider: Gets the lazily created provider used for edit-mask processing.

Uses EditMask and CultureInfo when a mask is configured; otherwise creates a placeholder provider. The initial prompt character is copied from PromptChar.

Modified

Boolean: Gets or sets the SAL modification flag.

NamedProperties

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

PromptChar

Char: Gets or sets the character displayed for unfilled mask positions. (Default: _)

Defaults to underscore. An invalid MaskedTextProvider input character causes ArgumentException; a change requests a browser update.

RejectInputOnFirstFailure

Boolean: Gets or sets whether masking uses a single provider Set operation instead of per-character insertion. (Default: False)

SelectedIndex

Int32: Gets or sets the selected item index while preserving the SAL modified flag.

Indices below -1 or at or beyond the item count are ignored.

Text

String: Gets or sets text with SAL mask, selection, and second-base behavior. (Default: "")

Editable styles return unmasked text unless KeepMask is active, and enforce positive MaxLength on assignment. DropDownList assignment selects by prefix, with empty text clearing selection. Direct assignment clears Modified.

TextMaskFormat

MaskFormat: Gets or sets whether the mask provider includes prompts and literals. (Default: IncludeLiterals)

Changing the value updates the provider and remasks the existing text.

Methods

AddListItem(sName)

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

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.

DeleteListItem(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Applies the referenced SAL operation to this control.

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.

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.

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.

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.

FireWindowActions(nMsg, nMywParam, nMylParam)

Invokes the SAL action dispatch pipeline for this control.

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 return value in the dispatched action's event data.

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.

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.

GetControlType()

Gets the SAL window type of this control.

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

GetDataLength()

Returns: SalNumber.

Applies the referenced SAL operation to this 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.

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.

GetFormat(sPicture)

Retrieves the SAL format picture.

Parameter	Type	Description
sPicture	SalString	Receives the picture; unchanged if it is null.

Returns: SalBoolean. True when the format helper returns a non-null picture; otherwise false.

GetFormat()

Returns: SalString.

Applies the referenced SAL operation to this control.

GetFormatCode()

Returns: SalNumber.

Applies the referenced SAL operation to this control.

GetFormattedText(sText, bFormat)

Retrieves text with optional SAL formatting.

Parameter	Type	Description
sText	SalString	Receives the requested text; unchanged if the helper returns null.
bFormat	SalBoolean	Whether to apply the format picture.

Returns: SalBoolean. True when text is returned; otherwise false.

GetFormattedText(bFormat)

Parameter	Type	Description
bFormat	SalBoolean

Returns: SalString.

Applies the referenced SAL operation to this control.

GetInputMask(sMask)

Retrieves the SAL editing mask.

Parameter	Type	Description
sMask	SalString	Receives the mask unless it is empty.

Returns: SalBoolean. False for an empty mask; otherwise true, including when the helper returns null.

GetInputMask()

Returns: SalString.

Applies the referenced SAL operation to this control.

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.

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.

GetListSelectedFile(sFileName)

Parameter	Type	Description
sFileName	SalString

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

GetListSelectedFile()

Returns: SalString.

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.

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.

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.

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.

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.

GetTextUnmasked(sText)

Retrieves the text without edit-mask prompts and literals.

Parameter	Type	Description
sText	SalString	Receives the unmasked text.

Returns: SalBoolean. True when the translated control exists; otherwise false.

GetTextUnmasked()

Returns: SalString.

Applies the referenced SAL operation to this control.

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.

InsertListItem(nIndex, sAdd)

Parameter	Type	Description
nIndex	SalNumber
sAdd	SalString

Returns: SalNumber.

Applies the referenced SAL operation to this control.

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.

IsEmpty()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

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.

IsValid()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

IsValidDateTime()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

IsValidDecimal(nPrecision, nScale)

Parameter	Type	Description
nPrecision	SalNumber
nScale	SalNumber

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

IsValidInteger()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

IsValidNumber()

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

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.

MaskText(text)

Applies the edit mask to text.

Parameter	Type	Description
text	String	The input text.

Returns: String. The unchanged text when no mask is set; otherwise the provider's formatted result.

RejectInputOnFirstFailure uses a single Set operation. Otherwise the provider is cleared and characters are inserted individually. IncludeLiterals output omits trailing unassigned literals for an incomplete mask.

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.

OnDoubleClick(e)

Raises the inherited event and sends SAM_DoubleClick.

Parameter	Type	Description
e	EventArgs	The event data.

OnDragDrop(e)

Processes the SAL drop notification before raising the inherited event.

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

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.

OnDragStart(e)

Starts SAL drag handling before raising the inherited drag-start event.

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

OnDropDown(e)

Raises the inherited event and sends SAM_DropDown.

Parameter	Type	Description
e	EventArgs	The event data.

OnGotFocus(e)

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

Parameter	Type	Description
e	EventArgs	The focus event data.

OnLostFocus(e)

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

Parameter	Type	Description
e	EventArgs	The focus event data.

OnValidating(e)

Runs SAL validation before raising the inherited validation event.

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

OnWebEvent(e)

Processes browser events in SAL context, reports selection changes, and simulates WinSDK events.

Parameter	Type	Description
e	WisejEventArgs	The browser event.

selectionChanged marks the control modified and unvalidated and sends SAM_Click.

OnWebRender(config)

Writes the edit-mask settings, SAL client class, and critical WinSDK events to browser configuration.

Parameter	Type	Description
config	Object	The mutable browser configuration.

Uses the virtual client when VirtualScroll is enabled. When masked and unselected, supplies the provider text including literals and excluding prompts.

OnWebUpdate(state)

Processes editable browser value updates and sends SAM_AnyEdit for changed text.

Parameter	Type	Description
state	Object	The incoming browser state.

Skips updates when CanUpdate is false or the style is DropDownList. Changed text marks the control modified and unvalidated.

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.

PopulateListFiles(ctrlPath, sPathName, nAttributes)

Parameter	Type	Description
ctrlPath	Control
sPathName	SalString
nAttributes	SalNumber

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.

RenderItem(item)

Renders SAL list items using their own browser representation.

Parameter	Type	Description
item	Object	The item to render.

Returns: Object. ISalListItem.Render output, or the inherited item representation for other objects.

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.

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.

SetDataLength(length)

Parameter	Type	Description
length	SalNumber

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

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

SetFormat(sPicture)

Parameter	Type	Description
sPicture	SalString

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

SetFormatCode(nFormat)

Parameter	Type	Description
nFormat	SalNumber

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

SetInputMask(sMask)

Parameter	Type	Description
sMask	SalString

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

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.

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.

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.

SetText(sValue, bFormat)

Parameter	Type	Description
sValue	SalString
bFormat	SalBoolean

Returns: SalBoolean.

Applies the referenced SAL operation to this control.

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.

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.

UnmaskText(text)

Removes edit-mask prompts and literals from text.

Parameter	Type	Description
text	String	The masked text.

Returns: String. The unchanged text when no mask is set; otherwise the provider output excluding prompts and literals.

UpdateWindow()

Requests an update of this control.

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

Validate()

Validates the control's data type and applies formatting when valid.

Returns: SalBoolean. True for valid data; otherwise false.

Requests the standard invalid-data dialog on failure.

Validate(nValidate)

Validates the control's data type and applies formatting when valid.

Parameter	Type	Description
nValidate	SalNumber	FMT_Validate_Dialog requests the standard invalid-data dialog; other values suppress it.

Returns: SalBoolean. True for valid data; otherwise false.

Events

WindowActions

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

Inherited By

Name	Description
VisColorComboBox
VisComboBoxBase
VisDriveComboBox
VisDropDownBase
VisFontComboBox
VisFontNameComboBox
VisListViewDropDown
VisOutlineComboBox
VisPictureComboBox

Implements

Name	Description
ISalControl	Exposes a SAL control's data type, value, and modification state.
ISalEditControl	Exposes validation, formatting, and input constraints for an editable SAL control.
ISalListControl	Provides item access, searching, and selection for SAL list controls.
ISalWindow	Provides SAL window actions, named properties, and access to a window's runtime implementation.