SalNavigationBar

PPJ.Runtime.Windows.SalNavigationBar

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.49 (4.9.0.0)

• Control

  • Accordion

    • SalNavigationBar

NavigationBar control.

C#

public class SalNavigationBar : Accordion, ISalWindow

VB.NET

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	SalNumber	Zero-based index of the pane to which you want to add a group.
groupIndex	SalNumber	Zero-based index that the new group will occupy.
groupTitle	SalString	The title of the new group.
height	SalNumber	The height of the new group in form units.

Returns: SalBoolean.

AddPane(paneIndex, name, image)

Inserts a pane into the navigation bar control.

Parameter	Type	Description
paneIndex	SalNumber	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	Name of the new pane (object title)
image	SalString	File name of the image to display for the new pane.

Returns: SalBoolean.

AssociateChild(paneIndex, groupIndex, control)

Associates a control to a pane.

Parameter	Type	Description
paneIndex	SalNumber	Zero-based index of the pane.
groupIndex	SalNumber	Zero-based index of the group. If the pane has no groups, use zero.
control	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(nType)

Clears a window's cursor.

Parameter	Type	Description
nType	SalNumber

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	SalNumber	Zero-based index of the pane
control	Control	The control you're disassociating

Returns: SalBoolean.

EnablePane(paneIndex, enable)

Enables or disables a pane on the navigation bar.

Parameter	Type	Description
paneIndex	SalNumber	Index for the pane to enable (start at 0).
enable	SalBoolean	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	SalNumber	Zero-based index of the pane
groupIndex	SalNumber	Zero-based index of the group
expand	SalBoolean	Set to TRUE to expand, FALSE to collapse

Returns: SalBoolean.

FindChild(sWindowName)

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

Parameter	Type	Description
sWindowName	SalString

Returns: SalWindowHandle.

FireWindowActions(nMsg, nMywParam, nMylParam)

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalNumber.

FormUnitsToPixels(nFormUnits, bVertical)

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	SalNumber
bVertical	SalBoolean

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(nTypeMask)

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	SalNumber

Returns: SalWindowHandle.

GetFont(sName, nSize, nEnhancement)

Parameter	Type	Description
sName	SalString&
nSize	SalNumber&
nEnhancement	SalNumber&

Returns: SalBoolean.

GetLocation(nX, nY)

Parameter	Type	Description
nX	SalNumber&
nY	SalNumber&

Returns: SalBoolean.

GetName(sText)

Parameter	Type	Description
sText	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

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

Parameter	Type	Description
nTypeMask	SalNumber

Returns: SalWindowHandle.

GetPaneIcon(paneIndex, image)

Parameter	Type	Description
paneIndex	SalNumber
image	SalString&

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	SalString	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	SalNumber
title	SalString&

Returns: SalBoolean.

GetPaneTitle(paneIndex)

Returns the title of a pane.

Parameter	Type	Description
paneIndex	SalNumber	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(sName, sValue)

Parameter	Type	Description
sName	SalString
sValue	SalString&

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter	Type	Description
sName	SalString

Returns: SalString.

GetSize(nWidth, nHeight)

Parameter	Type	Description
nWidth	SalNumber&
nHeight	SalNumber&

Returns: SalBoolean.

GetText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber

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	SalNumber	Zero-based index of the pane
groupIndex	SalNumber	Zero-based index of the group

Returns: SalBoolean.

HideWindow()

Hides a window.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(tClass)

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

Parameter	Type	Description
tClass	Type

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(nIDEvent)

Destroys an object's system timer.

Parameter	Type	Description
nIDEvent	SalNumber

Returns: SalBoolean.

LoadState(xml)

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

Parameter	Type	Description
xml	SalString

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter	Type	Description
nXOffset	SalNumber
nYOffset	SalNumber

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	SalNumber	Index of pane (start at 0).

Returns: SalBoolean.

PixelsToFormUnits(nNumPixels, bVertical)

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	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

RemoveGroup(paneIndex, groupIndex)

Removes a group from the navigation bar control.

Parameter	Type	Description
paneIndex	SalNumber	Zero-based index of the pane to be removed.
groupIndex	SalNumber	Zero-based index of the group to remove.

Returns: SalBoolean.

RemovePane(paneIndex)

Removes a pane from the navigation bar control.

Parameter	Type	Description
paneIndex	SalNumber	Zero-based index of the pane to be removed.

Returns: SalBoolean.

SaveState(xml)

Parameter	Type	Description
xml	SalString&

Returns: SalBoolean.

SendMessage(nMsg, nMywParam, nMylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SetActivePane(paneIndex)

Activates the indicated pane.

Parameter	Type	Description
paneIndex	SalNumber	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	SalString
nFlags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

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

Parameter	Type	Description
menuType	Type
nFlags	SalNumber

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter	Type	Description
nResourceId	Int32
nType	SalNumber

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter	Type	Description
sBlob	SalString
nType	SalNumber

Returns: SalBoolean.

SetCursorFile(sFile, nType)

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
sFile	SalString
nType	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(sName, nSize, nEnhancement)

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

Parameter	Type	Description
sName	SalString
nSize	SalNumber
nEnhancement	SalNumber

Returns: SalBoolean.

SetLocation(nX, nY)

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

Parameter	Type	Description
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

SetPaneIcon(paneIndex, image)

Sets the title of a pane.

Parameter	Type	Description
paneIndex	SalNumber	Index for the pane.
image	SalString	File name of the image to display for the pane.

Returns: SalBoolean.

SetPaneTitle(paneIndex, title)

Sets the title of a pane.

Parameter	Type	Description
paneIndex	SalNumber	Index for the pane whose title you want to get (start at 0).
title	SalString	The new title for the pane.

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter	Type	Description
sName	SalString
sValue	SalString
nLength	SalNumber

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter	Type	Description
nWidth	SalNumber
nHeight	SalNumber

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetTimer(nIDEvent, nElapseMilliSec)

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
nIDEvent	SalNumber
nElapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber
nX	SalNumber
nY	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber
nX	SalNumber
nY	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

WindowActions

WindowActionsEventHandler Window Actions

Implements

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