SalTableColumn

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.50 (5.0.0.0)

Defines a SAL table column and the editing, formatting, and list behavior of its current cell.

C#

public class SalTableColumn : Control, ISalWindow, ISalEditControl, ISalControl, ISalListControl, IConvertible, IComparer

VB.NET

Public Class SalTableColumn
    Inherits Control
    Implements ISalWindow, ISalEditControl, ISalControl, ISalListControl, IConvertible, IComparer

Example:

var column = new PPJ.Runtime.Windows.SalTableColumn();
column.Name = "CustomerName";
column.MaxLength = 80;

Constructors

SalTableColumn()

Initializes an editable, visible, sortable column with width 80 and maximum text length 100.

Properties

AllowDrop

Boolean: Gets the unsupported drag-and-drop setting. (Default: False)

AllowFiltering

Boolean: Gets or sets whether the grid offers filtering for this column. (Default: False)

Anchor

AnchorStyles: Gets the fixed anchoring behavior of a table column. (Default: Top, Left)

BackColor

Color: Gets or sets the column background color.

BackgroundImage

Image: Gets the unsupported background-image setting. (Default: null)

BackgroundImageLayout

ImageLayout: Gets the unsupported background-image layout setting. (Default: Tile)

CausesValidation

Boolean: Gets the fixed validation setting for a table column.

CellTextColor

Color: Gets or sets the text color of the context cell.

CellType

CellType: Gets or sets the editor used for the column cells. (Default: Standard)

CharacterCasing

CharacterCasing: Gets or sets automatic case conversion for input. (Default: Normal)

CheckBox

CellCheckBox: Gets the checked and unchecked value mapping for check-box cells.

ComboBox

CellComboBox: Gets the list and editor settings for combo-box cells.

CultureInfo

CultureInfo: Gets or sets the culture used by this column. (Default: null)

Throws:

• ArgumentException A neutral culture is assigned and is not handled by the reset branch.

Cursor

Cursor: Gets the current cursor.

CustomEditor

Control: Gets or sets the custom control used to edit cells. (Default: null)

DataType

DataType: Gets or sets the value type used by the column cells. (Default: String)

DateTime

SalDateTime: Gets or sets the datetime value of this column in the table context row.

Dock

DockStyle: Gets the fixed docking behavior of a table column. (Default: None)

EditMask

String: Gets or sets the cell input mask while preserving unmasked text. (Default: "")

EnableSpellChecker

Boolean: Gets or sets whether the cell editor uses the built-in spell checker. (Default: False)

Flags

Int32: Gets or replaces the column configuration flags.

Format

String: Gets or sets the formatting picture used for cell values. (Default: "")

An invalid numeric or date picture leaves the stored SAL picture unchanged, although the supplied picture is still forwarded to the attached grid columns.

GridCol

Column: Gets or binds the underlying main-grid column.

Id

Int32: Gets the column identifier, calculating and caching it on first access.

ImeMode

ImeMode: Gets the fixed input-method setting.

IsAutomatic

Boolean: Gets whether this column was generated automatically from a query result.

IsDynamic

Boolean: Gets whether this column was created dynamically.

Label

Control: Gets or sets the label associated with this control through the SAL window implementation.

Location

Point: Gets the horizontal position of the attached grid column.

MaxLength

Int32: Gets or sets the maximum input length. (Default: 100)

Modified

Boolean: Gets or sets the modification flag for this column in the table context row.

Name

String: Gets or sets the column name and synchronizes it with both grid columns.

NamedProperties

SalNamedProperties: Gets the SAL named-property collection associated with this control.

Number

SalNumber: Gets or sets the number value of this column in the table context row.

ParentTable

SalTableWindow: Gets the table that owns this column.

PasswordChar

Char: Gets or sets the character used to conceal cell text. (Default: "\0")

PasswordText

String: Gets the cached display string used for concealed cell text.

PopupBox

CellPopupBox: Gets the multiline popup-editor settings.

Position

Int32: Gets or sets the display position of the column.

Changing this property moves an attached grid column. Use SetColumnPosition to enforce locked-column restrictions. Throws:

• ArgumentOutOfRangeException The assigned value is negative.

ReadOnly

Boolean: Gets or sets the column read-only flag. (Default: False)

RightToLeft

Boolean: Gets the unsupported right-to-left setting.

Selected

Boolean: Gets or sets column selection in the main and split grids.

Size

Size: Gets the attached column width and this control's client height.

SplitGridCol

Column: Gets or binds the corresponding column in the split grid.

TabIndex

Int32: Gets the column position used for tab order.

TabStop

Boolean: Gets whether the column participates in tab navigation.

Text

String: Gets or sets the text value of this column in the table context row.

TextAlign

HorizontalAlignment: Gets or sets horizontal cell-text alignment. (Default: Left)

Title

String: Gets or sets the text displayed in the column header. (Default: "")

TitleAlign

HorizontalAlignment: Gets or sets horizontal alignment of the column header. (Default: Center)

Width

Int32: Gets or sets the column width in pixels. (Default: 80)

WordWrap

Boolean: Gets or sets whether multiline cell text wraps. (Default: False)

Methods

AddListItem(sName)

Adds a text item, respecting the list sorting setting.

Parameter	Type	Description
sName	SalString	The item text.

Returns: SalNumber. The added item index, or Sys.LB_Err for an unsupported target.

Average(flagsOn, flagsOff)

Calculates the mean of this column over rows matching the specified flags.

Parameter	Type	Description
flagsOn	Int32	Row flags for which at least one must be set, or zero to omit this test.
flagsOff	Int32	Row flags that must all be clear.

Returns: Decimal. The sum divided by the number of matching rows, or zero when none match.

The original context row is restored when the operation finishes.

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; otherwise, false.

CenterWindow()

Centers this window within its parent or, for a top-level form, its owner or screen working area.

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

A top-level form is constrained to the selected screen working area. A control without a parent is unchanged unless it is a top-level form.

Clear()

Clears the value or selection appropriate to this control type.

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

Editable controls and labels have their text cleared; check boxes are unchecked; list selections are cleared. A date/time picker is set to the current date and time. Unrecognized control types are unchanged.

ClearCursor(type)

Restores the default cursor for a role, using the I-beam for TextBox subclasses.

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

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

ClearList()

Removes all items from the list.

Returns: SalBoolean. True when the target supports lists; otherwise, false.

DefineCheckBoxColumn(flags, checkedValue, uncheckedValue)

Configures this column as check boxes with mapped cell values.

Parameter	Type	Description
flags	SalNumber	Sys.COL_CheckBox_IgnoreCase to compare values without case sensitivity, or zero.
checkedValue	SalString	The value representing a checked cell.
uncheckedValue	SalString	The value representing an unchecked cell.

Returns: SalBoolean. True after applying the configuration.

DefineDropDownListColumn(flags, lines)

Configures this column as combo-box cells.

Parameter	Type	Description
flags	SalNumber	The Sys.COL_DropDownList_Sorted, Editable, and Auto options. VScroll is ignored.
lines	SalNumber	Retained for SAL compatibility; ignored.

Returns: SalBoolean. True after applying the configuration.

DefinePopupEditColumn(flags, lines)

Configures this column to use a multiline popup editor.

Parameter	Type	Description
flags	SalNumber	Retained for SAL compatibility; ignored.
lines	SalNumber	The number of lines for the popup editor.

Returns: SalBoolean. True after applying the configuration.

DeleteListItem(nIndex)

Removes the item at a zero-based index.

Parameter	Type	Description
nIndex	SalNumber	The item to remove.

Returns: SalNumber. The remaining item count, or Sys.LB_Err for an invalid index or unsupported target.

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.

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.

Native disabled styles are also cleared. When needed, tab navigation is restored except for unchecked radio buttons.

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(windowName)

Searches this window for a child control by name.

Parameter	Type	Description
windowName	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 this control's SAL action handlers directly and returns their result.

Parameter	Type	Description
nMsg	SalNumber	The action message code.
nMywParam	SalNumber	The first action parameter.
nMylParam	SalNumber	The second action parameter.

Returns: SalNumber. The result stored in the dispatched action arguments.

FormUnitsToPixels(formUnits, vertical)

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

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

Returns: SalNumber. The converted pixel length.

FromControl(ctrl)

Resolves the derived SAL control and returns it as a table column.

Parameter	Type	Description
ctrl	Control	The control or secondary-base control to resolve.

Returns: SalTableColumn. The resolved table column, or null if it is not a SalTableColumn.

GetCellType(type)

Copies the editor type into a SAL number.

Parameter	Type	Description
type	SalNumber	Receives the CellType numeric value.

Returns: SalBoolean. Always true.

GetCellType()

Returns the numeric cell-editor type.

Returns: SalNumber. The current CellType value.

GetClassName()

Gets the translated application class name associated with this control.

Returns: SalString. The class name, an empty string for a runtime-defined class, or a null SAL string for an unresolved or native control.

Forms use their base type; nested table-window types are walked upward to a non-nested type.

GetColumnFlags(flags)

Tests whether any of the requested column flags are set.

Parameter	Type	Description
flags	SalNumber	The Sys.COL_* mask to test.

Returns: SalBoolean. True when at least one masked flag is set; false for a zero mask.

GetColumnID()

Returns the column identifier in the owning table.

Returns: SalNumber. The one-based index in the table column collection, or -1 when not found.

GetColumnPosition()

Returns the display position of the column.

Returns: SalNumber. The one-based data-column position.

GetColumnTitle(text, maxLen)

Copies the column title, limited to a specified length.

Parameter	Type	Description
text	SalString	Receives the truncated title.
maxLen	SalNumber	The maximum number of characters to return.

Returns: SalNumber. The number of characters copied.

GetColumnTitle(maxLen)

Returns the column title limited to a specified length.

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

Returns: SalString. The leading title characters.

GetColumnWidth(width)

Copies the column width in horizontal form units.

Parameter	Type	Description
width	SalNumber	Receives the converted width.

Returns: SalBoolean. Always true.

GetColumnWidth()

Returns the column width converted from pixels to horizontal form units.

Returns: SalNumber. The width in form units.

GetControlType()

Gets the SAL window type of this control.

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

GetDataLength()

Gets the configured maximum input length.

Returns: SalNumber. The character limit, -1 for native default or unlimited limits, or zero for an unsupported target.

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(typeMask)

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

Parameter	Type	Description
typeMask	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(name, size, enhancement)

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

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

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

GetFormat(sPicture)

Copies the current display picture.

Parameter	Type	Description
sPicture	SalString	Receives the picture, including an empty picture; remains unchanged for an unsupported target.

Returns: SalBoolean. True when the picture is available; otherwise, false.

GetFormat()

Gets the current display picture.

Returns: SalString. The picture, or a null string for an unsupported target.

GetFormatCode()

Gets the SAL format constant for the current picture, character casing, or password display.

Returns: SalNumber. A Sys.FMT_Format_* value; custom pictures return FMT_Format_Picture.

GetFormattedText(sText, bFormat)

Copies the field value as formatted or unformatted text.

Parameter	Type	Description
sText	SalString	Receives the text when the target supports editing.
bFormat	SalBoolean	True to apply the picture or retain a string input mask; false to use the value text.

Returns: SalBoolean. True when text is available; otherwise, false, leaving text unchanged.

GetFormattedText(bFormat)

Gets the field value as formatted or unformatted text.

Parameter	Type	Description
bFormat	SalBoolean	True to apply the picture or retain a string input mask; false to use the value text.

Returns: SalString. The value text, an empty string for an empty value, or a null string for an unsupported target.

GetInputMask(sMask)

Copies the input mask when a nonempty mask is configured.

Parameter	Type	Description
sMask	SalString	Receives the mask on success; remains unchanged otherwise.

Returns: SalBoolean. True for a nonempty mask; otherwise, false.

GetInputMask()

Gets the input mask used by the field.

Returns: SalString. The configured mask, or a null string for an unsupported target.

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

Counts the entries in the list.

Returns: SalNumber. The item count, or Sys.LB_Err for an unsupported target.

GetListItemState(index)

Checks whether a list item is selected.

Parameter	Type	Description
index	SalNumber	The zero-based item index.

Returns: SalBoolean. True when the item is selected; otherwise, false.

GetListItemText(index, text)

Copies the text of an indexed list item.

Parameter	Type	Description
index	SalNumber	The zero-based item index.
text	SalString	Receives the text on success; remains unchanged when the item is unavailable.

Returns: SalNumber. The text length, or Sys.LB_Err when the item is unavailable.

GetListItemText(index)

Gets the text of an indexed list item.

Parameter	Type	Description
index	SalNumber	The zero-based item index.

Returns: SalString. The item text, or a null string when the item is unavailable.

GetListItemTextLength(index)

Gets the number of characters in a list item.

Parameter	Type	Description
index	SalNumber	The zero-based item index.

Returns: SalNumber. The text length, or Sys.LB_Err when the item is unavailable.

GetListSelectedFile(fileName)

Decodes the selected file-list entry into a file, directory, or drive name.

Parameter	Type	Description
fileName	SalString	Receives the decoded name; remains unchanged when no item is selected.

Returns: SalBoolean. True for a directory or drive; false for an ordinary file or no selection.

GetListSelectedFile()

Gets the decoded name of the selected file-list entry.

Returns: SalString. The file name, a directory with a trailing separator, a drive ending in a colon, or an empty string when nothing is selected.

GetListSelectedIndex()

Gets the first selected item index.

Returns: SalNumber. The zero-based index, or Sys.LB_Err when no item is selected or the target is unsupported.

GetListSelectedItems(nSelectedArray)

Replaces an array with the selected indices of a multi-selection list.

Parameter	Type	Description
nSelectedArray	SalArray<SalNumber>	The destination, made dynamic and reset before indices are copied.

Returns: SalBoolean. True when at least one index is copied; false for an empty selection or a list without multi-selection.

GetListSelectedItemsCount()

Counts selected entries in a multi-selection list.

Returns: SalNumber. The selected count, zero when selection is disabled, or -1 for single-selection mode.

GetLocation(x, y)

Reads this control's location in form units.

Parameter	Type	Description
x	SalNumber	Receives the horizontal location.
y	SalNumber	Receives the vertical location.

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

GetName(text)

Copies this control's name to the supplied variable.

Parameter	Type	Description
text	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(typeMask)

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

Parameter	Type	Description
typeMask	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(name, value)

Reads a SAL named property into a supplied variable.

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

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

GetProperty(name)

Gets the value of a SAL named property.

Parameter	Type	Description
name	SalString	The property name.

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

GetSize(width, height)

Reads this control's size in form units.

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

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

GetText(text, maxLen)

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

Parameter	Type	Description
text	SalString	Receives the retrieved text.
maxLen	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(maxLen)

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

Parameter	Type	Description
maxLen	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)

Copies text with removable input-mask characters stripped.

Parameter	Type	Description
sText	SalString	Receives the unmasked text.

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

GetTextUnmasked()

Gets text with removable input-mask characters stripped.

Returns: SalString. The unmasked text, or a null string when the translated target does not exist.

GetWindowColor(colorIndex)

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

Parameter	Type	Description
colorIndex	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.

Transparent colors are reported as Sys.COLOR_None. Table-column window colors use the system window colors; cell colors use the column settings.

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)

Inserts text into the list at a requested position.

Parameter	Type	Description
nIndex	SalNumber	The zero-based insertion index, or -1 to append using normal sorting behavior.
sAdd	SalString	The item text.

Returns: SalNumber. The resulting index, or Sys.LB_Err for an invalid index or unsupported target.

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(typeClass)

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

Parameter	Type	Description
typeClass	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()

Checks whether the unmasked text is null or empty.

Returns: SalBoolean. True for empty edit text; 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.

IsValid()

Validates the value against the configured data type without applying display formatting.

Returns: SalBoolean. True when the value passes data-type validation; otherwise, false.

IsValidDateTime()

Checks the displayed text as a date and time using the current picture and culture.

Returns: SalBoolean. True when the value is valid; otherwise, false.

IsValidDecimal(nPrecision, nScale)

Checks the displayed text as a decimal with the specified digit limits, picture, and culture.

Parameter	Type	Description
nPrecision	SalNumber	The maximum total number of digits.
nScale	SalNumber	The maximum number of fractional digits.

Returns: SalBoolean. True when the value meets the decimal constraints; otherwise, false.

IsValidInteger()

Checks the displayed text as an integer using the current picture.

Returns: SalBoolean. True when the value is a valid integer; otherwise, false.

IsValidNumber()

Checks the unmasked text as a number using the current picture and culture.

Returns: SalBoolean. True when the value is a valid number; 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(idEvent)

Stops the native window timer with the specified identifier.

Parameter	Type	Description
idEvent	SalNumber	The timer identifier to remove.

Returns: SalBoolean. The native timer-removal result, or false if the control cannot be resolved.

MoveWindow(xOffset, yOffset)

Moves this control by an offset expressed in form units.

Parameter	Type	Description
xOffset	SalNumber	The horizontal offset to add to the current position.
yOffset	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.

OnBackColorChanged(e)

Copies the background color to both grid columns before raising the change event.

Parameter	Type	Description
e	EventArgs	The event data.

OnEnabledChanged(e)

Updates editability and cancels an active cell editor when the column is disabled.

Parameter	Type	Description
e	EventArgs	The event data.

OnFontChanged(e)

Copies the font to both grid columns before raising the change event.

Parameter	Type	Description
e	EventArgs	The event data.

OnForeColorChanged(e)

Copies the foreground color to both grid columns before raising the change event.

Parameter	Type	Description
e	EventArgs	The event data.

OnInvalidated(e)

Invalidates both grid columns before raising the invalidation event.

Parameter	Type	Description
e	InvalidateEventArgs	The invalidation event data.

OnParentChanged(e)

Resolves the owning table from the new parent before raising the parent-change event.

Parameter	Type	Description
e	EventArgs	The event data.

OnSizeChanged(e)

Copies the control width to both grid columns before raising the change event.

Parameter	Type	Description
e	EventArgs	The event data.

PixelsToFormUnits(numPixels, vertical)

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

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

Returns: SalNumber. The converted length in form units.

PopulateList(hSql, sSelect)

Replaces list items with tab-separated rows from a SQL result and calculates column tab stops.

Parameter	Type	Description
hSql	SalSqlHandle	The connected SQL handle used to execute and fetch results.
sSelect	SalString	The statement to prepare, or an empty value to execute the existing prepared statement.

Returns: SalBoolean. True after loading the result; false for an unsupported target or failed preparation or execution.

PopulateList(hSql, sSelect, errorHandler)

Loads SQL result rows into the list within a temporary SQL error-handler context.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle used to execute and fetch results.
sSelect	SalString	The statement to prepare, or an empty value to reuse the prepared statement.
errorHandler	WhenSqlErrorHandler	The SQL error callback active during population.

Returns: SalBoolean. True after loading the result; false for an unsupported target or failed preparation or execution.

PopulateListFiles(ctrlPath, pathName, attributes)

Replaces list items with matching files, directories, and drives.

Parameter	Type	Description
ctrlPath	Control	The control that receives the resolved directory path.
pathName	SalString	The directory and wildcard specification; receives the resulting file pattern.
attributes	SalNumber	Sys.FA_* flags controlling which entries are included.

Returns: SalBoolean. True after population; false when the target is unsupported or changing directory fails.

This operation can change the process current directory.

PostMessage(nMsg, nMywParam, nMylParam)

Posts a native Windows message to this control for asynchronous processing.

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

Returns: SalBoolean. True if the native message was posted; false for an unavailable or disposed control, or if posting fails.

QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)

Retrieves the value mapping of a check-box column.

Parameter	Type	Description
flags	SalNumber	Receives Sys.COL_CheckBox_IgnoreCase when enabled, or zero.
checkedValue	SalString	Receives the checked value.
uncheckedValue	SalString	Receives the unchecked value.

Returns: SalBoolean. True for a check-box column; otherwise false without changing the outputs.

QueryDropDownListColumn(flags, lines)

Retrieves the combo-box options for this column.

Parameter	Type	Description
flags	SalNumber	Receives the sorted, editable, and automatic-drop-down flags.
lines	SalNumber	Retained for compatibility; left unchanged.

Returns: SalBoolean. True for a combo-box column; otherwise false without changing the outputs.

QueryPopupEditColumn(flags, lines)

Retrieves the popup editor configuration.

Parameter	Type	Description
flags	SalNumber	Receives zero on success.
lines	SalNumber	Receives the configured popup line count.

Returns: SalBoolean. True for a popup-edit column; otherwise false without changing the outputs.

SendMessage(nMsg, nMywParam, nMylParam)

Sends a native Windows message to this control synchronously.

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

Returns: SalNumber. The native message result, or zero when the control is unavailable or disposed.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to this control's child windows and eligible descendants.

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

Returns: SalBoolean. True after dispatching; false when the parent is unavailable or disposed.

Traversal does not descend into embedded forms or user controls. Close and destroy messages for ordinary child controls are routed to their action handlers instead of their native window procedures.

SetBoundsCore(x, y, width, height, specified)

Applies designer bounds, or constrains the runtime control to zero location and height while retaining its width.

Parameter	Type	Description
x	Int32	The requested horizontal position.
y	Int32	The requested vertical position.
width	Int32	The requested width.
height	Int32	The requested height.
specified	BoundsSpecified	The bounds components being changed.

SetCellTextColor(color, discardable)

Sets the text color of this column in the current context row.

Parameter	Type	Description
color	SalNumber	The SAL color value.
discardable	SalBoolean	Retained for compatibility; ignored.

Returns: SalBoolean. The result of applying the cell-text color.

SetCellTextColor(color)

Sets the text color of this column in the current context row.

Parameter	Type	Description
color	SalNumber	The SAL color value.

Returns: SalBoolean. The result of applying the cell-text color.

SetColumnFlags(flags, set)

Sets or clears the specified column configuration flags.

Parameter	Type	Description
flags	SalNumber	The Sys.COL_* flags to change.
set	SalBoolean	True to set the flags; false to clear them.

Returns: SalBoolean. True after applying the flags.

SetColumnPosition(position)

Moves the column to a display position outside the locked-column region.

Parameter	Type	Description
position	SalNumber	The desired one-based position.

Returns: SalBoolean. False for a position below 1 or when either the source or destination is locked; otherwise true.

SetColumnTitle(title)

Changes the column-header text.

Parameter	Type	Description
title	SalString	The new title.

Returns: SalBoolean. True after assigning the title.

SetColumnWidth(width)

Sets the column width after converting horizontal form units to pixels.

Parameter	Type	Description
width	SalNumber	The requested width in form units.

Returns: SalBoolean. True after assigning the width.

SetContextMenu(sMenuName, nFlags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
sMenuName	SalString	The menu type name to resolve.
nFlags	SalNumber	Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu.

Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.

When called during a SAL context-menu action, the created menu is also shown at the current mouse position.

SetContextMenu(menuType, flags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
menuType	Type	The menu type to instantiate.
flags	SalNumber	Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu.

Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.

When called during a SAL context-menu action, the created menu is also shown at the current mouse position.

SetCursor(resource, type)

Loads a cursor resource and assigns it to the requested role.

Parameter	Type	Description
resource	SalResourceCursor	The cursor resource to load.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

SetCursor(resourceId, type)

Assigns a system cursor or a cursor identified by its native handle to the requested role.

Parameter	Type	Description
resourceId	Int32	A Sys.CURSOR_* identifier, or a native cursor handle represented as an integer.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

SetCursor(blob, type)

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

Parameter	Type	Description
blob	SalString	The cursor file data stored in a SAL binary string.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

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

SetCursorFile(file, type)

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

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

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

SetDataLength(length)

Sets the maximum input length.

Parameter	Type	Description
length	SalNumber	The character limit, or -1 to select the native unlimited setting.

Returns: SalBoolean. True when the target supports editing; otherwise, false.

SetFocus()

Moves keyboard focus to this control, deferring the change when SAL validation is in progress.

Returns: SalWindowHandle. The previously focused managed control as a SAL handle, or a null handle if the target is unavailable, a table column, an ActiveX host, disabled, or hidden.

SetFont(name, size, enhancement)

Creates and assigns a font to this control.

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

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

SetFormat(sPicture)

Assigns a display picture, translating encoded SAL numeric pictures when present.

Parameter	Type	Description
sPicture	SalString	The display picture to assign.

Returns: SalBoolean. True when the target supports formatting; this does not indicate whether its Format setter accepted the picture.

SetFormatCode(nFormat)

Applies a standard SAL picture, character casing, or password display setting.

Parameter	Type	Description
nFormat	SalNumber	The Sys.FMT_Format_* setting. FMT_Format_Picture leaves the existing picture unchanged.

Returns: SalBoolean. True when the setting is supported; otherwise, false.

SetInputMask(sMask)

Assigns the field input mask.

Parameter	Type	Description
sMask	SalString	The mask to apply.

Returns: SalBoolean. True when the target supports edit masks; otherwise, false.

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.

SetListRedraw(redraw)

Enables or disables native list repainting.

Parameter	Type	Description
redraw	SalNumber	The desired redraw state converted to a Boolean.

Returns: SalBoolean. True for an available target, including one without a native handle; otherwise, false.

Enabling redraw refreshes an existing list handle.

SetListSelectedIndex(index)

Replaces the current selection or applies a multi-selection sentinel.

Parameter	Type	Description
index	SalNumber	The item index. In multi-selection mode, -1 selects all and other invalid indices clear all. In single-selection mode, -1 clears selection.

Returns: SalBoolean. True for a processed multi-selection request or a successfully selected single item; false when clearing single selection or when the request is unsupported.

SetListSelectedItems(index, select)

Changes selected states in a multi-selection list.

Parameter	Type	Description
index	SalNumber	The item index, or -1 for all items.
select	SalBoolean	True to select; false to clear selection.

Returns: SalBoolean. True when the target supports multi-selection; otherwise, false. Invalid individual indices are ignored by SAL list controls.

SetListSelectedText(indexStart, text)

Finds and selects an item by its text prefix while suppressing SAL selection messages.

Parameter	Type	Description
indexStart	SalNumber	The index after which to begin searching, or -1 to search from the first item. The search can wrap.
text	SalString	The nonempty text prefix to find.

Returns: SalNumber. The matched index, or -1 when no match is found.

SetListTabStops(tabStops)

Sets the tab positions used to align tab-separated list text.

Parameter	Type	Description
tabStops	SalArray<SalNumber>	Tab positions expressed in horizontal form units.

Returns: SalBoolean. True when tab stops are assigned; false for an unsupported target or null array.

SetLocation(x, y)

Sets this control's location in form units.

Parameter	Type	Description
x	SalNumber	The new horizontal coordinate.
y	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(name, value, length)

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

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

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

SetSize(width, height)

Sets this control's dimensions in form units.

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

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

SetText(text)

Assigns the control's displayed text.

Parameter	Type	Description
text	SalString	The text to assign.

Returns: SalBoolean. True if the translated control exists and assignment completes; otherwise, false.

An empty string is passed as null when assigning combo-box text.

SetText(sValue, bFormat)

Assigns the field value through its typed value conversion.

Parameter	Type	Description
sValue	SalString	The text to assign.
bFormat	SalBoolean	Retained for compatibility; this argument is ignored.

Returns: SalBoolean. True when the target supports editing; otherwise, false.

SetTimer(idEvent, elapseMilliSec)

Creates or updates a native window timer for this control.

Parameter	Type	Description
idEvent	SalNumber	The timer identifier.
elapseMilliSec	SalNumber	The requested interval in milliseconds.

Returns: SalBoolean. True if the native timer was created; otherwise, false.

SetVisibleCore(value)

Synchronizes the column visibility flag and clears the focus cell when hiding this column.

Parameter	Type	Description
value	Boolean	True to show the column; false to hide it.

SetWindowColor(colorIndex, color)

Assigns a SAL window, table-cell, text, or transparent-image color.

Parameter	Type	Description
colorIndex	SalNumber	The Sys.COLOR_Index* component to update.
color	SalNumber	The SAL color value.

Returns: SalBoolean. True for a recognized color index and resolved control, even when the component does not apply to that control; otherwise, false.

Cell colors apply to table columns; window colors apply to other controls. Transparent colors require the SAL picture-control contract.

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.

Sort(flags)

Fetches all rows and sorts the main grid by this column if editing can finish.

Parameter	Type	Description
flags	SortFlags	The comparison and sort-direction options.

The grid selection events are suppressed during sorting, and a sort indicator is displayed afterward.

Sum(flagsOn, flagsOff)

Adds this column's numeric values over rows matching the specified flags.

Parameter	Type	Description
flagsOn	Int32	Row flags for which at least one must be set, or zero to omit this test.
flagsOff	Int32	Row flags that must all be clear.

Returns: Decimal. The total, or zero for a date/time column.

The original context row is restored when the operation finishes.

TrackPopupMenu(menuName, flags, x, y)

Creates and displays a temporary popup menu at screen coordinates.

Parameter	Type	Description
menuName	SalString	The menu type name to resolve.
flags	SalNumber	SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported.
x	SalNumber	The screen X coordinate, unless TPM_CursorX selects the cursor position.
y	SalNumber	The screen Y coordinate, unless TPM_CursorY selects the cursor position.

Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.

The previous context menu is restored after display and the temporary menu is queued for disposal.

TrackPopupMenu(menuType, flags, x, y)

Creates and displays a temporary popup menu at screen coordinates.

Parameter	Type	Description
menuType	Type	The menu type to instantiate.
flags	SalNumber	SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported.
x	SalNumber	The screen X coordinate, unless TPM_CursorX selects the cursor position.
y	SalNumber	The screen Y coordinate, unless TPM_CursorY selects the cursor position.

Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.

The previous context menu is restored after display and the temporary menu is queued for disposal.

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 data type and applies the display format, showing an error dialog if validation fails.

Returns: SalBoolean. True when validation succeeds; otherwise, false.

Validate(validate)

Validates the data type and applies the display format on success.

Parameter	Type	Description
validate	SalNumber	Use Sys.FMT_Validate_Dialog to display a validation error dialog; other values suppress it.

Returns: SalBoolean. True when validation succeeds; otherwise, false.

WinHelp(file, command, numData, strData)

Invokes the legacy Windows Help API for this control.

Parameter	Type	Description
file	SalString	The help file path.
command	SalNumber	The Sys.HELP_* command.
numData	SalNumber	The numeric topic or index for HELP_Context and HELP_SetIndex.
strData	SalString	The lookup text for HELP_Key.

Returns: SalBoolean. The native help result, or false for an empty file name.

WndProc(m)

Routes the native window message through the SAL window implementation.

Parameter	Type	Description
m	Message	The message to process, including its mutable result.

Yield()

Dispatches one pending message for this window, or processes application messages when no window handle exists.

Message dispatch can reenter application code.

Events

MessageActions

SalMessageHandler Provides the legacy SAL message-handler event.

Use WindowActions for new handlers.

WindowActions

WindowActionsEventHandler Occurs when this control dispatches a SAL or custom window action.

Implements

Name	Description
ISalControl	Provides access to a SAL control's typed value, associated label, and modification state.
ISalEditControl	Extends the SAL control contract with validation, display formatting, edit masks, and culture settings.
ISalListControl	Provides SAL list operations over list-box and combo-box items and selections.
ISalWindow	Exposes SAL message dispatch and runtime metadata for child controls, forms, dialogs, and MDI windows.