Saving and restoring toolbar settings – PB Docs 2022

You can save and restore the current toolbar settings using
functions that retrieve information about your toolbar settings, and you
can modify these settings.

GetToolbar and GetToolbarPos allow you to retrieve the current
toolbar settings. SetToolbar and SetToolbarPos allow you to change the
toolbar settings. The syntax you use for the GetToolbarPos and
SetToolbarPos functions varies depending on whether the toolbar you are
working with is floating or docked.

Floating toolbars

The position of a floating toolbar is determined by its x and y
coordinates. The size of a floating toolbar is determined by its width
and height.

When you code the GetToolbarPos and SetToolbarPos functions for a
floating toolbar, you need to include arguments for the x and y
coordinates and the width and height.

Docked toolbars

The position of a docked toolbar is determined by its docking row
and its offset from the beginning of the docking row. For toolbars at
the top or bottom, the offset for a docked toolbar is measured from the
left edge. For toolbars at the left or right, the offset is measured
from the top.

By default, the docking row for a toolbar is the same as its bar
index. If you align the toolbar with a different border in the window,
its docking row may change depending on where you place it.

When you code the GetToolbarPos and SetToolbarPos functions for a
docked toolbar, you need to include arguments for the docking row and
the offset.

Example

The example below shows how to use a custom class user object to
manage toolbar settings. The user object has two functions, one for
saving the current settings and the other for restoring the settings
later on. Because the logic required to save and restore the settings is
handled in the user object (instead of in the window itself), this logic
can easily be used with any window.

The sample code shown below supports both fixed and floating
toolbars.

Script for the window’s Open
event

When the window opens, the following script restores the toolbar
settings from an initialization file. To restore the settings, it
creates a custom class user object called u_toolbar and calls the
Restore function:

Script for the window’s Close
event

When the window closes, the following script saves the toolbar
settings by calling the Save function. Once the settings have been
saved, it destroys the user object:

Script for the Save
function

The Save function has three arguments:

The Save function uses the GetToolbar and GetToolbarPos functions
to retrieve the current toolbar settings. To write the settings to the
initialization file, it uses the SetProfileString function.

The Save function can handle multiple toolbars for a single menu.
It uses the bar index to keep track of information for each
toolbar:

Script for the Restore
function

The Restore function has the same three arguments as the Save
function. It uses the ProfileString function to retrieve toolbar
settings from the initialization file. Once the settings have been
retrieved, it uses the SetToolbar and SetToolbarPos functions to restore
the toolbar settings.

Like the Save function, the Restore function can handle multiple
toolbars for a single menu. It uses the bar index to keep track of
information for each toolbar: