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.
- C#
- VB.NET
public struct SalWindowHandle : ValueType, IConvertible, IComparable, ISalType, ISerializable, IXmlSerializable
Public Structure SalWindowHandle
Implements 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
SalWindowHandle(handle)
Initializes a SAL window handle from an identifier.
| Name | Type | Description |
|---|---|---|
| handle | IntPtr | The handle value, including zero. |
Captures a weak reference when the handle resolves to a managed control; otherwise, retains the raw identifier.
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 a weak reference to the derived control.
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(flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| flagsOn | SalNumber | |
| flagsOff | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
BringWindowToTop()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
CenterWindow()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
Clear()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
ClearCursor(type)
| Parameter | Type | Description |
|---|---|---|
| type | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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, flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| nColumnID | SalNumber | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
ColumnSum(columnId, flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| columnId | SalNumber | |
| flagsOn | SalNumber | |
| flagsOff | 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(flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| flagsOn | SalNumber | |
| flagsOff | 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(flags, checkedValue, uncheckedValue)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| checkedValue | SalString | |
| uncheckedValue | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DefineDropDownListColumn(flags, lines)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| lines | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DefinePopupEditColumn(flags, lines)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| lines | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DefineRowHeader(title, width, flags, column)
| Parameter | Type | Description |
|---|---|---|
| title | SalString | |
| width | SalNumber | |
| flags | 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()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DisableWindow()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DisableWindowAndLabel()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DoDeletes(hSql, flagsOn)
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | |
| flagsOn | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
DoDeletes(hSql, flagsOn, errorHandler)
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | |
| flagsOn | 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()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
EnableWindowAndLabel()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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(windowName)
| Parameter | Type | Description |
|---|---|---|
| windowName | SalString |
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
FindControl(name)
Resolves a named control relative to the associated control.
| Parameter | Type | Description |
|---|---|---|
| name | String | The control name to resolve. |
Returns: Control. The control found by SalWindow.FindControl, or null when no match is available.
FindMember(name)
Resolves a named field or property from the associated control.
| Parameter | Type | Description |
|---|---|---|
| name | String | The member name to resolve. |
Returns: ReferenceInfo. The value returned by SalWindow.FindMember for this control.
FindNextRow(Row, flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| Row | SalNumber | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
FindPrevRow(Row, flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| Row | SalNumber | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
FireWindowActions(msg, mywParam, mylParam)
Invokes the control's window-action handlers for a message.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | The message identifier. |
| mywParam | SalNumber | The message wParam value. |
| mylParam | SalNumber | The message lParam value. |
Returns: SalNumber. The Return value from the window-action event.
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(formUnits, vertical)
| Parameter | Type | Description |
|---|---|---|
| formUnits | SalNumber | |
| vertical | SalBoolean |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetCellType(type)
| Parameter | Type | Description |
|---|---|---|
| type | 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()
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
GetColumnFlags(flags)
| Parameter | Type | Description |
|---|---|---|
| flags | 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(columnID, text)
| Parameter | Type | Description |
|---|---|---|
| columnID | SalNumber | |
| text | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetColumnText(columnID)
Returns the value text for a column in the table's current context row.
| Parameter | Type | Description |
|---|---|---|
| columnID | SalNumber | The column identifier. |
Returns: SalString. The column text, or SAL null when this handle does not resolve to a table.
GetColumnTitle(text, maxLen)
| Parameter | Type | Description |
|---|---|---|
| text | SalString | |
| maxLen | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetColumnTitle(maxLen)
Returns the title of the associated table column.
| Parameter | Type | Description |
|---|---|---|
| maxLen | 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(formUnits)
| Parameter | Type | Description |
|---|---|---|
| formUnits | 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(col, flags)
| Parameter | Type | Description |
|---|---|---|
| col | SalNumber | |
| flags | 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()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetDataLength()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetDataType()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetDefaultButton()
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
GetFirstChild(typeMask)
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber |
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
GetFont(name, size, enhancement)
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| size | SalNumber | |
| enhancement | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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(buffer, type)
Encodes the current image as binary data and reports its format.
| Parameter | Type | Description |
|---|---|---|
| buffer | SalString | Receives the image data, or a null-valued buffer when no image is available. |
| type | SalNumber | Receives the image-type code. |
Returns: SalNumber. The byte count, or zero when no image data is available.
GetImageBytes(buffer, type)
Encodes the current image as binary data and reports its format.
| Parameter | Type | Description |
|---|---|---|
| buffer | SalBinary | Receives the image data, or a null-valued buffer when no image is available. |
| type | SalNumber | Receives the image-type code. |
Returns: SalNumber. The byte count, or zero when no image data is available.
GetImageDescription(desc, maxLen)
Retrieves the Gupta image-format description.
| Parameter | Type | Description |
|---|---|---|
| desc | SalString | Receives the description, or an empty string if no image is available. |
| maxLen | SalNumber | The maximum number of characters to copy. |
Returns: SalNumber. The number of characters copied.
GetImageDescription(maxLen)
Retrieves the Gupta image-format description.
| Parameter | Type | Description |
|---|---|---|
| maxLen | SalNumber | The maximum number of characters to return. |
Returns: SalString. The truncated description, or an empty string if no image is available.
GetImageString(format, pict)
Encodes the current image in a requested SAL image representation.
| Parameter | Type | Description |
|---|---|---|
| format | SalNumber | The PIC_Format* encoding selector. |
| pict | 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(format)
Encodes the current image in a requested SAL image representation.
| Parameter | Type | Description |
|---|---|---|
| format | 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.
GetImageString(format, buffer)
Encodes the current image in a requested SAL image representation.
| Parameter | Type | Description |
|---|---|---|
| format | SalNumber | The PIC_Format* encoding selector. |
| buffer | SalBinary | Receives the encoded image data. |
Returns: SalNumber. The number of encoded bytes.
The binary overload returns raw encoded bytes.
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. True for a nonempty available mask; false for an empty mask or unsupported control.
GetInputMask()
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
GetLabel()
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
GetLabelText(sText, nMaxLength)
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | |
| nMaxLength | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetLabelText(nMaxLength)
| Parameter | Type | Description |
|---|---|---|
| nMaxLength | SalNumber |
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
GetLinesPerRow(lines)
| Parameter | Type | Description |
|---|---|---|
| lines | 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(x, y)
Retrieves the control location in form units.
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | Receives the horizontal location. |
| y | SalNumber | Receives the vertical location. |
Returns: SalBoolean. True after the coordinates are assigned.
GetLockedColumns()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetName(text)
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetName()
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
GetNextChild(typeMask)
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber |
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
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()
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
GetProperty(name, value)
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| value | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetProperty(name)
| Parameter | Type | Description |
|---|---|---|
| name | SalString |
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
GetRowFlags(row, flags)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber | |
| flags | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetScrollBarPosition(pos)
Retrieves the position of the associated scrolling control.
| Parameter | Type | Description |
|---|---|---|
| pos | 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 Windows Forms ScrollBar.
GetScrollBarPosition()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetScrollBarRange(min, max, line, page)
| Parameter | Type | Description |
|---|---|---|
| min | SalNumber | |
| max | SalNumber | |
| line | SalNumber | |
| page | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetSize(width, height)
Retrieves the control size in form units.
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber | Receives the width. |
| height | SalNumber | Receives the height. |
Returns: SalBoolean. True after the dimensions are assigned.
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(flags)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
GetText(text, maxLen)
| Parameter | Type | Description |
|---|---|---|
| text | SalString | |
| maxLen | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetText(maxLen)
| Parameter | Type | Description |
|---|---|---|
| maxLen | SalNumber |
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
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(colorIndex)
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
GetWindowState()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
HideWindow()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
HideWindowAndLabel()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
HitTest(x, y, row, col, flags)
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | |
| y | SalNumber | |
| row | SalNumber | |
| col | SalWindowHandle | |
| flags | 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(row)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
InvalidateWindow()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
IsChecked()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
IsDerivedFromClass(typeClass)
| Parameter | Type | Description |
|---|---|---|
| typeClass | Type |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
IsEmpty()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
IsEnabled()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
IsModified()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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(idEvent)
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
MDIArrangeIcons()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
MDICascade()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
MDITile(bPosition)
| Parameter | Type | Description |
|---|---|---|
| bPosition | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
MoveWindow(xOffset, yOffset)
Offsets the control location by the specified form-unit distances.
| Parameter | Type | Description |
|---|---|---|
| xOffset | SalNumber | The horizontal offset. |
| yOffset | SalNumber | The vertical offset. |
Returns: SalBoolean. The status returned by SalWindow.Move.
NavAddGroup(paneIndex, groupIndex, groupTitle, height)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| groupIndex | SalNumber | |
| groupTitle | SalString | |
| height | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavAddPane(paneIndex, name, expandedImage, collapsedImage)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| name | SalString | |
| expandedImage | SalString | |
| collapsedImage | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavAssociateChild(paneIndex, groupIndex, child)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| groupIndex | SalNumber | |
| child | Control |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavDisassociateChild(paneIndex, child)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| child | Control |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavEnablePane(paneIndex, enable)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| enable | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavExpandGroup(paneIndex, groupIndex, expand)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| groupIndex | SalNumber | |
| expand | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavGetActivePane()
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
NavGetPaneIcon(paneIndex, binary, format, expanded)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| binary | SalBinary | |
| format | SalNumber | |
| expanded | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavGetPaneIndex(name)
| Parameter | Type | Description |
|---|---|---|
| name | SalString |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
NavGetPaneTitle(paneIndex, title)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| title | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavGetPaneTitle(paneIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber |
Returns: SalString.
Applies the referenced operation to the control represented by this handle.
NavGroupIsExpanded(paneIndex, groupIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| groupIndex | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavLoadState(xml)
| Parameter | Type | Description |
|---|---|---|
| xml | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavPaneIsEnabled(paneIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavRemoveGroup(paneIndex, groupIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| groupIndex | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavRemovePane(paneIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavSaveState(xml)
| Parameter | Type | Description |
|---|---|---|
| xml | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavSetActivePane(paneIndex)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavSetPaneIcon(paneIndex, binary, format, expanded)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| binary | SalBinary | |
| format | SalNumber | |
| expanded | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
NavSetPaneTitle(paneIndex, title)
| Parameter | Type | Description |
|---|---|---|
| paneIndex | SalNumber | |
| title | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
PasteRows()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
PixelsToFormUnits(numPixels, vertical)
| Parameter | Type | Description |
|---|---|---|
| numPixels | SalNumber | |
| vertical | SalBoolean |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
Populate(hSql, select, method)
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | |
| select | SalString | |
| method | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
Populate(hSql, select, method, errorHandler)
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | |
| select | SalString | |
| method | SalNumber | |
| errorHandler | WhenSqlErrorHandler |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
Populate(hSql, select)
Populates the associated table from a query using TBL_FillAll.
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | The SQL handle to execute the query. |
| select | SalString | The SELECT statement. |
Returns: SalBoolean. The status returned by Sal.TblPopulate for the query.
Uses TBL_FillAll as the population method.
Populate(hSql, select, errorHandler)
Populates the associated table from a query using TBL_FillAll.
| Parameter | Type | Description |
|---|---|---|
| hSql | SalSqlHandle | The SQL handle to execute the query. |
| select | 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(msg, mywParam, mylParam)
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | |
| mywParam | SalNumber | |
| mylParam | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| checkedValue | SalString | |
| uncheckedValue | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
QueryDropDownListColumn(flags, lines)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| lines | 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(flags, lines)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| lines | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
QueryRowHeader(title, maxTitle, width, flags, col)
| Parameter | Type | Description |
|---|---|---|
| title | SalString | |
| maxTitle | SalNumber | |
| width | SalNumber | |
| flags | SalNumber | |
| col | SalWindowHandle |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
QueryScroll(position, minRange, maxRange)
| Parameter | Type | Description |
|---|---|---|
| position | SalNumber | |
| minRange | SalNumber | |
| maxRange | 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(minRange, maxRange)
| Parameter | Type | Description |
|---|---|---|
| minRange | SalNumber | |
| maxRange | 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(row, column, flags)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber | |
| column | Control | |
| flags | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
ScrollRow(row, column)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber | |
| column | Control |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SendMessage(msg, mywParam, mylParam)
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | |
| mywParam | SalNumber | |
| mylParam | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
SendMessageToChildren(msg, mywParam, mylParam)
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | |
| mywParam | SalNumber | |
| mylParam | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetCellTextColor(color, discardable)
| Parameter | Type | Description |
|---|---|---|
| color | SalNumber | |
| discardable | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetCellTextColor(color)
| Parameter | Type | Description |
|---|---|---|
| color | 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(flags, set)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| set | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetColumnPos(pos)
| Parameter | Type | Description |
|---|---|---|
| pos | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetColumnPosition(pos)
| Parameter | Type | Description |
|---|---|---|
| pos | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetColumnText(columnID, text)
| Parameter | Type | Description |
|---|---|---|
| columnID | SalNumber | |
| text | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetColumnTitle(title)
| Parameter | Type | Description |
|---|---|---|
| title | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetColumnWidth(formUnits)
| Parameter | Type | Description |
|---|---|---|
| formUnits | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetContextMenu(sMenuName, nFlags)
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | |
| nFlags | 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(row)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetCursor(resource, type)
Assigns a cursor to the associated control.
| Parameter | Type | Description |
|---|---|---|
| resource | SalResourceCursor | The cursor resource to load. |
| type | SalNumber | The SAL cursor selector. |
Returns: SalBoolean. The status returned by SalWindow.SetCursor.
SetCursor(resourceId, type)
| Parameter | Type | Description |
|---|---|---|
| resourceId | Int32 | |
| type | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetCursor(blob, type)
Assigns a cursor to the associated control.
| Parameter | Type | Description |
|---|---|---|
| blob | SalString | The binary cursor data. |
| type | SalNumber | The SAL cursor selector. |
Returns: SalBoolean. The status returned by SalWindow.SetCursor.
SetCursorFile(file, type)
| Parameter | Type | Description |
|---|---|---|
| file | SalString | |
| type | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetDataLength(length)
| Parameter | Type | Description |
|---|---|---|
| length | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetDefaultButton()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetFlagsAnyRows(flags, set, flagsOn, flagsOff)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| set | SalBoolean | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetFocus()
Returns: SalWindowHandle.
Applies the referenced operation to the control represented by this handle.
SetFocusCell(row, column, editMin, editMax)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber | |
| column | Control | |
| editMin | SalNumber | |
| editMax | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetFocusRow(row)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetFont(name, size, enhancement)
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| size | SalNumber | |
| enhancement | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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(imageBytes, type)
Decodes image bytes and assigns the resulting image.
| Parameter | Type | Description |
|---|---|---|
| imageBytes | SalString | The encoded image data. |
| type | SalNumber | The SAL image-format code passed to the decoder. |
Returns: SalBoolean. True if the control supports image assignment; otherwise, false.
SetImageFile(fileName)
Loads and assigns an image from a file.
| Parameter | Type | Description |
|---|---|---|
| fileName | 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(fit, scaleWidth, scaleHeight)
Sets how a picture is fitted within its control.
| Parameter | Type | Description |
|---|---|---|
| fit | SalNumber | The PIC_Fit* fitting mode. |
| scaleWidth | SalNumber | The width scaling percentage used for PIC_FitScale. |
| scaleHeight | SalNumber | The 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.
SetImageHandle(type, handle)
Assigns an image identified by a native icon or bitmap handle.
| Parameter | Type | Description |
|---|---|---|
| type | SalNumber | PIC_FormatIcon for an icon; other values use the bitmap path. |
| handle | SalNumber | The native handle, or zero to clear the image. |
Returns: SalBoolean. True if the control supports image assignment; otherwise, false.
SetImageResource(resource, format)
Loads an image from a SAL resource and assigns it to the control.
| Parameter | Type | Description |
|---|---|---|
| resource | SalResource | The image resource to load. |
| format | 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(format, picture)
Decodes a SAL image buffer and assigns the resulting image.
| Parameter | Type | Description |
|---|---|---|
| format | SalNumber | The SAL image-format code. |
| picture | SalString | The encoded image buffer. |
Returns: SalBoolean. True if the control supports image assignment; otherwise, false.
SetImageString(format, buffer)
Decodes a SAL image buffer and assigns the resulting image.
| Parameter | Type | Description |
|---|---|---|
| format | SalNumber | The SAL image-format code. |
| buffer | SalBinary | 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)
| Parameter | Type | Description |
|---|---|---|
| sText | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetLinesPerRow(lines)
| Parameter | Type | Description |
|---|---|---|
| lines | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetListRedraw(bRedraw)
| Parameter | Type | Description |
|---|---|---|
| bRedraw | 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.
SetListTabStops(nTabStops)
| Parameter | Type | Description |
|---|---|---|
| nTabStops | SalArray<SalNumber> |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetLocation(x, y)
Sets the control location in form units.
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | The new horizontal location. |
| y | SalNumber | The new vertical location. |
Returns: SalBoolean. The status returned by SalWindow.SetLocation.
SetLockedColumns(lockedColumns)
| Parameter | Type | Description |
|---|---|---|
| lockedColumns | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetModified(bSet)
| Parameter | Type | Description |
|---|---|---|
| bSet | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetProperty(name, value, length)
Stores a named string property on the control.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | The property name. |
| value | SalString | The value to store. |
| length | SalNumber | The maximum number of characters retained from the value. |
Returns: SalBoolean. The status returned by SalWindow.SetProperty.
Uses SalString.Left to limit the stored value.
SetRange(min, max)
| Parameter | Type | Description |
|---|---|---|
| min | SalNumber | |
| max | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetRow(rowPos)
| Parameter | Type | Description |
|---|---|---|
| rowPos | SalNumber |
Returns: SalNumber.
Applies the referenced operation to the control represented by this handle.
SetRowFlags(row, flags, set)
| Parameter | Type | Description |
|---|---|---|
| row | SalNumber | |
| flags | SalNumber | |
| set | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetScrollBarPosition(pos)
| Parameter | Type | Description |
|---|---|---|
| pos | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetScrollBarRange(min, max, line, page)
| Parameter | Type | Description |
|---|---|---|
| min | SalNumber | |
| max | SalNumber | |
| line | SalNumber | |
| page | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetSize(width, height)
Sets the control size in form units.
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber | The new width. |
| height | SalNumber | The new height. |
Returns: SalBoolean. The status returned by SalWindow.SetSize.
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(flags, set)
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| set | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetText(text)
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetText(sValue, bFormat)
| Parameter | Type | Description |
|---|---|---|
| sValue | SalString | |
| bFormat | SalBoolean |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetTimer(idEvent, elapseMilliSec)
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber | |
| elapseMilliSec | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SetWindowColor(colorIndex, color)
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber | |
| color | SalNumber |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
ShowWindowAndLabel()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
SortRows(columnID, order)
| Parameter | Type | Description |
|---|---|---|
| columnID | SalNumber | |
| order | 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 weakly referenced control when it still has a handle, a native-control adapter for a valid raw window handle, or null.
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 raw identifier, or the current managed control handle; zero if the weakly referenced control is unavailable.
ToNumber()
Returns the handle as a SAL number.
Returns: SalNumber. A SalNumber containing the pointer-sized identifier.
TrackPopupMenu(menuName, flags, x, y)
Creates and displays a popup menu for the associated control.
| Parameter | Type | Description |
|---|---|---|
| menuName | SalString | The menu type name to resolve. |
| flags | SalNumber | The SAL popup-menu flags. |
| x | SalNumber | The horizontal screen coordinate in pixels. |
| y | SalNumber | The vertical screen coordinate in pixels. |
Returns: SalBoolean. The status returned by SalWindow.TrackPopupMenu.
TrackPopupMenu(menuType, flags, x, y)
Creates and displays a popup menu for the associated control.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The menu type to instantiate. |
| flags | SalNumber | The SAL popup-menu flags. |
| x | SalNumber | The horizontal screen coordinate in pixels. |
| y | SalNumber | The vertical screen coordinate in pixels. |
Returns: SalBoolean. The status returned by SalWindow.TrackPopupMenu.
UpdateWindow()
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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(validate)
Validates the edit control's data type and applies its format on success.
| Parameter | Type | Description |
|---|---|---|
| validate | 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.
WinHelp(file, command, numData, strData)
| Parameter | Type | Description |
|---|---|---|
| file | SalString | |
| command | SalNumber | |
| numData | SalNumber | |
| strData | SalString |
Returns: SalBoolean.
Applies the referenced operation to the control represented by this handle.
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
| Name | Description |
|---|---|
| Sal.AppFind | |
| 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 | |
| Sql.ContextSetToForm | |
| SalNavigationBar.FindChild | Searches this window for a child control by name. |
| SalTreeControl.FindChild | Searches this window for a child control by name. |
| SalActiveX.FindChild | Searches this window for a child control by name. |
| 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 | Searches this window for a child control by name. |
| 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. |
| SalRibbonBarBase.GetDefaultButton | GetDefaultButton applied to this form. |
| WindowActionsEventArgs.hWnd | Gets the target window handle captured when the action was created. |
| SalMultilineField.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. |
| SalUserControl.FindChild | Searches this window for a child control by name. |
| SalVerticalScrollBar.FindChild | Searches this window for a child control by name. |
| SalForm.GetDefaultButton | GetDefaultButton applied to this form. |
| SalFormTableWindow.GetColumnWindow | Resolves a column handle by identifier or physical grid position. |
| SalWindow.FromHandle | Resolves a SAL window handle and casts the translated control through SAL inheritance rules. |
| SalWindow.GetFocus | Gets the focused native window translated to its SAL handle. |
| SalTableColumn.FindChild | Searches this window for a child control by name. |
| SalTableWindow.GetColumnWindow | Resolves a column handle by identifier or physical grid position. |
| 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 | Handles a tab-frame size-change callback. |
| SalQuickTabsParent.TabSetFormPageSize | Sets bound form-page bounds to the frame's display rectangle. |
| SalQuickTabsParent.FromHandle | Resolves a SAL window handle to an existing SalQuickTabsParent. |
| SalQuickToolTipCheckBox.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipCheckBox.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipCheckBox.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipCheckBox.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipCheckBox.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipCheckBox.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipCheckBox.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipChildTable.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipChildTable.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipChildTable.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipChildTable.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipChildTable.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipChildTable.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipChildTable.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipComboBox.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipComboBox.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipComboBox.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipComboBox.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipComboBox.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipComboBox.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipComboBox.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipDataField.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipDataField.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipDataField.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipDataField.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipDataField.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipDataField.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipDataField.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipHScrollBar.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipHScrollBar.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipHScrollBar.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipHScrollBar.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipHScrollBar.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipHScrollBar.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipHScrollBar.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipListBox.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipListBox.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipListBox.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipListBox.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipListBox.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipListBox.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipListBox.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipMultilineField.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipMultilineField.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipMultilineField.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipMultilineField.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipMultilineField.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipMultilineField.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipMultilineField.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipOptionButton.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipOptionButton.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipOptionButton.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipOptionButton.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipOptionButton.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipOptionButton.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipOptionButton.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipPicture.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipPicture.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipPicture.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipPicture.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipPicture.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipPicture.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipPicture.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipPushButton.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipPushButton.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipPushButton.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipPushButton.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipPushButton.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipPushButton.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipPushButton.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipRadioButton.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipRadioButton.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipRadioButton.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipRadioButton.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipRadioButton.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipRadioButton.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipRadioButton.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipTableWindow.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipTableWindow.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipTableWindow.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipTableWindow.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipTableWindow.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipTableWindow.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipTableWindow.IsTool | Tests whether a control has a tooltip registration. |
| SalQuickToolTipVScrollBar.AddTool | Associates tooltip text and status text with a control. |
| SalQuickToolTipVScrollBar.SetTipText | Updates the tooltip text for a registered control. |
| SalQuickToolTipVScrollBar.SetStatusText | Updates the status-bar text for a registered control. |
| SalQuickToolTipVScrollBar.GetTipText | Reads a registered control's tooltip text. |
| SalQuickToolTipVScrollBar.DeleteTool | Unregisters a control's tooltip. |
| SalQuickToolTipVScrollBar.GetStatusText | Reads a registered control's status-bar text. |
| SalQuickToolTipVScrollBar.IsTool | Tests 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 |