XSalToolbar

Namespace: PPJ.Runtime.XSal

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

• Control
  • ScrollableControl
    • Panel
      • XSalToolbar

Provides a docking strip that groups XSal toolboxes along one edge of a form.

C#

public class XSalToolbar : Panel

VB.NET

Public Class XSalToolbar
    Inherits Panel

Example:

XSalToolbar bar = new XSalToolbar("Tools", XSalToolbar.Side.Top);
            SalForm form = new SalForm();
            form.Controls.Add(bar);

Constructors

XSalToolbar(name, side)

Creates a hidden borderless toolbar docked to the specified form edge.

Name	Type	Description
name	String	The toolbar’s control name.
side	Side	The edge to which the toolbar is docked.

Properties

ToolbarSide

Side: Gets the docking side specified when the toolbar was created.

UseVisualStyleBackColor

Boolean: Gets or sets the shared preference for visual-style toolbar background colors.

Methods

GetToolbars(form)

Finds the four standard XSal toolbar strips on a form.

Parameter	Type	Description
form	Form	The form containing the initialized XSal toolbar system.

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

GetToolboxes(form)

Collects docked and owned floating XSal toolboxes associated with a form.

Parameter	Type	Description
form	Form	The form with a complete initialized XSal toolbar system.

Returns: XSalToolbox[]. The collected toolboxes in reverse discovery order, or null when the toolbar system is absent.

OnControlAdded(e)

Tracks the added child’s visibility and updates whether the docking strip is shown.

Parameter	Type	Description
e	ControlEventArgs	The event data identifying the added control.

OnControlRemoved(e)

Stops tracking the removed child’s visibility and updates whether the docking strip is shown.

Parameter	Type	Description
e	ControlEventArgs	The event data identifying the removed control.