Chapter 12
Corel® WordPerfect® Product Commands
B
BackTab
Purpose
Insert a [Hd Back Tab] code at the insertion point. This code will move the current line of text left one tab from the insertion point.
Syntax
BackTab ()
See Also
Tab, TabInsert
Backup
Purpose
Turn Timed Document Backup on or off and return the current state.
Syntax
boolean := Backup (State: enumeration)
Parameters
| State | enumeration |
| Off! | |
| On! |
See Also
BackupMinutes, BackupOriginalDoc
BackupMinutes
Purpose
Specify the number of minutes between timed backups.
Syntax
BackupMinutes (Minutes: numeric)
Parameters
| Minutes | numeric |
See Also
Backup, BackupOriginalDoc, PrefSave
BackupOriginalDoc
Purpose
Turn Original Document Backup on or off.
Syntax
BackupOriginalDoc (State: enumeration)
Parameters
| State | enumeration |
| Off! | |
| On! |
See Also
Backup, BackupMinutes, PrefSave
BarcodeDlg
Purpose
Display the POSTNET Barcode dialog box.
Syntax
BarcodeDlg ()
See Also
BarcodePOSTNET
BarcodePOSTNET
Purpose
Specify a ZIP Code or merge field containing a ZIP Code.
Syntax
BarcodePOSTNET (Zip: string; State: enumeration)
Parameters
| Zip | string | A five, nine, or eleven-digit ZIP Code. If the ZIP Code is in a merge field, the parameter can be a string that specifies the field. |
| State | enumeration | (optional) Enable a merge field to provide a ZIP Code. Required only when a merge field is specified in the ZIP parameter. |
| MergeFieldAllowed! |
See Also
BarcodeDlg
BaselinePlacement
Purpose
Turn the Baseline placement for typesetting option on or off.
Syntax
BaselinePlacement (State: enumeration)
Parameters
| State | enumeration |
| Off! | |
| On! |
See Also
?BaselineMode
Binding
Purpose
Specify a binding offset for a specified paper edge. Use this command to specify two-sided document settings. This command inserts a [Binding Width] code at the beginning of the current page.
Syntax
Binding (Edge: enumeration; Offset: measurement)
Parameters
| Edge | enumeration |
| BottomEdge! | |
| LeftEdge! | |
| RightEdge! | |
| TopEdge! | |
| Offset | measurement |
See Also
?Binding, BindingOptionsDlg, DoubleSidedPrint, PrintTwoSidedDocCodesDlg, PrintUseTwoSidedDocCodes
BindingOptionsDlg
Purpose
Display the Print dialog box with the Two-Sided Printing tab active.
Syntax
BindingOptionsDlg ()
See Also
Binding, PrintDlg
BlockProtect
Purpose
Turn Block Protect on or off.
Syntax
BlockProtect (State: enumeration)
Parameters
| State | enumeration |
| Off! | |
| On! |
See Also
?BlockProtect, ConditionalEndOfPage, KeepTextTogetherDlg, WidowOrphan, BlockProtectToggle
BlockProtectToggle
Purpose
Toggle Block Protect on or off. The objects or text that are being block protected must be selected.
Syntax
BlockProtectToggle ()
See Also
?BlockProtect, BlockProtect
BoldKey
Purpose
Toggle Bold on or off at the insertion point.
Syntax
BoldKey ()
See Also
AttributeAppearanceToggle
BookmarkBlock
Purpose
Find and select a specified bookmark. If the type of the specified bookmark is not selected, the insertion point is moved to the bookmark and select mode is activated, but nothing is selected.
Syntax
BookmarkBlock (Name: string)
Parameters
| Name | string (optional) |
See Also
BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename
BookmarkCreate
Purpose
Create a bookmark.
Syntax
BookmarkCreate (Name: string; Selected: enumeration)
Parameters
| Name | string |
| Selected | enumeration (optional) |
| No! | |
| Yes! |
See Also
?BookmarkList, BookmarkBlock, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename
BookmarkDelete
Purpose
Delete a specified bookmark.
Syntax
BookmarkDelete (Name: string)
Parameters
| Name | string (optional) |
See Also
BookmarkBlock, BookmarkCreate, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename
BookmarkDlg
Purpose
Display the Bookmark dialog box.
Syntax
BookmarkDlg ()
See Also
BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkFind, BookmarkMove, BookmarkRename
BookmarkFind
Purpose
Find a specified bookmark.
Syntax
BookmarkFind (Name: string)
Parameters
| Name | string (optional) |
See Also
BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkMove, BookmarkRename
BookmarkMove
Purpose
Move a bookmark to the insertion point.
Syntax
BookmarkMove (Name: string)
Parameters
| Name | string (optional) |
See Also
BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkRename
BookmarkRename
Purpose
Rename a bookmark.
Syntax
BookmarkRename (OldName: string; NewName: string)
Parameters
| OldName | string |
| NewName | string |
See Also
BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove
BorderBottomLine
Purpose
Specify the style of a bottom border line. Precede with BorderStyleCreate or BorderStyleEdit, and end with BorderStyleEnd.
Syntax
BorderBottomLine (Style: any)
Parameters
| Style | any | Use a string for user-defined style names. |
| ButtonBottomRightLine! | HeavySingleLine! | |
| ButtonTopLeftLine! | NoLine! | |
| DashedLine! | SingleLine! | |
| DottedLine! | TableDefaultLine! | |
| DoubleLine! | ThickLine! | |
| ExtraThickLine! | ThickThinLine! | |
| HeavyDoubleLine! | ThinThickLine! |
See Also
?BorderBottomLine, BorderLeftLine, BorderRightLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderColor
Purpose
Specify the color of a graphics box, paragraph, page, or column border. Empty parameters use current program settings. Precede with BorderStyleCreate or BorderStyleEdit and BorderUseBorderColor, and end with BorderStyleEnd. The values of a selected color are displayed in the Define Color Printing Palette dialog box.
Syntax
BorderColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)
Parameters
| ColorName | string | (optional) This parameter has been left in for backward compatability with previous versions of Corel WordPerfect. To specify a color in Corel WordPerfect 8, use the Red, Green, and Blue parameters. |
| Red | numeric | (optional) Value: 0-255. |
| Green | numeric | (optional) Value: 0-255. |
| Blue | numeric | (optional) Value: 0-255. |
| Shade | numeric | (optional) Percent: 0-100. |
See Also
?BorderColorBlue, ?BorderColorGreen, ?BorderColorRed, ?BorderColorShading, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, BorderUseBorderColor, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderCornerRadius
Purpose
Specify the curve of border corners.
Syntax
BorderCornerRadius (Radius: measurement)
Parameters
| Radius | measurement | Higher measurements produce more rounded corners. |
See Also
?BorderCornerRadius, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderDropShadow
Purpose
Specify the location, size, and color of a border shadow. The values of a selected color are displayed in the Define Color Printing Palette dialog box.
Syntax
BorderDropShadow (Location: enumeration; Size: measurement; ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)
Parameters
| Location | enumeration | (optional) |
| LowerLeft! | ||
| LowerRight! | ||
| NoShadow! | ||
| UpperLeft! | ||
| UpperRight! | ||
| Size | measurement | (optional) Default: .125" |
| ColorName | string | (optional) This parameter has been left in for backward compatability with previous versions of Corel WordPerfect. To specify a color in Corel WordPerfect, use the Red, Green, and Blue parameters. |
| Red | numeric | (optional) Value: 0-255. |
| Green | numeric | (optional) Value: 0-255. |
| Blue | numeric | (optional) Value: 0-255. |
| Shade | numeric | (optional) Percent: 0-100. |
See Also
BorderStyleCreate, BorderStyleEdit, BorderStyleEnd
BorderInsideSpacing
Purpose
Specify the inside border spacing. Not available for page borders. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Syntax
BorderInsideSpacing (Bottom: measurement; Left: measurement; Right: measurement; Top: measurement)
Parameters
| Bottom | measurement (optional) |
| Left | measurement (optional) |
| Right | measurement (optional) |
| Top | measurement (optional) |
See Also
?BorderInsideSpacingTop, ?BorderInsideSpacingBottom, BorderOutsideSpacing, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderLeftLine
Purpose
Specify the left line style of a border.
Syntax
BorderLeftLine (Style: any)
Parameters
| Style | any | Use a string for user-defined styles. |
| ButtonBottomRightLine! | HeavySingleLine! | |
| ButtonTopLeftLine! | NoLine! | |
| DashedLine! | SingleLine! | |
| DottedLine! | TableDefaultLine! | |
| DoubleLine! | ThickLine! | |
| ExtraThickLine! | ThickThinLine! | |
| HeavyDoubleLine! | ThinThickLine! |
See Also
?BorderLeftLine, BorderBottomLine, BorderRightLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderOutsideSpacing
Purpose
Specify the outside border spacing.
Syntax
BorderOutsideSpacing (Left: measurement; Right: measurement; Top: measurement; Bottom: measurement)
Parameters
| Left | measurement |
| Right | measurement |
| Top | measurement |
| Bottom | measurement |
See Also
BorderInsideSpacing, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderRightLine
Purpose
Specify a right line border style.
Syntax
BorderRightLine (Style: any)
Parameters
| Style | any | Use a string for user-defined styles. |
| ButtonBottomRightLine! | HeavySingleLine! | |
| ButtonTopLeftLine! | NoLine! | |
| DashedLine! | SingleLine! | |
| DottedLine! | TableDefaultLine! | |
| DoubleLine! | ThickLine! | |
| ExtraThickLine! | ThickThinLine! | |
| HeavyDoubleLine! | ThinThickLine! |
See Also
?BorderRightLine, BorderBottomLine, BorderLeftLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderSeparatorLine
Purpose
Specify a separator line style in a paragraph or column border. Precede with BorderStyleCreate or BorderStyleEdit and end with BorderStyleEnd.
Syntax
BorderSeparatorLine (Style: any)
Parameters
| Style | any | Use a string for user-defined styles. |
| ButtonBottomRightLine! | HeavySingleLine! | |
| ButtonTopLeftLine! | NoLine! | |
| DashedLine! | SingleLine! | |
| DottedLine! | TableDefaultLine! | |
| DoubleLine! | ThickLine! | |
| ExtraThickLine! | ThickThinLine! | |
| HeavyDoubleLine! | ThinThickLine! |
See Also
?BorderSeparatorLine, BorderBottomLine, BorderLeftLine, BorderRightLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderSetSpacing
Purpose
Turn Auto spacing on or off in the current border style. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Syntax
BorderSetSpacing (State: enumeration)
Parameters
| State | enumeration | |
| Yes! | Set border spacing on | |
| No! | Auto border spacing on |
See Also
?BorderSetSpacing, BorderInsideSpacing, BorderOutsideSpacing, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderStyleCopy
Purpose
Copy a border style.
Syntax
BorderStyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)
Parameters
| Style | any | Enclose user-defined styles in quotation marks. |
| ButtonBorder! | HeavySingleBorder! | |
| ColumnBorderAll! | NoBorder! | |
| ColumnBorderBetween! | SingleBorder! | |
| DashedBorder! | SpacingOnly! | |
| DottedBorder! | ThickBorder! | |
| DoubleBorder! | ThickThinBorder! | |
| ExtraThickBorder! | ThickTopBottomBorder! | |
| HeavyDoubleBorder! | ThinThickBorder! | |
| FromLibrary | enumeration | (optional) |
| CurrentDocument! | ||
| PersonalLibrary! | ||
| SharedLibrary! | ||
| ToLibrary | enumeration | (optional) |
| CurrentDocument! | ||
| PersonalLibrary! | ||
| SharedLibrary! | ||
| DestName | string | (optional) The new name for a style. |
See Also
BorderStyleRetrieve, BorderStyleSave
BorderStyleCreate
Purpose
Create a new border style.
Syntax
BorderStyleCreate (Style: string; Library: enumeration)
Parameters
| Style | string |
| Library | enumeration (optional) |
| CurrentDoc! | |
| PersonalLibrary! | |
| SharedLibrary! |
See Also
BorderStyleDelete, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderStyleDelete
Purpose
Delete a border style.
Syntax
BorderStyleDelete (Style: any; Library: enumeration)
Parameters
| Style | any | Enclose user-defined styles in quotation marks. |
| ButtonBorder! | HeavySingleBorder! | |
| ColumnBorderAll! | NoBorder! | |
| ColumnBorderBetween! | SingleBorder! | |
| DashedBorder! | SpacingOnly! | |
| DottedBorder! | ThickBorder! | |
| DoubleBorder! | ThickThinBorder! | |
| ExtraThickBorder! | ThickTopBottomBorder! | |
| HeavyDoubleBorder! | ThinThickBorder! | |
| Library | enumeration | (optional) |
| CurrentDoc! | ||
| PersonalLibrary! | ||
| SharedLibrary! |
See Also
BorderStyleCopy, BorderStyleRetrieve, BorderStyleSave, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderStyleEdit
Purpose
Specify a border style to edit.
Syntax
BorderStyleEdit (Style: any; Library: enumeration)
Parameters
| Style | any | Enclose user-defined styles in quotation marks. |
| ButtonBorder! | HeavySingleBorder! | |
| ColumnBorderAll! | NoBorder! | |
| ColumnBorderBetween! | SingleBorder! | |
| DashedBorder! | SpacingOnly! | |
| DottedBorder! | ThickBorder! | |
| DoubleBorder! | ThickThinBorder! | |
| ExtraThickBorder! | ThickTopBottomBorder! | |
| HeavyDoubleBorder! | ThinThickBorder! | |
| Library | enumeration | (optional) |
| CurrentDoc! | ||
| PersonalLibrary! | ||
| SharedLibrary! |
See Also
?Border, BorderStyleCreate, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderStyleEnd
Purpose
Exit border style create or edit mode with or without saving changes. Precede this command with BorderStyleCreate or BorderStyleEdit.
Syntax
BorderStyleEnd (State: enumeration)
Parameters
| State | enumeration |
| Cancel! | |
| Save! |
See Also
BorderStyleCreate, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderStyleName
Purpose
Rename a user-defined border style. Precede with BorderStyleEdit.
Syntax
BorderStyleName (Style: string)
Parameters
| Style | string |
See Also
BorderStyleCreate, BorderStyleEdit
BorderStyleRetrieve
Purpose
Retrieve all border graphics styles from the specified document or template and add to the specified style list.
Syntax
BorderStyleRetrieve (Filename: string; FromLibrary: enumeration)
Parameters
| Filename | string | The path and filename of a document or template containing the styles to retrieve. |
| FromLibrary | enumeration | The 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! |
See Also
BorderStyleSave, StyleCopy
BorderStyleSave
Purpose
Save border styles to a specified library.
Syntax
BorderStyleSave (Filename: string; Library: enumeration)
Parameters
| Filename | string | The full path required. |
| Library | enumeration | |
| CurrentDoc! | ||
| PersonalLibrary! | ||
| SharedLibrary! |
See Also
BorderStyleCopy, BorderStyleRetrieve
BorderTopLine
Purpose
Specify the top line style of a border. Precede with BorderStyleCreate or BorderStyleEdit and end with BorderStyleEnd.
Syntax
BorderTopLine (Style: any)
Parameters
| Style | any | Enclose user-defined styles in quotation marks. |
| ButtonBottomRightLine! | HeavySingleLine! | |
| ButtonTopLeftLine! | NoLine! | |
| DashedLine! | SingleLine! | |
| DottedLine! | TableDefaultLine! | |
| DoubleLine! | ThickLine! | |
| ExtraThickLine! | ThickThinLine! | |
| HeavyDoubleLine! | ThinThickLine! |
See Also
?BorderTopLine, BorderBottomLine, BorderLeftLine, BorderRightLine, BorderSeparatorLine, TextBorderCreate, TextBorderEdit, TextBorderEnd
BorderUseBorderColor
Purpose
Specify whether the current border uses the line style color or the border color. Precede with BorderStyleCreate or BorderStyleEdit, follow with BorderColor, and end with BorderStyleEnd.
Syntax
BorderUseBorderColor (State: enumeration)
Parameters
| State | enumeration | |
| No! | Use line style color | |
| Yes! | Use border color |
See Also
?BorderUseBorderColor, BorderColor, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd
BoxAttachTo
Purpose
Anchor a graphics box to a page, paragraph, or character. Precede with BoxCreate or BoxEdit and end with BoxEnd.
Syntax
BoxAttachTo (Anchor: enumeration)
Parameters
| Anchor | enumeration |
| Character! | |
| Page! | |
| Paragraph! |
See Also
?BoxAttachTo, BoxCreate, BoxEdit, BoxEnd, BoxHorizontalPosition, BoxVerticalPosition
BoxBackwardOne
Purpose
Move the selected object(s) back one layer. Precede with BoxCreate or BoxEdit.
Syntax
BoxBackwardOne ()
See Also
BoxCreate, BoxEdit, BoxForwardOne
BoxBorder
Purpose
Specify a box border style. Precede with BoxCreate or BoxEdit and end with BoxEnd.
Syntax
BoxBorder (Style: any)
Parameters
| Style | any | |
| ButtonBorder! | HeavySingleBorder! | |
| ColumnBorderAll! | NoBorder! | |
| ColumnBorderBetween! | SingleBorder! | |
| DashedBorder! | SpacingOnly! | |
| DottedBorder! | ThickBorder! | |
| DoubleBorder! | ThickThinBorder! | |
| ExtraThickBorder! | ThickTopBottomBorder! | |
| HeavyDoubleBorder! | ThinThickBorder! |
See Also
BoxBorderDlg, BoxCreate, BoxEdit, BoxEnd
BoxBorderDlg
Purpose
Display the Box Border/Fill Styles dialog box.
Syntax
BoxBorderDlg ()
See Also
BoxBorder
BoxCaptionEdit
Purpose
Begin the caption editing commands. Follow with commands such as Type that furnish caption text.
Syntax
BoxCaptionEdit ()
See Also
BoxCaptionEditEnd