SalNavigationBar

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.50 (5.0.0.0)

Integrates the navigation-band control with SAL window actions and window operations.

C#

public class SalNavigationBar : NaviBar, ISalWindow

VB.NET

Public Class SalNavigationBar
    Inherits NaviBar
    Implements ISalWindow

Example:

void AddControl(System.Windows.Forms.Control parent)
{
    var control = new PPJ.Runtime.Windows.SalNavigationBar();
    control.Name = "SalNavigationBar";
    parent.Controls.Add(control);
}

Constructors

SalNavigationBar()

Initializes the navigation bar and its SAL window implementation.

Properties

NamedProperties

SalNamedProperties: Gets the SAL named-property collection associated with this control.

Methods

AddGroup(paneIndex, groupIndex, groupTitle, height)

Creates a group in a navigation pane and assigns its height in form units.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
groupIndex	SalNumber	The zero-based position among pane client controls, or -1 to append.
groupTitle	SalString	The displayed group caption.
height	SalNumber	The group height in vertical form units.

Returns: SalBoolean. True if added; false for an invalid pane or insertion index.

AddPane(paneIndex, name, expandedImage, collapsedImage)

Creates a navigation pane with the specified name, caption, and state images.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based insertion index, or -1 to append.
name	SalString	The pane name and initial displayed caption.
expandedImage	SalString	The image name used for the expanded pane.
collapsedImage	SalString	The image name used for the collapsed pane.

Returns: SalBoolean. True if inserted; false for an invalid insertion index.

AssociateChild(paneIndex, groupIndex, control)

Reparents a control into a group or an otherwise empty pane.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
groupIndex	SalNumber	The client-control index whose child collection receives the control; zero targets the pane directly when its client area is empty.
control	Control	The control to add.

Returns: SalBoolean. True if a target was found and the control was added; otherwise, false.

BringWindowToTop()

Brings this control to the front, or activates it when it is a top-level or MDI form.

Returns: SalBoolean. True if the translated control exists; otherwise, false.

CenterWindow()

Centers this window within its parent or, for a top-level form, its owner or screen working area.

Returns: SalBoolean. True when the translated control exists; otherwise, false.

A top-level form is constrained to the selected screen working area. A control without a parent is unchanged unless it is a top-level form.

ClearCursor(type)

Restores the default cursor for a role, using the I-beam for TextBox subclasses.

Parameter	Type	Description
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

DestroyWindow()

Closes this window when it is a form, or disposes the control.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

A true result reports that the close or disposal request was made; a form can apply its own closing behavior.

DisableWindow()

Disables input to this control, or clears editability for a table column.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

DisassociateChild(paneIndex, control)

Clears a control's parent when the control is contained in the specified pane.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
control	Control	The control to detach.

Returns: SalBoolean. True when detached; false for an invalid pane or a control outside the pane.

EnablePane(paneIndex, enable)

Shows or hides a pane by updating its Visible property.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
enable	SalBoolean	True to show the pane; false to hide it.

Returns: SalBoolean. The previous visibility state, or false for an invalid index.

EnableWindow()

Enables input to this control, or enables editing for a table column.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

For text-box controls, this operation also clears the read-only setting.

Native disabled styles are also cleared. When needed, tab navigation is restored except for unchecked radio buttons.

ExpandGroup(paneIndex, groupIndex, expand)

Changes the expanded state of a navigation group.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
groupIndex	SalNumber	The zero-based group index in the pane client area.
expand	SalBoolean	True to expand; false to collapse.

Returns: SalBoolean. True after changing an identified navigation group; otherwise, false.

FindChild(windowName)

Searches this window for a child control by name.

Parameter	Type	Description
windowName	SalString	The child control name to locate.

Returns: SalWindowHandle. The matching child handle, or a null SAL handle if no child is found.

FireWindowActions(msg, mywParam, mylParam)

Invokes this control's SAL action handlers directly and returns their result.

Parameter	Type	Description
msg	SalNumber	The action message code.
mywParam	SalNumber	The first action parameter.
mylParam	SalNumber	The second action parameter.

Returns: SalNumber. The result stored in the dispatched action arguments.

FormUnitsToPixels(formUnits, vertical)

Converts a length in form units to pixels using this control's form metrics.

Parameter	Type	Description
formUnits	SalNumber	The length in form units.
vertical	SalBoolean	True for a vertical measurement; false for a horizontal measurement.

Returns: SalNumber. The converted pixel length.

GetActivePane()

Finds the first pane whose name matches the active band.

Returns: SalNumber. The zero-based pane index, or -1 when no active band or matching pane exists.

GetClassName()

Gets the translated application class name associated with this control.

Returns: SalString. The class name, an empty string for a runtime-defined class, or a null SAL string for an unresolved or native control.

Forms use their base type; nested table-window types are walked upward to a non-nested type.

GetControlType()

Gets the SAL window type of this control.

Returns: SalNumber. The SAL Sys.TYPE_* code for the translated control.

GetFirstChild(typeMask)

Finds the first child matching a SAL window-type mask.

Parameter	Type	Description
typeMask	SalNumber	The SAL window types to include; zero matches no controls.

Returns: SalWindowHandle. The first matching child handle, or a null SAL handle when none matches.

Ordinary controls use tab order; table columns use their creation order, and MDI forms use their child-form collection.

GetFont(name, size, enhancement)

Reads the control font's family, point size, and style flags.

Parameter	Type	Description
name	SalString	Receives the font family name.
size	SalNumber	Receives the size in points.
enhancement	SalNumber	Receives the combined Sys.FONT_Enh* style flags.

Returns: SalBoolean. True if a font was available; otherwise, false.

GetLocation(x, y)

Reads this control's location in form units.

Parameter	Type	Description
x	SalNumber	Receives the horizontal location.
y	SalNumber	Receives the vertical location.

Returns: SalBoolean. Always true; an unresolved control produces zero coordinates.

GetName(text)

Copies this control's name to the supplied variable.

Parameter	Type	Description
text	SalString	Receives the control name when the operation succeeds.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

GetName()

Gets this control's name.

Returns: SalString. The control name, or an empty string if the control cannot be resolved.

GetNextChild(typeMask)

Finds the next sibling matching a SAL window-type mask.

Parameter	Type	Description
typeMask	SalNumber	The SAL window types to include; zero matches no controls.

Returns: SalWindowHandle. The next matching control handle, or a null SAL handle when none matches.

GetPaneIcon(paneIndex, binary, format, expanded)

Serializes the image used for one pane state.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
binary	SalBinary	Receives the encoded image, or an empty wrapper when no image is assigned.
format	SalNumber	Sys.PIC_FormatBitmap or Sys.PIC_FormatIcon.
expanded	SalBoolean	True for the large expanded-state image; false for the small collapsed-state image.

Returns: SalBoolean. True when the pane exists and its image is absent or successfully encoded; false for an invalid pane or unsupported format with an assigned image.

GetPaneIndex(name)

Finds the first pane with the supplied name.

Parameter	Type	Description
name	SalString	The pane name to match.

Returns: SalNumber. The zero-based index, or -1 when no pane matches.

GetPaneTitle(paneIndex, title)

Copies a pane's displayed caption to a SAL string.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
title	SalString	Receives the caption on success; unchanged for an invalid index.

Returns: SalBoolean. True when the caption was read; otherwise, false.

GetPaneTitle(paneIndex)

Gets a pane's displayed caption.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.

Returns: SalString. The caption, or a null SAL string for an invalid index.

GetParent()

Gets the SAL parent form, owner, or table container for this control.

Returns: SalWindowHandle. The parent window handle, or a null SAL handle if no parent can be resolved.

GetProperty(name, value)

Reads a SAL named property into a supplied variable.

Parameter	Type	Description
name	SalString	The property name.
value	SalString	Receives the value only when the property is found.

Returns: SalBoolean. True if a non-null property value was found; otherwise, false.

GetProperty(name)

Gets the value of a SAL named property.

Parameter	Type	Description
name	SalString	The property name.

Returns: SalString. The property value, or a SAL null string if the value is unavailable.

GetSize(width, height)

Reads this control's size in form units.

Parameter	Type	Description
width	SalNumber	Receives the width.
height	SalNumber	Receives the height.

Returns: SalBoolean. Always true; an unresolved control produces a zero size.

GetText(text, maxLen)

Copies this control's displayed text or long-string value to a SAL string.

Parameter	Type	Description
text	SalString	Receives the retrieved text.
maxLen	SalNumber	The maximum character count for ordinary text; ignored for a Sys.DT_LongString value.

Returns: SalNumber. The number of characters copied, or zero when no text is available.

GetText(maxLen)

Gets this control's displayed text or long-string value.

Parameter	Type	Description
maxLen	SalNumber	The maximum character count for ordinary text; ignored for a Sys.DT_LongString value.

Returns: SalString. The retrieved text, or an empty string if the control cannot be resolved.

GetWindowColor(colorIndex)

Reads a window or cell color as a Win32 color value.

Parameter	Type	Description
colorIndex	SalNumber	The Sys.COLOR_Index* color component to read.

Returns: SalNumber. The color encoded as a Win32 color value, or zero if the control is unavailable.

Transparent colors are reported as Sys.COLOR_None. Table-column window colors use the system window colors; cell colors use the column settings.

GetWindowState()

Gets the visibility and form-state classification of this window.

Returns: SalNumber. A Sys.Window_* state code; visible non-form controls report Sys.Window_Normal.

GroupIsExpanded(paneIndex, groupIndex)

Gets the expanded state of a navigation group.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
groupIndex	SalNumber	The zero-based group index in the pane client area.

Returns: SalBoolean. The group's expanded state, or false when the indices do not identify a navigation group.

HideWindow()

Hides this control or table column.

Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.

InvalidateWindow()

Invalidates this control and its child controls for repainting.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

IsDerivedFromClass(typeClass)

Tests this control's runtime type against an application base type.

Parameter	Type	Description
typeClass	Type	The type to test, including the framework's emulated inheritance relationships.

Returns: SalBoolean. True if the runtime type derives from the requested type; otherwise, false.

IsEnabled()

Determines whether this control accepts input.

Returns: SalBoolean. The enabled state, or the editable flag for a table column; false if the control cannot be resolved.

IsVisible()

Determines whether this control is visible.

Returns: SalBoolean. The visible state, or the visibility flag for a table column; false if the control cannot be resolved.

KillTimer(idEvent)

Stops the native window timer with the specified identifier.

Parameter	Type	Description
idEvent	SalNumber	The timer identifier to remove.

Returns: SalBoolean. The native timer-removal result, or false if the control cannot be resolved.

LoadState(xml)

Deserializes navigation settings and applies them to the bar.

Parameter	Type	Description
xml	SalString	The XML produced by SaveState.

Returns: SalBoolean. False for empty XML or an incompatible deserialized object; true after applying the settings.

Malformed XML and deserialization failures propagate to the caller.

MoveWindow(xOffset, yOffset)

Moves this control by an offset expressed in form units.

Parameter	Type	Description
xOffset	SalNumber	The horizontal offset to add to the current position.
yOffset	SalNumber	The vertical offset to add to the current position.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

OnActiveBandChanged(e)

Raises the base active-band event and dispatches SAM_NavChange with the active band's index in Controls.

Parameter	Type	Description
e	EventArgs	The active-band event data.

OnBandResized(e)

Raises the base resize event and dispatches SAM_NavResize with the band index and packed pixel dimensions.

Parameter	Type	Description
e	NaviBandEventArgs	The resized band.

The low word contains width and the high word contains height.

OnGroupCollapsed(e)

Raises the base group-collapse event and dispatches SAM_NavGroupCollapse with band and group indices.

Parameter	Type	Description
e	NaviBandEventArgs	The affected band and group.

OnGroupExpanded(e)

Raises the base group-expand event and dispatches SAM_NavGroupExpand with band and group indices.

Parameter	Type	Description
e	NaviBandEventArgs	The affected band and group.

PaneIsEnabled(paneIndex)

Determines whether a pane is visible.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.

Returns: SalBoolean. The pane visibility, or false for an invalid index.

PixelsToFormUnits(numPixels, vertical)

Converts a pixel length to form units using this control's form metrics.

Parameter	Type	Description
numPixels	SalNumber	The pixel length to convert.
vertical	SalBoolean	True for a vertical measurement; false for a horizontal measurement.

Returns: SalNumber. The converted length in form units.

PostMessage(msg, mywParam, mylParam)

Posts a native Windows message to this control for asynchronous processing.

Parameter	Type	Description
msg	SalNumber	The Windows or SAL message code.
mywParam	SalNumber	The first message parameter.
mylParam	SalNumber	The second message parameter.

Returns: SalBoolean. True if the native message was posted; false for an unavailable or disposed control, or if posting fails.

RemoveGroup(paneIndex, groupIndex)

Removes the client control at the specified group position.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
groupIndex	SalNumber	The zero-based index in the pane client-area controls.

Returns: SalBoolean. True if removed; false for an invalid index.

RemovePane(paneIndex)

Removes a navigation pane by index.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.

Returns: SalBoolean. True if removed; false for an invalid index.

SaveState(xml)

Serializes the current navigation settings as XML.

Parameter	Type	Description
xml	SalString	Receives the serialized settings.

Returns: SalBoolean. True after serialization completes.

Serialization failures propagate to the caller.

SendMessage(msg, mywParam, mylParam)

Sends a native Windows message to this control synchronously.

Parameter	Type	Description
msg	SalNumber	The Windows or SAL message code.
mywParam	SalNumber	The first message parameter.
mylParam	SalNumber	The second message parameter.

Returns: SalNumber. The native message result, or zero when the control is unavailable or disposed.

SendMessageToChildren(msg, mywParam, mylParam)

Sends a message to this control's child windows and eligible descendants.

Parameter	Type	Description
msg	SalNumber	The Windows or SAL message code.
mywParam	SalNumber	The first message parameter.
mylParam	SalNumber	The second message parameter.

Returns: SalBoolean. True after dispatching; false when the parent is unavailable or disposed.

Traversal does not descend into embedded forms or user controls. Close and destroy messages for ordinary child controls are routed to their action handlers instead of their native window procedures.

SetActivePane(paneIndex)

Activates the pane at the specified index.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.

Returns: SalBoolean. True after assignment; false for an invalid index.

SetContextMenu(menuName, flags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
menuName	SalString	The menu type name to resolve.
flags	SalNumber	Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu.

Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.

When called during a SAL context-menu action, the created menu is also shown at the current mouse position.

SetContextMenu(menuType, flags)

Creates and assigns a context menu for this control.

Parameter	Type	Description
menuType	Type	The menu type to instantiate.
flags	SalNumber	Use Sys.CM_TableCell to assign the table's cell-editor menu; otherwise, assign the control's context menu.

Returns: SalBoolean. True if a control and menu type resolve and the menu is created; otherwise, false.

When called during a SAL context-menu action, the created menu is also shown at the current mouse position.

SetCursor(resource, type)

Loads a cursor resource and assigns it to the requested role.

Parameter	Type	Description
resource	SalResourceCursor	The cursor resource to load.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

SetCursor(resourceId, type)

Assigns a system cursor or a cursor identified by its native handle to the requested role.

Parameter	Type	Description
resourceId	Int32	A Sys.CURSOR_* identifier, or a native cursor handle represented as an integer.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if the cursor is assigned to a supported role; otherwise, false.

SetCursor(blob, type)

Loads a cursor from binary data and assigns it to the requested role.

Parameter	Type	Description
blob	SalString	The cursor file data stored in a SAL binary string.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.

SetCursorFile(file, type)

Loads a cursor file and assigns it to the requested role.

Parameter	Type	Description
file	SalString	The cursor file path.
type	SalNumber	The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop.

Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.

SetFocus()

Moves keyboard focus to this control, deferring the change when SAL validation is in progress.

Returns: SalWindowHandle. The previously focused managed control as a SAL handle, or a null handle if the target is unavailable, a table column, an ActiveX host, disabled, or hidden.

SetFont(name, size, enhancement)

Creates and assigns a font to this control.

Parameter	Type	Description
name	SalString	The font family name.
size	SalNumber	The font size in points.
enhancement	SalNumber	The combined Sys.FONT_Enh* style flags.

Returns: SalBoolean. True if the font was created and assigned; otherwise, false.

SetLocation(x, y)

Sets this control's location in form units.

Parameter	Type	Description
x	SalNumber	The new horizontal coordinate.
y	SalNumber	The new vertical coordinate.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

For forms, this also selects manual startup positioning.

SetPaneIcon(paneIndex, binary, format, expanded)

Loads or clears the image used for one pane state.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
binary	SalBinary	The image bytes; a null wrapper or null binary value clears the image.
format	SalNumber	Sys.PIC_FormatBitmap or Sys.PIC_FormatIcon when loading data.
expanded	SalBoolean	True for the large expanded-state image; false for the small collapsed-state image.

Returns: SalBoolean. True after assignment; false for an invalid pane or unsupported input format.

Invalid encoded image data can throw.

SetPaneTitle(paneIndex, title)

Changes a pane's displayed caption without changing its name.

Parameter	Type	Description
paneIndex	SalNumber	The zero-based pane index.
title	SalString	The caption to display.

Returns: SalBoolean. True after assignment; false for an invalid index.

SetProperty(name, value, length)

Assigns a SAL named property after limiting the value's length.

Parameter	Type	Description
name	SalString	The property name.
value	SalString	The value to assign.
length	SalNumber	The number of leading characters to retain.

Returns: SalBoolean. True if the translated control implements the SAL window contract; otherwise, false.

SetSize(width, height)

Sets this control's dimensions in form units.

Parameter	Type	Description
width	SalNumber	The new width.
height	SalNumber	The new height.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

SetText(text)

Assigns the control's displayed text.

Parameter	Type	Description
text	SalString	The text to assign.

Returns: SalBoolean. True if the translated control exists and assignment completes; otherwise, false.

An empty string is passed as null when assigning combo-box text.

SetTimer(idEvent, elapseMilliSec)

Creates or updates a native window timer for this control.

Parameter	Type	Description
idEvent	SalNumber	The timer identifier.
elapseMilliSec	SalNumber	The requested interval in milliseconds.

Returns: SalBoolean. True if the native timer was created; otherwise, false.

SetWindowColor(colorIndex, color)

Assigns a SAL window, table-cell, text, or transparent-image color.

Parameter	Type	Description
colorIndex	SalNumber	The Sys.COLOR_Index* component to update.
color	SalNumber	The SAL color value.

Returns: SalBoolean. True for a recognized color index and resolved control, even when the component does not apply to that control; otherwise, false.

Cell colors apply to table columns; window colors apply to other controls. Transparent colors require the SAL picture-control contract.

ShowWindow()

Shows this control or table column.

Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.

TrackPopupMenu(menuName, flags, x, y)

Creates and displays a temporary popup menu at screen coordinates.

Parameter	Type	Description
menuName	SalString	The menu type name to resolve.
flags	SalNumber	SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported.
x	SalNumber	The screen X coordinate, unless TPM_CursorX selects the cursor position.
y	SalNumber	The screen Y coordinate, unless TPM_CursorY selects the cursor position.

Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.

The previous context menu is restored after display and the temporary menu is queued for disposal.

TrackPopupMenu(menuType, flags, x, y)

Creates and displays a temporary popup menu at screen coordinates.

Parameter	Type	Description
menuType	Type	The menu type to instantiate.
flags	SalNumber	SAL TPM_* alignment and cursor-position flags; center alignment and TPM_ContextMenu are unsupported.
x	SalNumber	The screen X coordinate, unless TPM_CursorX selects the cursor position.
y	SalNumber	The screen Y coordinate, unless TPM_CursorY selects the cursor position.

Returns: SalBoolean. True after the popup is shown; false when the target or menu cannot be resolved.

The previous context menu is restored after display and the temporary menu is queued for disposal.

UpdateWindow()

Requests an update of this control.

Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.

WinHelp(file, command, numData, strData)

Invokes the legacy Windows Help API for this control.

Parameter	Type	Description
file	SalString	The help file path.
command	SalNumber	The Sys.HELP_* command.
numData	SalNumber	The numeric topic or index for HELP_Context and HELP_SetIndex.
strData	SalString	The lookup text for HELP_Key.

Returns: SalBoolean. The native help result, or false for an empty file name.

Yield()

Dispatches one pending message for this window, or processes application messages when no window handle exists.

Message dispatch can reenter application code.

Events

MessageActions

SalMessageHandler Provides the legacy SAL message-handler event.

Use WindowActions for new handlers.

WindowActions

WindowActionsEventHandler Occurs when this control dispatches a SAL or custom window action.

Implements

Name	Description
ISalWindow	Exposes SAL message dispatch and runtime metadata for child controls, forms, dialogs, and MDI windows.