Chapter 2

Corel® WordPerfect® Product Commands
B
BoxEquationFontSize
Purpose
Specify an equation font size.
Syntax
BoxEquationFontSize (Size: measurement)
Parameters
Size
measurement
See Also
?BoxEquationFont, ?BoxEquationFontSize, BoxEquationFont
BoxEquationRedisplay
Purpose
Enlarge or reduce an equation display.
Syntax
BoxEquationRedisplay (Zoom: numeric)
Parameters
Zoom
numeric (optional)
See Also
BoxContentEdit, BoxCreate, BoxEdit, BoxEnd
BoxEquationSaveAsGraphic
Purpose
Save an equation box as a graphics file.
Syntax
BoxEquationSaveAsGraphic (Filename: string; Format: enumeration)
Parameters
Filename
string
Format
enumeration (optional) Default: current graphics format.
Presentations_20!
WordPerfectGraphic_10!
WordPerfectGraphic_20!
See Also
BoxEquationFilename
BoxFill
Purpose
Select a box fill style.
Syntax
BoxFill (FillStyleName: any)
Parameters
FillStyleName
any
|
Fill10! |
Fill60! |
|
Fill100! |
Fill70! |
|
Fill20! |
Fill80! |
|
Fill30! |
Fill90! |
|
Fill40! |
FillButton! |
|
Fill5! |
NoFill! |
|
Fill50! |
See Also
BoxContentEdit, BoxCreate, BoxEdit, BoxEnd
BoxForwardOne
Purpose
Move the selected object(s) forward one layer.
Syntax
BoxForwardOne ()
See Also
BoxBackwardOne
BoxHeight
Purpose
Specify the box height according to the height of box contents or a fixed measurement.
Syntax
BoxHeight (Height: any)
Parameters
Height
any Specify AutoHeight! or a fixed height.
AutoHeight!
See Also
?BoxHeight, BoxCreate, BoxEdit, BoxEnd, BoxWidth
BoxHorizontalAlignment
Purpose
Specify the alignment of a box attached to a page or paragraph.
Syntax
BoxHorizontalAlignment (Alignment: enumeration; Position: enumeration; Offset: measurement; LeftColumn: numeric; RightColumn: numeric)
Parameters
Alignment
enumeration
AlignColumns!
AlignMargins!
Position
enumeration The horizontal position after alignment to margins or columns.
Center!
FullAlign!
Left!
Right!
Offset
measurement (optional) The image position relative to the alignment point. Left is a negative number, right is positive.
LeftColumn
numeric (optional) Use when a box aligns to columns.
RightColumn
numeric (optional) Use when a box aligns to columns.
See Also
?BoxHorizontalAlignment, ?BoxHorizontalAlignTo, ?BoxHorizontalOffset, BoxCreate, BoxEdit, BoxEnd, BoxHorizontalPosition
BoxHorizontalPosition
Purpose
Specify the horizontal position of a box relative to the left edge of the page.
Syntax
BoxHorizontalPosition (Position: measurement)
Parameters
Position
measurement
See Also
BoxCreate, BoxEdit, BoxEnd, BoxHorizontalAlignment
BoxImageBlackWhiteThreshold
Purpose
Specify the point at which colors and/or grays in the current image convert to black and white.
Syntax
BoxImageBlackWhiteThreshold (Threshold: numeric)
Parameters
Threshold
numeric Value: 1-255. Values below the threshold convert to black, those above convert to white. Default: 127.
See Also
?BoxImageBlackWhiteThreshold, BoxCreate, BoxEdit, BoxEnd, BoxImageMonochrome
BoxImageBrightness
Purpose
Adjust the brightness (saturation) of a color or black and white image.
Syntax
BoxImageBrightness (Amount: numeric)
Parameters
Amount
numeric Value: -1.0 to 1.0. Black: -1.0. White: 1.0.
See Also
?BoxImageBrightness, BoxCreate, BoxEdit, BoxEnd, BoxImageContrast
BoxImageContrast
Purpose
Specify the contrast between light and dark areas of an image.
Syntax
BoxImageContrast (Contrast: numeric)
Parameters
Contrast
numeric Value: -1.0 to 1.0. Slight: -1.0. Strong: 1.0.
See Also
?BoxImageContrast, BoxCreate, BoxEdit, BoxEnd
BoxImageDitherMethod
Purpose
Specify a dither method and source.
Syntax
BoxImageDitherMethod (Method: enumeration; Source: enumeration)
Parameters
Method
enumeration
Default!
ErrorDiffusionDither!
Halftoning!
OrderedDither!
Source
enumeration
Default!
External!
Printer!
WordPerfect!
BoxImageFill
Purpose
Specify an image fill type. Images can have normal fill, no fill, or white fill.
Syntax
BoxImageFill (ImageFillType: enumeration)
Parameters
ImageFillType
enumeration
Normal!
Transparent!
White!
See Also
?BoxImageFill
BoxImageFlipX
Purpose
Flip an image box on its X (horizontal) axis, turning the image upside down.
Syntax
BoxImageFlipX (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxImageFlipX, BoxCreate, BoxEdit, BoxEnd, BoxImageFlipY
BoxImageFlipY
Purpose
Reverse an image box on its Y (vertical) axis, turning the image from side to side.
Syntax
BoxImageFlipY (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxImageFlipY, BoxCreate, BoxEdit, BoxEnd, BoxImageFlipX
BoxImageHalfToneOptions
Purpose
Specify the default or user-defined halftone values for the current printer.
Syntax
BoxImageHalfToneOptions (HalfTone: enumeration; LPI: numeric; Plane0: numeric; Plane1: numeric; Plane2: numeric; Plane3: numeric)
Parameters
HalfTone
enumeration
DefaultValues!
SetValues!
LPI
numeric (optional) The number of lines per inch for user-defined values.
Plane0
numeric (optional) The first halftone angle for user-defined values.
Plane1
numeric (optional) The second halftone angle for user-defined values.
Plane2
numeric (optional) The third halftone angle for user-defined values.
Plane3
numeric (optional) The fourth halftone angle for user-defined values.
BoxImageInvertColors
Purpose
Convert the image colors to their complements.
Syntax
BoxImageInvertColors (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxImageInvertColors, BoxCreate, BoxEdit, BoxEnd
BoxImageMonochrome
Purpose
Convert a color image to black and white, and specify the threshold for blackness.
Syntax
BoxImageMonochrome (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxImageMonochrome, BoxCreate, BoxEdit, BoxEnd, BoxImageBlackWhiteThreshold, BoxImageFill
BoxImageMove
Purpose
Move an image within a box.
Syntax
BoxImageMove (XPosition: numeric; YPosition: numeric)
Parameters
XPosition
numeric The horizontal position. Value: -5.0 to 5.0. Default: 0 (centered).
YPosition
numeric The vertical position. Value: -5.0 to 5.0. Default: 0 (centered).
See Also
?BoxImageTranslationY, ?BoxImageTranslationX, BoxCreate, BoxEdit, BoxEnd
BoxImageRetrieve
Purpose
Retrieve an image.
Syntax
BoxImageRetrieve (Action: enumeration; Filename: string; FileFormat: enumeration)
Parameters
Action
enumeration
LeaveExternal!
MakeInternal!
UseInternal!
Filename
string
FileFormat
enumeration (optional)
|
AdobePhotoShop! |
Macintosh_PICT! |
|
AutoCAD_DXF! |
MacPaint! |
|
BIFFCharts! |
Micrografx! |
|
Bitmap! |
MicrografxPicturePublisher4! |
|
CALSBitmap! |
PCPaintbrushX! |
|
CGM! |
Presentations_20! |
|
CompuserveGIF! |
ScitexCT! |
|
CompuserveGIF24! |
TaggedImageFileFormat! |
|
CorelPhotoPaint! |
TarGA! |
|
CorelVentura! |
WindowsMetaFile! |
|
CorelWavelen! |
WordPerfectGraphic_10! |
|
EncapsulatedPostScript! |
WordPerfectGraphic_20! |
|
EnhancedWindowsMetaFile! |
WPChartingData_10! |
|
FAX_TIFF! |
WPChartingData_10E! |
|
GEMIMG! |
WPChartingData_20! |
|
HewlettPackardGraphicPlotter! |
WPChartingStyle_10! |
|
JPEG! |
WPChartingStyle_10E! |
|
KodakPhotoCD! |
WPChartingStyle_20! |
|
LotusPIC! |
WPWorksPaint_20! |
See Also
BoxCreate, BoxEdit, BoxEnd
BoxImageRotate
Purpose
Rotate an image within a box.
Syntax
BoxImageRotate (Rotation: numeric)
Parameters
Rotation
numeric Value: 0.0 to 359.0.
See Also
?BoxImageRotation, BoxCreate, BoxEdit, BoxEnd
BoxImageSave
Purpose
Save an image, and optionally rename it and specify a graphics format.
Syntax
BoxImageSave (Filename: string; Format: enumeration)
Parameters
Filename
string
Format
enumeration
Presentations_20!
WordPerfectGraphic_10!
WordPerfectGraphic_20!
See Also
BoxCreate, BoxEdit, BoxEnd
BoxImageScaling
Purpose
Scale an image within a box.
Syntax
BoxImageScaling (XScale: numeric; YScale: numeric)
Parameters
XScale
numeric The image width. Value: 0.01 to 9.99. Default: 1.0.
YScale
numeric The image height. Value: 0.01 to 9.99. Default: 1.0.
See Also
?BoxImageScalingX, ?BoxImageScalingY, BoxCreate, BoxEdit, BoxEnd
BoxImageShowBackground
Purpose
Display the background colors or gradient saved with an image.
Syntax
BoxImageShowBackground (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxImagePageBackground, BoxCreate, BoxEdit, BoxEnd
BoxInitialStyleDlg
Purpose
Display the Text Box Initial Style dialog box. Specify a box before this command.
Syntax
BoxInitialStyleDlg ()
BoxOLEEditObject
Purpose
Edit the graphics box contents with the OLE server.
Syntax
BoxOLEEditObject ()
BoxOverlap
Purpose
Allow a box to overlap other boxes. Precede with BoxCreate or BoxEdit and follow with BoxEnd. This command takes effect only for boxes that are attached to a page or a paragraph.
Syntax
BoxOverlap (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxOverlap, BoxHorizontalAlignment, BoxHorizontalPosition, BoxVerticalAlignment, BoxVerticalPosition
BoxPosDlg
Purpose
Display the Box Position dialog box.
Syntax
BoxPosDlg ()
BoxResetBorder
Purpose
Reset the border values for the current box to the values of the corresponding box style. For example, border changes made to a specific figure box reset to the default border values assigned to the Figure Box style. Precede with BoxCreate or BoxEdit and end with BoxEnd.
Syntax
BoxResetBorder ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetCaption
Purpose
Reset the caption values for the current box to the caption values of the corresponding box style. For example, caption changes made to a specific text box are reset to the default caption values assigned to the Text Box style. Precede with BoxEdit and end with BoxEnd.
Syntax
BoxResetCaption ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetContent
Purpose
Reset the content values for the current box to the content values of the corresponding box style. For example, content changes made to a specific user box are reset to the values assigned to the User Box style. Precede with BoxEdit and end with BoxEnd.
Syntax
BoxResetContent ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetContentRender
Purpose
Reset the content render values for the current box to the values of the corresponding box style. For example, content render changes made to a specific equation box are reset to the default content render values assigned to the Equation Box style.
Syntax
BoxResetContentRender ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetCounter
Purpose
Reset the counter values for the current box to the values of the corresponding box style. For example, counter changes made to an equation box are reset to the default counter values of the Equation Box style.
Syntax
BoxResetCounter ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetFill
Purpose
Reset the fill values for the current box to the values of the corresponding box style. For example, fill style changes made to a figure box are reset to the fill values of the Figure Box style.
Syntax
BoxResetFill ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetPosition
Purpose
Reset the position values for the current box to the position values for the corresponding box style. For example, position changes made to a figure box are reset to default position values of the Figure Box style.
Syntax
BoxResetPosition ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxResetTextFlow
Purpose
Reset the text wrapping values for the current box to the values of the corresponding box style. For example, text wrapping changes made to a user box are reset to the text flow values of the User Box style.
Syntax
BoxResetTextFlow ()
See Also
BoxCreate, BoxEdit, BoxEnd
BoxSaveLookAsStyle
Purpose
Save the settings for the current box as a style. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.
Syntax
BoxSaveLookAsStyle (Style: string; Library: enumeration)
Parameters
Style
string
Library
enumeration
CurrentDoc!
PersonalLibrary!
SharedLibrary!
See Also
BoxStyleCreate
BoxStaysOnPage
Purpose
Specify whether a graphics box is allowed to move with the surrounding text. Although you may use BoxStaysOnPage to set this option for boxes that are attached to a paragraph or character, it takes effect only for boxes that are attached to a page. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.
Syntax
BoxStaysOnPage (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
?BoxStaysOnPage
BoxStyleCopy
Purpose
Copy a box style from one library to another and/or rename the style.
Syntax
BoxStyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)
Parameters
Style
any
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
FromLibrary
enumeration
CurrentDocument!
PersonalLibrary!
SharedLibrary!
ToLibrary
enumeration
CurrentDocument!
PersonalLibrary!
SharedLibrary!
DestName
string (optional) The new name of the style.
See Also
BoxStyleCreate, BoxStyleDelete, BoxStyleEdit, BoxStyleRetrieve
BoxStyleCreate
Purpose
Create a box style and specify the library where it resides.
Syntax
BoxStyleCreate (Style: any; Library: enumeration)
Parameters
Style
any
Library
enumeration (optional)
CurrentDoc!
PersonalLibrary!
SharedLibrary!
See Also
BoxStyleDelete, BoxStyleEdit, BoxStyleRetrieve, GraphicBoxStyleDlg
BoxStyleDelete
Purpose
Delete a user-defined box style.
Syntax
BoxStyleDelete (Style: any; Library: enumeration)
Parameters
Style
any
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
Library
enumeration (optional)
CurrentDoc!
PersonalLibrary!
SharedLibrary!
See Also
BoxStyleCreate, BoxStyleEdit, BoxStyleRetrieve, GraphicBoxStyleDlg
BoxStyleEdit
Purpose
Begin box style editing.
Syntax
BoxStyleEdit (Style: any; Library: enumeration)
Parameters
Style
any Enclose user-defined styles in quotation marks.
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
Library
enumeration (optional)
CurrentDoc!
PersonalLibrary!
SharedLibrary!
See Also
BoxStyleCreate, BoxStyleDelete, BoxStyleEdit, BoxStyleEnd, BoxStyleRetrieve
BoxStyleEnd
Purpose
Exit the graphics style create or edit mode with or without saving changes. Precede this command with BoxStyleCreate or BoxStyleEdit.
Syntax
BoxStyleEnd (State: enumeration)
Parameters
State
enumeration
Cancel!
Save!
See Also
BoxStyleCreate, BoxStyleEdit
BoxStyleName
Purpose
Specify a box style name. Precede with BoxStyleCreate.
Syntax
BoxStyleName (StyleName: string)
Parameters
StyleName
string
See Also
BoxStyleCreate
BoxStyleRetrieve
Purpose
Retrieve all box graphics styles from the specified document or template and add to the specified style list.
Syntax
BoxStyleRetrieve (Filename: string; Library: enumeration)
Parameters
Filename
string The path and filename of a document or template containing the styles to retrieve.
Library
enumeration Destination for the retrieved styles. Use CurrentDoc! to add the styles to the current document style list. Use PersonalLibrary! to add the styles to the default template style list. Use SharedLibrary! to add the styles to the additional objects template style list. If an additional objects template is not specified in Files Settings, and SharedLibrary! is used here, the command does nothing.
CurrentDoc!
PersonalLibrary!
SharedLibrary! Not used.
See Also
BoxStyleCopy, BoxStyleSave
BoxStyleSave
Purpose
Save all styles in the current document or a specified style library to another style library, replacing all styles already in it.
Syntax
BoxStyleSave (Filename: string; Library: enumeration)
Parameters
Filename
string The style library to save to.
Library
enumeration The current style location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
See Also
BoxStyleCopy, BoxStyleRetrieve
BoxTextAngle
Purpose
Rotate the text in a text box.
Syntax
BoxTextAngle (Angle: enumeration)
Parameters
Angle
enumeration
Degrees180!
Degrees270!
Degrees90!
None!
See Also
?BoxTextAngle, BoxCreate, BoxEdit, BoxEnd
BoxTextDefaultStyle
Purpose
Specify the default text box style.
Syntax
BoxTextDefaultStyle (Style: any)
Parameters
Style
any
|
AddressStyle! |
Legal4Style! |
|
BoxTextStyle! |
Legal5Style! |
|
BulletsOutlnStyle! |
Legal6Style! |
|
CaptionStyle! |
Legal7Style! |
|
CommentStyle! |
Legal8Style! |
|
CustomHTMLStyle! |
LegalOutlnStyle! |
|
Definition1Style! |
Level1Style! |
|
Definition2Style! |
Level2Style! |
|
Definition3Style! |
Level3Style! |
|
Definition4Style! |
Level4Style! |
|
Definition5Style! |
Level5Style! |
|
Definition6Style! |
Level6Style! |
|
Definition7Style! |
Level7Style! |
|
Definition8Style! |
Level8Style! |
|
DefinitionsOutlnStyle! |
ListStyle! |
|
DocStyle! |
MonospacedStyle! |
|
EndnoteNumberInDocumentStyle! |
NormalStyle! |
|
EndnoteStyle! |
NumbersOutlnStyle! |
|
EquationNumberStyle! |
OutlineStyle! |
|
FigureNumberStyle! |
ParagraphOutlnStyle! |
|
FooterAStyle! |
PreformattedStyle! |
|
FooterBStyle! |
Quotation1Style! |
|
FootnoteNumberInDocumentStyle! |
Quotation2Style! |
|
FootnoteStyle! |
Quotation3Style! |
|
HeaderAStyle! |
Quotation4Style! |
|
HeaderBStyle! |
Quotation5Style! |
|
Heading1Style! |
Quotation6Style! |
|
Heading2Style! |
Quotation7Style! |
|
Heading3Style! |
Quotation8Style! |
|
Heading4Style! |
QuotationsOutlnStyle! |
|
Heading5Style! |
TableBoxNumberStyle! |
|
Heading6Style! |
TextBoxNumberStyle! |
|
Heading7Style! |
ToAStyle! |
|
Heading8Style! |
ToC1Style! |
|
HeadingsOutlnStyle! |
ToC2Style! |
|
HypertextStyle! |
ToC3Style! |
|
Index1Style! |
ToC4Style! |
|
Index2Style! |
ToC5Style! |
|
Legal_2OutlnStyle! |
UserBoxNumberStyle! |
|
Legal1Style! |
WatermarkAStyle! |
|
Legal2Style! |
WatermarkBStyle! |
|
Legal3Style! |
See Also
?BoxTextDefaultStyle, BoxCreate, BoxEdit, BoxEnd
BoxTextEdit
Purpose
Begin the text box editing commands. Follow with commands that modify box contents such as Type and end with BoxTextEditEnd.
Syntax
BoxTextEdit ()
See Also
BoxContentEdit, BoxTextEditEnd
BoxTextEditEnd
Purpose
End the text box editing commands. Precede with BoxTextEdit and commands such as Type which modify box text.
Syntax
BoxTextEditEnd ()
See Also
BoxTextEdit, SubstructureExit
BoxTextFilename
Purpose
Specify a file to insert into a text box.
Syntax
BoxTextFilename (Filename: string)
Parameters
Filename
string
BoxTextFlow
Purpose
Specify the side(s) of a box to wrap text around.
Syntax
BoxTextFlow (Wrap: enumeration)
Parameters
Wrap
enumeration
BothSides!
Columnar!
LargestSide!
LeftSide!
NeitherSide!
NoWrapping!
RightSide!
See Also
?BoxWrapping, BoxCreate, BoxEdit, BoxEnd
BoxTextFlowContour
Purpose
Contour the text outside a box to the shape of an image inside the box.
Syntax
BoxTextFlowContour ()
See Also
BoxTextFlow, BoxTextFlowSquare
BoxTextFlowSquare
Purpose
Contour the text outside a box evenly around all sides of the box. Precede with BoxTextFlowContour.
Syntax
BoxTextFlowSquare ()
See Also
BoxTextFlow, BoxTextFlowContour
BoxToBack
Purpose
Move the selected object(s) to the back.
Syntax
BoxToBack ()
BoxToFront
Purpose
Move the selected object(s) to the front.
Syntax
BoxToFront ()
BoxUpdateDisplay
Purpose
Update the appearance of a box after editing changes. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.
Syntax
BoxUpdateDisplay ()
BoxVerticalAlignment
Purpose
Align a box with the page or character it is attached to. This command is not valid with paragraph-attached boxes. Precede with BoxCreate or BoxEdit and follow with BoxEnd.
Syntax
BoxVerticalAlignment (Alignment: enumeration; Offset: any)
Parameters
Alignment
enumeration
Baseline!
BaseOffset!
Bottom!
Center!
FullAlign!
Top!
Offset
any (optional)
See Also
?BoxVerticalAlignment, ?BoxVerticalOffset, BoxCreate, BoxEdit, BoxEnd, BoxVerticalPosition
BoxVerticalPosition
Purpose
Specify the vertical position of a box attached to a page or paragraph. For example, the distance from the top of the page (or top margin) to the top of the box. Not valid for boxes attached to characters.
Syntax
BoxVerticalPosition (Alignment: any)
Parameters
Alignment
any
See Also
BoxCreate, BoxEdit, BoxEnd, BoxVerticalAlignment, TextBoxCreate
BoxWidth
Purpose
Base the box width on the width of box contents or specify a fixed measurement.
Syntax
BoxWidth (Width: any)
Parameters
Width
any Use a number to specify a fixed width.
AutoWidth!
See Also
?BoxWidth, BoxCreate, BoxEdit, BoxEnd, BoxHeight
BoxWrapDlg
Purpose
Display the Wrap Text dialog box.
Syntax
BoxWrapDlg ()
BulletDlg
Purpose
Display the Bullets & Numbers dialog box.
Syntax
BulletDlg ()
BulletSetCounter
Purpose
Specify a bullet style name and counter value.
Syntax
BulletSetCounter (CounterName: string; Value: numeric)
Parameters
CounterName
string
Value
numeric
ButtonBarAddItem
Purpose
Add items such as macros, buttons, and separators to a toolbar. use any combination of parameters to identify an item.
Syntax
ButtonBarAddItem (ButtonBarName: string; Template: enumeration; ItemName: string; Offset: numeric; Type: enumeration; MacroName: string; ItemText: string; Prompt: string; HelpFile: string; HelpId: string; Script: string)
Parameters
ButtonBarName
string The toolbar to edit.
Template
enumeration (optional) The toolbar location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
ItemName
string For predefined items, use a macro command name.
Offset
numeric (optional) The position of an added item. First position: 0. Default: last.
Type
enumeration
Feature!
Launch!
Macro!
Script!
Separator!
MacroName
string (optional)
ItemText
string (optional) The text to display on a user-defined item.
Prompt
string (optional) The text to display for the new item on the status bar.
HelpFile
string (optional) The Help file to use if Help is the added item. Not used in the current version of the application.
HelpId
string (optional) The ID number of the Help file specified in the HelpFile parameter. Not used in the current version of the application.
Script
string (optional)
ButtonBarCreateDlg
Purpose
Display the Create Toolbar dialog box.
Syntax
ButtonBarCreateDlg ()
ButtonBarDeleteItem
Purpose
Remove an item from a toolbar. Default: Last item on the current toolbar. Use any combination of parameters to identify an item.
Syntax
ButtonBarDeleteItem (ButtonBarName: string; Template: enumeration; ItemName: string; Offset: numeric)
Parameters
ButtonBarName
string The toolbar name.
Template
enumeration (optional) The toolbar location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
ItemName
string (optional) For predefined items, use a macro command name.
Offset
numeric (optional) The position of the item to remove. First position: 0.
ButtonBarEditDlg
Purpose
Display the Toolbar Editor dialog box.
Syntax
ButtonBarEditDlg ()
ButtonBarOptionsDlg
Purpose
Display the Toolbar Options dialog box.
Syntax
ButtonBarOptionsDlg ()
ButtonBarScrollbarToggle
Purpose
Turn the toolbar scroll bar on or off.
Syntax
ButtonBarScrollbarToggle (State: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
State
enumeration (optional) Default = On!
Off!
On!
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
ButtonBarSelect
Purpose
Select a toolbar.
Syntax
ButtonBarSelect (ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
ButtonBarSetFont
Purpose
Specify a toolbar font face and size.
Syntax
ButtonBarSetFont (Font: string; Size: numeric)
Parameters
Font
string
Size
numeric
See Also
ButtonBarSetLocation, ButtonBarSetRows, ButtonBarSetStyle
ButtonBarSetLocation
Purpose
Specify a toolbar position.
Syntax
ButtonBarSetLocation (Location: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
Location
enumeration
Bottom!
Left!
Palette!
Right!
Top!
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
See Also
ButtonBarSetFont, ButtonBarSetRows, ButtonBarSetStyle
ButtonBarSetRows
Purpose
Specify the number of rows on a toolbar.
Syntax
ButtonBarSetRows (Rows: numeric; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
Rows
numeric
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
See Also
ButtonBarSetFont, ButtonBarSetLocation, ButtonBarSetStyle
ButtonBarSetStyle
Purpose
Specify a toolbar style.
Syntax
ButtonBarSetStyle (Style: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
Style
enumeration
Picture!
PictureAndText!
Text!
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
See Also
ButtonBarSetFont, ButtonBarSetLocation, ButtonBarSetRows
ButtonBarShow
Purpose
Display or hide the toolbar. Recordable substitute: ButtonBarShowToggle.
Syntax
ButtonBarShow (State: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)
Parameters
State
enumeration
Off!
On!
ButtonBarName
string
LoadedFromDefaultTemplate
enumeration
No!
Yes!
See Also
?ButtonBarActive, ViewToolbarsDlg
ButtonBarShowToggle
Purpose
Display or hide the toolbar.
Syntax
ButtonBarShowToggle ()
See Also
ButtonBarShow