XSalToolbar

Namespace: PPJ.Runtime.XSal

Assembly: PPJ.Runtime.XSal.50 (5.0.0.0)

Hosts docked XSal toolboxes along one edge of a form.

C#

public class XSalToolbar : Panel, ISalAccessory

VB.NET

Public Class XSalToolbar
    Inherits Panel
    Implements ISalAccessory

Example:

var toolbar = new PPJ.Runtime.XSal.XSalToolbar(
    "Tools", PPJ.Runtime.XSal.XSalToolbar.Side.Top);
toolbar.Height = 30;

Constructors

XSalToolbar(name, side)

Initializes a visible, borderless toolbar docked to the specified edge with an initially empty size.

Name	Type	Description
name	String	The control name.
side	Side	The edge used for docking.

Properties

Appearance

ToolBarAppearance: Gets or sets the shared toolbar appearance setting used by XSal toolbox behavior.

ToolbarSide

Side: Gets the docking edge selected at construction.

UseVisualStyleBackColor

Boolean: Gets or sets whether toolbar backgrounds use the themed tool-strip gradient when visual styles are available.

Methods

GetToolbars(form)

Finds the four conventionally named XSal docking toolbars on a form.

Parameter	Type	Description
form	Form	The form to search.

Returns: XSalToolbar[]. An array indexed by Side, or null when the top toolbar is absent. Other entries can be null.

GetToolboxes(form)

Collects docked and owned floating toolboxes in reverse discovery order.

Parameter	Type	Description
form	Form	The form whose four XSal docking toolbars and owned forms are inspected.

Returns: XSalToolbox[]. The toolbox array, or null if the top docking toolbar is absent.

When the top toolbar exists, the other three docking toolbars must also exist.

OnLayout(levent)

Arranges the docked toolboxes before running base layout.

Parameter	Type	Description
levent	LayoutEventArgs	The layout event data.

OnMouseDown(e)

Shows the toolbox visibility menu for a single right-button press.

Parameter	Type	Description
e	MouseEventArgs	The mouse position, button, and click count.

OnPaintBackground(e)

Paints the shared themed gradient when enabled, or delegates background painting to the base panel.

Parameter	Type	Description
e	PaintEventArgs	The painting surface and clip bounds.

Implements

Name	Description
ISalAccessory