SalNavigationBar
PPJ.Runtime.Windows.SalNavigationBar
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Web.49 (4.9.0.0)
NavigationBar control.
public class SalNavigationBar : Accordion, 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.
Returns: SalBoolean.
AddPane(paneIndex, name, image)

Inserts a pane into the navigation bar control.
Returns: SalBoolean.
AssociateChild(paneIndex, groupIndex, control)

Associates a control to a 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.
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.
Returns: SalBoolean.
EnablePane(paneIndex, enable)

Enables or disables a pane on the navigation bar.
Returns: SalBoolean.
EnableWindow()

Enables keyboard and mouse input to a window.
Returns: SalBoolean.
ExpandGroup(paneIndex, groupIndex, expand)

Expands or collapses a group.
Returns: SalBoolean.
FindChild(sWindowName)

This function finds a child window of a given name in the specified window.
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.
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.
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.
Returns: SalWindowHandle.
GetFont(sName, nSize, nEnhancement)

Returns: SalBoolean.
GetLocation(nX, nY)

Returns: SalBoolean.
GetName(sText)

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.
Returns: SalWindowHandle.
GetPaneIcon(paneIndex, image)

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.
Returns: SalNumber. the zero-based index of the pane. If the pane is not found, nIndex is -1.
GetPaneTitle(paneIndex, title)

Returns: SalBoolean.
GetPaneTitle(paneIndex)

Returns the title of a pane.
Returns: SalString.
GetParent()

Returns the handle of an object's parent window.
Returns: SalWindowHandle.
GetProperty(sName, sValue)

Returns: SalBoolean.
GetProperty(sName)

Gets the value of a named property.
Returns: SalString.
GetSize(nWidth, nHeight)

Returns: SalBoolean.
GetText(sText, nMaxLen)

Returns: SalNumber.
GetText(nMaxLen)

Retrieves the text of a window.
Returns: SalString.
GetWindowColor(nColorIndex)

Gets a window's color.
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.
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.
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.
Returns: SalBoolean.
LoadState(xml)

Restore the settings of a navigation bar from an XML string.
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.
Returns: SalBoolean.
PaneIsEnabled(paneIndex)

Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
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.
Returns: SalNumber.
PostMessage(nMsg, nMywParam, nMylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
RemoveGroup(paneIndex, groupIndex)

Removes a group from the navigation bar control.
Returns: SalBoolean.
RemovePane(paneIndex)

Removes a pane from the navigation bar control.
Returns: SalBoolean.
SaveState(xml)

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.
Returns: SalNumber.
SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
SetActivePane(paneIndex)

Activates the indicated pane.
Returns: SalBoolean.
SetContextMenu(sMenuName, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
SetContextMenu(menuType, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
SetCursor(nResourceId, nType)

Sets a window's cursor.
Returns: SalBoolean.
SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.
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.
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.
Returns: SalBoolean.
SetLocation(nX, nY)

Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
SetPaneIcon(paneIndex, image)

Sets the title of a pane.
Returns: SalBoolean.
SetPaneTitle(paneIndex, title)

Sets the title of a pane.
Returns: SalBoolean.
SetProperty(sName, sValue, nLength)

Sets the value of a named property.
Returns: SalBoolean.
SetSize(nWidth, nHeight)

Resizes a window.
Returns: SalBoolean.
SetText(sText)

Sets the text of a window.
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.
Returns: SalBoolean.
SetWindowColor(nColorIndex, nColor)

Sets a window's color.
Returns: SalBoolean.
ShowWindow()

Makes a window visible.
Returns: SalBoolean.
TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.
Returns: SalBoolean.
TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.
Returns: SalBoolean.
UpdateWindow()

Forces the update of a window.
Returns: SalBoolean.
Events
WindowActions

WindowActionsEventHandler Window Actions
Implements
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.
Last updated