User Guide

204
AddScriptToolbutton
function AddScriptToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption,
wsImageFile: WideString): WordBool
Adds a script toolbutton (executes passed JScript or VBScript file when clicked) to the
passed toolbar. Fails if toolbar doesn’t exist. Returns True if Toolbutton already exists,
but doesn’t add duplicate button.
AddTagToolbutton
function AddTagToolbutton(wsToolbarName, wsTagStart, wsTagEnd, wsHint,
wsCaption, wsImageFile: WideString): WordBool
Adds a tag toolbutton (inserts tag pair when clicked) to the passed toolbar. Fails if
toolbar doesn’t exist. Returns True if Toolbutton already exists, but doesn’t add
duplicate button.
AddVTMToolbutton
function AddVTMToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption,
wsImageFile: WideString): WordBool
Adds a VTM toolbutton (displays passed VTM dialog box when clicked) to the passed
toolbar. Fails if toolbar doesn’t exist. Returns True if Toolbutton already exists, but
doesn’t add duplicate button.
CreateToolbar
function CreateToolbar(wsToolbarName: WideString): WordBool
Creates a new, undocked toolbar of the passed name. Fails if a toolbar of the same
name already exists.
DeleteToolbar
function DeleteToolbar(wsToolbarName: WideString): WordBool
Physically deletes the toolbar. Fails if toolbar doesn’t exist or if toolbar is one of the
built-in toolbars. Works only on custom toolbars; built-in toolbars can be hidden, but
not deleted.
HideToolbar
function HideToolbar(wsToolbarName: WideString): WordBool
Hides a toolbar. Fails if the toolbar doesn’t exist.
SetToolbarDockPos
function SetToolbarDockPos(wsToolbarName: WideString; nDockPos: Integer):
WordBool
Sets the docking position of the toolbar. Fails if the toolbar doesn’t exist. Allowed values
for
nDockPos are:
1 = Top
2 = Bottom
3 = Left
4 = Right