SalNavigationBar
PPJ.Runtime.Windows.SalNavigationBar
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Web.49 (4.9.0.0)
NavigationBar control.
Constructors
Constructs a SalNavigationBar object.
Properties
SalNamedProperties: Returns the collection of named properties.
Methods
Adds a new group to the specified pane of a navigation bar.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane to which you want to add a group. | |
groupIndex | Zero-based index that the new group will occupy. | |
groupTitle | The title of the new group. | |
height | The height of the new group in form units. |
Returns: SalBoolean.
Inserts a pane into the navigation bar control.
Parameter | Type | Description |
---|---|---|
paneIndex | 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 | Name of the new pane (object title) | |
image | File name of the image to display for the new pane. |
Returns: SalBoolean.
Associates a control to a pane.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane. | |
groupIndex | Zero-based index of the group. If the pane has no groups, use zero. | |
control | the control you're associating to the pane. |
Returns: SalBoolean.
Brings a window to the top of all overlapping windows.
Returns: SalBoolean.
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.
Clears a window's cursor.
Parameter | Type | Description |
---|---|---|
nType |
Returns: SalBoolean.
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.
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.
Disassociates a control from a pane.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane | |
control | The control you're disassociating |
Returns: SalBoolean.
Enables or disables a pane on the navigation bar.
Parameter | Type | Description |
---|---|---|
paneIndex | Index for the pane to enable (start at 0). | |
enable | Set TRUE to enable pane, FALSE to disable. |
Returns: SalBoolean.
Enables keyboard and mouse input to a window.
Returns: SalBoolean.
Expands or collapses a group.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane | |
groupIndex | Zero-based index of the group | |
expand | Set to TRUE to expand, FALSE to collapse |
Returns: SalBoolean.
This function finds a child window of a given name in the specified window.
Parameter | Type | Description |
---|---|---|
sWindowName |
Returns: SalWindowHandle.
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Returns: SalNumber.
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 |
---|---|---|
nFormUnits | ||
bVertical |
Returns: SalNumber.
Returns the index of the currently selected pane.
Returns: SalNumber. The zero-based index of the currently selected pane.
Return the name of a window's class as a string.
Returns: SalString.
Returns an object's type.
Returns: SalNumber.
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 |
---|---|---|
nTypeMask |
Returns: SalWindowHandle.
Parameter | Type | Description |
---|---|---|
sName | ||
nSize | ||
nEnhancement |
Returns: SalBoolean.
Parameter | Type | Description |
---|---|---|
nX | ||
nY |
Returns: SalBoolean.
Parameter | Type | Description |
---|---|---|
sText |
Returns: SalBoolean.
Gets the name of an object.
Returns: SalString.
Returns the handle of the next child window that matches a specified type.
Parameter | Type | Description |
---|---|---|
nTypeMask |
Returns: SalWindowHandle.
Parameter | Type | Description |
---|---|---|
paneIndex | ||
image |
Returns: SalBoolean.
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 | The name of the pane (object title) |
Returns: SalNumber. the zero-based index of the pane. If the pane is not found, nIndex is -1.
Parameter | Type | Description |
---|---|---|
paneIndex | ||
title |
Returns: SalBoolean.
Returns the title of a pane.
Parameter | Type | Description |
---|---|---|
paneIndex | Index for the pane whose title you want to get (start at 0) |
Returns: SalString.
Returns the handle of an object's parent window.
Returns: SalWindowHandle.
Parameter | Type | Description |
---|---|---|
sName | ||
sValue |
Returns: SalBoolean.
Gets the value of a named property.
Parameter | Type | Description |
---|---|---|
sName |
Returns: SalString.
Parameter | Type | Description |
---|---|---|
nWidth | ||
nHeight |
Returns: SalBoolean.
Parameter | Type | Description |
---|---|---|
sText | ||
nMaxLen |
Returns: SalNumber.
Retrieves the text of a window.
Parameter | Type | Description |
---|---|---|
nMaxLen |
Returns: SalString.
Gets a window's color.
Parameter | Type | Description |
---|---|---|
nColorIndex |
Returns: SalNumber.
Returns a window's current state.
Returns: SalNumber.
Retrieves the group status. The function returns true if the group is expanded; false if collapsed.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane | |
groupIndex | Zero-based index of the group |
Returns: SalBoolean.
Hides a window.
Returns: SalBoolean.
Causes a window to be repainted.
Returns: SalBoolean.
Determines whether a window is an instance of the specified class.
Parameter | Type | Description |
---|---|---|
tClass |
Returns: SalBoolean.
Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
Determines whether a window is currently visible.
Returns: SalBoolean.
Destroys an object's system timer.
Parameter | Type | Description |
---|---|---|
nIDEvent |
Returns: SalBoolean.
Restore the settings of a navigation bar from an XML string.
Parameter | Type | Description |
---|---|---|
xml |
Returns: SalBoolean.
Moves a window a given number of form units on the X and Y axes relative to its current position.
Returns: SalBoolean.
Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
Parameter | Type | Description |
---|---|---|
paneIndex | Index of pane (start at 0). |
Returns: SalBoolean.
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 |
---|---|---|
nNumPixels | ||
bVertical |
Returns: SalNumber.
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
Removes a group from the navigation bar control.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane to be removed. | |
groupIndex | Zero-based index of the group to remove. |
Returns: SalBoolean.
Removes a pane from the navigation bar control.
Parameter | Type | Description |
---|---|---|
paneIndex | Zero-based index of the pane to be removed. |
Returns: SalBoolean.
Parameter | Type | Description |
---|---|---|
xml |
Returns: SalBoolean.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Returns: SalNumber.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
Activates the indicated pane.
Parameter | Type | Description |
---|---|---|
paneIndex | The zero-based index of the pane to activate. |
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Sets a window's cursor.
Returns: SalBoolean.
Sets a window's cursor from a string variable.
Returns: SalBoolean.
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
Returns: SalBoolean.
Sets the focus to a specified window.
Returns: SalWindowHandle.
Sets a window's font, font size, and font enhancements.
Returns: SalBoolean.
Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
Sets the title of a pane.
Parameter | Type | Description |
---|---|---|
paneIndex | Index for the pane. | |
image | File name of the image to display for the pane. |
Returns: SalBoolean.
Sets the title of a pane.
Parameter | Type | Description |
---|---|---|
paneIndex | Index for the pane whose title you want to get (start at 0). | |
title | The new title for the pane. |
Returns: SalBoolean.
Sets the value of a named property.
Returns: SalBoolean.
Resizes a window.
Returns: SalBoolean.
Sets the text of a window.
Parameter | Type | Description |
---|---|---|
sText |
Returns: SalBoolean.
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.
Returns: SalBoolean.
Sets a window's color.
Returns: SalBoolean.
Makes a window visible.
Returns: SalBoolean.
Creates pop-up menus at runtime.
Parameter | Type | Description |
---|---|---|
sMenuName | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Creates pop-up menus at runtime.
Parameter | Type | Description |
---|---|---|
menuType | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Forces the update of a window.
Returns: SalBoolean.
Events
WindowActionsEventHandler Window Actions
Implements
Name | Description |
---|---|
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |
Last updated