SalNavigationBar
PPJ.Runtime.Windows.SalNavigationBar
Last updated
PPJ.Runtime.Windows.SalNavigationBar
Last updated
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Runtime.49 (4.9.0.0)
Navigation Bar control (TD 6)
Constructs a SalNavigationBar object.
SalNamedProperties: Returns the collection of named properties.
Adds a new group to the specified pane of a navigation bar.
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.
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)
expandedImage
File name of the image to display for the new pane when it is expanded.
collapsedImage
File name of the image to display for the new pane when it is collapsed.
Returns: SalBoolean.
Associates a control to a pane.
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.
type
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.
paneIndex
Zero-based index of the pane
control
The control you're disassociating
Returns: SalBoolean.
Enables or disables a pane on the navigation bar.
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.
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.
windowName
Returns: SalWindowHandle.
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
msg
mywParam
mylParam
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.
formUnits
The number of form units.
vertical
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.
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.
typeMask
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.
name
size
enhancement
Returns: SalBoolean.
x
y
Returns: SalBoolean.
text
Returns: SalBoolean.
Gets the name of an object.
Returns: SalString.
Returns the handle of the next child window that matches a specified type.
typeMask
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.
paneIndex
binary
format
expanded
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.
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.
paneIndex
title
Returns: SalBoolean.
Returns the title of a pane.
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.
name
value
Returns: SalBoolean.
Gets the value of a named property.
name
Returns: SalString.
width
height
Returns: SalBoolean.
text
maxLen
Returns: SalNumber.
Retrieves the text of a window.
maxLen
Returns: SalString.
Gets a window's color.
colorIndex
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.
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.
typeClass
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.
idEvent
Returns: SalBoolean.
Restore the settings of a navigation bar from an XML string.
xml
Returns: SalBoolean.
Moves a window a given number of form units on the X and Y axes relative to its current position.
xOffset
yOffset
Returns: SalBoolean.
Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
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.
numPixels
vertical
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.
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
msg
mywParam
mylParam
Returns: SalBoolean.
Removes a group from the navigation bar control.
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.
paneIndex
Zero-based index of the pane to be removed.
Returns: SalBoolean.
xml
Returns: SalBoolean.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
msg
mywParam
mylParam
Returns: SalNumber.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
msg
mywParam
mylParam
Returns: SalBoolean.
Activates the indicated pane.
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.
sMenuName
nFlags
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
menuType
flags
Returns: SalBoolean.
Sets a window's cursor.
resource
type
Returns: SalBoolean.
Sets a window's cursor.
resourceId
type
Returns: SalBoolean.
Sets a window's cursor from a string variable.
blob
type
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.
file
type
Returns: SalBoolean.
Sets the focus to a specified window.
Returns: SalWindowHandle.
Sets a window's font, font size, and font enhancements.
name
size
enhancement
Returns: SalBoolean.
Moves a window to a new position (x, y) on the X and Y axes.
x
y
Returns: SalBoolean.
Sets the title of a pane.
paneIndex
Index for the pane.
binary
Buffer that stores the image (bmp or icon).
format
Indicates the image format. Use PIC_FormatIcon or PIC_FormatBitmap.
expanded
TRUE for "expanded" image, FALSE for "collapsed" image
Returns: SalBoolean.
Sets the title of a pane.
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.
name
value
length
Returns: SalBoolean.
Resizes a window.
width
height
Returns: SalBoolean.
Sets the text of a window.
text
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.
idEvent
elapseMilliSec
Returns: SalBoolean.
Sets a window's color.
colorIndex
color
Returns: SalBoolean.
Makes a window visible.
Returns: SalBoolean.
Creates pop-up menus at runtime.
menuName
flags
x
y
Returns: SalBoolean.
Creates pop-up menus at runtime.
menuType
flags
x
y
Returns: SalBoolean.
Forces the update of a window.
Returns: SalBoolean.
Starts the Windows help system.
file
command
numData
strData
Returns: SalBoolean.
Processes messages for this control.
SalMessageHandler Message Actions
WindowActionsEventHandler Window Actions
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.