Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

Toolbar.Register

Registers a new toolbar button.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Toolbar Window 4.3 Yes No No No No

MBS( "Toolbar.Register"; Identifier; FileName; ScriptName; Parameter; Label; PaletteLabel; Tooltip; Image )

Parameters

Parameter Description Example value
Identifier The toolbar identifier. Must be an unique string. "Test"
FileName The file name of the FileMaker database where the script is located. "Toolbar.fmp12"
ScriptName The name of the script to call when toolbar item is pressed. "ToolbarScript"
Parameter The parameter to pass to the script. This can be same as identifier. Using different parameters allows you to use one script for all toolbar items. "SwitchToMainLayout"
Label The label, which normally appears in the toolbar and in the overflow menu. "Hello"
PaletteLabel The label that appears when it is in the customization palette. Can be same as label or different. "Hello World"
Tooltip The tooltip for the label! "click me"
Image The image to use for the toolbar item. Pass a container value with JPEG, TIFF, PNG or other image formats. $image

Result

Returns OK or error.

Description

Registers a new toolbar button.
Please use an identifier with your own prefix/suffix to make sure you have no conflict with existing identifiers.
Once your item is registered, the next time the toolbar updates itself it will use it.
You can use Window.SetToolbarConfiguration or the customize palette to add your toolbar item.

You need to call Toolbar.Install at least once before using this command to have it take effect.

With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

See also

Example Databases


Toolbar.InstallBackground   -   Toolbar.SetImage

Feedback: Report problem or ask question.




Links
MBS FileMaker Plugins