Version: 2025

SalWindowHandle

Namespace: PPJ.Runtime

Assembly: PPJ.Web.50 (5.0.0.0)

Represents a SAL handle and exposes operations on the associated window or control.

C#
VB.NET

public struct SalWindowHandle : ValueType, IConvertible, IComparable, ISalType, ISerializable, IXmlSerializable, IWisejSerializable

Public Structure SalWindowHandle
    Implements ValueType, IConvertible, IComparable, ISalType, ISerializable, IXmlSerializable, IWisejSerializable

Stores a Wisej handle identifier. Control lookup is performed when an operation needs the control; a nonzero value alone does not establish that a control is still available.

Example:

using PPJ.Runtime;

void SetCaption(Wisej.Web.Control control)
{
    SalWindowHandle window = control;
    if (!window.IsNull)
        window.SetText("Ready");
}

Constructors

SalWindowHandle(handle)

Initializes a SAL window handle from an identifier.

Name	Type	Description
handle	IntPtr	The handle value, including zero.

Stores the identifier without validating it.

SalWindowHandle(ctrl)

Initializes a handle for the actual derived control.

Name	Type	Description
ctrl	Control	The control to wrap, or null for a zero handle.

Stores the derived control's handle.

Properties

Control

Control: Gets the control currently associated with the handle.

IsNull

Boolean: Gets whether the current handle value is zero.

Value

IntPtr: Gets the current pointer-sized handle value.

Methods

AddListItem(sName)

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

AnyRows(nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

ClearImage()

Clears the image assigned to the associated control.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

ClearList()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ClearSelection()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ColumnAverage(nColumnID, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nColumnID	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

ColumnSum(nColumnID, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nColumnID	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

CompareTo(obj)

Compares this handle with a boxed SAL window handle.

Parameter	Type	Description
obj	Object	A boxed SalWindowHandle.

Returns: Int32. The result of comparing the two handle identifiers as signed 32-bit integers.

A null argument or a different boxed type cannot be cast to SalWindowHandle. Large native identifiers can overflow the 32-bit conversion.

CompareTo(handle)

Compares handle identifiers as signed 32-bit integers.

Parameter	Type	Description
handle	SalWindowHandle	The handle to compare.

Returns: Int32. A negative value, zero, or a positive value when this identifier precedes, equals, or follows the argument.

The conversion can overflow for native identifiers outside the 32-bit range.

CopyRows(nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

Parameter	Type	Description
nColumnPos	SalNumber
nDispWidth	SalNumber
nMaxChars	SalNumber
sTitle	SalString

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)

Parameter	Type	Description
nColumnPos	SalNumber
nDispWidth	SalNumber
sTitle	SalString
nMaxChars	SalNumber
nDatatype	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

DefineCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)

Parameter	Type	Description
nFlags	SalNumber
sCheckedValue	SalString
sUncheckedValue	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DefineDropDownListColumn(nFlags, nLines)

Parameter	Type	Description
nFlags	SalNumber
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DefinePopupEditColumn(nFlags, nLines)

Parameter	Type	Description
nFlags	SalNumber
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DefineRowHeader(sTitle, nWidth, nFlags, column)

Parameter	Type	Description
sTitle	SalString
nWidth	SalNumber
nFlags	SalNumber
column	Control

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter	Type	Description
nRowsLowerHalf	SalNumber
bDragAdjust	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DeleteListItem(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

DeleteRow(nRow, nFlag)

Parameter	Type	Description
nRow	SalNumber
nFlag	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DeleteSelected(hSql)

Parameter	Type	Description
hSql	SalSqlHandle

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DeleteSelected(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DestroyColumns()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

DoDeletes(hSql, nFlagsOn)

Parameter	Type	Description
hSql	SalSqlHandle
nFlagsOn	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DoDeletes(hSql, nFlagsOn, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
nFlagsOn	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DoInserts(hSql, bClearFlags)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DoInserts(hSql, bClearFlags, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DoUpdates(hSql, bClearFlags)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DoUpdates(hSql, bClearFlags, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

DrawMenuBar()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

EndDialog(nReturn)

Parameter	Type	Description
nReturn	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

FetchRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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.

FindControl(name)

Parameter	Type	Description
name	String

Returns: Control.

Applies the referenced operation to the control represented by this handle.

FindMember(name)

Parameter	Type	Description
name	String

Returns: ReferenceInfo.

Applies the referenced operation to the control represented by this handle.

FindNextRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

FindPrevRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)

Parameter	Type	Description
nMsg	Int32
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

GetCellType(nType)

Parameter	Type	Description
nType	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetCellType()

Returns the cell-type code of the associated table column.

Returns: SalNumber. The cell-type code, or zero if the handle does not resolve to a table column.

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.

GetColumnFlags(nFlags)

Parameter	Type	Description
nFlags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetColumnID()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetColumnPosition()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetColumnText(nColumnID, sText)

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetColumnText(nColumnID)

Returns the value text for a column in the table's current context row.

Parameter	Type	Description
nColumnID	SalNumber	The column identifier.

Returns: SalString. The column text, or SAL null when this handle does not resolve to a table.

GetColumnTitle(sText, nMaxLen)

Parameter	Type	Description
sText	SalString
nMaxLen	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetColumnTitle(nMaxLen)

Returns the title of the associated table column.

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

Returns: SalString. The column title, or SAL null if the handle does not resolve to a table column.

GetColumnWidth(nFormUnits)

Parameter	Type	Description
nFormUnits	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetColumnWidth()

Returns the width of the associated table column in form units.

Returns: SalNumber. The column width, or zero if the handle does not resolve to a table column.

GetColumnWindow(nCol, nFlags)

Parameter	Type	Description
nCol	SalNumber
nFlags	SalNumber

Returns: SalWindowHandle.

Applies the referenced operation to the control represented by this handle.

GetContextRow()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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 operation to the control represented by this handle.

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.

GetDefaultButton()

Returns: SalWindowHandle.

Applies the referenced operation to the control represented by this handle.

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 display format of an edit-capable control.

Parameter	Type	Description
sPicture	SalString	Receives the format on success; unchanged if no format is available.

Returns: SalBoolean. True if a non-null format was obtained; otherwise, false.

GetFormat()

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

GetFormatCode()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetFormattedText(sText, bFormat)

Retrieves the control text with optional display formatting.

Parameter	Type	Description
sText	SalString	Receives the result when text is available; unchanged otherwise.
bFormat	SalBoolean	True to apply display formatting; false to request the underlying text.

Returns: SalBoolean. True if text was obtained; otherwise, false.

GetFormattedText(bFormat)

Parameter	Type	Description
bFormat	SalBoolean

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

GetImageBytes(sImageBytes, nType)

Encodes the current image as binary data and reports its format.

Parameter	Type	Description
sImageBytes	SalString	Receives the image data, or a null-valued buffer when no image is available.
nType	SalNumber	Receives the image-type code.

Returns: SalNumber. The byte count, or zero when no image data is available.

GetImageDescription(sDesc, nMaxLen)

Retrieves the Gupta image-format description.

Parameter	Type	Description
sDesc	SalString	Receives the description, or an empty string if no image is available.
nMaxLen	SalNumber	The maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

GetImageDescription(nMaxLen)

Retrieves the Gupta image-format description.

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

Returns: SalString. The truncated description, or an empty string if no image is available.

GetImageString(nFormat, sPict)

Encodes the current image in a requested SAL image representation.

Parameter	Type	Description
nFormat	SalNumber	The PIC_Format* encoding selector.
sPict	SalString	Receives the encoded image data.

Returns: SalNumber. The number of encoded bytes.

The object format includes a Gupta header and requires an available image. Other formats can return an empty blob when no image is available.

GetImageString(nFormat)

Encodes the current image in a requested SAL image representation.

Parameter	Type	Description
nFormat	SalNumber	The PIC_Format* encoding selector.

Returns: SalString. The encoded image buffer.

The object format includes a Gupta header and requires an available image. Other formats can return an empty blob when no image is available.

GetInputMask(sMask)

Retrieves the input mask of an edit-capable control.

Parameter	Type	Description
sMask	SalString	Receives the input mask when accepted; unchanged when the method returns false.

Returns: SalBoolean. False for an empty mask; otherwise, true. An unsupported control produces a SAL null mask and true.

GetInputMask()

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

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.

GetLinesPerRow(nLines)

Parameter	Type	Description
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetLinesPerRow()

Returns the configured number of display lines per table row.

Returns: SalNumber. The line count, or zero if this handle does not resolve to a table.

GetListItemsCount()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetListItemState(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetListItemText(nIndex, sText)

Parameter	Type	Description
nIndex	SalNumber
sText	SalString

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetListItemText(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

GetListItemTextLength(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetListSelectedFile(sFileName)

Parameter	Type	Description
sFileName	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetListSelectedFile()

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

GetListSelectedIndex()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetListSelectedItems(nSelectedArray)

Parameter	Type	Description
nSelectedArray	SalArray<SalNumber>

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetListSelectedItemsCount()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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.

GetLockedColumns()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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.

GetObjectData(info, context)

Serializes the current handle identifier.

Parameter	Type	Description
info	SerializationInfo	Receives the Handle entry.
context	StreamingContext	The serialization context; not used by this implementation.

The data records a runtime identifier, not a portable description of a window.

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.

GetRowFlags(nRow, nFlags)

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

GetScrollBarPosition(nPos)

Retrieves the position of the associated scrolling control.

Parameter	Type	Description
nPos	SalNumber	Receives the current position, or zero for a control of a different type.

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

Uses a Wisej TrackBar.

GetScrollBarPosition()

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

GetScrollBarRange(nMin, nMax, nLine, nPage)

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber
nLine	SalNumber
nPage	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

GetStatusBarText(sText, nMaxLen)

Reads the owning form's status-bar text.

Parameter	Type	Description
sText	SalString	Receives the truncated status text, or an empty string if no status bar is found.
nMaxLen	SalNumber	The maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

GetStatusBarText(nMaxLen)

Reads the owning form's status-bar text.

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

Returns: SalString. The truncated text, or an empty string if no status bar is found.

GetTableFlags(nFlags)

Parameter	Type	Description
nFlags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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 control text with input-mask literals removed.

Parameter	Type	Description
sText	SalString	Receives the unmasked text on success; unchanged when the control is unavailable.

Returns: SalBoolean. True if the control was available; otherwise, false.

GetTextUnmasked()

Returns: SalString.

Applies the referenced operation to the control represented by this handle.

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.

HitTest(nX, nY, nRow, hWndCol, nFlags)

Parameter	Type	Description
nX	SalNumber
nY	SalNumber
nRow	SalNumber
hWndCol	SalWindowHandle
nFlags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

InsertListItem(nIndex, sAdd)

Parameter	Type	Description
nIndex	SalNumber
sAdd	SalString

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

InsertRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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.

IsChecked()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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 operation to the control represented by this handle.

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 operation to the control represented by this handle.

IsValidDateTime()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

IsValidDecimal(nPrecision, nScale)

Parameter	Type	Description
nPrecision	SalNumber
nScale	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

IsValidInteger()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

IsValidNumber()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

KillCellEdit()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

KillFocusRow()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

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.

PasteRows()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

Populate(hSql, sSelect, nMethod)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

Populate(hSql, sSelect, nMethod, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

Populate(hSql, sSelect)

Populates the associated table from a query using TBL_FillAll.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle to execute the query.
sSelect	SalString	The SELECT statement.

Returns: SalBoolean. The status returned by Sal.TblPopulate for the query.

Uses TBL_FillAll as the population method.

Populate(hSql, sSelect, errorHandler)

Populates the associated table from a query using TBL_FillAll.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle to execute the query.
sSelect	SalString	The SELECT statement.
errorHandler	WhenSqlErrorHandler	The SQL error callback used by the population operation.

Returns: SalBoolean. The status returned by Sal.TblPopulate for the query.

Uses TBL_FillAll as the population method.

PopulateList(hSql, sSelect)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

PopulateList(hSql, sSelect, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

PopulateListFiles(ctrlPath, sPathName, nAttributes)

Parameter	Type	Description
ctrlPath	Control
sPathName	SalString
nAttributes	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

QueryCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)

Parameter	Type	Description
nFlags	SalNumber
sCheckedValue	SalString
sUncheckedValue	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryDropDownListColumn(nFlags, nLines)

Parameter	Type	Description
nFlags	SalNumber
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryFocusCell(nRow, hWndCol)

Parameter	Type	Description
nRow	SalNumber
hWndCol	SalWindowHandle

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryPopupEditColumn(nFlags, nLines)

Parameter	Type	Description
nFlags	SalNumber
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryRowHeader(sTitle, nMaxTitle, nWidth, nFlags, hWndCol)

Parameter	Type	Description
sTitle	SalString
nMaxTitle	SalNumber
nWidth	SalNumber
nFlags	SalNumber
hWndCol	SalWindowHandle

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryScroll(nPosition, nMinRange, nMaxRange)

Parameter	Type	Description
nPosition	SalNumber
nMinRange	SalNumber
nMaxRange	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QuerySplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter	Type	Description
nRowsLowerHalf	SalNumber
bDragAdjust	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

QueryVisibleRange(nMinRange, nMaxRange)

Parameter	Type	Description
nMinRange	SalNumber
nMaxRange	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ResetTable()

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ScrollRow(nRow, column, nFlags)

Parameter	Type	Description
nRow	SalNumber
column	Control
nFlags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ScrollRow(nRow, column)

Parameter	Type	Description
nRow	SalNumber
column	Control

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SetCellTextColor(nColor, bDiscardable)

Parameter	Type	Description
nColor	SalNumber
bDiscardable	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetCellTextColor(nColor)

Parameter	Type	Description
nColor	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetChecked(value)

Parameter	Type	Description
value	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnFlags(nFlags, bSet)

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnPos(nPos)

Parameter	Type	Description
nPos	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnPosition(nPos)

Parameter	Type	Description
nPos	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnText(nColumnID, sText)

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnTitle(sTitle)

Parameter	Type	Description
sTitle	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetColumnWidth(nFormUnits)

Parameter	Type	Description
nFormUnits	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetContextMenu(menuName, flags)

Parameter	Type	Description
menuName	SalString
flags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetContextMenu(menuType, flags)

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetContextRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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 operation to the control represented by this handle.

SetDefaultButton()

Sets this button as the containing form's accept button.

Returns: SalBoolean. True if a compatible button and containing form are available; otherwise, false.

SetFlagsAnyRows(nFlags, bSet, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SetFocusCell(nRow, column)

Parameter	Type	Description
nRow	SalNumber
column	Control

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetFocusRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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 operation to the control represented by this handle.

SetFormatCode(nFormat)

Parameter	Type	Description
nFormat	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetImageBytes(sImageBytes, nType)

Decodes image bytes and assigns the resulting image.

Parameter	Type	Description
sImageBytes	SalString	The encoded image data.
nType	SalNumber	The SAL image-format code passed to the decoder.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

SetImageFile(sFileName)

Loads and assigns an image from a file.

Parameter	Type	Description
sFileName	SalString	The file path, or an empty value to clear the image.

Returns: SalBoolean. True if assignment succeeds; false if the control does not support images or a file I/O error is caught.

SetImageFit(nFit, nScaleWidth, nScaleHeight)

Deprecated: SetImageFit(nFit, nScaleWidth, nScaleHeight) is deprecated, use SetImageFit(nFit) Sets how a picture is fitted within its control.

Parameter	Type	Description
nFit	SalNumber	The PIC_Fit* fitting mode.
nScaleWidth	SalNumber	Reserved for compatibility; ignored.
nScaleHeight	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. True for a supported picture control; otherwise, false.

The Web implementation uses the fitting mode only.

SetImageFit(nFit)

Sets how a picture is fitted within its control.

Parameter	Type	Description
nFit	SalNumber	The PIC_Fit* fitting mode.

Returns: SalBoolean. True for a supported picture control; otherwise, false.

The Web implementation uses the fitting mode only.

SetImageHandle(nType, nHandle)

Assigns an image identified by a native icon or bitmap handle.

Parameter	Type	Description
nType	SalNumber	PIC_FormatIcon for an icon; other values use the bitmap path.
nHandle	SalNumber	The native handle, or zero to clear the image.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

SetImageResource(tResource, nFormat)

Loads an image from a SAL resource and assigns it to the control.

Parameter	Type	Description
tResource	SalResource	The image resource to load.
nFormat	SalNumber	The image-format selector passed to the picture implementation.

Returns: SalBoolean. True if the image can be assigned to the control; otherwise, false.

SetImageString(nFormat, sPicture)

Decodes a SAL image buffer and assigns the resulting image.

Parameter	Type	Description
nFormat	SalNumber	The SAL image-format code.
sPicture	SalString	The encoded image buffer.

Returns: SalBoolean. True if the control supports image assignment; otherwise, false.

SetInputMask(sMask)

Parameter	Type	Description
sMask	SalString

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SetLinesPerRow(nLines)

Parameter	Type	Description
nLines	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetListSelectedIndex(nIndex)

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetListSelectedItems(nIndex, bSelect)

Parameter	Type	Description
nIndex	SalNumber
bSelect	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetListSelectedText(nIndexStart, sText)

Parameter	Type	Description
nIndexStart	SalNumber
sText	SalString

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

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.

SetLockedColumns(nLockedColumns)

Parameter	Type	Description
nLockedColumns	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SetRange(nMin, nMax)

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetRow(nRowPos)

Parameter	Type	Description
nRowPos	SalNumber

Returns: SalNumber.

Applies the referenced operation to the control represented by this handle.

SetRowFlags(nRow, nFlags, bSet)

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetScrollBarPosition(nPos)

Parameter	Type	Description
nPos	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

SetScrollBarRange(nMin, nMax, nLine, nPage)

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber
nLine	SalNumber
nPage	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SetStatusBarText(sText)

Assigns text to an available status bar of the owning form.

Parameter	Type	Description
sText	SalString	The status text to display.

Returns: SalBoolean. True after the request is processed, including when no suitable status bar is found.

SetTableFlags(nFlags, bSet)

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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 operation to the control represented by this handle.

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.

ShowStatusBar(bShow)

Parameter	Type	Description
bShow	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ShowToolBar(bShow)

Parameter	Type	Description
bShow	SalBoolean

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

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.

SortRows(nColumnID, nOrder)

Parameter	Type	Description
nColumnID	SalNumber
nOrder	SalNumber

Returns: SalBoolean.

Applies the referenced operation to the control represented by this handle.

ToControl()

Returns the control associated with the handle.

Returns: Control. The Wisej control resolved from the handle, or null for zero, the broadcast sentinel, or an unresolved identifier.

ToInt32()

Returns the handle as a 32-bit integer.

Returns: Int32. The handle identifier converted to a signed 32-bit integer.

On a 64-bit process, a handle outside the Int32 range can cause OverflowException.

ToIntPtr()

Returns the handle as a pointer-sized identifier.

Returns: IntPtr. The stored handle identifier.

ToNumber()

Returns the handle as a SAL number.

Returns: SalNumber. A SalNumber containing the pointer-sized identifier.

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

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

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

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

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

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

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

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

UpdateWindow()

Requests an update of this control.

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

Validate()

Validates the edit control's data type and applies its format on success.

Returns: SalBoolean. True when validation succeeds; false for invalid data or an unsupported control.

Shows the invalid-data message when validation fails.

Validate(nValidate)

Validates the edit control's data type and applies its format on success.

Parameter	Type	Description
nValidate	SalNumber	FMT_Validate_Dialog to show the invalid-data message; other values suppress it.

Returns: SalBoolean. True when validation succeeds; false for invalid data or an unsupported control.

Used By

Name	Description
Sal.AppFind	Retains application-window lookup for compatibility.
Sys.hWndItem	Identifies the control currently receiving SAL message actions.
Sys.hWndForm	Identifies the form or dialog in the current SAL message context.
Sys.hWndMDI	Identifies the MDI window in the current SAL message context.
Sys.hWndFocus	Identifies the focused control recorded for the current user session.
SalNumber.ToWindowHandle	Wraps the pointer-sized integer representation as a SAL window handle.
SalWindowHandle.CompareTo	Compares handle identifiers as signed 32-bit integers.
SalWindowHandle.GetDefaultButton
SalBackgroundText.FindChild	Searches this window for a child control by name.
SalCheckBox.FindChild	Searches this window for a child control by name.
SalComboBox.FindChild	Searches this window for a child control by name.
SalCustomControl.FindChild
SalDataField.FindChild	Searches this window for a child control by name.
SalFrame.FindChild	Searches this window for a child control by name.
SalGroupBox.FindChild	Searches this window for a child control by name.
SalHorizontalScrollBar.FindChild	Searches this window for a child control by name.
SalLine.FindChild	Searches this window for a child control by name.
SalListBox.FindChild	Searches this window for a child control by name.
SalMultilineField.FindChild	Searches this window for a child control by name.
SalNavigationBar.FindChild	Searches this window for a child control by name.
SalOptionButton.FindChild	Searches this window for a child control by name.
SalPicture.FindChild	Searches this window for a child control by name.
SalPushbutton.FindChild	Searches this window for a child control by name.
SalRadioButton.FindChild	Searches this window for a child control by name.
SalTreeControl.FindChild
SalUserControl.FindChild	Searches this window for a child control by name.
SalVerticalScrollBar.FindChild	Searches this window for a child control by name.
SalForm.GetDefaultButton
SalFormTableWindow.GetColumnWindow
SalWindow.FromHandle	Resolves a SAL window handle and casts the translated control through SAL inheritance rules.
SalWindow.GetFocus	Resolves the focused SAL control from the active form and nested active containers.
SalTableColumn.FindChild	Searches this window for a child control by name.
SalTableWindow.GetColumnWindow	Finds a column handle by display position or identifier.
WindowActionsEventArgs.hWnd	Gets the target window handle captured when the event data was created.
SalQuickTabs.ShowWindow	Removes a control from the explicit hidden set and applies its current-tab visibility.
SalQuickTabs.ShowWindowAndLabel	Removes a control and its label from the hidden set and reapplies tab visibility.
SalQuickTabs.HideWindow	Hides a control and keeps it hidden across tab changes.
SalQuickTabs.IsWindowVisible	Tests whether a control is present in the frame's explicitly hidden set.
SalQuickTabs.HideWindowAndLabel	Hides a control and its label across tab changes.
SalQuickTabs.FindTabFrame	Finds the first QuickTabs frame within a form's child traversal.
SalQuickTabsDialog.FromHandle	Resolves a SAL window handle to an existing SalQuickTabsDialog.
SalQuickTabsForm.FromHandle	Resolves a SAL window handle to an existing SalQuickTabsForm.
SalQuickTabsParent.TabCreate	Handles notification that a QuickTabs frame has been created.
SalQuickTabsParent.TabActivateStart	Handles tab activation before associated children are shown.
SalQuickTabsParent.TabActivateFinish	Handles tab activation after associated children are shown.
SalQuickTabsParent.TabUserRequest	Handles a user request to change tabs.
SalQuickTabsParent.TabFrameResize	Resizes bound pages using their stored bounds after a frame size change.
SalQuickTabsParent.TabSetFormPageSize	Sets bound form-page bounds to the frame's display rectangle.
SalQuickTabsParent.FromHandle	Resolves a SAL window handle to an existing SalQuickTabsParent.
Sql.ContextSetToForm
Vis.MenuGetSystemHandle
Vis.WinGetFlags
Vis.WinGetHandle
VisCalendar.FromHandle
VisCalendar.FindChild
VisCalendarDropDown.FromHandle
VisCalendarDropDown.FindChild
VisColorComboBox.FromHandle
VisColorListBox.FromHandle
VisComboBoxBase.DragDrop
VisDesktopListBox.FromHandle
VisDirListBox.FromHandle
VisDirTreeListBox.FromHandle
VisDriveComboBox.FromHandle
VisDriveListBox.FromHandle
VisFileListBox.FromHandle
VisFontComboBox.FromHandle
VisFontListBox.FromHandle
VisFontNameComboBox.FromHandle
VisFontNameListBox.FromHandle
VisListBoxBase.DragDrop
VisListBoxExtension.FromHandle
VisListView.FromHandle
VisListView.FindChild
VisListViewDropDown.FromHandle
VisMeter.FromHandle
VisMeter.FindChild
VisOutlineComboBox.FromHandle
VisOutlineComboBox.DragDrop
VisOutlineListBox.FromHandle
VisOutlineListBox.DoDragDrop
VisOutlineListBox.FindChild
VisPictureComboBox.FromHandle
VisPictureListBox.FromHandle
VisRadioListBox.FromHandle
VisSpinField.FromHandle
VisSpinField.FindChild
VisSplitter.FromHandle
VisSplitter.FindChild
VisSplitterWindow.FromHandle
XSal.GetClientWindow
XSalFlatButton.FromHandle
XSalHSplitter.FromHandle
XSalHSplitter.GetTopFrame
XSalSplitter.FromHandle
XSalSplitter.FindChild
XSalToolbox.FromHandle
XSalVSplitter.FromHandle
XSalVSplitter.GetLeftFrame

Constructors
- SalWindowHandle(handle)
- SalWindowHandle(ctrl)
Properties
Methods
Used By

Constructors​

SalWindowHandle(handle)​

SalWindowHandle(ctrl)​

Properties​

Control​

IsNull​

Value​

Methods​

AddListItem(sName)​

AnyRows(nFlagsOn, nFlagsOff)​

BringWindowToTop()​

CenterWindow()​

Clear()​

ClearCursor(nType)​

ClearImage()​

ClearList()​

ClearSelection()​

ColumnAverage(nColumnID, nFlagsOn, nFlagsOff)​

ColumnSum(nColumnID, nFlagsOn, nFlagsOff)​

CompareTo(obj)​

CompareTo(handle)​

CopyRows(nFlagsOn, nFlagsOff)​

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)​

CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)​

DefineCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)​

DefineDropDownListColumn(nFlags, nLines)​

DefinePopupEditColumn(nFlags, nLines)​

DefineRowHeader(sTitle, nWidth, nFlags, column)​

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)​

DeleteListItem(nIndex)​

DeleteRow(nRow, nFlag)​

DeleteSelected(hSql)​

DeleteSelected(hSql, errorHandler)​

DestroyColumns()​

DestroyWindow()​

DisableWindow()​

DisableWindowAndLabel()​

DoDeletes(hSql, nFlagsOn)​

DoDeletes(hSql, nFlagsOn, errorHandler)​

DoInserts(hSql, bClearFlags)​

DoInserts(hSql, bClearFlags, errorHandler)​

DoUpdates(hSql, bClearFlags)​

DoUpdates(hSql, bClearFlags, errorHandler)​

DrawMenuBar()​

EnableWindow()​

EnableWindowAndLabel()​

EndDialog(nReturn)​

FetchRow(nRow)​

FindChild(sWindowName)​

FindControl(name)​

FindMember(name)​

FindNextRow(nRow, nFlagsOn, nFlagsOff)​

FindPrevRow(nRow, nFlagsOn, nFlagsOff)​

FireWindowActions(nMsg, nMywParam, nMylParam)​

FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)​

FormUnitsToPixels(nFormUnits, bVertical)​

GetCellType(nType)​

GetCellType()​

GetClassName()​

GetColumnFlags(nFlags)​

GetColumnID()​

GetColumnPosition()​

GetColumnText(nColumnID, sText)​

GetColumnText(nColumnID)​

GetColumnTitle(sText, nMaxLen)​

GetColumnTitle(nMaxLen)​

GetColumnWidth(nFormUnits)​

GetColumnWidth()​

GetColumnWindow(nCol, nFlags)​

GetContextRow()​

GetControlType()​

GetDataLength()​

GetDataType()​

GetDefaultButton()​

GetFirstChild(nTypeMask)​

GetFont(sName, nSize, nEnhancement)​

GetFormat(sPicture)​

GetFormat()​

GetFormatCode()​

GetFormattedText(sText, bFormat)​

Constructors

SalWindowHandle(handle)

SalWindowHandle(ctrl)

Properties

Control

IsNull

Value

Methods

AddListItem(sName)

AnyRows(nFlagsOn, nFlagsOff)

BringWindowToTop()

CenterWindow()

Clear()

ClearCursor(nType)

ClearImage()

ClearList()

ClearSelection()

ColumnAverage(nColumnID, nFlagsOn, nFlagsOff)

ColumnSum(nColumnID, nFlagsOn, nFlagsOff)

CompareTo(obj)

CompareTo(handle)

CopyRows(nFlagsOn, nFlagsOff)

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)

DefineCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)

DefineDropDownListColumn(nFlags, nLines)

DefinePopupEditColumn(nFlags, nLines)

DefineRowHeader(sTitle, nWidth, nFlags, column)

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

DeleteListItem(nIndex)

DeleteRow(nRow, nFlag)

DeleteSelected(hSql)

DeleteSelected(hSql, errorHandler)

DestroyColumns()

DestroyWindow()

DisableWindow()

DisableWindowAndLabel()

DoDeletes(hSql, nFlagsOn)

DoDeletes(hSql, nFlagsOn, errorHandler)

DoInserts(hSql, bClearFlags)

DoInserts(hSql, bClearFlags, errorHandler)

DoUpdates(hSql, bClearFlags)

DoUpdates(hSql, bClearFlags, errorHandler)

DrawMenuBar()

EnableWindow()

EnableWindowAndLabel()

EndDialog(nReturn)

FetchRow(nRow)

FindChild(sWindowName)

FindControl(name)

FindMember(name)

FindNextRow(nRow, nFlagsOn, nFlagsOff)

FindPrevRow(nRow, nFlagsOn, nFlagsOff)

FireWindowActions(nMsg, nMywParam, nMylParam)

FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)

FormUnitsToPixels(nFormUnits, bVertical)

GetCellType(nType)

GetCellType()

GetClassName()

GetColumnFlags(nFlags)

GetColumnID()

GetColumnPosition()

GetColumnText(nColumnID, sText)

GetColumnText(nColumnID)

GetColumnTitle(sText, nMaxLen)

GetColumnTitle(nMaxLen)

GetColumnWidth(nFormUnits)

GetColumnWidth()

GetColumnWindow(nCol, nFlags)

GetContextRow()

GetControlType()

GetDataLength()

GetDataType()

GetDefaultButton()

GetFirstChild(nTypeMask)

GetFont(sName, nSize, nEnhancement)

GetFormat(sPicture)

GetFormat()

GetFormatCode()

GetFormattedText(sText, bFormat)