Skip to main content

SalWindowHandle

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.50 (5.0.0.0)

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

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

Stores a raw handle or a weak reference to a managed control. The weak reference does not keep a control alive. Window operations resolve the current control or a native-control adapter.

Example:

using PPJ.Runtime;

void SetCaption(System.Windows.Forms.Control control)
{
SalWindowHandle window = control;
if (!window.IsNull)
window.SetText("Ready");
}

Constructors

Instance member SalWindowHandle(handle)

Initializes a SAL window handle from an identifier.

NameTypeDescription
handleIntPtrThe handle value, including zero.

Captures a weak reference when the handle resolves to a managed control; otherwise, retains the raw identifier.

Instance member SalWindowHandle(ctrl)

Initializes a handle for the actual derived control.

NameTypeDescription
ctrlControlThe control to wrap, or null for a zero handle.

Stores a weak reference to the derived control.

Properties

Instance member Control

Control: Gets the control currently associated with the handle.

Instance member IsNull

Boolean: Gets whether the current handle value is zero.

Instance member Value

IntPtr: Gets the current pointer-sized handle value.

Methods

Instance member AddListItem(sName)

ParameterTypeDescription
sNameSalString

Returns: SalNumber.

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

Instance member AnyRows(flagsOn, flagsOff)

ParameterTypeDescription
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

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

Instance member BringWindowToTop()

Returns: SalBoolean.

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

Instance member CenterWindow()

Returns: SalBoolean.

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

Instance member Clear()

Returns: SalBoolean.

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

Instance member ClearCursor(type)

ParameterTypeDescription
typeSalNumber

Returns: SalBoolean.

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

Instance member ClearImage()

Clears the image assigned to the associated control.

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

Instance member ClearList()

Returns: SalBoolean.

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

Instance member ClearSelection()

Returns: SalBoolean.

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

Instance member ColumnAverage(nColumnID, flagsOn, flagsOff)

ParameterTypeDescription
nColumnIDSalNumber
flagsOnSalNumber
flagsOffSalNumber

Returns: SalNumber.

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

Instance member ColumnSum(columnId, flagsOn, flagsOff)

ParameterTypeDescription
columnIdSalNumber
flagsOnSalNumber
flagsOffSalNumber

Returns: SalNumber.

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

Instance member CompareTo(obj)

Compares this handle with a boxed SAL window handle.

ParameterTypeDescription
objObjectA 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.

Instance member CompareTo(handle)

Compares handle identifiers as signed 32-bit integers.

ParameterTypeDescription
handleSalWindowHandleThe 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.

Instance member CopyRows(flagsOn, flagsOff)

ParameterTypeDescription
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

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

Instance member CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

ParameterTypeDescription
nColumnPosSalNumber
nDispWidthSalNumber
nMaxCharsSalNumber
sTitleSalString

Returns: SalNumber.

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

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

ParameterTypeDescription
nColumnPosSalNumber
nDispWidthSalNumber
sTitleSalString
nMaxCharsSalNumber
nDatatypeSalNumber

Returns: SalNumber.

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

Instance member DefineCheckBoxColumn(flags, checkedValue, uncheckedValue)

ParameterTypeDescription
flagsSalNumber
checkedValueSalString
uncheckedValueSalString

Returns: SalBoolean.

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

Instance member DefineDropDownListColumn(flags, lines)

ParameterTypeDescription
flagsSalNumber
linesSalNumber

Returns: SalBoolean.

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

Instance member DefinePopupEditColumn(flags, lines)

ParameterTypeDescription
flagsSalNumber
linesSalNumber

Returns: SalBoolean.

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

Instance member DefineRowHeader(title, width, flags, column)

ParameterTypeDescription
titleSalString
widthSalNumber
flagsSalNumber
columnControl

Returns: SalBoolean.

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

Instance member DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

ParameterTypeDescription
nRowsLowerHalfSalNumber
bDragAdjustSalBoolean

Returns: SalBoolean.

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

Instance member DeleteListItem(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

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

Instance member DeleteRow(nRow, nFlag)

ParameterTypeDescription
nRowSalNumber
nFlagSalNumber

Returns: SalBoolean.

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

Instance member DeleteSelected(hSql)

ParameterTypeDescription
hSqlSalSqlHandle

Returns: SalBoolean.

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

Instance member DeleteSelected(hSql, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member DestroyColumns()

Returns: SalBoolean.

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

Instance member DestroyWindow()

Returns: SalBoolean.

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

Instance member DisableWindow()

Returns: SalBoolean.

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

Instance member DisableWindowAndLabel()

Returns: SalBoolean.

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

Instance member DoDeletes(hSql, flagsOn)

ParameterTypeDescription
hSqlSalSqlHandle
flagsOnSalNumber

Returns: SalBoolean.

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

Instance member DoDeletes(hSql, flagsOn, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
flagsOnSalNumber
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member DoInserts(hSql, bClearFlags)

ParameterTypeDescription
hSqlSalSqlHandle
bClearFlagsSalBoolean

Returns: SalBoolean.

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

Instance member DoInserts(hSql, bClearFlags, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
bClearFlagsSalBoolean
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member DoUpdates(hSql, bClearFlags)

ParameterTypeDescription
hSqlSalSqlHandle
bClearFlagsSalBoolean

Returns: SalBoolean.

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

Instance member DoUpdates(hSql, bClearFlags, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
bClearFlagsSalBoolean
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member DrawMenuBar()

Returns: SalBoolean.

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

Instance member EnableWindow()

Returns: SalBoolean.

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

Instance member EnableWindowAndLabel()

Returns: SalBoolean.

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

Instance member EndDialog(nReturn)

ParameterTypeDescription
nReturnSalNumber

Returns: SalBoolean.

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

Instance member FetchRow(nRow)

ParameterTypeDescription
nRowSalNumber

Returns: SalNumber.

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

Instance member FindChild(windowName)

ParameterTypeDescription
windowNameSalString

Returns: SalWindowHandle.

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

Instance member FindControl(name)

Resolves a named control relative to the associated control.

ParameterTypeDescription
nameStringThe control name to resolve.

Returns: Control. The control found by SalWindow.FindControl, or null when no match is available.

Instance member FindMember(name)

Resolves a named field or property from the associated control.

ParameterTypeDescription
nameStringThe member name to resolve.

Returns: ReferenceInfo. The value returned by SalWindow.FindMember for this control.

Instance member FindNextRow(Row, flagsOn, flagsOff)

ParameterTypeDescription
Row by referenceSalNumber
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

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

Instance member FindPrevRow(Row, flagsOn, flagsOff)

ParameterTypeDescription
Row by referenceSalNumber
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

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

Instance member FireWindowActions(msg, mywParam, mylParam)

Invokes the control's window-action handlers for a message.

ParameterTypeDescription
msgSalNumberThe message identifier.
mywParamSalNumberThe message wParam value.
mylParamSalNumberThe message lParam value.

Returns: SalNumber. The Return value from the window-action event.

Instance member FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)

ParameterTypeDescription
nMsgInt32
nMywParamSalNumber
nMylParamSalNumber

Returns: SalBoolean.

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

Instance member FormUnitsToPixels(formUnits, vertical)

ParameterTypeDescription
formUnitsSalNumber
verticalSalBoolean

Returns: SalNumber.

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

Instance member GetCellType(type)

ParameterTypeDescription
type by referenceSalNumber

Returns: SalBoolean.

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

Instance member 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.

Instance member GetClassName()

Returns: SalString.

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

Instance member GetColumnFlags(flags)

ParameterTypeDescription
flagsSalNumber

Returns: SalBoolean.

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

Instance member GetColumnID()

Returns: SalNumber.

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

Instance member GetColumnPosition()

Returns: SalNumber.

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

Instance member GetColumnText(columnID, text)

ParameterTypeDescription
columnIDSalNumber
text by referenceSalString

Returns: SalBoolean.

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

Instance member GetColumnText(columnID)

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

ParameterTypeDescription
columnIDSalNumberThe column identifier.

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

Instance member GetColumnTitle(text, maxLen)

ParameterTypeDescription
text by referenceSalString
maxLenSalNumber

Returns: SalNumber.

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

Instance member GetColumnTitle(maxLen)

Returns the title of the associated table column.

ParameterTypeDescription
maxLenSalNumberThe 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.

Instance member GetColumnWidth(formUnits)

ParameterTypeDescription
formUnits by referenceSalNumber

Returns: SalBoolean.

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

Instance member 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.

Instance member GetColumnWindow(col, flags)

ParameterTypeDescription
colSalNumber
flagsSalNumber

Returns: SalWindowHandle.

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

Instance member GetContextRow()

Returns: SalNumber.

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

Instance member GetControlType()

Returns: SalNumber.

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

Instance member GetDataLength()

Returns: SalNumber.

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

Instance member GetDataType()

Returns: SalNumber.

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

Instance member GetDefaultButton()

Returns: SalWindowHandle.

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

Instance member GetFirstChild(typeMask)

ParameterTypeDescription
typeMaskSalNumber

Returns: SalWindowHandle.

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

Instance member GetFont(name, size, enhancement)

ParameterTypeDescription
name by referenceSalString
size by referenceSalNumber
enhancement by referenceSalNumber

Returns: SalBoolean.

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

Instance member GetFormat(sPicture)

Retrieves the display format of an edit-capable control.

ParameterTypeDescription
sPicture by referenceSalStringReceives the format on success; unchanged if no format is available.

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

Instance member GetFormat()

Returns: SalString.

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

Instance member GetFormatCode()

Returns: SalNumber.

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

Instance member GetFormattedText(sText, bFormat)

Retrieves the control text with optional display formatting.

ParameterTypeDescription
sText by referenceSalStringReceives the result when text is available; unchanged otherwise.
bFormatSalBooleanTrue to apply display formatting; false to request the underlying text.

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

Instance member GetFormattedText(bFormat)

ParameterTypeDescription
bFormatSalBoolean

Returns: SalString.

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

Instance member GetImageBytes(buffer, type)

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

ParameterTypeDescription
buffer by referenceSalStringReceives the image data, or a null-valued buffer when no image is available.
type by referenceSalNumberReceives the image-type code.

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

Instance member GetImageBytes(buffer, type)

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

ParameterTypeDescription
buffer by referenceSalBinaryReceives the image data, or a null-valued buffer when no image is available.
type by referenceSalNumberReceives the image-type code.

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

Instance member GetImageDescription(desc, maxLen)

Retrieves the Gupta image-format description.

ParameterTypeDescription
desc by referenceSalStringReceives the description, or an empty string if no image is available.
maxLenSalNumberThe maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

Instance member GetImageDescription(maxLen)

Retrieves the Gupta image-format description.

ParameterTypeDescription
maxLenSalNumberThe maximum number of characters to return.

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

Instance member GetImageString(format, pict)

Encodes the current image in a requested SAL image representation.

ParameterTypeDescription
formatSalNumberThe PIC_Format* encoding selector.
pict by referenceSalStringReceives 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.

Instance member GetImageString(format)

Encodes the current image in a requested SAL image representation.

ParameterTypeDescription
formatSalNumberThe 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.

Instance member GetImageString(format, buffer)

Encodes the current image in a requested SAL image representation.

ParameterTypeDescription
formatSalNumberThe PIC_Format* encoding selector.
buffer by referenceSalBinaryReceives the encoded image data.

Returns: SalNumber. The number of encoded bytes.

The binary overload returns raw encoded bytes.

Instance member GetInputMask(sMask)

Retrieves the input mask of an edit-capable control.

ParameterTypeDescription
sMask by referenceSalStringReceives the input mask when accepted; unchanged when the method returns false.

Returns: SalBoolean. True for a nonempty available mask; false for an empty mask or unsupported control.

Instance member GetInputMask()

Returns: SalString.

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

Instance member GetLabel()

Returns: SalWindowHandle.

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

Instance member GetLabelText(sText, nMaxLength)

ParameterTypeDescription
sText by referenceSalString
nMaxLengthSalNumber

Returns: SalNumber.

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

Instance member GetLabelText(nMaxLength)

ParameterTypeDescription
nMaxLengthSalNumber

Returns: SalString.

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

Instance member GetLinesPerRow(lines)

ParameterTypeDescription
lines by referenceSalNumber

Returns: SalBoolean.

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

Instance member 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.

Instance member GetListItemsCount()

Returns: SalNumber.

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

Instance member GetListItemState(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

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

Instance member GetListItemText(nIndex, sText)

ParameterTypeDescription
nIndexSalNumber
sText by referenceSalString

Returns: SalNumber.

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

Instance member GetListItemText(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalString.

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

Instance member GetListItemTextLength(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalNumber.

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

Instance member GetListSelectedFile(sFileName)

ParameterTypeDescription
sFileName by referenceSalString

Returns: SalBoolean.

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

Instance member GetListSelectedFile()

Returns: SalString.

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

Instance member GetListSelectedIndex()

Returns: SalNumber.

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

Instance member GetListSelectedItems(nSelectedArray)

ParameterTypeDescription
nSelectedArraySalArray<SalNumber>

Returns: SalBoolean.

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

Instance member GetListSelectedItemsCount()

Returns: SalNumber.

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

Instance member GetLocation(x, y)

Retrieves the control location in form units.

ParameterTypeDescription
x by referenceSalNumberReceives the horizontal location.
y by referenceSalNumberReceives the vertical location.

Returns: SalBoolean. True after the coordinates are assigned.

Instance member GetLockedColumns()

Returns: SalNumber.

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

Instance member GetName(text)

ParameterTypeDescription
text by referenceSalString

Returns: SalBoolean.

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

Instance member GetName()

Returns: SalString.

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

Instance member GetNextChild(typeMask)

ParameterTypeDescription
typeMaskSalNumber

Returns: SalWindowHandle.

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

Instance member GetObjectData(info, context)

Serializes the current handle identifier.

ParameterTypeDescription
infoSerializationInfoReceives the Handle entry.
contextStreamingContextThe serialization context; not used by this implementation.

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

Instance member GetParent()

Returns: SalWindowHandle.

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

Instance member GetProperty(name, value)

ParameterTypeDescription
nameSalString
value by referenceSalString

Returns: SalBoolean.

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

Instance member GetProperty(name)

ParameterTypeDescription
nameSalString

Returns: SalString.

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

Instance member GetRowFlags(row, flags)

ParameterTypeDescription
rowSalNumber
flagsSalNumber

Returns: SalBoolean.

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

Instance member GetScrollBarPosition(pos)

Retrieves the position of the associated scrolling control.

ParameterTypeDescription
pos by referenceSalNumberReceives the current position, or zero for a control of a different type.

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

Uses a Windows Forms ScrollBar.

Instance member GetScrollBarPosition()

Returns: SalNumber.

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

Instance member GetScrollBarRange(min, max, line, page)

ParameterTypeDescription
min by referenceSalNumber
max by referenceSalNumber
line by referenceSalNumber
page by referenceSalNumber

Returns: SalBoolean.

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

Instance member GetSize(width, height)

Retrieves the control size in form units.

ParameterTypeDescription
width by referenceSalNumberReceives the width.
height by referenceSalNumberReceives the height.

Returns: SalBoolean. True after the dimensions are assigned.

Instance member GetStatusBarText(sText, nMaxLen)

Reads the owning form's status-bar text.

ParameterTypeDescription
sText by referenceSalStringReceives the truncated status text, or an empty string if no status bar is found.
nMaxLenSalNumberThe maximum number of characters to copy.

Returns: SalNumber. The number of characters copied.

Instance member GetStatusBarText(nMaxLen)

Reads the owning form's status-bar text.

ParameterTypeDescription
nMaxLenSalNumberThe maximum number of characters to return.

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

Instance member GetTableFlags(flags)

ParameterTypeDescription
flagsSalNumber

Returns: SalBoolean.

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

Instance member GetText(text, maxLen)

ParameterTypeDescription
text by referenceSalString
maxLenSalNumber

Returns: SalNumber.

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

Instance member GetText(maxLen)

ParameterTypeDescription
maxLenSalNumber

Returns: SalString.

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

Instance member GetTextUnmasked(sText)

Retrieves control text with input-mask literals removed.

ParameterTypeDescription
sText by referenceSalStringReceives the unmasked text on success; unchanged when the control is unavailable.

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

Instance member GetTextUnmasked()

Returns: SalString.

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

Instance member GetWindowColor(colorIndex)

ParameterTypeDescription
colorIndexSalNumber

Returns: SalNumber.

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

Instance member GetWindowState()

Returns: SalNumber.

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

Instance member HideWindow()

Returns: SalBoolean.

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

Instance member HideWindowAndLabel()

Returns: SalBoolean.

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

Instance member HitTest(x, y, row, col, flags)

ParameterTypeDescription
xSalNumber
ySalNumber
row by referenceSalNumber
col by referenceSalWindowHandle
flags by referenceSalNumber

Returns: SalBoolean.

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

Instance member InsertListItem(nIndex, sAdd)

ParameterTypeDescription
nIndexSalNumber
sAddSalString

Returns: SalNumber.

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

Instance member InsertRow(row)

ParameterTypeDescription
rowSalNumber

Returns: SalNumber.

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

Instance member InvalidateWindow()

Returns: SalBoolean.

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

Instance member IsChecked()

Returns: SalBoolean.

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

Instance member IsDerivedFromClass(typeClass)

ParameterTypeDescription
typeClassType

Returns: SalBoolean.

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

Instance member IsEmpty()

Returns: SalBoolean.

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

Instance member IsEnabled()

Returns: SalBoolean.

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

Instance member IsModified()

Returns: SalBoolean.

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

Instance member IsValid()

Returns: SalBoolean.

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

Instance member IsValidDateTime()

Returns: SalBoolean.

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

Instance member IsValidDecimal(nPrecision, nScale)

ParameterTypeDescription
nPrecisionSalNumber
nScaleSalNumber

Returns: SalBoolean.

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

Instance member IsValidInteger()

Returns: SalBoolean.

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

Instance member IsValidNumber()

Returns: SalBoolean.

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

Instance member IsVisible()

Returns: SalBoolean.

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

Instance member KillCellEdit()

Returns: SalBoolean.

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

Instance member KillFocusRow()

Returns: SalBoolean.

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

Instance member KillTimer(idEvent)

ParameterTypeDescription
idEventSalNumber

Returns: SalBoolean.

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

Instance member MDIArrangeIcons()

Returns: SalBoolean.

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

Instance member MDICascade()

Returns: SalBoolean.

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

Instance member MDITile(bPosition)

ParameterTypeDescription
bPositionSalBoolean

Returns: SalBoolean.

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

Instance member MoveWindow(xOffset, yOffset)

Offsets the control location by the specified form-unit distances.

ParameterTypeDescription
xOffsetSalNumberThe horizontal offset.
yOffsetSalNumberThe vertical offset.

Returns: SalBoolean. The status returned by SalWindow.Move.

ParameterTypeDescription
paneIndexSalNumber
groupIndexSalNumber
groupTitleSalString
heightSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
nameSalString
expandedImageSalString
collapsedImageSalString

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
groupIndexSalNumber
childControl

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
childControl

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
enableSalBoolean

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
groupIndexSalNumber
expandSalBoolean

Returns: SalBoolean.

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

Returns: SalNumber.

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

ParameterTypeDescription
paneIndexSalNumber
binary by referenceSalBinary
formatSalNumber
expandedSalBoolean

Returns: SalBoolean.

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

ParameterTypeDescription
nameSalString

Returns: SalNumber.

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

ParameterTypeDescription
paneIndexSalNumber
title by referenceSalString

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber

Returns: SalString.

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

ParameterTypeDescription
paneIndexSalNumber
groupIndexSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
xmlSalString

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
groupIndexSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
xml by referenceSalString

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
binarySalBinary
formatSalNumber
expandedSalBoolean

Returns: SalBoolean.

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

ParameterTypeDescription
paneIndexSalNumber
titleSalString

Returns: SalBoolean.

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

Instance member PasteRows()

Returns: SalBoolean.

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

Instance member PixelsToFormUnits(numPixels, vertical)

ParameterTypeDescription
numPixelsSalNumber
verticalSalBoolean

Returns: SalNumber.

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

Instance member Populate(hSql, select, method)

ParameterTypeDescription
hSqlSalSqlHandle
selectSalString
methodSalNumber

Returns: SalBoolean.

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

Instance member Populate(hSql, select, method, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
selectSalString
methodSalNumber
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member Populate(hSql, select)

Populates the associated table from a query using TBL_FillAll.

ParameterTypeDescription
hSqlSalSqlHandleThe SQL handle to execute the query.
selectSalStringThe SELECT statement.

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

Uses TBL_FillAll as the population method.

Instance member Populate(hSql, select, errorHandler)

Populates the associated table from a query using TBL_FillAll.

ParameterTypeDescription
hSqlSalSqlHandleThe SQL handle to execute the query.
selectSalStringThe SELECT statement.
errorHandlerWhenSqlErrorHandlerThe 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.

Instance member PopulateList(hSql, sSelect)

ParameterTypeDescription
hSqlSalSqlHandle
sSelectSalString

Returns: SalBoolean.

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

Instance member PopulateList(hSql, sSelect, errorHandler)

ParameterTypeDescription
hSqlSalSqlHandle
sSelectSalString
errorHandlerWhenSqlErrorHandler

Returns: SalBoolean.

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

Instance member PopulateListFiles(ctrlPath, sPathName, nAttributes)

ParameterTypeDescription
ctrlPathControl
sPathName by referenceSalString
nAttributesSalNumber

Returns: SalBoolean.

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

Instance member PostMessage(msg, mywParam, mylParam)

ParameterTypeDescription
msgSalNumber
mywParamSalNumber
mylParamSalNumber

Returns: SalBoolean.

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

Instance member QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)

ParameterTypeDescription
flags by referenceSalNumber
checkedValue by referenceSalString
uncheckedValue by referenceSalString

Returns: SalBoolean.

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

Instance member QueryDropDownListColumn(flags, lines)

ParameterTypeDescription
flags by referenceSalNumber
lines by referenceSalNumber

Returns: SalBoolean.

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

Instance member QueryFocusCell(nRow, hWndCol)

ParameterTypeDescription
nRow by referenceSalNumber
hWndCol by referenceSalWindowHandle

Returns: SalBoolean.

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

Instance member QueryPopupEditColumn(flags, lines)

ParameterTypeDescription
flags by referenceSalNumber
lines by referenceSalNumber

Returns: SalBoolean.

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

Instance member QueryRowHeader(title, maxTitle, width, flags, col)

ParameterTypeDescription
title by referenceSalString
maxTitleSalNumber
width by referenceSalNumber
flags by referenceSalNumber
col by referenceSalWindowHandle

Returns: SalBoolean.

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

Instance member QueryScroll(position, minRange, maxRange)

ParameterTypeDescription
position by referenceSalNumber
minRange by referenceSalNumber
maxRange by referenceSalNumber

Returns: SalBoolean.

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

Instance member QuerySplitWindow(nRowsLowerHalf, bDragAdjust)

ParameterTypeDescription
nRowsLowerHalf by referenceSalNumber
bDragAdjust by referenceSalBoolean

Returns: SalBoolean.

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

Instance member QueryVisibleRange(minRange, maxRange)

ParameterTypeDescription
minRange by referenceSalNumber
maxRange by referenceSalNumber

Returns: SalBoolean.

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

Instance member ResetTable()

Returns: SalBoolean.

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

Instance member ScrollRow(row, column, flags)

ParameterTypeDescription
rowSalNumber
columnControl
flagsSalNumber

Returns: SalBoolean.

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

Instance member ScrollRow(row, column)

ParameterTypeDescription
rowSalNumber
columnControl

Returns: SalBoolean.

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

Instance member SendMessage(msg, mywParam, mylParam)

ParameterTypeDescription
msgSalNumber
mywParamSalNumber
mylParamSalNumber

Returns: SalNumber.

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

Instance member SendMessageToChildren(msg, mywParam, mylParam)

ParameterTypeDescription
msgSalNumber
mywParamSalNumber
mylParamSalNumber

Returns: SalBoolean.

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

Instance member SetCellTextColor(color, discardable)

ParameterTypeDescription
colorSalNumber
discardableSalBoolean

Returns: SalBoolean.

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

Instance member SetCellTextColor(color)

ParameterTypeDescription
colorSalNumber

Returns: SalBoolean.

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

Instance member SetChecked(value)

ParameterTypeDescription
valueSalNumber

Returns: SalBoolean.

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

Instance member SetColumnFlags(flags, set)

ParameterTypeDescription
flagsSalNumber
setSalBoolean

Returns: SalBoolean.

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

Instance member SetColumnPos(pos)

ParameterTypeDescription
posSalNumber

Returns: SalBoolean.

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

Instance member SetColumnPosition(pos)

ParameterTypeDescription
posSalNumber

Returns: SalBoolean.

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

Instance member SetColumnText(columnID, text)

ParameterTypeDescription
columnIDSalNumber
textSalString

Returns: SalBoolean.

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

Instance member SetColumnTitle(title)

ParameterTypeDescription
titleSalString

Returns: SalBoolean.

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

Instance member SetColumnWidth(formUnits)

ParameterTypeDescription
formUnitsSalNumber

Returns: SalBoolean.

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

Instance member SetContextMenu(sMenuName, nFlags)

ParameterTypeDescription
sMenuNameSalString
nFlagsSalNumber

Returns: SalBoolean.

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

Instance member SetContextMenu(menuType, flags)

ParameterTypeDescription
menuTypeType
flagsSalNumber

Returns: SalBoolean.

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

Instance member SetContextRow(row)

ParameterTypeDescription
rowSalNumber

Returns: SalBoolean.

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

Instance member SetCursor(resource, type)

Assigns a cursor to the associated control.

ParameterTypeDescription
resourceSalResourceCursorThe cursor resource to load.
typeSalNumberThe SAL cursor selector.

Returns: SalBoolean. The status returned by SalWindow.SetCursor.

Instance member SetCursor(resourceId, type)

ParameterTypeDescription
resourceIdInt32
typeSalNumber

Returns: SalBoolean.

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

Instance member SetCursor(blob, type)

Assigns a cursor to the associated control.

ParameterTypeDescription
blobSalStringThe binary cursor data.
typeSalNumberThe SAL cursor selector.

Returns: SalBoolean. The status returned by SalWindow.SetCursor.

Instance member SetCursorFile(file, type)

ParameterTypeDescription
fileSalString
typeSalNumber

Returns: SalBoolean.

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

Instance member SetDataLength(length)

ParameterTypeDescription
lengthSalNumber

Returns: SalBoolean.

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

Instance member SetDefaultButton()

Returns: SalBoolean.

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

Instance member SetFlagsAnyRows(flags, set, flagsOn, flagsOff)

ParameterTypeDescription
flagsSalNumber
setSalBoolean
flagsOnSalNumber
flagsOffSalNumber

Returns: SalBoolean.

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

Instance member SetFocus()

Returns: SalWindowHandle.

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

Instance member SetFocusCell(row, column, editMin, editMax)

ParameterTypeDescription
rowSalNumber
columnControl
editMinSalNumber
editMaxSalNumber

Returns: SalBoolean.

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

Instance member SetFocusRow(row)

ParameterTypeDescription
rowSalNumber

Returns: SalBoolean.

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

Instance member SetFont(name, size, enhancement)

ParameterTypeDescription
nameSalString
sizeSalNumber
enhancementSalNumber

Returns: SalBoolean.

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

Instance member SetFormat(sPicture)

ParameterTypeDescription
sPictureSalString

Returns: SalBoolean.

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

Instance member SetFormatCode(nFormat)

ParameterTypeDescription
nFormatSalNumber

Returns: SalBoolean.

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

Instance member SetImageBytes(imageBytes, type)

Decodes image bytes and assigns the resulting image.

ParameterTypeDescription
imageBytesSalStringThe encoded image data.
typeSalNumberThe SAL image-format code passed to the decoder.

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

Instance member SetImageFile(fileName)

Loads and assigns an image from a file.

ParameterTypeDescription
fileNameSalStringThe 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.

Instance member SetImageFit(fit, scaleWidth, scaleHeight)

Sets how a picture is fitted within its control.

ParameterTypeDescription
fitSalNumberThe PIC_Fit* fitting mode.
scaleWidthSalNumberThe width scaling percentage used for PIC_FitScale.
scaleHeightSalNumberThe height scaling percentage used for PIC_FitScale.

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

Best-fit and size-to-fit modes reset the scaling percentages to 100.

Instance member SetImageHandle(type, handle)

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

ParameterTypeDescription
typeSalNumberPIC_FormatIcon for an icon; other values use the bitmap path.
handleSalNumberThe native handle, or zero to clear the image.

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

Instance member SetImageResource(resource, format)

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

ParameterTypeDescription
resourceSalResourceThe image resource to load.
formatSalNumberThe image-format selector passed to the picture implementation.

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

Instance member SetImageString(format, picture)

Decodes a SAL image buffer and assigns the resulting image.

ParameterTypeDescription
formatSalNumberThe SAL image-format code.
pictureSalStringThe encoded image buffer.

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

Instance member SetImageString(format, buffer)

Decodes a SAL image buffer and assigns the resulting image.

ParameterTypeDescription
formatSalNumberThe SAL image-format code.
bufferSalBinaryThe encoded image buffer.

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

Instance member SetInputMask(sMask)

ParameterTypeDescription
sMaskSalString

Returns: SalBoolean.

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

Instance member SetLabelText(sText)

ParameterTypeDescription
sTextSalString

Returns: SalBoolean.

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

Instance member SetLinesPerRow(lines)

ParameterTypeDescription
linesSalNumber

Returns: SalBoolean.

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

Instance member SetListRedraw(bRedraw)

ParameterTypeDescription
bRedrawSalNumber

Returns: SalBoolean.

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

Instance member SetListSelectedIndex(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

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

Instance member SetListSelectedItems(nIndex, bSelect)

ParameterTypeDescription
nIndexSalNumber
bSelectSalBoolean

Returns: SalBoolean.

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

Instance member SetListSelectedText(nIndexStart, sText)

ParameterTypeDescription
nIndexStartSalNumber
sTextSalString

Returns: SalNumber.

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

Instance member SetListTabStops(nTabStops)

ParameterTypeDescription
nTabStopsSalArray<SalNumber>

Returns: SalBoolean.

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

Instance member SetLocation(x, y)

Sets the control location in form units.

ParameterTypeDescription
xSalNumberThe new horizontal location.
ySalNumberThe new vertical location.

Returns: SalBoolean. The status returned by SalWindow.SetLocation.

Instance member SetLockedColumns(lockedColumns)

ParameterTypeDescription
lockedColumnsSalNumber

Returns: SalBoolean.

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

Instance member SetModified(bSet)

ParameterTypeDescription
bSetSalBoolean

Returns: SalBoolean.

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

Instance member SetProperty(name, value, length)

Stores a named string property on the control.

ParameterTypeDescription
nameSalStringThe property name.
valueSalStringThe value to store.
lengthSalNumberThe maximum number of characters retained from the value.

Returns: SalBoolean. The status returned by SalWindow.SetProperty.

Uses SalString.Left to limit the stored value.

Instance member SetRange(min, max)

ParameterTypeDescription
minSalNumber
maxSalNumber

Returns: SalBoolean.

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

Instance member SetRow(rowPos)

ParameterTypeDescription
rowPosSalNumber

Returns: SalNumber.

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

Instance member SetRowFlags(row, flags, set)

ParameterTypeDescription
rowSalNumber
flagsSalNumber
setSalBoolean

Returns: SalBoolean.

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

Instance member SetScrollBarPosition(pos)

ParameterTypeDescription
posSalNumber

Returns: SalBoolean.

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

Instance member SetScrollBarRange(min, max, line, page)

ParameterTypeDescription
minSalNumber
maxSalNumber
lineSalNumber
pageSalNumber

Returns: SalBoolean.

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

Instance member SetSize(width, height)

Sets the control size in form units.

ParameterTypeDescription
widthSalNumberThe new width.
heightSalNumberThe new height.

Returns: SalBoolean. The status returned by SalWindow.SetSize.

Instance member SetStatusBarText(sText)

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

ParameterTypeDescription
sTextSalStringThe status text to display.

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

Instance member SetTableFlags(flags, set)

ParameterTypeDescription
flagsSalNumber
setSalBoolean

Returns: SalBoolean.

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

Instance member SetText(text)

ParameterTypeDescription
textSalString

Returns: SalBoolean.

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

Instance member SetText(sValue, bFormat)

ParameterTypeDescription
sValueSalString
bFormatSalBoolean

Returns: SalBoolean.

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

Instance member SetTimer(idEvent, elapseMilliSec)

ParameterTypeDescription
idEventSalNumber
elapseMilliSecSalNumber

Returns: SalBoolean.

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

Instance member SetWindowColor(colorIndex, color)

ParameterTypeDescription
colorIndexSalNumber
colorSalNumber

Returns: SalBoolean.

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

Instance member ShowStatusBar(bShow)

ParameterTypeDescription
bShowSalBoolean

Returns: SalBoolean.

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

Instance member ShowToolBar(bShow)

ParameterTypeDescription
bShowSalBoolean

Returns: SalBoolean.

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

Instance member ShowWindow()

Returns: SalBoolean.

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

Instance member ShowWindowAndLabel()

Returns: SalBoolean.

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

Instance member SortRows(columnID, order)

ParameterTypeDescription
columnIDSalNumber
orderSalNumber

Returns: SalBoolean.

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

Instance member ToControl()

Returns the control associated with the handle.

Returns: Control. The weakly referenced control when it still has a handle, a native-control adapter for a valid raw window handle, or null.

Instance member 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.

Instance member ToIntPtr()

Returns the handle as a pointer-sized identifier.

Returns: IntPtr. The raw identifier, or the current managed control handle; zero if the weakly referenced control is unavailable.

Instance member ToNumber()

Returns the handle as a SAL number.

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

Instance member TrackPopupMenu(menuName, flags, x, y)

Creates and displays a popup menu for the associated control.

ParameterTypeDescription
menuNameSalStringThe menu type name to resolve.
flagsSalNumberThe SAL popup-menu flags.
xSalNumberThe horizontal screen coordinate in pixels.
ySalNumberThe vertical screen coordinate in pixels.

Returns: SalBoolean. The status returned by SalWindow.TrackPopupMenu.

Instance member TrackPopupMenu(menuType, flags, x, y)

Creates and displays a popup menu for the associated control.

ParameterTypeDescription
menuTypeTypeThe menu type to instantiate.
flagsSalNumberThe SAL popup-menu flags.
xSalNumberThe horizontal screen coordinate in pixels.
ySalNumberThe vertical screen coordinate in pixels.

Returns: SalBoolean. The status returned by SalWindow.TrackPopupMenu.

Instance member UpdateWindow()

Returns: SalBoolean.

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

Instance member 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.

Instance member Validate(validate)

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

ParameterTypeDescription
validateSalNumberFMT_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.

Instance member WinHelp(file, command, numData, strData)

ParameterTypeDescription
fileSalString
commandSalNumber
numDataSalNumber
strDataSalString

Returns: SalBoolean.

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

Instance member Yield()

Processes a pending window message for this control.

If the control has no usable handle, processes the application message queue instead. A pending quit message requests application termination.

Used By

NameDescription
Sal.AppFind
SalNumber.ToWindowHandleWraps the pointer-sized integer representation as a SAL window handle.
SalWindowHandle.CompareToCompares handle identifiers as signed 32-bit integers.
SalWindowHandle.GetDefaultButton
Sql.ContextSetToForm
SalNavigationBar.FindChildSearches this window for a child control by name.
SalTreeControl.FindChildSearches this window for a child control by name.
SalActiveX.FindChildSearches this window for a child control by name.
SalBackgroundText.FindChildSearches this window for a child control by name.
SalCheckBox.FindChildSearches this window for a child control by name.
SalComboBox.FindChildSearches this window for a child control by name.
SalCustomControl.FindChildSearches this window for a child control by name.
SalDataField.FindChildSearches this window for a child control by name.
SalFrame.FindChildSearches this window for a child control by name.
SalGroupBox.FindChildSearches this window for a child control by name.
SalHorizontalScrollBar.FindChildSearches this window for a child control by name.
SalLine.FindChildSearches this window for a child control by name.
SalListBox.FindChildSearches this window for a child control by name.
SalRibbonBarBase.GetDefaultButtonGetDefaultButton applied to this form.
WindowActionsEventArgs.hWndGets the target window handle captured when the action was created.
SalMultilineField.FindChildSearches this window for a child control by name.
SalOptionButton.FindChildSearches this window for a child control by name.
SalPicture.FindChildSearches this window for a child control by name.
SalPushbutton.FindChildSearches this window for a child control by name.
SalRadioButton.FindChildSearches this window for a child control by name.
SalUserControl.FindChildSearches this window for a child control by name.
SalVerticalScrollBar.FindChildSearches this window for a child control by name.
SalForm.GetDefaultButtonGetDefaultButton applied to this form.
SalFormTableWindow.GetColumnWindowResolves a column handle by identifier or physical grid position.
SalWindow.FromHandleResolves a SAL window handle and casts the translated control through SAL inheritance rules.
SalWindow.GetFocusGets the focused native window translated to its SAL handle.
SalTableColumn.FindChildSearches this window for a child control by name.
SalTableWindow.GetColumnWindowResolves a column handle by identifier or physical grid position.
SalQuickTabs.ShowWindowRemoves a control from the explicit hidden set and applies its current-tab visibility.
SalQuickTabs.ShowWindowAndLabelRemoves a control and its label from the hidden set and reapplies tab visibility.
SalQuickTabs.HideWindowHides a control and keeps it hidden across tab changes.
SalQuickTabs.IsWindowVisibleTests whether a control is present in the frame's explicitly hidden set.
SalQuickTabs.HideWindowAndLabelHides a control and its label across tab changes.
SalQuickTabs.FindTabFrameFinds the first QuickTabs frame within a form's child traversal.
SalQuickTabsDialog.FromHandleResolves a SAL window handle to an existing SalQuickTabsDialog.
SalQuickTabsForm.FromHandleResolves a SAL window handle to an existing SalQuickTabsForm.
SalQuickTabsParent.TabCreateHandles notification that a QuickTabs frame has been created.
SalQuickTabsParent.TabActivateStartHandles tab activation before associated children are shown.
SalQuickTabsParent.TabActivateFinishHandles tab activation after associated children are shown.
SalQuickTabsParent.TabUserRequestHandles a user request to change tabs.
SalQuickTabsParent.TabFrameResizeHandles a tab-frame size-change callback.
SalQuickTabsParent.TabSetFormPageSizeSets bound form-page bounds to the frame's display rectangle.
SalQuickTabsParent.FromHandleResolves a SAL window handle to an existing SalQuickTabsParent.
SalQuickToolTipCheckBox.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipCheckBox.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipCheckBox.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipCheckBox.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipCheckBox.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipCheckBox.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipCheckBox.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipChildTable.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipChildTable.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipChildTable.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipChildTable.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipChildTable.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipChildTable.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipChildTable.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipComboBox.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipComboBox.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipComboBox.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipComboBox.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipComboBox.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipComboBox.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipComboBox.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipDataField.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipDataField.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipDataField.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipDataField.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipDataField.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipDataField.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipDataField.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipHScrollBar.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipHScrollBar.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipHScrollBar.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipHScrollBar.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipHScrollBar.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipHScrollBar.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipHScrollBar.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipListBox.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipListBox.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipListBox.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipListBox.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipListBox.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipListBox.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipListBox.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipMultilineField.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipMultilineField.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipMultilineField.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipMultilineField.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipMultilineField.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipMultilineField.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipMultilineField.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipOptionButton.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipOptionButton.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipOptionButton.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipOptionButton.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipOptionButton.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipOptionButton.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipOptionButton.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipPicture.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipPicture.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipPicture.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipPicture.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipPicture.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipPicture.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipPicture.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipPushButton.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipPushButton.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipPushButton.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipPushButton.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipPushButton.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipPushButton.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipPushButton.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipRadioButton.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipRadioButton.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipRadioButton.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipRadioButton.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipRadioButton.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipRadioButton.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipRadioButton.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipTableWindow.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipTableWindow.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipTableWindow.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipTableWindow.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipTableWindow.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipTableWindow.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipTableWindow.IsToolTests whether a control has a tooltip registration.
SalQuickToolTipVScrollBar.AddToolAssociates tooltip text and status text with a control.
SalQuickToolTipVScrollBar.SetTipTextUpdates the tooltip text for a registered control.
SalQuickToolTipVScrollBar.SetStatusTextUpdates the status-bar text for a registered control.
SalQuickToolTipVScrollBar.GetTipTextReads a registered control's tooltip text.
SalQuickToolTipVScrollBar.DeleteToolUnregisters a control's tooltip.
SalQuickToolTipVScrollBar.GetStatusTextReads a registered control's status-bar text.
SalQuickToolTipVScrollBar.IsToolTests whether a control has a tooltip registration.
SalDDE.Post
SalDDE.Send
SalDDE.SendAll
Vis.SendMsgString
Vis.MenuGetSystemHandle
Vis.WinEnumProps
Vis.WinGetFlags
Vis.WinGetHandle
VisCalendar.FromHandle
VisCalendar.FindChild
VisCalendarDropDown.FromHandle
VisCalendarDropDown.FindChild
VisColorComboBox.FromHandle
VisColorListBox.FromHandle
VisColorPalette.FromHandle
VisColorPaletteDropDown.FromHandle
VisComboBoxBase.DragDrop
VisDesktopListBox.FromHandle
VisDirListBox.FromHandle
VisDirTreeListBox.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
VisOutlineComboBox.FromHandle
VisOutlineComboBox.DragDrop
VisOutlineListBox.FromHandle
VisOutlineListBox.DoDragDrop
VisOutlineListBox.FindChild
VisPictureComboBox.FromHandle
VisPictureListBox.FromHandle
VisRadioListBox.FromHandle
VisRichEdit.FromHandle
VisRichEdit.FindChild
VisSpinField.FromHandle
VisSpinField.FindChild
VisSplitter.FromHandle
VisSplitterWindow.FromHandle
XSal.GetClientWindow
XSalFlatButton.FromHandle
XSalHSplitter.FromHandle
XSalHSplitter.GetTopFrame
XSalSeparator.FromHandle
XSalSplitter.FromHandle
XSalToolbox.FromHandle
XSalVSplitter.FromHandle
XSalVSplitter.GetLeftFrame