SalForm
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Runtime.50 (5.0.0.0)
Supplies shared SAL form behavior, including window actions, control labels, form state, and application lifetime tracking.
- C#
- VB.NET
public class SalForm : Form, ISalForm, ISalWindow
Public Class SalForm
Inherits Form
Implements ISalForm, ISalWindow
Example:
public class CustomerWindow : PPJ.Runtime.Windows.SalForm
{
public CustomerWindow()
{
Text = "Customers";
}
}
Properties
AutoScaleBaseDpi
Size: Gets or sets the DPI basis recorded for automatic scaling.
CreateParams
CreateParams: Gets native creation parameters, using a border without a caption for embedded fixed-border forms.
CultureInfo
CultureInfo: Gets or sets the culture used by the form.
Throws:
- ArgumentException A neutral culture is assigned.
IconName
String: Gets or sets the embedded resource name used to load the form icon.
NamedProperties
SalNamedProperties: Gets the SAL named-property collection associated with this control.
Methods
BeginUpdate()
Suspends form redraw while a batch of changes is made.
Calls nest and must be matched by EndUpdate. The call has no effect before a handle exists.
BringWindowToTop()
Brings this control to the front, or activates it when it is a top-level or MDI form.
Returns: SalBoolean. True if the translated control exists; otherwise, false.
CenterWindow()
Centers this window within its parent or, for a top-level form, its owner or screen working area.
Returns: SalBoolean. True when the translated control exists; otherwise, false.
A top-level form is constrained to the selected screen working area. A control without a parent is unchanged unless it is a top-level form.
ClearCursor(type)
Restores the default cursor for a role, using the I-beam for TextBox subclasses.
| Parameter | Type | Description |
|---|---|---|
| type | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.
CreateForm()
Initializes scaling, creates the form handle, and completes SAL creation once.
Reentrant or already completed creation requests are ignored.
DefWndProc(m)
Dispatches unhandled messages to the MDI-child procedure when required, or to the base form procedure.
| Parameter | Type | Description |
|---|---|---|
| m | Message | The message to process. |
DestroyWindow()
Closes this window when it is a form, or disposes the control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
A true result reports that the close or disposal request was made; a form can apply its own closing behavior.
DisableWindow()
Disables input to this control, or clears editability for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Dispose(disposing)
Disposes the form while preserving owner lookup during destruction, then releases a custom icon.
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean | True to release managed resources as well as native resources. |
DrawMenuBar()
UpdateMainMenu applied to this form.
Returns: SalBoolean. The result returned by SalWindow.UpdateMainMenu.
EnableWindow()
Enables input to this control, or enables editing for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For text-box controls, this operation also clears the read-only setting.
Native disabled styles are also cleared. When needed, tab navigation is restored except for unchecked radio buttons.
EndDialog(nReturn)
EndDialog applied to this form.
| Parameter | Type | Description |
|---|---|---|
| nReturn | SalNumber | The SAL dialog result. |
Returns: SalBoolean. The result returned by SalWindow.EndDialog.
EndUpdate()
Completes a redraw suspension and invalidates the form when the outermost update ends.
A call without a matching BeginUpdate has no effect.
FindChild(windowName)
Searches this window for a child control by name.
| Parameter | Type | Description |
|---|---|---|
| windowName | SalString | The child control name to locate. |
Returns: SalWindowHandle. The matching child handle, or a null SAL handle if no child is found.
FireWindowActions(msg, mywParam, mylParam)
Invokes this control's SAL action handlers directly and returns their result.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | The action message code. |
| mywParam | SalNumber | The first action parameter. |
| mylParam | SalNumber | The second action parameter. |
Returns: SalNumber. The result stored in the dispatched action arguments.
FireWindowActionsToChildren(msg, mywParam, mylParam)
FireWindowActionsToChildren applied to this form.
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 | The message identifier. |
| mywParam | SalNumber | The first message parameter. |
| mylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. The result returned by SalWindow.FireWindowActionsToChildren.
FormUnitsToPixels(formUnits, vertical)
Converts a length in form units to pixels using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| formUnits | SalNumber | The length in form units. |
| vertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted pixel length.
GetClassName()
Gets the translated application class name associated with this control.
Returns: SalString. The class name, an empty string for a runtime-defined class, or a null SAL string for an unresolved or native control.
Forms use their base type; nested table-window types are walked upward to a non-nested type.
GetControlType()
Gets the SAL window type of this control.
Returns: SalNumber. The SAL Sys.TYPE_* code for the translated control.
GetDefaultButton()
GetDefaultButton applied to this form.
Returns: SalWindowHandle. The result returned by SalWindow.GetDefaultButton.
GetFirstChild(typeMask)
Finds the first child matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The first matching child handle, or a null SAL handle when none matches.
Ordinary controls use tab order; table columns use their creation order, and MDI forms use their child-form collection.
GetFont(name, size, enhancement)
Reads the control font's family, point size, and style flags.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | Receives the font family name. |
| size | SalNumber | Receives the size in points. |
| enhancement | SalNumber | Receives the combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if a font was available; otherwise, false.
GetFormParameter(paramType)
Returns a display-area dimension or the number of client-height pages.
| Parameter | Type | Description |
|---|---|---|
| paramType | SalNumber | Sys.FORM_nFormHeight, FORM_nFormWidth, or FORM_nFormPages. |
Returns: SalNumber. Height or width in form units, the integer display-height/client-height quotient for pages, or zero for an unknown selector.
GetLocation(x, y)
Reads this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | Receives the horizontal location. |
| y | SalNumber | Receives the vertical location. |
Returns: SalBoolean. Always true; an unresolved control produces zero coordinates.
GetName(text)
Copies this control's name to the supplied variable.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | Receives the control name when the operation succeeds. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
GetName()
Gets this control's name.
Returns: SalString. The control name, or an empty string if the control cannot be resolved.
GetNextChild(typeMask)
Finds the next sibling matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The next matching control handle, or a null SAL handle when none matches.
GetParent()
Gets the SAL parent form, owner, or table container for this control.
Returns: SalWindowHandle. The parent window handle, or a null SAL handle if no parent can be resolved.
GetProperty(name, value)
Reads a SAL named property into a supplied variable.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | The property name. |
| value | SalString | Receives the value only when the property is found. |
Returns: SalBoolean. True if a non-null property value was found; otherwise, false.
GetProperty(name)
Gets the value of a SAL named property.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | The property name. |
Returns: SalString. The property value, or a SAL null string if the value is unavailable.
GetSize(width, height)
Reads this control's size in form units.
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber | Receives the width. |
| height | SalNumber | Receives the height. |
Returns: SalBoolean. Always true; an unresolved control produces a zero size.
GetStatusBarText(sText, nMaxLen)
GetStatusBarText applied to this form.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the status-bar text. |
| nMaxLen | SalNumber | The maximum number of text characters. |
Returns: SalNumber. The result returned by SalWindow.GetStatusBarText.
GetStatusBarText(nMaxLen)
GetStatusBarText applied to this form.
| Parameter | Type | Description |
|---|---|---|
| nMaxLen | SalNumber | The maximum number of text characters. |
Returns: SalString. The result returned by SalWindow.GetStatusBarText.
GetText(text, maxLen)
Copies this control's displayed text or long-string value to a SAL string.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | Receives the retrieved text. |
| maxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalNumber. The number of characters copied, or zero when no text is available.
GetText(maxLen)
Gets this control's displayed text or long-string value.
| Parameter | Type | Description |
|---|---|---|
| maxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalString. The retrieved text, or an empty string if the control cannot be resolved.
GetWindowColor(colorIndex)
Reads a window or cell color as a Win32 color value.
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber | The Sys.COLOR_Index* color component to read. |
Returns: SalNumber. The color encoded as a Win32 color value, or zero if the control is unavailable.
Transparent colors are reported as Sys.COLOR_None. Table-column window colors use the system window colors; cell colors use the column settings.
GetWindowState()
Gets the visibility and form-state classification of this window.
Returns: SalNumber. A Sys.Window_* state code; visible non-form controls report Sys.Window_Normal.
HideWindow()
Hides this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
InvalidateWindow()
Invalidates this control and its child controls for repainting.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
IsDerivedFromClass(typeClass)
Tests this control's runtime type against an application base type.
| Parameter | Type | Description |
|---|---|---|
| typeClass | Type | The type to test, including the framework's emulated inheritance relationships. |
Returns: SalBoolean. True if the runtime type derives from the requested type; otherwise, false.
IsEnabled()
Determines whether this control accepts input.
Returns: SalBoolean. The enabled state, or the editable flag for a table column; false if the control cannot be resolved.
IsVisible()
Determines whether this control is visible.
Returns: SalBoolean. The visible state, or the visibility flag for a table column; false if the control cannot be resolved.
KillTimer(idEvent)
Stops the native window timer with the specified identifier.
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber | The timer identifier to remove. |
Returns: SalBoolean. The native timer-removal result, or false if the control cannot be resolved.
MoveWindow(xOffset, yOffset)
Moves this control by an offset expressed in form units.
| Parameter | Type | Description |
|---|---|---|
| xOffset | SalNumber | The horizontal offset to add to the current position. |
| yOffset | SalNumber | The vertical offset to add to the current position. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
OnActivated(e)
Raises activation, sends SAM_Activate with an active value, and schedules deferred validation.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnDeactivate(e)
Raises deactivation, sends SAM_Activate with an inactive value, and records eligible forms for deferred validation.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnFontChanged(e)
Applies eligible font-based form scaling before raising the font-change event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnHandleCreated(e)
Registers a newly created runtime form and sends SAL creation messages to its children.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnHandleDestroyed(e)
Unregisters the destroyed form, marks it closed, and restores the previously active window for an unowned modal dialog.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnMdiChildActivate(e)
Raises the MDI activation event and refreshes the main menu.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnMenuComplete(e)
Raises menu completion and clears the status-bar text.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnPaintBackground(e)
Raises PaintBackground before invoking the base background painter.
| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | The graphics surface and repaint region. |
PixelsToFormUnits(numPixels, vertical)
Converts a pixel length to form units using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| numPixels | SalNumber | The pixel length to convert. |
| vertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted length in form units.
PostMessage(msg, mywParam, mylParam)
Posts a native Windows message to this control for asynchronous processing.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | The Windows or SAL message code. |
| mywParam | SalNumber | The first message parameter. |
| mylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. True if the native message was posted; false for an unavailable or disposed control, or if posting fails.
ProcessCmdKey(msg, keyData)
Processes SAL Enter-to-Tab mapping, Tab window actions, menu shortcuts, and button accelerators.
| Parameter | Type | Description |
|---|---|---|
| msg | Message | The keyboard message. |
| keyData | Keys | The key and modifier flags. |
Returns: Boolean. True when a handler or accelerator consumes the key.
ProcessDialogKey(keyData)
Applies Enter-to-Tab mapping and grouped radio-button arrow navigation before default dialog-key handling.
| Parameter | Type | Description |
|---|---|---|
| keyData | Keys | The key and modifier flags. |
Returns: Boolean. True when the key is handled.
ProcessTabKey(forward)
Moves focus through embedded forms and toolbar groups while enabling keyboard focus cues.
| Parameter | Type | Description |
|---|---|---|
| forward | Boolean | True to move forward; false to move backward. |
Returns: Boolean. Whether navigation was handled.
Scale(oldScale, newScale)
Scales the form through the SAL scaling implementation.
| Parameter | Type | Description |
|---|---|---|
| oldScale | Size | The previous horizontal and vertical scale basis. |
| newScale | Size | The new horizontal and vertical scale basis. |
ScaleCore(x, y)
Scales the form at runtime and suppresses this scaling path in the designer.
| Parameter | Type | Description |
|---|---|---|
| x | Single | The horizontal scale factor. |
| y | Single | The vertical scale factor. |
Select(directed, forward)
Selects the form unless doing so would displace an already visible active MDI child.
| Parameter | Type | Description |
|---|---|---|
| directed | Boolean | Whether selection results from directed navigation. |
| forward | Boolean | Whether navigation proceeds forward. |
SendMessage(msg, mywParam, mylParam)
Sends a native Windows message to this control synchronously.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | The Windows or SAL message code. |
| mywParam | SalNumber | The first message parameter. |
| mylParam | SalNumber | The second message parameter. |
Returns: SalNumber. The native message result, or zero when the control is unavailable or disposed.
SendMessageToChildren(msg, mywParam, mylParam)
Sends a message to this control's child windows and eligible descendants.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | The Windows or SAL message code. |
| mywParam | SalNumber | The first message parameter. |
| mylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. True after dispatching; false when the parent is unavailable or disposed.
Traversal does not descend into embedded forms or user controls. Close and destroy messages for ordinary child controls are routed to their action handlers instead of their native window procedures.
SetContextMenu(menuName, flags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| menuName | SalString | The menu type name to resolve. |
| flags | SalNumber | Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu. |
Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.
When called during a SAL context-menu action, the created menu is also shown at the current mouse position.
SetContextMenu(menuType, flags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The menu type to instantiate. |
| flags | SalNumber | Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu. |
Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.
When called during a SAL context-menu action, the created menu is also shown at the current mouse position.
SetCursor(resource, type)
Loads a cursor resource and assigns it to the requested role.
| Parameter | Type | Description |
|---|---|---|
| resource | SalResourceCursor | The cursor resource to load. |
| type | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.
SetCursor(resourceId, type)
Assigns a system cursor or a cursor identified by its native handle to the requested role.
| Parameter | Type | Description |
|---|---|---|
| resourceId | Int32 | A Sys.CURSOR_* identifier, or a native cursor handle represented as an integer. |
| type | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.
SetCursor(blob, type)
Loads a cursor from binary data and assigns it to the requested role.
| Parameter | Type | Description |
|---|---|---|
| blob | SalString | The cursor file data stored in a SAL binary string. |
| type | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.
SetCursorFile(file, type)
Loads a cursor file and assigns it to the requested role.
| Parameter | Type | Description |
|---|---|---|
| file | SalString | The cursor file path. |
| type | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.
SetFocus()
Moves keyboard focus to this control, deferring the change when SAL validation is in progress.
Returns: SalWindowHandle. The previously focused managed control as a SAL handle, or a null handle if the target is unavailable, a table column, an ActiveX host, disabled, or hidden.
SetFont(name, size, enhancement)
Creates and assigns a font to this control.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | The font family name. |
| size | SalNumber | The font size in points. |
| enhancement | SalNumber | The combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if the font was created and assigned; otherwise, false.
SetLocation(x, y)
Sets this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | The new horizontal coordinate. |
| y | SalNumber | The new vertical coordinate. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For forms, this also selects manual startup positioning.
SetProperty(name, value, length)
Assigns a SAL named property after limiting the value's length.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | The property name. |
| value | SalString | The value to assign. |
| length | SalNumber | The number of leading characters to retain. |
Returns: SalBoolean. True if the translated control implements the SAL window contract; otherwise, false.
SetSize(width, height)
Sets this control's dimensions in form units.
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber | The new width. |
| height | SalNumber | The new height. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetStatusBarText(sText)
SetStatusBarText applied to this form.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | The status-bar text to display. |
Returns: SalBoolean. The result returned by SalWindow.SetStatusBarText.
SetText(text)
Assigns the control's displayed text.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | The text to assign. |
Returns: SalBoolean. True if the translated control exists and assignment completes; otherwise, false.
An empty string is passed as null when assigning combo-box text.
SetTimer(idEvent, elapseMilliSec)
Creates or updates a native window timer for this control.
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber | The timer identifier. |
| elapseMilliSec | SalNumber | The requested interval in milliseconds. |
Returns: SalBoolean. True if the native timer was created; otherwise, false.
SetVisibleCore(value)
Coordinates visibility with SAL creation, showing, and closing states.
| Parameter | Type | Description |
|---|---|---|
| value | Boolean | True to request display; false to hide. |
Secondary-base instances remain hidden. Showing an uncreated form initiates SAL form creation.
SetWindowColor(colorIndex, color)
Assigns a SAL window, table-cell, text, or transparent-image color.
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber | The Sys.COLOR_Index* component to update. |
| color | SalNumber | The SAL color value. |
Returns: SalBoolean. True for a recognized color index and resolved control, even when the component does not apply to that control; otherwise, false.
Cell colors apply to table columns; window colors apply to other controls. Transparent colors require the SAL picture-control contract.
Show(parent)
Shows the form modelessly using SAL ownership and MDI-parent rules.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The control used to resolve the owner or MDI container. |
Modeless dialog boxes remain top-level windows. Owned windows are excluded from the taskbar.
ShowAsChild(parent, rect, border)
Embeds and shows the form as a child control at the specified bounds.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The parent control; a form's SAL client area is used when available. |
| rect | RectangleF | The location and size in form units. A width or height of -1 preserves that dimension. |
| border | Boolean | True to show a thin border; false for a borderless child. |
The embedded form's status bar is hidden. Throws:
- InvalidOperationException This form is an MDI container.
ShowAsChild(parent, rect, border)
Embeds and shows the form as a child control at the specified bounds.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The parent control; a form's SAL client area is used when available. |
| rect | Rectangle | The location and size in pixels. A width or height of -1 preserves that dimension. |
| border | Boolean | True to show a thin border; false for a borderless child. |
The embedded form's status bar is hidden. Throws:
- InvalidOperationException This form is an MDI container.
ShowDialog(parent)
Shows a modal dialog with SAL owner resolution and returns its SAL result.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | The control used to resolve the dialog owner, or null for an unowned dialog. |
Returns: Int32. The value supplied by the dialog through EndDialog.
The dialog is scheduled for delayed disposal after it closes. Throws:
- InvalidOperationException This form is an MDI container.
ShowStatusBar(bShow)
ShowStatusBar applied to this form.
| Parameter | Type | Description |
|---|---|---|
| bShow | SalBoolean | True to show the accessory; false to hide it. |
Returns: SalBoolean. The result returned by SalWindow.ShowStatusBar.
ShowToolBar(bShow)
ShowToolBar applied to this form.
| Parameter | Type | Description |
|---|---|---|
| bShow | SalBoolean | True to show the accessory; false to hide it. |
Returns: SalBoolean. The result returned by SalWindow.ShowToolBar.
ShowWindow()
Shows this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
TrackPopupMenu(menuName, flags, x, y)
Creates and displays a temporary popup menu at screen coordinates.
| Parameter | Type | Description |
|---|---|---|
| menuName | SalString | The menu type name to resolve. |
| flags | SalNumber | SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported. |
| x | SalNumber | The screen X coordinate, unless TPM_CursorX selects the cursor position. |
| y | SalNumber | The screen Y coordinate, unless TPM_CursorY selects the cursor position. |
Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.
The previous context menu is restored after display and the temporary menu is queued for disposal.
TrackPopupMenu(menuType, flags, x, y)
Creates and displays a temporary popup menu at screen coordinates.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The menu type to instantiate. |
| flags | SalNumber | SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported. |
| x | SalNumber | The screen X coordinate, unless TPM_CursorX selects the cursor position. |
| y | SalNumber | The screen Y coordinate, unless TPM_CursorY selects the cursor position. |
Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.
The previous context menu is restored after display and the temporary menu is queued for disposal.
UpdateWindow()
Requests an update of this control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
WinHelp(file, command, numData, strData)
Invokes the legacy Windows Help API for this control.
| Parameter | Type | Description |
|---|---|---|
| file | SalString | The help file path. |
| command | SalNumber | The Sys.HELP_* command. |
| numData | SalNumber | The numeric topic or index for HELP_Context and HELP_SetIndex. |
| strData | SalString | The lookup text for HELP_Key. |
Returns: SalBoolean. The native help result, or false for an empty file name.
WndProc(m)
Handles SAL focus, mouse-wheel, and activation behavior before dispatching window messages through the SAL adapter.
| Parameter | Type | Description |
|---|---|---|
| m | Message | The window message and its result. |
Yield()
Dispatches one pending message for this window, or processes application messages when no window handle exists.
Message dispatch can reenter application code.
Events
MessageActions
SalMessageHandler Provides the legacy SAL message-handler event.
Use WindowActions for new handlers.
PaintBackground
PaintEventHandler Occurs immediately before the base form paints its background.
WindowActions
WindowActionsEventHandler Occurs when this control dispatches a SAL or custom window action.
Inherited By
| Name | Description |
|---|---|
| SalDialogBox | Provides a SAL dialog with a fixed border and no minimize, maximize, or taskbar button. |
| SalFormTableWindow | Provides a top-level form whose client area contains a SAL table window. |
| SalFormWindow | Provides a standard SAL application form with automatic scrolling enabled. |
| SalMDIWindow | Provides a SAL multiple-document container with optional tabbed child-window management. |
| SalQuickTabsDialog | Provides a dialog with a built-in fill-docked QuickTabs frame. |
| SalQuickTabsForm | Provides a form with a built-in fill-docked QuickTabs frame. |
| SalQuickTabsParent | Provides overridable callbacks for a child QuickTabs frame. |
| SalQuickTabsParentDialog | Provides a dialog-style host for QuickTabs callbacks. |
| SalQuickTabsParentForm | Provides a form host for QuickTabs callbacks. |
| SalQuickToolTipTableWindow | Provides a SAL table window with Quick Objects tooltip and status-text compatibility methods. |
| VisSplitterWindow | |
| XSalToolbox |
Implements
| Name | Description |
|---|---|
| ISalWindow | Exposes SAL message dispatch and runtime metadata for child controls, forms, dialogs, and MDI windows. |