# SalForm

Namespace: **PPJ.Runtime.Windows**

Assembly: **PPJ.Runtime.49** (4.9.0.0)

Base class for Sal forms.

{% tabs %}
{% tab title="C#" %}

```csharp
public class SalForm : Form, ISalForm, ISalWindow
```

{% endtab %}

{% tab title="VB.NET" %}

```visual-basic
Public Class SalForm
    Inherits Form
    Implements ISalForm, ISalWindow
```

{% endtab %}
{% endtabs %}

## Properties

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)AutoScaleBaseDpi

[Size](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.size): Returns/Sets the DPI used to design this form. This is the base DPI scale and it will be used to scale the form.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)CultureInfo

[CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo): Returns/Sets the culture to use for this form.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)IconName

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Icon name. The image is loaded from the embedded resources.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)NamedProperties

[SalNamedProperties](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform): Returns the collection of named properties.

## Methods

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)BeginUpdate()

Freezes screen updates to the form.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)BringWindowToTop()

Brings a window to the top of all overlapping windows.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)CenterWindow()

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ClearCursor(type)

Clears a window's cursor.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **type**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)DestroyWindow()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)DisableWindow()

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)DrawMenuBar()

Redraws the menu bar for a given form window or top-level table window.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)EnableWindow()

Enables keyboard and mouse input to a window.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)EndDialog(nReturn)

Destroys a modal dialog box and returns control to the caller of SalModalDialog.

| Parameter   | Type                                                                                              | Description |
| ----------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **nReturn** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)EndUpdate()

Enables screen updates to the form.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)FindChild(windowName)

This function finds a child window of a given name in the specified window.

| Parameter      | Type                                                                                              | Description |
| -------------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **windowName** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)FireWindowActions(msg, mywParam, mylParam)

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **msg**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)FireWindowActionsToChildren(msg, mywParam, mylParam)

Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **msg**      | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)                                 |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)FormUnitsToPixels(formUnits, vertical)

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

| Parameter     | Type                                                                                               | Description                                                                                                                        |
| ------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| **formUnits** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)  | The number of form units.                                                                                                          |
| **vertical**  | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetClassName()

Return the name of a window's class as a string.

**Returns:** [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetControlType()

Returns an object's type.

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetDefaultButton()

Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetFirstChild(typeMask)

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

| Parameter    | Type                                                                                              | Description                                                                                            |
| ------------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **typeMask** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | One or more window types combined (using the OR (\|) operator) to create a mask of child window types. |

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetFont(name, size, enhancement)

| Parameter       | Type                                                                                               | Description |
| --------------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **name**        | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **size**        | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **enhancement** | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetFormParameter(paramType)

Returns the value of one of three form window parameters: height, width, or number of pages.

| Parameter     | Type                                                                                              | Description                                                              |
| ------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **paramType** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | One of Sys.FORM.nFormHeight, Sys.FORM\_nFormWidth, Sys.FORM\_nFormPages. |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetLocation(x, y)

| Parameter | Type                                                                                               | Description |
| --------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **x**     | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **y**     | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetName(text)

| Parameter | Type                                                                                               | Description |
| --------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **text**  | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetName()

Gets the name of an object.

**Returns:** [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetNextChild(typeMask)

Returns the handle of the next child window that matches a specified type.

| Parameter    | Type                                                                                              | Description                                                                                            |
| ------------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **typeMask** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | One or more window types combined (using the OR (\|) operator) to create a mask of child window types. |

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetParent()

Returns the handle of an object's parent window.

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetProperty(name, value)

| Parameter | Type                                                                                               | Description |
| --------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **name**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)  |             |
| **value** | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetProperty(name)

Gets the value of a named property.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **name**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetSize(width, height)

| Parameter  | Type                                                                                               | Description |
| ---------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **width**  | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **height** | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetStatusBarText(sText, nMaxLen)

| Parameter   | Type                                                                                               | Description |
| ----------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **sText**   | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **nMaxLen** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)  |             |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetStatusBarText(nMaxLen)

Gets the text displayed in the status bar of a top-level or MDI window.

| Parameter   | Type                                                                                              | Description |
| ----------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **nMaxLen** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetText(text, maxLen)

| Parameter  | Type                                                                                               | Description |
| ---------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **text**   | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **maxLen** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)  |             |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetText(maxLen)

Retrieves the text of a window.

| Parameter  | Type                                                                                              | Description |
| ---------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **maxLen** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetWindowColor(colorIndex)

Gets a window's color.

| Parameter      | Type                                                                                              | Description |
| -------------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **colorIndex** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetWindowState()

Returns a window's current state.

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)HideWindow()

Hides a window.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)InvalidateWindow()

Causes a window to be repainted.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)IsDerivedFromClass(typeClass)

Determines whether a window is an instance of the specified class.

| Parameter     | Type                                                            | Description |
| ------------- | --------------------------------------------------------------- | ----------- |
| **typeClass** | [Type](https://docs.microsoft.com/en-us/dotnet/api/system.type) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)IsEnabled()

Determines whether a window is enabled for mouse and keyboard input.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)IsVisible()

Determines whether a window is currently visible.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)KillTimer(idEvent)

Destroys an object's system timer.

| Parameter   | Type                                                                                              | Description |
| ----------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **idEvent** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)MoveWindow(xOffset, yOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

| Parameter   | Type                                                                                              | Description |
| ----------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **xOffset** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **yOffset** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)PixelsToFormUnits(numPixels, vertical)

Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.

| Parameter     | Type                                                                                               | Description                                                                                                                        |
| ------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| **numPixels** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)  |                                                                                                                                    |
| **vertical**  | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)PostMessage(msg, mywParam, mylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **msg**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SendMessage(msg, mywParam, mylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **msg**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SendMessageToChildren(msg, mywParam, mylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **msg**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetContextMenu(menuName, flags)

Defines a named popup menu that displays automatically when a window receives SAM\_ContextMenu.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **menuName** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **flags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetContextMenu(menuType, flags)

Defines a named popup menu that displays automatically when a window receives SAM\_ContextMenu.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **menuType** | [Type](https://docs.microsoft.com/en-us/dotnet/api/system.type)                                   |             |
| **flags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetCursor(resource, type)

Sets a window's cursor.

| Parameter    | Type                                                                                                      | Description |
| ------------ | --------------------------------------------------------------------------------------------------------- | ----------- |
| **resource** | [SalResourceCursor](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **type**     | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)         |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetCursor(resourceId, type)

Sets a window's cursor.

| Parameter      | Type                                                                                              | Description |
| -------------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **resourceId** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)                                 |             |
| **type**       | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetCursor(blob, type)

Sets a window's cursor from a string variable.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **blob**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **type**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetCursorFile(file, type)

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **file**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **type**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetFocus()

Sets the focus to a specified window.

**Returns:** [SalWindowHandle](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetFont(name, size, enhancement)

Sets a window's font, font size, and font enhancements.

| Parameter       | Type                                                                                              | Description |
| --------------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **name**        | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **size**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **enhancement** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetLocation(x, y)

Moves a window to a new position (x, y) on the X and Y axes.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **x**     | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **y**     | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetProperty(name, value, length)

Sets the value of a named property.

| Parameter  | Type                                                                                              | Description |
| ---------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **name**   | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **value**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **length** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetSize(width, height)

Resizes a window.

| Parameter  | Type                                                                                              | Description |
| ---------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **width**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **height** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetStatusBarText(sText)

Displays specified text in the status bar of a top-level or MDI window.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **sText** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetText(text)

Sets the text of a window.

| Parameter | Type                                                                                              | Description |
| --------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **text**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetTimer(idEvent, elapseMilliSec)

Creates a system timer for a given object. When a timer event occurs, sends SAM\_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

| Parameter          | Type                                                                                              | Description |
| ------------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **idEvent**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **elapseMilliSec** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetWindowColor(colorIndex, color)

Sets a window's color.

| Parameter      | Type                                                                                              | Description |
| -------------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **colorIndex** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **color**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Show(parent)

Shows the form.

| Parameter  | Type                                                                                | Description |
| ---------- | ----------------------------------------------------------------------------------- | ----------- |
| **parent** | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) |             |

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowAsChild(parent, rect, border)

Shows the form as child control.

| Parameter  | Type                                                                                | Description |
| ---------- | ----------------------------------------------------------------------------------- | ----------- |
| **parent** | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) |             |
| **rect**   | [RectangleF](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.rectanglef) |             |
| **border** | [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)               |             |

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowAsChild(parent, rect, border)

Shows the form as child control.

| Parameter  | Type                                                                                | Description |
| ---------- | ----------------------------------------------------------------------------------- | ----------- |
| **parent** | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) |             |
| **rect**   | [Rectangle](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.rectangle)   |             |
| **border** | [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)               |             |

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowDialog(parent)

Shows the modal dialog.

| Parameter  | Type                                                                                | Description |
| ---------- | ----------------------------------------------------------------------------------- | ----------- |
| **parent** | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) |             |

**Returns:** [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowStatusBar(bShow)

Shows or hides the status bar on a top-level or MDI window.

| Parameter | Type                                                                                               | Description |
| --------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **bShow** | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowToolBar(bShow)

Shows or hides the tool bar on a top-level or MDI window.

| Parameter | Type                                                                                               | Description |
| --------- | -------------------------------------------------------------------------------------------------- | ----------- |
| **bShow** | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ShowWindow()

Makes a window visible.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **menuName** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **flags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **x**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **y**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

| Parameter    | Type                                                                                              | Description |
| ------------ | ------------------------------------------------------------------------------------------------- | ----------- |
| **menuType** | [Type](https://docs.microsoft.com/en-us/dotnet/api/system.type)                                   |             |
| **flags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **x**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **y**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)UpdateWindow()

Forces the update of a window.

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)WinHelp(file, command, numData, strData)

Starts the Windows help system.

| Parameter   | Type                                                                                              | Description |
| ----------- | ------------------------------------------------------------------------------------------------- | ----------- |
| **file**    | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **command** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **numData** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |
| **strData** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) |             |

**Returns:** [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform).

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Yield()

Processes messages for this control.

## Events

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)MessageActions

[SalMessageHandler](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) Message Actions

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)PaintBackground

[PaintEventHandler](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.painteventhandler) fired when the form needs to paint the background, this event is missing from WinForms.

### ![](https://299326270-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7qefdGDqaAibSgFIaGI0%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)WindowActions

[WindowActionsEventHandler](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) Window Actions

## Inherited By

| Name                                                                                                               | Description                                                                                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [SalDialogBox](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)               | Summary description for SalDialogBox.                                                                                                                                                                                                         |
| [SalFormTableWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)         | Top level table window implementation.                                                                                                                                                                                                        |
| [SalFormWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)              | Top level form window implementation.                                                                                                                                                                                                         |
| [SalMDIWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)               | Top level MDI window implementation.                                                                                                                                                                                                          |
| [SalQuickTabsDialog](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)         | Dialog Box window parent of a tab frame. This class allows editing of the properties of child windows identifying their associated tab.                                                                                                       |
| [SalQuickTabsForm](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)           | Form window with a tab frame. In addition to containing a built in tab frame. This class also has the smarts to manage other child windows on the form so that they can be associated with specific tabs.                                     |
| [SalQuickTabsParent](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)         | Defines late bound functions in QuickTabs parent Form or Dialog Box that will be called when an event occurs in the tab control.                                                                                                              |
| [SalQuickTabsParentDialog](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)   | Specializes the generic SalQuickTabsParent class into a dialog box implementation. This class should be used when the ported code extends cQuickTabsParent directly. Using this class avoids the creation of multiple inheritance constructs. |
| [SalQuickTabsParentForm](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)     | Specializes the generic SalQuickTabsParent class into a form implementation. This class should be used when the ported code extends cQuickTabsParent directly. Using this class avoids the creation of multiple inheritance constructs.       |
| [SalQuickToolTipTableWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | Pushbutton with tool tip support                                                                                                                                                                                                              |
| [VisSplitterWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)          |                                                                                                                                                                                                                                               |
| [XSalToolbox](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform)                |                                                                                                                                                                                                                                               |

## Implements

| Name                                                                                               | Description                                                                        |
| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [ISalWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/forms/ppj.runtime.windows.salform) | All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |