# SalPushbutton

Namespace: **PPJ.Runtime.Windows**

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

An object that you can click (or double-click) to create an event and invoke some action.

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

```csharp
public class SalPushbutton : Button, ISalWindow, ISalControl, ISalPictureControl
```

{% endtab %}

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

```visual-basic
Public Class SalPushbutton
    Inherits Button
    Implements ISalWindow, ISalControl, ISalPictureControl
```

{% endtab %}
{% endtabs %}

## Constructors

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

Constructs a SalPushbutton object.

## 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)AcceleratorKey

[Keys](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.keys): Keyboard shortcut for choosing a menu item or pressing a push button.

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

[Image](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.image): Overrides the default Image property.

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

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Image name. Name of the image to load from the embedded resources. (Default: `""`)

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

[Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control): Returns/Sets the label associated with this 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)NamedProperties

[SalNamedProperties](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton): Returns the collection of named 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)TransparentColor

[Color](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.color): Transparent color.

## 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)BringWindowToTop()

Brings a window to the top of all overlapping windows.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Clears the value from a data field, multi line field, or table window column.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Deletes the contents of a picture.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. 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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton)  | The number of form units.                                                                                                          |
| **vertical**  | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) | 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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Returns a data field's or table window column's data type.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) | 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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **size**        | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **enhancement** | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

| Parameter       | Type                                                                                                        | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------- | ----------- |
| **sImageBytes** | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **nType**       | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

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

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

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

Retrieves a description of a picture's contents.

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

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

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

| Parameter   | Type                                                                                                        | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------- | ----------- |
| **nFormat** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)  |             |
| **sPict**   | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Return the contents of a picture into a string.

| Parameter   | Type                                                                                                       | Description |
| ----------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **nFormat** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.

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

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

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

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

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

Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.

| Parameter      | Type                                                                                                       | Description |
| -------------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **nMaxLength** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **y**     | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) | 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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton)  |             |
| **value** | [SalString&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **height** | [SalNumber&](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **maxLen** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)  |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Hides a window and its associated label.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Returns the setting of the Field Edit Flag for a data field, multi line field, combo box, table window's context row cell, or picture.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **yOffset** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Triggers the OnClick event.

### ![](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/controls/ppj.runtime.windows.salpushbutton)  |                                                                                                                                    |
| **vertical**  | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) | 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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **mywParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **mylParam** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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(sMenuName, nFlags)

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

| Parameter     | Type                                                                                                       | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **sMenuName** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **nFlags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **type**     | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)         |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **type**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **type**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Sets the default push button of a form window or dialog box.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **size**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **enhancement** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Inserts the contents of a picture to an image without the image header.

| Parameter       | Type                                                                                                       | Description |
| --------------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **sImageBytes** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **nType**       | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Inserts a file's contents into a picture.

| Parameter     | Type                                                                                                       | Description |
| ------------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **sFileName** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Sets the picture image of a picture window with the handle of a bitmap (HBITMAP) or icon (HICON). Usually, HBITMAPs and HICONs are loaded from DLLs.

| Parameter   | Type                                                                                                       | Description |
| ----------- | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **nType**   | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **nHandle** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Inserts a resource into a picture.

| Parameter     | Type                                                                                                         | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------ | ----------- |
| **tResource** | [SalResource](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **nFormat**   | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)   |             |

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

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

Inserts the contents of a string into a picture.

| Parameter    | Type                                                                                                       | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------- | ----------- |
| **nFormat**  | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **sPicture** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Sets the text of the associated label control.

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

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **y**     | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

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

Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.

| Parameter | Type                                                                                                        | Description |
| --------- | ----------------------------------------------------------------------------------------------------------- | ----------- |
| **bSet**  | [SalBoolean](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **value**  | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **length** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **height** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **elapseMilliSec** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **color**      | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

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

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **flags**    | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **x**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **y**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **x**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **y**        | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton).

### ![](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/controls/ppj.runtime.windows.salpushbutton) |             |
| **command** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **numData** | [SalNumber](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |
| **strData** | [SalString](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) |             |

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

### ![](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/controls/ppj.runtime.windows.salpushbutton) 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)WindowActions

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

## Inherited By

| Name                                                                                                                       | Description                      |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [SalQuickToolTipPushButton](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) | Pushbutton with tool tip support |
| [XSalFlatButton](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)            |                                  |

## Implements

| Name                                                                                                                | Description                                                                        |
| ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [ISalControl](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)        | All SAL controls implement this interface.                                         |
| [ISalPictureControl](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton) | SAL Controls that display a picture implement this interface.                      |
| [ISalWindow](https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salpushbutton)         | All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |