Namespace: Consultingwerk.Windows.Session
Class 
ProToolsButtonProvider Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Session.ProToolsButtonProvider

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Windows.Session.ISessionInfoFormButtonProvider

/* The ProTools buttons show their image only, so they use the height of the
standard dialog buttons but only the width that the 16x16 image requires

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddProTool (character, character, character, character, logical, integer) Adds a ProTool to the tools that are offered on the SessionInfoForm
AssignButtonImage (Button, character, character) Assigns the image of a ProTool button
System.Collections.Generic.List <System.Windows.Forms.Button> GetButtons () Returns the List of Buttons to be added to the SessionInfoForm
LOGICAL HandleButtonClick (Button) Handles the click event of a ProTool button

Top Constructor Summary
Options Name Purpose
ProToolsButtonProvider () Constructor for the ProToolsButtonProvider class


Method Detail
Top

AddProTool (character, character, character, character, logical, integer)
Purpose: Adds a ProTool to the tools that are offered on the SessionInfoForm
Notes:

Parameters:
pcToolName CHARACTER
The technical name of the ProTool, used as the Name of the button
pcToolLabel CHARACTER
The label of the ProTool, used as the tooltip of the button
pcProcedureName CHARACTER
The name of the ABL procedure that implements the ProTool
pcImageName CHARACTER
The file name (without extension) of the PNG image of the ProTool
plRunPersistent LOGICAL
Logical value indicating if the procedure is run persistent
piSortOrder INTEGER
The position of the ProTool in the ProTools palette
Top

AssignButtonImage (Button, character, character)
Purpose: Assigns the image of a ProTool button
Notes: When the image cannot be loaded (i.e. because the images of the
framework are not deployed), the button falls back to the label of
the ProTool, so that the tool stays available. The SessionInfoForm
arranges the buttons based on their actual width

Parameters:
poButton System.Windows.Forms.Button
The reference to the button of the ProTool
pcImageName CHARACTER
The file name (without extension) of the PNG image of the ProTool
pcToolLabel CHARACTER
The label of the ProTool
Top

System.Collections.Generic.List <System.Windows.Forms.Button> GetButtons ()
Purpose: Returns the List of Buttons to be added to the SessionInfoForm
Notes: One button per ProTool, showing the image of the tool only. The
label of the tool is returned as the AccessibleDescription of the
button, which the SessionInfoForm uses as the tooltip

Returns System.Collections.Generic.List <System.Windows.Forms.Button>
The List of the System.Windows.Forms.Button objects to be added to the SessionInfoForm
Top

LOGICAL HandleButtonClick (Button)
Purpose: Handles the click event of a ProTool button
Notes: Launches the ABL procedure of the ProTool, persistent or not,
following the ProTools palette definition

Parameters:
poButton System.Windows.Forms.Button
The reference to the Button that was clicked
Returns LOGICAL
Logical value indicating if the SessionInfoForm should be closed (True = Close)


Constructor Detail
Top

ProToolsButtonProvider ()
Purpose: Constructor for the ProToolsButtonProvider class
Notes: The order of the tools follows the order of the ProTools palette



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:23:46