SalNavigationBar

PPJ.Runtime.Windows.SalNavigationBar

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

Navigation Bar control (TD 6)

public class SalNavigationBar : NaviBar, ISalWindow

Constructors

SalNavigationBar()

Constructs a SalNavigationBar object.

Properties

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Methods

AddGroup(paneIndex, groupIndex, groupTitle, height)

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.

AddPane(paneIndex, name, expandedImage, collapsedImage)

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)

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.

AssociateChild(paneIndex, groupIndex, control)

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.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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.

ClearCursor(type)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

DestroyWindow()

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

Returns: SalBoolean.

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.

DisassociateChild(paneIndex, control)

Disassociates a control from a pane.

Parameter
Type
Description

paneIndex

Zero-based index of the pane

control

The control you're disassociating

Returns: SalBoolean.

EnablePane(paneIndex, enable)

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.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

ExpandGroup(paneIndex, groupIndex, expand)

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.

FindChild(windowName)

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

Parameter
Type
Description

windowName

Returns: SalWindowHandle.

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

mywParam

mylParam

Returns: SalNumber.

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

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.

GetActivePane()

Returns the index of the currently selected pane.

Returns: SalNumber. The zero-based index of the currently selected pane.

GetClassName()

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

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

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

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter
Type
Description

Returns: SalBoolean.

GetLocation(x, y)

Parameter
Type
Description

Returns: SalBoolean.

GetName(text)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

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

Parameter
Type
Description

typeMask

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetPaneIcon(paneIndex, binary, format, expanded)

Parameter
Type
Description

paneIndex

format

expanded

Returns: SalBoolean.

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

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.

GetPaneTitle(paneIndex, title)

Parameter
Type
Description

paneIndex

Returns: SalBoolean.

GetPaneTitle(paneIndex)

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.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetSize(width, height)

Parameter
Type
Description

Returns: SalBoolean.

GetText(text, maxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter
Type
Description

maxLen

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

GroupIsExpanded(paneIndex, groupIndex)

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.

HideWindow()

Hides a window.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter
Type
Description

typeClass

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter
Type
Description

idEvent

Returns: SalBoolean.

LoadState(xml)

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

Parameter
Type
Description

Returns: SalBoolean.

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

yOffset

Returns: SalBoolean.

PaneIsEnabled(paneIndex)

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.

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

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.

PostMessage(msg, mywParam, mylParam)

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

Parameter
Type
Description

mywParam

mylParam

Returns: SalBoolean.

RemoveGroup(paneIndex, groupIndex)

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.

RemovePane(paneIndex)

Removes a pane from the navigation bar control.

Parameter
Type
Description

paneIndex

Zero-based index of the pane to be removed.

Returns: SalBoolean.

SaveState(xml)

Parameter
Type
Description

Returns: SalBoolean.

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

mywParam

mylParam

Returns: SalNumber.

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

mywParam

mylParam

Returns: SalBoolean.

SetActivePane(paneIndex)

Activates the indicated pane.

Parameter
Type
Description

paneIndex

The zero-based index of the pane to activate.

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

sMenuName

nFlags

Returns: SalBoolean.

SetContextMenu(menuType, flags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

menuType

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter
Type
Description

resourceId

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

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

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

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

Parameter
Type
Description

enhancement

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter
Type
Description

Returns: SalBoolean.

SetPaneIcon(paneIndex, binary, format, expanded)

Sets the title of a pane.

Parameter
Type
Description

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.

SetPaneTitle(paneIndex, title)

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.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter
Type
Description

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter
Type
Description

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

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

elapseMilliSec

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter
Type
Description

command

numData

strData

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Implements

Name
Description

All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.

Last updated