# SalNavigationBar

Namespace: **PPJ.Runtime.Windows**

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

Navigation Bar control (TD 6)

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

```csharp
public class SalNavigationBar : NaviBar, ISalWindow
```

{% endtab %}

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

```visual-basic
Public Class SalNavigationBar
    Inherits NaviBar
    Implements ISalWindow
```

{% endtab %}
{% endtabs %}

## Constructors

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SalNavigationBar()

Constructs a SalNavigationBar object.

## Properties

### ![](/files/dBIrS7XBDGmrzmTRbSI6)NamedProperties

[SalNamedProperties](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md): Returns the collection of named properties.

## Methods

### ![](/files/dBIrS7XBDGmrzmTRbSI6)AddGroup(paneIndex, groupIndex, groupTitle, height)

Adds a new group to the specified pane of a navigation bar.

| Parameter      | Type                                                                          | Description                                                    |
| -------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------- |
| **paneIndex**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the pane to which you want to add a group. |
| **groupIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index that the new group will occupy.               |
| **groupTitle** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | The title of the new group.                                    |
| **height**     | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | The height of the new group in form units.                     |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)AddPane(paneIndex, name, expandedImage, collapsedImage)

Inserts a pane into the navigation bar control.

| Parameter          | Type                                                                          | Description                                                                                                                                 |
| ------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| **paneIndex**      | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Indicates a zero-based pane index. The new pane will be inserted after the pane indicated by nPaneIndex. Use -1 to append as the last pane. |
| **name**           | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Name of the new pane (object title)                                                                                                         |
| **expandedImage**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | File name of the image to display for the new pane when it is expanded.                                                                     |
| **collapsedImage** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | File name of the image to display for the new pane when it is collapsed.                                                                    |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)AssociateChild(paneIndex, groupIndex, control)

Associates a control to a pane.

| Parameter      | Type                                                                                | Description                                                         |
| -------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| **paneIndex**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)       | Zero-based index of the pane.                                       |
| **groupIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)       | Zero-based index of the group. If the pane has no groups, use zero. |
| **control**    | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) | the control you're associating to the pane.                         |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)BringWindowToTop()

Brings a window to the top of all overlapping windows.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ClearCursor(type)

Clears a window's cursor.

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **type**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)DestroyWindow()

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

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)DisassociateChild(paneIndex, control)

Disassociates a control from a pane.

| Parameter     | Type                                                                                | Description                       |
| ------------- | ----------------------------------------------------------------------------------- | --------------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)       | Zero-based index of the pane      |
| **control**   | [Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) | The control you're disassociating |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)EnablePane(paneIndex, enable)

Enables or disables a pane on the navigation bar.

| Parameter     | Type                                                                           | Description                                |
| ------------- | ------------------------------------------------------------------------------ | ------------------------------------------ |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Index for the pane to enable (start at 0). |
| **enable**    | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Set TRUE to enable pane, FALSE to disable. |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)EnableWindow()

Enables keyboard and mouse input to a window.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ExpandGroup(paneIndex, groupIndex, expand)

Expands or collapses a group.

| Parameter      | Type                                                                           | Description                              |
| -------------- | ------------------------------------------------------------------------------ | ---------------------------------------- |
| **paneIndex**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Zero-based index of the pane             |
| **groupIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Zero-based index of the group            |
| **expand**     | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Set to TRUE to expand, FALSE to collapse |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)FindChild(windowName)

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

| Parameter      | Type                                                                          | Description |
| -------------- | ----------------------------------------------------------------------------- | ----------- |
| **windowName** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalWindowHandle](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mywParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mylParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | The number of form units.                                                                                                          |
| **vertical**  | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | 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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetActivePane()

Returns the index of the currently selected pane.

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md). The zero-based index of the currently selected pane.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetClassName()

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

**Returns:** [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetControlType()

Returns an object's type.

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | One or more window types combined (using the OR (\|) operator) to create a mask of child window types. |

**Returns:** [SalWindowHandle](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetFont(name, size, enhancement)

| Parameter       | Type                                                                           | Description |
| --------------- | ------------------------------------------------------------------------------ | ----------- |
| **name**        | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **size**        | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **enhancement** | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetLocation(x, y)

| Parameter | Type                                                                           | Description |
| --------- | ------------------------------------------------------------------------------ | ----------- |
| **x**     | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **y**     | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetName(text)

| Parameter | Type                                                                           | Description |
| --------- | ------------------------------------------------------------------------------ | ----------- |
| **text**  | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetName()

Gets the name of an object.

**Returns:** [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetNextChild(typeMask)

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

| Parameter    | Type                                                                          | Description                                                                                            |
| ------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **typeMask** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | One or more window types combined (using the OR (\|) operator) to create a mask of child window types. |

**Returns:** [SalWindowHandle](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetPaneIcon(paneIndex, binary, format, expanded)

| Parameter     | Type                                                                           | Description |
| ------------- | ------------------------------------------------------------------------------ | ----------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |             |
| **binary**    | [SalBinary&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **format**    | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |             |
| **expanded**  | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetPaneIndex(name)

Finds the pane by its name and returns a zero-based index of the pane if successful or -1 if the pane is not found.

| Parameter | Type                                                                          | Description                         |
| --------- | ----------------------------------------------------------------------------- | ----------------------------------- |
| **name**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | The name of the pane (object title) |

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md). the zero-based index of the pane. If the pane is not found, nIndex is -1.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetPaneTitle(paneIndex, title)

| Parameter     | Type                                                                           | Description |
| ------------- | ------------------------------------------------------------------------------ | ----------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |             |
| **title**     | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetPaneTitle(paneIndex)

Returns the title of a pane.

| Parameter     | Type                                                                          | Description                                                 |
| ------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Index for the pane whose title you want to get (start at 0) |

**Returns:** [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetParent()

Returns the handle of an object's parent window.

**Returns:** [SalWindowHandle](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetProperty(name, value)

| Parameter | Type                                                                           | Description |
| --------- | ------------------------------------------------------------------------------ | ----------- |
| **name**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |             |
| **value** | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetProperty(name)

Gets the value of a named property.

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **name**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetSize(width, height)

| Parameter  | Type                                                                           | Description |
| ---------- | ------------------------------------------------------------------------------ | ----------- |
| **width**  | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **height** | [SalNumber&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetText(text, maxLen)

| Parameter  | Type                                                                           | Description |
| ---------- | ------------------------------------------------------------------------------ | ----------- |
| **text**   | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **maxLen** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |             |

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetText(maxLen)

Retrieves the text of a window.

| Parameter  | Type                                                                          | Description |
| ---------- | ----------------------------------------------------------------------------- | ----------- |
| **maxLen** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetWindowColor(colorIndex)

Gets a window's color.

| Parameter      | Type                                                                          | Description |
| -------------- | ----------------------------------------------------------------------------- | ----------- |
| **colorIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetWindowState()

Returns a window's current state.

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GroupIsExpanded(paneIndex, groupIndex)

Retrieves the group status. The function returns true if the group is expanded; false if collapsed.

| Parameter      | Type                                                                          | Description                   |
| -------------- | ----------------------------------------------------------------------------- | ----------------------------- |
| **paneIndex**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the pane  |
| **groupIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the group |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)HideWindow()

Hides a window.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)InvalidateWindow()

Causes a window to be repainted.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)IsEnabled()

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

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)IsVisible()

Determines whether a window is currently visible.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)KillTimer(idEvent)

Destroys an object's system timer.

| Parameter   | Type                                                                          | Description |
| ----------- | ----------------------------------------------------------------------------- | ----------- |
| **idEvent** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)LoadState(xml)

Restore the settings of a navigation bar from an XML string.

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **xml**   | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **yOffset** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)PaneIsEnabled(paneIndex)

Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).

| Parameter     | Type                                                                          | Description                 |
| ------------- | ----------------------------------------------------------------------------- | --------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Index of pane (start at 0). |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  |                                                                                                                                    |
| **vertical**  | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | 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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)PostMessage(msg, mywParam, mylParam)

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

| Parameter    | Type                                                                          | Description |
| ------------ | ----------------------------------------------------------------------------- | ----------- |
| **msg**      | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mywParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mylParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)RemoveGroup(paneIndex, groupIndex)

Removes a group from the navigation bar control.

| Parameter      | Type                                                                          | Description                                 |
| -------------- | ----------------------------------------------------------------------------- | ------------------------------------------- |
| **paneIndex**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the pane to be removed. |
| **groupIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the group to remove.    |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)RemovePane(paneIndex)

Removes a pane from the navigation bar control.

| Parameter     | Type                                                                          | Description                                 |
| ------------- | ----------------------------------------------------------------------------- | ------------------------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Zero-based index of the pane to be removed. |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SaveState(xml)

| Parameter | Type                                                                           | Description |
| --------- | ------------------------------------------------------------------------------ | ----------- |
| **xml**   | [SalString&](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mywParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mylParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mywParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **mylParam** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetActivePane(paneIndex)

Activates the indicated pane.

| Parameter     | Type                                                                          | Description                                   |
| ------------- | ----------------------------------------------------------------------------- | --------------------------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | The zero-based index of the pane to activate. |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetContextMenu(sMenuName, nFlags)

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

| Parameter     | Type                                                                          | Description |
| ------------- | ----------------------------------------------------------------------------- | ----------- |
| **sMenuName** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **nFlags**    | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetCursor(resource, type)

Sets a window's cursor.

| Parameter    | Type                                                                                  | Description |
| ------------ | ------------------------------------------------------------------------------------- | ----------- |
| **resource** | [SalResourceCursor](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **type**     | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)         |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetCursor(blob, type)

Sets a window's cursor from a string variable.

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **blob**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **type**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **type**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetFocus()

Sets the focus to a specified window.

**Returns:** [SalWindowHandle](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetFont(name, size, enhancement)

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

| Parameter       | Type                                                                          | Description |
| --------------- | ----------------------------------------------------------------------------- | ----------- |
| **name**        | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **size**        | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **enhancement** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetLocation(x, y)

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

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **x**     | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **y**     | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetPaneIcon(paneIndex, binary, format, expanded)

Sets the title of a pane.

| Parameter     | Type                                                                           | Description                                                           |
| ------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Index for the pane.                                                   |
| **binary**    | [SalBinary](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Buffer that stores the image (bmp or icon).                           |
| **format**    | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md)  | Indicates the image format. Use PIC\_FormatIcon or PIC\_FormatBitmap. |
| **expanded**  | [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | TRUE for "expanded" image, FALSE for "collapsed" image                |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetPaneTitle(paneIndex, title)

Sets the title of a pane.

| Parameter     | Type                                                                          | Description                                                  |
| ------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------ |
| **paneIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | Index for the pane whose title you want to get (start at 0). |
| **title**     | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | The new title for the pane.                                  |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetProperty(name, value, length)

Sets the value of a named property.

| Parameter  | Type                                                                          | Description |
| ---------- | ----------------------------------------------------------------------------- | ----------- |
| **name**   | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **value**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **length** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetSize(width, height)

Resizes a window.

| Parameter  | Type                                                                          | Description |
| ---------- | ----------------------------------------------------------------------------- | ----------- |
| **width**  | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **height** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetText(text)

Sets the text of a window.

| Parameter | Type                                                                          | Description |
| --------- | ----------------------------------------------------------------------------- | ----------- |
| **text**  | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **elapseMilliSec** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetWindowColor(colorIndex, color)

Sets a window's color.

| Parameter      | Type                                                                          | Description |
| -------------- | ----------------------------------------------------------------------------- | ----------- |
| **colorIndex** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **color**      | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ShowWindow()

Makes a window visible.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

| Parameter    | Type                                                                          | Description |
| ------------ | ----------------------------------------------------------------------------- | ----------- |
| **menuName** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **flags**    | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **x**        | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **y**        | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **x**        | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **y**        | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)UpdateWindow()

Forces the update of a window.

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)WinHelp(file, command, numData, strData)

Starts the Windows help system.

| Parameter   | Type                                                                          | Description |
| ----------- | ----------------------------------------------------------------------------- | ----------- |
| **file**    | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **command** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **numData** | [SalNumber](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |
| **strData** | [SalString](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) |             |

**Returns:** [SalBoolean](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Yield()

Processes messages for this control.

## Events

### ![](/files/dBIrS7XBDGmrzmTRbSI6)MessageActions

[SalMessageHandler](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) Message Actions

### ![](/files/dBIrS7XBDGmrzmTRbSI6)WindowActions

[WindowActionsEventHandler](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) Window Actions

## Implements

| Name                                                                           | Description                                                                        |
| ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
| [ISalWindow](/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md) | All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://desktop-api.iceteagroup.com/ppj.runtime.49/controls/ppj.runtime.windows.salnavigationbar.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.