╔═════╦═════════════════════════════╦═════╗
║ ╔═╦═╝  Corel Corporation Limited  ╚═╦═╗ ║
╠═╬═╝                                 ╚═╬═╣
╠═╬═╗   Corel WP 6.2 Product Macros   ╔═╬═╣
║ ╚═╩═╗          01/01/97           ╔═╩═╝ ║
╚═════╩═════════════════════════════╩═════╝

Table of Contents

Introduction

Macros are powerful tools for any Corel® WordPerfect® 6.2 for DOS user. This manual contains basic information for beginning macro writers as well as important concepts for more advanced macro writers. The largest section of this manual is dedicated to descriptions of each product command available in Corel WordPerfect 6.2 for DOS.

What's in this Manual?

This manual is divided into three sections.A brief description of each section follows.

Using Product Commands

This section contains basic information concerning the Corel WordPerfect 6.2 for DOS macro language. Most macros involve product commands since they constitute the bulk of the macro language. As a result, this section describes the "anatomy" product commands and introduces concepts essential for creating macros.

Product Commands Reference

This section contains a description of each product command. In addition to a description, this section includes syntax, parameters, related commands, and, where appropriate, an example of each command.

Glossary

The glossary defines terms specific to macros. If you encounter a term that is unfamiliar to you, refer to the glossary for a definition.

Using this Manual

As you read through this manual, you should understand the following conventions and terms. They will help you locate and interpret the information you need.

Mouse Instructions

Unless otherwise noted, mouse actions refer to the left button. Most instructions in this manual refer to the mouse.

Keyboard Instructions

Although this manual is written with the mouse user in mind, some instructions involve the keyboard. When function keys are involved in the instruction, a plus sign between keys (such as Alt+F10) means that you must hold down the first key while pressing the second. A comma between keys (such as Home, Down Arrow) means to release the first key before you press the second.

Text you are asked to type is in bolded lettering.

Notes

Throughout this manual you may see two kinds of notes: Important and Hint.

IMPORTANT: The important note gives critical information for completing a task or using macro features. When you see an important note, you should be sure to read it.

HINT: A hint note provides additional information about using a macro feature or a macro command.

README Files

Before you begin using this manual, we suggest you glance through the README files that apply to Corel WordPerfect 6.2 for DOS macros. Occasionally, changes are made to a program after a manual has been printed. README files generally contain information about those changes.

Using Product Commands

Macro Basics

Use Corel WordPerfect macros to record commands that perform a task automatically. For example, you can create a macro that opens a file, gives it a new name, and saves it in another file format.

What's in this section?

Concepts

Corel WordPerfect 6.2 Macro Language

The Corel WordPerfect 6.2 macro language is a command-based language. This means that Corel WordPerfect records the results of keystrokes or mouse selections instead of recording the keystrokes themselves. For example, instead of recording each keystroke involved in changing your top margin to 2", Corel WordPerfect simply records the command MarginTop(2"). These commands are called product commands.

The Corel WordPerfect 6.2 macro language also includes programming commands and operators such as AND, OR, LABEL, and CHAR. These commands let you create macros that can evaluate conditional statements that respond to user input. System variables are also included in the Corel WordPerfect 6.2 macro language to provide the macro with information about the current state of Corel WordPerfect.

Corel WordPerfect 6.2 macros do not need a macro editor. They are simply Corel WordPerfect documents that can be opened, edited, and even formatted in any of the nine Corel WordPerfect document windows.

Methods for Recording Macro Commands

There are several ways to create macros. You can let Corel WordPerfect record commands for you, or you can type in the appropriate commands yourself. You can also use these two methods in combination. For more information on typing in the commands yourself, see Typing Macro Commands Yourself under Additional Information later in this section. For more information on using the two methods in combination, see Editing a Macro later in this section.

You can record macro programming commands and system variables by selecting them from the Macro Commands dialog box. For more information, see Recording and Editing Macros in the macro online help.

Recording a Macro

1 Choose Macro from the Tools menu, then choose Record.

Or Press Ctrl+F10

2 Type a filename for the macro. You can either assign a macro to an Alt+letter combination or use an eight character filename. Corel WordPerfect assigns a .WPM extension to the filename for you.

If you name a macro using an Alt+letter combination, you can either type altx as the filename or press Alt+x, where x is the letter you want to assign.

3 Choose OK to begin recording the macro.

4 Press keystrokes or choose menu items to record macro commands.

The message "Recording Macro" displays in the lower left corner of the document window throughout the recording process. Corel WordPerfect records commands from the keyboard (including any text you type) as well as selections made with the mouse. However, while a macro is recording, the mouse cannot be used to position the cursor in the document window. If you want to position the cursor in the document window, you must use the keyboard.

To stop recording,

5 Choose Macro from the Tools menu, then choose Stop.

Or Press Ctrl+F10

Editing a Macro

To edit a macro,

1 Choose Macro from the Tools menu, choose Record, then select Edit Macro.

Or Press Home, Ctrl+F10

2 Type the filename of the macro you want to edit. You can also click on the drop-down list or press the down arrow key to list the last four opened macros, then choose OK.

Open the macro, press Ctrl+PgUp, choose Macro Record Document, then choose OK

3 Type in new commands or edit existing ones. You can also press Switch (Shift+F3) to record commands, then press Switch again to return to the macro.

You can switch between recording and editing as many times as you want. When you press Switch, a new document window opens, and every selection you make is recorded. While you are recording commands, you can tile the document windows to see the commands inserted into the macro. Recorded commands are inserted into the macro at the cursor. When you are finished recording, press Switch again, and you will return to your original macro.

To stop editing,

4 Choose Exit from the File menu.

5 Choose Yes to save the macro, then choose Yes to exit the document window.

Compiling a Macro

A macro compiler is used to compile or "translate" macros so that Corel WordPerfect can play them.

To compile a macro,

1 Choose Save from the File menu to save the macro.

Or Press F10

2 Choose Macro from the Tools menu, the choose Play to play the macro.

Or Press Alt+F10

If you receive an error message while the macro is compiling during a save, you can either choose Edit or Save Anyway. If you choose Save Anyway, the macro will be saved, but it will not compile. If you are playing a macro and you choose Edit, the macro file will open, and your cursor will be placed somewhere after the problem.

Playing a Macro

1 Choose Macro from the Tools menu, then choose Play.

Or Press Alt+F10

2 Type the filename of the macro you want to play or select it from the File List or QuickList. You can also press the down arrow key to display the last four macros.

3 Choose OK.

Helps and Hints

The Macro Compiler

The compiler is a useful tool for troubleshooting macro problems. If the compiler locates an error, a dialog box will display containing general information about the problem. If you choose to edit the macro, your cursor will be placed somewhere after the error. The macro compiler can only make a "best guess" as to what the macro is actually designed to accomplish, however. As a result, errors given by the compiler sometimes serve as direction to, rather than specific identification of, the reported problem.

Macro Commands and Syntax

In the Corel WordPerfect 6.2 macro language, a macro command is an instruction for Corel WordPerfect to carry out. To execute properly, macro commands must be arranged in the correct order. This arrangement is called syntax. To be syntactically correct, each macro command must be spelled correctly and must include all of the required parameters and the necessary separators in the correct order.

Macro commands are constructed sequentially from left to right and consist of three parts: command name, parameters, and separators.

Command Name

The command name indicates which feature the command activates. Sometimes the name is all that is necessary to perform a complete action. Any command that does not require parameters is considered a complete macro command. For example, FileManagerDlg is a complete macro command because Corel WordPerfect needs no more information to execute it properly; the command name itself instructs the program to open the File Manager dialog box.

Example: FileManagerDlg

Parameters

If Corel WordPerfect needs more information than is provided by the command name alone, parameters are required. The command name represents the feature. Parameters, in turn, represent aspects of the feature you can change or selections you can make. This includes such things as specifying a font or defining columns. For example, the Backup command requires one parameter indicating whether you want Backup on or off. Parameters are always enclosed in parentheses.

Example: Backup(On!)

Separators

Some macro commands require several parameters. Parameters must be placed in the correct order and must be separated properly. Semi-colons (;) are used to separate individual parameters, and an entire string of parameters must be enclosed in parentheses. Groups of repeating parameters are also enclosed in French braces ({}). For example, the MENULIST programming command requires a variable and a list of menu items (the title and location parameters are optional). The menu item parameter can be repeated for as many menu items as you want to include, and the entire list is enclosed in French braces.

Example: MENULIST(Var1;{"Files";"Graphics"};"Directories")

Note that the menu items and the title are enclosed in quotes. For more information, see the Expressions and Variables section in the macros online help. The macro help file can be accessed by choosing Macros from the Help menu.

See the Macro Commands Index section in the macro online help for the required syntax and a description of each parameter for all Corel WordPerfect 6.2 macro commands.

Recording Dialog Boxes

When playing a macro, you may want a dialog box to open and then pause to let the user insert the necessary information. In these instances, the macro needs to include a command that invokes a dialog box. Corel WordPerfect 6.2 has such a command for almost every dialog box in the program. These commands are usually the name of the dialog box followed by Dlg. For example, the command to open the File Manager dialog box is FileManagerDlg. When a macro encounters a command that opens a dialog box, the macro pauses to allow the user to select options in the dialog box. When the user closes the dialog box, Corel WordPerfect sets the selected options, then resumes playing the macro.

To record a dialog box command, display the dialog box as you normally would, then select the check box located in the upper right corner of the dialog box. This check box will only be visible while you are recording a macro. After selecting the check box, choose Cancel to close the dialog box. If you do not have a mouse, select the check box by pressing Ctrl+M.

Additional Information

Macros Online Help

Corel WordPerfect 6.2 includes an online macros manual. To access the manual, choose Macros from the Help menu.

Converting Corel WordPerfect 5.1 Macros

For information on converting Corel WordPerfect 5.1 macros to Corel WordPerfect 6.2 format, see the Converting 5.1 Macros section in the macros online help. The macro help file can be accessed by choosing Macros from the Help menu.

Typing Macro Commands Yourself

Because Corel WordPerfect 6.2 macros do not need a Macro Editor, you can insert macro commands by typing them in a blank document. When you save a macro, remember to give it a .WPM extension.

If you want to improve the readability of a macro, you can include tabs, spaces, and even font or attribute changes. Formatting the macro will not affect how it works. For example, Corel WordPerfect records the following macro in this format:

PosDocBottom
Type("Sincerely")
HardReturn
HardReturn
HardReturn
HardReturn
Type("Ms. Sharon Openshaw")
HardReturn
Type("Vice President, Marketing")

However, if you type in the commands yourself, or edit the existing macro, you could format it as follows:

        PosDocBottom

Type ("Sincerely")

        HardReturn
        HardReturn
        HardReturn
        HardReturn

Type ("Ms. Sharon Openshaw")

        HardReturn

Type ("Vice President, Marketing")

Product Commands

Advance

Advance positions text a specified distance from the top or left edge of the page or at a certain distance from the current cursor position. This command is the equivalent of choosing Layout, Other, Advance, and setting options. This command is not recordable. To use this command, you must type it into the macro.

Syntax

Advance(Type;Amount)

Parameters

Type
Specifies the text advance type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
AdvanceLeft! 0 Advances left from the cursor
AdvanceRight! 1 Advances right from the cursor
AdvanceFromLeftEdge! 2 Advances from left edge of page
AdvanceUp! 3 Advances up from the cursor
AdvanceDown! 4 Advances down from the cursor
AdvanceFromTop! 5 Advances from top of page
Amount
A measurement expression specifying an advance distance.

Example
To print text 3.5" to the right of the current cursor position, the command is:

Advance(AdvanceRight!;3.5")

See Also

AdvanceDlg

AdvanceDlg displays the Advance dialog box. This command is the equivalent of choosing Layout, Other, Advance.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

AdvanceDlg

Parameters

None.

See Also

AFCEditBegin

AFCEditBegin initiates automatic font changes. AFCEditBegin must be used in conjunction with AFCEditFont and AFCEditEnd. This command is the equivalent of choosing Font, Font, pressing Shift+F1, then choosing either Edit Automatic Font Changes for Printer Fonts or Edit Automatic Font Changes for Graphics Fonts.

Syntax

AFCEditBegin

Parameters

None.

See Also

AFCEditEnd

AFCEditEnd marks the end of automatic font changes to either a printer driver or a graphics driver, and saves or cancels the changes. AFCEditEnd must be used in conjunction with AFCEditBegin and AFCEditFont. This command is the equivalent of choosing OK or Cancel after making changes to printer fonts or graphics fonts.

Syntax

AFCEditEnd(State;Driver)

Parameters

State
Specifies whether to save automatic font changes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Do not save changes
Save! 1 Save changes
Driver
Specifies a driver where an automatic font change is saved. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PRSAFC 0 Printer driver
DRSAFC 1 Graphics driver

Example

To edit attribute Small for a Courier 10 pt. font, select a Roman font as the AFC, and save the changes to the current printer driver, the command sequence is:

AFCEditBegin
AFCEditFont("Courier 10";Small!;"Roman 12")
AFCEditEnd(Save!;PRSAFC!)

See Also

AFCEditFont

AFCEditFont makes an automatic font change to the specified font and attribute. This command is the equivalent of choosing Font, Font, pressing Shift+F1, selecting either Edit Automatic Font Changes for Printer Fonts or Edit Automatic Changes for Graphics Fonts, selecting a font, Edit, selecting an attribute, Edit, and selecting the font to use for this automatic font change.

Syntax

AFCEditFont(Font;Attribute;AFC)

Parameters

Font
A character expression specifying a font to edit.
Attribute
Specifies an attribute to edit. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ExtraLarge! 0 Edit Extra Large
VeryLarge! 1 Edit Very Large
Large! 2 Edit Large
Small! 3 Edit Small
Fine! 4 Edit Fine
Superscript! 5 Edit Superscript
Subscript! 6 Edit Subscript
Outline! 7 Edit Outline
Italics! 8 Edit Italics
Shadow! 9 Edit Shadow
Redline! 10 Edit Redline
DoubleUnderline! 11 Edit Double Underline
Bold! 12 Edit Bold
Strikeout! 13 Edit Strikeout
Underline! 14 Edit Underline
SmallCaps! 15 Edit Small Caps
ASCII! 16 Edit ASCII character set
BoxDrawing! 17 Edit Box Drawing character set
Multinational! 18 Edit Multinational character set
Phonetic! 19 Edit Phonetic character set
TypographicSymbols! 20 Edit Typographic Symbols character set
IconicSymbols! 21 Edit Iconic Symbols character set
MathScientific! 22 Edit Math/Scientific character set
MathScientificExtension! 23 Edit Math/Scientific Extension character set
Greek! 24 Edit Greek character set
Hebrew! 25 Edit Hebrew character set
Cyrillic! 26 Edit Cyrillic character set
Japanese! 27 Edit Japanese character set
Arabic! 28 Edit Arabic 1 character set
ArabicScript! 29 Edit Arabic Script character set
UserDefined! 30 Edit User Defined character set
Portrait! 31 Edit portrait fonts
Landscape! 32 Edit landscape fonts
ReversePortrait! 33 Edit reverse portrait fonts
ReverseLandscape! 34 Edit reverse landscape fonts
AFC (optional)
A character expression specifying the AFC (automatic font change) for the attribute specified in the Attribute parameter.

Example

To edit attribute Small for a Courier 10 pt. font, select a Roman font as the AFC, and save the changes to the current printer driver, the command sequence is:

AFCEditBegin
AFCEditFont("Courier 10";Small!;"Roman 12")
AFCEditEnd(Save!;PRSAFC!)

See Also

AltEqual

AltEqual is the equivalent of pressing Alt+Equal. This keystroke combination usually activates the menu, but the command will execute whatever Alt+Equal is designed to do in the state the program is in when the macro encounters this command. This doesn't include situations where Alt+Equal has been remapped in Keyboard Layout. This command is not recordable. To use this command, you must type it into the macro.

Syntax

AltEqual

Parameters

None.

AltHome

AltHome is the equivalent of pressing Alt+Home. This command will execute whatever Alt+Home is designed to do in the state the program is in when the macro encounters this command. This doesn't include situations where Alt+Home has been remapped in Keyboard Layout. This command is not recordable. To use this command, you must type it into the macro.

Syntax

AltHome

Parameters

None.

AltKeySelectsMenuBar

AltKeySelectsMenuBar determines whether the Alt key selects the menu bar. This command is the equivalent of choosing View, Screen Setup, Alt key.

Syntax

AltKeySelectsMenuBar(State)

Parameters

State
Specifies whether the Alt key selects the menu bar. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Does not select menu bar
Yes! 1 Selects menu bar

Example

To specify the Alt key to select the menu bar, the command is:

AltKeySelectsMenuBar(Yes!)

See Also

AppendFilenameDlg

AppendFilenameDlg displays the Append To dialog box. This dialog box specifies the name of a file to which the current document or currently blocked text will be appended. AppendFilenameDlg is the equivalent of choosing Edit, Append, To File.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

AppendFilenameDlg

Parameters

None.

See Also

AppendToFile

AppendToFile appends the current document or currently blocked text to another file. If no text is currently blocked, the entire document will be blocked. This command is the equivalent of choosing Edit, Append, To File, and specifying a filename.

Syntax

AppendToFile(Filename)

Parameters

Filename
A character expression specifying the file to which the document or currently blocked text should be appended.

Example

To append the current document to a file named REFERENC.DOC in the COREL\WP62 directory of drive C, the command is:

AppendToFile("C:\COREL\WP62\REFERENC.DOC")

See Also

AttributeAppearanceOff

AttributeAppearanceOff turns off specified font attribute(s) where this command is encountered. This command is the equivalent of choosing Font, Font, and deselecting attributes.

Syntax

AttributeAppearanceOff(Attribute)

Parameters

Attribute
Specifies the attribute(s) to turn off. AttributeAppearanceOff requires at least one attribute parameter, but will accept as many attributes as you need to turn off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Outline! 7 Turns off Outline
Italics! 8 Turns off Italics
Shadow! 9 Turns off Shadow
Redline! 10 Turns off Redline
DoubleUnderline! 11 Turns off DoubleUnderline
Bold! 12 Turns off Bold
Strikeout! 13 Turns off Strikeout
Underline! 14 Turns off Underline
SmallCaps! 15 Turns off Small Caps

Example

To turn off the attributes Shadow, Underline, and Small Caps, the command is:

AttributeAppearanceOff(Shadow!;Underline!;SmallCaps!)

See Also

AttributeAppearanceOn

AttributeAppearanceOn turns on the specified font attributes where this command is encountered. This command is the equivalent of choosing Font, Font, and selecting attributes.

Syntax

AttributeAppearanceOn(Attribute)

Parameters

Attribute
Specifies the attribute(s) to turn on. AttributeAppearanceOn requires at least one attribute parameter but will accept as many attributes as you need to turn on. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Outline! 7 Turns on Outline
Italics! 8 Turns on Italics
Shadow! 9 Turns on Shadow
Redline! 10 Turns on Redline
DoubleUnderline! 11 Turns on DoubleUnderline
Bold! 12 Turns on Bold
Strikeout! 13 Turns on Strikeout
Underline! 14 Turns on Underline
SmallCaps! 15 Turns on Small Caps

Example

To turn on Shadow, Bold, and Small Caps, the command is:

AttributeAppearanceOn(Shadow!;Bold!;SmallCaps!)

See Also

AttributeAppearanceToggle

AttributeAppearanceToggle toggles a font attribute on or off, usually the attributes of blocked text. This command is the equivalent of choosing Font and selecting an attribute.

Syntax

AttributeAppearanceToggle(Attribute)

Parameters

Attribute
Specifies the attribute(s) to toggle. AttributeAppearanceToggle requires at least one attribute parameter, but will accept as many attributes as you need to toggle. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Outline! 7 Toggles Outline
Italics! 8 Toggles Italics
Shadow! 9 Toggles Shadow
Redline! 10 Toggles Redline
DoubleUnderline! 11 Toggles DoubleUnderline
Bold! 12 Toggles Bold
Strikeout! 13 Toggles Strikeout
Underline! 14 Toggles Underline
SmallCaps! 15 Toggles Small Caps

Example

To toggle Italics and Redline, the command is:

AttributeAppearanceToggle(Italics!;Redline!)

See Also

AttributeNormal

AttributeNormal turns off all active font attributes, including size. Font attributes include bold, large, and redline, among others. This command does not reset font color changes. AttributeNormal is the equivalent of choosing Font, Normal.

Syntax

AttributeNormal

Parameters

None.

See Also

AttributePosition

AttributePosition positions text vertically in relation to text on the same line. This command is the equivalent of choosing Font, Size/Position, and selecting a position.

Syntax

AttributePosition(Position)

Parameters

Position
Specifies the vertical position of subsequent or blocked text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Superscript! 5 Superscript position
Subscript! 6 Subscript position
NormalPosition! 7 Normal position

Example

To set the position of subsequent or blocked text as superscript, the command is:

AttributePosition(Superscript!)

See Also

AttributePositionToggle

AttributePositionToggle toggles the specified text position. This command is not recordable. To use this command, you must type it into the macro.

Syntax

AttributePositionToggle(Position)

Parameters

Position
Specifies a position to toggle. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Superscript! 5 Toggles Superscript position
Subscript! 6 Toggles Subscript position
NormalPosition! 7 Toggles Normal position

Example

To toggle a subscript position, the command is:

AttributePositionToggle(Subscript!)

See Also

AttributeRelativeSize

AttributeRelativeSize specifies a font size for subsequent or blocked text. The size of the resulting font is relative to the currently selected font. This command is the equivalent of choosing Font, Size/Position, and selecting a size.

Syntax

AttributeRelativeSize(Size)

Parameters

Size
Specifies the relative size of subsequent or blocked text based on the currently selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ExtraLarge! 0 Relative Extra Large
VeryLarge! 1 Relative Very Large
Large! 2 Relative Large
Small! 3 Relative Small
Fine! 4 Relative Fine
NormalSize! 5 Relative Normal

Example

To select a font size of Large, the command is:

AttributeRelativeSize(Large!)

See Also

AttributeRelativeSizeToggle

AttributeRelativeSizeToggle toggles the specified relative font size. This command is not recordable. To use this command, you must type it into the macro.

Syntax

AttributeRelativeSizeToggle(Size)

Parameters

Size
Specifies a relative font size to toggle. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ExtraLarge! 0 Toggles relative Extra Large
VeryLarge! 1 Toggles relative Very Large
Large! 2 Toggles relative Large
Small! 3 Toggles relative Small
Fine! 4 Toggles relative Fine
NormalSize! 5 Toggles relative Normal

Example

To toggle the size of Fine, the command is:

AttributeRelativeSizeToggle(Fine!)

See Also

AttributeSizeRatios

AttributeSizeRatios changes the ratios used to determine the size of a relative font selected by AttributeRelativeSize. This command is the equivalent of choosing Font, Font, pressing Shift+F1, choosing Size Ratios, and specifying an attribute and a ratio.

Syntax

AttributeSizeRatios(Size;Ratio)

Parameters

Size
Specifies a relative font size to edit. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ExtraLarge! 0 Edits Extra Large
VeryLarge! 1 Edits Very Large
Large! 2 Edits Large
Small! 3 Edits Small
Fine! 4 Edits Fine
SuperSubscript! 5 Edits Superscript or Subscript
Ratio
A numeric expression specifying the ratio of an edited size. Ratio specifies the relative size of a font selected by AttributeRelativeSize.

Example

To specify a ratio of 130 for the attribute Large, the command is:

AttributeSizeRatios(Large!;130)

See Also

AutoCodePlacement

AutoCodePlacement determines whether Auto Code Placement is on or off. This command is the equivalent of choosing File, Setup, Environment, Auto Code Placement.

Syntax

AutoCodePlacement(State)

Parameters

State
Specifies whether Auto Code Placement is on or off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Auto Code Placement is off
On! 1 Auto Code Placement is on

Example

To turn off Auto Code Placement, the command is:

AutoCodePlacement(Off!)

BackTab

BackTab moves the cursor one tab stop left of the cursor position. This command is the equivalent of pressing Margin Release (Shift+Tab) or choosing Layout, Alignment, Back Tab.

Syntax

BackTab

Parameters

None.

See Also

Backup

Backup specifies whether Timed Document Backup is on or off. This command is the equivalent of choosing File, Setup, Environment, Backup Options, Timed Document Backup.

Syntax

Backup(State)

Parameters

State
Specifies whether Backup is on or off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Backup is off
On! 1 Backup is on

Example

To turn off Backup, the command is:

Backup(Off!)

See Also

BackupDlg

BackupDlg displays the Backup dialog box to set options for Timed Document Backup, Minutes Between Backups, and Original Document Backup. This command is the equivalent of choosing File, Setup, Environment, Backup Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BackupDlg

Parameters

None.

See Also

BackupMinutes

BackupMinutes specifies the number of minutes between each Timed Backup. This command is the equivalent of choosing File, Setup, Environment, Backup Options, and entering a number in the Minutes Between Backups text box.

Syntax

BackupMinutes(Minutes)

Parameters

Minutes
A numeric expression specifying the number of minutes between backups.

Example

To set a timed backup interval of fifteen minutes, the command is:

BackupMinutes(15)

See Also

BackupOriginalDoc

BackupOriginalDoc specifies whether Original Document Backup is on or off. This command is the equivalent of choosing File, Setup, Environment, Backup Options, and selecting Back Up Original Document (.BK!) on Save or Exit.

Syntax

BackupOriginalDoc(State)

Parameters

State
Specifies whether Original Document Backup is on or off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Original Document Backup off
Yes! 1 Original Document Backup on

Example

To turn on Original Document Backup, the command is:

BackupOriginalDoc(On!)

See Also

BarcodeDlg

BarcodeDlg displays the POSTNET® Bar Code dialog box. This command is the equivalent of choosing Layout, Other, Bar Code.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BarcodeDlg

Parameters

None.

See Also

BarcodePOSTNET

BarcodePOSTNET specifies a ZIP Code or a merge field containing a ZIP Code. This command is the equivalent of choosing Layout, Other, Bar Code, and entering the bar code contents. When specifying a merge field containing a ZIP code, this command is the equivalent of choosing Tools, Merge, Define, (if no merge document type is selected choose a document type, OK), Merge Codes, POSTNET, Select, OK, positioning the cursor between the parentheses following the POSTNET merge code, Tools, Merge, Define, Fields, and specifying a field name or number.

Syntax

BarcodePOSTNET(ZIP Code;Merge Field)

Parameters

ZIP Code
A numeric expression specifying a five, nine or eleven-digit ZIP Code. If the ZIP Code is contained in a merge field, this parameter can be a character expression specifying the merge field to use.
Merge Field (optional)
Specifies whether a merge field is used to provide the ZIP Code. This parameter is necessary only when a merge field has been specified in the ZIP Code parameter.
Enumerated Type Numeric Equivalent Description
MergeFieldAllowed! 1 Merge field provides ZIP Code

Example

To enter a ZIP Code contained in a merge field named Zip, the command is:

BarcodePOSTNET("Zip";MergeFieldAllowed!)

See Also

BaselinePlacement

BaselinePlacement determines whether Baseline Placement for Typesetters is on or off for the current document. This command is the equivalent of choosing Layout, Document, Baseline Placement for Typesetters.

Syntax

BaselinePlacement(State)

Parameters

State
Determines whether Baseline Placement is on for the current document. Select an enumerated type its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Baseline Placement is off
On! 1 Baseline Placement is on

Example

To turn on Baseline Placement, the command is:

BaselinePlacement(On!)

See Also

BaselinePlacementSetup

BaselinePlacementSetup determines whether Baseline Placement for Typesetters is on for all documents. The BaselinePlacementSetup command is the equivalent of choosing File, Print/Fax, Setup, Baseline Placement for Typesetters.

Syntax

BaselinePlacementSetup(State)

Parameters

State
Determines whether Baseline Placement is on for all documents. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Baseline Placement is off
On! 1 Baseline Placement is on

Example

To turn on the Baseline Placement option for all documents, the command is:

BaselinePlacementSetup(On!)

See Also

BeepOnError

BeepOnError determines whether a beep sounds when an error occurs. This command is the equivalent of choosing File, Setup, Environment, Beep Options, Beep on Error.

Syntax

BeepOnError(State)

Parameters

State
Determines whether a beep sounds when an error occurs. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No beep when an error occurs
Yes! 1 Beep sounds when an error occurs

Example

To sound a beep when an error occurs, the command is:

BeepOnError(Yes!)

See Also

BeepOnHyphenation

BeepOnHyphenation determines whether a beep prompts you to position the hyphen to break a word at the end of a line. This command is the equivalent of choosing File, Setup, Environment, Beep Options, Beep on Hyphenation.

Syntax

BeepOnHyphenation(State)

Parameters

State
Determines whether a beep prompts you to position the hyphen to break a word at the end of a line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No beep on hyphenation
Yes! 1 Beep sounds on hyphenation

Example

To turn off the hyphenation beep, the command is:

BeepOnHyphenation(No!)

See Also

BeepOnSearchFailure

BeepOnSearchFailure determines whether a beep sounds when a search fails. This command is the equivalent of choosing File, Setup, Environment, Beep Options, Beep on Search Failure.

Syntax

BeepOnSearchFailure(State)

Parameters

State
Determines whether a beep sounds when a search fails. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No beep when a search fails
Yes! 1 Beep when a search fails

Example

To sound a beep when a search fails, the command is:

BeepOnSearchFailure(Yes!)

See Also

BeepOptionsDlg

BeepOptionsDlg displays the Beep Options dialog box. This command is the equivalent of choosing File, Setup, Environment, Beep Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BeepOptionsDlg

Parameters

None.

See Also

Binding

Binding specifies the binding offset and the edge of the paper to which that offset should be applied. The offset will be added to the margin of the specified edge. This command is the equivalent of choosing Layout, Other, Printer Functions, Binding Offset, selecting binding options, and specifying a measurement.

Syntax

Binding(Edge;Offset)

Parameters

Edge
This parameter specifies a binding edge. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LeftEdge! 0 Binding on left edge
RightEdge! 1 Binding on right edge
TopEdge! 2 Binding on top edge
BottomEdge! 3 Binding on bottom edge
Offset
A measurement expression specifying the Binding Offset. The measurement you provide in this parameter will be added to the margin of the edge specified in the Edge parameter.

Example

To set a binding offset of .75" at the top of a document, the command is:

Binding(TopEdge!;.75")

BlockDelete

BlockDelete deletes blocked text. This command is the equivalent of pressing Ctrl+F4 and choosing Delete from the Move Block dialog box.

Syntax

BlockDelete

Parameters

None.

BlockKey

BlockKey is the equivalent of pressing Alt+F4. BlockKey executes whatever Alt+F4 is designed to do in the state the program is in when the macro encounters this command. If Alt+F4 has been remapped in Keyboard Layout, this command executes the original function of Alt+F4. This command is not recordable. To use this command, you must type it into the macro.

Syntax

BlockKey

Parameters

None.

See Also

BlockOff

BlockOff turns off Block. When Block is on, this command is the equivalent of choosing Edit, Block.

Syntax

BlockOff

Parameters

None.

See Also

BlockOn

BlockOn turns on Block and is the equivalent of choosing Edit, then choosing either Block (which automatically selects character mode) or Select (which presents other block mode options).

Syntax

BlockOn(Mode)

Parameters

Mode
Specifies the block mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CharMode! 1 Blocks a character at a time
WordMode! 2 Blocks a word at a time
SentenceMode! 4 Blocks a sentence at a time
ParagraphMode! 8 Blocks a paragraph at a time
PageMode! 16 Blocks a page at a time
RectangleMode! 32 Blocks a rectangle
TabularColumnsMode! 64 Blocks tabular columns
DocMode! 128 Blocks the document

Example

To block an entire page, the command is:

BlockOn(PageMode!)

See Also

BlockProtect

BlockProtect turns Block Protect on or off. This command is the equivalent of choosing Layout, Other, Block Protect.

Syntax

BlockProtect(State)

Parameters

State
Determines whether Block Protect is on. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Block Protect off
On! 1 Block Protect on

Example

To turn on Block Protect, the command is:

BlockProtect(On!)

BlockRectangle

BlockRectangle blocks a rectangular section of text. When Block is on, this command is the equivalent of choosing Edit, Select, Rectangle.

Syntax

BlockRectangle

Parameters

None.

BlockSave

BlockSave names and saves blocked text with a filename you specify. If the filename you specify already exists, Corel WordPerfect will replace the file without prompting you. You cannot append the block to another document using this command. With text blocked, this command is the equivalent of choosing File, Save, and entering a filename.

Syntax

BlockSave(Filename)

Parameters

Filename
A character expression specifying the filename of blocked text.

Example

To name and save blocked text with the filename BLOCK.DOC, the command is:

BlockSave("BLOCK.DOC")

See Also

BlockTabularColumn

BlockTabularColumn blocks a tabular column. With Block on, this command is the equivalent of choosing Edit, Select, Tabular Column.

Syntax

BlockTabularColumn

Parameters

None.

BoldKey

BoldKey is the equivalent of pressing F6. BoldKey will execute whatever F6 is designed to do in the state the program is in when the macro encounters this command. If F6 has been remapped in Keyboard Layout, this command will execute the original function of F6.

Syntax

BoldKey

Parameters

None.

BookmarkBlock

BookmarkBlock activates the Find and Block bookmark feature which finds a bookmark and blocks the assigned text. This command is the equivalent of displaying the Mark dialog box by pressing Alt+F5, Bookmark, selecting a bookmark, and choosing Find and Block.

Syntax

BookmarkBlock(Name)

Parameters

Name
A character expression specifying the name of a bookmark to find. The bookmark must have already been assigned to blocked text.

Example

To find a bookmark named Block This and to block the corresponding text, the command is:

BookmarkBlock("Block This")

See Also

BookmarkCreate

BookmarkCreate creates a Bookmark. This command is the equivalent of pressing Alt+F5, Bookmark, Create, and entering a name.

Syntax

BookmarkCreate(Name)

Parameters

Name
A character expression specifying the name of a Bookmark to create.

Example

To create a Bookmark named Find Me, the command is:

BookmarkCreate("Find Me")

See Also

BookmarkDelete

BookmarkDelete deletes a bookmark. This command is the equivalent of displaying the Mark dialog box by pressing Alt+F5, Bookmark, selecting a bookmark, Delete.

Syntax

BookmarkDelete(Name)

Parameters

Name
A character expression specifying the name of a bookmark to delete.

Example

To delete a bookmark named Last Page, the command is:

BookmarkDelete("Last Page")

See Also

BookmarkDlg

BookmarkDlg displays the Bookmark dialog box. This command is the equivalent of choosing Edit, Bookmark.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BookmarkDlg

Parameters

None.

See Also

BookmarkFind

BookmarkFind moves the cursor to a specified bookmark. This command is the equivalent of pressing Alt+F5, Bookmark, selecting a bookmark, Find.

Syntax

BookmarkFind(Name)

Parameters

Name
A character expression specifying the name of a bookmark to find.

Example

To find a bookmark named Entry, the command is:

BookmarkFind("Entry")

See Also

BookmarkMove

BookmarkMove moves a bookmark from its current location in your document to the cursor. This command is the equivalent of pressing Alt+F5, Bookmark, selecting a bookmark, Move.

Syntax

BookmarkMove(Name)

Parameters

Name
A character expression specifying a bookmark to move to the cursor position.

Example

To move a bookmark named Read This, the command is:

BookmarkMove("Read This")

See Also

BookmarkRename

BookmarkRename renames a bookmark. This command is the equivalent of pressing Alt+F5, Bookmark, selecting a bookmark, Rename, and entering a new name. You will receive an error if you type in the name of a bookmark that already exists in the current document.

Syntax

BookmarkRename(Current Name;New Name)

Parameters

Current Name
A character expression specifying the name of a bookmark to rename.
New Name
A character expression specifying the new name of a bookmark.

Example

To rename a bookmark named Edit as Copy, the command is:

BookmarkRename("Edit";"Copy")

See Also

BorderBottomLine

BorderBottomLine specifies the style of a bottom border line. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting border type, Customize, Lines, Bottom Line, and selecting a line style.

Syntax

BorderBottomLine(Type)

Parameters

Type
Specifies border bottom line style. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single
DoubleLine! 1 Double
DashedLine! 2 Dashed
DottedLine! 3 Dotted
ThickLine! 4 Thick
ExtraThickLine! 5 Extra thick
ThinThickLine! 6 Thick outside, thin inside
ThickThinLine! 7 Thin outside, thick inside
ButtonTopLeftLine! 8 Button shaded top and left
ButtonBottomRightLine! 9 Button shaded bottom and right
NoLine! 127 None

Example

To create a paragraph border with a double bottom border line, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderBottomLine(DoubleLine!)
TextBorderEnd(Save!)

See Also

BorderColor

BorderColor specifies the color of a Paragraph, Page, or Column border. All parameters for this command are optional. If you do not fill in a particular parameter, the current program setting for that aspect of the feature will be used when the macro executes. This command must be used in conjunction with other commands, such as TextBorderCreate, TextBorderEnd, and BorderUseBorderColor. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Color, Choose One Color For All Lines, and selecting a color and shade.

Syntax

BorderColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)

Parameters

Color Name (optional)
A character expression specifying border color. Includes custom-made colors.
Red Value (optional)
A numeric expression specifying the amount of red in a selected color. Values range from 0 to 255 and are available in the Color Selection dialog box.
Green Value (optional)
A numeric expression representing the amount of green in the selected color. See the description of "Red Value" above.
Blue Value (optional)
A numeric expression representing the amount of blue in the selected color. See the description of "Red Value" above.
Shading Value (optional)
A numeric expression representing the shading percentage of the selected color. Values range from 0 to 100.

Example

To create a Magenta paragraph border, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderUseBorderColor(Yes!)
BorderColor("Magenta";255;0;255;100)
TextBorderEnd(Save!)

See Also

BorderCornerRadius

BorderCornerRadius customizes the curve of rounded corners. Higher measurements produce more rounded corners. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. To use this command with a text border, you must specify a page border. When used to alter a text border, this command is the equivalent of choosing Graphics, Borders, Page, Customize, Corners, Rounded, and specifying a Corner Radius. When used to alter a graphics box, this command is the equivalent of choosing Graphics, Graphics Boxes, Create, Edit Border/Fill, Corners, Rounded, and specifying a Corner Radius.

Syntax

BorderCornerRadius(Radius)

Parameters

Radius
A measurement expression specifying the curve of border corners. The default for rounded corners is .325".

Example

To create a paragraph border with very rounded corners, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderCornerRadius(.5")
TextBorderEnd(Save!)

See Also

BorderDropShadow

BorderDropShadow specifies the location, size, and color of a border shadow. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a type, Customize, Shadow, and selecting from the Shadow dialog box.

Syntax

BorderDropShadow(Location;Size;Color Name;Red Value;Green Value;Blue Value;Shading Value)

Parameters

Location
Specifies the location of a shadow. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoShadow! 0 None
UpperLeft! 1 Upper left
LowerLeft! 2 Lower left
LowerRight! 3 Lower right
UpperRight! 4 Upper right
Size (optional)
A measurement expression specifying the size of a shadow. The default shadow size is .125".
Color Name (optional)
A character expression specifying shadow color, including custom-made colors.
Red Value (optional)
A numeric expression representing the amount of red in a selected color. Values range from 0 to 255 and are available in the Color Selection dialog box.
Green Value (optional)
A numeric expression representing the amount of green in a selected color. See the description of "Red Value" above.
Blue Value (optional)
A numeric expression representing the amount of blue in a selected color. See the description of "Red Value" above.
Shading Value (optional)
A numeric expression representing the shading percentage of a selected color. Values range from 0 to 100.

Example

To create a blue shadow on the upper right corner of a paragraph border, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderDropShadow(UpperRight!;.125";"Blue";0;0;255;100)
TextBorderEnd(Save!)

See Also

BorderFillColor

BorderFillColor specifies the color of a border fill. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Border, selecting a border type, Customize, Fill, selecting a fill style, Foreground Color, selecting a color, Background Color, and selecting a color.

Syntax

BorderFillColor(Foreground Color Name;Red Value;Green Value;Blue Value;Shading Value;Background Color Name;Red Value;Green Value;Blue Value;Shading Value)

Parameters

The first five parameters specify foreground color and the last five specify background color. Select a background color only if you have already selected a fill pattern.

Color Name (Foreground/Background) (optional)
A character expression specifying border fill color, including custom-made colors.
Red Value (optional)
A numeric expression representing the amount of red in a selected color. Values range from 0 to 255 and are available in the Color Selection dialog box.
Green Value (optional)
A numeric expression representing the amount of green in a selected color. See the description of "Red Value" above.
Blue Value (optional)
A numeric expression representing the amount of blue in a selected color. See the description of "Red Value" above.
Shading Value (optional)
A numeric expression representing the shading percentage of a selected color. Values range from 0 to 100.

Example

To create a 40% shaded fill paragraph border with a red foreground, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderFillColor("Red";255;0;0;40)
TextBorderEnd(Save!)

See Also

BorderInsideSpacing

BorderInsideSpacing specifies spacing inside a border, much as margins specify spacing on a page. This option is not available with page borders. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting border type, Customize, Spacing, deselecting Automatic Spacing, Inside Spacing, and selecting and specifying spacing measurements.

Syntax

BorderInsideSpacing(Left;Right;Top;Bottom)

Parameters

Left (optional)
A measurement expression specifying spacing of a left inside border.
Right (optional)
A measurement expression specifying spacing of a right inside border.
Top (optional)
A measurement expression specifying spacing of a top inside border spacing.
Bottom (optional)
A measurement expression specifying spacing of a bottom inside border.

Example

To create inside spacing of .1" on the top and bottom of a paragraph border, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderInsideSpacing(;;.1";.1")
TextBorderEnd(Save!)

See Also

BorderLeftLine

BorderLeftLine specifies the left line style of a border. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Lines, Left Line, and selecting a line style.

Syntax

BorderLeftLine(Type)

Parameters

Type
Specifies left border line style. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined line style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single
DoubleLine! 1 Double
DashedLine! 2 Dashed
DottedLine! 3 Dotted
ThickLine! 4 Thick
ExtraThickLine! 5 Extra thick
ThinThickLine! 6 Thick outside, thin inside
ThickThinLine! 7 Thin outside, thick inside
ButtonTopLeftLine! 8 Button shaded top and left
ButtonBottomRightLine! 9 Button shaded bottom and right
TableDefaultLine! 126 Default. Used only in Table Edit mode.
NoLine! 127 None

Example

To create a thick left paragraph border line, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderLeftLine(ThickLine!)
TextBorderEnd(Save!)

See Also

BorderOutsideSpacing

BorderOutsideSpacing specifies spacing outside a border. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Spacing, Auto Spacing Off, Outside Spacing, and specifying a spacing measurement.

Syntax

BorderOutsideSpacing(Left;Right;Top;Bottom)

Parameters

Left (optional)
A measurement expression specifying left outside border spacing.
Right (optional)
A measurement expression specifying right outside border spacing.
Top (optional)
A measurement expression specifying top outside border spacing.
Bottom (optional)
A measurement expression specifying bottom outside border spacing.

Example

To create outside spacing of .2" on all sides of a border, the command is:

BorderOutsideSpacing(.2";.2";.2";.2")

See Also

BorderRightLine

BorderRightLine specifies the right line border style. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Lines, Right Line, and selecting a line style.

Syntax

BorderRightLine(Type)

Parameters

Type
Specifies right border line style. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined line style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single
DoubleLine! 1 Double
DashedLine! 2 Dashed
DottedLine! 3 Dotted
ThickLine! 4 Thick
ExtraThickLine! 5 Extra thick
ThinThickLine! 6 Thick outside, thin inside
ThickThinLine! 7 Thin outside, thick inside
ButtonTopLeftLine! 8 Button shaded top and left
ButtonBottomRightLine! 9 Button shaded bottom and right
TableDefaultLine! 126 Default. Used only in Table Edit mode.
NoLine! 127 None

Example

To create a Paragraph border with a dashed right line, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderRightLine(DashedLine!)
TextBorderEnd(Save!)

See Also

BorderSeparatorLine

BorderSeparatorLine specifies the separator line style in a paragraph or column border. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Lines, Separator Line, and selecting a line style.

Syntax

BorderSeparatorLine(Type)

Parameters

Type
Specifies the type of separator line a border contains. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined line style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single
DoubleLine! 1 Double
DashedLine! 2 Dashed
DottedLine! 3 Dotted
ThickLine! 4 Thick
ExtraThickLine! 5 Extra thick
ThinThickLine! 6 Thick outside, thin inside
ThickThinLine! 7 Thin outside, thick inside
ButtonTopLeftLine! 8 Button border on top left
ButtonBottomRightLine! 9 Button border on bottom right
TableDefaultLine! 126 Default. Used only in Table Edit mode.
NoLine! 127 None

Example

To create a double-line separator in a paragraph border, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderSeparatorLine(DoubleLine!)
TextBorderEnd(Save!)

See Also

BorderSetSpacing

BorderSetSpacing specifies whether or not the Automatic Spacing option is selected. If it is not selected, you can specify a border's inside and/or outside spacing. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border style, Customize, Spacing, Automatic Spacing.

Syntax

BorderSetSpacing(State)

Parameters

State
Specifies whether the Automatic Spacing option is selected. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Automatic Spacing selected
Yes! 1 Automatic Spacing not selected

Example

To specify that Automatic Spacing is selected, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderSetSpacing(No!)
TextBorderEnd(Save!)

See Also

BorderStyleCopy

BorderStyleCopy copies a specified style from one location to another. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a style, Copy, selecting a destination, and naming a style.

Syntax

BorderStyleCopy(Style Name;Current Location;Destination;New Name)

Parameters

Style Name
Specifies the name of a style to copy. To copy a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To copy a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SpacingOnly! 0 Spacing Only
SingleBorder! 1 Single Border
DoubleBorder! 2 Double Border
DashedBorder! 3 Dashed Border
DottedBorder! 4 Dotted Border
ThickBorder! 5 Thick Border
ExtraThickBorder! 6 Extra Thick Border
ThinThickBorder! 7 Thin Thick Border
ThickThinBorder! 8 Thick Thin Border
ThickTopBottomBorder! 9 Thick Top Bottom Border
ButtonBorder! 10 Button Border
ColumnBorderBetween! 11 Column Border (Between Only)
ColumnBorderAll! 12 Column Border (Outside and Between)
NoBorder! 127 No border
Current Location
Specifies location of a style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library
Destination
Specifies the destination of a style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library
New Name (optional)
A character expression renaming a style to copy. Select this parameter only when placing a second copy of the style in the same location (when the contents of Current Location and Destination are the same).

Example

To copy a style named MyStyle from the personal style library to the shared style library, the command is:

BorderStyleCopy("MyStyle";PersonalLibrary!;SharedLibrary!)

See Also

BorderStyleCreate

BorderStyleCreate names a new border style. This command is the equivalent of choosing Graphics, Borders, Styles, Create, and naming a style.

Syntax

BorderStyleCreate(Style Name;Location)

Parameters

Style Name
A character expression naming a new style.
Location (optional)
Specifies the location of the style to delete. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library

Example

To give a paragraph border style the name Highlight, the command sequence is:

BorderStyleCreate("Highlight")
TextBorderEnd(Save!)

See Also

BorderStyleDelete

BorderStyleDelete deletes a specified style in a current document, personal, or shared style library. This command is the equivalent of choosing Graphics, Borders, Styles, select a style, Delete.

Syntax

BorderStyleDelete(Style Name;Location)

Parameters

Style Name
Specifies the name of a style to delete. To delete a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To delete a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SpacingOnly! 0 Spacing Only
SingleBorder! 1 Single Border
DoubleBorder! 2 Double Border
DashedBorder! 3 Dashed Border
DottedBorder! 4 Dotted Border
ThickBorder! 5 Thick Border
ExtraThickBorder! 6 Extra Thick Border
ThinThickBorder! 7 Thin Thick Border
ThickThinBorder! 8 Thick Thin Border
ThickTopBottomBorder! 9 Thick Top Bottom Border
ButtonBorder! 10 Button Border
ColumnBorderBetween! 11 Column Border (Between Only)
ColumnBorderAll! 12 Column Border (Outside and Between)
NoBorder! 127 No Border
Location
Specifies the location of the style to delete. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library

Example

To delete a paragraph border style named Example in the current document, the command sequence is:

BorderStyleDelete("Example";CurrentDoc!)

See Also

BorderStyleDlg

BorderStyleDlg displays the Border Styles dialog box. This command is the equivalent of choosing Graphics, Borders, Styles.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BorderStyleDlg

Parameters

None.

BorderStyleEdit

BorderStyleEdit specifies a style to edit. It is usually followed by border modification commands such as BorderCornerRadius. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a style, Edit.

Syntax

BorderStyleEdit(Style Name;Location)

Parameters

Style Name
Specifies a style to edit. To edit a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To edit a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SpacingOnly! 0 Spacing Only
SingleBorder! 1 Single Border
DoubleBorder! 2 Double Border
DashedBorder! 3 Dashed Border
DottedBorder! 4 Dotted Border
ThickBorder! 5 Thick Border
ExtraThickBorder! 6 Extra Thick Border
ThinThickBorder! 7 Thin Thick Border
ThickThinBorder! 8 Thick Thin Border
ThickTopBottomBorder! 9 Thick Top Bottom Border
ButtonBorder! 10 Button Border
ColumnBorderBetween! 11 Column Border (Between Only)
ColumnBorderAll! 12 Column Border (Outside and Between)
NoBorder! 127 No Border
Location
Specifies the location of the style to delete. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library

Example

To edit the Thin Thick Border line style, the command is:

BorderStyleEdit(ThinThickBorder!)

See Also

BorderStyleEditDlg

BorderStyleEditDlg displays the Edit Border Style dialog box. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a style, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BorderStyleEditDlg

Parameters

None.

See Also

BorderStyleEnd

BorderStyleEnd indicates the end of editing or creating a border style and specifies whether to save or cancel the changes. This command is the equivalent of choosing OK or Cancel when closing the Edit Border Style or Create Border Style dialog box.

Syntax

BorderStyleEnd(State)

Parameters

State
Specifies whether the most recent changes made to a style should be saved or canceled. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancel changes
Save! 1 Save changes

Example

To save the changes made to a border style, the command is:

BorderStyleEnd(Save!)

See Also

BorderStyleName

BorderStyleName renames a border style. This command must be used in conjunction with commands such as BorderStyleEdit and BorderStyleEnd. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a user-defined style, Edit, Border Style Name, and entering a new name.

Syntax

BorderStyleName(Style Name)

Parameters

Style Name
A character expression specifying the name of a border to rename.

Example

To rename a border style from Nouveau to Traditional, the command sequence is:

BorderStyleEdit("Nouveau")
BorderStyleName("Traditional")
BorderStyleEnd(Save!)

BorderStyleRetrieve

BorderStyleRetrieve retrieves all border styles in a specified style library into the current document or a personal or shared style library. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a location, Retrieve, and naming a style library.

Syntax

BorderStyleRetrieve(Style Library;Location)

Parameters

Style Library
A character expression specifying a style library containing styles to retrieve. Specify both the filename and path of the library.
Location
Specifies where to place the retrieved styles. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library

Example

To retrieve styles contained in a style library named Format into a personal style library, the command is:

BorderStyleRetrieve("Format";PersonalLibrary!)

See Also

BorderStyleSave

BorderStyleSave saves a border style located in a current document or a personal or shared style library to a specified style library. Saving to an existing library deletes any styles it contains and replaces them with the new styles. This command is the equivalent of choosing Graphics, Borders, Styles, selecting a location, selecting a style, Save, and naming a style.

Syntax

BorderStyleSave(Style Library;Location)

Parameters

Style Library
A character expression specifying the name of the style library to which the styles should be saved. Specify both the filename and path of the library.
Location
Specifies the location of the styles to save. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal style library
SharedLibrary! 2 Shared style library

Example

To save all styles from the Shared Style Library to a style library named Designs, the command is:

BorderStyleSave("Designs";SharedLibrary!)

See Also

BorderTopLine

BorderTopLine specifies the top line style of a border. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Lines, Top Line, and selecting a line style.

Syntax

BorderTopLine(Type)

Parameters

Type
Specifies a top border line style. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single
DoubleLine! 1 Double
DashedLine! 2 Dashed
DottedLine! 3 Dotted
ThickLine! 4 Thick
ExtraThickLine! 5 Extra thick
ThinThickLine! 6 Thick outside, thin inside
ThickThinLine! 7 Thin outside, thick inside
ButtonTopLeftLine! 8 Button shaded top and left
ButtonBottomRightLine! 9 Button shaded bottom and right lines
TableDefaultLine! 126 Default. Used only in Table Edit mode.
NoLine! 127 None

Example

To create a paragraph border with an extra thick top line, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderTopLine(ExtraThickLine!)
TextBorderEnd(Save!)

See Also

BorderUseBorderColor

BorderUseBorderColor specifies whether the border color option is for the current border, and is used with BorderStyleCreate or BorderStyleEdit, and with BorderColor. This command is the equivalent of choosing Graphics, Borders, selecting a border type, Customize, Color, Choose One Color For All Lines.

Syntax

BorderUseBorderColor(State)

Parameters

State
Specifies whether to use the border color option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Color not used
Yes! 1 Color used

Example

To use the color border option for the current paragraph border, the command sequence is:

TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderUseBorderColor(Yes!)
BorderColor("Magenta";255;0;255;100)
TextBorderEnd(Save!)

See Also

BoxAttachTo

BoxAttachTo attaches a graphics box to a page, paragraph, or character. When a box is attached to a location, BoxHorizontalPosition and BoxVerticalPosition specify horizontal and vertical positions. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Attach To, and selecting a position.

Syntax

BoxAttachTo(Location)

Parameters

Location
Specifies where a box is attached. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Page! 2 Attach to page
Paragraph! 3 Attach to paragraph
Character! 64 Attach to character

Example

To attach a graphics box to a character, the command sequence is:

BoxCreate(FigureBox!)
BoxAttachTo(Character!)
BoxEnd(Save!)

See Also

BoxAutoPosition

BoxAutoPosition specifies whether to position a box created based on the style specified in BoxStyleCreate vertically according to the position of the cursor when the box is created. This command is the equivalent of choosing Graphics, Graphics Boxes, Style, Edit, Edit Position, Position Box At Cursor When Created. This command must be used in combination with BoxStyleCreate or BoxStyleEdit and BoxEnd.

Syntax

BoxAutoPosition(State)

Parameters

State
Specifies whether to position a graphics box vertically at the cursor or not when the box is created. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not position vertically at cursor
Yes! 1 Position vertically at cursor

Example

To position a box based on the specified style vertically in relation to the cursor position, the command is:

BoxStyleCreate("Test")
BoxAutoPosition(Yes!)
BoxStyleEnd(Save!)

See Also

BoxBorderDlg

BoxBorderDlg displays the Edit Graphics Box Border/Fill dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Border/Fill.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxBorderDlg

Parameters

None.

BoxBorderStyle

BoxBorderStyle specifies a border style for a current graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Border/Fill, Based on Border Style, and selecting style.

Syntax

BoxBorderStyle(Style Name)

Parameters

Style Name
Specifies the border style of a graphics box. To specify a Corel WordPerfect sytle, select an enumerated type or its numeric equivalent. To specify a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SpacingOnly! 0 Spacing
SingleBorder! 1 Single
DoubleBorder! 2 Double
DashedBorder! 3 Dashed
DottedBorder! 4 Dotted
ThickBorder! 5 Thick
ExtraThickBorder! 6 Extra thick
ThinThickBorder! 7 Thick outside, thin inside
ThickThinBorder! 8 Thin outside, thick inside
ThickTopBottomBorder! 9 Thick top, bottom
ButtonBorder! 10 Shaded button
ColumnBorderBetween! 11 Border between columns
ColumnBorderAll! 12 Border around and between columns
NoBorder! 127 None

Example

To select Extra Thick lines as the border style for a figure box, the command sequence is:

BoxCreate(FigureBox!)
BoxBorderStyle(ExtraThickBorder!)
BoxEnd(Save!)

See Also

BoxCaptionEdit

BoxCaptionEdit opens a box caption. Because this command has no parameters, it is always followed by commands that furnish caption text such as the Type command. BoxCaptionEdit is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Create or Edit Caption, and entering a caption.

Syntax

BoxCaptionEdit

Parameters

None.

Example

This command has no parameters, but is used with other commands to create or edit caption contents:

BoxCaptionEdit
Type("Brad's Ferrari")
SubstructureExit

See Also

BoxCaptionInitialStyle

BoxCaptionInitialStyle specifies an initial style for a box caption. This command must be used in conjunction with other commands, such as BoxStyleCreate and BoxStyleEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Create or Edit, Options, Caption Options, Caption Text Style, Initial Style, highlighting a style, Select.

Syntax

BoxCaptionInitialStyle(Style)

Parameters

Style
Specifies the initial style for a box caption. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To specify Comment Style as the caption initial style, the command sequence is:

BoxStyleCreate("Test")
BoxCaptionInitialStyle(CommentStyle!)
BoxStyleEnd(Save!)

See Also

BoxCaptionNumberStyle

BoxCaptionNumberStyle specifies a numbering style for box caption. This command must be used in conjunction with other commands, such as BoxStyleCreate and BoxStyleEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Create or Edit, Options, Caption Options, Caption Text Style, Number Style, selecting style, Select.

Syntax

BoxCaptionNumberStyle(Number Style)

Parameters

Number Style
Specifies a number style for a box caption. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To specify Bullet Style as the caption numbering style, the command sequence is:

BoxStyleCreate("Test")
BoxCaptionNumberStyle(BulletStyle!)
BoxStyleEnd(Save!)

See Also

BoxCaptionOptionsDlg

BoxCaptionOptionsDlg opens the Caption Options dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Captions Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxCaptionOptionsDlg

Parameters

None.

BoxCaptionPosition

BoxCaptionPosition customizes the location of a graphics box caption. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Caption Options, and selecting options from the Caption Position group box.

Syntax

BoxCaptionPosition(Side of Box;Relation To Border;Position;Offset)

Parameters

Side Of Box
Specifies the side of the box where the caption is located. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Left side
Top! 1 Top
Right! 3 Right side
Bottom! 4 Bottom
Relation To Border
Specifies a caption's location relative to the border. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OutsideBorder! 0 Outside of border
InsideBorder! 1 Inside of border
OnBorder! 2 On the border
Position (optional)
Specifies the position of a caption. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Position left
Top! 1 Position top
Center! 2 Position center
Right! 3 Position right
Bottom! 4 Position bottom
Offset (optional)
A numeric expression or a measurement expression specifying the position offset. For a measurement expression, indicate a unit of measure (for example, 0.5"). A position number indicates a right offset, and a negative number indicates a left offset.

Example

To position a caption within the top border of a graphics box, the command sequence is:

BoxCreate(FigureBox!)
BoxCaptionPosition(Top!;InsideBorder!;;;)
BoxEnd(Save!)

BoxCaptionRotation

BoxCaptionRotation rotates graphics box captions. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Caption Options, Rotation, selecting the degree of rotation.

Syntax

BoxCaptionRotation(Rotation)

Parameters

Rotation
Specifies the rotation degree of a graphics box caption. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No rotation
Degrees90! 1 90 degrees
Degrees180! 2 180 degrees
Degrees270! 3 270 degrees

Example

To rotate a caption 90 degrees, the command sequence is:

BoxCreate(FigureBox!)
BoxCaptionRotation(Degrees90!)
BoxEnd(Save!)

See Also

BoxCaptionWidth

BoxCaptionWidth specifies the width of a graphics box caption as a current unit of measure (inches, points, etc.), a percentage, or based on the length of a caption. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Caption Options, Caption Width, and selecting an option.

Syntax

BoxCaptionWidth(Width)

Parameters

Width
Specifies the width of a graphics box caption. To have Corel WordPerfect automatically set the width based on the length of the caption, select the enumerated type or its numeric equivalent. To base the width on a current unit of measure, use a measurement expression. To base the width on a percentage of the box width, use a numeric expression.
Enumerated Type Numeric Equivalent Description
AutoWidth! 2 Use auto width

Example

To specify a caption width of 1", the command sequence is:

BoxCreate(FigureBox!)
BoxCaptionWidth(1")
BoxEnd(Save!)

See Also

BoxChangeLineHeight

BoxChangeLineHeight specifies whether attaching a graphics box to a character position will change the text line height. The default changes the height. When a box is attached to a character position, this command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Position, selecting and specifying options.

Syntax

BoxChangeLineHeight(State)

Parameters

State
Specifies whether the graphics box will change the text line height when attached to a character position. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not change line height
Yes! 1 Change line height

Example

To prevent the graphics box from changing the text line height, the command sequence is:

BoxCreate(FigureBox!)
BoxAttachTo(Character!)
BoxVerticalAlignment(Bottom!)
BoxChangeLineHeight(No!)
BoxEnd(Save!)

See Also

BoxChangeStyle

BoxChangeStyle changes the style of a graphics box when creating or editing a box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Based on Box Style, selecting style.

Syntax

BoxChangeStyle(Style Name)

Parameters

Style Name
Specifies the box style to change. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Figure Box style
TableBox! 1 Table Box style
TextBox! 2 Text Box style
UserBox! 3 User Box style
EquationBox! 4 Equation Box style
ButtonBox! 5 Button Box style
WatermarkImageBox! 6 Watermark Image Box style
InlineEquationBox! 7 Inline Equation Box style
NoBox! 127 No Box

Example

To change a box style from graphics to text, the command sequence is:

BoxCreate(FigureBox!)
BoxChangeStyle(TextBox!)
BoxEnd(Save!)

See Also

BoxCharPositionDlg

BoxCharPositionDlg displays the Character Box Position dialog box. After attaching a box to a character position, this command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Position.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxCharPositionDlg

Parameters

None.

BoxContentEdit

BoxContentEdit initiates the creation and/or editing of box contents. After specifying the contents of the box, this command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, selecting Create Text or Select Box to Edit, and entering text.

Syntax

BoxContentEdit

Parameters

None.

Example

This command has no parameters and is used with other commands to create or edit box contents:

BoxContentEdit
Type("Example Box")
SubstructureExit

See Also

BoxContentOptionsDlg

BoxContentOptionsDlg displays the Content Options dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Content Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxContentOptionsDlg

Parameters

None.

BoxContentPosition

BoxContentPosition positions the contents of a graphics box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Content Options, and selecting options.

Syntax

BoxContentPosition(Horizontal;Vertical)

Parameters

Horizontal
Specifies the horizontal position of box contents. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Position left
Center! 2 Position center
Right! 3 Position right
Vertical
Specifies the vertical position of box contents. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Top! 1 Position top
Center! 2 Position center
Bottom! 4 Position bottom

Example

To position contents at the left and bottom of a box, the command sequence is:

BoxCreate(FigureBox!)
BoxContentPosition(Left!;Bottom!)
BoxEnd(Save!)

See Also

BoxContentPreserveAspectRatio

BoxContentPreserveAspectRatio specifies whether to preserve the width/height ratio when the position of box contents changes. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Options, Content Options, Preserve Image Width/Height Ratio.

Syntax

BoxContentPreserveAspectRatio(State)

Parameters

State
Specifies whether to preserve the image width/height ratio when the size of box contents changes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not preserve
Yes! 1 Preserve

Example

To preserve the image width/height ratio, the command sequence is:

BoxCreate(FigureBox!)
BoxContentPreserveAspectRatio(Yes!)
BoxEnd(Save!)

See Also

BoxContentType

BoxContentType specifies the content type of a graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Contents, and selecting an option.

Syntax

BoxContentType(Type Name)

Parameters

Type Name
Specifies the type of contents in a graphics box. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Text! 1 Text contents
LinkedText! 2 Linked text contents
Image! 3 Image contents
Equation! 4 Equation contents
Presentation! 5 Corel® Presentations™ contents
Video! 6 Video contents
Macro! 7 Macro contents
External! 8 External contents
Empty! 127 No contents

Example

To specify box contents as a graphics image, the command sequence is:

BoxCreate(FigureBox!)
BoxContentType(Image!)
BoxEnd(Save!)

See Also

BoxCounter

BoxCounter assigns a new counter type to a current graphics box or graphics box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, (Styles if editing a style), Create or Edit, (selecting style name, then choosing Edit if editing a style), Options, Caption Options, Caption Counter, highlighting counter type, Select.

Syntax

BoxCounter(Counter Type)

Parameters

Counter Type
Specifies the counter type of a current graphics box or graphics box style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No counter
FigureCounter! 1 Figure
TableBoxCounter! 2 Table Box
TextBoxCounter! 3 Text Box
UserBoxCounter! 4 User Box
EquationCounter! 5 Equation

Example

To assign a Text Box counter type to a graphics box or graphics box style, the command sequence is:

BoxCreate(FigureBox!)
BoxCounter(TextBoxCounter!)
BoxEnd(Save!)

See Also

BoxCreate

BoxCreate creates the specified graphics box. This command must be used with BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create, and selecting options.

Syntax

BoxCreate(Box Style)

Parameters

Box Style
Designates the type of box to create. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Create Figure Box
TableBox! 1 Create Table Box
TextBox! 2 Create Text Box
UserBox! 3 Create User Box
EquationBox! 4 Create Equation Box
ButtonBox! 5 Create Button Box
WatermarkImageBox! 6 Create Watermark Image Box
InlineEquationBox! 7 Create Inline Equation Box
NoBox! 127 Do not create box

Example

To create an Equation Box, the command sequence is:

BoxCreate(EquationBox!)
BoxEnd(Save!)

See Also

BoxCreateDlg

BoxCreateDlg displays the Create Graphics Box dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create. This command is not recordable. To use this command, you must type it into the macro.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxCreateDlg

Parameters

None.

See Also

BoxDelete

BoxDelete is recorded in Graphics or Page mode and executed in Text, Graphics, or Full Page mode. In Graphics or Page mode, this command is the equivalent of selecting a box with a mouse, Delete, Yes.

Syntax

BoxDelete(Box Number)

Parameters

Box Number
A numeric expression specifying the number of a box to delete.

Example

To delete Equation Box 3, the command sequence is:

BoxDelete(3)

See Also

BoxDlg

BoxDlg displays the Create Box dialog if preceded by the BoxCreate command and the Edit Box dialog if preceded by the BoxEdit command. This command must be followed by BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxDlg

Parameters

None.

BoxEdit

BoxEdit specifies a box number to edit. This command must be used in conjunction with box editing commands and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Edit, Document Box Number, specifying a box number, Edit Box.

Syntax

BoxEdit(Box Number)

Parameters

Box Number A numeric expression specifying a box number to edit.

Example

To edit graphics box 3 of a document, the command sequence is:

BoxEdit(3)
BoxEnd

See Also

BoxEditDlg

BoxEditDlg displays the Select Box To Edit dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxEditDlg

Parameters

None.

See Also

BoxEditByCounter

BoxEditByCounter specifies a box counter type and the number of the box to edit. This command must be used in conjunction with box editing commands and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Edit, Counter Number, and specifying counter and number.

Syntax

BoxEditByCounter(Counter;{Number})

Parameters

Counter
Specifies a box type to edit. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Edit by Figure Box counter
TableBoxCounter! 2 Edit by Table Box counter
TextBoxCounter! 3 Edit by Text Box counter
UserBoxCounter! 4 Edit by User Box counter
EquationCounter! 5 Edit by Equation Box counter
Number
A numeric expression specifying the number of a box type. If the edited counter has more than one level, specify each of the levels by repeating this parameter and separating the levels with a semicolon. All levels should be within one set of French braces.

Example

To edit text box 2.5 in a document, the command sequence is:

BoxEditByCounter(TextBoxCounter!;{2;5})
BoxEnd(Save!)

See Also

BoxEditNext

BoxEditNext edits the next occurrence of a box type. This command must be used in conjunction with box editing commands and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Edit, Next Box, Edit Box.

Syntax

BoxEditNext(Box Type)

Parameters

Box Type
Specifies a box type to edit. If a box type is not specified, the macro edits the box following the cursor, regardless of type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Edit next Figure Box
TableBox! 1 Edit next Table Box
TextBox! 2 Edit next Text Box
UserBox! 3 Edit next User Box
EquationBox! 4 Edit next Equation Box
ButtonBox! 5 Edit next Button Box
WatermarkImageBox! 6 Edit next Watermark Image Box
InlineEquationBox! 7 Edit next Inline Equation Box
NoBox! 127 Edit no box

Example

To edit the next occurrence of a user box, the command sequence is:

BoxEditNext(UserBox!)
BoxEnd(Save!)

See Also

BoxEditPrevious

BoxEditPrevious edits the previous occurrence of a box type. This command must be used in conjunction with box editing commands and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Edit, Previous Box.

Syntax

BoxEditPrevious(Box Type)

Parameters

Box Type
Specifies a box type to edit. If a box type is not specified, the macro edits the box immediately previous to the cursor, regardless of type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Edit previous Figure Box
TableBox! 1 Edit previous Table Box
TextBox! 2 Edit previous Text Box
UserBox! 3 Edit previous User Box
EquationBox! 4 Edit previous Equation Box
ButtonBox! 5 Edit previous Button Box
WatermarkImageBox! 6 Edit previous Watermark Image Box
InlineEquationBox! 7 Edit previous Inline Equation Box
NoBox! 127 Edit no box

Example

To edit the previous occurrence of a button box, the command sequence is:

BoxEditPrevious(ButtonBox!)
BoxEnd(Save!)

See Also

BoxEnd

BoxEnd saves or cancels changes made when creating or editing a graphics box. This command must be used in conjunction with box editing commands and BoxEdit or BoxCreate. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, creating or editing, OK or Cancel.

Syntax

BoxEnd(State)

Parameters

State
Specifies whether creating or editing changes to a graphics box are saved or canceled. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancel changes
Save! 1 Save changes

Example

To save changes made to graphics box number 1, the command sequence is:

BoxEdit(1)
BoxEnd(Save!)

See Also

BoxEquationDefaultFont

BoxEquationDefaultFont selects the default font and determines whether to change the default font size. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, selecting Equation Box or Inline Equation Box, Edit, Equation Settings, Initial Font, Size, and specifying a font size.

Syntax

BoxEquationDefaultFont(Size)

Parameters

Size
Determines whether an equation uses the document initial font and font size, or specifies a new size.

Example

To select the default font but specify a non-default font size of 14p, the command is:

BoxEquationDefaultFont(14p)

BoxEquationFilename

BoxEquationFilename specifies the name of an equation file. This command doesn't retrieve the file, it simply indicates to the program that the box contains an equation. To retrieve an equation file, use FileRetrieve. To record this command, specify the box contents as an Equation, then retrieve an equation file.

Syntax

BoxEquationFilename(Filename)

Parameters

Filename A character expression specifying the name of an equation file.

Example

To specify an equation filename STAT.DOC, the command is:

BoxEquationFilename("STAT.DOC")

See Also

BoxEquationFont

BoxEquationFont selects a graphics box font and font size. This command must be used between BoxStyleEdit and BoxEnd. This statement is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting Equation Box or Inline Equation Box, Edit, Equation Setting, Select Font, Font, selecting options, Size, and specifying a font size.

Syntax

BoxEquationFont(Name;Size)

Parameters

Name
A character expression specifying a font name.
Size
A numeric expression specifying a font size.

Example

To select 14p Helvetica, the command is:

BoxEquationFont("Helvetica";14p)

BoxEquationPositionToError

BoxEquationPositionToError positions the cursor at a syntax error in an equation created or displayed in the Equation Editor. Corel WordPerfect will insert this command if a recorded macro attempts to create an equation containing a syntax error, but the command is not necessary for the macro to execute successfully; Corel WordPerfect 6.2 will position the cursor at an error whether or not a macro contains this command.

Syntax

BoxEquationPositionToError

Parameters

None.

BoxEquationSave

BoxEquationSave names and saves an equation file. The file can then be used in the current graphics box or retrieved into other graphics boxes. In the Equation Editor, this command is the equivalent of choosing File, Save As, and entering a filename.

Syntax

BoxEquationSave(Filename)

Parameters

Filename A character expression specifying the name of the equation file.

Example

To save an equation named Formula, the command is:

BoxEquationSave("Formula")

See Also

BoxEquationSaveAsGraphic

BoxEquationSaveAsGraphic saves an equation in a graphics file format. In the Equation Editor, this command is the equivalent of choosing File, Save As Image, entering a filename, and selecting graphics format.

Syntax

BoxEquationSaveAsGraphic(Filename;Format)

Parameters

Filename
A character expression naming an equation box.
Format (optional)
Specifies the graphics format of an equation box. Select an enumerated type or its numeric equivalent. If a format is not specified, the equation is saved in the current graphics format.
Enumerated Type Numeric Equivalent Description
WordPerfectGraphic_10! 725 Corel WordPerfect Graphic 1.0 format
WordPerfectGraphic_20! 726 Corel WordPerfect Graphic 2.0 format
Bitmap! 730 Bitmap format
Presentations_20! 738 Corel Presentations 2.0 format

Example

To save an equation named Calculus in Corel Presentations 2.0 format, the command is:

BoxEquationSaveAsGraphic("Calculus";Presentations_20!)

See Also

BoxEquationSettingsDlg

BoxEquationSettingsDlg displays the Equation Settings dialog box containing font, color, and keyboard options. In the Equation Editor, this command is the equivalent of choosing File, Settings.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxEquationSettingsDlg

Parameters

None.

See Also

BoxExactPositionDlg

BoxExactPositionDlg displays the Fixed Page Position dialog box containing options for the horizontal and vertical position of a graphics box. This command must be preceded by BoxCreate or BoxEdit. While a graphics box is attached to Fixed Page Position, this command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Position.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxExactPositionDlg

Parameters

None.

See Also

BoxFillStyle

BoxFillStyle specifies a graphics box fill style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Border/Fill, Fill, Fill Style, and selecting a style.

Syntax

BoxFillStyle(Style Name)

Parameters

Style Name
Specifies a graphics box fill style. To specify a Corel WordPerfect fill style, select an enumerated type or its numeric equivalent. To specify a user-defined style, enclose the name in quotation marks.
Enumerated Type Numeric Equivalent Description
Fill10! 0 Fill 10% style
Fill20! 1 Fill 20% style
Fill30! 2 Fill 30% style
Fill40! 3 Fill 40% style
Fill50! 4 Fill 50% style
Fill60! 5 Fill 60% style
Fill70! 6 Fill 70% style
Fill80! 7 Fill 80% style
Fill90! 8 Fill 90% style
Fill100! 9 Fill 100% style
FillButton! 10 Fill Button style
NoFill! 127 No fill style

Example

To define a Corel WordPerfect fill style of 30%, the command sequence is:

BoxCreate(FigureBox!)
BoxFillStyle(Fill30!)
BoxEnd(Save!)

See Also

BoxHeight

BoxHeight sets box height based on the height of box contents or manually specified measurements. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Size, and selecting or specifying options.

Syntax

BoxHeight(Height)

Parameters

Height
Specifies a graphics box height. Select the enumerated type or its numeric equivalent to base box height on the height of its contents. Enter a numeric expression to set the height manually.
Enumerated Type Numeric Equivalent Description
AutoHeight! 2 Select auto height

Example

To set box height to 4", the command sequence is:

BoxCreate(FigureBox!)
BoxHeight(4")
BoxEnd(Save!)

See Also

BoxHorizontalAlignment

BoxHorizontalAlignment specifies the alignment of a graphics box attached to a page or paragraph. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Position, Horizontal position, choosing an option, Offset from Position, and choosing an option.

Syntax

BoxHorizontalAlignment(Alignment;Position;Offset;Left Column;Right Column)

Parameters

Alignment
Specifies where a graphics box should be horizontally aligned. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
AlignMargins! 1 Align to margins
AlignColumns! 2 Align to columns
Position
Specifies the horizontal position of a graphics box after having been aligned to margins or columns. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Left align
Center! 2 Center align
Right! 3 Right align
FullAlign! 7 Full align
Offset (optional)
A numeric expression specifying the left or right offset of a graphics box. The offset moves the image left or right of the alignment point; left offsets are negative numbers, right offsets are positive.
Left Column (optional)
A numeric expression specifying the left column when a box is aligned to columns.
Right Column (optional)
A numeric expression specifying the right column when a box is aligned to columns.

Example

To center a graphics box between two columns, the command sequence is:

BoxCreate(FigureBox!)
BoxHorizontalAlignment(AlignColumns!;Center!;0";1;2)
BoxEnd(Save!)

See Also

BoxHorizontalPosition

BoxHorizontalPosition specifies the horizontal position of a graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Position, Horizontal Position, Set, and entering a position.

Syntax

BoxHorizontalPosition(Position)

Parameters

Position
A measurement expression specifying the horizontal position of a graphics box.

Example

To position a graphics box 2" from the left edge of the page, the command sequence is:

BoxCreate(FigureBox!)
BoxHorizontalPosition(2.5")
BoxEnd(Save!)

See Also

BoxImageBlackWhiteThreshold

BoxImageBlackWhiteThreshold determines the threshold or point at which colors and/or grays in the current graphics image are converted to black and white. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Edit All, B/W Threshold.

Syntax

BoxImageBlackWhiteThreshold(Threshold)

Parameters

Threshold
A numeric expression specifying the threshold at which colors and/or grays are converted to either black or white. Colors or grays below the threshold are converted to black; those above the threshold are converted to white. Values range from 1 to 255, with 127 as the default.

Example

To set the threshold for converting colors and/or grays to black and white at 150, the command sequence is:

BoxCreate(FigureBox!)
BoxImageBlackWhiteThreshold(150)
BoxEnd(Save!)

See Also

BoxImageBrightness

BoxImageBrightness adjusts the brightness (saturation) of a color or black and white image. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor this command is the equivalent of choosing Edit, Color Adjust, Brightness.

Syntax

BoxImageBrightness(Brightness)

Parameters

Brightness
A numeric expression specifying the brightness of an image color. Values range from -1.0 (all black) to 1.0 (all white).

Example

To set the brightness of an image color to .5, the command sequence is:

BoxCreate(FigureBox!)
BoxImageBrightness(0.5)
BoxEnd(Save!)

See Also

BoxImageClipboardRetrieve

BoxImageClipboardRetrieve retrieves an image from the clipboard into the current document at the cursor position. In the Image Editor, this command is the equivalent of choosing File, Go to Shell, Clipboard, Retrieve.

Syntax

BoxImageClipboardRetrieve

Parameters

None.

See Also

BoxImageClipboardSave

BoxImageClipboardSave saves an image to the Clipboard. In the Image Editor, this command is the equivalent of choosing File, Go to Shell, Clipboard, Save to.

Syntax

BoxImageClipboardSave

Parameters

None.

See Also

BoxImageContrast

BoxImageContrast determines the contrast between light and dark areas of a graphic image. This command must be used in conjunction with other commands such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Color Adjust, Contrast.

Syntax

BoxImageContrast(Contrast)

Parameters

Contrast
A numeric expression specifying the contrast or sharpness of an image. Values range from -1.0 (slight contrast) to 1.0 (substantial contrast).

Example

To set the contrast of an image color to .7, the command sequence is:

BoxCreate(FigureBox!)
BoxImageContrast(.7)
BoxEnd(Save!)

See Also

BoxImageDitherMethod

BoxImageDitherMethod specifies both the method and source of dithering. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Print Parameters, Dither Method, and Dither Source.

Syntax

BoxImageDitherMethod(Method;Source)

Parameters

Method
Specifies dither method. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Halftoning! 1 Evenly spaced dots of variable diameter
OrderedDither! 2 Sort image pixels
ErrorDiffusionDither! 3 Random dot pattern
Default! 6 Default halftoning method
Source
Specifies dither source. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WordPerfect! 0 Corel WordPerfect as dither source
Printer! 1 Printing device as dither source
Default! 6 Default source
External! 8 Based on your printer, Corel WordPerfect will select either Corel WordPerfect or your printer as the dither source

Example

To specify Error Diffusion as the dither method and Corel WordPerfect as the source, the command sequence is:

BoxCreate(FigureBox!)
BoxImageDitherMethod(ErrorDiffusionDither!;WordPerfect!)
BoxEnd(Save!)

See Also

BoxImageFill

BoxImageFill specifies a graphics image fill type. In the Image Editor, this command is the equivalent of choosing Edit, Fill.

Syntax

BoxImageFill(Fill Type)

Parameters

Fill Type
Specifies an image fill type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Normal! 0 Image is in its normal state
Transparent! 1 Image is transparent so background (if one has been selected) shows through
White! 2 Image is white with black lines

Example

To set an image fill type to transparent, the command sequence is:

BoxCreate(FigureBox!)
BoxImageFill(Transparent!)
BoxEnd(Save!)

BoxImageFlipX

BoxImageFlipX determines whether an image is reversed on its X axis. For example, if an image faces right, this command causes it to face left. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Attributes, Flip Horizontal.

Syntax

BoxImageFlipX(State)

Parameters

State
Determines whether an image is reversed on its horizontal axis. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not reverse image
Yes! 1 Reverse image

Example

To reverse an image on its horizontal axis, the command sequence is:

BoxCreate(FigureBox!)
BoxImageFlipX(Yes!)
BoxEnd(Save!)

See Also

BoxImageFlipY

BoxImageFlipY determines whether to reverse an image on its Y axis. In other words, this command turns an image upside down. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Attributes, Flip Vertical.

Syntax

BoxImageFlipY(State)

Parameters

State
Determines whether the image is reversed on its vertical axis. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not reverse image
Yes! 1 Reverse image

Example

To reverse an image on its vertical axis, the command sequence is:

BoxCreate(FigureBox!)
BoxImageFlipY(Yes!)
BoxEnd(Save!)

See Also

BoxImageHalftoneOptions

BoxImageHalftoneOptions sets predefined halftone values from the .PRS file of the currently selected printer, or allows user-defined values. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, choose Edit, Print Parameters, Halftone Options.

Syntax

BoxImageHalftoneOptions(Source;LPI;Halftone Angle)

Parameters

Source
Specifies whether source of halftone options is the .PRS file or user-defined. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DefaultValues! 0 Default values from .PRS file
SetValues! 1 User-defined values
LPI (optional) A numeric expression specifying the LPI.
Halftone Angle (optional) A numeric expression specifying the halftone angle.

Example

To specify that an image use the default halftone options defined in the .PRS file, the command sequence is:

BoxCreate(FigureBox!)
BoxImageHalftoneOptions(Default!;;)
BoxEnd(Save!)

See Also

BoxImageInvertColors

BoxImageInvertColors determines whether the current colors of an image are inverted to their respective complementary colors. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Attributes, Invert Color.

Syntax

BoxImageInvertColors(State)

Parameters

State
Determines whether image colors are inverted. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not invert colors
Yes! 1 Invert colors

Example

To invert the colors of the current image, the command sequence is:

BoxCreate(FigureBox!)
BoxImageInvertColors(Yes!)
BoxEnd(Save!)

See Also

BoxImageMonochrome

BoxImageMonochrome converts a color image to black and white. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Attributes, Black and White.

Syntax

BoxImageMonochrome(State)

Parameters

State
Determines whether a color image is converted to black and white. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Not converted
Yes! 1 Converted

Example

To convert a color image to black and white, the command sequence is:

BoxCreate(FigureBox!)
BoxImageMonochrome(Yes!)
BoxEnd(Save!)

See Also

BoxImageMove

BoxImageMove moves an image within a graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Edit All, Position, Horizontal, Vertical.

Syntax

BoxImageMove(X Position;Y Position)

Parameters

X Position
A numeric expression specifying the horizontal position of an image within a box. Values range from -5.0 to 5.0, with 0.0 being the default.
Y Position
A numeric expression specifying the vertical position of an image within a box. Values range from -5.0 to 5.0, with 0.0 centering the image.

Example

To move an image slightly up and to the right within a graphics box, the command sequence is:

BoxEdit(2)
BoxImageMove(0.2;0.2)
BoxEnd(Save!)

See Also

BoxImagePresentations

BoxImagePresentations loads Corel Presentations for the purpose of editing a graphics image. This command will only execute properly if the directory containing PR.EXE has been added to the PATH command in your AUTOEXEC.BAT file. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Contents, Image or Image on Disk, Image Editor, File, Corel Presentations.

Syntax

BoxImagePresentations

Parameters

None.

See Also

BoxImageRetrieve

BoxImageRetrieve retrieves a specified image from a specific location. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Contents, selecting either Image or Image on Disk, Filename, and specifying a filename.

Syntax

BoxImageRetrieve(Image Location;Filename;Format)

Parameters

Image Location
Specifies the current location of an image. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LeaveExternal! 0 Use image on Disk
MakeInternal! 1 Standard retrieve
UseInternal! 2 Use existing image in document
Filename
A character expression specifying the filename of an image to retrieve.
Format (optional)
Specifies the format of the image to retrieve. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WordPerfectGraphic_10! 725 Corel WordPerfect 1.0 format
WordPerfectGraphic_20! 726 Corel WordPerfect 2.0 format
TaggedImageFileFormat! 727 Tagged Image File Format
PCPaintbrushX! 728 PC Paintbrush format.
WindowsMetaFile! 729 Microsoft® Windows® Metafile format.
Bitmap! 730 Bitmap format.
CMG! 731 Computer Graphics Metafile format.
AutoCAD_DXF! 732 AutoCAD® format. Requires additional graphics conversion disk.
EncapsulatedPostScript! 733 Encapsulated PostScript format.
HewlettPackardGraphic Plotter! 734 Hewlett-Packard® Graphics Language Plotter format.
Macintosh_PICT! 736 Macintosh® format.
MicroGraftx! 737 MicroGrafx® format. Requires additional graphics conversion disk.
Presentations_20! 738 Corel Presentations 2.0 format.
LotusPIC! 739 Lotus 1-2-3® .PIC format.
TarGA! 741 TarGA format. Requires additional graphics conversion disk.

Example

To retrieve an image named MOUNTAIN.WPG from the current document into another box created in the same document, the command sequence is:

BoxCreate(FigureBox!)
BoxImageRetrieve(UseInternal!;"MOUNTAIN.WPG")
BoxEnd(Save!)

See Also

BoxImageRotate

BoxImageRotate rotates a graphics image. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Edit All, Rotation, and specifying a degree measurement.

Syntax

BoxImageRotate(Degree)

Parameters

Degree
A numeric expression specifying a degree of rotation. Value ranges from 0.0 to 359.0.

Example

To rotate an image 90 degrees, the command sequence is:

BoxCreate(FigureBox!)
BoxImageRotate(90.0)
BoxEnd(Save!)

See Also

BoxImageSave

BoxImageSave saves an image either with its current name or with a new name. It can also specify the graphics format. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing File, Save As, and naming the file and selecting a format.

Syntax

BoxImageSave(Filename;Format)

Parameters

Filename
A character expression naming an image.
Format (optional)
Specifies a graphics format. If unspecified, the image will be saved in the currently selected graphics format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WordPerfectGraphic_10! 725 Corel WordPerfect 1.0 format
WordPerfectGraphic_20! 726 Corel WordPerfect 2.0 format
Bitmap! 730 Bitmap format
Presentations_20! 738 Corel Presentations 2.0 format

Example

To save an image named Fireworks in a Corel Presentations 2.0 format, the command sequence is:

BoxEdit(3)
BoxImageSave("Fireworks";Presentations_20!)
BoxEnd(Save!)

See Also

BoxImageScaling

BoxImageScaling scales an image within a graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Edit All, Position, Scale Width and/or Scale Height, and specifying the scale.

Syntax

BoxImageScaling(Width;Height)

Parameters

Width
A numeric expression specifying the width to which an image is scaled. Value ranges from 0.01 to 9.99, with 1.0 being the default.
Height
A numeric expression specifying the height to which an image is scaled. Value ranges from 0.01 to 9.99, with 1.0 being the default.

Example

To scale an image to a width of 1.5 and a height of 1.2, the command is:

BoxEdit(2)
BoxImageScaling(1.5;1.2)
BoxEnd(Save!)

See Also

BoxImageSettingsDlg

BoxImageSettingsDlg displays the Edit All dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Create, entering a style name, Contents, Image, Settings.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxImageSettingsDlg

Parameters

None.

BoxImageShowBackground

BoxImageShowBackground determines whether any background colors or gradients saved with the original image are visible. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. In the Image Editor, this command is the equivalent of choosing Edit, Attributes, Show Background.

Syntax

BoxImageShowBackground(State)

Parameters

State
Determines whether image backgrounds are visible. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Not visible
Yes! 1 Visible

Example

To show an image background, the command sequence is:

BoxCreate(FigureBox!)
BoxImageShowBackground(Yes!)
BoxEnd(Save!)

See Also

BoxInsertFullPageOn

BoxInsertFullPageOn indicates whether a full page graphics box should be inserted at the cursor position or on the next page. With a full page graphics box in your document, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, Edit Box, Edit Position, Insert Full Page Box on Following Page. This command must be used in combination with BoxCreate or BoxEdit, BoxStyleCreate or BoxStyleEdit and BoxEnd.

Syntax

BoxInsertFullPageOn(State)

Parameters

State
Specifies whether a full page graphics box is inserted at the cursor or on the next page. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Following Page! 0 Insert graphics box on following page
Current Page! 1 Insert graphics box on current page

Example

To show an image background, the command sequence is:

BoxCreate(FigureBox!)
BoxInsertFullPageOn(Current Page!)
BoxEnd(Save!)

See Also

BoxOverlap

BoxOverlap specifies whether a graphics box will be allowed to overlap other boxes. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After attaching a box to either a page or paragraph, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box, then choosing Allow Box to Overlap Other Boxes.

Syntax

BoxOverlap(State)

Parameters

State
Specifies whether the box is allowed to overlap other boxes. Use an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Overlap not allowed
Yes! 1 Overlap allowed

Example

To allow a graphics box to overlap other boxes, the command sequence is:

BoxCreate(FigureBox!)
BoxOverlap(Yes!)
BoxEnd(Save!)

See Also

BoxPagePositionDlg

BoxPagePositionDlg displays the Page Box Position dialog box. After attaching an image to a page, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxPagePositionDlg

Parameters

None.

See Also

BoxParagraphPositionDlg

BoxParagraphPositionDlg displays the Paragraph Box Position dialog box. After attaching an image to a paragraph, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxParagraphPositionDlg

Parameters

None.

See Also

BoxResetBorder

BoxResetBorder resets the border values for the current box to the border values for the corresponding box style. For example, border changes made to a specific figure box will reset to the default border values assigned to the Figure Box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making border changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Based on Box Style, Reset to Style, Border Options.

Syntax

BoxResetBorder

Parameters

None.

See Also

BoxResetCaption

BoxResetCaption resets the caption values for the current box to the caption values for the corresponding box style. For example, caption changes made to a specific text box will reset to the default caption values assigned to the Text Box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making caption changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Based on Box Style, Reset to Style, Caption Options (Clears Caption).

Syntax

BoxResetCaption

Parameters

None.

Example

To reset the caption of graphics box number 2, the command sequence is:

BoxEdit(2)
BoxResetCaption
BoxEnd(Save!)

See Also

BoxResetContent

BoxResetContent resets the content values for the current box to the content values for the corresponding box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making content changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Based on Box Style, Reset to Style, Content Type (Clears Content).

Syntax

BoxResetContent

Parameters

None.

Example

To reset the content values of graphics box number 1, the command sequence is:

BoxEdit(1)
BoxResetContent
BoxEnd(Save!)

See Also

BoxResetContentRender

BoxResetContentRender resets any changes made in the Image Editor for the current box to the values for the corresponding box style. This command must be used in conjunction with other commands, such as BoxEdit and BoxEnd. After making changes in the Image Editor, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Image Editor, Edit, Reset All.

Syntax

BoxResetContentRender

Parameters

None.

Example

To reset the content render of graphics box number 2, the command sequence is:

BoxEdit(2)
BoxResetContentRender
BoxEnd(Save!)

See Also

BoxResetCounter

BoxResetCounter resets the counter values for the current box to the counter values for the corresponding box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making counter changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Based on Box Style, Reset to Style, Counter.

Syntax

BoxResetCounter

Parameters

None.

Example

To reset the counter value of graphics box 3, the command sequence is:

BoxEdit(3)
BoxResetCounter
BoxEnd(Save!)

See Also

BoxResetFill

BoxResetFill resets the fill values for the current box to the fill values for the corresponding box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making fill changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specify a box, Edit Box, Based on Box Style, Reset to Style, Fill Options.

Syntax

BoxResetFill

Parameters

None.

Example

To reset the box fill values of graphics box number 2, the command sequence is:

BoxEdit(2)
BoxResetFill
BoxEnd(Save!)

See Also

BoxResetPosition

BoxResetPosition resets the position values for the current box to the position values for the corresponding box style. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After making position changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specify a box, Edit Box, Based on Box Style, Reset to Style, Position and Size.

Syntax

BoxResetPosition

Parameters

None.

Example

To reset the box position values of graphics box number 1, the command sequence is:

BoxEdit(1)
BoxResetPosition
BoxEnd(Save!)

See Also

BoxResetTextFlow

BoxResetTextFlow resets the text flow values for the current box to the text flow values for the corresponding box style. For example, text flow changes made to a specific user box will reset to the default text flow values assigned to the User Box style. After making text flow changes to a box, this command is the equivalent of choosing Graphics, Graphics Boxes, Edit, specifying a box, Edit Box, Based on Box Style, Reset to Style, Text Flow Options.

Syntax

BoxResetTextFlow

Parameters

None.

Example

To reset text flow values of graphics box number 1, the command sequence is:

BoxEdit(1)
BoxResetTextFlow
BoxEnd(Save!)

See Also

BoxSizeDlg

BoxSizeDlg displays the Graphics Box Size dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create (or Edit, specifying a box to edit, Edit Box), Edit Size.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxSizeDlg

Parameters

None.

BoxStaysOnPage

BoxStaysOnPage specifies whether the image should be allowed to move with the surrounding text--even if that means moving to another page. The default setting will allow a box to move. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After attaching an image to a page, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box, then choosing Allow Box to Move Page to Page with Text.

Syntax

BoxStaysOnPage(State)

Parameters

State
Specifies whether the image should stay on the page to which it was attached rather than moving with the text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Moves with text
Yes! 1 Stays on page

Example

To allow the box to move with the surrounding text, the command sequence is:

BoxCreate(FigureBox!)
BoxStaysOnPage(No!)
BoxEnd(Save!)

See Also

BoxStyleCopy

BoxStyleCopy copies the specified style from one location to another. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Copy.

Syntax

BoxStyleCopy(Style Name;Current Location;Destination;New Name)

Parameters

Style Name
Specifies the name of the style to be copied. To copy a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To copy a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Copy Figure Box style
TableBox! 1 Copy Table Box style
TextBox! 2 Copy Text Box style
UserBox! 3 Copy User Box style
EquationBox! 4 Copy Equation Box style
ButtonBox! 5 Copy Button Box style
WatermarkImageBox! 6 Copy Watermark Image Box style
InlineEquationBox! 7 Copy Inline Equation Box style
NoBox! 127 No box
Current Location
Specifies the current location of the style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current Document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared Library
Destination
Specifies the destination of the style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current Document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared Library
New Name (optional)
A character expression specifying the new name to be given to the style. This parameter is only necessary if you want to place a second copy of the style in the same location. This parameter will be expected by the macro if the contents of the Current Location and Destination parameters are the same.

Example

To copy a style you have created called MyStyle from your personal style library to your shared style library, the command is:

BoxStyleCopy("MyStyle";PersonalLibrary!;SharedLibrary!)

See Also

BoxStyleCreate

BoxStyleCreate specifies the name of the style to create. This command must be followed by BoxStyleEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Create, and typing a style name.

Syntax

BoxStyleCreate(Style Name)

Parameters

Style Name
A character expression specifying the name of the style to create.

Example

To create a box style called NewBox, the command sequence is:

BoxStyleCreate("NewBox")
BoxStyleEnd(Save!)

See Also

BoxStyleDelete

BoxStyleDelete deletes a style from the specified location. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting a style, Delete.

Syntax

BoxStyleDelete(Style Name;Style Library)

Parameters

Style Name (optional)
Specifies the name of the box style to delete. To delete a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To delete a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Edit Figure Box style
TableBox! 1 Edit Table Box style
TextBox! 2 Edit Text Box style
UserBox! 3 Edit User Box style
EquationBox! 4 Edit Equation Box style
ButtonBox! 5 Edit Button Box style
WatermarkImageBox! 6 Edit Watermark Image Box style
InlineEquationBox! 7 Edit Inline Equation Box style
Style Library
Specifies the location from which the style should be deleted. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current Document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared Library

Example

To delete a box style called OldBox from the current document, the command is:

BoxStyleDelete("OldBox";CurrentDoc!)

See Also

BoxStyleDlg

BoxStyleDlg displays the Graphics Box Styles dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxStyleDlg

Parameters

None.

See Also

BoxStyleEdit

BoxStyleEdit initiates the editing of a specified style. BoxStyleEdit is used in conjunction with style editing commands and BoxStyleEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting the style to edit, and choosing Edit.

Syntax

BoxStyleEdit(Style Name)

Parameters

Style Name
Specifies the name of the style to edit. To edit a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To edit a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
FigureBox! 0 Edit Figure Box style
TableBox! 1 Edit Table Box style
TextBox! 2 Edit Text Box style
UserBox! 3 Edit User Box style
EquationBox! 4 Edit Equation Box style
ButtonBox! 5 Edit Button Box style
WatermarkImageBox! 6 Edit Watermark Image Box style
InlineEquationBox! 7 Edit Inline Equation Box style

Example

To edit the Watermark Image Box style to allow it to overlap other boxes, the command sequence is:

BoxStyleEdit(WatermarkImageBox!)
BoxOverlap(Yes!)
BoxStyleEnd(Save!)

See Also

BoxStyleEditDlg

BoxStyleEditDlg displays the Edit Graphics Box Style dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting a style, and choosing Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxStyleEditDlg

Parameters

None.

See Also

BoxStyleEnd

BoxStyleEnd ends the editing of a specified style. BoxStyleEnd is used in conjunction with style editing commands such as BoxStyleEdit or BoxStyleCreate. This command is the equivalent of choosing OK or Cancel after creating or editing a graphics box.

Syntax

BoxStyleEnd(State)

Parameters

State
Specifies whether to save or cancel changes made to the style most recently created or edited. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancel changes
Save! 1 Save changes

Example

To save changes to an edited Figure Box style, the command sequence is:

BoxStyleEdit(FigureBox!)
BoxOverlap(Yes!)
BoxStyleEnd(Save!)

See Also

BoxStyleName

BoxStyleName renames a style. This command is used in conjunction with BoxStyleEdit and BoxStyleEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting a style, Edit, and entering a new name in Box Style Name.

Syntax

BoxStyleName(Style Name)

Parameters

Style Name
A character expression specifying a new name for a style.

Example

To rename a style from Picture to Portrait, the command sequence is:

BoxStyleEdit("Picture")
BoxStyleName("Portrait")
BoxStyleEnd(Save!)

See Also

BoxStyleRetrieve

BoxStyleRetrieve retrieves the specified style into either the current document or your personal or shared style libraries. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, selecting the location into which you wish to retrieve a style, Retrieve, and typing the name of a style to retrieve.

Syntax

BoxStyleRetrieve(Style Library;Location)

Parameters

Style Library
A character expression specifying the style library containing the styles to be retrieved.
Location
Specifies the location into which the style should be retrieved. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current Document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared Library

Example

To retrieve all styles in a style library named RETRO into your Shared Style Library, the command is:

BoxStyleRetrieve("RETRO";SharedLibrary!)

See Also

BoxStyleSave

BoxStyleSave saves all styles from the current document or your personal or shared style libraries to the specified style library. If the specified style library contains styles, they will be replaced. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, selecting location, selecting a style, Save, and naming a style library.

Syntax

BoxStyleSave(Library Name;Location)

Parameters

Library Name
A character expression specifying the style library to which the styles will be saved.
Location
Specifies the current location of the styles. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current Document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared Library

Example

To save all styles in your Shared Style library to a style library named AWARD, the command is:

BoxStyleSave("C:\COREL\WP62\AWARD.STY";SharedLibrary!)

See Also

BoxTextAngle

BoxTextAngle rotates the text in a graphics box. This command must be used in conjunction with other commands, such as BoxCreate, BoxEdit and BoxEnd. This command is the equivalent of choosing Create or Edit Text from the Edit Graphics Box dialog box, pressing Alt+F9, choosing Rotate Box Contents, and specifying the rotation degree.

Syntax

BoxTextAngle(Degree)

Parameters

Degree
Specifies the degree to rotate the text in a graphics box. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No rotation
Degrees90! 1 90 degrees
Degrees180! 2 180 degrees
Degrees270! 3 270 degrees

Example

To rotate box text 180 degrees, the command sequence is:

BoxCreate(TextBox!)
BoxTextAngle(Degrees180!)
BoxEnd(Save!)

See Also

BoxTextDefaultStyle

BoxTextDefaultStyle determines the default style for box text. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting a Text Box style, Edit, Text Settings, Style, highlighting a style, Select.

Syntax

BoxTextDefaultStyle(Style)

Parameters

Style
Specifies the default style for box text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To specify Normal Style as the default for box text, the command sequence is:

BoxStyleEdit(TextBox!)
BoxTextDefaultStyle(BoxTextStyle!)
BoxStyleEnd(Save!)

See Also

BoxTextFilename

BoxTextFilename specifies the name of a text file. This command doesn't retrieve the file, it simply indicates to the program that the contents of the box is text. To retrieve a text file, use FileRetrieve. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. To record this command, specify the box contents as Text, then retrieve a file.

Syntax

BoxTextFilename(Filename)

Parameters

Filename
A character expression specifying the name of the text file.

Example

To specify a text filename of DRAFT.FIL, the command sequence is:

BoxCreate(TextBox!)
FileRetrieve("DRAFT.FIL")
BoxTextFilename("DRAFT.FIL")
BoxEnd(Save!)

See Also

BoxTextFlow

BoxTextFlow specifies the flow or placement of text surrounding a graphics box. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Text Flow Around Box, Text Flows.

Syntax

BoxTextFlow(Direction)

Parameters

Direction
Specifies the location of the text flow surrounding a graphics box. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LargestSide! 0 Side with largest amount of space
LeftSide! 1 Left side
RightSide! 2 Right side
NeitherSide! 3 Neither side
BothSides! 8 Both sides
Columnar! 9 Columns
NoWrapping! 15 No wrapping

Example

To allow text to wrap around the box, the command sequence is:

BoxCreate(FigureBox!)
BoxTextFlow(BothSides!)
BoxEnd(Save!)

See Also

BoxTextFlowContour

BoxTextFlowContour determines whether text should be contoured to the shape of the graphics image. Contouring applies only to text outside of the box. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Text Flow Around Box, Contour Text Flow.

Syntax

BoxTextFlowContour

Parameters

None.

See Also

BoxTextFlowSquare

BoxTextFlowSquare determines whether text should be contoured to the square shape of the box. BoxTextFlowSquare is only necessary if you have previously used BoxTextFlowContour. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Text Flow Around Box, Contour Text Flow.

Syntax

BoxTextFlowSquare

Parameters

None.

See Also

BoxTextSettingsDlg

BoxTextSettingsDlg displays the Rotate Box Contents dialog box. After selecting Text as the contents of the box and choosing either Create or Edit Text, this command is the equivalent of pressing Alt+F9, and choosing Rotate Box Contents.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

BoxTextSettingsDlg

Parameters

None.

See Also

BoxVerticalAlignment

BoxVerticalAlignment positions a box relative to the page or character to which it has been attached. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After attaching a box to either a page or a character, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box, then choosing Vertical Position and/or Offset from Position.

Syntax

BoxVerticalAlignment(Position;Offset)

Parameters

Position
Specifies the vertical position of a box that has been attached to either a page or a character position. Select an enumerated type or numeric equivalent.
Enumerated Type Numeric Equivalent Description
Top! 1 Top of page or top of text baseline
Center! 2 Center of page or center of text baseline
Bottom! 4 Bottom of page or bottom of text baseline
Baseline! 6 Text baseline (if attached to character position)
FullAlign! 7 Full length of page (if attached to page position)
Offset (optional)
A numeric expression specifying the offset from the vertical position. This parameter only applies to boxes attached to a page. An offset moving text up from the vertical position should be a negative number; an offset moving text down should be a positive number.

Example

To vertically center a figure box that has been attached to a page, the command sequence is:

BoxCreate(FigureBox!)
BoxVerticalAlignment(Center!)
BoxEnd(Save!)

See Also

BoxVerticalPosition

BoxVerticalPosition specifies the vertical position of a graphics box that has been attached to either a page or a paragraph. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. After attaching a box to either a page or a paragraph, this command is the equivalent of choosing Edit Position from the Edit Graphics Box dialog box, then choosing Vertical Position.

Syntax

BoxVerticalPosition(Position)

Parameters

Position
A measurement expression specifying the vertical position of a box.

Example

To position a figure box 3" from the top of the page, the command sequence is:

BoxCreate(FigureBox!)
BoxVerticalPosition(3")
BoxEnd(Save!)

See Also

BoxWidth

BoxWidth sets the box width or allows Corel WordPerfect to set the width automatically based on the box contents. This command must be used in conjunction with other commands, such as BoxCreate and BoxEnd. This command is the equivalent of choosing Graphics, Graphics Boxes, Create or Edit, Edit Size, and choosing either Set Width, or Automatic Width.

Syntax

BoxWidth(Width)

Parameters

Width
Specifies the width of a graphics box. Select the enumerated type or its numeric equivalent to automatically set the width based on the width of the box contents. Use a numeric expression if you want to set the width.
Enumerated Type Numeric Equivalent Description
AutoWidth! 2 Use automatic width

Example

To set a figure box width to 3", the command sequence is:

BoxCreate(FigureBox!)
BoxWidth(3")
BoxEnd(Save!)

See Also

ButtonBar

ButtonBar determines whether the Button Bar is displayed. This command is not recordable. To use this command, you must type it into the macro.

Syntax

ButtonBar(State)

Parameters

State
Specifies whether the Button Bar is displayed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Not displayed
On! 1 Displayed

Example

To display the Button Bar, the command is:

ButtonBar(On!)

See Also

ButtonBarPosition

ButtonBarPosition specifies where the Button Bar should be positioned on your document screen. This command is the equivalent of choosing View, Button Bar Setup, Options, then selecting a position.

Syntax

ButtonBarPosition(Position)

Parameters

Position
Specifies the position of the Button Bar on a document window. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Left side of window
Top! 1 Top of window
Right! 3 Right side of window
Bottom! 4 Bottom of window

Example

To position the Button Bar at the bottom of a document window, the command is:

ButtonBarPosition(Bottom!)

See Also

ButtonBarSelect

ButtonBarSelect selects the specified Button Bar. This command is the equivalent of choosing View, Button Bar Setup, Select, highlighting a Button Bar, Select.

Syntax

ButtonBarSelect(Button Bar)

Parameters

Button Bar
A character expression specifying the Button Bar to select.

Example

To select a Button Bar named MYMACROS, the command is:

ButtonBarSelect("MYMACROS")

See Also

ButtonBarSetupGraphics

ButtonBarSetupGraphics determines whether Button Bars are visible while the program display is in Graphics Mode. This command is the equivalent of choosing View, Screen Setup, Screen Options, Button Bar (Graphics).

Syntax

ButtonBarSetupGraphics(State)

Parameters

State
Specifies whether Button Bars are visible in Graphics Mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Button Bars not visible
On! 1 Button Bars visible

Example

To allow Button Bars to be visible while in Graphics Mode, the command is:

ButtonBarSetupGraphics(On!)

See Also

ButtonBarSetupText

ButtonBarSetupText determines whether Button Bars are visible while the program display is in Text Mode. This command is the equivalent of choosing View, Screen Setup, Screen Options, Button Bar (Text).

Syntax

ButtonBarSetupText(State)

Parameters

State
Specifies whether Button Bars are visible in Text Mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Button Bars not visible
On! 1 Button Bars visible

Example

To allow Button Bars to be visible while in Text Mode, the command is:

ButtonBarSetupText(On!)

See Also

ButtonBarStyle

ButtonBarStyle specifies a Button Bar style. This command is the equivalent of choosing View, Button Bar Setup, Options, and selecting a style.

Syntax

ButtonBarStyle(Style)

Parameters

Style
Specifies the style of the Button Bar. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Text! 1 Text only
Icon! 2 Icon only
Both! 3 Text and Icon

Example

To specify that a Button Bar display icons only, the command is:

ButtonBarStyle(Icons!)

See Also

CancelKey

It might be helpful to think of this command as the Esc key. This command displays the Undelete dialog or cancels the current dialog. CancelKey will execute whatever the Escape key is designed to do in the state the program is in when the macro encounters this command. This doesn't include situations where the Escape key has been remapped in Keyboard Layout. This command is not recordable. To use this command, you must type it into the macro.

Syntax

CancelKey

Parameters

None.

CapBeginSentence

CapBeginSentence automatically capitalizes the first letter of each sentence as you type. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, Capitalize First Letter.

Syntax

CapBeginSentence(State)

Parameters

State
Specifies whether to automatically capitalize the first letter of each sentence as it is typed. Select an enumerated type or its numeric equivalent.
EnumeratedNumeric TypeEquivalent
Off!0
On!1

Example

To specify that the first letter of each sentence is automatically capitalized, the command is:

CapBeginSentence(On!)

CartridgesAndFontsBegin

CartridgesAndFontsBegin initiates cartridge, font, and print wheel selections. This command must be used in conjunction with commands such as CartridgesAndFontsMarkFont and CartridgesAndFontsEnd. This command is the equivalent of choosing Font, Font, Setup, Select Cartridges/Fonts/Print Wheels.

Syntax

CartridgesAndFontsBegin

Parameters

None.

See Also

CartridgesAndFontsEnd

CartridgesAndFontsEnd terminates cartridge, font, and print wheel selections and specifies whether to save or cancel those selections. This command must be used in conjunction with commands such as CartridgesAndFontsBegin and CartridgesAndFontsMarkFont. This command is the equivalent of choosing OK or Cancel when closing the Select Fonts dialog box.

Syntax

CartridgesAndFontsEnd(State;Printer Name;.PRS Filename)

Parameters

State
Specifies whether to save or cancel cartridge, font, and print wheel selections. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancel changes
Save! 1 Save changes
Printer Name
A character expression specifying a printer.
.PRS Filename (optional)
A character expression naming the printer file to which the selections will be saved.

Example

To end and save font selections on an Apple LaserWriter IINTX to its printer file named APLW2NTX.PRS, the command sequence is:

CartridgesAndFontsBegin
CartridgesAndFontsMarkFont("Built-In";;"New Century Schoolbook";StarMark!)
CartridgesAndFontsEnd(Save!;"Apple LaserWriter IINTX";"APLW2NTX.PRS")

See Also

CartridgesAndFontsMarkFont

CartridgesAndFontsMarkFont marks fonts to be added to a printer file. This command must be used in conjunction with CartridgesAndFontsBegin and CartridgesAndFontsEnd. This command is the equivalent of choosing Font, Font, Setup, Select Cartridges/Fonts/Print Wheels, choosing a category, Edit, marking fonts.

Syntax

CartridgesAndFontsMarkFont(Font Source;Library Name;Font Name;Type of Mark)

Parameters

Font Source
A character expression specifying a font source. Options for this parameter, such as "Built-In", or "Soft Font", are displayed in the Select Cartridges/Fonts/Print Wheels dialog box.
Library Name (optional)
A character expression specifying the font library. This parameter must be used if marking soft fonts.
Font Name (optional)
A character expression naming a font to be marked. For non-scalable fonts, the font name should include point size.
Type of Mark
Specifies how a font is marked. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RemoveMark! 0 Unmark font
HomeStar! 1 Home, "*". Marks all fonts with a "*". Not recordable.
HomePlus! 2 Home, "+". Marks all fonts with a "+". Not recordable.
PlusMark! 128 Mark with "+"
StarPlusMark! 152 Mark with "*+"
StarMark! 176 Mark with "*"

Example

To mark the font New Century Schoolbook with an asterisk, the command sequence is:

CartridgesAndFontsBegin
CartridgesAndFontsMarkFont("Built-In";;"New Century Schoolbook";StarMark!)
CartridgesAndFontsEnd(Save!;"Apple LaserWriter IINTX")

See Also

CartridgesAndFontsQuantity

CartridgesAndFontsQuantity indicates how much memory, or how many cartridge slots or print wheels are available. This command must be used in conjunction with CartridgesAndFontsBegin and CartridgesAndFontsEnd commands. This command is the equivalent of choosing File, Print/Fax, Select, selecting a printer, Edit, Font Setup, Select Cartridges/Fonts/Print Wheels, choosing a font category, Quantity, and specifying quantity.

Syntax

CartridgesAndFontsQuantity(Font Source;Quantity)

Parameters

Font Source
A character expression specifying a font source. Options for this parameter such as "Built-In", or "Soft Font", are displayed in the Select Cartridges/Fonts/Print Wheels dialog box.
Quantity
A numeric expression specifying the quantity of memory, cartridge slots, or print wheels available.

Example

To specify that your printer has 350K memory available for downloadable soft fonts, the command sequence is:

CartridgesAndFontsBegin
CartridgesAndFontsQuantity("Soft Font";350)
CartridgesAndFontsEnd(Save!;"Apple LaserWriter IINTX")

See Also

Center

Center aligns one line of text. This command is the equivalent of choosing Layout, Alignment, Center.

Syntax

Center

Parameters

None.

See Also

CenterCurrentPage

CenterCurrentPage specifies whether to center the current page vertically. This command is the equivalent of choosing Layout, Page, Center Current Page.

Syntax

CenterCurrentPage(State)

Parameters

State
Designates whether to center the contents of a current page vertically. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Do not center page
On! 1 Center page

Example

To center a current page vertically, the command is:

CenterCurrentPage(On!)

See Also

CenterPages

CenterPages specifies whether all pages in a document from the current page forward are centered vertically. This command is the equivalent of choosing Layout, Page, Center Pages.

Syntax

CenterPages(State)

Parameters

State
Designates whether to center all pages vertically in a current document. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Do not center pages
On! 1 Center pages

Example

To center all pages vertically in the current document, the command is:

CenterPages(On!)

See Also

CGAFastText

CGAFastText speeds up screen display on CGA monitors. This command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Fast Text. This command may cause snow on screen.

Syntax

CGAFastText(State)

Parameters

State
Designates whether the CGA Fast Text option is on. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 CGA Fast Text off
Yes! 1 CGA Fast Text on

Example

To turn the CGA Fast Text option on, the command is:

CGAFastText(Yes!)

ChapterNumber

ChapterNumber specifies a chapter number. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, New Number, and specifying a number.

Syntax

ChapterNumber(Number)

Parameters

Number
A numeric expression specifying chapter number.

Example

To specify chapter 5, the command is:

ChapterNumber(5)

See Also

ChapterNumberDecrement

ChapterNumberDecrement decrements a chapter number based on the previous chapter number. For example, if the previous chapter was 10, ChapterNumberDecrement decrements the next chapter to 9. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, Decrement Number.

Syntax

ChapterNumberDecrement

Parameters

None.

See Also

ChapterNumberDisplay

ChapterNumberDisplay types the chapter number at the cursor. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, Display in Document.

Syntax

ChapterNumberDisplay

Parameters

None.

See Also

ChapterNumberIncrement

ChapterNumberIncrement increments a chapter number based on the previous chapter number. For example, if the previous chapter was 1, ChapterNumberIncrement will increment the next chapter to 2. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, Increment Number.

Syntax

ChapterNumberIncrement

Parameters

None.

See Also

ChapterNumberMethod

ChapterNumberMethod specifies the method of numbering a chapter. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, Numbering Method, and selecting a method.

Syntax

ChapterNumberMethod(Number Method)

Parameters

Number Method
Designates the numbering method for a current chapter. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Numbers
LowerLetters! 1 Lowercase letters
UpperLetters! 2 Uppercase letters
LowerRoman! 3 Lowercase roman numerals
UpperRoman! 4 Uppercase roman numerals

Example

To select uppercase roman numerals as the numbering method, the command is:

ChapterNumberMethod(UpperRoman!)

See Also

ClearDoc

ClearDoc clears a document screen without saving changes. This command is the equivalent of choosing File, Exit, No, No.

Syntax

ClearDoc

Parameters

None.

See Also

ClipboardAppendTo

ClipboardAppendTo appends the contents of a document screen or blocked text to existing text in the Clipboard. This command is the equivalent of choosing File, Go To Shell, Append.

Syntax

ClipboardAppendTo

Parameters

None.

See Also

ClipboardRetrieve

ClipboardRetrieve retrieves the contents of a clipboard into a document screen. This command is the equivalent of choosing File, Go To Shell, Retrieve.

Syntax

ClipboardRetrieve

Parameters

None.

See Also

ClipboardSaveTo

ClipboardSaveTo saves the contents of a document screen or blocked text to the clipboard. Current Clipboard contents will be overwritten. This command is the equivalent of choosing File, Go To Shell, Save to Clipboard.

Syntax

ClipboardSaveTo

Parameters

None.

See Also

ClipboardSetNumber

ClipboardSetNumber specifies the number of a Clipboard. This command is the equivalent of choosing File, Go To Shell, Clipboard Number.

Syntax

ClipboardSetNumber(Number)

Parameters

Number
A numeric expression specifying a Clipboard number to append, save to, or retrieve from. Clipboard numbers range from 0 to 79.

Example

To specify Clipboard 10, the command is:

ClipboardSetNumber(10)

See Also

Close

Closes a document screen without saving changes. This command is the equivalent of choosing File, Close, No.

Syntax

Close

Parameters

None.

See Also

CloseAllDocuments

Closes all open documents but does not exit Corel WordPerfect. This command is the equivalent of pressing Home, F7 or choosing File, Exit All Docs.

Syntax

CloseAllDocuments

Parameters

None.

See Also

CloseDlg

CloseDlg displays the Close dialog box. This command is the equivalent of choosing File, Close with text on the screen.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CloseDlg

Parameters

None.

See Also

ColorAdd

ColorAdd adds a color to a color palette. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Edit, Create, and specifying color name and values.

Syntax

ColorAdd(Palette Name;Position;Red Value;Green Value;Blue Value;Color Name:)

Parameters

Palette Name
A character expression naming a color palette.
Position (optional)
A numeric expression specifying the position at which the new color should appear in the list of palette colors.
Red Value
A numeric expression representing the amount of red in a color. Values range from 0 to 255. The values for all colors are displayed in the Edit Color Printing Palette dialog box.
Green Value
A numeric expression representing the amount of green in the color. Values range from 0 to 255. See parameter description of "Red Value" above.
Blue Value
A numeric expression representing the amount of blue in a color to be added. Values range from 0 to 255. See parameter description of "Red Value" above.
Color Name
A character expression specifying the name of a color to be added.

Example

To add a color named Autumn to a palette named Seasons, the command is:

ColorAdd("Seasons";0;251;160;90;"Autumn")

See Also

ColorDelete

ColorDelete deletes a color from a color palette. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Edit, selecting a color, Delete.

Syntax

ColorDelete(Palette Name;Color Name)

Parameters

Palette Name
A character expression specifying a palette from which a color is to be deleted.
Color Name
A character expression specifying a color to be deleted.

Example

To delete Cyan from Crayon Palette, the command is:

ColorDelete("Crayon Palette";"Cyan")

See Also

ColorDlg

ColorDlg displays the Color Selection dialog box. This command is for use with tables and is the equivalent of choosing Font, Font, Color.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ColorDlg

Parameters

None.

ColorModify

ColorModify modifies and renames a color. This command is the equivalent of choosing File, Setup, Color Palette, highlighting a palette, Edit, highlighting a color, Edit, and modifying attributes.

Syntax

ColorModify(Palette Name;Current Color Name;Red Value;Green Value;Blue Value;New Color Name)

Parameters

Palette Name
A character expression naming a color palette containing a color to be modified.
Current Color Name
A character expression naming the color to be modified.
Red Value
A numeric expression representing the amount of red in a color. Values range from 0 to 255.
Green Value
A numeric expression representing the amount of green in a color. Values range from 0 to 255.
Blue Value
A numeric expression representing the amount of blue in a color. Values range from 0 to 255.
New Color Name
A character expression renaming a color after modification.

Example

To modify Black in the Crayon Palette and rename it Slate, the command is:

ColorModify("Crayon Palette";"Black";51;91;91;"Slate")

See Also

ColorPaletteCreate

ColorPaletteCreate names a palette to create, usually in conjunction with palette modification commands such as ColorAdd. This command is the equivalent of choosing File, Setup, Color Palette, Create.

Syntax

ColorPaletteCreate(Palette Name)

Parameters

Palette Name
A character expression naming a palette.

Example

To create a palette named Hues of Blue, the command is:

ColorPaletteCreate("Hues of Blue")

See Also

ColorPaletteDelete

ColorPaletteDelete names a palette to delete. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Delete.

Syntax

ColorPaletteDelete(Palette Name)

Parameters

Palette Name
A character expression naming a palette to delete.

Example

To delete a palette named Hues of Blue, the command is:

ColorPaletteDelete("Hues of Blue")

See Also

ColorPaletteDlg

ColorPaletteDlg displays the Color Printing Palette dialog box. This command is the equivalent of choosing File, Setup, Color Palette.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ColorPaletteDlg

Parameters

None.

See Also

ColorPaletteRename

ColorPaletteRename renames an existing palette. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Rename, and renaming the palette.

Syntax

ColorPaletteRename(Current Palette Name;New Palette Name)

Parameters

Current Palette Name
A character expression specifying the current name of a palette.
New Palette Name
A character expression renaming a color palette.

Example

To change the name Craig Pyle's Palette to Puget Sound Blues, the command is:

ColorPaletteRename("Craig Pyle's Palette";"Puget Sound Blues")

See Also

ColorPaletteSelect

ColorPaletteSelect names a palette to select. This command is the equivalent of choosing File, Setup, Color Palette, highlighting a palette, Select.

Syntax

ColorPaletteSelect(Palette Name)

Parameters

Palette Name
A character expression specifying a palette to select.

Example

To select the palette called Multi-Colors, the command is:

ColorPaletteSelect("Multi-Colors")

See Also

ColorSchemeAssign

ColorSchemeAssign assigns new color combinations to specified display attributes in Text Mode. While in Text Mode, this command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Color Schemes, highlighting a color scheme, Create or Edit, Text Attributes or Menus & Dialogs, highlighting an attribute, menu or dialog, Color, and highlighting a color combination.

Syntax

ColorSchemeAssign(Scheme Name;Attribute;Foreground/Background)

Parameters

Scheme Name
A character expression specifying the name of a color scheme.
Attribute
A numeric expression representing the attribute, menu or dialog being changed. The number assigned to each attribute is not displayed in the Edit Text Screen Colors dialog box. The best way to obtain these numbers is to record the command.
Foreground/Background
A numeric expression representing the combination of background and foreground colors. The number assigned to each color combination is not displayed in the Select Color dialog box. The best way to obtain these numbers is to record the command.

Example

To specify Light Cyan on Light Blue as the color combination for displaying blocked text in a color scheme named Wedgewood, the command is:

ColorSchemeAssign("Wedgewood";1;155)

See Also

ColorSchemeCopy

ColorSchemeCopy makes a copy of a specified color scheme and gives it a new name. While in Text Mode, this command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Color Schemes, highlighting a scheme to copy, Copy, and entering a new name.

Syntax

ColorSchemeCopy(Current Name;New Name)

Parameters

Current Name
A character expression specifying the color scheme to copy.
New Name
A character expression specifying the new name of the color scheme.

Example

To make a copy of a color scheme called Sharon's with a new name of Deena's, the command is:

ColorSchemeCopy("Sharon's";"Deena's")

See Also

ColorSchemeCreate

ColorSchemeCreate creates a color scheme. While in Text Mode, this command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Color Schemes, Create, and entering a name.

Syntax

ColorSchemeCreate(Scheme Name)

Parameters

Scheme Name
A character expression specifying the name of a color scheme to create.

Example

To create a color scheme named Eclectic Selections, the command is:

ColorSchemeCreate("Eclectic Selections")

See Also

ColorSchemeDelete

ColorSchemeDelete deletes a color scheme. While in Text Mode, this command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Color Schemes, highlighting a scheme, Delete.

Syntax

ColorSchemeDelete(Scheme Name)

Parameters

Scheme Name
A character expression specifying the color scheme to delete.

Example

To delete a color scheme named Mousy Browns, the command is:

ColorSchemeDelete("Mousy Browns")

See Also

ColorSchemeSelect

ColorSchemeSelect selects a color scheme. While in Text Mode, this command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Color Schemes, highlighting a scheme, Select.

Syntax

ColorSchemeSelect(Scheme Name)

Parameters

Scheme Name
A character expression specifying the color scheme to select.

Example

To select a color scheme named London Fog, the command is:

ColorSchemeSelect("London Fog")

See Also

ColorUnits

ColorUnits selects the specified color display unit. This command is the equivalent of choosing File, Setup, Color Palette, Color Display Units, and selecting a display unit.

Syntax

ColorUnits(Unit)

Parameters

Unit
Specifies the color display unit for all color selections. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RGB! 0 Selects Red Green Blue display unit
HLS! 1 Selects Hue Luminosity Saturation display unit
CMYK! 2 Selects Cyan Magenta Yellow Black display unit

Example

To select the Hue Luminosity Saturation display unit, the command is:

ColorUnits(HLS!)

See Also

ColumnsDefinition

ColumnsDefinition defines columns. This command should be used if you want to specify the column widths or if you want to vary the space between columns. This command is the equivalent of choosing Layout, Columns, selecting a column type, selecting number of columns, Custom Widths, Edit, and specifying the Width and the Fixed options for each column and space between columns.

Syntax

ColumnsDefinition(Type of Column;Section Spacing;{Width;Fixed})

Parameters

Type of Column
Specifies the type of column being defined. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Newspaper! 0 Newspaper columns
NewspaperBalanced! 1 Evenly-spaced newspaper columns
Parallel! 2 Parallel columns
ParallelBlockProtect! 3 Parallel columns with Block Protect
Section Spacing
A numeric expression specifying the spacing between sections of text in Parallel Columns.
Width
A measurement expression that alternates between specifying the width of each column and the desired space between the columns. This parameter is always paired with the Fixed parameter.
Fixed
Specifies whether or not the width of the column or the space between columns is fixed. This parameter is always paired with the Width parameter. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NotFixed! 0 Columns not fixed
Fixed! 1 Columns fixed

Example

To define two non-fixed newspaper columns, one with a width of 2" and one with a width of 3", with 1" between them, the command is:

ColumnsDefinition(Newspaper!;1.0;{2";NotFixed!;1";Fixed!;3";NotFixed!})

See Also

ColumnsDefinitionDlg

ColumnsDefinitionDlg displays the Text Columns dialog box. This command is the equivalent of choosing Layout, Columns.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ColumnsDefinitionDlg

Parameters

None.

See Also

ColumnsDefinitionSimple

ColumnsDefinitionSimple defines columns. It should be used if you do not want to specify the column widths and if you want the same distance between all columns. This command is the equivalent of choosing Layout, Columns, and selecting options from the Text Columns dialog box without changing the spacing or width of columns.

Syntax

ColumnsDefinitionSimple(Number of Columns;Type of Column;Section Spacing;Width Between Columns)

Parameters

Number of Columns
A numeric expression specifying the number of columns.
Type
Specifies the type of column being defined. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Newspaper! 0 Newspaper columns
NewspaperBalanced! 1 Evenly-spaced newspaper columns
Parallel! 2 Parallel columns
ParallelBlockProtect! 3 Parallel columns with Block Protect
Section Spacing
A numeric expression specifying the spacing between sections of text in Parallel Columns.
Width
Between Columns (optional) A measurement expression specifying the width between columns.

Example

To define two parallel columns, with .5" between them, the command is:

ColumnsDefinitionSimple(2;Parallel!;1.0;0.5")

See Also

ColumnsOff

ColumnsOff turns columns off. This command is the equivalent of choosing Layout, Columns, Off.

Syntax

ColumnsOff

Parameters

None.

See Also

ColumnsTablesDlg

ColumnsTablesDlg displays the Columns/Tables dialog box. This command is the equivalent of pressing Alt+F7.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ColumnsTablesDlg

Parameters

None.

See Also

CommentConvert

CommentConvert converts a comment to text. This command is the equivalent of choosing Layout, Comment, Convert to Text.

Syntax

CommentConvert

Parameters

None.

See Also

CommentCreate

CommentCreate opens the Comment editing screen. This command is the equivalent of choosing Layout, Comment, Create.

Syntax

CommentCreate

Parameters

None.

See Also

CommentEdit

CommentEdit opens the Comment editing screen. If a comment has not been created, a "Not Found" error is generated. This command is the equivalent of choosing Layout, Comment, Edit.

Syntax

CommentEdit

Parameters

None.

See Also

CommentsDisplaySetup

CommentsDisplaySetup specifies whether comments are displayed in documents. This command is the equivalent of choosing View, Screen Setup, Window Options, Display Comments.

Syntax

CommentsDisplaySetup(State)

Parameters

State
Specifies whether comments are displayed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not display comments
Yes! 1 Display comments

Example

To display comments, the command is:

CommentsDisplaySetup(Yes!)

See Also

ComposeDlg

ComposeDlg displays the Compose dialog box. This command is the equivalent of pressing Ctrl+A.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ComposeDlg

Parameters

None.

See Also

CompressedPrintForList

CompressedPrintForList specifies whether to print the files listed in File Manager in a compressed font. This command is the equivalent of choosing File, File Manager, entering a directory, Setup, Compressed Print for List.

Syntax

CompressedPrintForList(State)

Parameters

State
Specifies whether the list of files printed from File Manager prints in a compressed font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Compressed font
Yes! 1 Normal font

Example

To print the File Manager files list in a compressed font, the command is:

CompressedPrintForList(Yes!)

ConditionalEndOfPage

ConditionalEndOfPage protects the specified number of lines from being separated by a page break. If a page break will fall between the lines, the lines will all be moved to the next page. This command is the equivalent choosing Layout, Other, Conditional End of Page, and specifying the Number of Lines to Keep Together.

Syntax

ConditionalEndOfPage(Number Of Lines)

Parameters

Number of Lines A numeric expression specifying the number of lines to keep together.

Example

To keep ten lines of text together, the command is:

ConditionalEndOfPage(10)

ConvertCaseDlg

ConvertCaseDlg displays the Convert Case dialog box. This dialog box will only be displayed if text is currently blocked. With text blocked, this command is the equivalent of pressing Shift+F3.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ConvertCaseDlg

Parameters

None.

See Also

ConvertCaseInitialCaps

ConvertCaseInitialCaps converts the currently blocked text to initial caps. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Initial Caps.

Syntax

ConvertCaseInitialCaps

Parameters

None.

See Also

ConvertCaseLowercase

ConvertCaseLowercase converts the currently blocked text to lowercase letters. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Lowercase.

Syntax

ConvertCaseLowercase

Parameters

None.

See Also

ConvertCaseUppercase

ConvertCaseUppercase converts the currently blocked text to uppercase letters. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Uppercase.

Syntax

ConvertCaseUppercase

Parameters

None.

See Also

ConvertCodePage

ConvertCodePage specifies a Code Page for the current document. This command is the equivalent of choosing Save, Code Page, highlighting a language set, Select.

Syntax

ConvertCodePage(Code Page)

Parameters

Code Page
A numeric expression specifying a code page.

Example

To convert to a Code Page of Hebrew, the command is:

ConvertCodePage(862)

Copy

Copy duplicates blocked text and is used with Paste to retrieve the duplicated text. With text blocked, this command is the equivalent of choosing Edit, Copy.

Syntax

Copy

Parameters

None.

See Also

CopyAndPaste

CopyAndPaste duplicates blocked text and is used with MoveModeEnd to copy the text. With text blocked, this command is the equivalent of choosing Edit, Copy and Paste.

Syntax

CopyAndPaste

Parameters

None.

See Also

CounterBoxNumberingDlg

CounterBoxNumberingDlg displays the Counters dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CounterBoxNumberingDlg

Parameters

None.

See Also

CounterCreate

CounterCreate specifies a graphics box reference number. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, Create, entering a name, Numbering Method.

Syntax

CounterCreate(Type;{Number})

Parameters

Type
Specifies a counter value. To edit a counter, select an enumerated type or its numeric equivalent. To create a counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Number
Specifies a numbering method. Select an enumerated type or its numeric equivalent. This parameter can be repeated to indicate how many levels a counter has and to specify a numbering method for each level. Enclose repeating parameters in French braces.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Arabic numbers
LowLetter! 1 Lowercase letters
UpLetter! 2 Uppercase letters
LowRoman! 3 Lowercase roman numerals
UpRoman! 4 Uppercase roman numerals

Example

To define a user box counter as lowercase letters, the command is:

CounterCreate(UserBoxCounter!;{LowLetter!})

CounterDecrement

CounterDecrement decreases a counter by one. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, highlighting a graphics box type, Decrement.

Syntax

CounterDecrement(Type;Level)

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box decrement
TableBoxCounter! 2 Table box decrement
TextBoxCounter! 3 Text box decrement
UserBoxCounter! 4 User box decrement
EquationCounter! 5 Equation box decrement
Level
A numeric expression specifying a level to decrement.

Example

To decrement a figure box number at level one, the command is:

CounterDecrement(FigureCounter!;1)

See Also

CounterDelete

CounterDelete specifies a counter value to delete. This command accepts either a character expression if the counter is a user-defined counter or an enumerated type. If an enumerated type is specified, the counter will be reset, not deleted. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a graphics box type, Delete.

Syntax

CounterDelete(Type)

Parameters

Type
Specifies a counter to delete. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box

Example

To delete a user-created counter named My Counter, the command is:

CounterDelete("My Counter")

CounterDisplay

CounterDisplay displays the counter value of a graphics box or user-defined counter. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, highlighting a counter, Display in Document.

Syntax

CounterDisplay(Type;Level)

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Level
A numeric expression specifying a level of the graphics box counter to display.

Example

To display a number from a user-created counter named My Counter, the command is:

CounterDisplay("My Counter";1)

CounterDlg

CounterDlg displays the Counter dialog box, but does not display the system counters. This command is the equivalent of choosing Layout, Character, Counters.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CounterDlg

Parameters

None.

See Also

CounterEditLevel

CounterEditLevel specifies the number of levels a graphics box contains. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a graphics box type, Edit, Levels, and specifying a number of levels.

Syntax

CounterEditLevel(Type;Level)

Parameters

Type
Specifies a counter value type. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Level
A numeric expression specifying a counter level. Each counter can have up to five levels.

Example

To specify two levels in a figure box, the command is:

CounterEditLevel(FigureCounter!;2)

CounterEditLevelMethod

CounterEditLevelMethod changes the graphics box numbering method for a graphics box level. This command is only available after specifying more than one level in the Edit Counter Definition dialog box. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a counter level, Edit, Numbering Method, and selecting a numbering method.

Syntax

CounterEditLevelMethod(Type;Level;Method)

Parameters

Type
Specifies a counter type. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Level (optional)
A numeric expression specifying which counter level the command affects.
Method
Specifies a display type for the counter. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Arabic numbers
LowLetter! 1 Lowercase letters
UpLetter! 2 Uppercase letters
LowRoman! 3 Lowercase roman numerals
UpRoman! 4 Uppercase roman numerals

Example

To specify uppercase letters for the first level of a figure box counter, the command is:

CounterEditLevelMethod(FigureCounter!;1;UpLetter!)

See Also

CounterEditLevelName

CounterEditLevelName renames a counter level. This command is only available after choosing Create in the Counters dialog box, naming a new graphics box counter type, and selecting more than one level, or when a system counter has been modified to have multiple levels. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a graphics box level, Edit, Name, and entering a new name.

Syntax

CounterEditLevelName(Type;OldName;NewName)

Parameters

Type
Specifies a type of counter. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
OldName
A character expression specifying the name of a graphics box counter type.
NewName
A character expression specifying the new name of a graphics box counter type.

Example

To change the name of a user-created graphics box counter level from Level 1 to First Level for a graphics type named My Box, the command is:

CounterEditLevelName("My Box";"Level 1";"First Level")

See Also

CounterEditMethod

CounterEditMethod changes the counter numbering method for a specified graphics box. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a graphics box type, Edit, Numbering Method.

Syntax

CounterEditMethod(Type;Method)

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Method
Specifies a display type for a counter. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Arabic numbers
LowLetter! 1 Lowercase letters
UpLetter! 2 Uppercase letters
LowRoman! 3 Lowercase roman numerals
UpRoman! 4 Uppercase roman numerals

Example

To specify a figure box counter numbering method as uppercase letters, the command is:

CounterEditMethod(FigureCounter!;UpLetter!)

See Also

CounterEditName

CounterEditName renames a counter. This command is only available after choosing Create in the Counters dialog box and naming a new counter value. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a graphics box type, Edit, Name, and entering a new name.

Syntax

CounterEditName(OldName;NewName)

Parameters

OldName
A character expression specifying the name of a counter value.
NewName
A character expression specifying the new name of a counter value.

Example

To change the name of a user-created graphics box counter type from My Box to Shaded Box, the command is:

CounterEditName("My Box";"Shaded Box")

See Also

CounterIncrement

CounterIncrement increments a specified counter by one. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a counter, Increment.

Syntax

CounterIncrement(Type;Level)

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box increment
TableBoxCounter! 2 Table box increment
TextBoxCounter! 3 Text box increment
UserBoxCounter! 4 User box increment
EquationCounter! 5 Equation box increment
Level
A numeric expression specifying a counter level to increment.

Example

To increment the first level of a table box, the command is:

CounterIncrement(TableBoxCounter!;1)

See Also

CounterSetMethod

CounterSetMethod specifies a numbering method for a counter. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a counter level, Set Method, and selecting a method.

Syntax

CounterSetMethod(Type;Level;Method)

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Level
A numeric expression specifying a counter level for which to specify a numbering method.
Method
Specifies a display type for a counter. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Arabic numbers
LowLetter! 1 Lowercase letters
UpLetter! 2 Uppercase letters
LowRoman! 3 Lowercase roman numerals
UpRoman! 4 Uppercase roman numerals

Example

To specify the second level of a text box as lowercase roman numerals, the command is:

CounterSetMethod(TextBoxCounter!;2;LowRoman!)

CounterSetValue

CounterSetValue sets the value of a counter. This command is the equivalent of choosing Graphics, Graphics Boxes, Create, Options, Caption Options, Counter, highlighting a counter, Set Value, and entering a value.

Syntax

CounterSetValue(Type;{Value})

Parameters

Type
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box
Value
A numeric expression specifying the value of the highlighted counter or counter level. This parameter can contain a value for each level of the specified counter. Parameters which can contain multiple values are enclosed in French braces.

Example

To set the figure box counter level at 5, the command is:

CounterSetValue(FigureCounter!;{5})

CreateSummaryOnSaveExit

CreateSummaryOnSaveExit specifies whether to create a document summary when saving a document. This command is the equivalent of choosing File, Summary, Setup, Create Summary on Exit/Save.

Syntax

CreateSummaryOnSaveExit(State)

Parameters

State
Specifies whether to create a document summary when saving a document. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not create a summary
Yes! 1 Create a summary

Example

To automatically create a document summary when saving a document, the command is:

CreateSummaryOnSaveExit(Yes!)

CrossRefBothReference

CrossRefBothReference marks both a target and a reference. This command is the equivalent of choosing Tools, Cross-Reference, Both, specifying a reference and entering a target name.

Syntax

CrossRefBothReference(Target;Reference;Type)

Parameters

Target
A character expression specifying a target name.
Reference
Specifies a cross-reference location. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RefPage! 0 Page
RefSecondaryPage! 1 Secondary page
RefChapter! 2 Chapter
RefVolume! 3 Volume
RefParagraph! 4 Paragraph
RefFootnote! 5 Footnote
RefEndnote! 6 Endnote
RefBox! 7 Graphics box
RefCounter! 8 Counter
Type (optional)
Specifies a type of counter. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression. This parameter is only used when RefCounter! is specified in the Reference parameter.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box

Example

To mark a page reference with a target named Next, the command is:

CrossRefBothReference("Next";RefPage!)
CrossRefEnterSubstructure
PosPageNext
SubstructureExit
CrossRefBothTarget

See Also

CrossRefBothTarget

CrossRefBothTarget is used in conjunction with CrossRefBothReference to mark both a reference and target and to generate a document. This command is the equivalent of choosing Tools, Cross-Reference, Both, Target Name, typing a target name, choosing OK (the Mark Cross-Reference and Target editing screen opens), moving to the location to insert the target, and pressing Enter.

Syntax

CrossRefBothTarget

Parameters

None.

See Also

CrossRefEnterSubstructure

CrossRefEnterSubstructure enters the Mark Cross-Reference and Target dialog box. This command does not display the dialog box, but rather allows the macro to position the cursor in the appropriate location. This command must be used in conjunction with the SubstructureExit command. This command is the equivalent of choosing Tools, Cross-Reference, Both, specifying a reference type, entering a target name, OK.

Syntax

CrossRefEnterSubstructure

Parameters

None.

See Also

CrossRefMarkBothDlg

CrossRefMarkBothDlg displays the Mark Cross-Reference and Target dialog box. This command is the equivalent of choosing Tools, Cross-Reference, Both.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CrossRefMarkBothDlg

Parameters

None.

CrossRefMarkReference

CrossRefMarkReference specifies a reference mark. This command is the equivalent of choosing Tools, Cross-Reference, Reference, specifying a reference type, and entering a target name.

Syntax

CrossRefMarkReference(Name;Type;Counter)

Parameters

Name
A character expression specifying a reference name.
Type
Specifies what to tie the reference to. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RefPage! 0 Page
RefSecondaryPage! 1 Secondary page
RefChapter! 2 Chapter
RefVolume! 3 Volume
RefParagraph! 4 Paragraph
RefFootnote! 5 Footnote
RefEndnote! 6 Endnote
RefBox! 7 Graphics box
RefCounter! 8 Counter
Counter (optional)
Specifies a counter value. To specify a Corel WordPerfect counter, select an enumerated type or its numeric equivalent. To specify a user-defined counter, use a character expression. This parameter is only used when RefCounter! is specified in the Type parameter.
Enumerated Type Numeric Equivalent Description
None! 0 None
FigureCounter! 1 Figure box
TableBoxCounter! 2 Table box
TextBoxCounter! 3 Text box
UserBoxCounter! 4 User box
EquationCounter! 5 Equation box

Example

To mark a cross-reference named Next and tie it to a secondary page, the command is:

CrossRefMarkReference("Next";RefSecondaryPage!)

CrossRefMarkReferenceDlg

CrossRefMarkReferenceDlg displays the Mark Cross-Reference dialog box. This command is the equivalent of choosing Tools, Cross-Reference, Reference.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CrossRefMarkReferenceDlg

Parameters

None.

CrossRefMarkTarget

CrossRefMarkTarget names a cross-reference target. This command is the equivalent of choosing Tools, Cross-Reference, Target, and entering a target name.

Syntax

CrossRefMarkTarget(Name)

Parameters

Name (optional)
A character expression specifying the name of a cross-reference target.

Example

To define a target named Index, the command is:

CrossRefMarkTarget("Index")

CrossRefMarkTargetDlg

CrossRefMarkTargetDlg displays the Mark Cross-Reference Target dialog box. This command is the equivalent of choosing Tools, Cross-Reference, Target.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

CrossRefMarkTargetDlg

Parameters

None.

CtrlDelKey

CtrlDelKey executes Ctrl+Del and will perform whatever the Ctrl+Del key combination does in the current state of Corel WordPerfect. This does not include situations where the key combination has been remapped in Keyboard Layout. This command is not recordable. To use this command, you must type it into the macro.

Syntax

CtrlDelKey

Parameters

None.

CtrlInsKey

CtrlInsKey performs the function associated with Ctrl+Ins in the current state of Corel WordPerfect. This command is not recordable. To use this command, you must type it into the macro.

Syntax

CtrlInsKey

Parameters

None.

CtrlNumPlus

CtrlNumPlus performs the function associated with Ctrl++ (plus sign on numeric pad) in the current state of Corel WordPerfect. This command is not recordable. To use this command, you must type it into the macro.

Syntax

CtrlNumPlus

Parameters

None.

CursorSpeed

CursorSpeed specifies how fast the cursor moves across the screen. The speed is measured in characters per second. This command is the equivalent of choosing File, Setup, Environment, Cursor Speed, and selecting a speed.

Syntax

CursorSpeed(Speed)

Parameters

Speed
Specifies how fast the cursor moves across the screen when you are using the arrow keys on the keyboard. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Normal! 0 Normal speed
Cps15! 1 15 characters per second
Cps20! 2 20 characters per second
Cps30! 3 30 characters per second
Cps40! 4 40 characters per second
Cps50! 5 50 characters per second

Example

To set the cursor speed at 30 characters per second, the command is:

CursorSpeed(Cps30!)

Cut

Cut moves blocked text to a buffer (a temporary storage area in a computer's memory). This command is the equivalent of choosing Edit, Cut.

Syntax

Cut

Parameters

None.

CutAndPaste

CutAndPaste cuts and pastes blocked text. When this command is encountered, the macro pauses, allows you to move the cursor, then pastes the blocked text when you press Enter. This command is the equivalent of choosing Edit, Cut and Paste.

Syntax

CutAndPaste

Parameters

None.

DateCode

DateCode inserts a code that displays the current date at the cursor position. The date code updates to the current system date whenever the document is opened, retrieved, or reformatted. This command is the equivalent of choosing Tools, Date, Code.

Syntax

DateCode

Parameters

None.

See Also

DateDlg

DateDlg displays the Date dialog box. This command is the equivalent of pressing Shift+F5.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DateDlg

Parameters

None.

See Also

DateFormat

DateFormat specifies a date format for DateCode or DateText. This command must be recorded. This command is the equivalent of choosing Tools, Date, Format, and selecting an option, or Tools, Date, Format, Edit, and defining a Date Format.

Syntax

DateFormat(String)

Parameters

String
Specifies the order of day, month, year, and time codes.

Example

To change a date format to read 31.July 1993, the command is:

DateFormat("[Day#]"+".[Month]"+"[Year(4)#]")

See Also

DateFormatDlg

DateFormatDlg displays the Date Formats dialog box. This command is the equivalent of choosing Tools, Date, Format.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DateFormatDlg

Parameters

None.

See Also

DateText

DateText inserts the system date at the current cursor position. This command is the equivalent of choosing Tools, Date, Text.

Syntax

DateText

Parameters

None.

See Also

DecimalAlignmentCharacter

DecimalAlignmentCharacter specifies a decimal character. This command is the equivalent of choosing Layout, Character, Decimal/Align Character, and entering a character.

Syntax

DecimalAlignmentCharacter(Character)

Parameters

Character
A character expression specifying a decimal alignment character.

Example

To change the decimal character from a period to a comma, the command is:

DecimalAlignmentCharacter(",")

DelayCodes

DelayCodes specifies how many pages to delay specified codes. After using DelayCodes, every subsequent command that references a code will be delayed until a SubstructureExit command is encountered. This command is the equivalent of choosing Layout, Page, Delay Codes, and specifying a number in the Delay Codes dialog box.

Syntax

DelayCodes(Number)

Parameters

Number
A numeric expression specifying how many pages to delay a code.

Example

To delay a specified code for three pages, the command is:

DelayCodes(3)

See Also

DelayCodesDlg

DelayCodesDlg displays the Delay Codes dialog box. This command is the equivalent of choosing Layout, Page, Delay Codes.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DelayCodesDlg

Parameters

None.

See Also

DeleteAppend

DeleteAppend appends the current document or block of text to the specified file. After appending the information, the current file or block will be deleted. This command is not recordable. To use this command, you must type it into the macro.

Syntax

DeleteAppend(Filename)

Parameters

Filename (optional)
A character expression specifying the file to append the current document or block to.

Example

To append the current block of text to a file named HORIZON, the command is:

DeleteAppend("HORIZON")

See Also

DeleteAppendFilenameDlg

DeleteAppendFilenameDlg displays the Append To dialog box. This is different than choosing Edit, Append, To File. This command deletes the current document or blocked text after appending to the specified file. This command is not recordable. To use this command, you must type it into the macro.

Syntax

DeleteAppendFilenameDlg

Parameters

None.

See Also

DeleteCharNext

DeleteCharNext in Text Mode deletes the character at the cursor. In Graphics Mode, this command deletes the character to the right of the cursor. This command is the equivalent of pressing Delete.

Syntax

DeleteCharNext

Parameters

None.

DeleteCharPrevious

DeleteCharPrevious deletes the character to the left of the cursor. This command is the equivalent of pressing Backspace.

Syntax

DeleteCharPrevious

Parameters

None.

DeleteToBeginningOfWord

DeleteToBeginningOfWord deletes all characters to the left of the cursor in the current word. This command is the equivalent of pressing Home, Backspace.

Syntax

DeleteToBeginningOfWord

Parameters

None.

DeleteToEndOfLine

DeleteToEndOfLine deletes all characters from the cursor to the end of the current line. This command does not delete HardReturns or HardPageBreaks. This command is the equivalent of pressing Ctrl+End.

Syntax

DeleteToEndOfLine

Parameters

None.

DeleteToEndOfPage

DeleteToEndOfPage deletes all characters from the cursor to the end of the current page. This command is the equivalent of pressing Ctrl+Page Down, Yes.

Syntax

DeleteToEndOfPage

Parameters

None.

DeleteToEndOfPageDlg

DeleteToEndOfPageDlg displays the Delete Remainder of Page dialog box. This command is the equivalent of pressing Ctrl+Page Down.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DeleteToEndOfPageDlg

Parameters

None.

DeleteToEndOfWord

DeleteToEndOfWord deletes all characters from the cursor to the beginning of the next word. This command is the equivalent of pressing Home, Delete.

Syntax

DeleteToEndOfWord

Parameters

None.

DeleteWord

DeleteWord deletes the current word or space. This command is the equivalent of pressing Ctrl+Backspace.

Syntax

DeleteWord

Parameters

None.

DirectoryCreate

DirectoryCreate creates a directory at DOS. This command is the equivalent of pressing F5, Enter, choosing Change Default Dir, and entering the directory you want to create.

Syntax

DirectoryCreate(Name)

Parameters

Name
A character expression specifying a name of the directory to create.

Example

To create a directory named PERSONAL on the C: drive, the command is:

DirectoryCreate("C:\PERSONAL")

DirectoryDefault

DirectoryDefault temporarily changes the default directory. After exiting Corel WordPerfect, the default returns to the directory specified for Documents in Location of Files. This command is the equivalent of choosing File, File Manager, pressing the equal sign (=), and entering a directory.

Syntax

DirectoryDefault(Name)

Parameters

Name
A character expression specifying a default directory.

Example

To change the default directory to C:\COREL\WP62\MACROS, the command is:

DirectoryDefault("C:\COREL\WP62\MACROS")

DirectoryRemove

DirectoryRemove removes an empty directory at DOS. This command is the equivalent of choosing File, File Manager, OK, highlighting a directory, and choosing Delete, Yes.

Syntax

DirectoryRemove(Name)

Parameters

Name
A character expression specifying an empty DOS directory to remove.

Example

To remove an empty directory named C:\TEMP, the command is:

DirectoryRemove("C:\TEMP")

DisplayListMode

DisplayListMode specifies a display mode for File Manager files. This command is the equivalent of choosing File, File Manager, OK, Setup, and selecting a Display List Mode.

Syntax

DisplayListMode(State)

Parameters

State
Specifies a display mode for File Manager. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DOSFilenames! 1 Display DOS filenames
DescriptiveNames! 2 Display descriptive names

Example

To display descriptive names in File Manager, the command is:

DisplayListMode(DescriptiveNames!)

DisplayMode

DisplayMode specifies a display mode. This command is the equivalent of choosing View, Text Mode, Graphics Mode or Page Mode.

Syntax

DisplayMode(State)

Parameters

State
Specifies a document display mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Text! 1 Text mode
Graphics! 2 Graphical mode
FullPage! 3 Graphical mode with headers, footer, page numbers, and margins

Example

To specify Page Mode display, the command is:

DisplayMode(FullPage!)

DisplayOnStatusLine

DisplayOnStatusLine specifies elements to display on the left side of the status line. This command is the equivalent of choosing View, Screen Setup, Window Options, Status Line, selecting Filename, Font, or Nothing.

Syntax

DisplayOnStatusLine(Choice)

Parameters

Choice
Specifies display elements for the status line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Nothing! 0 Nothing in the bottom left corner of the window
Filename! 1 Filename
Font! 2 Font

Example

To display the filename of a document on the status line, the command is:

DisplayOnStatusLine(Filename!)

DisplayPitch

DisplayPitch specifies character width on the screen. This command is the equivalent of choosing Layout, Document, Display Pitch.

Syntax

DisplayPitch(State;Width)

Parameters

State
Specifies either an automatic or manual display pitch. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Automatic! 0 Predetermined
Manual! 1 User-defined
Width
A measurement expression specifying the constant width of each character displayed on the screen. Width ranges from 0.025" to 0.5".

Example

To specify a manual display pitch of 0.2", the command is:

DisplayPitch(Manual!;0.2")

DisplayRewrite

DisplayRewrite rewrites the document screen. This command is the equivalent of pressing Ctrl+F3, Rewrite.

Syntax

DisplayRewrite

Parameters

None.

See Also

DisplaySetupDlg

DisplaySetupDlg displays the Display dialog box. This command is the equivalent of choosing File, Setup, Display.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DisplaySetupDlg

Parameters

None.

DisplayUnits

DisplayUnits specifies a method used to display units of measure. This command is the equivalent of choosing File, Setup, Environment, Units of Measure, Display/Entry of Numbers.

Syntax

DisplayUnits(State)

Parameters

State
Specifies a measurement mode to display numeric entries. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Inches! 0 Inches (")
InchesI! 1 Inches (i)
Centimeters! 2 Centimeters
Millimeters! 3 Millimeters
Points! 4 Points
WP1200ths! 5 1200ths of an inch
WP42Units! 6 80 columns by 24 rows

Example

To specify millimeters as the unit of measure, the command is:

DisplayUnits(Millimeters!)

See Also

DisplayZoom

DisplayZoom specifies the graphic display of a current document screen. This command is only available in Graphics Mode. This command is the equivalent of choosing View, Zoom, Margin Width, Page Width or Full Page.

Syntax

DisplayZoom(State)

Parameters

State
Specifies a zoom mode to display. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ZoomMarginWidth! 0 Screen extends to match the left and right margins
ZoomPageWidth! 1 Screen displays the actual margins
ZoomFullPage! 2 Full page screen

Example

To zoom a graphic mode document screen to the current page width, the command is:

DisplayZoom(ZoomPageWidth!)

See Also

DisplayZoomSetup

DisplayZoomSetup specifies a default graphic display. This command is not available in Text Mode. This command is the equivalent of choosing View, Screen Setup, Zoom, and Margin Width, Page Width or Full Page.

Syntax

DisplayZoomSetup(State)

Parameters

State
Specifies a default zoom state to display. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ZoomMarginWidth! 0 Left and right screen edges match margins
ZoomPageWidth! 1 Screen displays the actual margins within the boundaries of the document screen
ZoomFullPage! 2 Full page

Example

To display the page width including margins from one edge of the screen to another, the command is:

DisplayZoomSetup(ZoomPageWidth!)

See Also

DocCompare

DocCompare compares the current document with a specified document using redline and strikeout to mark changes. This command is the equivalent of choosing File, Compare Documents, Add Markings, entering a filename, and specifying a comparison type.

Syntax

DocCompare(Filename;Type)

Parameters

Filename
A character expression specifying the name of a document to which the current document is compared.
Type
Specifies the scope of comparison between the specified document and the document on screen. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Phrase! 0 Phrase changes
Word! 1 Word changes
Sentence! 2 Sentence changes
Paragraph! 3 Paragraph changes

Example

To compare the current document with a document named ORIGINAL sentence for sentence, the command is:

DocCompare("ORIGINAL";Sentence!)

See Also

DocCompareDlg

DocCompareDlg displays the Compare Documents dialog box. This command is the equivalent of choosing File, Compare Documents, Add Markings.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocCompareDlg

Parameters

None.

See Also

DocCompareRemoveRedline

DocCompareRemoveRedline either removes strikeout and redline codes as well as strikeout text; or removes strikeout codes and text, retaining redline codes. This command is the equivalent of choosing File, Compare Documents, Remove Markings, and specifying the codes to remove.

Syntax

DocCompareRemoveRedline(Choice)

Parameters

Choice
Specifies whether to remove text contained within strikeout and redline codes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RemoveAll! 0 Remove the strikeout codes and text and redline codes; retain redline text
LeaveRedline! 1 Retain redline codes and text

Example

To remove redline and strikeout codes and strikeout text, the command is:

DocCompareRemoveRedline(RemoveAll!)

See Also

DocCompareRemoveRedlineDlg

DocCompareRemoveRedlineDlg displays the Remove Markings dialog box. This command is the equivalent of choosing File, Compare Documents, Remove Markings.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocCompareRemoveRedlineDlg

Parameters

None.

See Also

DocInformation

DocInformation displays document information for the current document or block of text. This command is the equivalent of choosing Tools, Writing Tools, Document Information.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocInformation

Parameters

None.

DocInitialFont

DocInitialFont specifies a default document font. This command is the equivalent of choosing Layout, Document, Initial Font, and selecting a font and point size.

Syntax

DocInitialFont(Name;Size;Family;Attributes;Weight;Width;Source;Type)

Parameters

Name
A character expression specifying a font name.
Size (optional)
A numeric expression specifying a font point size.
Family (optional)
Specifies a font family. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FamilyITCBenguiat! 256 ITC Benguiat
FamilyTimesRoman! 2304 Times Roman
FamilyITCGaramond! 4352 ITC Garamond
FamilyCenturySchoolbook! 6400 Century Schoolbook
FamilyBodoni! 8448 Bodoni
FamilyITCLubalinGraph! 10496 ITC Lubalin Graph
FamilyAlbertus! 12544 Albertus
FamilyCourier! 14592 Courier
FamilyHelvetica! 16640 Helvetica
FamilyITCRonda! 18688 ITC Ronda
FamilyMicrostyle! 20736 Microstyle
FamilyOptima! 22784 Optima
FamilyLetterGothic! 24832 Letter Gothic
FamilyBrush! 26880 Brush
FamilyParkAvenue! 28928 Park Avenue
FamilySignetRoundhand! 30976 Signet Roundhand
FamilyTekton! 33024 Tekton
FamilyUncial! 35072 Uncial
FamilyOldEnglish! 37120 Old English
FamilyITCZapfDingbats! 39168 ITC Zapf Dingbats
FamilyBroadway! 41216 Broadway
FamilyComputer! 43264 Computer
FamilyPTBarnum! 45312 PT Barnum
FamilyPonderosa! 47360 Ponderosa
FamilyMadrone! 49408 Madrone
FamilyHobo! 51456 Hobo
FamilyRevue! 53504 Revue
FamilyAestheticOrnamented! 55552 Aesthetic Ornamented
Attributes (optional)
Specifies font attributes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FontMatchNormal! 0 Normal
FontMatchItalic! 1 Italic
FontMatchOutline! 2 Outline
FontMatchShadow! 4 Shadow
FontMatchSmallCaps! 8 Small caps
Weight (optional)
Specifies font weight. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WeightUnknown! 0 Unknown
WeightUltraThin! 1 Ultra Thin
WeightUltraLight! 8 Ultra Light
WeightExtraThin! 16 Extra Thin
WeightThin! 24 Thin
WeightExtraLight! 32 Extra Light
WeightLight! 48 Light
WeightDemiLight! 64 Demi Light
WeightSemiLight! 80 Semi Light
WeightBook! 88 Book
WeightRegular! 96 Regular
WeightRoman! 104 Roman
WeightMedium! 112 Medium
WeightDemiBold! 128 Demi Bold
WeightSemiBold! 136 Semi Bold
WeightBold! 144 Bold
WeightExtraBold! 160 Extra Bold
WeightHeavy! 176 Heavy
WeightExtraHeavy! 192 Extra Heavy
WeightBlack! 208 Black
WeightExtraBlack! 224 Extra Black
WeightUltraHeavy! 240 Ultra Heavy
WeightUltraBlack! 248 Ultra Black
WeightMaximum! 254 Maximum
Width (optional)
Specifies font width. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WidthUnknown! 0 Unknown
WidthUltraCondensed! 16 Ultra Condensed
WidthExtraCompressed! 32 Extra Compressed
WidthCompressed! 48 Compressed
WidthExtraCondensed! 64 Extra Condensed
WidthCondensed! 80 Condensed
WidthSemiCondensed! 96 Semi Condensed
WidthNormal! 112 Normal
WidthSemiExpanded! 128 Semi Expanded
WidthExpanded! 144 Expanded
WidthExtraExpanded! 160 Extra Expanded
WidthUltraExpanded! 176 Ultra Expanded
WidthDoubleWide! 192 Double Wide
WidthTripleWide! 224 Triple Wide
Source (optional)
Specifies a font file. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PRSFile! 16 .PRS file
DRSFile! 20 .DRS file
Type (optional)
Specifies a font type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Speedo! 134 Speedo
Intellifont! 135 Intellifont
Type1! 138 Type 1
TrueType! 139 True Type
Set (optional)
Specifies a Corel WordPerfect Character set. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FontMatchASCII! 0 ASCII
FontMatchMultinational1! 1 Multinational 1
FontMatchMultinational2! 2 Multinational 2
FontMatchBoxDrawing! 3 Box Drawing
FontMatchTypographicSymbols! 4 Typographic Symbols
FontMatchIconicSymbols! 5 Iconic Symbols
FontMatchMath! 6 Math
FontMatchMathExtension! 7 Math Extension
FontMatchGreek! 8 Greek
FontMatchHebrew! 9 Hebrew
FontMatchCyrillic! 10 Cyrillic
FontMatchJapaneseKana! 11 Japanese Kana
FontMatchUserDefined! 12 User-defined
FontMatchArabic! 13 Arabic
FontMatchArabicScript! 14 Arabic Script

Example

To select CG Times 12pt as a document default font, the command is:

DocInitialFont("CG Times";12)

DocSummaryDelete

DocSummaryDelete deletes the document summary of the current document. This command is the equivalent of choosing Layout, Document, Summary, Delete, Yes.

Syntax

DocSummaryDelete

Parameters

None.

DocSummaryDescriptiveTypeSetup

DocSummaryDescriptiveTypeSetup defines a default descriptive type for all subsequent document summaries. This command is the equivalent of choosing Layout, Document, Summary, Setup, Default Descriptive Type, and entering a description.

Syntax

DocSummaryDescriptiveTypeSetup(String)

Parameters

String
A character expression specifying a default descriptive type for all subsequent document summaries.

Example

To define "Personal Primary Files" as the default descriptive type, the command is:

DocSummaryDescriptiveTypeSetup("Personal Primary Files")

DocSummaryDlg

DocSummaryDlg displays the Document Summary dialog box. This command is the equivalent of choosing File, Summary.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocSummaryDlg

Parameters

None.

DocSummaryExtract

DocSummaryExtract extracts the document summary from the current document. This command is the equivalent of choosing File, Summary, Extract, Yes.

Syntax

DocSummaryExtract

Parameters

None.

DocSummaryField

DocSummaryField defines a field. This command is the equivalent of choosing Layout, Document, Summary, and adding text to fields.

Syntax

DocSummaryField(Field;Text)

Parameters

Field
Defines a document summary field. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Abstract! 1 Abstract field
Account! 2 Account field
Address! 3 Address field
Attachments! 4 Attachments field
Author! 5 Author field
Authorization! 6 Authorization field
BillTo! 7 Bill to field
BlindCopy! 8 Blind copy field
CarbonCopy! 9 Carbon copy field
Category! 10 Category field
CheckedBy! 11 Checked by field
Client! 12 Client field
Comments! 13 Comments field
CreationDate! 14 Creation date field
DateCompleted! 15 Date completed field
Department! 16 Department field
DescriptiveName! 17 Descriptive name field
DescriptiveType! 18 Descriptive type field
Destination! 19 Destination field
Disposition! 20 Disposition field
Division! 21 Division field
DocNumber! 22 Document number field
Editor! 23 Editor field
ForwardTo! 24 Forward to field
Group! 25 Group field
Keywords! 26 Keywords field
Language! 27 Language field
MailStop! 28 Mail stop field
Matter! 29 Matter field
Office! 30 Office field
Owner! 31 Owner field
Project! 32 Project field
Publisher! 33 Publisher field
Purpose! 34 Purpose field
ReceivedFrom! 35 Received from field
RecordedBy! 36 Recorded by field
RecordedDate! 37 Recorded date field
Reference! 38 Reference field
RevisionDate! 39 Revision date field
RevisionNotes! 40 Revision notes field
RevisionNumber! 41 Revision number field
Section! 42 Section field
Security! 43 Security field
Source! 44 Source field
Status! 45 Status field
Subject! 46 Subject field
TelephoneNumber! 47 Telephone number field
Typist! 48 Typist field
VersionDate! 49 Version date field
VersionNotes! 50 Version notes field
VersionNumber! 51 Version number field
Text
A character expression defining the contents of the specified document summary field. To enter a date in the Creation Date field, enter the month, day, and year, separated by slashes (9/9/99 or 09/09/1999). For the time, enter the complete time (10:00a and not 10a for 10:00 a.m.).

Example

To enter JD in the Typist field, the command is:

DocSummaryField(Typist!;"JD")

See Also

DocSummaryFieldOrder

DocSummaryFieldOrder changes the sequence of document summary fields. This command is the equivalent of choosing Layout, Document, Summary, Select Fields, highlighting fields, then selecting Move, Remove, or Add.

Syntax

DocSummaryFieldOrder(Documents;{Fields})

Parameters

Documents
Specifies documents to contain changed field order. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDocument! 1 Current document
NewDocuments! 2 Subsequent documents only
Both! 3 Current and new documents
Fields
Specifies fields and the order in which they are displayed in a document summary. Enclose repeating parameters in French braces. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Abstract! 1 Abstract field
Account! 2 Account field
Address! 3 Address field
Attachments! 4 Attachments field
Author! 5 Author field
Authorization! 6 Authorization field
BillTo! 7 Bill to field
BlindCopy! 8 Blind copy field
CarbonCopy! 9 Carbon copy field
Category! 10 Category field
CheckedBy! 11 Checked by field
Client! 12 Client field
Comments! 13 Comments field
CreationDate! 14 Creation date field
DateCompleted! 15 Date completed field
Department! 16 Department field
DescriptiveName! 17 Descriptive name field
DescriptiveType! 18 Descriptive type field
Destination! 19 Destination field
Disposition! 20 Disposition field
Division! 21 Division field
DocNumber! 22 Document number field
Editor! 23 Editor field
ForwardTo! 24 Forward to field
Group! 25 Group field
Keywords! 26 Keywords field
Language! 27 Language field
MailStop! 28 Mail stop field
Matter! 29 Matter field
Office! 30 Office field
Owner! 31 Owner field
Project! 32 Project field
Publisher! 33 Publisher field
Purpose! 34 Purpose field
ReceivedFrom! 35 Received from field
RecordedBy! 36 Recorded by field
RecordedDate! 37 Recorded date field
Reference! 38 Reference field
RevisionDate! 39 Revision date field
RevisionNotes! 40 Revision notes field
RevisionNumber! 41 Revision number field
Section! 42 Section field
Security! 43 Security field
Source! 44 Source field
Status! 45 Status field
Subject! 46 Subject field
TelephoneNumber! 47 Telephone number field
Typist! 48 Typist field
VersionDate! 49 Version date field
VersionNotes! 50 Version notes field
VersionNumber! 51 Version number field

Example

To change the document summary fields of the current document to the following order, the command is:

DocSummaryFieldOrder(CurrentDocument!; {Account!; Abstract!; Keywords!; Author!; Subject!; Descriptive Name!; Typist!; CreationDate!; Descriptive Type!; Revision Date!})

See Also

DocSummaryPrint

DocSummaryPrint prints a file document summary. If no file is specified, the summary of the current document is printed. This command is the equivalent of choosing Layout, Document, Summary, Print, Yes.

Syntax

DocSummaryPrint(Filename)

Parameters

Filename (optional)
A character expression specifying a file document summary to print. If this parameter is omitted, the document summary of the current file is printed.

Example

To print the document summary of a file named SUMMARY, the command is:

DocSummaryPrint("C:\COREL\WP62\SUMMARY")

DocSummarySave

DocSummarySave saves a document summary as a file. This command is the equivalent of choosing Layout, Document, Summary, Save, Yes, entering a filename, and selecting Replace or Append if the file already exists.

Syntax

DocSummarySave(Filename;Choice;Source)

Parameters

Filename
A character expression specifying the name of the document to which the specifed document summary will be saved or appended.
Choice
Specifies options if a specified file already exists. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Append! 0 Appends summary to existing file
Replace! 1 Replaces existing file with document summary
Source (optional)
Specifies a file containing a document summary. If this parameter is omitted, the source file is the current document.

Example

To append the document summary of a current document to a file named SUMMARY, the command is:

DocSummarySave("SUMMARY";Append!)

DocSummarySelectDlg

DocSummarySelectDlg displays the Select Summary Fields dialog box. This command is the equivalent of choosing Layout, Document, Summary, Select Fields.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocSummarySelectDlg

Parameters

None.

DocSummarySetupDlg

DocSummarySetupDlg displays the Document Summary Setup dialog box. This command is the equivalent of choosing File, Summary, Setup.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

DocSummarySetupDlg

Parameters

None.

DOSCommand

DOSCommand initiates a DOS command from within Corel WordPerfect. This command is the equivalent of choosing File, Go To Shell, DOS Command and entering a DOS command.

Syntax

DOSCommand(Command)

Parameters

Command
A character expression specifying a DOS command.

Example

To list all files in C:\, the command is:

DOSCommand("dir c:\")

DotLeader

DotLeader specifies a dot leader character and a number of spaces between each character. This command is the equivalent of choosing Layout, Character, Dot Leader Character, entering a character, Spaces Between Dots, and entering a number.

Syntax

DotLeader(Character;Spaces)

Parameters

Character
A character expression specifying a dot leader character.
Spaces
Specifies a number of spaces between visible dot leader characters.

Example

To specify a comma (,) dot leader character with five spaces between each character, the command is:

DotLeader(",";5)

DoubleSidedPrint

DoubleSidedPrint turns on or off Double-sided Printing and selects a binding edge. This command is the equivalent of choosing Layout, Page, Double-sided Printing, and selecting a binding edge (or none).

Syntax

DoubleSidedPrint(Print)

Parameters

Print
Determines whether to turn on Double-sided Printing, and selects a binding edge. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 None
LongEdge! 1 Long Edge
ShortEdge! 3 Short Edge

Example

To turn on Double-sided Printing and select a short edge for binding, the command is:

DoubleSidedPrint(ShortEdge!)

DoubleSmartQuote

DoubleSmartQuote turns the Double Smart Quote feature on or off and specifies quote characters. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, selecting Turn on Double Quotes, then specifiying quote characters.

Syntax

DoubleSmartQuote(State;OpeningDoubleQuote;ClosingDoubleQuote)

Parameters

State
Specifies whether the Double Smart Quotes feature is on or off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Turns on Double Smart Quotes
On! 1 Turns off Double Smart Quotes
OpeningDoubleQuote (optional)
A numeric expression specifying the numeric equivalent of a quote character.
ClosingDoubleQuote (optional)
A numeric expression specifying the numeric equivalent of a quote character.

Example

To specify " as the double quote characters, the command is:

DoubleSmartQuote(On!;34;34)

DownArrow

DownArrow moves an equation down in the View Equation Window of the Equation Editor. This command is the equivalent of pressing Down Arrow () while in the View Equation Window. This command is not recordable. To use this command you must type it in the macro. Outside of the View Equation window, pressing Down Arrow records PosLineDown.

Syntax

DownArrow

Parameters

None.

See Also

DropCapBegin

DropCapBegin begins the creation or editing of a drop cap. This command is the equivalent of choosing Font, Drop Cap.

Syntax

DropCapBegin

Parameters

None.

See Also

DropCapBorderDlg

DropCapBorderDlg displays the Drop Cap Border dialog box. This command is the equivalent of choosing Font, Drop Cap, Edit, Border/Fill.

To record this command, choose Font, Drop Cap, Edit, Border/Fill to display the dialog box, then select the check box with your mouse or by pressing Ctrl+m. The check box is located in the upper right corner of the dialog box and is only visible while recording a macro. After selecting the check box, choose Cancel to close the dialog box.

Syntax

DropCapBorderDlg

Parameters

None.

See Also

DropCapBorderStyle

DropCapBorderStyle specifies a drop cap border style. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Border/Fill, and specifying border style.

Syntax

DropCapBorderStyle(Name)

Parameters

Name
Specifies a border style. Select an enumerated type or its numeric equivalent or use a character expression to specify a user-defined style.
Enumerated Type Numeric Equivalent Description
ButtonBorder! 10 Button Border style
ColumnBorderAll! 12 Borders around all columns
ColumnBorderBetween! 11 Lines between columns
DashedBorder! 3 Dashed Border style
DottedBorder! 4 Dotted Border style
DoubleBorder! 2 Double-line border
ExtraThickBorder! 6 Extra Thick border line
NoBorder! 127 No borders
SingleBorder! 1 Single-line border
SpacingOnly! 0 Spacing without lines
ThickBorder! 5 Thick-line border
ThickThinBorder! 8 Thick Thin Border style
ThickTopBottomBorder! 9 Thick Top Bottom Border style
ThinThickBorder! 7 Thin Thick Border style

Example

To specify a double border as the drop cap border style, the command is:

DropCapBorderStyle(DoubleBorder!)

See Also

DropCapCharacters

DropCapCharacters specifies the number of characters to include in a drop cap. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Number of Characters to Drop, then specifying a number.

Syntax

DropCapCharacters(Number)

Parameters

Number
A numeric expression specifying the number of characters to include in a drop cap. Specifying 0 will drop an entire word.

Example

To include three characters in a drop cap, the command is:

DropCapBegin
DropCapCharacters(3)
DropCapEnd(Save!)

See Also

DropCapCharacterSize

DropCapCharacterSize specifies the height of a drop cap. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Height in Lines.

Syntax

DropCapCharacterSize(Size)

Parameters

Size
A numeric expression specifying, in text lines, the height of a drop cap.

Example

To specify four text lines as the height of a drop cap, the command sequence is:

DropCapBegin
DropCapCharacterSize(4)
DropCapEnd(Save!)

See Also

DropCapCustomDlg

DropCapCustomDlg displays the Edit Drop Cap Definition dialog box. This command is the equivalent of choosing Font, Drop Cap, Edit.

To record this command, choose Font, Drop Cap, Edit to display the dialog box, then select the check box with your mouse or by pressing Ctrl+m. The check box is located in the upper right corner of the dialog box and is only visible while recording a macro. After selecting the check box, choose Cancel to close the dialog box.

Syntax

DropCapCustomDlg

Parameters

None.

See Also

DropCapDlg

DropCapDlg displays the Drop Cap dialog box. This command is the equivalent of choosing Font, Drop Cap.

To record this command, choose Font, Drop Cap to display the dialog box, then select the check box with your mouse or by pressing Ctrl+m. The check box is located in the upper right corner of the dialog box and is only visible while recording a macro. After selecting the check box, choose Cancel to close the dialog box.

Syntax

DropCapDlg

Parameters

None.

See Also

DropCapEnd

DropCapEnd ends a drop cap editing or creating sequence and saves or cancels changes. This command is used in combination with DropCapBegin and drop cap editing commands such as DropCapCharacters. This command is the equivalent of choosing Font, Drop Cap, Edit, making selections or changes, then choosing OK or Cancel.

Syntax

DropCapEnd(State)

Parameters

State
Specifies whether to save or cancel changes made to a drop cap. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancels changes to drop cap
Save! 1 Saves changes to drop cap

Example

To save editing changes to a drop cap, the command is:

DropCapEnd(Save!)

See Also

DropCapFillStyle

DropCapFillStyle specifies the drop cap fill style. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Border/Fill, then specifying a fill style.

Syntax

DropCapFillStyle(Fill Style Name)

Parameters

State
Specifies a drop cap fill style. Select an enumerated type or its numeric equivalent or use a character expression to specify a user-defined style.
Enumerated Type Numeric Equivalent Description
Fill10! 0 10% fill shading
Fill20! 1 20% fill shading
Fill30! 2 30% fill shading
Fill40! 3 40% fill shading
Fill50! 4 50% fill shading
Fill60! 5 60% fill shading
Fill70! 6 70% fill shading
Fill80! 7 80% fill shading
Fill90! 8 90% fill shading
Fill100! 9 Black fill
FillButton! 10 Button fill shading
NoFill! 127 No fill

Example

To specify a drop cap with no fill, the command sequence is:

DropCapBegin
DropCapFillStyle(NoFill!)
DropCapEnd(Save!)

See Also

DropCapFontDlg

DropCapFontDlg displays the Drop Cap Font dialog box. This command is the equivalent of choosing Font, Drop Cap, Edit, Font.

To record this command, choose Font, Drop Cap, Edit, Font to display the dialog box, then select the check box with your mouse or by pressing Ctrl+m. The check box is located in the upper right corner of the dialog box and is only visible while recording a macro. After selecting the check box, choose Cancel to close the dialog box.

Syntax

DropCapFontDlg

Parameters

None.

See Also

DropCapHorizontalAdjustment

DropCapHorizontalAdjustment specifies What percentage of a drop cap is located in the margin. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Move Into Margin (Percent), then specifying a percentage.

Syntax

DropCapHorizontalAdjustment(Adjustment)

Parameters

Adjustment
A numeric expression representing what percentage of a drop cap is located in the margin.

Example

To specify that fifty percent of a drop cap should be in the margin, the command sequence is:

DropCapBegin
DropCapHorizontalAdjustment(50)
DropCapEnd(Save!)

See Also

DropCapIncludeDescender

DropCapIncludeDescender specifies whether to allow space for descending characters in a drop cap. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Allow for Descender.

Syntax

DropCapIncludeDescender(State)

Parameters

State
Specifies whether to allow space for descending characters in a drop cap. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No space for descender
Yes! 1 Allow space for descender

Example

To allow space for descending characters in a drop cap, the command sequence is:

DropCapBegin
DropCapIncludeDescender(Yes!)
DropCapEnd(Save!)

See Also

DropCapIncludeDiacritic

DropCapIncludeDiacritic specifies whether to allow space for diacritical marks in a drop cap. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Allow for Diacritic.

Syntax

DropCapIncludeDiacritic(State)

Parameters

State
Specifies whether to allow space for diacritical marks in a drop cap. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No space for diacritic
Yes! 1 Allow space for diacritic

Example

To allow space for diacritical marks in a drop cap, the command sequence is:

DropCapBegin
DropCapIncludeDiacritic(Yes!)
DropCapEnd(Save!)

See Also

DropCapKerning

DropCapKerning adjusts the spacing between a drop cap and paragraph text. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Shift Text Left/Right, choosing a direction, then specifying an amount.

Syntax

DropCapKerning(Adjustment)

Parameters

Adjustment
A numeric expression specifying the spacing adjustment between a drop cap and paragraph text.

Example

To move a drop cap .01", the command sequence is:

DropCapBegin
DropCapKerning(0.01")
DropCapEnd(Save!)

See Also

DropCapNoWrap

DropCapNoWrap specifies whether text wraps around a drop cap. If text does not wrap around a drop cap, it prints over it. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Wrap Text Around Drop Cap.

Syntax

DropCapNoWrap(State)

Parameters

State
Specifies whether text wraps around a drop cap. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Text wrapping
Yes! 1 No text wrapping

Example

To specify that text does not wrap around a drop cap, the command sequence is:

DropCapBegin
DropCapNoWrap(Yes!)
DropCapEnd(Save!)

See Also

DropCapOff

DropCapOff turns off the drop cap feature or deletes the drop cap in the current paragraph. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Off.

Syntax

DropCapOff

Parameters

None.

See Also

DropCapUsePrevious

DropCapUsePrevious duplicates the previous drop cap and inserts it at the beginning of the current paragraph. This command is the equivalent of choosing Font, Drop Cap, Use Previous.

Syntax

DropCapUsePrevious

Parameters

None.

DropCapVerticalAdjustment

DropCapVerticalAdjustment specifies the number of blank lines between a drop cap and the subsequent paragraph text. This command is used in combination with DropCapBegin and DropCapEnd. This command is the equivalent of choosing Font, Drop Cap, Edit, Adjust Paragraph Text Down (Lines), choosing a direction, then specifying the number of lines.

Syntax

DropCapVerticalAdjustment(Adjustment)

Parameters

Adjustment
A numeric expression specifying the number of blank lines between a drop cap and subsequent text in a paragraph.

Example

To specify two blank lines between a drop cap and paragraph text, the command sequence is:

DropCapBegin
DropCapVerticalAdjustment(2.0)
DropCapEnd(Save!)

See Also

DuplicateCodesAllow

By default, Corel WordPerfect duplicates codes. For example, if the right margin is set to one inch and you reset it to one inch, Corel WordPerfect inserts a duplicate right margin code. With this option active, Corel WordPerfect inserts codes even when they duplicate existing conditions.

Syntax

DuplicateCodesAllow(State)

Parameters

State
Specifies whether Corel WordPerfect duplicates codes that do not change existing conditions. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No code duplication
Yes! 1 Code duplication

Example

To specify that Corel WordPerfect inserts codes even when they duplicate existing conditions, the command is:

DuplicateCodesAllow(Yes!)

EditCodeRight

EditCodeRight performs the same function as pressing Ctrl+E or double-clicking on a code in Reveal Codes to edit the code content or format setting(s). The cursor needs to be on the code for the code to be edited.

Syntax

EditCodeRight

Parameters

None.

EndCenterOrAlignment

EndCenterOrAlignment places an End Centering/Alignment code at the cursor. This command is the equivalent of choosing Layout, Other, End Centering/Alignment.

Syntax

EndCenterOrAlignment

Parameters

None.

EndField

EndField places an ENDFIELD merge code at the cursor. This command is the equivalent of pressing F9.

Syntax

EndField

Parameters

None.

See Also

EndFieldKey

EndFieldKey is the equivalent of pressing F9. EndFieldKey will execute whatever the F9 key is designed to do in the current state of Corel WordPerfect. This does not include situations where F9 has been remapped in Keyboard Layout. EndFieldKey is not recordable. To use this command, you must type it into the macro.

Syntax

EndFieldKey

Parameters

None.

See Also

EndnoteCreate

EndnoteCreate displays an Endnote editing screen. This command is the equivalent of choosing Layout, Endnote, Create.

Syntax

EndnoteCreate

Parameters

None.

See Also

EndnoteEdit

EndnoteEdit displays the Endnote editing screen. If no endnote number is specified, the first endnote to the right of the cursor is edited. If no endnote is found to the right, a Not Found condition is generated. This command is the equivalent of choosing Layout, Endnote, Edit, and specifying an endnote number.

Syntax

EndnoteEdit (Endnote Number)

Parameters

Endnote Number (optional)
A numeric expression specifying an endnote to edit. If this parameter is not specified, the next endnote is edited.

Example

To edit the second endnote of a document, the command is:

EndnoteEdit(2)

See Also

EndnoteEditDlg

EndnoteEditDlg displays the Endnote Number dialog box. This command is the equivalent of choosing Layout, Endnote, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EndnoteEditDlg

Parameters

None.

See Also

EndnoteMinimum

EndnoteMinimum specifies the amount of endnote text to keep together. This command is the equivalent of choosing Layout, Endnote, Options, Minimum Amount of Endnote to Keep Together, and specifying an amount.

Syntax

EndnoteMinimum(Measurement)

Parameters

Measurement
A measurement expression specifying the amount of endnote text to keep together. The default is .5".

Example

To keep at least .75" of endnote text together on each page, the command is:

EndnoteMinimum(.75")

See Also

EndnoteNewNumber

EndnoteNewNumber specifies a new starting number for endnotes. This command is the equivalent of choosing Layout, Endnote, New Number, New Number, and entering a new number.

Syntax

EndnoteNewNumber(Number)

Parameters

Number
A numeric expression specifying a new starting endnote number.

Example

To start endnote numbering at 7, the command is:

EndnoteNewNumber(7)

See Also

EndnoteNumberDecrement

EndnoteNumberDecrement decreases the endnote number by one. This command is the equivalent of choosing Layout, Endnote, New Number, Decrement Number.

Syntax

EndnoteNumberDecrement

Parameters

None.

See Also

EndnoteNumberDisplay

EndnoteNumberDisplay copies the current endnote number into a document at the cursor position. This command is the equivalent of choosing Layout, Endnote, New Number, Display in Document.

Syntax

EndnoteNumberDisplay

Parameters

None.

See Also

EndnoteNumberIncrement

EndnoteNumberIncrement increases the endnote number by one. This command is the equivalent of choosing Layout, Endnote, New Number, Increment Number.

Syntax

EndnoteNumberIncrement

Parameters

None.

See Also

EndnoteNumberMethod

EndnoteNumberMethod selects an endnote numbering method. This command is the equivalent of choosing Layout, Endnote, New Number, Numbering Method, and selecting a numbering method.

Syntax

EndnoteNumberMethod(Numbering Method;Character)

Parameters

Numbering Method
Specifies an endnote numbering method. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Numbers
LowerLetters! 1 Lowercase letters
UpperLetters! 2 Uppercase letters
LowerRoman! 3 Lowercase Roman numerals
UpperRoman! 4 Uppercase Roman numerals
Characters! 5 Characters
Character (optional)
A character expression specifying a character(s) to use as the endnote numbering method. Used when Characters! is used in the first parameter.

Example

To specify the asterisk (*) as an endnote numbering method, the command is:

EndnoteNumberMethod(Characters!;"*")

See Also

EndnoteOptionsDlg

EndnoteOptionsDlg displays the Endnote Options dialog box. This command is the equivalent of choosing Layout, Endnote, Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EndnoteOptionsDlg

Parameters

None.

See Also

EndnotePlacement

EndnotePlacement marks the location where an endnote list is generated and determines whether to reset numbering for subsequent endnotes. This command is the equivalent of choosing Layout, Endnote, Placement, and selecting yes or no.

Syntax

EndnotePlacement(State)

Parameters

State
Determines whether to reset endnote numbering and where to start printing endnotes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not reset
Yes! 1 Reset

Example

To reset endnote numbering, the command is:

EndnotePlacement(Yes!)

See Also

EndnotePlacementDlg

EndnotePlacementDlg displays the Restart endnote numbering? dialog box. This command is the equivalent of choosing Layout, Endnote, Placement.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EndnotePlacementDlg

Parameters

None.

See Also

EndnoteSetNumberDlg

EndnoteSetNumberDlg displays the Set Endnote Number dialog box. This command is the equivalent of choosing Layout, Endnote, New Number.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EndnoteSetNumberDlg

Parameters

None.

See Also

EndnotesSpaceBetween

EndnotesSpaceBetween sets the amount of blank space between endnotes. This command is the equivalent of choosing Layout, Endnote, Options, Spacing Between Endnotes, and specifying a measurement.

Syntax

EndnotesSpaceBetween(Spacing)

Parameters

Spacing
A measurement expression specifying the amount of blank space between endnotes. The default is .167".

Example

To specify .25" blank space between endnotes, the command is:

EndnotesSpaceBetween(.25")

See Also

EndnoteStyleDlg

EndnoteStyleDlg displays the Endnote Style in Note dialog box. This command is the equivalent of choosing Layout, Endnote, Edit Style in Note. This command is not recordable. To use this command, you must type it into the macro.

Syntax

EndnoteStyleDlg

Parameters

None.

EndnoteStyleInDocDlg

EndnoteStyleInDocDlg displays the Endnote Style In Document dialog box. This command is the equivalent of choosing Layout, Endnote, Edit Style in Doc. This command is not recordable. To use this command, you must type it into the macro.

Syntax

EndnoteStyleInDocDlg

Parameters

None.

EndOfSentenceSpacing

EndOfSentenceSpacing changes the spacing at the end of sentences. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, End of Sentence Corrections, then specifying an option.

Syntax

EndOfSentenceSpacing(Spacing)

Parameters

Spacing
Makes spacing corrections at the end of a sentence. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DoubleToSingle 2 Change spacing from double to single
None! 0 No change to spacing
SingleToDouble! 1 Change spacing from single to double

Example

To change end of sentence spacing of single to double, the command is

EndOfSentenceSpacing(SingleToDouble!)

EnterKey

EnterKey performs the same functions as Enter. This command is the equivalent of pressing Enter. To use this command, you must type it into the macro.

Syntax

EnterKey

Parameters

None.

See Also

EnvelopeAddressEnd

EnvelopeAddressEnd is the closing command of the EnvelopeReturnAddressBegin-EnvelopeAddressEnd statement, or the EnvelopeMailingAddressBegin-EnvelopeAddressEnd statement. The first command of these statements should be followed by Type commands with address information. These statements must be used between EnvelopeBegin and EnvelopeEnd commands and are the equivalent of choosing Layout, Envelope, and entering return and mailing address information.

Syntax

EnvelopeAddressEnd

Parameters

None.

See Also

EnvelopeAddressPosition

EnvelopeAddressPosition sets the position of both a return address and a mailing address. This command is used between EnvelopeBegin and EnvelopeEnd commands. This command is the equivalent of choosing Layout, Envelope, Setup, Envelope Size, highlighting an Envelope, Address Positions, and specifying positions.

Syntax

EnvelopeAddressPosition(Return Address Horizontal;Return Address Vertical;Mailing Address Horizontal;Mailing Address Vertical;Envelope Name)

Parameters

Return Address Horizontal
A measurement expression specifying the position of a return address from the left edge of an envelope.
Return Address Vertical
A measurement expression specifying the position of a return address from the top edge of an envelope.
Mailing Address Horizontal
A measurement expression specifying the position of a mailing address from the left edge of an envelope.
Mailing Address Vertical
A measurement expression specifying the position of a mailing address from the top edge of an envelope.
Envelope Name
A character expression specifying an envelope name.

Example

To position a return address .25" from the top of an envelope and .25" from the left side, to position the mailing address 3" from the top of an envelope and 2.5" from the left side, and to specify a standard 9.5" x 4.13" envelope, the command is:

EnvelopeAddressPosition(.25";.25";3";2.5";"Envelope (COM 10)")

See Also

EnvelopeBarcode

EnvelopeBarcode creates a US Postal Bar Code. This command is used between EnvelopeBegin and EnvelopeEnd commands. This command is the equivalent of choosing Layout, Envelope, POSTNET Bar Code, and entering 5, 9, or 11 digits, or choosing Ctrl+F9, Merge, Data File options, Generate an Envelope, and specifying a ZIP code or field name/number.

Syntax

EnvelopeBarcode(Digits;Merge Field)

Parameters

Digits
A character expression specifying digits of a custom Bar Code. A Bar Code of 5, 9, or 11 digits is allowed.
Merge Field (optional)
Determines whether the name or number of a merge field is allowed as a Bar Code. If so, 1, 2, or 3 digits or characters are allowed. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
MergeFieldAllowed! 1 Merge field allowed

Example

To create a Bar Code for the ZIP code 12345, the command is:

EnvelopeBarcode("12345")

See Also

EnvelopeBarcodePosition

EnvelopeBarcodePosition specifies where to print the Barcode relative to the address. This command is the equivalent of choosing Layout, Envelope, Setup, Bar Code Position, and selecting an option.

Syntax

EnvelopeBarcodePosition(Position)

Parameters

Position
Specifies the position of the Barcode relative to the address. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
AboveAddress! 0 Print above address
BelowAddress! 1 Print below address

Example

To specify that the Barcode be printed below the address, the command is:

EnvelopeBarcodePosition(BelowAddress!)

See Also

EnvelopeBarcodeSetup

EnvelopeBarcodeSetup determines whether to create a Bar Code automatically or manually, or to remove the option. This command is used in conjunction with other commands, such as EnvelopeBegin and EnvelopeEnd. This command is the equivalent of choosing Layout, Envelope, Setup, Bar Code Creation, and selecting an option.

Syntax

EnvelopeBarcodeSetup(Setup)

Parameters

Setup
Determines whether to create a Bar Code. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ManuallyCreateBarcode! 0 Manually create Bar Code
AutomaticallyCreateBarcode! 1 Automatically create Bar Code
RemoveBarcodeOption! 2 Remove Bar Code option

Example

To remove the POSTNET Bar Code Field from an envelope setup, the command is:

EnvelopeBarcodeSetup(RemoveBarcodeOption!)

See Also

EnvelopeBegin

EnvelopeBegin is the opening command of the EnvelopeBegin-EnvelopeEnd statement. EnvelopeBegin should be followed by envelope format commands. This command is the equivalent of choosing Layout, Envelope, and selecting options. Use EnvelopeEnd to close the statement.

Syntax

EnvelopeBegin

Parameters

None.

See Also

EnvelopeDlg

EnvelopeDlg displays the Envelope dialog box. This command is the equivalent of choosing Layout, Envelope.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EnvelopeDlg

Parameters

None.

EnvelopeEnd

EnvelopeEnd is the closing command of the EnvelopeBegin-EnvelopeEnd statement. After choosing Layout, Envelope, and selecting the envelope command options, EnvelopeEnd is the equivalent of selecting Print, Insert, Close, or Cancel.

Syntax

EnvelopeEnd(Type)

Parameters

Type
Determines whether to cancel an envelope command, send it to the current printer, or display it as part of a document. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
EnvelopeCancel! 0 Cancel
EnvelopeClose! 1 Close
EnvelopeInsert! 2 Insert
EnvelopePrint! 3 Print

Example

To print an envelope, the command is:

EnvelopeEnd(EnvelopePrint!)

EnvelopeMailingAddressBegin

EnvelopeMailingAddressBegin is the opening command of the EnvelopeMailingAddressBegin-EnvelopeAddressEnd statement. This statement is used between EnvelopeBegin and EnvelopeEnd commands. EnvelopeMailingAddressBegin should be followed by Type commands with address information. This statement is the equivalent of choosing Layout, Envelope, and entering mailing address information.

Syntax

EnvelopeMailingAddressBegin

Parameters

None.

See Also

EnvelopeOmitReturnAddress

EnvelopeOmitReturnAddress determines whether to omit a return address. This command is used between EnvelopeBegin and EnvelopeEnd commands. EnvelopeOmitReturnAddress is the equivalent of choosing Layout, Envelope, Omit Return Address.

Syntax

EnvelopeOmitReturnAddress(State)

Parameters

State
Determines whether to omit a return address. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not omit
Yes! 1 Omit

Example

To omit a return address, the command is:

EnvelopeOmitReturnAddress(On!)

EnvelopeReturnAddressBegin

EnvelopeReturnAddressBegin is the opening command of the EnvelopeReturnAddressBegin-EnvelopeAddressEnd statement. This command is used between EnvelopeBegin and EnvelopeEnd commands. EnvelopeReturnAddressBegin should be followed by Type commands with address information. This statement is the equivalent of choosing Layout, Envelope, and entering return and mailing address information.

Syntax

EnvelopeReturnAddressBegin

Parameters

None.

See Also

EnvelopeSaveAddressAsDefault

EnvelopeSaveAddressAsDefault determines whether to save a return address as the default. This command is used in conjunction with the commands EnvelopeBegin and EnvelopeEnd. This command is the equivalent of choosing Layout, Envelope, Save Return Address as Default.

Syntax

EnvelopeSaveAddressAsDefault(State)

Parameters

State
Determines whether to save the current return address as the default return address. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not save
Yes! 1 Save

Example

To make a return address the default, the command is:

EnvelopeSaveAddressAsDefault(Yes!)

EnvelopeSize

EnvelopeSize selects an envelope name. This command is used in conjunction with the commands EnvelopeBegin and EnvelopeEnd. This command is the equivalent of choosing Layout, Envelope, Envelope Size, and selecting an envelope.

Syntax

EnvelopeSize(Envelope Name)

Parameters

Envelope Name
A character expression specifying an envelope name.

Example

To select a standard 9.5" x 4.13" envelope, the command is:

EnvelopeSize("Envelope (COM 10)")

See Also

EnvelopeSizeSetup

EnvelopeSizeSetup changes the default envelope name displayed in the Envelope dialog box. This command is used in conjunction with EnvelopeBegin and EnvelopeEnd. This command is the equivalent of choosing Layout, Envelope, Setup, Envelope Size, and selecting an envelope.

Syntax

EnvelopeSizeSetup(Envelope Name)

Parameters

Envelope Name
A character expression specifying the default envelope.

Example

To specify a standard 9.5" x 4.13" envelope as the default in the Envelope dialog box, the command is:

EnvelopeSizeSetup("Envelope (COM 10)")

See Also

EnvironmentSetupDlg

EnvironmentSetupDlg displays the Environment dialog. This command is the equivalent of choosing File, Setup, Environment.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

EnvironmentSetupDlg

Parameters

None.

ExitDlg

ExitDlg displays a prompt to save your work before exiting a Corel WordPerfect document. This command is the equivalent of choosing File, Exit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ExitDlg

Parameters

None.

See Also

ExitWordPerfect

ExitWordPerfect exits Corel WordPerfect documents and program without prompting you to save your work. Use this command with caution! Before using this command, you may want to set the macro to check for the existence of any modified documents.

Syntax

ExitWordPerfect

Parameters

None.

See Also

ExitWordPerfectDlg

ExitWordPerfectDlg prompts you to specify files to save before exiting Corel WordPerfect. This command is the equivalent of choosing File, Exit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ExitWordPerfectDlg

Parameters

None.

See Also

ExtendedBackwardSearchDlg

ExtendedBackwardSearchDlg displays the Search dialog box, including any previously specified search string. This command is the equivalent of choosing Edit, Search, entering a search string, Backward Search, Extended Search (Hdrs, Ftrs, etc.). This command is not recordable. To use this command, you must type it into the macro.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ExtendedBackwardSearchDlg

Parameters

None.

See Also

ExtendedReplaceDlg

ExtendedReplaceDlg displays the Search and Replace dialog box and any previously specified search string. This command is the equivalent of choosing Edit, Replace, entering search and replace strings, Extended Search (Hdrs, Ftrs, etc.), or pressing Home, Alt+F2. This command is not recordable. To use this command, you must type it into the macro.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ExtendedReplaceDlg

Parameters

None.

See Also

ExtendedSearchDlg

ExtendedSearchDlg displays the Search dialog box and any previously specified search string. This command is the equivalent of choosing Edit, Search, entering a search string, Extended Search (Hdrs, Ftrs, etc.), or pressing Home+F2. This command is not recordable. To use this command, you must type it into the macro.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ExtendedSearchDlg

Parameters

None.

See Also

FastSave

FastSave determines whether a document is formatted for printing when it is saved. This command is the equivalent of choosing File, Save, Setup, Fast Save (unformatted).

Syntax

FastSave(State)

Parameters

State
Determines whether a document is formatted for printing when it is saved. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Not formatted
Yes! 1 Formatted

Example

To format a document for printing when it is saved, the command is:

FastSave(No!)

Fax

Fax displays the Fax Services dialog box. This command is the equivalent of choosing File, Print/Fax, Fax Services.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

Fax

Parameters

None.

See Also

FaxBegin

FaxBegin designates the beginning of the fax sending process. This command must be used in conjunction with other fax commands.

Syntax

FaxBegin

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxDestination

FaxDestination specifies key information about the fax recipient. This command must be used in conjunction with other fax commands.

Syntax

FaxDestination(Fax Number;Voice Number;Recipient;Route;Billing)

Parameters

Fax Number
A character expression specifying the recipient's fax number.
Voice Number
A character expression specifying the recipient's voice number.
Recipient
A character expression specifying the recipient's name.
Route
A character expression specifying the fax route. Use of this parameter is determined by the fax service you are using.
Billing
A character expression specifying fax billing information. Use of this parameter is determined by the fax service you are using.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxDialOutSelect

FaxDialOutSelect specifies customized dial-out settings such as area codes. This command is the equivalent of choosing File, Print/Fax, Fax Services, Fax Setup, Dial-out Instructions.

Syntax

FaxDialOutSelect(Name)

Parameters

Name
A character expression specifying the fax dial out setting.

Example

To specify Home Office as a dial out setting, the command is:

FaxDialOutSelect("Home Office")

See Also

FaxEnd

FaxEnd designates the end of the fax sending process. This command must be used in conjunction with other fax commands.

Syntax

FaxEnd

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxError

FaxError specifies the name of the file to which fax error messages are appended.

Syntax

FaxError(Filename)

Parameters

Filename
A character expression specifying the filename of the file to which errors are logged.

Example

To specify FAXERROR.LOG as the fax error file, the command is:

FaxError("FAXERROR.LOG")

See Also

FaxFile

FaxFile specifies the characteristics of a fax file. This command must be used in conjunction with other fax commands.

Syntax

FaxFile(Filename;File Mode;Delete;Resolution Mode)

Parameters

Filename
Specifies the filename of a formatted fax file to be sent.
File Mode
Specifies the fax sending mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FaxOnly! 0 Send as a fax only
BFTOnly! 1 Send as a binary file only
PeerFax! 2 Send as a binary file; if there is an error, send as a fax
Delete
Designates whether to delete the file after the fax is sent. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not delete the fax after sending
Yes! 1 Delete the fax after sending
Resolution Mode
Specifies the resolution mode of the fax. If FaxRasterize was used, this resolution must match the rasterize resolution.
Enumerated Type Numeric Equivalent Description
FXStandard! 0 Standard Resolution (204 x 98 dpi)
FXFine! 1 Fine Resolution (204 x 196 dpi)
FX300DPI! 2 300 x 300 dpi
FX400DPI! 3 400 x 400 dpi

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxParameters

FaxParameters specifies the coversheet and scheduling information for a fax. This command must be used in conjunction with other fax commands.

Syntax

FaxParameters(Date;Time;Priority;Coversheet;Subject;From)

Parameters

Date
Character expression specifying the date to send the fax.
Time
Character expression specifying the time to send the fax.
Priority
Character expression specifying the priority of the fax being sent. Use of this parameter is determined by the fax service you are using.
Coversheet
Character expression specifying the coversheet to be used with the fax.
Subject
Character expression specifying the text to be used on the Subject line of the fax.
From
Character expression specifying the text to be used on the From line of the fax.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxRasterize

FaxRasterize converts a source document to a bitmap fax format. This command must be used in conjunction with other fax commands.

Syntax

FaxRasterize(Source;Destination;Resolution)

Parameters

Source
Character expression specifying the filename of the source document.
Destination
Character expression specifying the filename of the converted fax file.
Resolution
Specifies the rasterize resolution. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FXStandard! 0 Standard Resolution (204 x 98 dpi)
FXFine! 1 Fine Resolution (204 x 196 dpi)
FX300DPI! 2 300 x 300 dpi
FX400DPI! 3 400 x 400 dpi

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxRasterizeCover

FaxRasterizeCover creates a fax cover sheet. This command must be used in combination with other fax commands such as FaxRasterize.

Syntax

FaxRasterizeCover(Source;Destination;Resolution;Recipient;Recipient Phone;Sender;Pages;Subject)

Parameters

Source
A character expression specifying the filename of the source document.
Destination
A character expression specifying the filename of the converted fax file.
Resolution
Specifies the rasterize resolution. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FXStandard! 0 Standard Resolution (204 x 98 dpi)
FXFine! 1 Fine Resolution (204 x 196 dpi)
FX300DPI! 2 300 x 300 dpi
FX400DPI! 3 400 x 400 dpi
Recipient (optional)
A character expression specifying the recipient.
Recipient Phone (optional)
A character expression specifying the recipient's phone number.
Sender (optional)
A character expression specifying the sender.
Pages (optional)
A character expression specifying the number of pages faxed.
Subject (optional)
A character expression specifying the fax subject.

Example

To create a fax cover, the command is:

FaxRasterizeCover("LATEST.FAX"; "COPY.FAX"; FXStandard!; "Yvonne Barrus"; "801-478-8451"; "Camille Blackburn"; "2"; "Designs")

See Also

FaxScheduleBegin

FaxScheduleBegin designates the beginning of the fax scheduling process. This command must be used in conjunction with other fax commands.

Syntax

FaxScheduleBegin

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxScheduleEnd

FaxScheduleEnd designates the end of the fax scheduling process. This command must be used in conjunction with other fax commands.

Syntax

FaxScheduleEnd

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxStatusBegin

FaxStatusBegin designates the beginning of a fax process. This command must be used in conjunction with other fax commands.

Syntax

FaxStatusBegin

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FaxStatusEnd

FaxStatusEnd designates the end of a fax process. This command must be used in conjunction with other fax commands.

Syntax

FaxStatusEnd

Parameters

None.

Example

To send a fax, the command sequence is:

FaxBegin FaxStatusBegin
FaxRasterize(;"LATEST.FAX";FXStandard!)
FaxScheduleBegin
FaxFile("LATEST.FAX";FaxOnly!;Yes!;FXStandard!)
FaxDestination("5556407";;"Jennifer Wong")
FaxParameters("03-05-93";"09:23a";;"DEFAULT";"";"Kurt Krieger")
FaxScheduleEnd FaxStatusEnd FaxEnd

See Also

FileCopy

FileCopy copies a source file to a destination file, and, optionally, copies subdocuments. This command is the equivalent of choosing File, File Manager, selecting a directory, selecting a file or files to copy, Copy.

Syntax

FileCopy(Source File;Destination File;Subdocs)

Parameters

Source File
A character expression specifying a file to copy.
Destination File
A character expression specifying a file to which a source file is copied.
Subdocs (optional)
Determines whether to copy subdocuments with a master document. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Subdocs! 1 Copy subdocuments

Example

To copy a master document OLD.DOC and its subdocuments to another directory, the command is:

FileCopy("C:\WP62\OLD.DOC";"C:\WP62\DATA\OLD.DOC";Subdocs!)

See Also

FileDelete

FileDelete deletes a file, and, optionally, deletes subdocuments. This command is the equivalent of choosing File, File Manager, specifying a directory, selecting a file or files to delete, Delete.

Syntax

FileDelete(Filename;Subdocs)

Parameters

Filename
A character expression specifying a file to delete.
Subdocs (optional)
Determines whether to delete subdocuments. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Subdocs! 1 Delete subdocuments

Example

To delete a master document OLD.DOC but not its subdocuments, the command is:

FileDelete("C:\COREL\WP62\OLD.DOC")

See Also

FileListDlg

FileListDlg displays the File Manager dialog box. This command is the equivalent of choosing File, File Manager, specifying a directory of files to list, then pressing Enter.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileListDlg

Parameters

None.

FileManagerDlg

FileManagerDlg displays the Specify File Manager List dialog box. This command is the equivalent of choosing File, File Manager.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileManagerDlg

Parameters

None.

FileManagerSaveSetup

FileManagerSaveSetup saves changes made in the File Manager Sort/Setup dialog box. This command is the equivalent of choosing File, File Manager, displaying the File Manager dialog box by specifying a File Manager list, Sort/Setup, selecting options, Save Defaults to Setup File.

Syntax

FileManagerSaveSetup

Parameters

None.

FileManagerSetupDlg

FileManagerSetupDlg displays the File Manager Setup dialog box. This command is the equivalent of choosing File, File Manager, specifying a directory, OK, Setup.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileManagerSetupDlg

Parameters

None.

FileManagerSortBySetup

FileManagerSortBySetup specifies how to sort a list of files. This command is the equivalent of choosing File, File Manager, specifying a directory, OK, Setup, Sort List by, and selecting an option.

Syntax

FileManagerSortBySetup(Sort)

Parameters

Sort
Specifies how to sort files. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Filename! 1 Filename
Extension! 2 Extension
DateTime! 3 Date and time
Size! 4 Size
DescrName! 5 Description name
DescrType! 6 Description type
NoSort! 7 No sorting

Example

To sort files by filename, the command is:

FileManagerSortBySetup(Filename!)

See Also

FileManagerSortDescending

FileManagerSortDescending determines whether File Manager lists files in ascending or descending order. This command is the equivalent of choosing File, File Manager, specifying a directory, OK, Setup, Descending Sort.

Syntax

FileManagerSortDescending(State)

Parameters

State
Determines whether files are listed in ascending or descending order.
Enumerated Type Numeric Equivalent Description
No! 0 Not descending order
Yes! 1 Descending order

Example

To list files in descending order, the command is:

FileManagerSortDescending(Yes!)

See Also

FileManagerUseSpeedupFile

FileManagerUseSpeedupFile determines whether File Manager uses the Descriptive Name Speedup File when sorting or displaying files by their descriptive name. This command is the equivalent of choosing File, File Manager, displaying the File Manager dialog box, Sort/Setup, selecting Sort List By, then Descriptive Name, or selecting Display List Mode, then Descriptive Names and Types, and then selecting Use Desc. Name Speedup File.

Syntax

FileManagerUseSpeedupFile(State)

Parameters

State
Specifies whether File Manager uses the Descriptive Name Speedup File. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not use Speedup file
Yes! 1 Use Speedup file

Example

To use the Descriptive Name Speedup File, the command is:

FileManagerUseSpeedupFile(Yes!)

See Also

FileMoveRename

FileMoveRename moves and/or renames a source file to a destination file, and, optionally, moves subdocuments. This command is the equivalent of choosing File, File Manager, selecting a directory, selecting a file or files to move and/or rename, Move/Rename.

Syntax

FileMoveRename(Source File;Destination File;Subdocs)

Parameters

Source File
A character expression specifying the name of a file to move and/or rename.
Destination File
A character expression specifying the name of a file to which the source file will be moved and/or renamed.
Subdocs (optional)
Determines whether to move subdocuments within a master document. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Subdocs! 1 Move subdocuments

Example

To move and rename OLD.DOC, the command is:

FileMoveRename("C:\WP62\OLD.DOC";"C:\WP62\DATA\NEW.DOC")

See Also

FileNew

FileNew opens a new document screen. This command is the equivalent of choosing File, New.

Syntax

FileNew

Parameters

None.

FileOpen

FileOpen opens a file into a new document window, and, optionally, identifies the file format. This command is the equivalent of choosing File, Open, and entering a filename.

Syntax

FileOpen(Filename;File Format)

Parameters

Filename
A character expression specifying the name and location of a file to open.
File Format (optional)
Specifies a file format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WordPerfect_42! 1
WordPerfect_50! 2
WordPerfect_51/52! 3
WordPerfect_60! 4
WordPerfect_61! 5
WordPerfect_62! 6
WordPerfectMac_20! 20
WorPerfectMac_21! 21
WordStar_33! 30
WordStar_331! 31
WordStar_34! 32
WordStar_40! 33
WordStar_50! 34
WordStar_55! 35
WordStar_60! 36
WordStar_70! 37
WordStar2000_10! 50
WordStar2000_20! 51
WordStar2000_30! 52
MicroSoftWord_40! 62
MicroSoftWord_50! 63
MicroSoftWord_55! 64
WordForWindows_10! 70
WordForWindows_11! 71
WordForWindows_1A/1B! 72
WordForWindows_20! 73
WordForWindows_2A! 74
WordForWindows_2B! 75
RFT! 80
FFT! 81
MultiMate_33! 100
MultiMateAdvantage_36! 101
MultiMateAdvantageII_10! 102
MultiMate_40! 103
ProfessionalWrite_10! 110
ProfessionalWrite_20! 111
ProfessionalWrite_21! 112
ProfessionalWrite_22! 113
OfficeWriter_60! 120
OfficeWriter_61! 121
OfficeWriter_611! 122
OfficeWriter_62! 123
VolksWriter_4! 143
RTF! 150
ASCIIStandard! 160
DelimitedText! 163
ASCIIStripped! 165
Kermit! 173
NavyDIF! 175
XyWriteIIIPlus_355! 190
XyWriteIIIPlus_356! 191
Sprint_10! 210
SpreadsheetDIF! 800

Example

To open WP.DOC, saved as a WordPerfect Corporation WordPerfect 4.2 document, the command is:

FileOpen("C:\WP42\WP.DOC";WordPerfect_42!)

See Also

FileOpenAsCopy

FileOpenAsCopy opens a read-only copy of the file so you can edit it without risking replacing the original. This command is the equivalent of choosing File, Open As Copy, and entering a filename.

Syntax

FileOpenAsCopy(Filename;File Format)

Parameters

Filename
A character expression specifying the name and location of a file to open as a copy.
File Format (optional)
Specifies a file format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WordPerfect_42! 1
WordPerfect_50! 2
WordPerfect_51/52! 3
WordPerfect_60! 4
WordPerfect_61! 5
WordPerfect_62! 6
WordPerfectMac_20! 20
WorPerfectMac_21! 21
WordStar_33! 30
WordStar_331! 31
WordStar_34! 32
WordStar_40! 33
WordStar_50! 34
WordStar_55! 35
WordStar_60! 36
WordStar_70! 37
WordStar2000_10! 50
WordStar2000_20! 51
WordStar2000_30! 52
MicroSoftWord_40! 62
MicroSoftWord_50! 63
MicroSoftWord_55! 64
WordForWindows_10! 70
WordForWindows_11! 71
WordForWindows_1A/1B! 72
WordForWindows_20! 73
WordForWindows_2A! 74
WordForWindows_2B! 75
RFT! 80
FFT! 81
MultiMate_33! 100
MultiMateAdvantage_36! 101
MultiMateAdvantageII_10! 102
MultiMate_40! 103
ProfessionalWrite_10! 110
ProfessionalWrite_20! 111
ProfessionalWrite_21! 112
ProfessionalWrite_22! 113
OfficeWriter_60! 120
OfficeWriter_61! 121
OfficeWriter_611! 122
OfficeWriter_62! 123
VolksWriter_4! 143
RTF! 150
ASCIIStandard! 160
DelimitedText! 163
ASCIIStripped! 165
Kermit! 173
NavyDIF! 175
XyWriteIIIPlus_355! 190
XyWriteIIIPlus_356! 191
Sprint_10! 210
SpreadsheetDIF! 800

Example

If WP.DOC has been saved as a Corel WordPerfect 5.2 document, the command to open WP.DOC as a copy is:

FileOpenAsCopy("C:\WP52\WP.DOC";WordPerfect_51\52!)

See Also

FileOpenAsCopyDlg

FileOpenAsCopyDlg displays the Open As Copy dialog box. This command is the equivalent of choosing File, Open As Copy.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileOpenAsCopyDlg

Parameters

None.

See Also

FileOpenDlg

FileOpenDlg displays the Open Document dialog box. This command is the equivalent of choosing File, Open.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileOpenDlg

Parameters

None.

See Also

FileRetrieve

FileRetrieve retrieves a file into the current document window, and, optionally, identifies a file format. This command is the equivalent of choosing File, Retrieve, and specifying a file to retrieve.

Syntax

FileRetrieve(Filename;File Format)

Parameters

Filename
A character expression specifying the name of a file to retrieve.
File Format (optional)
Specifies a file format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WordPerfect_42! 1
WordPerfect_50! 2
WordPerfect_51/52! 3
WordPerfect_60! 4
WordPerfect_61! 5
WordPerfect_62! 6
WordPerfectMac_20! 20
WorPerfectMac_21! 21
WordStar_33! 30
WordStar_331! 31
WordStar_34! 32
WordStar_40! 33
WordStar_50! 34
WordStar_55! 35
WordStar_60! 36
WordStar_70! 37
WordStar2000_10! 50
WordStar2000_20! 51
WordStar2000_30! 52
MicroSoftWord_40! 62
MicroSoftWord_50! 63
MicroSoftWord_55! 64
WordForWindows_10! 70
WordForWindows_11! 71
WordForWindows_1A/1B! 72
WordForWindows_20! 73
WordForWindows_2A! 74
WordForWindows_2B! 75
RFT! 80
FFT! 81
MultiMate_33! 100
MultiMateAdvantage_36! 101
MultiMateAdvantageII_10! 102
MultiMate_40! 103
ProfessionalWrite_10! 110
ProfessionalWrite_20! 111
ProfessionalWrite_21! 112
ProfessionalWrite_22! 113
OfficeWriter_60! 120
OfficeWriter_61! 121
OfficeWriter_611! 122
OfficeWriter_62! 123
VolksWriter_4! 143
RTF! 150
ASCIIStandard! 160
DelimitedText! 163
ASCIIStripped! 165
Kermit! 173
NavyDIF! 175
XyWriteIIIPlus_355! 190
XyWriteIIIPlus_356! 191
Sprint_10! 210
SpreadsheetDIF! 800

Example

To retrieve a file named TEST.DOC saved as a WordPerfect Corporation WordPerfect 5.0 document, the command is:

FileRetrieve("C:\WP50\TEST.DOC";WordPerfect_50!)

See Also

FileRetrieveDlg

FileRetrieveDlg displays the Retrieve Document dialog box. This command is the equivalent of choosing File, Retrieve.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileRetrieveDlg

Parameters

None.

See Also

FileSave

FileSave saves the active document, and optionally, specifies a file format. This command is the equivalent of choosing File, Save.

Syntax

FileSave(Filename; File Format)

Parameters

Filename
A character expression specifying the name of a document to save.
File Format (optional)
Specifies a file format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WordPerfect_42! 1
WordPerfect_50! 2
WordPerfect_51/52! 3
WordPerfect_60! 4
WordPerfect_61! 5
WordPerfect_62! 6
WordPerfectMac_20! 20
WorPerfectMac_21! 21
WordStar_33! 30
WordStar_331! 31
WordStar_34! 32
WordStar_40! 33
WordStar_50! 34
WordStar_55! 35
WordStar_60! 36
WordStar_70! 37
WordStar2000_10! 50
WordStar2000_20! 51
WordStar2000_30! 52
MicroSoftWord_40! 62
MicroSoftWord_50! 63
MicroSoftWord_55! 64
WordForWindows_10! 70
WordForWindows_11! 71
WordForWindows_1A/1B! 72
WordForWindows_20! 73
WordForWindows_2A! 74
WordForWindows_2B! 75
RFT! 80
FFT! 81
MultiMate_33! 100
MultiMateAdvantage_36! 101
MultiMateAdvantageII_10! 102
MultiMate_40! 103
ProfessionalWrite_10! 110
ProfessionalWrite_20! 111
ProfessionalWrite_21! 112
ProfessionalWrite_22! 113
OfficeWriter_60! 120
OfficeWriter_61! 121
OfficeWriter_611! 122
OfficeWriter_62! 123
VolksWriter_4! 143
RTF! 150
ASCIIStandard! 160
DelimitedText! 163
ASCIIStripped! 165
Kermit! 173
NavyDIF! 175
XyWriteIIIPlus_355! 190
XyWriteIIIPlus_356! 191
Sprint_10! 210
SpreadsheetDIF! 800

Example

To save NEW.DOC in Corel WordPerfect 5.1 format, the command is:

FileSave("C:\COREL\WP62\NEW.DOC";WordPerfect_51/52!)

FileSaveDefaultFormat

FileSaveDefaultFormat specifies the default save format. This command is the equivalent of choosing File, Save, Setup, Default Save Format, and selecting a format.

Syntax

FileSaveDefaultFormat(File Format)

Parameters

File Format
Specifies the default file format. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WordPerfect_42! 1
WordPerfect_50! 2
WordPerfect_51/52! 3
WordPerfect_60! 4
WordPerfect_61! 5
WordPerfect_62! 6
WordStar_33! 30
WordStar_331! 31
WordStar_34! 32
WordStar_40! 33
WordStar_50! 34
WordStar_55! 35
WordStar_60! 36
WordStar_70! 37
WordStar2000_10! 50
WordStar2000_20! 51
WordStar2000_30! 52
WordStar2000_35! 53
MicroSoftWord_30! 60
MicroSoftWord_31! 61
MicroSoftWord_40! 62
MicroSoftWord_50! 63
MicroSoftWord_55! 64
WordForWindows_10! 70
WordForWindows_11! 71
WordForWindows_1A! 72
WordForWindows_20! 73
RFT! 80
FFT! 81
DisplayWrite_40! 82
DisplayWrite_42! 83
DisplayWrite_50! 84
WITA_10! 90
WITA_20! 91
MultiMate_33! 100
MultiMateAdvantage_36! 101
MultiMateAdvantageII_10! 102
MultiMate_40! 103
ProfessionalWrite_10! 110
ProfessionalWrite_20! 111
ProfessionalWrite_21! 112
ProfessionalWrite_22! 113
OfficeWriter_60! 120
OfficeWriter_61! 121
OfficeWriter_611! 122
OfficeWriter_62! 123
WordPerfectMerge! 130
VolksWriterDeluxe_22! 140
VolksWriterDeluxePlus! 141
VolksWriter_3! 142
VolksWriter_4! 143
TotalWord! 146
RTF! 150
ASCIIStandard! 160
DelimitedText! 163
ASCIIStripped! 165
ASCIISRt! 166
NavyDIF! 175
Enable_20! 180
Enable_215! 181
Enable_30! 182
Enable_40! 183
XyWriteIIIPlus_355! 190
XyWriteIIIPlus_356! 191
XyWriteIIIPlus_40! 192
Sprint_10! 210
AmiPro_10! 310
AmiPro_12! 311
AmiPro_12A! 312
AmiPro_12B! 313
AmiPro_20! 314
SpreadsheetDIF! 800
Excel_21! 805
Excel_30! 806
Excel_40! 807
Lotus123_1A! 815
Lotus123_20! 816
Lotus123_23! 817
Lotus123_24! 818
Lotus123_30! 825
Lotus123_31! 826
Quattro! 835
QuattroPro_30! 836
QuattroPro_40! 837
PlanPerfect_30! 845
PlanPerfect_50! 846
PlanPerfect_51! 847

Example

To set the default save format as Corel WordPerfect 5.1, the command is:

FileSaveDefaultFormat(WordPerfect_51/52!)

FileSaveDlg

FileSaveDlg displays the Save Document dialog box. This command is the equivalent of choosing File, Save.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FileSaveDlg

Parameters

None.

See Also

FillColors

FillColors specifies foreground and background colors, and the amount of red, blue, and green in the selected colors. FillColors is the equivalent of choosing Graphics, Fill Styles, Create or Edit, Color...(Foreground) and/or Color...(Background), and selecting options.

Syntax

FillColors(Foreground Color;Red Value;Green Value;Blue Value;Shading Value; Background Color;Red Value;Green Value;Blue Value;Shading Value)

Parameters

The first five parameters specify foreground color and the last five specify background color.
Foreground/Background Color (optional)
A character expression specifying foreground and background colors.
Red Value (optional)
A numeric expression representing the amount of red in the selected color. Values range from 0 to 255.
Green Value (optional)
A numeric expression representing the amount of green in the selected color. Values range from 0 to 255.
Blue Value (optional)
A numeric expression representing the amount of blue in the selected color. Values range from 0 to 255.
Shading Value (optional)
A numeric expression representing the amount of shading in the selected color. Values range from 0 to 100.

Example

To specify black and white colors with 40 percent foreground shading, the command is:

FillColors("Black";0;0;0;40;"White";255;255;255;100)

See Also

FillSetGradient

FillSetGradient customizes a gradient fill. This command is used between FillStyleEdit or FillStyleCreate and FillStyleEnd commands. After choosing Graphics, Fill Styles, Edit (or Create), selecting a style, and selecting Gradient from Fill Type options, this command is the equivalent of choosing Fill Pattern and selecting and entering options.

Syntax

FillSetGradient(Type;Position;X Offset;Y Offset;Steps)

Parameters

Type
Determines the type of gradient. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LinearGradient! 0 Linear
RadialGradient! 1 Radial
RectangularGradient! 2 Rectangular
Position
A numeric expression specifying a degree of rotation and horizontal and vertical offset positions.
X Offset (optional)
A numeric expression specifying the horizontal center of a radial or rectangular gradient, or the horizontal offset of a rotated linear gradient. Values are decimals ranging from 0 to 1.0.
Y Offset (optional)
A numeric expression specifying the vertical center of a radial or rectangular gradient, or the top of a linear gradient. Values are decimals ranging from 0 to 1.0.
Steps
Specifies the number of steps in the gradient. Use a numeric expression to specify the number of steps, or select the enumerated type or its numeric equivalent to calculate the number automatically.
Enumerated Type Numeric Equivalent Description
CalculateSteps! 0 Calculate steps

Example

To rotate a linear gradient 45 degrees and automatically calculate the steps, the command is:

FillSetGradient(LinearGradient!;45.0;0.0;0.0;CalculateSteps!)

FillSetWPG2

FillSetWPG2 specifies both a pattern set and a pattern from the set. (Only pattern set 0 is available in the current version of WordPerfect.) This command is the equivalent of choosing Graphics, Fill Styles, Create or Edit, Fill Type, Pattern, Fill Pattern, and selecting an option.

Syntax

FillSetWPG2(Pattern Set;Pattern)

Parameters

Pattern Set
A numeric expression specifying a pattern set. Currently only pattern set 0 is available.
Pattern
Specifies a pattern. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WPG2_Solid! 0
WPG2_Crosshatch1! 4
WPG2_Crosshatch2! 5
WPG2_Crosshatch3! 6
WPG2_Crosshatch4! 7
WPG2_Lines1! 8
WPG2_Lines2! 9
WPG2_Lines3! 10
WPG2_Lines4! 11
WPG2_Lines5! 12
WPG2_Lines6! 13
WPG2_Lines7! 14
WPG2_Lines8! 15
WPG2_Checkboard1! 16
WPG2_Checkboard2! 17
WPG2_Bricks1! 18
WPG2_Bricks2! 19
WPG2_Fishscale! 20
WPG2_Honeycomb! 21
WPG2_Patio! 22
WPG2_Chainlink! 23
WPG2_Weave! 24
WPG2_Plaid! 25
WPG2_Balls! 26
WPG2_Mesh! 27
WPG2_Crosses! 28
WPG2_Triangles! 29
WPG2_Waves! 30
WPG2_Arch! 31

Example

To select pattern set 0 and pattern WPG2_Arch, the command is:

FillSetWPG2(0;WPG2_Arch!)

FillStyleCopy

FillStyleCopy copies Fill Styles between the current document, the personal library, and the shared library. This command is the equivalent of choosing Graphics, Fill Styles, Copy.

Syntax

FillStyleCopy(Style;Source;Destination;Style Name)

Parameters

Style
Specifies a style to copy. To specify a WordPerfect style, select an enumerated type or its numeric equivalent. Use a character expression to specify a user-created style.
Enumerated Type Numeric Equivalent
Fill10! 0
Fill20! 1
Fill30! 2
Fill40! 3
Fill50! 4
Fill60! 5
Fill70! 6
Fill80! 7
Fill90! 8
Fill100! 9
NoFill! 127
Source
Specifies the source of a style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library
Destination
Specifies the destination of a style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library
Style Name (optional)
A character expression specifying the name of the style if source and destination are the same.

Example

To copy 50% Shaded Fill from the current document to the personal library, the command is:

FillStyleCopy(Fill50!;CurrentDoc!;PersonalLibrary!)

FillStyleCreate

FillStyleCreate creates a new fill style. This command is the equivalent of choosing Graphics, Fill Styles, Create, and entering a name for the new style.

Syntax

FillStyleCreate(Style Name;Location)

Parameters

Style Name
A character expression specifying the name of a new style.
Location (optional)
Specifies the location of the new style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To create a style named Button Fill, the command is:

FillStyleCreate("Button Fill")

FillStyleDelete

FillStyleDelete deletes a style. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Delete.

Syntax

FillStyleDelete(Style Name;Source)

Parameters

Style Name
Specifies a style to delete. To delete a WordPerfect style, select an enumerated type or its numeric equivalent. To delete a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent
Fill10! 0
Fill20! 1
Fill30! 2
Fill40! 3
Fill50! 4
Fill60! 5
Fill70! 6
Fill80! 7
Fill90! 8
Fill100! 9
NoFill! 127
Source
Specifies the source of a style name. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To delete a style named My Style, the command is:

FillStyleDelete("My Style";CurrentDoc!)

FillStyleDlg

FillStyleDlg displays the Fill Styles dialog box. This command is the equivalent of choosing Graphics, Fill Styles.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FillStyleDlg

Parameters

None.

FillStyleEdit

FillStyleEdit is the opening command of a FillStyleEdit-FillStyleEnd statement; this statement contains style commands. The FillStyleEdit command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Edit.

Syntax

FillStyleEdit(Style Name;Location)

Parameters

Style Name
Specifies the style to edit. Use a character expression to specify a user-created style, or select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Fill10! 0
Fill20! 1
Fill30! 2
Fill40! 3
Fill50! 4
Fill60! 5
Fill70! 6
Fill80! 7
Fill90! 8
Fill100! 9
FillButton! 10
NoFill! 127
Location (optional)
Specifies the location of the style to edit. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To edit the fill style named My Button, the command is:

FillStyleEdit("My Button")

See Also

FillStyleEditDlg

This command displays the Edit Fill Style dialog box. This command must be used between FillStyleEdit and FillStyleEnd commands. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FillStyleEditDlg

Parameters

None.

FillStyleEnd

FillStyleEnd saves or cancels changes after creating or editing a style. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Create (entering a style name) or Edit, OK or Cancel.

Syntax

FillStyleEnd(State)

Parameters

State
Determines whether to save changes after creating or editing a style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Do not save changes
Save! 1 Save changes

Example

To save changes after creating a new style, the command is:

FillStyleEnd(Save!)

See Also

FillStyleName

FillStyleName renames a user-created fill style. This command must be used between FillStyleEdit and FillStyleEnd. This command is the equivalent of choosing Graphics, Fill Styles, highlighting a user-created style, Edit, Fill Style Name, and entering a name.

Syntax

FillStyleName(New Name)

Parameters

New Name
A character expression renaming a user-created fill style.

Example

To rename a user-created fill style New Style, the command is:

FillStyleName("New Style")

FillStyleRetrieve

FillStyleRetrieve retrieves a fill style. This command is the equivalent of choosing Graphics, Fill Styles, Retrieve, and entering the name of a style.

Syntax

FillStyleRetrieve(Name;Location)

Parameters

Name
A character expression specifying a fill style to retrieve.
Location (optional)
Specifies the location of a fill style to retrieve. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To retrieve a fill style named My Style into the current document, the command is:

FillStyleRetrieve("My Style";CurrentDoc!)

See Also

FillStyleSave

FillStyleSave saves a fill style. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Save.

Syntax

FillStyleSave (Name;Location)

Parameters

Name
A character expression specifying a style library to save.
Location (optional)
Specifies the location of a fill style to save. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal Library
SharedLibrary! 2 Shared library

Example

To save a style library named MYSTYLE.STY, the command is:

FillStyleSave("C:\COREL\WP62\MYSTYLE.STY";CurrentDoc!)

See Also

FirstLineIndent

FirstLineIndent indents the first line of a new paragraph relative to the left margin. This command is the equivalent of choosing Layout, Margins, First Line Indent, and specifying a measurement.

Syntax

FirstLineIndent(Amount)

Parameters

Amount
A measurement expression specifying an amount to indent the first line of a new paragraph.

Example

To indent the first line of each new paragraph 1.5", the command is:

FirstLineIndent(1.5")

FloatingCellBegin

FloatingCellBegin moves the cursor to the beginning of the current floating cell. While in a floating cell, this command is the equivalent of pressing Shift+Tab.

Syntax

FloatingCellBegin

Parameters

None.

See Also

FloatingCellCreate

FloatingCellCreate creates a floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell, OK.

Syntax

FloatingCellCreate

Parameters

None.

See Also

FloatingCellCreateDlg

FloatingCellCreateDlg displays the Edit Floating Cell dialog box. This command creates a new floating cell and cannot be used to edit an existing floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FloatingCellCreateDlg

Parameters

None.

See Also

FloatingCellDlg

FloatingCellDlg displays the Edit Floating Cell dialog box. This command is the equivalent of choosing Layout, Tables, Edit Floating Cell. If no floating cell exists, this command generates an error.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FloatingCellDlg

Parameters

None.

See Also

FloatingCellEdit

FloatingCellEdit specifies that a floating cell is to be edited. This command must be used in conjunction with other commands that specify a name, formula, or number type for the cell. This command is the equivalent of choosing Layout, Tables, Edit Floating Cell.

Syntax

FloatingCellEdit

Parameters

None.

See Also

FloatingCellEditDlg

FloatingCellEditDlg displays the Edit Floating Cell dialog box. This command is the equivalent of choosing Layout, Tables, Edit Floating Cell. This command is not recordable. To use this command, you must type it into the macro.

Syntax

FloatingCellEditDlg

Parameters

None.

See Also

FloatingCellEnd

FloatingCellEnd moves the cursor to the code just following the current floating cell. While in a floating cell, this command is the equivalent of pressing Tab.

Syntax

FloatingCellEnd

Parameters

None.

See Also

FloatingCellFormula

FloatingCellFormula specifies a formula used in the current floating cell. This command must be used in conjunction with FloatingCellCreate or FloatingCellEdit. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Formula, and entering a formula.

Syntax

FloatingCellFormula(Formula)

Parameters

Formula
A character expression specifying a formula to place in a floating cell.

Example

To create a floating cell containing a formula to add the values of two other floating cells, the command sequence is:

FloatingCellCreate
FloatingCellFormula("FloatingCell_A + FloatingCell_B")

See Also

FloatingCellNumAlignCurrency

FloatingCellNumAlignCurrency specifies whether to align currency symbols. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Options, Align Currency Symbol.

Syntax

FloatingCellNumAlignCurrency(Align)

Parameters

Align
Designates whether to align currency symbols. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not align symbol
Yes! 1 Align symbol

Example

To create a floating cell that formats numbers as currency and aligns the currency symbols, the command sequence is:

FloatingCellCreate
FloatingCellNumberFormat(Currency!)
FloatingCellNumAlignCurrency(Yes!)

See Also

FloatingCellNumberDateFormat

FloatingCellNumberDateFormat specifies a floating cell date format. This command must be used in conjunction with FloatingCellCreate or FloatingCellEdit. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Date, Select Date Format, and selecting a format.

Syntax

FloatingCellNumberDateFormat(Format)

Parameters

Format
Specifies a date format. Select a numeric equivalent.
Numeric Equivalent Description
1 March 5, 1993
3 Mar 5, 1993
4 5 March 1993
5 Friday, March 5, 1993
6 4:18 pm
7 05Mar93
8 March 5, 1993 (4:18pm)
9 1993-03-05
10 3/5
11 Mar 5
12 04:18:25

Example

To edit a floating cell and specify the date format mm/dd/yy, the command sequence is:

FloatingCellEdit
FloatingCellNumberDateFormat(2)

See Also

FloatingCellNumberDecDigits

FloatingCellNumberDecDigits specifies the number of digits to display after the decimal point in a floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, (selecting a Standard Format other than General, Integer, Date, or Text,) Digits After Decimal, and specifying a number.

Syntax

FloatingCellNumberDecDigits(Number)

Parameters

Number
A numeric expression specifying the number of digits to display after a decimal point.

Example

To edit a floating cell and display two digits after the decimal point, the command sequence is:

FloatingCellEdit
FloatingCellNumberDecDigits(2)

See Also

FloatingCellNumberFormat

FloatingCellNumberFormat specifies a number format for floating cells. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, and selecting a format in the Standard Formats group box.

Syntax

FloatingCellNumberFormat(Format)

Parameters

Format
Specifies the format of a number in floating cells. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
General! 0 General
Integer! 1 Integer
Fixed2! 2 Fixed point
Percent! 3 Percent
Currency! 4 Currency
Accounting! 5 Accounting
Commas! 6 Commas
Scientific! 7 Scientific notation
DateFormat! 8 Date format
TextOnly! 9 Text only

Example

To create a floating cell in the scientific notation format, the command sequence is:

FloatingCellCreate
FloatingCellNumberFormat(Scientific!)

See Also

FloatingCellNumberNegNumber

FloatingCellNumberNegNumber specifies how to display negative numbers in a floating cell. This command is equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Negative Numbers, and selecting an option.

Syntax

FloatingCellNumberNegNumber(Type)

Parameters

Type
Specifies the display of negative numbers. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Minus! 0 Minus sign
Parentheses! 1 Parentheses
CRDR! 2 Credit/Debit

Example

To edit a floating cell and display negative numbers in parentheses, the command sequence is:

FloatingCellEdit
FloatingCellNumberNegNumber(Parentheses!)

See Also

FloatingCellNumberRound

FloatingCellNumberRound determines whether to round numbers for calculation in a floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Round for Calculation.

Syntax

FloatingCellNumberRound(Round)

Parameters

Round
Designates whether to round numbers to calculate. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not round numbers
Yes! 1 Round numbers

Example

To edit a floating cell and round numbers for calculation, the command sequence is:

FloatingCellEdit
FloatingCellNumberRound(Yes!)

See Also

FloatingCellNumberUseCommas

FloatingCellNumberUseCommas determines whether to display commas in floating cell numbers. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Use Commas.

Syntax

FloatingCellNumberUseCommas(Commas)

Parameters

Commas
Designates whether to use commas in numbers. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not use commas
Yes! 1 Use commas

Example

To create a floating cell that displays numbers with commas, the command sequence is:

FloatingCellCreate
FloatingCellNumberUseCommas(Yes!)

See Also

FloatingCellNumberUseCurrency

FloatingCellNumberUseCurrency determines whether to use a currency symbol in a floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, On.

Syntax

FloatingCellNumberUseCurrency(Use)

Parameters

Use
Determines whether to use a currency symbol. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not use symbol
Yes! 1 Use symbol

Example

To create a floating cell that displays currency symbols, the command sequence is:

FloatingCellCreate
FloatingCellNumberUseCurrency(Yes!)

See Also

FloatingCellNumSelectCurrency

FloatingCellNumSelectCurrency specifies a currency symbol for floating cells. This command is the equivalent of choosing Layout, Tables, Create Floating Cell or Edit Floating Cell, Number Type, Currency Symbol, Select, and selecting a currency symbol.

Syntax

FloatingCellNumSelectCurrency(Symbol)

Parameters

Symbol
Specifies a currency symbol or country where the currency is used. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DefaultCurrency! 0 Default currency
Dollar! 1 Dollar
Peso! 2 Peso
FrenchCanada! 3 Dollar
Canada! 4 Dollar
Brazil! 5 Cruzeiro
Denmark! 6 Danish Krone
Peseta! 7 Peseta
Croatia! 8 Croatia
CzechRepublic! 9 Koruna
SlovakRepublic! 10 Koruna
Finland! 11 Markka
FinlandIntl! 12 Markka
France! 13 Franc
Germany! 14 Deutsche Mark
Greece! 15 Drachma
Hungary! 16 Forint
Iceland! 17 Krona
Italy! 18 Lira
Japan! 19 Yen
Netherlands! 20 Guilder
Norway! 21 Krone
NorwayIntl! 22 Krone
Ukraine! 23 Ruble
RubleIntl! 24 Ruble
SouthAfrica! 25 Rand
Sweden! 26 Krona
Turkey! 27 Lira
UnitedKingdom! 28 Pound
Switzerland! 29 Swiss Franc
Austria! 30 Schilling
Belgium! 31 Belgian Franc
Ecuador! 32 Sucre
ElSalvador! 33 Colón
Guatemala! 34 Quetzal
Honduras! 35 Lempira
Paraguay! 36 Guaraní
Venezuela! 37 Bolívar
Poland! 38 Zloty
Slovenia! 39 Tolar
Russia! 40 Ruble

Example

To edit a cell and specify the dollar sign ($) as the currency symbol, the command sequence is:

FloatingCellEdit
FloatingCellNumSelectCurrency(Dollar!)

See Also

FlushRight

FlushRight aligns text against the right margin. This command is the equivalent of choosing Layout, Alignment, Flush Right.

Syntax

FlushRight

Parameters

None.

Font

Font selects a font. This command is the equivalent of choosing Font, Font, and selecting a font.

Syntax

Font(Name;Font Family;Attributes;Weight;Width;Source;Font Type;Character Set)

Parameters

Name
A character expression specifying a font.
Font Family (optional)
Specifies the typeface family of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
FamilyITCBenguiat! 256
FamilyTimesRoman! 2304
FamilyITCGaramond! 4352
FamilyCenturySchoolbook! 6400
FamilyBodoni! 8448
FamilyITCLubalinGraph! 10496
FamilyAlbertus! 12544
FamilyCourier! 14592
FamilyHelvetica! 16640
FamilyITCRonda! 18688
FamilyMicrostyle! 20736
FamilyOptima! 22784
FamilyLetterGothic! 24832
FamilyBrush! 26880
FamilyParkAvenue! 28928
FamilySignetRoundhand! 30976
FamilyTekton! 33024
FamilyUncial! 35072
FamilyOldEnglish! 37120
FamilyITCZapfDingbats! 39168
FamilyBroadway! 41216
FamilyComputer! 43264
FamilyPTBarnum! 45312
FamilyPonderosa! 47360
FamilyMadrone! 49408
FamilyHobo! 51456
FamilyRevue! 53504
FamilyAestheticOrnamented! 55552
Attributes (optional)
Specifies the typeface description attribute of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
FontMatchNormal! 0
FontMatchItalic! 1
FontMatchOutline! 2
FontMatchShadow! 4
FontMatchSmallCaps! 8
Weight (optional)
Specifies the typeface weight of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WeightUnknown! 0
WeightUltraThin! 1
WeightUltraLight! 8
WeightExtraThin! 16
WeightThin! 24
WeightExtraLight! 32
WeightLight! 48
WeightDemiLight! 64
WeightSemiLight! 80
WeightBook! 88
WeightRegular! 96
WeightRoman! 104
WeightMedium! 112
WeightDemiBold! 128
WeightSemiBold! 136
WeightBold! 144
WeightExtraBold! 160
WeightHeavy! 176
WeightExtraHeavy! 192
WeightBlack! 208
WeightExtraBlack! 224
WeightUltraHeavy! 240
WeightUltraBlack! 248
WeightMaximum! 254
Width (optional)
Specifies the typeface width of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WidthUnknown! 0
WidthUltraCondensed! 16
WidthUltraCompressed! 32
WidthCompressed! 48
WidthExtraCondensed! 64
WidthCondensed! 80
WidthSemiCondensed! 96
WidthNormal! 112
WidthSemiExpanded! 128
WidthExpanded! 144
WidthExtraExpanded! 160
WidthUltraExpanded! 176
WidthDoubleWide! 192
WidthTripleWide! 224
Source (optional)
Specifies the source of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
PRSFile! 16
DRSFile! 20
Font Type (optional)
Specifies the font type of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Speedo! 134
Intellifont! 135
Type1! 138
TrueType! 139
Character Set (optional)
Specifies the Corel WordPerfect character set associated with a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
FontMatchASCII! 0
FontMatchMultinational1! 1
FontMatchMultinational2! 2
FontMatchBoxDrawing! 3
FontMatchTypographicSymbols! 4
FontMatchIconicSymbols! 5
FontMatchMath! 6
FontMatchMathExtension! 7
FontMatchGreek! 8
FontMatchHebrew! 9
FontMatchCyrillic! 10
FontMatchJapaneseKana! 11
FontMatchUserDefined! 12
FontMatchArabic! 13
FontMatchArabicScript! 14

Example

To select the font named Courier 10 Roman (Speedo), the command is:

Font("Courier 10 Roman (Speedo)")

FontDlg

FontDlg displays the Font dialog box. This command is the equivalent of choosing Font, Font.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FontDlg

Parameters

None.

See Also

FontMatchBegin

FontMatchBegin is the opening command of a FontMatchBegin-FontMatchEnd statement; this statement contains the FontMatchTable command. This statement is the equivalent of choosing Font, Font, Setup, Edit Document Font Mapping Table.

Syntax

FontMatchBegin

Parameters

None.

See Also

FontMatchEnd

FontMatchEnd is the closing command of a FontMatchBegin-FontMatchTable-FontMatchEnd statement. After choosing Font, Font, Setup, Edit Document Font Matching Table, and specifying options, this command is the equivalent of choosing OK or Cancel.

Syntax

FontMatchEnd(State;PRS Filename;Type)

Parameters

State
Determines whether to save or cancel changes to the Font Mapping Table. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancels changes
Save! 1 Saves changes
PRS Filename (optional)
A character expression specifying the current .PRS filename.
Type (optional)
Determines whether to match a font to a printer font or a graphics font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PRSFile! 16 Printer font
DRSFile! 20 Graphics font

Example

To end a FontMatchBegin-FontMatchTable-FontMatchEnd statement where an Apple LaserWriter IINTX is the current printer and the current font is mapped to a graphics font, and to save the changes, the command is:

FontMatchEnd(Save!;"APLW2NTX.PRS";DRSFile!)

FontMatchTable

FontMatchTable specifies attributes of a font and determines whether the matching font is a printer font or a graphics font. This command must be used between FontMatchBegin and FontMatchEnd, and is the equivalent of choosing Font, Font, Setup, Edit Document Font Mapping Table, and entering options.

Syntax

FontMatchTable(Typeface;Attribute;Group;Format;Size;Type;Name;Remove)

Parameters

Typeface
A character expression specifying the name of a font to be matched.
Attribute (optional)
A character expression specifying the attribute of a font to be matched.
Group (optional)
A character expression specifying the group (such as Speedo) of a font to be matched.
Format (optional)
A character expression specifying the format (such as ASCII) of a font to be matched.
Size (optional)
A numeric expression specifying the size of a font to be matched in points or characters per inch (cpi).
Type
Determines whether the matching font is a printer font or a graphics font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PRSFile! 16 Printer font
DRSFile! 20 Graphics font
Name (optional)
A character expression naming the matching font.
Remove (optional)
Removes font mapping. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
RemoveMapping! 1 Remove font mappings

Example

To match a Courier 10pt Bold font with a graphics font, the command is:

FontMatchTable("Courier";"Bold";DRSFile!;"Courier 10 Bold (Speedo)")

FontSize

FontSize sets the font size of a selected font. This command is the equivalent of choosing Font, Font, Size, and entering a size.

Syntax

FontSize(Point Size)

Parameters

Point Size
A measurement expression specifying font size in points.

Example

To set the font size to 14p, the command is:

FontSize(14p)

See Also

FooterA

FooterA determines whether to create, edit, or cancel Footer A, and whether to mark it for printing on odd, even, or all pages. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Footers, Footer A, and selecting Footer A options.

Syntax

FooterA(Footer;Pages)

Parameters

Footer
Determines whether to create, edit, or cancel Footer A. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Cancel
Create! 1 Create
Edit! 2 Edit
Pages (optional)
Specifies pages on which Footer A prints. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OddPages! 1 Odd pages
EvenPages! 2 Even pages
AllPages! 3 All pages

Example

To create Footer A and print it on odd pages, the command is:

FooterA(Create!;OddPages!)

FooterB

FooterB determines whether to create, edit, or cancel Footer B, and whether to mark it for printing on odd, even, or all pages. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Footers, Footer B, and selecting Footer B options.

Syntax

FooterB(Footer;Pages)

Parameters

Footer
Determines whether to create, edit, or cancel Footer B. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Cancel
Create! 1 Create
Edit! 2 Edit
Pages (optional)
Specifies pages on which Footer B prints. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OddPages! 1 Odd pages
EvenPages! 2 Even pages
AllPages! 3 All pages

Example

To Edit Footer B and print it on even pages, the command is:

FooterB(Edit!;EvenPages!)

FooterSeparationDistance

FooterSeparationDistance specifies an amount of blank space above footers. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Footers, Space Above Footer, and specifying a measurement.

Syntax

FooterSeparationDistance(Spacing)

Parameters

Spacing
A measurement expression specifying an amount of blank space above a footer. The default is .167".

Example

To specify .5" of blank space above footers, the command is:

FooterSeparationDistance(0.5")

FootnoteContinuedMessage

FootnoteContinuedMessage determines whether to print "(continued...)" when a footnote is split between two pages. This command is the equivalent of choosing Layout, Footnote, Options, Print Continued Message.

Syntax

FootnoteContinuedMessage(State)

Parameters

State
Determines whether to print a continued message when a footnote is split between two pages. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 No message
Yes! 1 Continued message

Example

To print a continued message, the command is:

FootnoteContinuedMessage(Yes!)

See Also

FootnoteCreate

FootnoteCreate displays a Footnote editing screen. This command is the equivalent of choosing Layout, Footnote, Create.

Syntax

FootnoteCreate

Parameters

None.

See Also

FootnoteEdit

FootnoteEdit displays the Footnote editing screen. If no footnote number is specified, the first footnote to the right of the cursor is edited. If no footnote is found to the right, a Not Found condition is generated. This command is the equivalent of choosing Layout, Footnote, Edit, and specifying a footnote number.

Syntax

FootnoteEdit(Footnote Number)

Parameters

Footnote Number (optional)
A numeric expression specifying a footnote to edit. If this parameter is not specified, the next footnote is edited.

Example

To edit the third footnote of a document, the command is:

FootnoteEdit(3)

See Also

FootnoteEditDlg

FootnoteEditDlg displays the Footnote Number dialog box. This command is the equivalent of choosing Layout, Footnote, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FootnoteEditDlg

Parameters

None.

See Also

FootnoteMinimum

FootnoteMinimum specifies the minimum amount of footnote text to keep together on a page. This command is the equivalent of choosing Layout, Footnote, Options, Amount of Footnote to Keep Together, and specifying a measurement.

Syntax

FootnoteMinimum(Amount)

Parameters

Amount
A measurement expression specifying the minimum amount of footnote text to keep together. The default is .5".

Example

To keep 1" of footnote text together, the command is:

FootnoteMinimum(1")

See Also

FootnoteNewNumber

FootnoteNewNumber specifies a starting number for footnotes. This command is the equivalent of choosing Layout, Footnote, New Number, New Number, and entering a new number.

Syntax

FootnoteNewNumber(Number)

Parameters

Number
A numeric expression specifying a starting number.

Example

To start footnote numbering at three, the command is:

FootnoteNewNumber(3)

FootnoteNumberDecrement

FootnoteNumberDecrement decreases a footnote number by one. This command is the equivalent of choosing Layout, Footnote, New Number, Decrement Number.

Syntax

FootnoteNumberDecrement

Parameters

None.

See Also

FootnoteNumberDisplay

FootnoteNumberDisplay copies the current footnote number into a document at the cursor position. This command is the equivalent of choosing Layout, Footnote, New Number, Display in Document.

Syntax

FootnoteNumberDisplay

Parameters

None.

See Also

FootnoteNumberIncrement

FootnoteNumberIncrement increases a footnote number by one. This command is the equivalent of choosing Layout, Footnote, New Number, Increment Number.

Syntax

FootnoteNumberIncrement

Parameters

None.

See Also

FootnoteNumberMethod

FootnoteNumberMethod selects a footnote numbering method. This command is the equivalent of choosing Layout, Footnote, New Number, Numbering Method, and selecting a numbering method. Including the optional second parameter with this command is the equivalent of choosing Characters from the Set Footnote Number dialog box, and entering up to five characters.

Syntax

FootnoteNumberMethod(Numbering Method;Character Method)

Parameters

Numbering Method
Specifies a footnote numbering method. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Numbers
LowerLetters! 1 Lowercase letters
UpperLetters! 2 Uppercase letters
LowerRoman! 3 Lowercase Roman numerals
UpperRoman! 4 Uppercase Roman numerals
Characters! 5 Characters
Character Method (optional)
A character expression specifying the character(s) to be used to mark footnotes when the Characters! numbering method is selected.

Example

To specify the asterisk (*) as the footnote numbering method, the command is:

FootnoteNumberMethod(Characters!;"*")

See Also

FootnoteOptionsDlg

FootnoteOptionsDlg displays the Footnote Options dialog box. This command is the equivalent of choosing Layout, Footnote, Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FootnoteOptionsDlg

Parameters

None.

See Also

FootnotePosition

FootnotePosition specifies where footnotes will be printed. This command is the equivalent of choosing Layout, Footnote, Options, Footnotes at Bottom of Page.

Syntax

FootnotePosition(Position)

Parameters

Position
Determines whether footnotes will be printed at the bottom of the page or just below the last line of text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
BottomOfPage! 0 Bottom of page
AfterText! 1 After text

Example

To position footnotes at the bottom of the page, the command is:

FootnotePosition(BottomOfPage!)

See Also

FootnoteRestartEachPage

FootnoteRestartEachPage determines whether to restart footnote numbering on every page. This command is the equivalent of choosing Layout, Footnote, Options, Restart Footnote Numbers each Page.

Syntax

FootnoteRestartEachPage(State)

Parameters

State
Determines whether to restart footnote numbering on every page. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not restart
Yes! 1 Restart

Example

To restart footnote numbering on every page, the command is:

FootnoteRestartEachPage(Yes!)

See Also

FootnoteSeparatorLine

FootnoteSeparatorLine specifies the characteristics of a separator line between text and footnotes. This command is the equivalent of choosing Layout, Footnote, Options, Footnote Separator Line, and selecting options.

Syntax

FootnoteSeparatorLine(Separator Line;Space;Alignment;Width;Position)

Parameters

Separator Line
Specifies the type of separator line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
SingleLine! 0
DoubleLine! 1
DashedLine! 2
DottedLine! 3
ThickLine! 4
ExtraThickLine! 5
ThickThinLine! 6
ThinThickLine! 7
ButtonTopLeftLine! 8
ButtonBottomRightLine! 9
TableDefaultLine! 126
NoLine! 127
Space
A measurement expression specifying the amount of space above a separator line.
Alignment
Specifies how the separator line is justified. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Left! 0
Full! 1
Center! 2
Right! 3
SetPosition! 4
Width (optional)
A measurement expression specifying the width of a separator line.
Position (optional)
A measurement expression specifying the distance of a separator line from the left edge of the page.

Example

To create a separator line with .5" of space above the line and .25" below, 2" from the left edge of the paper, and 3" in length, the command is:

FootnoteSeparatorLine(DoubleLine!;.5";.25";SetPosition!;3";2")

See Also

FootnoteSetNumberDlg

FootnoteSetNumberDlg displays the Set Footnote Number dialog box. This command is the equivalent of choosing Layout, Footnote, New Number.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FootnoteSetNumberDlg

Parameters

None.

See Also

FootnotesSpaceBetween

FootnotesSpaceBetween specifies the amount of blank space between footnotes. This command is the equivalent of choosing Layout, Footnote, Options, Spacing Between Footnotes, and specifying a measurement.

Syntax

FootnotesSpaceBetween(Spacing)

Parameters

Spacing
A measurement expression specifying the amount of blank space between footnotes. The default is .167".

Example

To specify .25" blank space between footnotes, the command is:

FootnotesSpaceBetween(.25")

See Also

FootnoteStyleDlg

FootnoteStyleDlg displays the Footnote Style In Note dialog box. This command is the equivalent of choosing Layout, Footnote, Edit Style in Note. This command is not recordable. To use this command, you must type it into the macro.

Syntax

FootnoteStyleDlg

Parameters

None.

FootnoteStyleInDocDlg

FootnoteStyleInDocDlg displays the Footnote Style In Document dialog box. This command is the equivalent of choosing Layout, Footnote, Edit Style in Doc. This command is not recordable. To use this command, you must type it into the macro.

Syntax

FootnoteStyleInDocDlg

Parameters

None.

ForcePage

ForcePage specifies that a certain page will always have an odd or even number. This command is the equivalent of choosing Layout, Page, Force Page, and selecting Even, Odd, or New.

Syntax

ForcePage(State)

Parameters

State
Determines whether a page number is odd or even. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Even! 0
Odd! 1
New! 2

Example

To insert a blank page, forcing an even page number to odd, the command is:

ForcePage(Odd!)

FormatCharacterDlg

FormatCharacterDlg displays the Character Format dialog box. This command is the equivalent of choosing Layout, Character.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatCharacterDlg

Parameters

None.

FormatDlg

FormatDlg displays the Format dialog box. This command is the equivalent of pressing Format (Shift+F8).

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatDlg

Parameters

None.

FormatDocDlg

FormatDocDlg displays the Document Format dialog box. This command is the equivalent of choosing Layout, Document.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatDocDlg

Parameters

None.

FormatForDefaultPrinter

FormatForDefaultPrinter determines whether an opened or retrieved document is formatted for the default printer. This command is the equivalent of choosing File, Setup, Environment, Format Document for Default Printer on Open.

Syntax

FormatForDefaultPrinter(State)

Parameters

State
Determines whether an opened or retrieved document is formatted for the default printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
No! 0
Yes! 1

Example

To format a document for the default printer, the command is:

FormatForDefaultPrinter(Yes!)

FormatLineDlg

FormatLineDlg displays the Line Format dialog box. This command is the equivalent of choosing Layout, Line.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatLineDlg

Parameters

None.

FormatMarginsDlg

FormatMarginsDlg displays the Margin Format dialog box. This command is the equivalent of choosing Layout, Margins.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatMarginsDlg

Parameters

None.

FormatOtherDlg

FormatOtherDlg displays the Other Format dialog box. This command is the equivalent of choosing Layout, Other.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatOtherDlg

Parameters

None.

FormatPageDlg

FormatPageDlg displays the Page Format dialog box. This command is the equivalent of choosing Layout, Page.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

FormatPageDlg

Parameters

None.

FramedWindowSetup

FramedWindowSetup determines whether a current document window is displayed in a frame or as a full window. This command is the equivalent of choosing Window, Frame (to display a document window in a frame); or choosing Window, Maximize (to display a document window as a full window).

Syntax

FramedWindowSetup(State)

Parameters

State
Determines whether a document window is displayed in a frame. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Off! 0
On! 1

Example

To display a document window in a frame, the command is:

FramedWindowSetup(On!)

GenerateDlg

GenerateDlg displays the Generate dialog box. This command is the equivalent of choosing Tools, Generate.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

GenerateDlg

Parameters

None.

See Also

GenerateDoc

GenerateDoc generates Endnotes, Indexes, Tables of Contents, Lists, Cross References, Tables of Authorities, and Master Documents. This command is the equivalent of choosing Tools, Generate, and selecting or unselecting Save Modified Subdocuments.

Syntax

GenerateDoc(State;Undo)

Parameters

State (optional)
Specifies whether changes to individual subdocuments in a master document are saved. This parameter is not necessary if you are not generating in a master document. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DontSave! 0 Don't save subdocs
Save! 1 Save subdocs
Undo (optional)
Specifies whether the Allow Undo feature is active for documents that require generating. Generally, if Allow Undo is off, documents will generate more quickly. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoUndo! 0 Allow Undo is off
Undo! 1 Allow Undo is active

Example

To generate a document, save subdocuments and disable the Allow Undo feature, the command is:

GenerateDoc(Save!;NoUndo!)

See Also

GenerateUndo

GenerateUndo specifies whether the Allow Undo feature is active for all subsequent documents to be generated. This command is the equivalent of choosing Tools, Generate, Allow Undo.

Syntax

GenerateUndo(Undo)

Parameters

Undo
Specifies whether the Allow Undo feature is active for all subsequent documents to be generated. If the Allow Undo feature is disabled, documents may generate more quickly. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoUndo! 0 Allow Undo is off
Undo! 1 Allow Undo is active

Example

To disable the Allow Undo feature for all subsequent documents to be generated, the command is:

GenerateUndo(NoUndo!)

See Also

GetProfileData

GetProfileData gets information about a document from SoftSolutions. In order to use GetProfileData, you must have SoftSolutions installed on your system.

Syntax

GetProfileData

Parameters

Refer to your SoftSolutions handbook for parameters.

Example

To return the available information from SoftSolutions concerning the author and data set of the current document, the command is:

GetProfileData("%A%D")

GoToDlg

GoToDlg displays the Go To dialog box. This command is not recordable. To use this command, you must type it into your macro. This command is the equivalent of choosing Edit, Go To.

Syntax

GoToDlg

Parameters

None.

See Also

GoToDos

GoToDos takes you to a DOS prompt and allows you to perform DOS commands. Once at a DOS prompt, typing Exit returns you to Corel WordPerfect, and macro execution continues. This command is the equivalent of choosing File, Go to Shell, Go to DOS.

Syntax

GoToDos

Parameters

None.

See Also

GoToKey

GoToKey performs the same function as the GoToDlg command unless you are in the Equation Editor. If you execute this command in the Equation Editor when the View Equation window is selected, this command forces the equation to fit in the window. GoToKey either enlarges or reduces the display size of the equation to fit in the View Equation window. In the Equation Editor, this command is the equivalent of choosing View, Zoom Fill.

Syntax

GoToKey

Parameters

None.

See Also

GoToMail

GoToMail executes your mail program.

Syntax

GoToMail

Parameters

None.

GoToShell

GoToShell takes you from Corel WordPerfect to the shell or the menu from which you executed Corel WordPerfect. Macro execution continues once you return to Corel WordPerfect. This command is the equivalent of choosing File, Go To Shell, Active Programs, Shell

Syntax

GoToShell

Parameters

None.

See Also

Grammatik

The Grammatik command executes Grammatik®, a grammar checking program. This command is the equivalent of choosing Tools, Writing Tools, Grammatik.

Syntax

Grammatik

Parameters

None.

GraphicsColorsAssign

GraphicsColorsAssign modifies screen element colors in a color scheme. You cannot use this command to modify color schemes which shipped with this program. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, selecting a color scheme, Edit, selecting a screen element, Color, selecting a color, Select.

Syntax

GraphicsColorsAssign(Name;Type;Red Value;Green Value;Blue Value)

Parameters

Name
A character expression naming a color scheme to be modified.
Type
Specifies a screen element to modify. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DlgBackground! 0 Changes dialog background
DlgBorder! 1 Changes dialog border
DlgUpperLightReflection! 2 Changes border reflection
DlgDarkShadow! 3 Changes border shadow of an active dialog
DlgLightShadow! 4 Changes border shadow of an inactive dialog
DlgActiveTitle! 5 Changes active title bar
DlgInactiveTitle! 6 Changes inactive title bar
CheckBoxBackground! 7 Changes check box background
CheckBoxActive! 8 Changes check mark
ComboButtonBackground! 9 Changes combo button
ScrollBarFill! 10 Changes scroll bar
DlgTextColor! 11 Changes dialog text
DlgBoldTextColor! 12 Changes available options
DlgInactiveTextColor! 13 Changes unavailable options
PullDownBackground! 14 Changes pull-down menu color
PullDownBorder! 15 Changes pull-down border
DlgBlockTextColor! 17 Changes background color of blocked text in dialog
DlgBlockBackground! 18 Changes text color of blocked text in dialog
MousePointerFill! 19 Changes mouse pointer
MousePointerBorder! 20 Changes border of mouse pointer
DocumentBackground! 21 Changes document background
DocumentTextColor! 22 Changes document foreground (text)
Red Value
A numeric expression representing the amount of red in a color. Values range from 0 to 255.
Green Value
A numeric expression representing the amount of green in a color. Values range from 0 to 255.
Blue Value
A numeric expression representing the amount of blue in a color. Values range from 0 to 255.

Example

To modify a check box background color in a color scheme named My Colors, the command is:

GraphicsColorsAssign("My Colors";CheckBoxBackground!;255;207;191)

See Also

GraphicsColorsCopy

GraphicsColorsCopy copies colors from one color scheme to another. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, Color Schemes, Copy.

Syntax

GraphicsColorsCopy(Source Color Scheme Name;Target Color Scheme Name)

Parameters

Source Color Scheme Name
A character expression naming a color scheme to be copied.
Target Color Scheme Name
A character expression containing the name of a color scheme to which you are copying.

Example

To copy colors from a color scheme named A Colors to a color scheme named B Colors, the command is:

GraphicsColorsCopy("A Colors";"B Colors")

See Also

GraphicsColorsCreate

GraphicsColorsCreate creates a color scheme in the Graphics Mode Screen Type/Colors dialog box. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, Color Schemes, Create, and entering a color scheme name.

Syntax

GraphicsColorsCreate(Color Scheme Name)

Parameters

Color Scheme Name
A character expression naming a color scheme to be created.

Example

To create a color scheme named My Colors, the command is:

GraphicsColorsCreate("My Colors")

See Also

GraphicsColorsDelete

GraphicsColorsDelete deletes a color scheme in the Graphics Mode Screen Type/Colors dialog box. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, selecting a color scheme, and choosing Delete.

Syntax

GraphicsColorsDelete(Color Scheme Name)

Parameters

Color Scheme Name
A character expression naming a color scheme to be deleted.

Example

To delete a color scheme named My Colors, the command is:

GraphicsColorsDelete("My Colors")

See Also

GraphicsColorsSelect

GraphicsColorsSelect selects a color scheme in the Graphics Mode Screen Type/Colors dialog box. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, Color Schemes, selecting a color scheme, and choosing Select.

Syntax

GraphicsColorsSelect(Color Scheme Name)

Parameters

Color Scheme Name
A character expression naming a color scheme to be selected.

Example

To select a color scheme My Colors, the command is:

GraphicsColorsSelect("My Colors")

See Also

GraphicsDlg

GraphicsDlg displays the Graphics dialog box, which allows you to create and customize graphics boxes, graphics lines, graphics styles, and borders. This command is the equivalent of pressing Alt+F9

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

GraphicsDlg

Parameters

None.

GraphicsFontsActivate

GraphicsFontsActivate toggles screen font types on or off. This command is the equivalent of choosing File, Setup, Location of Files, Graphics Fonts Data Files, Activate.

Syntax

GraphicsFontsActivate(Type;State)

Parameters

Type
Specifies a graphics font type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Speedo! 134 Bitstream Speedo fonts
Bullet! 135 Bullet fonts
Type1! 138 Type 1 fonts
TrueType! 139 True Type fonts
State
Determines whether to activate a font type.
Enumerated Type Numeric Equivalent Description
No! 0 Do not activate
Yes! 1 Activate

Example

To deactivate the Bitstream Speedo screen fonts, the command is:

GraphicsFontsActivate(Speedo!;No!)

GraphicsFontsPathsDlg

GraphicsFontsPathsDlg displays the Graphics Fonts Data Files dialog box. This command is the equivalent of choosing File, Setup, Location of Files, Graphics Fonts Data Files.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

GraphicsFontsPathsDlg

Parameters

None.

GraphicsFontsSelectBegin

GraphicsFontsSelectBegin is the opening command of the GraphicsFontsSelectBegin-GraphicsFontsSelectMarkFont-GraphicsFontsSelectEnd statement; this statement contains graphics font information. This statement is the equivalent of choosing Font, Font, Setup, Select Graphics Fonts, and selecting graphics fonts.

Syntax

GraphicsFontsSelectBegin

Parameters

None.

See Also

GraphicsFontsSelectEnd

GraphicsFontsSelectEnd is the closing command of the GraphicsFontsSelectBegin-GraphicsFontsSelectMarkFont-GraphicsFontsSelectEnd statement; this statement contains graphics font information. This statement is the equivalent of selecting OK or Cancel in the Select Graphics Fonts dialog box.

Syntax

GraphicsFontsSelectEnd(State)

Parameters

State
Determines whether to save graphics font selections. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancels selections
Save! 1 Saves selections

Example

To save font selections, the command is:

GraphicsFontsSelectEnd(Save!)

See Also

GraphicsFontsSelectMarkFont

GraphicsFontsSelectMarkFont designates which fonts can be used as graphics fonts. This command is used in conjunction with GraphicsFontsSelectBegin and GraphicsFontsSelectEnd commands. This command is the equivalent of choosing Font, Font, Setup, Select Graphics Fonts, and marking or unmarking graphics fonts with an asterisk.

Syntax

GraphicsFontsSelectMarkFont(Font;Mark)

Parameters

Font
A character expression specifying a graphics font.
Mark
Determines whether the font in the first parameter is marked as a graphics font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DRSMark! 0 Mark Font
DRSUnmark! 1 Unmark Font

Example

To mark the Swiss 721 Roman (Speedo), the command is:

GraphicsFontsSelectMarkFont("Swiss 721 Roman (Speedo)";DRSMark!)

See Also

GraphicsFontsUpdate

GraphicsFontsUpdate updates graphics fonts (generates new Automatic Font Changes for WP.DRS). This command is the equivalent of choosing Font, Font, Setup, Update Graphic Fonts.

Syntax

GraphicsFontsUpdate

Parameters

None.

See Also

GraphicsLineColor

GraphicsLineColor specifies the color of a graphics line. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Color, Choose Color, and selecting a color.

Syntax

GraphicsLineColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)

Parameters

Color Name (optional)
A character expression specifying graphics line color.
Red Value (optional)
A numeric expression representing the amount of red in a color. Values range from 0 to 255.
Green Value (optional)
A numeric expression representing the amount of green in a color. Values range from 0 to 255.
Blue Value (optional)
A numeric expression representing the amount of blue in a color. Values range from 0 to 255.
Shading Value (optional)
A numeric expression representing the shading percentage of a color. Values range from 0 to 100.

Example

To make the color of a graphics line red, the command is:

GraphicsLineColor("Red";255;0;0;100)

See Also

GraphicsLineCreate

GraphicsLineCreate creates a graphics line. This command must be used in conjunction with other commands, such as GraphicsLineEnd. GraphicsLineCreate creates a horizontal line unless otherwise specified by GraphicsLineType. This command is the equivalent of choosing Graphics, Graphics Lines, Create.

Syntax

GraphicsLineCreate

Parameters

None.

See Also

GraphicsLineDelete

GraphicsLineDelete deletes a graphics line. This command is the equivalent of selecting a graphics line, pressing Delete, and typing Y.

Syntax

GraphicsLineDelete(Graphics Line Number)

Parameters

Graphics Line Number
A numeric expression specifying a graphics line number to delete.

Example

To delete graphics line three, the command is:

GraphicsLineDelete(3)

GraphicsLineDlg

GraphicsLineDlg displays the Create Graphics Line (or Edit Graphics Line) dialog box. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

GraphicsLineDlg

Parameters

None.

See Also

GraphicsLineEdit

GraphicsLineEdit specifies the number of a graphic to edit. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Edit, Graphics Line Number, entering a line number, and choosing Edit Line.

Syntax

GraphicsLineEdit(Graphics Line Number)

Parameters

Graphics Line Number
A numeric expression specifying a graphics line to edit.

Example

To edit graphics line one, the command is:

GraphicsLineEdit(1)

See Also

GraphicsLineEditNext

GraphicsLineEditNext must be used in conjunction with other commands, such as GraphicsLineEnd, to edit the first graphics line to the right of the cursor. If the cursor is resting on a graphics line code, the graphics line on which the cursor is resting is edited. After editing, the cursor is repositioned to the right of the edited graphics line code. This command is the equivalent of choosing Graphics, Graphics Lines, Edit, Next Graphics Line, Edit Line.

Syntax

GraphicsLineEditNext

Parameters

None.

See Also

GraphicsLineEditPrevious

GraphicsLineEditPrevious must be used in conjunction with other commands, such as GraphicsLineEnd, to edit the first graphics line to the left of the cursor. After editing, the cursor is repositioned to the right of the edited graphics line code. This command is the equivalent of choosing Graphics, Graphics Lines, Edit, Previous Graphics Line, Edit Line.

Syntax

GraphicsLineEditPrevious

Parameters

None.

See Also

GraphicsLineEnd

GraphicsLineEnd ends a series of commands modifying the appearance of a graphics line and specifies whether the changes will be saved or canceled. GraphicsLineEnd must be used in conjunction with other commands, such as GraphicsLineEdit or GraphicsLineCreate. This command is the equivalent of choosing OK or Cancel in the Create Graphics Line or Edit Graphics Line dialog box.

Syntax

GraphicsLineEnd(State)

Parameters

State
Specifies whether modifications made to the graphics line will be saved or canceled. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancels changes
Save! 1 Saves changes

Example

To end a series of commands modifying a graphics line and save changes, the command is:

GraphicsLineEnd(Save!)

See Also

GraphicsLineHorizontalPosition

GraphicsLineHorizontalPosition positions a graphics line horizontally. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. GraphicsLineHorizontalPosition is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Horizontal Position, and selecting position.

Syntax

GraphicsLineHorizontalPosition(Location;Position;Column Number)

Parameters

Location
Specifies the horizontal location of a graphics line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Positions line to the left
Center! 2 Centers line
Right! 3 Positions line to the right
FullAlign! 7 Line spans width of page
Set! 8 Sets an exact page position
BetweenColumns! 9 Position line between columns
Position (optional)
A measurement expression which specifies the exact position on a page to place the graphics line. Use this parameter if you specified Set as the Location parameter.
Column Number (optional)
A numeric expression which specifies which column to place the graphics line to the right of. Use this parameter if you specified BetweenColumns! as the Location parameter.

Example

To center a graphics line horizontally on a page, the command is:

GraphicsLineHorizontalPosition(Center!)

See Also

GraphicsLineLength

GraphicsLineLength modifies the length of graphics lines. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. To use this command, the horizontal or vertical position of the graphics line may not be set to Full in the Create Graphics Line (or Edit Graphics Line) dialog box. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Length, and specifying the length.

Syntax

GraphicsLineLength(Length)

Parameters

Length
A measurement expression specifying the length of a graphics line.

Example

To create a 2.5" graphics line, the command is:

GraphicsLineLength(2.5")

See Also

GraphicsLineSpacing

GraphicsLineSpacing specifies the amount of white space between a graphics line and text. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. GraphicsLineSpacing is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Spacing, and specifying an amount.

Syntax

GraphicsLineSpacing(Amount Above Line;Amount Below Line)

Parameters

Amount Above Line
A measurement expression specifying the amount of space above a horizontal graphics line or to the left of a vertical graphics line between the line and text.
Amount Below Line (optional)
A measurement expression specifying the amount of space below a horizontal graphics line or to the right of a vertical graphics line between the line and text.

Example

To specify .25" space above and below a graphics line, the command is:

GraphicsLineSpacing(.25";.25")

See Also

GraphicsLineStyle

GraphicsLineStyle modifies the style of a graphics line. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. GraphicsLineStyle is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Line Style, and selecting a style.

Syntax

GraphicsLineStyle(Style)

Parameters

Style
Specifies a graphics line style. To specify a user-created style, use a character expression. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Single line style
DoubleLine! 1 Double line style
DashedLine! 2 Dashed line style
DottedLine! 3 Dotted line style
ThickLine! 4 Thick line style
ExtraThickLine 5 Extra Thick line style
ThickThinLine! 6 Thick Thin line style
ThinThickLine! 7 Thin Thick line style
ButtonTopLeftLine! 8 Button Top Left line style
ButtonBottomRightLine! 9 Button Bottom Right line style
TableDefaultLine! 126 Table Default line style
NoLine! 127 No line

Example

To create a dotted graphics line, the command is:

GraphicsLineStyle(DottedLine!)

See Also

GraphicsLineThickness

GraphicsLineThickness specifies the width or thickness of a graphics line. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Thickness, Auto or Set; if Set, specify thickness.

Syntax

GraphicsLineThickness(Width)

Parameters

Width
To specify the thickness of a graphics line, use a measurement expression. To let Corel WordPerfect select the line thickness, select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
AutoThickness! 2 Corel WordPerfect auto selects line thickness

Example

To make a graphics line .75" thick, the command is:

GraphicsLineThickness(.75")

See Also

GraphicsLineType

GraphicsLineType specifies whether a graphics line is horizontal or vertical. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Line Orientation, Horizontal or Vertical.

Syntax

GraphicsLineType(Orientation)

Parameters

Orientation
Specifies whether a graphics line is horizontal or vertical. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Horizontal! 0 Horizontal graphics line
Vertical! 1 Vertical graphics line

Example

To create a vertical graphics line, the command is:

GraphicsLineType(Vertical!)

See Also

GraphicsLineUseColor

GraphicsLineUseColor determines whether a graphics line uses the predefined line style color. When the State parameter is set to No!, you may choose a color using GraphicsLineColor. This command must be used in conjunction with other commands, such as GraphicsLineColor, GraphicsLineCreate, and GraphicsLineEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, Color, Use Line Style Color or Choose Color.

Syntax

GraphicsLineUseColor(State)

Parameters

State
Specifies whether a graphics line uses a predefined line style color. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Do not use predefined line style color
Yes! 1 Use predefined line style color

Example

To format a graphics line with the predefined line style color, the command is:

GraphicsLineUseColor(Yes!)

See Also

GraphicsLineVerticalPosition

GraphicsLineVerticalPosition specifies the vertical position of a graphics line. This command must be used in conjunction with other commands, such as GraphicsLineCreate and GraphicsLineEnd. GraphicsLineVerticalPosition is the equivalent of choosing Graphics, Graphics Lines, Create or Edit, and selecting a position.

Syntax

GraphicsLineVerticalPosition(Location;Position)

Parameters

Location
Specifies the vertical location of a graphics line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Top! 1 Position line at top of page
Center! 2 Center line on page
Bottom! 4 Position line at bottom of page
Baseline! 6 Position line at bottom of current line
FullAlign! 7 Line spans width of page
Set! 8 Sets line at a precise position on page
Position (optional)
A measurement expression specifying the exact position of a graphics line. Use this parameter if you specified Set! as the Location parameter.

Example

To position a vertical line at the top of a page, the command is:

GraphicsLineVerticalPosition(Top!)

See Also

GraphicsScreenAutoselect

GraphicsScreenAutoSelect allows Corel WordPerfect to select a graphics screen driver. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, Screen Type, Auto Select.

Syntax

GraphicsScreenAutoselect

Parameters

None.

See Also

GraphicsScreenOptionsDlg

GraphicsScreenOptionsDlg displays the Graphics Mode Screen Type/Colors dialog box. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

GraphicsScreenOptionsDlg

Parameters

None.

GraphicsScreenSelect

GraphicsScreenSelect selects a screen type for graphics mode display. This command must be used in conjunction with SetupSave. This command is the equivalent of choosing File, Setup, Display, Graphics Mode Screen Type/Colors, Screen Type, highlighting a general screen type, choosing Select, highlighting a specific screen type, and choosing Select.

Syntax

GraphicsScreenSelect(Filename;General Type;Specific Type)

Parameters

Filename
A character expression specifying the name of a graphics driver.
General Type
A character expression specifying the name of a general screen type.
Specific Type
A character expression specifying the name of a specific screen type.

Example

To select an IBM VGA 640x480 16 color screen type, the command is:

GraphicsScreenSelect("VGA.VRS";"IBM VGA";"VGA 640x480 16 Color")

See Also

HardColumnBreak

HardColumnBreak ends a column before the bottom of a page, and moves the cursor to the top of the next column. With columns On, this command is the equivalent of choosing Layout, Alignment, Hard Page.

Syntax

HardColumnBreak

Parameters

None.

HardPageBreak

HardPageBreak inserts a hard page break at the cursor position. This command is the equivalent of pressing Ctrl+Enter or choosing Layout, Alignment, Hard Page.

Syntax

HardPageBreak

Parameters

None.

HardPageBreakKey

HardPageBreakKey inserts a hard page break at the cursor position. This command is the equivalent of pressing Ctrl+Enter, or choosing Layout, Alignment, Hard Page. This command is not recordable. To use this command, you must type it into the macro.

Syntax

HardPageBreakKey

Parameters

None.

HardReturn

HardReturn ends a line. This command is the equivalent of pressing Enter.

Syntax

HardReturn

Parameters

None.

HardReturnDisplayCharacter

HardReturnDisplayCharacter identifies a character to display at each hard return. This command is the equivalent of choosing View, Screen Setup, Display Characters, and entering a character.

Syntax

HardReturnDisplayCharacter(Character)

Parameters

Character
A character expression specifying the character to display at each hard return.

Example

To display a dollar sign ($) at each hard return, the command is:

HardReturnDisplayCharacter("$")

HardSpace

Words separated by a HardSpace command are kept together on one line. This command is the equivalent of pressing Hard Space (Home, Space Bar).

Syntax

HardSpace

Parameters

None.

HeaderA

HeaderA determines whether to create, edit, or cancel Header A, and whether to print it on odd, even, or all pages. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Headers, Header A, and selecting Header A options.

Syntax

HeaderA(Header;Pages)

Parameters

Header
Determines whether to create, edit, or cancel Header A. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Cancel
Create! 1 Create
Edit! 2 Edit
Pages
Specifies pages on which Header A prints. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OddPages! 1 Odd pages
EvenPages! 2 Even pages
AllPages! 3 All pages

Example

To edit Header A and print it on even pages, the command is:

HeaderA(Edit!;EvenPages!)

HeaderB

HeaderB determines whether to create, edit, or cancel Header B, and whether to print it on odd, even, or all pages. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Headers, Header B, and selecting Header B options.

Syntax

HeaderB(Header;Pages)

Parameters

Header
Determines whether to create, edit, or cancel Header B. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Cancel
Create! 1 Create
Edit! 2 Edit
Pages
Specifies the pages on which Header B prints. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OddPages! 1 Odd pages
EvenPages! 2 Even pages
AllPages! 3 All pages

Example

To create Header B and print it on even pages, the command is:

HeaderB(Create!;EvenPages!)

HeaderFooterWatermarkDlg

HeaderFooterWatermarkDlg displays the Header/Footer/Watermark dialog box. This command is the equivalent of choosing Layout, Header/Footer/Watermark.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

HeaderFooterWatermarkDlg

Parameters

None.

HeaderSeparationDistance

HeaderSeparationDistance sets the amount of blank space below headers. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Headers, Space Above Header, and specifying a measurement.

Syntax

HeaderSeparationDistance(Spacing)

Parameters

Spacing
A measurement expression specifying the amount of blank space below a header. The default is .167".

Example

To specify .5" blank space below headers, the command is:

HeaderSeparationDistance(.5")

Help

Help displays the Help dialog box. This command is the equivalent of choosing Help, Contents. This command is not recordable. To use this command, you must type it into the macro.

Syntax

Help

Parameters

None.

HiddenText

HiddenText turns the Hidden Text option on or off. This command is the equivalent of pressing Alt+F5 and choosing Hidden Text, Hidden Text.

Syntax

HiddenText(State)

Parameters

State
Toggles the Hidden Text option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Not hidden text
On! 1 Hidden Text

Example

To create hidden text, the command is:

HiddenText(On!)

See Also

HiddenTextDlg

HiddenTextDlg displays the Hidden Text dialog box. This command is the equivalent of pressing Alt+F5 and choosing Hidden Text.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

HiddenTextDlg

Parameters

None.

HiddenTextShowAll

HiddenTextShowAll shows or hides hidden text. This command is the equivalent of pressing Alt+F5 and choosing Hidden Text, Show All Hidden Text.

Syntax

HiddenTextShowAll(State)

Parameters

State
Toggles the Show All Hidden Text option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Hides hidden text
On! 1 Shows hidden text

Example

To show hidden text, the command is:

HiddenTextShowAll(On!)

See Also

HomeKey

The HomeKey command is not recordable. To use this command, you must type it into the macro. Although Home, Right Arrow moves the cursor to the right side of the screen, the macro facility records the PosScreenRight command. The same is true of other directional commands using the HomeKey.

Syntax

HomeKey

Parameters

None.

HorizontalBarSetup

HorizontalBarSetup toggles the horizontal bar on or off. This command is the equivalent of choosing View, Horizontal Scroll Bar. This command is not recordable. To use this command, you must type it into the macro.

Syntax

HorizontalBarSetup(State)

Parameters

State (optional)
Determines whether to turn on the horizontal bar. If you do not specify this parameter, HorizontalBarSetup works as a toggle. To specify whether the horizontal bar is on or off, select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Bar not displayed
On! 1 Bar displayed

Example

To display the horizontal bar, the command is:

HorizontalBarSetup(Yes!)

HorizontalBarSetupGraphics

HorizontalBarSetupGraphics determines whether the horizontal scroll bar is visible while the program display is in Graphics Mode. This command is the equivalent of choosing View, Screen Setup, Window Options, Hor. Scroll Bar (Graphics).

Syntax

HorizontalBarSetupGraphics(State)

Parameters

State
Specifies whether the horizontal scroll bar is visible in Graphics Mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Horizontal scroll bar not visible
On! 1 Horizontal scroll bar visible

Example

To allow the horizontal scroll bar to be visible while in Graphics Mode, the command is:

HorizontalBarSetupGraphics(On!)

See Also

HorizontalBarSetupText

HorizontalBarSetupText determines whether the horizontal scroll bar is visible while the program display is in Text Mode. This command is the equivalent of choosing View, Screen Setup, Window Options, Hor. Scroll Bar (Text).

Syntax

HorizontalBarSetupText(State)

Parameters

State
Specifies whether the horizontal scroll bar is visible in Text Mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Horizontal scroll bar not visible
On! 1 Horizontal scroll bar visible

Example

To allow the horizontal scroll bar to be visible while in Text Mode, the command is:

HorizontalBarSetupText(On!)

See Also

Hypertext

Hypertext activates all hypertext links. This command is the equivalent of choosing Tools, Hypertext, Hypertext is Active.

Syntax

Hypertext(State)

Parameters

State
Determines whether hypertext is active. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Inactive! 0 Hypertext not active
Active! 1 Hypertext active

Example

To activate hypertext, the command is:

Hypertext(Active!)

HypertextCreate

HypertextCreate identifies a hypertext link type, the location of a bookmark, and whether to identify the hypertext link as highlighted text or as a button. This command is the equivalent of choosing Tools, Hypertext, Create Link, selecting options, and entering a Bookmark or Macro name.

Syntax

HypertextCreate(Hypertext Link;Document/Macro Link;Current Document Link;Hypertext Identifier)

Parameters

Hypertext Link
Determines whether to jump to a bookmark or run a macro. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
GoToBookmark! 0 Jump to bookmark
RunMacro! 1 Run macro
Document/Macro Link
A character expression specifying the name of a macro or document where a bookmark is located.
Current Document Link
A character expression specifying the name of a bookmark within a current document.
Hypertext Identifier
Determines whether a hypertext link is displayed highlighted or as a button.
Enumerated Type Numeric Equivalent Description
HighlightedText! 0 Highlighted
Button! 1 Button

Example

To create a hypertext link to a bookmark named Test Link in a document named TEST.DOC, and display the link as a button, the command is:

HypertextCreate(GoToBookmark!;"C:\COREL\WP62\TEST.DOC";"Test Link";Button!)

See Also

HypertextDelete

HypertextDelete deletes a hypertext link. With the cursor on the link, this command is the equivalent of choosing Tools, Hypertext, Delete Link(s).

Syntax

HypertextDelete

Parameters

None.

HypertextDlg

HypertextDlg displays the Hypertext dialog box. This command is the equivalent of choosing Tools, Hypertext.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

HypertextDlg

Parameters

None.

HypertextEdit

HypertextEdit identifies the type of hypertext link to edit, the location of its bookmark, and whether to identify the hypertext link as highlighted text or as a button. This command is the equivalent of choosing Tools, Hypertext, Edit Link, and editing options.

Syntax

HypertextEdit(Hypertext Link;Document/Macro Link;Current Document Link;Hypertext Identifier)

Parameters

Hypertext Link
Determines whether the hypertext link to edit is a link to a bookmark or to a macro. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
GoToBookmark! 0 Bookmark
RunMacro! 1 Macro
Document/Macro Link
A character expression specifying the name of a macro or document where a bookmark is located.
Current Document Link
A character expression specifying the name of a bookmark.
Hypertext Identifier
Determines whether a hypertext link is highlighted or is displayed as a button. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
HighlightedText! 0 Display as highlighted text
Button! 1 Display as a button

Example

To edit a hypertext link named Test Link in a document named TEST.DOC, the command is:

HypertextEdit(GoToBookmark!;"C:\COREL\WP62\TEST.DOC";"Test Link";Button!)

HypertextJumpRun

HypertextJumpRun jumps from a link to a bookmark, or runs a macro. This command is the equivalent of choosing Tools, Hypertext, Jump/Run.

Syntax

HypertextJumpRun

Parameters

None.

See Also

HypertextNext

HypertextNext advances to the next hypertext link in a document. This command is the equivalent of choosing Tools, Hypertext, Go to Next Link.

Syntax

HypertextNext

Parameters

None.

HypertextPrevious

HypertextPrevious returns to the previous hypertext link in a document. This command is the equivalent of choosing Tools, Hypertext, Go to Previous Link.

Syntax

HypertextPrevious

Parameters

None.

HypertextReturnFrom

HypertextReturnFrom returns from a bookmark to the bookmark's hypertext link. This command is the equivalent of choosing Tools, Hypertext, Return from Jump.

Syntax

HypertextReturnFrom

Parameters

None.

See Also

Hyphenation

Hyphenation determines whether to turn on hyphenation. This command is the equivalent of choosing Layout, Line, Hyphenation.

Syntax

Hyphenation(State)

Parameters

State
Determines whether to turn on hyphenation. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Hyphenation Off
On! 1 Hyphenation On

Example

To turn hyphenation on, the command is:

Hyphenation(On!)

See Also

HyphenationIgnore

HyphenationIgnore determines whether to cancel hyphenation for a particular word. This command is the equivalent of moving to the first letter of a word, pressing Home, and typing a slash (/).

Syntax

HyphenationIgnore

Parameters

None.

See Also

HyphenationPrompt

HyphenationPrompt specifies the prompt action when a word is hyphenated. This command is the equivalent of choosing File, Setup, Environment, Prompt for Hyphenation, and selecting options.

Syntax

HyphenationPrompt(Prompt)

Parameters

Prompt
Specifies a hyphenation prompt. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Never! 0 Do not prompt
WhenRequired! 1 Prompt when required
Always! 2 Prompt always

Example

To stop at each word to be hyphenated, and display the prompt "Position Hyphen; Press ESC," the command is:

HyphenationPrompt(Always!)

HyphenationSoftReturn

HyphenationSoftReturn inserts a Temporary Soft Return at the cursor position. It indicates where a line is broken when the Temporary Soft Return is within the hyphenation zone. This command is the equivalent of pressing Home, Enter.

Syntax

HyphenationSoftReturn

Parameters

None.

HyphenationZoneLeft

HyphenationZoneLeft sets the lower limit of a hyphenation zone; the zone determines whether words are hyphenated at the right margin. This command is the equivalent of choosing Layout, Line, Hyphenation Zone, and specifying a percentage.

Syntax

HyphenationZoneLeft(Left Zone)

Parameters

Left Zone
A numeric expression specifying the lower limit of a hyphenation zone.

Example

To set the lower limit of a hyphenation zone to 10%, the command is:

HyphenationZoneLeft(10)

See Also

HyphenationZoneRight

HyphenationZoneRight sets the upper limit of a hyphenation zone; the zone determines whether words are hyphenated at the right margin. This command is the equivalent of choosing Layout, Line, Hyphenation Zone, and specifying a percentage.

Syntax

HyphenationZoneRight(Right Zone)

Parameters

Right Zone
A numeric expression setting the upper limit of a hyphenation zone.

Example

To set the upper limit of a hyphenation zone to 4%, the command is:

HyphenationZoneRight(4)

See Also

Indent

Indent indents all lines in a paragraph without changing the current margin settings. This command is the equivalent of pressing Indent (F4).

Syntax

Indent

Parameters

None.

See Also

IndentLeftRight

IndentLeftRight indents both left and right margins of all lines in a paragraph. This command is the equivalent of pressing Indent (Shift-F4).

Syntax

IndentLeftRight

Parameters

None.

See Also

IndexDefinition

IndexDefinition specifies an index format. This command is the equivalent of choosing Tools, Index, Define, and selecting options.

Syntax

IndexDefinition(Heading Style;Subheading Style;Numbering Mode;Combine Sequential Page Numbers;Concordance Filename;Page Number Format)

Parameters

Heading Style
Specifies the style of an index heading. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style
Subheading Style

Specifies the style of an index subheading. Select an enumerated type or its numeric equivalent.

See the table under Heading Style above for a list of enumerated types.

Numbering Mode
Specifies the method of displaying a page number after a heading. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DefNone! 0 No number
DefFollows! 1 Follows heading
DefParentheses! 2 In parentheses
DefFlushRight! 3 Flush Right
DefLeader! 4 Flush Right with dot leader
Combine Sequential Page Numbers
Designates whether sequential page numbers are combined (for example, 51-53) or remain separate (for example, 51, 52, 53). Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoCombine! 0 Does not combine numbers
Combine! 1 Combines numbers
Concordance Filename (optional)
A character expression specifying the filename of a concordance file.
Page Number Format (optional)
A character expression specifying an index page number format. If you leave this parameter blank, page numbers are formatted as they are in your document.

Example

To define an index with normal heading styles, numbers flush right, sequential numbers combined, without a concordance filename, and page numbering format the same as the document, the command is:

IndexDefinition(Index1Style!;Index2!Style;DefFlushRight!;Combine!)

See Also

IndexDefinitionDlg

IndexDefinitionDlg displays the Define Index dialog box. This command is the equivalent of choosing Tools, Index, Define.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

IndexDefinitionDlg

Parameters

None.

IndexMark

IndexMark marks text to index. This command is the equivalent of choosing Tools, Index, Mark, and entering a heading and subheading.

Syntax

IndexMark(Heading;Subheading)

Parameters

Heading (optional)
Specifies an index heading.
Subheading (optional)
Specifies an index subheading.

Example

To insert an index code for "Ham, baked," the command is:

IndexMark("Ham";"baked")

See Also

IndexMarkDlg

IndexMarkDlg displays the Mark Index dialog box. This command is equivalent of choosing Tools, Index, Mark.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

IndexMarkDlg

Parameters

None.

See Also

InitialCodesDoc

InitialCodesDoc designates the beginning of the Initial Codes for a document. All codes between InitialCodesDoc and SubstructureExit are placed in the Initial Codes section of the document. This command is the equivalent of choosing Layout, Document, Document Initial Codes.

Syntax

InitialCodesDoc

Parameters

None.

Example

To change the document paper size to Letter (Landscape) in Initial Codes, the command sequence is:

InitialCodesDoc
PaperSizeSelect("Letter (Landscape)")
SubstructureExit

See Also

InitialCodesDocDlg

InitialCodesDocDlg displays the Initial Codes dialog box. This command is the equivalent of choosing Layout, Document, Document Initial Codes.

Syntax

InitialCodesDocDlg

Parameters

None.

See Also

InitialCodesSetup

InitialCodesSetup designates the beginning of the Initial Codes Setup codes. All codes between InitialCodesSetup and SubstructureExit are stored as part of the Initial Codes Setup. This command is the equivalent of choosing Layout, Document, Initial Codes Setup.

Syntax

InitialCodesSetup

Parameters

None.

Example

To insert a LineSpacing(2.0) command in Setup Initial Codes, the command sequence is:

InitialCodesSetup
LineSpacing(2.0)
SubstructureExit

See Also

InitialCodesSetupDlg

InitialCodesSetupDlg displays the Initial Codes Setup dialog box. This command is the equivalent of choosing Layout, Document, Initial Codes Setup.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

InitialCodesSetupDlg

Parameters

None.

See Also

InsertFilename

InsertFilename inserts the current filename at the cursor. This command is the equivalent of choosing Layout, Other, Insert Filename, Insert Filename.

Syntax

InsertFilename

Parameters

None.

See Also

InsertFilenameDlg

InsertFilenameDlg displays the Insert Filename dialog box. This command is the equivalent of choosing Layout, Other, Insert Filename.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

InsertFilenameDlg

Parameters

None.

See Also

InsertFilenameWithPath

InsertFilenameWithPath inserts the current filename and path at the cursor. This command is the equivalent of choosing Layout, Other, Insert Filename, Insert Path and Filename.

Syntax

InsertFilenameWithPath

Parameters

None.

See Also

IrregularCap

IrregularCap specifies whether to turn on or off the feature that lowercases the second of two initial capitals in a word. This command is the equivalent of choosing Tools, QuickCorrect, Options, Correct Two Irregular Capitals.

Syntax

IrregularCap(State)

Parameters

State
Specifies whether to turn on or off the feature that lowercases the second of two initial capitals. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Turn off lowercasing
On! 1 Turn on lowercasing

Example

To lowercase the second of two initial capitals, the command is:

IrregularCap(On!)

ItalicsKey

ItalicsKey turns italics on or off. This command is the equivalent of choosing Fonts, Italics. This command is not recordable. To use this command, you must type it into the macro.

Syntax

ItalicsKey

Parameters

None.

See Also

ItemDown

ItemDown moves the cursor down one section or cell in tables and paragraph numbering. This command is the equivalent of pressing Item Down (Alt+Down Arrow). This command is not recordable. To use this command, you must type it into the macro.

Syntax

ItemDown

Parameters

None.

ItemLeft

ItemLeft moves the cursor left one section, column, or cell in tables and paragraph numbering. This command is the equivalent of pressing Item Left (Alt+Left Arrow). This command is not recordable. To use this command, you must type it into the macro.

Syntax

ItemLeft

Parameters

None.

ItemRight

ItemRight moves the cursor right one section, column, or cell in tables and paragraph numbering. This command is the equivalent of pressing Item Right (Alt+Right Arrow). This command is not recordable. To use this command, you must type it into the macro.

Syntax

ItemRight

Parameters

None.

ItemUp

ItemUp moves the cursor up one section or cell in tables and paragraph numbering. This command is the equivalent of pressing Item Up (Alt+Up Arrow). This command is not recordable. To use this command, you must type it into the macro.

Syntax

ItemUp

Parameters

None.

Justification

Justification aligns text on right or left margins, both margins, or centered between margins. This command is the equivalent of choosing Layout, Justification, and selecting a type.

Syntax

Justification(Type)

Parameters

Type
Specifies text justification. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Left! 0 Left
Full! 1 Full
Center! 2 Center
Right! 3 Right
FullAll! 4 Full, All Lines
DecAlign! 5 Decimal Align (valid only with table tokens)

Example

To center all subsequent lines of text, the command is:

Justification(Center!)

Kerning

Kerning reduces the space between some printed characters if a kerning table exists for the current font. This command is the equivalent of choosing Layout, Other, Printer Functions, Kerning.

Syntax

Kerning(State)

Parameters

State
Determines whether to turn on or turn off Kerning. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Turns kerning off
On! 1 Turns kerning on

Example

To turn kerning on, the command is:

Kerning(On!)

KeyboardCopy

KeyboardCopy creates a copy of a keyboard file. This command is the equivalent of choosing File, Setup, Keyboard Layout, selecting a layout, and choosing Copy.

Syntax

KeyboardCopy(From;To)

Parameters

From
A character expression specifying the filename of a keyboard file to copy from.
To
A character expression specifying the filename of a keyboard file to copy to.

Example

To copy a keyboard file named MYKEYBRD to a file named NEWKYBRD, the command is:

KeyboardCopy("MYKEYBRD";"NEWKYBRD")

See Also

KeyboardCreate

KeyboardCreate creates a keyboard file. This command is the equivalent of choosing File, Setup, Keyboard Layout, Create, and entering a name.

Syntax

KeyboardCreate(Filename)

Parameters

Filename
A character expression naming a new keyboard file.

Example

To create a keyboard file named MYKEYBRD, the command is:

KeyboardCreate("MYKEYBRD")

See Also

KeyboardDelete

KeyboardDelete deletes a keyboard file. This command is the equivalent of choosing File, Setup, Keyboard Layout, selecting a layout, and choosing Delete.

Syntax

KeyboardDelete(Filename)

Parameters

Filename
A character expression specifying a keyboard file to delete.

Example

To delete a keyboard file named MYKEYBRD, the command is:

KeyboardDelete("MYKEYBRD")

See Also

KeyboardLayoutDlg

KeyboardLayoutDlg displays the Keyboard Layout dialog box. This command is the equivalent of choosing File, Setup, Keyboard Layout.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

KeyboardLayoutDlg

Parameters

None.

See Also

KeyboardOriginal

KeyboardOriginal selects the original keyboard definition as the normal keyboard or the Equation Editor keyboard. This command is the equivalent of either choosing File, Setup, Keyboard Layout, and selecting the original keyboard definition, or choosing File, Settings, Keyboard, and selecting the original keyboard definition in the Equation Editor.

Syntax

KeyboardOriginal(Equation)

Parameters

Equation (optional)
Selects the original keyboard definition as the Equation Editor keyboard. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Equation! 4 Equation Editor keyboard

Example

To select the original keyboard definition as the normal keyboard, the command is:

KeyboardOriginal

To select the original keyboard definition as the Equation Editor keyboard, the command is:

KeyboardOriginal(Equation!)

See Also

KeyboardRename

KeyboardRename renames a keyboard. This command is the equivalent of choosing File, Setup, Keyboard Layout, highlighting a keyboard, choosing Rename, and entering a new name.

Syntax

KeyboardRename(From;To)

Parameters

From
A character expression specifying the original filename of a keyboard file to rename.
To
A character expression specifying the new filename of a keyboard file to rename.

Example

To rename a keyboard file named MYKEYBRD to NEWKYBRD, the command is:

KeyboardRename("MYKEYBRD";"NEWKYBRD")

See Also

KeyboardSelect

KeyboardSelect selects a keyboard file for the normal keyboard or Equation Editor keyboard. This command is the equivalent of either choosing File, Setup, Keyboard Layout, and selecting a keyboard definition for the normal keyboard, or choosing File, Settings, Keyboard, and selecting a keyboard definition in the Equation Editor.

Syntax

KeyboardSelect(Filename;Equation)

Parameters

Filename
A character expression specifying the filename of a keyboard file to select.
Equation (optional)
Specifies a keyboard definition for the Equation Editor keyboard. Select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Equation! 4 Equation Editor keyboard

Example

To select a keyboard file named MYKEYBRD for the normal keyboard, the command is:

KeyboardSelect("MYKEYBRD")

To select a keyboard file named MYKEYBRD for the Equation Editor, the command is:

KeyboardSelect("MYKEYBRD";Equation!)

See Also

LabelsDefine

LabelsDefine creates a customized labels definition. This command is the equivalent of choosing Layout, Page, Labels, Create, entering a label description, specifying measurements, and selecting a label type.

Syntax

LabelsDefine(Filename;Labels Name;Label Type;Page Width;Page Length;Columns;Rows;Label Width;Label Length;Left Offset;Top Offset;Between Rows;Between Columns;Left Margin;Right Margin;Top Margin;Bottom Margin)

Parameters

Filename
A character expression specifying an existing filename where customized labels are saved.
Labels Name
A character expression specifying a label's name.
Label Type
A character expression which determines whether the labels displayed in the Labels dialog box are for laser or tractor-feed printers, or both. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Laser! 1 Display only laser labels
TractorFed! 2 Display only tractor-fed labels
LaserAndTractorFed! 3 Display both types of labels
Page Width
A measurement expression specifying the width of a page of labels.
Page Length
A measurement expression specifying the length of a page of labels.
Columns
A numeric expression specifying the number of label columns on a page. Hint: Columns run down the page and are counted across the page.
Rows
A numeric expression specifying the number of label rows on a page. Hint: Rows run across the page and are counted down the page.
Label Width
A measurement expression specifying the width of an individual label.
Label Length
A measurement expression specifying the length of an individual label.
Left Offset
A measurement expression specifying the distance from the left edge of the page to the left edge of the first column of labels.
Top Offset
A measurement expression specifying the distance from the top edge of the page to the top edge of the first row of labels.
Between Rows
A measurement expression specifying the distance between rows of labels.
Between Columns
A measurement expression specifying the distance between columns of labels.
Left Margin
A measurement expression specifying the left margin of each label.
Right Margin
A measurement expression specifying the right margin of each label.
Top Margin
A measurement expression specifying the top margin of each label.
Bottom Margin
A measurement expression specifying the bottom margin of each label.

Example

To create a labels paper size/type named My Labels with 3 columns and 10 rows on an 8.5" x 11" sheet, the command is:

LabelsDefine("WP_WP_US.LAB";"My Labels";Laser!;8.5";11";3;10;2.63";1";0.188";0.5";0.125";0";0";0";0";0")

See Also

LabelsDelete

LabelsDelete deletes a labels definition. This command is the equivalent of choosing Layout, Page, Labels, selecting a labels definition in the Labels list box, and choosing Delete.

Syntax

LabelsDelete(Filename;Labels Name)

Parameters

Filename
A character expression specifying a labels file containing a labels definition to delete.
Labels Name
A character expression specifying the name of labels to delete.

Example

To delete a labels definition named My Labels, the command is:

LabelsDelete("WP_WP_US.LAB";"My Labels")

LabelsDisplay

LabelsDisplay specifies the type of labels displayed in the Labels dialog box. This command is the equivalent of choosing Layout, Page, Labels, and choosing Display Laser, Display Tractor-Fed, or Display Both.

Syntax

LabelsDisplay(Label Type)

Parameters

Label Type
Specifies the type of labels to display in the Label File dialog box. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Laser! 1 Display only laser labels
TractorFed! 2 Display only tractor-fed labels
LaserAndTractorFed! 3 Display both types of labels

Example

To display only tractor-fed labels in the Labels dialog box, the command is:

LabelsDisplay(TractorFed!)

LabelsDlg

LabelsDlg displays the Labels dialog box. This command is the equivalent of choosing Layout, Page, Labels.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LabelsDlg

Parameters

None.

LabelsFileCreate

LabelsFileCreate creates a labels file. This command is the equivalent of choosing Layout, Page, Labels, Label File, Create, and entering a filename.

Syntax

LabelsFileCreate(Filename)

Parameters

Filename
A character expression specifying the full pathname of a new label file.

Example

To create a labels file named CUSTOM.LAB in the C:\COREL\WP62 directory, the command is:

LabelsFileCreate("C:\COREL\WP62\CUSTOM.LAB")

See Also

LabelsFileDescription

LabelsFileDescription adds a description to an existing labels file. This command is the equivalent of choosing Layout, Page, Labels, Label File, highlighting a labels file, choosing Edit, and entering a description.

Syntax

LabelsFileDescription(Filename;Description)

Parameters

Filename
A character expression specifying the full pathname of a labels file. If the specified labels file does not exist, a Not Found condition is generated.
Description
A character expression specifying a description to add to a labels file.

Example

To add the description Label Library to a labels file named CUSTOM.LAB, the command is:

LabelsFileDescription("C:\COREL\WP62\CUSTOM.LAB";"Label Library")

See Also

LabelsFileSelect

LabelsFileSelect selects a labels file. The label definitions contained in the labels file are displayed in the Labels list box in the Labels dialog box. If the specified filename does not exist, this command has no effect. This command is the equivalent of choosing Layout, Page, Labels, Label File, highlighting a labels file, and choosing Select.

Syntax

LabelsFileSelect(Filename)

Parameters

Filename
A character expression specifying the complete pathname of a labels file to select.

Example

To select a labels file named CUSTOM.LAB, the command is:

LabelsFileSelect("C:\COREL\WP62\CUSTOM.LAB")

See Also

LabelsOff

LabelsOff discontinues the labels definition, starts a new page, and selects an 8.5" x 11" portrait paper size/type. This command is the equivalent of choosing Layout, Page, Labels, Labels Off.

Syntax

LabelsOff

Parameters

None.

LabelsSelect

LabelsSelect selects a labels definition. This command is the equivalent of choosing Layout, Page, Labels, highlighting a labels definition paper size/type from the Labels list box, and choosing Select.

Syntax

LabelsSelect(Filename;Labels Name)

Parameters

Filename
A character expression specifying the full pathname of the labels file you are making the selection from.
Labels Name
A character expression specifying the name of the selected labels definition.

Example

To select a labels definition named My Labels from the default Corel WordPerfect labels file named WP_WP_US.LAB, the command is:

LabelsSelect("C:\COREL\WP62\WP_WP_US.LAB";"My Labels")

Language

Language specifies the language used for a document or section of text. This command is the equivalent of choosing Layout, Other, Language, and selecting a language.

Syntax

Language(Language Code)

Parameters

Language Code
A two-character character expression specifying the language of a document or section of text.

Example

To specify Spanish as the language of a section of text, the command is:

Language("ES")

LanguageSelectDlg

LanguageSelectDlg displays the Select Language dialog box. This command is the equivalent of choosing Layout, Other, Language.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LanguageSelectDlg

Parameters

None.

See Also

Leading

Leading specifies leading adjustment. This command is the equivalent of choosing Layout, Other, Printer Functions, Leading Adjustment, and specifying a leading adjustment.

Syntax

Leading(Amount)

Parameters

Amount
A measurement expression specifying leading adjustment.

Example

To specify a leading adjustment of 0.1", the command is:

Leading(0.1")

LeaveBlockOn

LeaveBlockOn determines whether the Block feature remains on after formatted selected text. This command is the equivalent of choosing File, Setup, Environment, then selecting or deselecting Leave Block On After Block Operation.

Syntax

LeaveBlockOn(State)

Parameters

State
Specifies whether the Leave Block On After Block Operation is checked (Yes!) or unchecked (No!). Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Turns off Leave Block On After Block Opertion.
Yes! 1 Turns on Leave Block On After Block Operation.

Example

To turn on the Leave Block On After Block Operation feature, the command is:

LeaveBlockOn(Yes!)

LeftArrow

LeftArrow moves an equation left in the View Equation window of the Equation Editor. This command is the equivalent of pressing Left Arrow while in the View Equation window of the Equation Editor. This command is not recordable. To use this command, you must type it into the macro. Outside of the View Equation window, pressing Left Arrow records PosCharPrevious.

Syntax

LeftArrow

Parameters

None.

See Also

LineCreateDlg

LineCreateDlg displays the Create Graphics Line dialog box. This command is the equivalent of choosing Graphics, Graphics Lines, Create.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineCreateDlg

Parameters

None.

LineDrawArrow

LineDrawArrow draws a line segment using Line Draw. This command is the equivalent of pressing End, an arrow key, or a Home+Arrow Key combination in Line Draw.

Syntax

LineDrawArrow(Key)

Parameters

Key
Specifies a key or key combination to draw a line segment. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
UpArrow! 23 Line segment drawn one space up.
RightArrow! 24 Line segment drawn one space to the right.
LeftArrow! 25 Line segment drawn one space to the left.
DownArrow! 26 Line segment drawn one space down.
End! 85 Line segment drawn to end of line
HomeUpArrow! 87 Line segment drawn to top of screen.
HomeRightArrow! 88 Line segment drawn right to intersecting line, 100 characters, right page margin, cell margin, or column margin.
HomeLeftArrow! 89 Line segment drawn left to intersecting line, 100 characters, left page margin, cell margin, or column margin.
HomeDownArrow! 90 Line segment drawn to bottom of page.
HomeHomeUpArrow! 151 Line segment drawn to top of document.
HomeHomeRightArrow! 152 Line segment drawn to end of line (right margin), crossing any intersecting lines.
HomeHomeLeftArrow! 153 Line segment drawn to beginning of line before codes.
HomeHomeDownArrow! 154 Line segment drawn to beginning of line before codes.

Example

To draw a line from the cursor position to the right margin, the command is:

LineDrawArrow(HomeHomeRightArrow!)

or

LineDrawArrow(152)

See Also

LineDrawChange

LineDrawChange specifies a line draw character. This command is the equivalent of choosing Graphics, Line Draw, and selecting a line draw character.

Syntax

LineDrawChange(Mode;Type)

Parameters

Mode
Specifies the current line draw mode. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ModeInsert! 0 Insert Mode
ModeMove! 2 Cursor can move without drawing a line
Type
Specifies a line draw character. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Erase! 0 Erases a line segment
Single! 1 Draws a single line
Double! 2 Draws a double line
Solid! 255 Draws a line using a character

Example

To draw a double line using Line Draw, the command is:

LineDrawChange(ModeInsert!;DoubleLine!)

LineDrawDlg

LineDrawDlg displays the Line Draw dialog box. This command is the equivalent of choosing Graphics, Line Draw.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineDrawDlg

Parameters

None.

See Also

LineDrawSolidCharacter

LineDrawSolidCharacter specifies which character Line Draw uses when drawing lines. This command is the equivalent of choosing Graphics, Line Draw, Change, and selecting an option.

Syntax

LineDrawSolidCharacter(Character)

Parameters

Character
A character expression specifying a character with which a line is drawn.

Example

To specify the pound sign as a line draw character, the command is:

LineDrawSolidCharacter("#")

See Also

LineEditDlg

LineEditDlg displays the Select Graphics Line To Edit dialog box. This command is the equivalent of choosing Graphics, Graphics Lines, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineEditDlg

Parameters

None.

See Also

LineHeight

LineHeight specifies line height. Line height is measured from baseline to baseline in single-spaced text. Auto line height configures line height as the point size of the font you are using, plus two points. This command is the equivalent of choosing Layout, Line, Line Height, either Auto or Fixed, and (if Fixed) specifying a measurement.

Syntax

LineHeight(Height)

Parameters

Height
To specify a fixed line height, use a measurement expression. To let Corel WordPerfect decide the line height based on the current font, select the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Auto! 0 Corel WordPerfect auto-selects line height

Example

To specify a line height of .275", the command is:

LineHeight(.275")

LineNumbering

LineNumbering turns on Line Numbering. This command is the equivalent of choosing Layout, Line, Line Numbering, and selecting options in the Line Numbering Format dialog box

Syntax

LineNumbering(State;Restart;Blank Lines;Columns;Relative Position;Position;First Printed Number;Interval;Values;Font;Point Size;Red Value;Green Value;Blue Value;Shading Value;{Attributes})

Parameters

State
Determines whether line numbering is on. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Line Numbering Off
On! 1 Line Numbering On
Restart (optional)
Determines whether line numbering is continuous or restarted on each page. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DontRestartNumbersEachPage! 0
RestartNumbersEachPage! 1
Blank Lines (optional)
Determines whether blank lines are counted in line numbering. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DontCountBlankLines! 0
CountBlankLines! 1
Columns (optional)
Determines whether lines in newspaper columns are numbered. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DontNumberAllNewspaperColumns! 0
NumberAllNewspaperColumns! 1
Relative Position (optional)
Determines whether the measurement given in the Position parameter is measured from the left edge of a page or from the margin. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
PosNumberFromLeftEdgeOfPage! 0
PosNumberFromLeftMargin 1
Position (optional)
A measurement expression specifying where the line number prints.
First Printed Number (optional)
A numeric expression specifying the first line number to print.
Interval (optional)
A numeric expression specifying the numbering interval.
Values (optional)
Determines whether a line numbering font uses a document's initial font attributes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
UseDefaultValues! 0
DontUseDefaultValues! 1
Font (optional)
A character expression specifying the line number font. Used only when the Values parameter is set to DontUseDefaultValues! or 1.
Point Size (optional)
A measurement expression specifying the point size of a line number font. Used only when the Values parameter is set to DontUseDefaultValues! or 1.
Red Value (optional)
A numeric expression representing the amount of red in a color. Values range from 0 to 255. Used only when the Values parameter is set to DontUseDefaultValues! or 1. The values of a selected color are available in the Color Selection dialog box.
Green Value (optional)
A numeric expression representing the amount of green in a color. See the parameter description for "Red Value" above.
Blue Value (optional)
A numeric expression representing the amount of blue in a color. See the parameter description for "Red Value" above.
Shading Value (optional)
A numeric expression representing the shading percentage of a color. Values range from 0 to 100. Used only when the Values parameter is set to DontUseDefaultValues! or 1.
Attributes
Specifies attributes and relative size of a font. Attributes are separated by semicolons and enclosed in a pair of French braces ({}). Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
ExtraLarge! 0
VeryLarge! 1
Large! 2
Small! 3
Fine! 4
Superscript! 5
Subscript! 6
Outline! 7
Italics! 8
Shadow! 9
Redline! 10
DoubleUnderline! 11
Bold! 12
Strikeout! 13
Underline! 14
SmallCaps! 15
Every! 16

Example

To number lines with an extra large, shadowed, double underlined, bold font, the command is:

LineNumbering(On!;;;;;;;;DontUseDefaultValues!;;;;;;;{ExtraLarge!;Shadow!;DoubleUnderline!;Bold!})

or

LineNumbering(1;;;;;;;;1;;;;;;;{0;9;11;12})

See Also

LineNumberingDlg

LineNumberingDlg displays the Line Numbering Format dialog box. This command is the equivalent of choosing Layout, Line, Line Numbering.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineNumberingDlg

Parameters

None.

See Also

LineNumberingMethod

LineNumberingMethod specifies a numbering method for Line Numbering. This command is the equivalent of choosing Layout, Line, Line Numbering, Numbering Method, and selecting an option.

Syntax

LineNumberingMethod(Numbering Method)

Parameters

Numbering Method
Specifies a numbering method for Line Numbering. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Use numbers to number lines
LowerLetters! 1 Lower-case letters
UpperLetters! 2 Upper-case letters
LowerRoman! 3 Lower-case roman numerals
UpperRoman! 4 Upper-case roman numerals

Example

To specify uppercase letters as the Line Numbering method, the command is:

LineNumberingMethod(UpperLetters!)

See Also

LineNumberSet

LineNumberSet specifies the beginning line number on a page. This command is the equivalent of choosing Layout, Line, Line Numbering, Starting Line Number, and entering a number.

Syntax

LineNumberSet(Starting Number)

Parameters

Starting Number
A numeric expression specifying a beginning line number.

Example

To specify 5 as the beginning line number, the command is:

LineNumberSet(5)

See Also

LineSegmentColor

LineSegmentColor specifies the color of a line segment. This command must be used in conjunction with other commands, such as LineSegmentCreate and LineSegmentEnd. This command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, selecting a line style, choosing Edit, Color, and selecting a color.

Syntax

LineSegmentColor(Color;Red Value;Green Value;Blue Value;Shading Value)

Parameters

Color
A character expression specifying the name of a color.
Red Value (optional)
A numeric expression representing the amount of red in a color. Values range from 0 to 255. The values of a selected color are available in the Color Selection dialog box.
Green Value (optional)
A numeric expression representing the amount of green in a color. See the parameter description for "Red Value" above.
Blue Value (optional)
A numeric expression representing the amount of blue in a color. See the parameter description for "Red Value" above.
Shading Value (optional)
A numeric expression representing the shading percentage of a color. Values range from 0 to 100.

Example

To specify a blue line segment, the command is:

LineSegmentColor("Blue";0;0;255;100)

See Also

LineSegmentCreate

LineSegmentCreate creates a line segment with multiple lines, or a stacked line style. This command must be used in conjunction with other commands, such as LineStyleCreate and LineStyleEdit. This command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, and either highlighting a Style and selecting Edit, or choosing Create and typing a style name, then selecting Create.

Syntax

LineSegmentCreate(Position)

Parameters

Position
A numeric expression specifying where a line segment is created or stacked. The first (inside) position is 0.

Example

To stack a line in the first (inside) position, the command is:

LineSegmentCreate(0)

See Also

LineSegmentDelete

LineSegmentDelete deletes a stacked line segment. This command must be used in conjunction with other commands, such as LineStyleEdit and LineSegmentEnd. This command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, selecting a line style, and choosing Edit, Delete.

Syntax

LineSegmentDelete(Position)

Parameters

Position
A numeric expression specifying where to delete a stacked line. The first (inside) position is 0.

Example

To delete an inside stacked line of a border, the command is:

LineSegmentDelete(0)

See Also

LineSegmentEdit

LineSegmentEdit edits a line segment. This command must be used in conjunction with other commands, such as LineSegmentEnd. This command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, highlighting a line style, and choosing Edit.

Syntax

LineSegmentEdit(Position)

Parameters

Position
A numeric expression specifying a line to edit. The first (inside) position is 0.

Example

To edit an inside stacked line, the command is:

LineSegmentEdit(0)

See Also

LineSegmentEnd

LineSegmentEnd ends a series of commands modifying a line segment. This command is used in conjunction with other commands, such as LineSegmentCreate. This command is the equivalent of choosing OK or Cancel in the Edit Line Styles (or Create Line Styles) dialog box.

Syntax

LineSegmentEnd(State)

Parameters

State
Determines whether changes to a line segment are saved. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Don't save changes
Save! 1 Save changes

Example

To save changes made to a line segment, the command is:

LineSegmentEnd(Save!)

See Also

LineSegmentSetUser

LineSegmentSetUser specifies a number of dash/space lengths in a custom line segment. This command must be followed by the number of LineSegmentSetUserData tokens for the number of dash/space lengths specified. This command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, highlighting Style, choosing Edit, Pattern Type, Custom, Pattern, and creating the number of desired lines.

Syntax

LineSegmentSetUser(Dash/Space)

Parameters

Dash/Space
A numeric expression specifying a number of dash/space lengths in a custom line segment.

Example

To create a line segment with one dash length and one space length, the command sequence is:

LineSegmentSetUser(2)
LineSegmentSetUserData(0.2")
LineSegmentSetUserData(0.1")
LineSegmentSetUserEnd

See Also

LineSegmentSetUserData

LineSegmentSetUserData specifies a dash or space length in a custom line pattern. This command must be used in conjunction with other commands, such as LineSegmentSetUser and LineSegmentEnd. The LineSegmentSetUserData command is the equivalent of pressing Alt+F9, Graphics Lines, Styles, highlighting a style, choosing Edit, Pattern Type, Custom, Pattern, creating the desired number of lines, and setting the desired length of dashes and spaces.

Syntax

LineSegmentSetUserData(Length)

Parameters

Length
A measurement expression specifying a dash or space length in a custom line pattern.

Example

To create a line segment with one dash length and one space length, the command sequence is:

LineSegmentSetUser(2)
LineSegmentSetUserData(0.2")
LineSegmentSetUserData(0.1")
LineSegmentSetUserEnd

See Also

LineSegmentSetUserEnd

LineSegmentSetUserEnd marks the end of a custom line pattern command sequence. This command is not required, but it can be used in conjunction with other commands such as LineSegmentSetUser and LineSegmentSetUserData. This command is not recordable. To use this command, you must type it into the macro.

Syntax

LineSegmentSetUserEnd

Parameters

None.

See Also

LineSegmentSetWPG2

LineSegmentSetWPG2 sets the pattern of a line segment to one of the predefined WPG2 line patterns. This command must be used in conjunction with other commands, such as LineSegmentEdit and LineSegmentEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Styles, Create or Edit, Pattern Type, Pre-defined, Pattern, and selecting a pre-defined line style.

Syntax

LineSegmentSetWPG2(Pattern Set;Line Pattern Number)

Parameters

Pattern Set
A numeric expression specifying a pattern set. Currently, the only valid entry for this parameter is 0.
Line Pattern Number
A numeric expression specifying which line pattern to use for the selected pattern set. The following predefined line patterns are available for pattern set 0:
Number Line Pattern
0 ———
1 — — 
2 – – – 
3 - - - - 
4 --------
5 ................
6 . . . . . . . . 
7 . . .  . . .  .
8 — · — · 
9 — · · — · · —
10 — — · — —
11 — — · · — — ·
12 —— — —— —
13 —— -- —— —
14 —  —
15 — —

Example

To specify the dash-dot line pattern, the command sequence is:

LineSegmentEdit(0)
LineSegmentSetWPG2(0;8)
LineSegmentEnd(Save!)

See Also

LineSegmentSpacing

LineSegmentSpacing sets the distance between line segments. This command must be used in conjunction with LineSegmentEdit and LineSegmentEnd. The LineSegmentSpacing command is the equivalent of pressing Alt+F9, selecting Graphics Lines, Styles, highlighting a style, choosing Edit, Interline Spacing, and setting the distance between line segments.

Syntax

LineSegmentSpacing(Distance)

Parameters

Distance
A measurement expression specifying a distance between line segments.

Example

To set the distance between line segments at 0.5", the command is:

LineSegmentSpacing(0.5")

LineSegmentWidth

LineSegmentWidth specifies the width or thickness of a graphics line segment. This command must be used in conjunction with other commands, such as LineSegmentCreate and LineSegmentEnd. When creating or editing tables, graphics, graphics lines, or borders, this command is the equivalent of specifying thickness in the Edit Line Style or Create Line Style dialog box.

Syntax

LineSegmentWidth(Width)

Parameters

Width
A measurement expression specifying the width or thickness of a graphics line segment.

Example

To set the width of a line segment at 0.2", the command is:

LineSegmentWidth(0.2")

See Also

LineSpacing

LineSpacing specifies the vertical spacing between lines in your document. The tenths position is used when this command is recorded. Tenths is optional when entering this command in a macro. This command is the equivalent of choosing Layout, Line, Line Spacing, and specifying a line spacing value.

Syntax

LineSpacing(Spacing)

Parameters

Spacing
A numeric expression specifying line spacing.

Example

To specify single-spaced line spacing, the command is:

LineSpacing(1.0)

LineStyleCopy

LineStyleCopy copies attributes from one line to another. This command is the equivalent of copying a line style in a Line Styles dialog box. This feature is available in Tables, Graphics Boxes, and Graphics Lines.

Syntax

LineStyleCopy(Line;Source Library;Recipient Library;New Name)

Parameters

Line
Specifies a line to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Copy a single line
DoubleLine! 1 Copy a double line
DashedLine! 2 Copy a dashed line
DottedLine! 3 Copy a dotted line
ThickLine! 4 Copy a thick line
ExtraThickLine! 5 Copy an extra thick line
ThinThickLine! 6 Copy a thin thick line
ThickThinLine! 7 Copy a thick thin line
ButtonTopLeftLine! 8 Copy a button top left line
ButtonBottomRightLine! 9 Copy button bottom right line
TableDefaultLine! 126 Copy table default line
NoLine! 127 No line
Source Library
Specifies a library from which to copy a line. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Copies from current document
PersonalLibrary! 1 Copies from a personal library
SharedLibrary! 2 Copies from a shared library
Recipient Library
Specifies a library to which a line is copied. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Copies to the current document
PersonalLibrary! 1 Copies to a personal library
SharedLibrary! 2 Copies to a shared library
New Name (optional)
A character expression specifying a new name of a line.

Example

To copy the attributes of a line named Single Line in a personal library to a newly created line named New Line in the current document, the command is:

LineStyleCopy(SingleLine!;PersonalLibrary!;CurrentDoc!;"New Line")

See Also

LineStyleCreate

LineStyleCreate creates a line style. This command must be used in conjunction with other commands, such as LineStyleEnd. This command is the equivalent of creating a line style in a Line Styles dialog box. This feature is available in Tables, Graphics Boxes, and Graphics Lines.

Syntax

LineStyleCreate(Name;Source)

Parameters

Name
A character expression naming a new line style.
Source
Specifies the location of a new line style.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Place line style in current document
PersonalLibrary! 1 Place line style in personal library
SharedLibrary! 2 Place line style in shared library

Example

To create a line style named Custom in the current document, the command is:

LineStyleCreate("Custom";CurrentDoc!)

See Also

LineStyleDelete

LineStyleDelete deletes a line style. This command is the equivalent of deleting a line style in a Line Styles dialog box. You cannot delete Corel WordPerfect-defined line styles. The Lines Styles dialog box is available in Tables, Graphics Boxes, and Graphics Lines.

Syntax

LineStyleDelete(Style Name;Source)

Parameters

Style Name
Specifies a line style to delete. To delete a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To delete a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent
SingleLine! 0
DoubleLine! 1
DashedLine! 2
DottedLine! 3
ThickLine! 4
ExtraThickLine! 5
ThinThickLine! 6
ThickThinLine! 7
ButtonTopLeftLine! 8
ButtonBottomRightLine! 9
TableDefaultLine! 126
NoLine! 127
Source
Specifies the location of a line style to delete.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Delete line style from current document
PersonalLibrary! 1 Delete line style from personal library
SharedLibrary! 2 Delete line style from shared library

Example

To delete a line style named Custom from the personal library, the command is:

LineStyleDelete("Custom";PersonalLibrary!)

LineStyleDlg

LineStyleDlg displays the Line Styles dialog box. Changes made in this dialog box affect line styles available in Tables, Graphics Boxes, and Graphics Lines. This command is the equivalent of choosing Graphics, Graphics Lines, Styles.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineStyleDlg

Parameters

None.

LineStyleEdit

LineStyleEdit edits a line style. This command is used in conjunction with other commands, such as LineStyleEnd. This command is the equivalent of choosing Graphics, Graphics Lines, Styles, highlighting a style to edit, and choosing Edit.

Syntax

LineStyleEdit(Line;Source)

Parameters

Line
Specifies a line style to edit. To edit a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To edit a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
SingleLine! 0 Edit a single line style
DoubleLine! 1 Edit a double line style
DashedLine! 2 Edit a dashed line style
DottedLine! 3 Edit a dotted line style
ThickLine! 4 Edit a thick line style
ExtraThickLine! 5 Edit an extra thick line style
ThickThinLine! 6 Edit a thick thin line style
ThinThickLine! 7 Edit a thin thick line style
ButtonTopLeftLine! 8 Edit a top left line style
ButtonBottomRightLine! 9 Edit a button bottom right line style
TableDefaultLine! 126 Edit the table default line style
NoLine! 127 No line
Source
Specifies the location of a line style to edit.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Edit line style in current document
PersonalLibrary! 1 Edit line style in personal library
SharedLibrary! 2 Edit line style in shared library

Example

To edit the Thick Line style located in the shared library, the command is:

LineStyleEdit(ThickLine!;SharedLibrary!)

See Also

LineStyleEditDlg

LineStyleEditDlg displays the Edit Line Styles dialog box. This command must be used in conjunction with the commands LineStyleEdit and LineStyleEnd. Changes made in the Edit Line Styles dialog box effect Tables, Graphics Boxes, and Graphics Lines. This command is the equivalent of choosing Graphics, Graphics Lines, Styles, Edit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LineStyleEditDlg

Parameters

None.

See Also

LineStyleEnd

LineStyleEnd is required to end series of commands changing a line style. This command is used in conjunction with other commands, such as LineStyleCreate or LineStyleEdit. This command is the equivalent of selecting OK or Cancel in the Edit Line Style (or Create Line Style) dialog box. These dialog boxes are available in Tables through the Layout menu, and in Graphic Boxes and Graphics Lines through the Graphics menu.

Syntax

LineStyleEnd(State)

Parameters

State
Determines whether line style changes are saved. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancel changes
Save! 1 Save changes

Example

To save line style changes, the command is:

LineStyleEnd(Save!)

See Also

LineStyleName

LineStyleName renames a line style. Corel WordPerfect-defined line styles cannot be renamed. This command is used in conjunction with other commands, such as LineStyleCreate and LineStyleEnd. This command is the equivalent of naming a line style in the Edit Line Style (or Create Line Style) dialog box. These dialog boxes are available in Tables through the Layout menu, and in Graphics Boxes and Graphics Lines through the Graphics menu.

Syntax

LineStyleName(Name)

Parameters

Name
A character expression naming a line style.

Example

To rename the current line style to Custom, the command is:

LineStyleName("Custom")

See Also

LineStyleRetrieve

LineStyleRetrieve retrieves a line style library. This command is the equivalent of choosing Retrieve in the Line Styles dialog box. This feature is available in Tables, Graphics Boxes, and Graphics Lines.

Syntax

LineStyleRetrieve(Filename;Library)

Parameters

Filename
A character expression naming the filename from which the line style library is to be retrieved.
Library
The line style library to retrieve. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Retrieve current document's library
PersonalLibrary! 1 Retrieve personal library
SharedLibrary! 2 Retrieve shared library

Example

To retrieve a line style library named CUSTOMLN from the personal library, the command is:

LineStyleRetrieve("CUSTOMLN";PersonalLibrary!)

LineStyleSave

LineStyleSave saves a line style library. This command is the equivalent of choosing Save in the Line Styles dialog box. This feature is available in Tables, Graphics Boxes, and Graphics Lines.

Syntax

LineStyleSave(Filename;Library)

Parameters

Filename
A character expression naming the filename in which the line style library is to be saved.
Library
The line style library to save. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Save current document's library
PersonalLibrary! 1 Save personal library
SharedLibrary! 2 Save shared library

Example

To save a current document line style library with the filename CURRENT, the command is:

LineStyleSave("CURRENT";CurrentDoc!)

ListDefinition

ListDefinition selects a list definition and defines the page on which the list is generated. The item must exist in the defined lists or be created by ListDefinitionCreate before it can be selected. This command is the equivalent of choosing Tools, List, Define, highlighting a list definition, and choosing Select.

Syntax

ListDefinition(Name)

Parameters

Name
A character expression naming or renaming a selected list definition.

Example

To select a list definition named Subject List, the command is:

ListDefinition("Subject List")

See Also

ListDefinitionCreate

ListDefinitionCreate creates a list definition. This command is the equivalent of choosing Tools, List, Define, Create, and selecting options in the Create List dialog box.

Syntax

ListDefinitionCreate(Name;List Style;Numbering Mode;Graphics;Page Numbering)

Parameters

Name
A character expression naming a new list definition.
List Style
Specifies a list style to create. To specify Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style
Numbering Mode
Specifies a numbering method the list uses when it is generated. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DefNone! 0 No numbering method specified
DefFollows! 1 Number follows entry
DefParentheses! 2 Number in parentheses
DefFlushRight! 3 Number flush right
DefLeader! 4 Number preceded by dot leader
Graphics
Determines whether to include graphics in a generated list. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No graphics
FigureCounter! 1 Figure
TableBoxCounter! 2 Table Box
TextBoxCounter! 3 Text Box
UserBoxCounter! 4 User Box
EquationCounter! 5 Equation
Page Numbering (optional)
A character expression specifying a type of page numbering used in the list pages. If this parameter is not used, page numbering on list pages will be the same format as in the main document.

Example

To create a list definition named Subject List which specifies a List style and numbering with dot leaders following entries, includes figure boxes, and specifies a different page numbering method than the main document, the command is:

ListDefinitionCreate("Subject List";ListStyle!;DefLeader!;FigureCounter!;"List Page # [page #]")

See Also

ListDefinitionDelete

ListDefinitionDelete deletes a list definition in the Define List dialog box. This command is the equivalent of choosing Tools, List, Define, highlighting a list definition, Delete.

Syntax

ListDefinitionDelete(Name)

Parameters

Name
A character expression naming a list definition to delete.

Example

To delete a list definition named Old List, the command is:

ListDefinitionDelete("Old List")

ListDefinitionDlg

ListDefinitionDlg displays the Define List dialog box. This command is the equivalent of choosing Tools, List, Define.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ListDefinitionDlg

Parameters

None.

ListDefinitionEditBox

ListDefinitionEditBox changes the type of graphics box the specified list will include when generated. This command is the equivalent of choosing Tools, List, Define, selecting a list definition, choosing Edit, Include Graphics, and highlighting a graphics box type.

Syntax

ListDefinitionEditBox(Name;Graphics)

Parameters

Name
A character expression naming a list definition to edit.
Graphics
Specifies which type of graphics box the list definition now includes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No graphics
FigureCounter! 1 Figure
TableBoxCounter! 2 Table Box
TextBoxCounter! 3 Text Box
UserBoxCounter! 4 User Box
EquationCounter! 5 Equation

Example

To change a list definition named List 1 to include figure boxes, the command is:

ListDefinitionEditBox("List 1";FigureCounter!)

ListDefinitionMode

ListDefinitionMode changes the method of numbering or numbering mode in a list definition. This command is the equivalent of choosing Tools, List, Define, highlighting a list definition, choosing Edit, and selecting a Numbering Mode.

Syntax

ListDefinitionMode(Name;Numbering Mode)

Parameters

Name
A character expression naming a list definition to edit.
Numbering Mode
Specifies which numbering mode a list definition uses. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DefNone! 0 No numbers
DefFollows! 1 Number follows entry
DefParentheses! 2 Number in parentheses
DefFlushRight! 3 Number flush right
DefLeader! 4 Number preceded by dot leaders

Example

To change the numbering mode to flush right in a list definition named List 2, the command is:

ListDefinitionMode("List 2";DefFlushRight!)

ListDefinitionRename

ListDefinitionRename renames a list definition. This command is the equivalent of choosing Tools, List, Define, highlighting a list definition, choosing Edit, Name, and entering a new name.

Syntax

ListDefinitionRename(Name;New Name)

Parameters

Name
A character expression specifying a list definition to rename.
New Name
A character expression specifying the new name of a list definition.

Example

To rename a list definition named List 1 to List One, the command is:

ListDefinitionRename("List 1";"List One")

ListDefinitionRetrieve

ListDefinitionRetrieve retrieves a list definition from a document. To retrieve more than one list definition from a document, use more than one ListDefinitionRetrieve command. This command is the equivalent of choosing Tools, List, Define, Retrieve, specifying a document name, and marking a list to retrieve.

Syntax

ListDefinitionRetrieve(Filename;List Name)

Parameters

Filename
A character expression naming the document which contains a list to retrieve.
List Name
A character expression specifying the list definition to retrieve.

Example

To retrieve a list definition named List One from a document named MYFILE, the command is:

ListDefinitionRetrieve("MYFILE";"List One")

ListDefinitionStyle

ListDefinitionStyle edits a list definition and changes the list style that definition uses. This command is the equivalent of choosing Tools, List, Define, highlighting a List Definition, Edit, Style, Select, and selecting a list style.

Syntax

ListDefinitionStyle(Name;New Style)

Parameters

Name
A character expression specifying a list definition to edit.
New Style
Specifies which list style the list definition now uses. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-defined style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To change the list style to Index 2 for a list definition named List One, the command is:

ListDefinitionStyle("List One";Index2Style!)

See Also

ListEditPageFormat

ListEditPageFormat edits the page numbering format of a list definition. This command is the equivalent of choosing Tools, List, Define, highlighting a list definition, choosing Edit, Page Number Format, and specifying a page number format.

Syntax

ListEditPageFormat(Name;Page Numbering)

Parameters

Name
A character expression specifying a list definition to edit.
Page Numbering
Use a character expression to specify a page numbering style. Or to use the same page numbering style in the generated list as in the main document, specify the enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
DocFormat! 0 Same page numbering style as in document

Example

To change a page numbering format to be the same as the main document page numbering format in a list definition named List One, the command is:

ListEditPageFormat("List One";DocFormat!)

See Also

ListKey

ListKey displays the Specify File Manager List dialog box. In some dialog boxes this command can perform the redo function. In the Equation Editor, if the insertion point is in the text entry area, ListKey highlights the first command in the commands list, and if the insertion point is in the commands list, ListKey displays the Set drop-down list. This command is the equivalent of pressing F5. This command is not recordable. To use this command, you must type it into the macro.

Syntax

ListKey

Parameters

None.

ListMark

ListMark marks selected text to add to a list when a document is generated. This command is the equivalent of choosing Tools, List, Mark, and specifying a list name.

Syntax

ListMark(List Name)

Parameters

List Name
A character expression naming a new list.

Example

To mark selected text to be added to a list named List One, the command is:

ListMark("List One")

See Also

ListMarkDlg

ListMarkDlg displays the Mark Text For List dialog box. After selecting text, this command is the equivalent of choosing Tools, List, Mark.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

ListMarkDlg

Parameters

None.

LocationOfBackupFiles

LocationOfBackupFiles changes the directory where files created by Timed Backup are saved. This command is the equivalent of choosing File, Setup, Location of Files, Backup Files, and entering a path for backup files.

Syntax

LocationOfBackupFiles(Path)

Parameters

Path
A character expression specifying the full path for backup files.

Example

To specify C:\COREL\WP62\BACKUP as the directory where backup files are saved, the command is:

LocationOfBackupFiles("C:\COREL\WP62\BACKUP")

See Also

LocationOfDocFiles

LocationOfDocFiles changes the default directory in Setup where documents are saved. This is also the default directory used when you Open or Retrieve a document. This command is the equivalent of choosing File, Setup, Location of Files, Documents, and entering a path for documents.

Syntax

LocationOfDocFiles(Path)

Parameters

Path
A character expression specifying the full path for document files.

Example

To specify C:\COREL\WP62\DOCS as a directory where documents are saved, the command is:

LocationOfDocFiles("C:\COREL\WP62\DOCS")

See Also

LocationOfDRSFile

LocationOfDRSFile specifies where the WP.DRS and *.WFW files are located. These files are used for Print Preview and to print Corel WordPerfect characters graphically. This command is the equivalent of choosing File, Setup, Location of Files, WP.DRS File and *.WFW Files, and entering a path.

Syntax

LocationOfDRSFile(Path)

Parameters

Path
A character expression specifying the full path of files named WP.DRS and *.WFW.

Example

To specify C:\COREL\WP62\OTHER as the directory where the WP.DRS and *.WFW files are located, the command is:

LocationOfDRSFile("C:\COREL\WP62\OTHER")

See Also

LocationOfFilesDlg

LocationOfFilesDlg displays the Location of Files dialog box. This command is the equivalent of choosing File, Setup, Location of Files.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

LocationOfFilesDlg

Parameters

None.

LocationOfGraphicsFiles

LocationOfGraphicsFiles changes the Personal Path. This command is the equivalent of choosing File, Setup, Location of Files, Graphics Files, Personal Path, and entering a path.

Syntax

LocationOfGraphicsFiles(Path)

Parameters

Path
A character expression specifying the full path for Graphics files.

Example

To specify C:\COREL\WP62\GRAPHICS as the graphics files (*.WPG) directory, the command is:

LocationOfGraphicsFiles("C:\COREL\WP62\GRAPHICS")

See Also

LocationOfGraphicsFontsFiles

LocationOfGraphicsFontsFiles changes the path for the graphics font files. This command is the equivalent of choosing File, Setup, Location of Files, Graphics Fonts Data Files, highlighting a font type, choosing Edit Path, and typing a path.

Syntax

LocationOfGraphicsFontsFiles(Type;Path)

Parameters

Type
Specifies a graphics font type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Speedo! 134 Bitstream Speedo fonts
Bullet! 135 Bullet fonts
Type1! 138 Type 1 fonts
TrueType! 139 True Type fonts
Path
A character expression specifying the path for available screen fonts.

Example

To change the path for the available Bitstream Speedo screen fonts to C:\PRINT\FONTS, the command is:

LocationOfGraphicsFontsFiles(Speedo!;"C:\PRINT\FONTS")

LocationOfMacroKeyboardFiles

LocationOfMacroKeyboardFiles changes the Personal directory of macro, keyboard, and Button Bar files in Setup. This command is the equivalent of choosing File, Setup, Location of Files, Macros/Keyboard/Button Bar, Personal Path, and entering a path.

Syntax

LocationOfMacroKeyboardFiles(Path)

Parameters

Path
A character expression specifying the full path for macro, keyboard, and Button Bar files.

Example

To specify C:\COREL\WP62\MACROS as the directory where macro, keyboard, and Button Bar files (*.WPM, *.WPK, and *.WPB) are located, the command is:

LocationOfMacroKeyboardFiles("C:\COREL\WP62\MACROS")

See Also

LocationOfPrinterFiles

LocationOfPrinterFiles changes the Personal directory specified for printer files. This command is the equivalent of choosing File, Setup, Location of Files, Printer Files, Personal Path, and entering a path.

Syntax

LocationOfPrinterFiles(Path)

Parameters

Path
A character expression specifying the full path for printer files.

Example

To specify C:\COREL\WP62\PRINT as the directory where printer files (*.PRS, and *.ALL) are located, the command is:

LocationOfPrinterFiles("C:\COREL\WP62\PRINT")

See Also

LocationOfQuickFinderFiles

LocationOfQuickFinderFiles changes the Personal Path of QuickFinder™ indexes in Setup. This command is the equivalent of choosing File, Setup, Location of Files, QuickFinder Files, Personal Path, and entering a path.

Syntax

LocationOfQuickFinderFiles(Path)

Parameters

Path
A character expression specifying the full path for QuickFinder Index files.

Example

To specify C:\COREL\WP62\INDEX as the directory where QuickFinder Index files are located, the command is:

LocationOfQuickFinderFiles("C:\COREL\WP62\INDEX")

See Also

LocationOfSharedGraphicsFiles

LocationOfSharedGraphicsFiles changes the Shared directory specified for graphics files. The directory is usually a network drive. When you are not connected to a network, the directory provides additional personal graphics file directories. This command is the equivalent of choosing File, Setup, Location of Files, Graphics Files, Shared Path, and entering a path.

Syntax

LocationOfSharedGraphicsFiles(Path)

Parameters

Path
A character expression specifying the full path (usually a network directory) for graphics files.

Example

To specify F:\WP60\GRAPHICS as the directory for graphics files (*.WPG), the command is:

LocationOfSharedGraphicsFiles("F:\WP60\GRAPHICS")

See Also

LocationOfSharedMacroKbdFiles

LocationOfSharedMacroKbdFiles specifies the Shared path in Setup for macro, keyboard, and Button Bar files. The Macros/Keyboard/Button Bar shared directory is usually a network drive. When you are not connected to a network, the directory provides additional personal macro file directories. This command is the equivalent of choosing File, Setup, Location of Files, Macros/Keyboard/Button Bar, Shared Path, and entering a path.

Syntax

LocationOfSharedMacroKbdFiles(Path)

Parameters

Path
A character expression specifying the full path (usually a network path) for macro, keyboard, and Button Bar files.

Example

To specify F:\WP60\MACROS as the shared directory for macro, keyboard, and Button Bar files (*.WPM, *.WPK, and *.WPB), the command is:

LocationOfSharedMacroKbdFiles("F:\WP60\MACROS")

See Also

LocationOfSharedPrinterFiles

LocationOfSharedPrinterFiles specifies the Shared directory in Setup for printer files. The printer files shared directory is usually a network drive. When you are not connected to a network, the directory provides additional personal printer file directories. This command is the equivalent of choosing File, Setup, Location of Files, Printer Files, Shared Path, and entering a path.

Syntax

LocationOfSharedPrinterFiles(Path)

Parameters

Path
A character expression specifying the full path (usually a network path) for printer files.

Example

To specify F:\WP60\PRINT as the printer files (*.PRS and *.ALL) directory, the command is:

LocationOfSharedPrinterFiles("F:\WP60\PRINT")

See Also

LocationOfSharedQFinderFiles

LocationOfSharedQFinderFiles changes the shared directory of QuickFinder index files. The index files shared directory is usually a network drive. When you are not connected to a network, the directory provides additional personal index file directories. This command is the equivalent of choosing File, Setup, Location of Files, QuickFinder Files, Shared Path, and entering a path.

Syntax

LocationOfSharedQFinderFiles(Path)

Parameters

Path
A character expression specifying the full path (usually a network directory) for QuickFinder index files.

Example

To specify F:\WP60\INDEX as the QuickFinder Index files directory, the command is:

LocationOfSharedQFinderFiles("F:\WP60\INDEX")

See Also

LocationOfSharedSprFiles

LocationOfSharedSprFiles specifies the Shared directory in Setup for spreadsheet files. The spreadsheet files shared directory is usually a network drive. When you are not connected to a network, the directory provides additional personal spreadsheet file directories. This command is the equivalent of choosing File, Setup, Location of Files, Spreadsheet Files, Shared Path, and entering a path.

Syntax

LocationOfSharedSprFiles(Path)

Parameters

Path
A character expression specifying the full path (usually a network path) for spreadsheet files.

Example

To specify F:\WP60\SPR as a spreadsheet files directory, the command is:

LocationOfSharedSprFiles("F:\WP60\SPR")

See Also

LocationOfSharedStyleFiles

LocationOfSharedStyleFiles specifies a default directory for shared style library files. This command is the equivalent of choosing File, Setup, Location of Files, Style Files, Directory for Shared Libraries, and entering a directory name.

Syntax

LocationOfSharedStyleFiles(Directory)

Parameters

Directory
A character expression specifying the default directory for shared style library files.

Example

To specify a directory named LIBS on the W: drive as the default shared style library directory, the command is:

LocationOfSharedStyleFiles("W:\LIBS")

See Also

LocationOfSharedTemplateFiles

On many systems, certain template files are placed in a template directory for everyone to use. LocationOfSharedTemplateFiles lets you specify that directory. It is the equivalent of choosing File, Setup, Location of Files, Template Files, Shared Path and entering a path.

Syntax

LocationOfSharedTemplateFiles(Path)

Parameters

Path
A character expression specifying the full path for template files.

Example

To specify C:\WP62\TEMPLATES as the directory where shared template files are stored and saved, the command is:

LocationOfSharedTemplateFiles("C:\WP62\TEMPLATES")

See Also

LocationOfSprFiles

LocationOfSprFiles specifies the location of spreadsheet files. This command is the equivalent of choosing File, Setup, Location Of Files, Spreadsheet Files, Personal Path, and specifying a directory.

Syntax

LocationOfSprFiles(Location)

Parameters

Location A character expression specifying the location of spreadsheet files.

Example

To specify C:\SPREADSH as the location for spreadsheet files, the command is:

LocationOfSprFiles("C:\SPREADSH")

LocationOfStyleFiles

LocationOfStyleFiles specifies a default directory for personal style library files. This command is the equivalent of choosing File, Setup, Location of Files, Style Files, Directory for Personal Libraries, and entering a directory name.

Syntax

LocationOfStyleFiles(Directory)

Parameters

Directory
A character expression specifying the default directory for personal style library files.

Example

To specify a directory named LIBS on the C: drive as the default personal style library directory, the command is:

LocationOfStyleFiles("C:\LIBS")

See Also

LocationOfSupWritingTools

LocationOfSupWritingTools specifies the location of supplementary speller files. This command is the equivalent of choosing File, Setup, Location of Files, Writing Tools, Supplementary, and entering a directory name.

Syntax

LocationOfSupWritingTools(Location)

Parameters

Location
A character expression specifying the location of supplementary speller files.

Example

To specify the location C:\COREL\WP62\SPELL for supplementary speller files, the command is:

LocationOfSupWritingTools("C:\COREL\WP62\SPELL")

LocationOfTemplateFiles

LocationOfTemplateFiles lets you specify that directory where you want COrel WordPerfect to put the template files you create. This command is the equivalent of choosing File, Setup, Location of Files, Setup, Location of Files, Template Files, Personal Path, and entering a path.

Syntax

LocationOfTemplateFiles(Path)

Parameters

Path
A character expression specifying the full path for template files.

Example

To specify C:\COREL\WP62\TEMPLATES as the directory where personal template files are saved, the command is:

LocationOfTemplateFiles("C:|COREL\WP62\TEMPLATES")

See Also

LocationOfWritingTools

LocationOfWritingTools specifies the location of speller files. This command is the equivalent of choosing File, Setup, Location of Files, Writing Tools, Main, and entering a directory name.

Syntax

LocationOfWritingTools(Location)

Parameters

Location
A character expression specifying the location of speller files.

Example

To specify the location C:\COREL\WP62\SPELL for speller files, the command is:

LocationOfWritingTools("C:\COREL\WP62\SPELL")

MacroAssignVariableDlg

MacroAssignVariableDlg displays the Assign Variable dialog box. This command is the equivalent of choosing Tools, Macro, Control, Assign Variable.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MacroAssignVariableDlg

Parameters

None.

MacroCommandsDlg

MacroCommandsDlg displays the Macro Commands dialog box. This command is the equivalent of choosing Tools, Macro, Control, Macro Commands.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MacroCommandsDlg

Parameters

None.

MacroControlDlg

MacroControlDlg displays the Macro Control dialog box. This command is the equivalent of choosing Tools, Macro, Control.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MacroControlDlg

Parameters

None.

MacroPlayDlg

MacroPlayDlg displays the Play Macro dialog box. This command is the equivalent of choosing Tools, Macro, Play.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MacroPlayDlg

Parameters

None.

MacroRecordDlg

MacroRecordDlg displays the Record Macro dialog box. This command is the equivalent of choosing Tools, Macro, Record. This command is not recordable. To use this command, you must type it into the macro.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MacroRecordDlg

Parameters

None.

MakeItFit

MakeItFit shrinks or expands a document to fill a certain number of pages by adjusting specified features. This command is the equivalent of choosing Layout, Make It Fit, specifying pages, then specifying items to adjust.

Syntax

MakeItFit(Pages;{Adjust;Adjust...;})

Parameters

Pages
A numeric expression specifying the number of pages to fill.
Adjust
Specifies a items to adjust. Select an enumerated type or its numeric equivalent. To specify more than one item, enclose the items in braces and separate with semi-colons.
Enumerated Type Numeric Equivalent Description
AdjustBottomMargin! 3 Adjust bottom margin
AdjustFont! 4 Adjust font setting
AdjustLeftMargin! 0 Adjust left margin
AdjustLineSpacing! 5 Adjust line spacing
AdjustRightMargin! 1 Adjust right margin
AdjustTopMargin! 2 Adjust top margin

Example

To fit the current document on two pages by adjusting the font size and line spacing, the command is:

MakeItFit(2;{AdjustFont!;AdjustLineSpacing!})

See Also

MakeItFitDlg

MakeItFitDlg displays the Make It Fit dialog box. This command is the equivalent of choosing Layout, then Make It Fit.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MakeItFitDlg

Parameters

None.

See Also

MarginAdjustLeft

MarginAdjustLeft adjusts the left margin relative to the current margin setting. The MarginAdjustLeft command is the equivalent of choosing Layout, Margins, Left Margin Adjustment, and specifying a measurement.

Syntax

MarginAdjustLeft(Adjustment)

Parameters

Adjustment
A measurement expression specifying the amount to adjust the left margin.

Example

To adjust the left margin .5" to the right, the command is:

MarginAdjustLeft(.5")

See Also

MarginAdjustRight

MarginAdjustRight adjusts the right margin relative to the current margin setting. This command is the equivalent of choosing Layout, Margins, Right Margin Adjustment, and specifying a measurement.

Syntax

MarginAdjustRight(Adjustment)

Parameters

Adjustment
A measurement expression specifying an amount to adjust the right margin.

Example

To make the right margin .5" smaller, the command is:

MarginAdjustRight(-.5")

See Also

MarginBottom

MarginBottom sets the bottom margin. This command is the equivalent of choosing Layout, Margins, Bottom Margin, and specifying a measurement.

Syntax

MarginBottom(Margin Setting)

Parameters

Margin Setting
A measurement expression specifying a bottom margin.

Example

To set the bottom margin 1" from the bottom edge of the page, the command is:

MarginBottom(1")

MarginLeft

MarginLeft sets the left margin. This command is the equivalent of choosing Layout, Margins, Left Margin, and specifying a measurement.

Syntax

MarginLeft(Margin Setting)

Parameters

Margin Setting
A measurement expression specifying a left margin.

Example

To set the left margin 1" from the left edge of the page, the command is:

MarginLeft(1")

See Also

MarginRight

MarginRight sets the right margin. This command is the equivalent of choosing Layout, Margins, Right Margin, and specifying a measurement.

Syntax

MarginRight(Margin Setting)

Parameters

Margin Setting
A measurement expression specifying a right margin.

Example

To set the right margin 1" from the right edge of the page, the command is:

MarginRight(1")

See Also

MarginTop

MarginTop sets the top margin. This command is the equivalent of choosing Layout, Margins, Top Margin, and specifying a measurement.

Syntax

MarginTop(Margin Setting)

Parameters

Margin Setting
A measurement expression specifying a top margin.

Example

To set the top margin 1.5" from the top edge of the page, the command is:

MarginTop(1.5")

MarkTextDlg

MarkTextDlg displays the Mark dialog box. This command is the equivalent of pressing Alt+F5.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MarkTextDlg

Parameters

None.

MasterDocCondense

MasterDocCondense specifies subdocuments to condense and whether to save changes. This command is the equivalent of choosing File, Master Document, Condense, selecting a subdocument to condense, and selecting options.

Syntax

MasterDocCondense(Subdoc;Save File)

Parameters

Subdoc (optional)
A character expression specifying a subdocument to condense. If this parameter is omitted, all subdocuments are condensed.
Save File
Determines whether to save changes to a subdocument when the subdocument is condensed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SkipSub! 0 Do not save changes
SaveSub! 2 Save changes

Example

To condense and not save changes in a subdocument named C:\COREL\WP62\SUB1.DOC, the command is:

MasterDocCondense("C:\COREL\WP62\SUB1.DOC";SkipSub!)

See Also

MasterDocCondenseDlg

MasterDocCondenseDlg displays the Condense Master Document dialog box. This command is the equivalent of choosing File, Master Document, Condense.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MasterDocCondenseDlg

Parameters

None.

See Also

MasterDocExpand

MasterDocExpand specifies a subdocument to expand. This command is the equivalent of choosing File, Master Document, Expand, and selecting a subdocument.

Syntax

MasterDocExpand(Subdoc)

Parameters

Subdoc (optional)
A character expression specifying a subdocument to expand. If this parameter is omitted, all subdocuments are expanded.

Example

To expand a subdocument named SUB1.DOC, the command is:

MasterDocExpand("SUB1.DOC")

See Also

MasterDocExpandDlg

MasterDocExpandDlg displays the Expand Master Document dialog box. This command is the equivalent of choosing File, Master Document, Expand.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MasterDocExpandDlg

Parameters

None.

See Also

Math

Math determines whether the Math feature is on. This command is the equivalent of choosing Tools, Math, On or Off.

Syntax

Math(State)

Parameters

State
Turns math on or off. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Math off
On! 1 Math on

Example

To turn on math, the command is:

Math(On!)

MathCalculate

MathCalculate calculates the results of a Math document. This command is the equivalent of choosing Tools, Math, Calculate.

Syntax

MathCalculate

Parameters

None.

See Also

MathColumn

MathColumn defines a column in a Math document. This command is used in conjunction with MathDefinitionStart and MathDefinitionEnd. This command is the equivalent of choosing Tools, Math, Define, and selecting options.

Syntax

MathColumn(Column Number;Column Type;Negative Numbers;Digits;Formula)

Parameters

Column Number
A numeric expression specifying the number of a column.
Column Type (optional)
Specifies a column type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
MathText! 1 Text
MathNumeric! 2 Numeric
MathTotal! 3 Total
MathCalculate! 4 Calculate
Negative Numbers (optional)
Specifies how to display negative numbers. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
MinusSign! 0 Minus sign
Parentheses! 1 Parentheses
Digits (optional)
A numeric expression specifying the number of digits beyond the decimal point.
Formula (optional)
A character expression specifying a Math formula.

Example

The following command selects column 2, defines it as a calculating column, uses a minus sign for negative numbers, displays 2 digits beyond the decimal point, and contains a simple formula:

MathColumn(2;MathCalculate!;MinusSign!;2;"2*3-A")

See Also

MathDefinitionDlg

MathDefinitionDlg displays the Math dialog box. This command is the equivalent of choosing Tools, Math, Define.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MathDefinitionDlg

Parameters

None.

See Also

MathDefinitionEnd

MathDefinitionEnd is the closing command of a MathDefinitionStart-MathDefinitionEnd statement. This statement contains the MathColumn command, and is the equivalent of choosing Tools, Math, Define, and selecting options.

Syntax

MathDefinitionEnd

Parameters

None.

See Also

MathDefinitionStart

MathDefinitionStart is the opening command of a MathDefinitionStart-MathDefinitionEnd statement. This statement contains the MathColumn command, and is the equivalent of choosing Tools, Math, Define, and selecting options.

Syntax

MathDefinitionStart

Parameters

None.

See Also

MenuBarRemainsVisible determines whether to display pull-down menus. With pull-down Menus displayed, this command is the equivalent of choosing View, Pull-Down Menus.

Syntax

MenuBarRemainsVisible(State)

Parameters

State
Determines whether pull-down menus are displayed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Not displayed
Yes! 1 Displayed

Example

To display pull-down menus, the command is:

MenuBarRemainsVisible(Yes!)

MergeBlankField

MergeBlankField determines whether to remove a blank field. If blank fields are removed, this command shifts remaining fields up one line. MergeBlankField is the equivalent of choosing Tools, Merge, Run, Blank Fields in Data File, and selecting options.

Syntax

MergeBlankField(State)

Parameters

State
Determines whether to remove a blank field. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Leave! 0 Leave field
Remove! 1 Remove field

Example

To remove a blank field, the command is:

MergeBlankField(Remove!)

MergeCode

MergeCode inserts a merge code into a document. This command is the equivalent of choosing Tools, Merge, Define, selecting a merge document type, Merge Codes, and entering a merge code.

Syntax

MergeCode(Code Name;Code Parameters)

Parameters

Code Name
Specifies a merge code to insert. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Beep! 0
Break! 1
CancelOff! 2
CancelOn! 3
Continue 4
Date! 5
Default! 6
DisplayStop! 7
Else! 8
EndSwitch! 9
EndField! 10
EndFor! 11
EndIf! 12
EndRecord! 13
EndWhile! 14
Next! 15
NextRecord! 16
PageOff! 17
PageOn! 18
Print! 19
Quit! 20
ProcessOn! 21
Return! 22
ReturnCancel! 23
ReturnError! 24
Rewrite! 25
StepOff! 26
StepOn! 27
Stop! 28
ProcessOff! 29
Assign! 48
Call! 50
Caps! 52
Switch! 54
CaseOf! 56
ChainMacro! 58
ChainData! 60
ChainForm! 62
Char! 64
Codes! 66
Comment! 68
CtoN! 70
Document! 72
EmbedMacro! 74
Field! 76
FieldNames! 78
FirstCap! 80
ForNext! 82
ForEach! 84
GetString! 86
Go! 88
If! 90
IfBlank! 92
IfExists! 94
IfNotBlank! 96
Insert! 98
Keyboard! 100
Label! 102
AssignLocal! 104
Look! 106
MrgCmnd! 108
NestData! 110
NestForm! 112
NestMacro! 114
NtoC! 116
OnCancel! 118
OnError! 120
Prompt! 122
StatusPrompt! 124
StrLen! 126
StrPos! 128
SubstData! 130
SubstForm! 132
SubStr! 134
System! 136
ToLower! 138
ToUpper! 140
Variable! 142
Wait! 144
While! 146
PostNet! 148
Code Parameters (optional)
A character expression specifying necessary parameters.

Example

To insert a merge code named FieldNames! with name, address and telephone parameters, the command is:

MergeCode(FieldNames!;"name;address;city/state/zip;phone")

See Also

MergeCodesDisplayEdit

When defining a merge, MergeCodesDisplayEdit hides or shows merge codes or displays them as icons. This command is the equivalent of choosing Tools, Merge, Define, selecting a merge document type, Display of Merge Codes, and selecting an option.

Syntax

MergeCodesDisplayEdit(Type)

Parameters

Type
When defining a merge, determines whether to hide or show merge codes or display them as icons. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Hide! 0 Hide codes
Show! 1 Show codes
Icon! 2 Display as Icons

Example

To hide merge codes, the command is:

MergeCodesDisplayEdit(Hide!)

See Also

MergeCodesDisplayRun

In a merged document, MergeCodesDisplayRun hides or shows merge codes or displays them as icons. This command is the equivalent of choosing Tools, Merge, Run, Display of Merge Codes, and selecting an option.

Syntax

MergeCodesDisplayRun(Type)

Parameters

Type
In a merged document, determines whether to hide or show merge codes or display them as icons. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Hide! 0 Hide codes
Show! 1 Show codes
Icon! 2 Display as Icons

Example

To show merge codes, the command is:

MergeCodesDisplayRun(Show!)

See Also

MergeCodesDisplaySetup

MergeCodesDisplaySetup hides or shows merge codes or displays them as icons. This command is the equivalent of choosing View, Screen Setup, Display of Merge Codes, and selecting an option.

Syntax

MergeCodesDisplaySetup(Type)

Parameters

Type
Determines whether to hide or show merge codes or display them as icons. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Hide! 0 Hide codes
Show! 1 Show codes
Icon! 2 Display as Icons

Example

To display merge codes as icons, the command is:

MergeCodesDisplaySetup(Icon!)

See Also

MergeCodesDlg

MergeCodesDlg displays the Merge Codes dialog box. This command is the equivalent of choosing Tools, Merge, Define.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MergeCodesDlg

Parameters

None.

See Also

MergeCodesListDlg

MergeCodesListDlg displays the All Merge Codes dialog box. This command is the equivalent of choosing Tools, Merge, Define, selecting a merge document type, Merge Codes.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MergeCodesListDlg

Parameters

None.

See Also

MergeCondition

MergeCondition defines a condition for selecting records from a data file. This command is the equivalent of choosing Tools, Merge, Run, Data Record Selection, Define Conditions, and selecting the fields and condition sets.

Syntax

MergeCondition(Field Names;Field Data)

Parameters

This command can contain 1-3 occurrences of the Field Name parameter and 1-12 occurrences of the Field Data parameter.

Field Names (optional)
A character expression specifying a field to search.
Field Data (optional)
A character expression defining a condition or condition set for record selection.

Example

The following command selects all records that match the following condition set: 1) COMPANY = Corel; 2) TITLE = Regional Manager; and 3) STATE = UT.

MergeCondition("COMPANY";"TITLE";"STATE";"Corel";"Regional Manager";"UT")

MergeDataFile

MergeDataFile specifies a data file from which to list fields when defining a form file. This command is the equivalent of choosing Tools, Merge, Define, Form, Field, List Field Names, and entering the name of a data file.

Syntax

MergeDataFile(Name)

Parameters

Name
A character expression specifying the name of a data file from which to list fields when defining a form file.

Example

To specify a file named MYLIST as the data file from which to list fields, the command is:

MergeDataFile("MYLIST")

MergeEnvelope

MergeEnvelope determines whether to create an envelope for merged records. This command is the equivalent of choosing Tools, Merge, Run, Envelopes. (The Envelopes options is only available after you have specified a Data File name.)

Syntax

MergeEnvelope(State)

Parameters

State
Determines whether to create an envelope for merged records. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 No envelope created
On! 1 Create envelope

Example

To create a merge envelope, the command is:

MergeEnvelope(On!)

MergeEnvelopeDefinitionBegin

MergeEnvelopeDefinitionBegin is the opening command of the MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. This statement contains address information. MergeEnvelopeDefinitionBegin is the equivalent of choosing Tools, Merge, Run, Envelopes. (The Envelopes option is only available after you have specified a Data File name.)

Syntax

MergeEnvelopeDefinitionBegin

Parameters

None.

See Also

MergeEnvelopeDefinitionEnd

MergeEnvelopeDefinitionEnd is the closing command of a MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. This statement contains address information, and is the equivalent of choosing Tools, Merge, Run, Envelope. (The Envelopes option is only available after you have specified a Data File name.)

Syntax

MergeEnvelopeDefinitionEnd

Parameters

None.

See Also

MergeFieldDelimiter

MergeFieldDelimiter toggles the Field Delimiter option and specifies a Field Delimiter. This command is the equivalent of choosing File, Setup, Environment, Delimited Text Options, Field Delimiter, and entering the characters or codes serving as a delimiter.

Syntax

MergeFieldDelimiter(State;Delimiter)

Parameters

State
Toggles the Field Delimiter option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Off
Yes! 1 On
Delimiter
A character expression specifying the characters or codes serving as a field delimiter. Connect multiple characters or codes with a plus sign (+).

Example

To specify the Tab code followed by Hard Return as the field delimiter, the command is:

MergeFieldDelimiter(Yes!;"[TAB]"+"")

MergeFieldEncapsulateCharacter

MergeFieldEncapsulateCharacter marks data protected in a delimited text merge. This command is the equivalent of choosing File, Setup, Environment, Delimited Text Options, Field Encapsulate Character, and entering characters or codes.

Syntax

MergeFieldEncapsulateCharacter(State;Encapsulate Character)

Parameters

State
Toggles the Field Encapsulate Character option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Off
Yes! 1 On
Encapsulate Character
A character expression specifying field data protected during conversion in a delimited text merge.

Example

To use the pound sign (#) to mark protected data, the command is:

MergeFieldEncapsulateCharacter(Yes!;"#")

MergeFileAssociate

MergeFileAssociate associates form and data files. This command is the equivalent of choosing Tools, Merge, Run, and typing Form and Data filenames.

Syntax

MergeFileAssociate(Form File;Data File)

Parameters

Form File
A character expression specifying a form file.
Data File
A character expression specifying a data file.

Example

To associate C:\WP62\DOC1 and C:\WP62\DOC2, the command is:

MergeFileAssociate("C:\WP62\DOC1";"C:\WP62\DOC2")

MergeFileType

MergeFileType selects a Merge document type. This command is the equivalent of choosing Tools, Merge, Define, and selecting a document type. If a document type is already selected, choose Tools, Merge, Define, Change File Type, and selecting a document type.

Syntax

MergeFileType(File Type)

Parameters

File Type
Specifies a merge document type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
None! 0 No merge document
Form! 1 Form
TableData! 2 Table data
TextData! 4 Text data

Example

To create a Form document, the command is:

MergeFileType(Form!)

See Also

MergeMark

MergeMark specifies a record to be marked for merging. This command is the equivalent of choosing Tools, Merge, Run, specifying a Form File and a Data File, Data Record Selection, Mark Records To Include, selecting a field, highlighting a record, Mark Record.

Syntax

MergeMark(Record Number)

Parameters

Record Number
A numeric expression specifying a record number to mark for merging. Each record marked will be recorded in a separate MergeMark command. MergeMark(0) represents the Field Names record and is included automatically with any records you mark.

Example

To mark records 7, 10, and 25 for merging, the command sequence is:

MergeMark(0)
MergeMark(7)
MergeMark(10)
MergeMark(25)
MergeSelect(Marked!)

See Also

MergePageBreak

MergePageBreak determines whether to create a page break between merged records. This command is the equivalent of choosing Tools, Merge, Run, Page Break Between Merged Records.

Syntax

MergePageBreak(State)

Parameters

State
Determines whether to create a page break between merged records. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 No page break
On! 1 Page break

Example

To create a page break between merged records, the command is:

MergePageBreak(On!)

MergePrintText

Sends a secondary merge file form to a printer. With the data file on the screen, this command is the equivalent of choosing Tools, Merge, Define, Print.

Syntax

MergePrintText

Parameters

None.

See Also

MergeRecordDelimiter

MergeRecordDelimiter toggles the Record Delimiter option and specifies a Record Delimiter. This command is the equivalent of choosing File, Setup, Environment, Delimited Text Options, Record Delimiter, and entering the characters or codes serving as a delimiter.

Syntax

MergeRecordDelimiter(State;Delimiter)

Parameters

State
Toggles the Record Delimiter option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Off
Yes! 1 On
Delimiter
A character expression specifying the characters or codes serving as a record delimiter. Connect multiple characters or codes with a plus sign (+).

Example

To specify Carriage Return and Line Feed as the record delimiter, the command is:

MergeRecordDelimiter(Yes!;"[CR]"+"[LF]")

MergeRepeat

MergeRepeat sets the number of times to merge each record. This command is the equivalent of choosing Tools, Merge, Run, Repeat Merge for Each Data Record, and entering a number.

Syntax

MergeRepeat(Repeat)

Parameters

Repeat
A numeric expression specifying how many times to merge each data record.

Example

To merge a data record 3 times, the command is:

MergeRepeat(3)

MergeRun

MergeRun identifies files to merge and where to send the result. This command is the equivalent of choosing Tools, Merge, Run, Form File, entering a filename, Data File, entering a filename, and Output.

Syntax

MergeRun(Primary File;Form File Name;Secondary File;Data File Name;Output Location;Output Filename)

Parameters

Primary File
Specifies the primary file type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
Clipboard! 1 Clipboard
FormFile! 2 Form
Form File Name (optional)
A character expression specifying the name of a form file.
Secondary File
Specifies a secondary file type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoData! 0 No data
Clipboard! 1 Clipboard
DataFile! 2 Data file
Data File Name (optional)
A character expression specifying the name of a data file.
Output Location
Specifies where to send the result of a merge. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ToCurrentDoc! 0 To current document
ToNewDoc! 1 To new document
ToFile! 2 To file
ToPrinter! 3 To printer
Output Filename (optional)
A character naming a file to contain the results of a merge. Used when the Output Location parameter is set to ToFile!.

Example

To merge a primary file named PRIMARY.DOC and a secondary file named SECOND.DOC to a current document, the command is:

MergeRun(FormFile!;"PRIMARY.DOC";DataFile!;"SECOND.DOC";ToCurrentDoc!)

MergeRunDlg

MergeRunDlg displays the Run Merge dialog box. This command is the equivalent of choosing Tools, Merge, Run.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MergeRunDlg

Parameters

None.

See Also

MergeSelect

MergeSelect identifies records to merge. This command is the equivalent of choosing Tools, Merge, Run, Data Record Selection, and selecting options.

Syntax

MergeSelect(Records;Low Range;High Range)

Parameters

Records
Specifies records to merge. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
All! 0 All records
Marked! 1 Marked records
Range! 2 Range of records
Low Range (optional)
A numeric expression specifying the low end of a range.
High Range (optional)
A numeric expression specifying the high end of a range.

Example

To merge records 10 through 50, the command is:

MergeSelect(Range!;10;50)

See Also

MergeSortDlg

MergeSortDlg displays the Merge/Sort dialog box. This command is the equivalent of pressing Merge/Sort (Ctrl+F9).

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MergeSortDlg

Parameters

None.

MergeStripCharacters

MergeStripCharacters toggles the Strip Characters option and specifies characters or codes marking characters to strip from a data file. This command is the equivalent of choosing File, Setup, Environment, Delimited Text Options, Strip Characters, and entering characters or codes.

Syntax

MergeStripCharacters(State;Strip)

Parameters

State
Toggles the Strip Characters option. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Off
Yes! 1 On
Strip
A character expression specifying characters or codes marking characters to strip from a data file in a delimited text merge. Connect multiple characters or codes with a plus sign (+).

Example

To use an asterisk (*) to identify characters to strip from a data file, the command is:

MergeStripCharacters(Yes!;"*")

MinusSign

MinusSign is the equivalent of pressing the minus sign. This command executes whatever the minus sign key is designed to do in the state Corel WordPerfect is in when the macro encounters the command. If the key has been remapped in Keyboard Layout, this command will execute the original function. This command is not recordable. To use this command, you must type it into the macro.

Syntax

MinusSign

Parameters

None.

MouseAccelerationFactor

MouseAccelerationFactor sets the correlation between the mouse pointer and mouse movement. This command is the equivalent of choosing File, Setup, Mouse, Acceleration Factor, and specifying an acceleration factor.

Syntax

MouseAccelerationFactor(Acceleration Factor)

Parameters

Acceleration Factor
A numeric expression specifying how responsive the mouse pointer is to mouse movement. Values range from 0 to 100.

Example

To set the acceleration factor to fast, the command is:

MouseAccelerationFactor(100)

MouseAutoselect

MouseAutoselect automatically selects the mouse driver. This command is the equivalent of choosing File, Setup, Mouse, Type, Auto Select.

Syntax

MouseAutoselect

Parameters

None.

MouseDoubleClick

MouseDoubleClick sets the double-click interval. This command is the equivalent of choosing File, Setup, Mouse, Double-click Interval, and specifying an interval.

Syntax

MouseDoubleClick(Interval)

Parameters

Interval
A numeric expression that sets the double-click interval.

Example

To set the double-click interval to one-half second, the command is:

MouseDoubleClick(50)

MouseInitialize

MouseInitialize initializes a selected mouse. This command must be used between MouseSelect and SetupSave commands. This command is equivalent to the initialization which occurs by choosing Layout, Setup, Mouse, Type, highlighting a mouse type, Select.

Syntax

MouseInitialize

Parameters

None.

Example

To initialize a PS/2 Logitech mouse, the command is:

MouseSelect("STANDARD.IRS";"Logitech Mouse (PS/2)")
MouseInitialize
SetupSave

See Also

MouseLeftHanded

MouseLeftHanded turns on or off Left-handed Mouse. This command is the equivalent of choosing File, Setup, Mouse, Left-handed Mouse.

Syntax

MouseLeftHanded(State)

Parameters

State
Determines whether mouse is set to left-handed.
Enumerated Type Numeric Equivalent Description
No! 0 Not left-handed
Yes! 1 Left handed

Example

To set a mouse to left-handed, the command is:

MouseLeftHanded(Yes!)

MousePort

MousePort selects a mouse port. This command is the equivalent of choosing File, Setup, Mouse, Port, and selecting an option.

Syntax

MousePort(Port)

Parameters

Port
A numeric expression specifying which mouse port to use.
Numeric Expression Description
0 COM port 1
1 COM port 2

Example

To select COM port 1, the command is:

MousePort(0)

MouseSelect

MouseSelect selects a mouse. This command must be followed by MouseInitialize and SetupSave. This series of commands is equivalent to choosing File, Setup, Mouse, Type, highlighting a mouse type, Select.

Syntax

MouseSelect(Type;Name)

Parameters

Type
A character expression specifying the type of mouse selected.
Name
A character expression specifying the name of the selected mouse.

Example

To select a standard Microsoft serial mouse, the command is:

MouseSelect("STANDARD.IRS";"Microsoft Mouse (Serial)")
MouseInitialize
SetupSave

See Also

MouseSetupDlg

MouseSetupDlg displays the Mouse dialog box. This command is the equivalent of choosing File, Setup, Mouse.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MouseSetupDlg

Parameters

None.

MouseUnselect

MouseUnselect changes the current mouse selection to None. This command is not recordable. To use this command, you must type it into the macro.

Syntax

MouseUnselect

Parameters

None.

See Also

MoveDlg

MoveDlg displays the Move Block dialog box. This command is the equivalent of pressing Move (Ctrl+F4).

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

MoveDlg

Parameters

None.

See Also

MoveModeCancel

If you decide not to retrieve text that has been moved or copied, MoveModeCancel eliminates the Move prompt. This command is the equivalent of pressing Cancel/Undelete (Esc).

Syntax

MoveModeCancel

Parameters

None.

See Also

MoveModeEnd

MoveModeEnd is the closing command for moving text. After displaying the Move dialog box (Ctrl+F4), choosing Cut and Paste, or Copy and Paste, and positioning the cursor, this command is the equivalent of pressing Enter.

Syntax

MoveModeEnd

Parameters

None.

See Also

NotesDlg

NotesDlg displays the Notes dialog box. This command is the equivalent of pressing Ctrl+F7.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

NotesDlg

Parameters

None.

OutlineBarSetup

OutlineBarSetup turns the Outline Bar on or off. This command is the equivalent of choosing View, Outline Bar. To record the parameter, choose Tools, Outline, Outline Options, Display Outline Bar.

Syntax

OutlineBarSetup(State)

Parameters

State
Determines whether to display the outline bar. Select an enumerated type or its numeric equivalent. When no parameter is specified, the command acts as a toggle.
Enumerated Type Numeric Equivalent Description
Off! 0 Outline bar not displayed
On! 1 Outline bar displayed

Example

To display the Outline Bar, the command is:

OutlineBarSetup(On!)

See Also

OutlineBeginNew

OutlineBeginNew begins a new outline in a specified style. This command is the equivalent of choosing Tools, Outline, Begin New Outline, and selecting a style.

Syntax

OutlineBeginNew(Style Name)

Parameters

Style Name
Specifies a style for a new outline. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To create a bullets style outline, the command is:

OutlineBeginNew(BulletsOutlnStyle!)

See Also

OutlineBeginNewDlg

OutlineBeginNewDlg displays the Outline Style List dialog box. This command is the equivalent of choosing Tools, Outline, Begin New Outline.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

OutlineBeginNewDlg

Parameters

None.

See Also

OutlineBodyText

OutlineBodyText hides or shows outline body text. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Hide (or Show) Body Text.

Syntax

OutlineBodyText(State)

Parameters

State (optional)
OutlineBodyText hides or shows outline body text. Select an enumerated type or its numeric equivalent. When no parameter is specified, the command acts as a toggle.
Enumerated Type Numeric Equivalent Description
ShowBodyText! 0 Shows body text
HideBodyText! 1 Hides body text

Example

To hide outline body text, the command is:

OutlineBodyText(HideBodyText!)

See Also

OutlineBottom

In Edit in Outline Mode, OutlineBottom positions the cursor at the beginning of the last family of an outline. After choosing Tools, Outline, Outline Options, and Edit in Outline Mode, this command is the equivalent of pressing Home, Down Arrow.

Syntax

OutlineBottom

Parameters

None.

See Also

OutlineChangeToBodyText

OutlineChangeToBodyText moves text or the cursor from an outline to body text. This command is the equivalent of choosing Tools, Outline, Change to Body Text.

Syntax

OutlineChangeToBodyText

Parameters

None.

See Also

OutlineDlg

OutlineDlg displays the Outline dialog box. This command is the equivalent of choosing Tools, Outline, Outline Options.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

OutlineDlg

Parameters

None.

OutlineDown

In Edit in Outline Mode, OutlineDown blocks the next outline family. When repeated, the command unblocks the family and, with each repetition, blocks successive outline paragraphs until reaching the next family. After choosing Tools, Outline, Outline Options, and Edit in Outline Mode, this command is the equivalent of pressing Down Arrow.

Syntax

OutlineDown

Parameters

None.

See Also

OutlineEditKey

OutlineEditKey activates Edit in Outline Mode and displays the Outline Bar. This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineEditKey

Parameters

None.

See Also

OutlineEnd

OutlineEnd turns off the outline feature. This command is the equivalent of choosing Tools, Outline, End Outline.

Syntax

OutlineEnd

Parameters

None.

See Also

OutlineFamilyCopy

OutlineFamilyCopy copies an outline family and adjusts the numbering in the outline when the family is retrieved. After positioning the cursor at the beginning of an outline family, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Copy Family.

Syntax

OutlineFamilyCopy

Parameters

None.

See Also

OutlineFamilyCut

OutlineFamilyCut deletes an outline family and adjusts the numbering in the outline. After positioning the cursor at the beginning of an outline family, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Cut Family.

Syntax

OutlineFamilyCut

Parameters

None.

See Also

OutlineFamilyDemote

In Edit in Outline Mode, OutlineFamilyDemote adjusts an outline family to the next level. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and positioning the cursor at the beginning of an outline family, this command is the equivalent of pressing Tab.

Syntax

OutlineFamilyDemote

Parameters

None.

See Also

OutlineFamilyDown

OutlineFamilyDown moves the cursor to the beginning of the next outline family. In Edit in Outline Mode, this command blocks the next outline family. This command is the equivalent of pressing Alt+Down Arrow while in Edit in Outline Mode.

Syntax

OutlineFamilyDown

Parameters

None.

See Also

OutlineFamilyDragDown

In Edit in Outline Mode, OutlineFamilyDragDown positions a selected outline family below the next family and adjusts the numbering. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and blocking an outline family, this command is the equivalent of pressing Ctrl+Down Arrow.

Syntax

OutlineFamilyDragDown

Parameters

None.

See Also

OutlineFamilyDragUp

In Edit in Outline Mode, OutlineFamilyDragUp positions a selected outline family above the previous family and adjusts the numbering. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and blocking an outline family, this command is the equivalent of pressing Ctrl+Up Arrow.

Syntax

OutlineFamilyDragUp

Parameters

None.

See Also

OutlineFamilyHide

OutlineFamilyHide hides the current outline family. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Hide Family.

Syntax

OutlineFamilyHide(State)

Parameters

State
Determines whether to hide or show an outline family. Select an enumerated type of its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ShowBodyText! 0 Shows outline family
HideBodyText! 1 Hides outline family

Example

To hide an outline family, the command is:

OutlineFamilyHide(HideBodyText!)

See Also

OutlineFamilyLeft

OutlineFamilyLeft moves the cursor from one outline paragraph to the previous outline paragraph. This command is the equivalent of pressing Alt+Left Arrow while in an outline.

Syntax

OutlineFamilyLeft

Parameters

None.

See Also

OutlineFamilyMove

OutlineFamilyMove moves an outline family. After positioning the cursor at the beginning of an outline family, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Move Family.

Syntax

OutlineFamilyMove

Parameters

None.

See Also

OutlineFamilyPromote

In Edit in Outline Mode, OutlineFamilyPromote adjusts an outline family to the previous level. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and positioning the cursor at the beginning of an outline family, this command is the equivalent of pressing Shift+Tab.

Syntax

OutlineFamilyPromote

Parameters

None.

See Also

OutlineFamilyRight

OutlineFamilyRight moves the cursor from one outline paragraph to the next outline paragraph. This command is the equivalent of pressing Alt+Right Arrow while in an outline.

Syntax

OutlineFamilyRight

Parameters

None.

See Also

OutlineFamilySelect

OutlineFamilySelect selects an outline family. This command is the equivalent of blocking an outline family (Alt+F4). This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineFamilySelect

Parameters

None.

See Also

OutlineFamilyShow

OutlineFamilyShow displays a hidden outline family. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Show Family.

Syntax

OutlineFamilyShow(State)

Parameters

State
Shows a previously hidden outline family. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ShowBodyText! 0 Shows outline family
HideBodyText! 1 Hides outline family

Example

To show a previously hidden outline family, the command is:

OutlineFamilyShow(ShowBodyText!)

See Also

OutlineFamilyUp

OutlineFamilyUp moves the cursor to the beginning of the previous outline family. In Edit in Outline Mode, this command blocks the previous outline family. This command is the equivalent of pressing Alt+Up Arrow while in an outline.

Syntax

OutlineFamilyUp

Parameters

None.

See Also

OutlineHideShowingBodyText

OutlineHideShowingBodyText hides an outline but leaves body text showing. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Hide Outline.

Syntax

OutlineHideShowingBodyText

Parameters

None.

See Also

OutlineNumberToggleKey

OutlineNumberToggleKey toggles an outline paragraph between an outline and the body text. This command is the equivalent of pressing Ctrl+T. This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineNumberToggleKey

Parameters

None.

See Also

OutlineParagraphCopy

OutlineParagraphCopy copies an outline paragraph. After blocking an outline paragraph, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Copy Paragraph.

Syntax

OutlineParagraphCopy

Parameters

None.

See Also

OutlineParagraphDelete

OutlineParagraphDelete deletes an outline paragraph. After blocking an outline paragraph, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Cut Paragraph.

Syntax

OutlineParagraphDelete

Parameters

None.

See Also

OutlineParagraphDemote

OutlineParagraphDemote adjusts an outline paragraph to the next level. After positioning the cursor at the beginning of an outline paragraph, this command is the equivalent of choosing Tools, Outline, Outline Options, Adjust Levels, Next Level.

Syntax

OutlineParagraphDemote

Parameters

None.

See Also

OutlineParagraphDragDown

In Edit in Outline Mode, OutlineParagraphDragDown positions an outline paragraph below the next paragraph and adjusts the numbering. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and blocking an outline paragraph, this command is the equivalent of pressing Ctrl+Down Arrow. This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineParagraphDragDown

Parameters

None.

See Also

OutlineParagraphDragUp

In Edit in Outline Mode, OutlineParagraphDragUp positions an outline paragraph above the previous paragraph and adjusts the numbering. After choosing Tools, Outline, Outline Options, Edit in Outline Mode, and blocking an outline paragraph, this command is the equivalent of pressing Ctrl+Up Arrow. This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineParagraphDragUp

Parameters

None.

See Also

OutlineParagraphMove

OutlineParagraphMove moves an outline paragraph. After blocking an outline paragraph, this command is the equivalent of choosing Tools, Outline, Outline Options, Move/Copy, Move Paragraph.

Syntax

OutlineParagraphMove

Parameters

None.

See Also

OutlineParagraphNumber

OutlineParagraphNumber specifies an outline paragraph level. This command is the equivalent of choosing Tools, Outline, Outline Options, Insert Outline Level (1-8), and specifying an outline level.

Syntax

OutlineParagraphNumber(Level)

Parameters

Level (optional)
A numeric expression specifying the level of an outline paragraph. Levels range from 1 to 8. If this parameter is not specified, the current level is inserted.

Example

To adjust an outline paragraph to level 3, the command is:

OutlineParagraphNumber(3)

OutlineParagraphNumberDrag

OutlineParagraphNumberDrag moves the current outline paragraph and number down one line. After positioning the cursor at the beginning of an outline paragraph, this command is the equivalent of pressing Enter.

Syntax

OutlineParagraphNumberDrag

Parameters

None.

OutlineParagraphPromote

OutlineParagraphPromote adjusts an outline paragraph to the previous level. After positioning the cursor at the beginning of an outline paragraph, this command is the equivalent of choosing Tools, Outline, Outline Options, Adjust Levels, Previous Level.

Syntax

OutlineParagraphPromote

Parameters

None.

See Also

OutlineParagraphSelect

OutlineParagraphSelect selects an outline paragraph. This command is the equivalent of blocking an outline paragraph (Alt+F4). This command is not recordable. To use this command, you must type it into the macro.

Syntax

OutlineParagraphSelect

Parameters

None.

See Also

OutlineRight

In Edit in Outline Mode, OutlineRight blocks the next outline family. When repeated, the command unblocks the family and, with each repetition, blocks successive outline paragraphs until reaching the next family. After choosing Tools, Outline, Outline Options, and Edit in Outline Mode, this command is the equivalent of pressing Right Arrow.

Syntax

OutlineRight

Parameters

None.

See Also

OutlineSetParagraphNumber

OutlineSetParagraphNumber sets the number for an outline paragraph. This command is the equivalent of choosing Tools, Outline, Outline Options, Set Paragraph Number, and entering a number or character.

Syntax

OutlineSetParagraphNumber(Number)

Parameters

Number
A character expression setting the number of an outline paragraph.

Example

To set an outline paragraph number as 5, the command is:

OutlineSetParagraphNumber("5")

OutlineShow

OutlineShow specifies the highest outline level to show and whether to show body text. When specifying a level, this command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Show Levels, and entering an outline level.

Syntax

OutlineShow(Level;State)

Parameters

Level
A numeric expression specifying the lowest level of an outline to show. Levels range from 1 to 8.
State
Specifies whether to show or hide body text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ShowBodyText! 0 Shows body text
HideBodyText! 1 Hides body text

Example

To show outline levels 1 through 3 and hide the body text, the command is:

OutlineShow(3;HideBodyText!)

See Also

OutlineStyleCopy

OutlineStyleCopy copies an outline style and renames the copy or moves it into another library. This command is the equivalent of choosing Tools, Outline, Outline Options, Outline Style, Copy, and selecting options.

Syntax

OutlineStyleCopy(Style Name;Current Location;Destination;Rename)

Parameters

Style Name
Specifies the name of an outline style to copy. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style
Current Location
Specifies the location of an outline style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library
Destination
Specifies the destination of the outline style to copy. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library
Rename (optional)
A character expression renaming an outline style when the current location is the same as the destination.

Example

To copy an outline style named Bullets from the current document to the current personal library, the command is:

OutlineStyleCopy(BulletsOutlnStyle!;CurrentDoc!;PersonalLibrary!)

OutlineStyleCreate

OutlineStyleCreate creates, names, and saves an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, Create, and naming the new style.

Syntax

OutlineStyleCreate(Name;Location)

Parameters

Name
A character expression naming a new outline style.
Location (optional)
Specifies the library of a new outline style. Select an enumerated type or its numeric equivalent. If no location is specified, the style is created for the current document.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To create an outline style named My Style and save it in a shared library, the command is:

OutlineStyleCreate("My Style";Shared Library!)

See Also

OutlineStyleDelete

OutlineStyleDelete deletes an outline style. Corel WordPerfect System styles cannot be deleted from the current document. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting a style, Delete.

Syntax

OutlineStyleDelete(Style Name;Location)

Parameters

Style Name
Specifies the name of an outline style to delete. Corel WordPerfect System styles can only be deleted from a library, not from the current document. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style
Location (optional)
Specifies the library of an outline style to delete. If no location is specified, the style is deleted from the current document.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To delete an outline style named My Style from a shared library, the command is:

OutlineStyleDelete("My Style";SharedLibrary!)

See Also

OutlineStyleDescription

OutlineStyleDescription describes an outline style. This command must be used in conjunction with OutlineStyleEditBegin and OutlineStyleEditEnd. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting an outline style, Edit, Description, and entering a description.

Syntax

OutlineStyleDescription(Description)

Parameters

Description
A character expression describing an outline style.

Example

To describe an outline style named My Style as Table of Contents Format, the command sequence is:

OutlineStyleEditBegin("My Style";PersonalLibrary!)
OutlineStyleDescription("Table of Contents Format")
OutlineStyleEditEnd(Save!)

See Also

OutlineStyleDlg

OutlineStyleDlg displays the Outline Style List dialog box. This command is the equivalent of choosing Tools, Outline, Outline Style.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

OutlineStyleDlg

Parameters

None.

OutlineStyleEditBegin

OutlineStyleEditBegin is the opening command of an OutlineStyleEditBegin-OutlineStyleEditEnd statement. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting a style, Edit.

Syntax

OutlineStyleEditBegin(Style Name;Location)

Parameters

Style Name
Specifies an outline style to edit. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style
Location (optional)
Specifies the library of an outline style. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To edit an outline style named Bullets in the current document, the command is:

OutlineStyleEditBegin(BulletsOutlnStyle!;CurrentDoc!)

See Also

OutlineStyleEditEnd

OutlineStyleEditEnd is the closing command of an OutlineStyleEditBegin-OutlineStyleEditEnd statement. After editing an outline style, this command is the equivalent of choosing OK or Cancel.

Syntax

OutlineStyleEditEnd(State)

Parameters

State
OutlineStyleEditEnd saves or cancels outline style changes. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Cancels style changes
Save! 1 Saves style changes

Example

To save outline style changes, the command is:

OutlineStyleEditEnd(Save!)

See Also

OutlineStyleLevel

OutlineStyleLevel specifies an outline level and a style for that level. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting a style, Edit, Level Style, and selecting options.

Syntax

OutlineStyleLevel(Level;Style Name)

Parameters

Level
A numeric expression selecting an outline level. Levels range from 1 to 8.
Style Name
Specifies an outline style for the selected level. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#indoc style
EndnoteNumberInDocumentStyle! 17 Endn#indoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To apply a style named Heading 1 to outline level 3, the command is:

OutlineStyleLevel(3;Heading1Style!)

OutlineStyleNumberFormat

OutlineStyleNumberFormat specifies the numbering format for each level of a selected outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting a style, Edit, Number Format, and highlighting a format or entering a user-defined format.

Syntax

OutlineStyleNumberFormat(Level;Format)

Parameters

Level
A numeric expression selecting an outline level. Levels range from 1 to 8.
Format
Specifies the numbering format for each outline level. Select a system format or enter a character expression specifying the format.

Example

To specify paragraph numbering style for level 1, the command is:

OutlineStyleNumberFormat(1;"1.")

See Also

OutlineStyleNumbersOnly

OutlineStyleNumbersOnly specifies whether to apply the Numbers Only format to a selected outline. This command must be used in conjunction with OutlineStyleEditBegin and OutlineStyleEditEnd. This command is the equivalent of choosing Tools, Outline, Outline Style, Edit, Numbers Only.

Syntax

OutlineStyleNumbersOnly(State)

Parameters

State
Determines whether to define level styles or use the Numbers Only format in an outline. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Numbers only format off
Yes! 1 Numbers only format on

Example

To specify the Numbers Only format for a style named My Style, the command sequence is:

OutlineStyleEditBegin("My Style";PersonalLibrary!)
OutlineStyleNumbersOnly(Yes!)
OutlineStyleEditEnd(Save!)

See Also

OutlineStyleRename

OutlineStyleRename renames a user-created outline style. This command must be used in conjunction with OutlineStyleEditBegin and OutlineStyleEditEnd. This command is the equivalent of choosing Tools, Outline, Outline Options, Outline Style, highlighting a style, Edit, Name, and entering a new name.

Syntax

OutlineStyleRename(New Name)

Parameters

New Name
A character expression renaming a user-created outline style.

Example

To rename a user-created style named Old Style to My Style, the command sequence is:

OutlineStyleEditBegin("Old Style";PersonalLibrary!)
OutlineStyleRename("My Style")
OutlineStyleEditEnd(Save!)

See Also

OutlineStyleRetrieve

OutlineStyleRetrieve retrieves an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, Retrieve, entering a style name, and selecting options.

Syntax

OutlineStyleRetrieve(Name;Type;Location)

Parameters

Name
A character expression specifying an outline style to retrieve.
Type
Determines whether to retrieve Corel WordPerfect system outline styles, user-created outline styles, or both. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
UserStyles! 1 Retrieves only user styles
SystemStyles! 2 Retrieves only system styles
AllStyles! 3 Retrieves all style types
Location (optional)
Specifies the library of a file to retrieve. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To retrieve a user-created outline style named My Style from the current personal library, the command is:

OutlineStyleRetrieve("My Style";UserStyles!;PersonalLibrary!)

See Also

OutlineStyleSave

OutlineStyleSave saves an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, Save, entering a style name, and selecting options.

Syntax

OutlineStyleSave(Name;Type;Location)

Parameters

Name
A character expression specifying an outline style to save.
Type
Specifies whether to save Corel WordPerfect system outline styles, user-created outline styles, or both. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
UserStyles! 1 Saves only user styles
SystemStyles! 2 Saves only system styles
AllStyles! 3 Saves all style types
Location (optional)
Specifies the library of a file to save. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
CurrentDoc! 0 Current document
PersonalLibrary! 1 Personal library
SharedLibrary! 2 Shared library

Example

To save a Corel WordPerfect system outline style named Numbers in the current shared library, the command is:

OutlineStyleSave("Numbers";SystemStyles!;SharedLibrary!)

See Also

OutlineStyleSelect

OutlineStyleSelect selects an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting an outline style, Select.

Syntax

OutlineStyleSelect(Name)

Parameters

Name
Selects an outline style. To specify a Corel WordPerfect style, select an enumerated type or its numeric equivalent. To specify a user-created style, use a character expression.
Enumerated Type Numeric Equivalent Description
NormalStyle! 0 Normal style
FootnoteNumberInDocumentStyle! 16 Ftn#inDoc style
EndnoteNumberInDocumentStyle! 17 Endn#inDoc style
FigureNumberStyle! 18 FigureNum style
TableBoxNumberStyle! 19 TblBoxNum style
TextBoxNumberStyle! 20 TextBoxNum style
UserBoxNumberStyle! 21 UserBoxNum style
EquationNumberStyle! 22 EquationNum style
HypertextStyle! 23 Hypertext style
ToC1Style! 24 TableofCont1 style
ToC2Style! 25 TableofCont2 style
ToC3Style! 26 TableofCont3 style
ToC4Style! 27 TableofCont4 style
ToC5Style! 28 TableofCont5 style
Index1Style! 29 Index1 style
Index2Style! 30 Index2 style
ListStyle! 31 List style
ToAStyle! 32 TableofAuth style
InitialCodesStyle! 33 InitialCodes style
BoxTextStyle! 34 BoxText style
CaptionStyle! 35 Caption style
FootnoteStyle! 36 Footnote style
EndnoteStyle! 37 Endnote style
CommentStyle! 38 Comment style
HeaderAStyle! 39 HeaderA style
HeaderBStyle! 40 HeaderB style
FooterAStyle! 41 FooterA style
FooterBStyle! 42 FooterB style
WatermarkAStyle! 43 WatermarkA style
WatermarkBStyle! 44 WatermarkB style
ParagraphOutlnStyle! 45 Paragraph outline style
OutlineStyle! 46 Outline outline style
LegalOutlnStyle! 47 Legal outline style
BulletsOutlnStyle! 48 Bullets outline style
HeadingsOutlnStyle! 49 Headings outline style
Legal_2OutlnStyle! 50 Legal 2 outline style
NumbersOutlnStyle! 51 Numbers outline style
Level1Style! 52 Level 1 style
Level2Style! 53 Level 2 style
Level3Style! 54 Level 3 style
Level4Style! 55 Level 4 style
Level5Style! 56 Level 5 style
Level6Style! 57 Level 6 style
Level7Style! 58 Level 7 style
Level8Style! 59 Level 8 style
Legal1Style! 60 Legal 1 style
Legal2Style! 61 Legal 2 style
Legal3Style! 62 Legal 3 style
Legal4Style! 63 Legal 4 style
Legal5Style! 64 Legal 5 style
Legal6Style! 65 Legal 6 style
Legal7Style! 66 Legal 7 style
Legal8Style! 67 Legal 8 style
Heading1Style! 68 Heading 1 style
Heading2Style! 69 Heading 2 style
Heading3Style! 70 Heading 3 style
Heading4Style! 71 Heading 4 style
Heading5Style! 72 Heading 5 style
Heading6Style! 73 Heading 6 style
Heading7Style! 74 Heading 7 style
Heading8Style! 75 Heading 8 style

Example

To select the Bullets outline style, the command is:

OutlineStyleSelect(BulletsOutlnStyle!)

OutlineTop

OutlineTop positions the cursor at the beginning of an outline. While in Edit in Outline Mode, this command is the equivalent of pressing Home, Up Arrow.

Syntax

OutlineTop

Parameters

None.

See Also

OutlineUp

OutlineUp blocks the previous outline paragraph. After blocking each paragraph of an outline family, OutlineUp blocks the entire family. While in Edit in Outline Mode this command is the equivalent of pressing Up Arrow.

Syntax

OutlineUp

Parameters

None.

See Also

OutputOption

OutputOption specifies a printer output type. This command is the equivalent of choosing File, Print/Fax, Output Options, and selecting options.

Syntax

OutputOption(Type;Bins)

Parameters

Type
Specifies the type of output from a printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
OutputToSort! 1 Sorting on
OutputToPutGroup! 2 Grouping on
OutputToBins! 16 Output to bins
OutputPutNone! 64 No special options
Bins (optional)
A numeric expression specifying output bins to mark.

Example

To sort output into bins 1 and 2, the command is:

OutputOption(OutputToSort!;1;2)

See Also

OutputOptionsOffsetJogger

OutputOptionsOffsetJogger determines whether the Offset Jogger option is selected in the Output Options dialog box. This command is the equivalent of choosing File, Print/Fax, Output Options, and selecting or deselecting Offset Jogger.

Syntax

OutputOptionsOffsetJogger(State)

Parameters

State
Determines whether Offset Jogger is active. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
JoggerOn! 8 Offset Jogger On
JoggerOff! 10 Offset Jogger Off

Example

To activate the Offset Jogger option in the Output Options dialog box, the command is:

OutputOptionsOffsetJogger(JoggerOn!)

See Also

OverstrikeCreate

OverstrikeCreate creates an overstrike. This command is the equivalent of choosing Layout, Character, Create Overstrike, and specifying the characters to overstrike.

Syntax

OverstrikeCreate(Characters)

Parameters

Characters
A character expression specifying two or more characters to create an overstrike character.

Example

To overstrike characters = and \, the command is:

OverstrikeCreate("=\")

See Also

OverstrikeCreateDlg

OverstrikeCreateDlg displays the Create Overstrike dialog box. This command is the equivalent of choosing Layout, Character, Create Overstrike.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

OverstrikeCreateDlg

Parameters

None.

See Also

OverstrikeEdit

OverstrikeEdit edits the first overstrike to the right of the cursor. The edited overstrike is replaced by the text in the Characters parameter. This command is the equivalent of choosing Layout, Character, Edit Overstrike, and entering overstrike characters.

Syntax

OverstrikeEdit(Characters)

Parameters

Characters
A character expression specifying new overstrike characters.

Example

To replace an existing overstrike with characters x, y, and z, the command is:

OverstrikeEdit("xyz")

See Also

OverstrikeEditDlg

OverstrikeEditDlg displays the Edit Overstrike dialog box. This command is the equivalent of choosing Layout, Character, Edit Overstrike.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

OverstrikeEditDlg

Parameters

None.

PageDown

PageDown is the equivalent of pressing Page Down. This command is not recordable. To use this command, you must type it into the macro.

Syntax

PageDown

Parameters

None.

PageNumber

PageNumber specifies a new page number for the current page. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number, New Number, and specifying a page number.

Syntax

PageNumber(New Number)

Parameters

New Number
A numeric expression specifying a new number for the current page.

Example

To change the current page number of a page to 5, the command is:

PageNumber(5)

PageNumberDecrement

PageNumberDecrement decreases the current page number by one. For example, if the current page number is 23, this command would make the page number 22. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number, Decrement Number.

Syntax

PageNumberDecrement

Parameters

None.

See Also

PageNumberDisplay

PageNumberDisplay displays a page number in the current document window. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number, Display in Document.

Syntax

PageNumberDisplay

Parameters

None.

PageNumberDisplayFormat

PageNumberDisplayFormat displays a formatted page number in the current document window. This command is the equivalent of choosing Layout, Page, Page Numbering, Insert Formatted Page Number.

Syntax

PageNumberDisplayFormat

Parameters

None.

See Also

PageNumberFormat

PageNumberFormat specifies a page number format including text, volume or chapter numbers, or secondary page numbers. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number Format, and entering a format.

Syntax

PageNumberFormat(Format)

Parameters

Format
A character expression specifying a page number format. Connect multiple characters with a plus sign (+).

Example

To format page numbers as a chapter number followed by a period and Page n (n being the number), the command is:

PageNumberFormat("[chapter #]."+"Page [page #]")

See Also

PageNumberIncrement

PageNumberIncrement increases the current page number by one. For example, if the current page number is 24, this command would make the page number 25. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number, Increment Number.

Syntax

PageNumberIncrement

Parameters

None.

See Also

PageNumberingDlg

PageNumberingDlg displays the Page Numbering dialog box. This command is the equivalent of choosing Layout, Page, Page Numbering.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PageNumberingDlg

Parameters

None.

See Also

PageNumberMethod

PageNumberMethod specifies a page numbering method. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number, Numbering Method, and selecting a numbering method.

Syntax

PageNumberMethod(Method)

Parameters

Method
Specifies a page numbering method. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Numbers! 0 Numbers
LowerLetters! 1 Lower-case letters
UpperLetters! 2 Upper-case letters
LowerRoman! 3 Lower-case roman numerals
UpperRoman! 4 Upper-case roman numerals

Example

To specify uppercase roman numerals as the page numbering method, the command is:

PageNumberMethod(UpperRoman!)

PageNumberPosition

PageNumberPosition specifies the position and appearance of page numbering. This command is the equivalent of choosing Layout, Page, Page Numbering, Page Number Position, and selecting options.

Syntax

PageNumberPosition(Position;Values;Font;Point Size;Red Value;Green Value;Blue Value;Shading Value;{Attributes})

Parameters

Position
Specifies where a page number prints.
Enumerated Type Numeric Equivalent
None! 0
TopLeft! 1
TopCenter! 2
TopRight! 3
TopAlternating! 4
BottomLeft! 5
BottomCenter! 6
BottomRight! 7
BottomAlternating! 8
Values
Determines whether the page numbering font uses the initial document font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
UseDefaultValues! 0
DontUseDefaultValues! 1
Font (optional)
A character expression specifying a page numbering font. Use this parameter only if the Values parameter is set to DontUseDefaultValues! or 1.
Point Size (optional)
A measurement expression specifying the point size of the page numbering font. You may use this parameter if the Values parameter is set to DontUseDefaultValues! or 1.
Red Value (optional)
A numeric expression representing the amount of red in a color. Values range from 0 to 255. You may use this parameter if the Values parameter is set to DontUseDefaultValues! or 1.
Green Value (optional)
A numeric expression representing the amount of green in a color. See Red Value above.
Blue Value (optional)
A numeric expression representing the amount of blue in a color. See Red Value above.
Shading Value (optional)
A numeric expression representing the shading percentage of a color. Values range from 0 to 100. You may use this parameter if the Values parameter is set to DontUseDefaultValues! or 1.
Attributes (optional)
Specifies attributes and relative size of a font. This parameter is placed in French braces {} because you may choose more than one attribute. For instance, you can specify a large, bold, underlined, shadowed font by placing the corresponding enumerated types in French braces with semicolons between each enumerated type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
ExtraLarge! 0
VeryLarge! 1
Large! 2
Small! 3
Fine! 4
Superscript! 5
Subscript! 6
Outline! 7
Italics! 8
Shadow! 9
Redline! 10
DoubleUnderline! 11
Bold! 12
Strikeout! 13
Underline! 14
SmallCaps! 15

Example

To position page numbers at the bottom center of each page using a small, italicized, bold font, the command is:

PageNumberPosition(BottomCenter!;DontUseDefaultValues!;;;;;;;{Small!;Italics!;Bold!})

PageSuppressDlg

PageSuppressDlg displays the Suppress (This Page Only) dialog box. This command is the equivalent of choosing Layout, Page, Suppress.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PageSuppressDlg

Parameters

None.

PageUp

PageUp is the equivalent of pressing Page Up. This command is not recordable. To use this command, you must type it into the macro.

Syntax

PageUp

Parameters

None.

PaperSize

PaperSize creates or edits a paper size/type. This command is the equivalent of choosing Layout, Page, Paper Size/Type, Create or Edit, and specifying settings in the Create Paper Size/Type or Edit Size/Type dialog box.

Syntax

PaperSize(Name;Type;Width;Height;Location;Prompt;Orientation;Vertical Adjustment Direction;Vertical Adjustment Amount;Horizontal Adjustment Direction;Horizontal Adjustment Amount)

Parameters

Name
A character expression specifying the name of a paper size/type to create or edit.
Type
Specifies the type of the paper size/type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Standard! 1
Bond! 2
Letterhead! 3
Labels! 4
Envelope! 5
Transparency! 6
Cardstock! 7
Glossy! 8
Special! 9
Other! 255
Width
A measurement expression specifying the width of a paper size/type.
Height
A measurement expression specifying the height of a paper size/type.
Location
Specifies where the paper size is fed into the printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Continuous! 0
Bin1! 1
Bin2! 2
Bin3! 3
Bin4! 4
Bin5! 5
Bin6! 6
Bin7! 7
Bin8! 8
Bin9! 9
Bin10! 10
Bin11! 11
Bin12! 12
Bin13! 13
Bin14! 14
Bin15! 15
Bin16! 16
Bin17! 17
Bin18! 18
Bin19! 19
Bin20! 20
Bin21! 21
Bin22! 22
Bin23! 23
Bin24! 24
Bin25! 25
Bin26! 26
Bin27! 27
Bin28! 28
Bin29! 29
Bin30! 30
Bin31! 31
ManualFeed! 32
Prompt
Determines whether Corel WordPerfect prompts user to load paper when printing.
Enumerated Type Numeric Equivalent Description
No! 0 Don't prompt to load
Yes! 1 Prompt to load
Orientation (optional)
Specifies the direction of both paper feed and printing on the page. If not specified, the default is PortraitFont! The only exception is when the width is larger than the height; in that case, the default is WideFormPortraitFont!
Enumerated Type Numeric Equivalent
PortraitFont! 0
WideFormLandscapeFont! 1
LandscapeFont! 2
WideFormPortraitFont! 3
Vertical Adjustment Direction (optional)
This parameter specifies that a vertical adjustment needs to be made in order for the text to print on the paper correctly. If you use this parameter, also use the Vertical Adjustment Amount parameter to specify the amount of vertical adjustment. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Down! 0
Up! 1
Vertical Adjustment Amount (optional)
A measurement expression specifying an amount of vertical adjustment. See Vertical Adjustment Direction above.
Horizontal Adjustment Direction (optional)
This parameter specifies that a horizontal adjustment needs to be made in order for the text to print on the paper correctly. If you use this parameter, also use the Horizontal Adjustment Value parameter to specify the amount of horizontal adjustment. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Left! 0
Right! 3
Horizontal Adjustment Amount (optional)
A measurement expression specifying an amount of horizontal adjustment. See Horizontal Adjustment Direction above.

Example

To create or edit a paper size/type named Scratch Paper with standard settings, the command is:

PaperSize("Scratch Paper";Standard!;8.5";11";Continuous!;No!;PortraitFont!;Down!;0";Right!;0")

PaperSizeDelete

PaperSizeDelete deletes a paper size/type. This command is the equivalent of choosing Layout, Page, Paper Size/Type, highlighting a paper name, Delete.

Syntax

PaperSizeDelete(Name)

Parameters

Name
A character expression specifying the name of a paper size/type to delete.

Example

To delete a paper size/type named Scratch Paper, the command is:

PaperSizeDelete("Scratch Paper")

PaperSizeSelect

PaperSizeSelect selects a paper size/type. This command is the equivalent of choosing Layout, Page, Paper Size/Type, highlighting a paper name, Select.

Syntax

PaperSizeSelect(Name;Width;Height;Type)

Parameters

Name (optional)
A character expression specifying the name of a paper size/type. You may want to use the rest of the parameters if you have more than one paper size/type with the same name.
Width (optional)
A measurement expression specifying the width of a paper size/type.
Height (optional)
A measurement expression specifying the height of a paper size/type.
Type (optional)
Specifies a type of paper size/type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Standard! 1
Bond! 2
Letterhead! 3
Labels! 4
Envelope! 5
Transparency! 6
Cardstock! 7
Glossy! 8
Special! 9
Other! 255

Example

To select a paper size/type named Envelope (Monarch), the command is:

PaperSizeSelect("Envelope (Monarch)";7.5";3.88";Envelope!)

PaperSizeTypeDlg

PaperSizeTypeDlg displays the PaperSize/Type dialog box. This command is the equivalent of choosing Layout, Page, Paper Size/Type.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PaperSizeTypeDlg

Parameters

None.

See Also

ParagraphDown

ParagraphDown moves the cursor down one paragraph (marked by a hard return or hard page break [HPg]). This command is the equivalent of pressing Ctrl+Down Arrow.

Syntax

ParagraphDown

Parameters

None.

ParagraphSpacing

ParagraphSpacing specifies the spacing of a Hard Return, thus specifying the spacing between paragraphs. The default spacing is 1.0, which is equal to the font point size plus 2 points. A point is 1/72". This command is the equivalent of choosing Layout, Margins, Paragraph Spacing, and specifying paragraph spacing.

Syntax

ParagraphSpacing(Spacing)

Parameters

Spacing
A numeric expression specifying the spacing between paragraphs. The default is 1.0.

Example

To specify a spacing of 1.2 between paragraphs, the command is:

ParagraphSpacing(1.2)

ParagraphUp

ParagraphUp moves the cursor to the beginning of the previous paragraph. This command is the equivalent of pressing Ctrl+Up Arrow.

Syntax

ParagraphUp

Parameters

None.

PasswordAddChange

PasswordAddChange adds or changes the password of the current document. This command is the equivalent of choosing File, Save As, Password, and setting a password.

IMPORTANT: If you type this command into a macro, you may compromise file security because the password will be visible in the macro. However, if you record this command, the password will be represented by quotation marks in the Password parameter.

Syntax

PasswordAddChange(Password)

Parameters

Password
A character expression specifying a password.

Example

To change or set the password on the current document to Confidential, the command is:

PasswordAddChange("CONFIDENTIAL")

PasswordRemove

PasswordRemove removes the password from the document. This command is the equivalent of choosing File, Save As, Password, Remove.

Syntax

PasswordRemove

Parameters

None.

Paste

Paste copies the contents of the buffer into the current document at the cursor position. This command is the equivalent of choosing Edit, Paste.

Syntax

Paste

Parameters

None.

PersonalInfo

PersonalInfo inserts text into the various personal information set items. This command is the equivalent of choosing File, Template, Personal Information, selecting a personal information set, choosing Edit, then editing the text of the various items in the set.

Syntax

PersonalInfo(DataType;Data)

Parameters

DataType
Specifies an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PDSetName! 0 Name set
PDName! 1 Name entry
PDTitle! 2 Title entry
PDOrganization! 3 Organization entry
PDAddress! 4 Address entry
PDCityStateZip! 5 City, state, and zip code entry
PDCountry! 6 Country entry
PDTelephone! 7 Telephone entry
PDFaxnumber! 8 Fax number entry
PDCustom1! 9 Customized entry
PDCustom2! 10 Customized entry
PDCustom3! 11 Customized entry
PDCustom4! 12 Customized entry
PDCustom5! 13 Customized entry
PDCustom6! 14 Customized entry
PDCustom7! 15 Customized entry
PDCustom8! 16 Customized entry
PDCustom9! 17 Customized entry
Data
A character expression specifying the text you want to insert for that item.

Example

To add Daniel O'Brien as a name to the Danny personal information set, the command sequence is:

PersonalInfoBegin("Danny")
PersonalInfo(PDName!;"Daniel O'Brien")
PersonalInfoEnd

See Also

PersonalInfoBegin

PersonalInfoBegin either creates a new personal information set or opens an existing personal information set. This command is equivalent of choosing File, Templates, Personal Information, Create or Edit.

Syntax

PersonalInfoBegin(Name)

Parameters

Name
A character expression specifying the name of the personal information set you want to create or edit.

Example

To create the Danny personal information set so you can begin entering items, the command is:

PersonalInfoBegin("Danny")

PersonalInfoDelete

PersonalInfoDelete deletes the specified personal information set. This command is equivalent of choosing File, Templates, Personal Information, selecting a personal information set, then Delete.

Syntax

PersonalInfoDelete(Name)

Parameters

Name
A character expression specifying the name of the personal information set you want to delete.

Example

To delete the Danny personal information set, the command is, the command is:

PersonalInfoDelete("Danny")

PersonalInfoDlg

PersonalInfoDlg displays the Personal Information Sets dialog box. This command is the equivalent of choosing File, Template, Personal Information.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PersonalInfoDlg

Parameters

None.

See Also

PersonalInfoEnd

PersonalInfoEnd finishes editing a personal information set and saves or cancels changes. This command is the equivalent to choosing OK or Cancel after editing a personal information set.

Syntax

PersonalInfoEnd(State)

Parameters

State
Specifies whether to save a personal information set. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Cancel! 0 Do not save changes
Save! 1 Save changes

Example

To save a personal information set, the command is:

PersonalInfoEnd(Save!)

See Also

PersonalInfoSelect

PersonalInfoSelect selects a personal information set. The templates you create will then use this personal information set as the source of the personal information they insert. This command is the equivalent of chooising File, Template, Personal Information, highlighting a personal information set, then choosing Select.

Syntax

PersonalInfoSelect(Name)

Parameters

Name
A character expression specifying the name of the personal information set you want to select.

Example

To select the Danny personal information set, the command is:

PersonalInfoSelect("Danny")

PosBlockBeg

Moves the cursor to the position in the document where the block was activated. If there is no active block then the command functions the same as the PosGoPrevious command, moving the cursor to its last position.

Syntax

PosBlockBeg

Parameters

None.

PosBlockBottom

PosBlockBottom moves the cursor to the end of the block which is closest to the end of the document.

Syntax

PosBlockBottom

Parameters

None.

PosBlockTop

PosBlockTop moves the cursor to the end of the block which is closest to the beginning of the document.

Syntax

PosBlockTop

Parameters

None.

PosCharacter

PosCharacter searches forward and positions the cursor after a specified character.

Syntax

PosCharacter(Character)

Parameters

Character
A character expression specifying a single search character.

Example

To position the cursor after the first C to the right of the cursor, the command is:

PosCharacter("C")

PosCharNext

PosCharNext moves the cursor one character to the right. This command is the equivalent of pressing Right Arrow.

Syntax

PosCharNext

Parameters

None.

PosCharPrevious

PosCharPrevious moves the cursor one character to the left. This command is the equivalent of pressing Left Arrow.

Syntax

PosCharPrevious

Parameters

None.

PosColBottom

PosColBottom positions the cursor at the beginning of the last line of a current column or, if not in Columns, at the beginning of the last line of the document. This command is the equivalent of choosing Edit, Go to, and pressing Down Arrow.

Syntax

PosColBottom

Parameters

None.

PosColDown

PosColDown moves the cursor down one row in the current column. If the cursor is not in Parallel Columns, this command has no effect. This command is the equivalent of pressing Alt+Down Arrow while the cursor is in Parallel Columns.

Syntax

PosColDown

Parameters

None.

PosColFirst

PosColFirst positions the cursor at the left margin of the first column. This command is the equivalent of pressing Ctrl+Home, Home, Left Arrow while the cursor is in Columns.

Syntax

PosColFirst

Parameters

None.

PosColLast

PosColLast positions the cursor in the last column of a current row. If the cursor is not in Columns, this command has no effect. This command is the equivalent of pressing Ctrl+Home, Home, Right.

Syntax

PosColLast

Parameters

None.

PosColNext

PosColNext moves the cursor one column to the right. If the cursor is not in Columns, this command has no effect. This command is the equivalent of pressing Alt+Right Arrow.

Syntax

PosColNext

Parameters

None.

PosColNextWP51

PosColNextWP51 moves the cursor one column to the right. If the cursor is not in Columns, this command has no effect. With Corel WordPerfect 5.1 Cursor Movement selected, this command is the equivalent of pressing Ctrl+Home, Right Arrow.

Syntax

PosColNxtWP51

Parameters

None.

PosColPrevious

PosColPrevious moves the cursor one column to the left. This command is the equivalent of pressing Alt+Left Arrow.

Syntax

PosColPrevious

Parameters

None.

PosColPreviousWP51

PosColPreviousWP51 moves the cursor one column to the left. If the cursor is not in Columns, this command has no effect. With WordPerfect 5.1 Cursor Movement selected, this command is the equivalent of pressing Ctrl+Home, Left Arrow.

Syntax

PosColPreviousWP51

Parameters

None.

PosColTop

PosColTop positions the cursor at the top of the current column. If the cursor is not in Columns, this command has no effect. This command is the equivalent of pressing Ctrl+Home, Up Arrow.

Syntax

PosColTop

Parameters

None.

PosColUp

PosColUp moves the cursor up one row in the current column. If the cursor is not in Columns, this command has no effect. This command is the equivalent of pressing Alt+Up Arrow.

Syntax

PosColUp

Parameters

None.

PosDocBottom

PosDocBottom positions the cursor at the end of the current document. This command is the equivalent of pressing Home, Home, Down Arrow.

Syntax

PosDocBottom

Parameters

None.

PosDocTop

PosDocTop positions the cursor at beginning of document text. This command is the equivalent of pressing Home, Home, Up Arrow.

Syntax

PosDocTop

Parameters

None.

PosDocVeryBottom

PosDocVeryBottom positions the cursor at the end of a document after all codes. This command is the equivalent of pressing Home, Home, Home, Down Arrow.

Syntax

PosDocVeryBottom

Parameters

None.

PosDocVeryTop

PosDocVeryTop positions the cursor at the beginning of a document before all codes. This command is the equivalent of pressing Home, Home, Home, Up Arrow.

Syntax

PosDocVeryTop

Parameters

None.

PosFunction

PosFunction positions the cursor to the right of a special code. This command is not recordable. To use this command, you must type it into the macro.

Syntax

PosFunction(Code)

Parameters

Code
Specifies a code to search for. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
HardSpace! 129
HardHyphen! 132
CancelHyphenation! 144
HardEndOfLine! 204
SoftEndOfLine! 207
Tab! 225

Example

To position the cursor to the right of a Hard Space, the command is:

PosFunction(HardSpace!)

See Also

PosGoPrevious

PosGoPrevious positions the cursor at the previous cursor position. This command is the equivalent of pressing Ctrl+Home twice.

Syntax

PosGoPrevious

Parameters

None.

PosLineBeg

PosLineBeg positions the cursor at the beginning of the current line of text. This command is the equivalent of pressing Home, Home, Left Arrow.

Syntax

PosLineBeg

Parameters

None.

PosLineDown

PosLineDown moves the cursor down one line. This command is the equivalent of pressing Down Arrow.

Syntax

PosLineDown

Parameters

None.

PosLineEnd

PosLineEnd positions the cursor at the end of the current line of text. This command is the equivalent of pressing Home, Home, Right Arrow.

Syntax

PosLineEnd

Parameters

None.

PosLineUp

PosLineUp moves the cursor up one line. This command is the equivalent of pressing Up Arrow.

Syntax

PosLineUp

Parameters

None.

PosLineVeryBeg

PosLineVeryBeg positions the cursor at the beginning of a line before all codes. This command is the equivalent of pressing Home, Home, Home, Left Arrow.

Syntax

PosLineVeryBeg

Parameters

None.

PosLineVeryEnd

PosLineVeryEnd positions the cursor at the end of a line after all codes (with the exception of end of line codes). This command is the equivalent of pressing Home, Home, Home, Right Arrow.

Syntax

PosLineVeryEnd

Parameters

None.

PosPage

PosPage is the equivalent of pressing Ctrl+Home then typing the Volume number, Chapter number, Page number, then either pressing PageUp or PageDown to specify the direction.

Syntax

PosPage(Volume;Chapter;Page;Direction)

Parameters

Volume
A numeric expression specifying a volume number.
Chapter
A numeric expression specifying a chapter number.
Page
A numeric expression specifying a page number.
Direction
Specifies a direction. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Down! 0
Up! 1

Example

To position the cursor at page 3 of chapter 2 in volume 1, the command is:

PosPage(1;2;3;Up!)

PosPageBottom

PosPageBottom positions the cursor at the bottom of a current page. It is the equivalent of pressing Ctrl+Home, Down Arrow.

Syntax

PosPageBottom

Parameters

None.

PosPageNext

PosPageNext positions the cursor at the beginning of the next page. If the cursor is on the last page of the document, this command positions the cursor at the end of the page. This command is the equivalent of pressing Page Down.

Syntax

PosPageNext

Parameters

None.

PosPagePrevious

PosPagePrevious positions the cursor at the beginning of the previous page. If the cursor is on the first page of the document, this command positions the cursor at the top of that page. This command is the equivalent of pressing Page Up.

Syntax

PosPagePrevious

Parameters

None.

PosPageTop

PosPageTop positions the cursor at the top of a current page. This command is the equivalent of pressing Ctrl+Home, Up.

Syntax

PosPageTop

Parameters

None.

PosScreenDown

PosScreenDown positions the cursor at the bottom of the screen, then down one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Down Arrow, or with Num Lock off, pressing the plus key (+) on the numeric keypad.

Syntax

PosScreenDown

Parameters

None.

PosScreenLeft

PosScreenLeft positions the cursor at the left edge of the screen, then left one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Left Arrow.

Syntax

PosScreenLeft

Parameters

None.

PosScreenRight

PosScreenRight positions the cursor at the right edge of the screen, then right one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Right Arrow.

Syntax

PosScreenRight

Parameters

None.

PosScreenUp

PosScreenUp positions the cursor at the top of the screen, then up one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Up Arrow or, with Num Lock off, pressing the minus key (-) on the numeric keypad.

Syntax

PosScreenUp

Parameters

None.

PosSelectBottom

PosSelectBottom positions the cursor at the end (bottom) of the current block.

Syntax

PosSelectBottom

Parameters

None.

PosSelectTop

PosSelectTop positions the cursor at the top (beginning) of the current block.

Syntax

PosSelectTop

Parameters

None.

PosTableBeg

PosTableBeg positions the cursor in the first cell of a table. This command is the equivalent of pressing Home, Home, Up Arrow while in table editing mode.

Syntax

PosTableBeg

Parameters

None.

PosTableBlockBeg

PosTableBlockBeg positions the cursor in the first cell of a table.

Syntax

PosTableBlockBeg

Parameters

None.

PosTableCell

PosTableCell positions the cursor in the cell specified in the Cell parameter. This command is the equivalent of pressing Ctrl+Home, typing the cell address, and pressing Enter while in table editing mode.

Syntax

PosTableCell(Cell)

Parameters

Cell
A character expression specifying the table cell in which to position the cursor.

Example

To position the cursor in cell B3, the command is:

PosTableCell("B3")

PosTableCellBottom

PosTableCellBottom positions the cursor at the beginning of the last line in a table cell. To use this command, you must type it into the macro.

Syntax

PosTableCellBottom

Parameters

None.

PosTableCellDown

PosTableCellDown moves the cursor down one cell in a table. This command is the equivalent of pressing Alt+Down Arrow while the cursor is in a table.

Syntax

PosTableCellDown

Parameters

None.

PosTableCellNext

PosTableCellNext positions the cursor in the cell to the right. If the cursor is in the far-right cell, the cursor moves to the first cell in the next row. This command is the equivalent of pressing Alt+Right arrow while the cursor is in a table.

Syntax

PosTableCellNext

Parameters

None.

PosTableCellPrevious

PosTableCellPrevious positions the cursor one cell to the left. If the cursor is in the left-most cell, the cursor moves to the last cell on the previous row. This command is the equivalent of pressing Alt+Left arrow while the cursor is in a Table.

Syntax

PosTableCellPrevious

Parameters

None.

PosTableCellTop

PosTableCellTop positions the cursor at the top of a current table cell. This command is not recordable. To use this command, you must type it into the macro.

Syntax

PosTableCellTop

Parameters

None.

PosTableCellUp

PosTableCellUp positions the cursor up one table cell. This command is the equivalent of pressing Alt+Up Arrow, while the cursor is in a table.

Syntax

PosTableCellUp

Parameters

None.

PosTableColBottom

PosTableColBottom positions the cursor at the bottom of a current column. This command is the equivalent of pressing Home+Down Arrow while in table editing mode.

Syntax

PosTableColBottom

Parameters

None.

PosTableColTop

PosTableColTop positions the cursor at the top of the current column. This command is the equivalent of pressing Home+Up Arrow while in table editing mode.

Syntax

PosTableColTop

Parameters

None.

PosTableEnd

PosTableEnd positions the cursor in the last cell of a table. This command is the equivalent of pressing Home, Home, Down Arrow while in table editing mode.

Syntax

PosTableEnd

Parameters

None.

PosTableGoPrevious

PosTableGoPrevious returns the cursor to its previous position in a table. This command is the equivalent of pressing Ctrl+Home twice while in table editing mode.

Syntax

PosTableGoPrevious

Parameters

None.

PosTableRowBeg

PosTableRowBeg positions the cursor in the first cell of a current row. This command is the equivalent of Home, Home, Home, Left Arrow while in a table.

Syntax

PosTableRowBeg

Parameters

None.

PosTableRowEnd

PosTableRowEnd positions the cursor in the last cell of a current row. This command is the equivalent of pressing Home, Home, Home, Right Arrow while in a table.

Syntax

PosTableRowEnd

Parameters

None.

PosTableScreenDown

PosTableScreenDown positions the cursor at the bottom of the screen in Tables, then down one screen at a time with each repetition of the command. This command is the equivalent of pressing Page Down (or the plus key (+) on the numeric keypad) while in table editing mode.

Syntax

PosTableScreenDown

Parameters

None.

PosTableScreenLeft

PosTableScreenLeft positions the cursor at the left edge of the screen in Tables, then left one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Left Arrow while in table editing mode.

Syntax

PosTableScreenLeft

Parameters

None.

PosTableScreenRight

PosTableScreenRight positions the cursor at the right edge of the screen in Tables, then right one screen at a time with each repetition of the command. This command is the equivalent of pressing Home, Right Arrow while in table editing mode.

Syntax

PosTableScreenRight

Parameters

None.

PosTableScreenUp

PosTableScreenUp positions the cursor at the top of the screen in Tables, then up one screen at a time with each repetition of the command. This command is the equivalent of pressing Page Up (or the minus key (-) on the numeric keypad) while in table editing mode.

Syntax

PosTableScreenUp

Parameters

None.

PosTableTopCellNext

PosTableTopCellNext moves the cursor one cell to the right. If the cursor is in the last cell of a table, this command creates a new table row at the bottom of the table. This command is the equivalent of pressing Tab while the cursor is in a table.

Syntax

PosTableTopCellNext

Parameters

None.

PosTableTopCellPrevious

PosTableTopCellPrevious positions the cursor one cell to the left. This command is the equivalent of pressing Shift+Tab while the cursor is in a table.

Syntax

PosTableTopCellPrevious

Parameters

None.

PosWordNext

PosWordNext positions the cursor at the beginning of the next word. This command is the equivalent of pressing Ctrl+Right Arrow.

Syntax

PosWordNext

Parameters

None.

PosWordPrevious

PosWordPrevious positions the cursor at the beginning of the previous word. This command is the equivalent of pressing Ctrl+Left Arrow.

Syntax

PosWordPrevious

Parameters

None.

PreviewGraphicsInBlackWhite

PreviewGraphicsInBlackWhite determines whether graphics are viewed in black and white. This command is the equivalent of choosing File, Setup, View Text & Graphics in Black & White while in Print Preview.

Syntax

PreviewGraphicsInBlackWhite(State)

Parameters

State
Determines whether graphics are viewed only in black and white. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
No! 0 Graphics not viewed in black and white
Yes! 1 Graphics are viewed in black and white

Example

To view graphics in black and white, the command is:

PreviewGraphicsInBlackWhite(Yes!)

See Also

PreviewTextInBlackWhite

PreviewTextInBlackWhite determines whether Print Preview text is viewed only in black and white. This command is the equivalent of choosing File, Print Preview, File, Setup, View Text & Graphics in Black & White.

Syntax

PreviewTextInBlackWhite(State)

Parameters

State
Determines whether Print Preview text is viewed only in black and white.
Enumerated Type Numeric Equivalent Description
No! 0 Print Preview not in black and white
Yes! 1 Print Preview in black and white

Example

To view text in black and white, the command is:

PreviewTextInBlackWhite(Yes!)

See Also

PrintBlock

PrintBlock prints selected text. This command is the equivalent of blocking text, pressing Shift+F7, Print.

Syntax

PrintBlock

Parameters

None.

PrintCopies

PrintCopies specifies a number of copies of the current document to print. This command is the equivalent of choosing File, Print/Fax, Number of Copies, and entering a number.

Syntax

PrintCopies(Number)

Parameters

Number
A numeric expression specifying a number of copies to print.

Example

To set the number of copies to print to 2, the command is:

PrintCopies(2)

See Also

PrintCopiesBy

PrintCopiesBy determines whether multiple copies of the specified document are generated by Corel WordPerfect or by a printer. This command is the equivalent of choosing File, Print/Fax, Generated By, and highlighting an option.

Syntax

PrintCopiesBy(Source)

Parameters

Source
Determines whether multiple copies are generated by Corel WordPerfect or by a printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WordPerfect! 0 Corel WordPerfect generates multiple copies
Printer! 1 Printer generates multiple copies
Network! 2 Network generates multiple copies

Example

To specify Corel WordPerfect as the generation source for multiple copies of a specified document, the command is:

PrintCopiesBy(WordPerfect!)

See Also

PrintCopiesBySetup

PrintCopiesBySetup determines whether Corel WordPerfect, the printer, or the network is the source of all multiple copies to print. This command must be used in conjunction with SetupSave. This command is the equivalent of choosing File, Print/Fax, Setup, Generated By, and selecting an option.

Syntax

PrintCopiesBySetup(Source)

Parameters

Source
Determines whether Corel WordPerfect, a printer or a network generates multiple copies to print. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
WordPerfect! 0 Corel WordPerfect generates multiple copies
Printer! 1 Printer generates multiple copies
Network! 2 Network generates multiple copies

Example

To designate Corel WordPerfect as the source of multiple copies, the command sequence is:

PrintCopiesBySetup(WordPerfect!)
SetupSave

See Also

PrintCopiesSetup

PrintCopiesSetup specifies a number of times to print all documents. This command must be used in conjunction with SetupSave. This command is the equivalent of choosing File, Print/Fax, Setup, Number of Copies, and specifying a number.

Syntax

PrintCopiesSetup(Number)

Parameters

Number
A numeric expression specifying a default number of copies to print.

Example

To print 2 copies of every document printed, the command sequence is:

PrintCopiesSetup(2)
SetupSave

See Also

PrintDlg

PrintDlg displays the Print/Fax dialog box. This command is the equivalent of choosing File, Print/Fax.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PrintDlg

Parameters

None.

PrintDocOnDisk

PrintDocOnDisk prints a document saved to disk. This command is the equivalent of choosing File, Print/Fax, Document on Disk, specifying a filename, and selecting options in the Print Multiple Pages dialog box.

Syntax

PrintDocOnDisk(Filename;Page Range;Secondary Page Range;Chapter Range;Volume Range;Odd/Even Pages;DocSummary;Pamphlet;Order)

Parameters

Filename
A character expression specifying the name of a file to print.
Page Range (optional)
A character expression specifying a range of pages to print.
Secondary Page Range (optional)
A character expression specifying a secondary range of pages to print.
Chapter Range (optional)
A character expression specifying a range of chapters to print.
Volume Range (optional)
A character expression specifying a range of volumes to print.
Odd/Even Pages (optional)
Determines whether to print all, odd, or even pages. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
PrintAll! 0 Print all pages
PrintOdd! 2 Print odd pages
PrintEven! 4 Print even pages
DocSummary
Determines whether to print a document summary if it exists. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoDocSummary! 0 Do not print document summary
DocSummary! 1 Print document summary
Pamphlet
Indicates whether the document is to be printed as a booklet. If the document is a booklet, Corel WordPerfect numbers and prints logical pages in the correct sequence. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoBooklet! 0 Document is not a booklet
Booklet! 1 Document is a booklet
Order
Determines whether pages print in ascending or descending order. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Forward! 0 Print in ascending order
Backward! 1 Print in descending order

Example

To print all pages of a document on disk named TEST with a document summary, the command is:

PrintDocOnDisk("TEST";;;;;PrintAll!;DocSummary!;NoBooklet!;Forward!)

PrinterAdd

PrinterAdd adds a printer to the Select Printer dialog box. This command is the equivalent of choosing File, Print/Fax, Select, Add Printer, and selecting a printer.

Syntax

PrinterAdd(Name;Filename)

Parameters

Name
A character expression specifying the name of a printer to add to the Select Printer dialog box.
Filename
A character expression specifying the full path of the .PRS filename.

Example

To add an HP LaserJet 4 to the Select Printer dialog box, the command is:

PrinterAdd("HP LaserJet 4";"C:\COREL\WP62\HP4.PRS")

See Also

PrinterColorConfigured

PrinterColorConfigured indicates whether a printer is configured for color printing. The ability to print in color depends on the capabilities of the printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, and selecting Printer Configured for Color.

Syntax

PrinterColorConfigured(Name;Filename;State)

Parameters

Name
A character expression specifying a printer name.
Filename (optional)
A character expression specifying the name of a printer .PRS file.
State
Indicates whether a printer is configured for color. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
ColorOff! 0 Not configured for color
ColorOn! 1 Configured for color

Example

To indicate an HP DeskJet 500C is configured for color, the command is:

PrinterColorConfigured("HP DeskJet 500C";"HP500C.PRS";ColorOn!)

PrinterCommand

PrinterCommand inserts a printer command code [Ptr Cmnd] into the current document. This command is the equivalent of choosing Layout, Other, Printer Functions, Printer Commands, and entering and selecting options in the Printer Commands dialog box.

Syntax

PrinterCommand(Type;Command)

Parameters

Type
Determines whether the second command is a printer command or the name of a file containing one or more printer commands. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
File! 0 Printer commands contained in a file
Command! 1 Command is a single printer command
Command
A character expression specifying either a printer command or the full path of a filename containing one or more printer commands.

Example

To insert printer commands into a current document using a filename PTRCMD, the command is:

PrinterCommand(File!;"C:\COREL\WP62\PTRCMD")

PrinterControlCancel

PrinterControlCancel cancels a print job on the Printer Control screen. This command is the equivalent of choosing File, Print/Fax, Control Printer, selecting Cancel Job, and choosing whether to cancel all jobs, the first job in the print queue, or a specific job number.

Syntax

PrinterControlCancel(Job)

Parameters

Job
Specifies a print job to cancel. Select either a numeric expression, or an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FirstJob! 0 Cancel first job in the print queue
AllJobs! 1 Cancel all print jobs in print queue

Example

To cancel print job 3 on the Printer Control screen, the command is:

PrinterControlCancel(3)

PrinterControlCancelImmediate

PrinterControlCancelImmediate cancels a print job on the Control Printer screen. This command must be used in conjunction with PrinterControlCancel. This command is the equivalent of choosing File, Print/Fax, Control Printer, highlighting a job, Cancel Job, Yes, Cancel Immed.

Syntax

PrinterControlCancelImmediate

Parameters

None.

PrinterControlDlg

PrinterControlDlg displays the Control Printer dialog box. This command is the equivalent of choosing File, Print/Fax, Control Printer.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PrinterControlDlg

Parameters

None.

PrinterControlGo

PrinterControlGo resumes printing when Prompt to Load is on. This command is the equivalent of choosing File, Print/Fax, Control Printer, Go.

Syntax

PrinterControlGo

Parameters

None.

PrinterControlNetworkQueue

PrinterControlNetworkQueue sets the network print queue in Control Printer. This is the equivalent of choosing File, Print/Fax, Control Printer, Network, Select Server/Queue, selecting a print server and queue.

Syntax

PrinterControlNetworkQueue(Queue)

Parameters

Queue
A character expression specifying a network queue.

Example

To specify PrintQ_0 as the network print queue, the command is:

PrinterControlNetworkQueue("PrintQ_0")

PrinterControlRush

PrinterControlRush advances a specified print job to the top of the print queue. This command is the equivalent of choosing File, Print/Fax, Control Printer, highlighting a print job, Rush Job, Yes, and selecting whether to interrupt the current job.

Syntax

PrinterControlRush(Job;Interfere)

Parameters

Job
Specifies a job to advance to the beginning of the print queue. To specify a job number, use a numeric expression; to specify the last job, select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LastJob! 0 Advance last job to beginning of queue
Interfere
Determines whether to interrupt the current print job to print the rush job. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FinishJob! 0 Allow current job to finish printing
FinishPage! 1 Interrupt current print job

Example

To advance the print job 2 to the top of the print queue and interrupt the job currently printing, the command is:

PrinterControlRush(2;FinishPage!)

PrinterControlRushImmediate

PrinterControlRushImmediate advances the last job in the print queue to the top of the list and interrupts the job currently printing. This command is the equivalent of choosing File, Print/Fax, Control Printer, highlighting a print job, Rush Job, Yes, then selecting to interrupt the current job.

Syntax

PrinterControlRushImmediate

Parameters

None.

PrinterControlStop

PrinterControlStop pauses the current print job. To resume printing, use PrinterControlGo. This command is the equivalent of choosing File, Print/Fax, Control Printer, Stop.

Syntax

PrinterControlStop

Parameters

None.

PrinterCopy

PrinterCopy copies information from one .PRS file to another. This command is the equivalent of choosing File, Print/Fax, Select, highlighting a .PRS filename, Copy, and entering a new printer filename.

Syntax

PrinterCopy(Name;Source;Target)

Parameters

Name
A character expression specifying the name of a printer to copy.
Source
A character expression specifying the full path of a .PRS file containing information to copy.
Target
A character expression specifying the full path of a .PRS file to receive copied information.

Example

To copy the HP LaserJet III .PRS file information to a .PRS file named OTHER.PRS, the command is:

PrinterCopy("HP LaserJet III";"C:\WP62\HP3.PRS";"C:\WP62\OTHER.PRS")

PrinterDelete

PrinterDelete removes a printer from the Select Printer dialog box. This command also optionally deletes the printer .PRS file from disk. This command is the equivalent of choosing File, Print/Fax, Select, highlighting a printer, Delete, and (optional) Delete .PRS file.

Syntax

PrinterDelete(Name;Filename;Delete PRS)

Parameters

Name
A character expression specifying a printer to delete.
Filename (optional)
A character expression specifying the full path of a printer .PRS file.
Delete PRS
Determines whether to delete a printer .PRS file from disk.
Enumerated Type Numeric Equivalent Description
DontDeletePRS! 0 Don't delete .PRS file from disk
DeletePRS! 1 Delete .PRS file from disk

Example

To delete a printer named HP LaserJet III and its .PRS file, the command is:

PrinterDelete("HP LaserJet III";"C:\WP62\HP3.PRS";DeletePRS!)

PrinterDescription

PrinterDescription changes a printer description. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Description, and editing the description.

Syntax

PrinterDescription(Description;Filename;New Description)

Parameters

Description
A character expression specifying a current printer description.
Filename (optional)
A character expression specifying the .PRS file of a printer.
New Description
A character expression specifying a new printer description.

Example

To rename the description of a printer currently described as "HP LaserJet III" to "Special Fonts," the command is:

PrinterDescription("HP LaserJet III";"HP3.PRS";"Special Fonts")

PrinterFont

PrinterFont changes the initial (default) font used with a printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Font Setup, Select Initial Font, and selecting options in the Initial Font dialog box.

Syntax

PrinterFont(Printer;Filename;New Font;Point Size;FontFamily;Attributes;Weight;Width;Source;Font Type;Character Set)

Parameters

Printer
A character expression specifying a printer.
Filename
A character expression specifying the name of a printer .PRS file.
New Font
A character expression specifying the initial font.
Point Size (optional)
A measurement expression specifying a font point size.
Font Family (optional)
Specifies the typeface family of a selected font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
FamilyITCBenguiat! 256
FamilyTimesRoman! 2304
FamilyITCGaramond! 4352
FamilyCenturySchoolbook! 6400
FamilyBodoni! 8448
FamilyITCLubalinGraph! 10496
FamilyAlbertus! 12544
FamilyCourier! 14592
FamilyHelvetica! 16640
FamilyITCRonda! 18688
FamilyMicrostyle! 20736
FamilyOptima! 22784
FamilyLetterGothic! 24832
FamilyBrush! 26880
FamilyParkAvenue! 28928
FamilySignetRoundhand! 30976
FamilyTekton! 33024
FamilyUncial! 35072
FamilyOldEnglish! 37120
FamilyITCZapfDingbats! 39168
FamilyBroadway! 41216
FamilyComputer! 43264
FamilyPTBarnum! 45312
FamilyPonderosa! 47360
FamilyMadrone! 49408
FamilyHobo! 51456
FamilyRevue! 53504
FamilyAestheticOrnamented! 55552
Attributes (optional)
Specifies one or more font attributes. If specifying two or more attributes, enclose them in French braces {}; separate attributes with semi-colons. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
FontMatchNormal! 0 Normal font
FontMatchItalic! 1 Italic font
FontMatchOutline! 2 Outline font
FontMatchShadow! 4 Shadow font
FontMatchSmallCaps! 8 Small Caps font
Weight (optional)
Specifies the weight or intensity of a font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WeightUnknown! 0
WeightUltraThin! 1
WeightUltraLight! 8
WeightExtraThin! 16
WeightThin! 24
WeightExtraLight! 32
WeightLight! 48
WeightDemiLight! 64
WeightSemiLight! 80
WeightBook! 88
WeightRegular! 96
WeightRoman! 104
WeightMedium! 112
WeightDemiBold! 128
WeightSemiBold! 136
WeightBold! 144
WeightExtraBold! 160
WeightHeavy! 176
WeightExtraHeavy! 192
WeightBlack! 208
WeightExtraBlack! 224
WeightUltraHeavy! 240
WeightUltraBlack! 248
WeightMaximum! 254
Width (optional)
Specifies the width of a font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
WidthUnknown! 0
WidthUltraCondensed! 16
WidthExtraCompressed! 32
WidthCompressed! 48
WidthExtraCondensed! 64
WidthCondensed! 80
WidthSemiCondensed! 96
WidthNormal! 112
WidthSemiExpanded! 128
WidthExpanded! 144
WidthExtraExpanded! 160
WidthUltraExpanded! 176
WidthDoubleWide! 192
WidthTripleWide! 224
Source (optional)
Specifies the source of the printer font. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
PRSFile! 16
DRSFile! 20
Font Type (optional)
Specifies the printer font type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Speedo! 134
Intellifont! 135
Type1! 138
TrueType! 139
Character Set (optional)
Specifies the printer font character set. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
FontMatchASCII! 0
FontMatchMultinational1! 1
FontMatchMultinational2! 2
FontMatchBoxDrawing! 3
FontMatchTypographicSymbols! 4
FontMatchIconicSymbols! 5
FontMatchMath! 6
FontMatchMathExtension! 7
FontMatchGreek! 8
FontMatchHebrew! 9
FontMatchCyrillic! 10
FontMatchJapaneseKana! 11
FontMatchUserDefined! 12
FontMatchArabic! 13
FontMatchArabicScript! 14

Example

To change the initial font of an HP LaserJet III to CG Times 12pt Bold, the command is:

PrinterFont("HP LaserJet III";"HP3.PRS";"CG Times Bold";12p;;FontMatchNormal!)

PrinterFontDirectory

PrinterFontDirectory specifies or changes a printer font path. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Directory for Soft Fonts, and entering a path.

Syntax

PrinterFontDirectory(Printer;Filename;New Path)

Parameters

Printer
A character expression specifying a printer.
Filename (optional)
A character expression specifying the .PRS file of a printer.
New Path
A character expression specifying a path where fonts are located.

Example

To change the path for fonts used with an HP LaserJet III to C:\COREL\WP62\FONTS, the command is:

PrinterFontDirectory("HP LaserJet III";"HP3.PRS";"C:\COREL\WP62\FONTS")

PrinterFunctionsDlg

PrinterFunctionsDlg displays the Printer Functions dialog box. This command is the equivalent of choosing Layout, Other, Printer Functions.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PrinterFunctionsDlg

Parameters

None.

PrinterInitialize

PrinterInitialize downloads soft fonts to a printer. This command is the equivalent of choosing File, Print/Fax, Initialize Printer.

Syntax

PrinterInitialize

Parameters

None.

PrinterOtherDirectory

PrinterOtherDirectory directs the macro to look in the specified directory for printer files. This command is the equivalent of choosing File, Print/Fax, Select, Add Printer, Other Directory, and specifying a directory containing printer files.

Syntax

PrinterOtherDirectory(Directory)

Parameters

Directory
A character expression specifying another directory in which to locate printer files.

Example

To specify another printer directory named Y:\NETWORK\PRINTERS, the command is:

PrinterOtherDirectory("Y:\NETWORK\PRINTERS")

PrinterPause

PrinterPause pauses the current print job. This command is the equivalent of choosing Layout, Other, Printer Functions, Printer Commands, Pause Printer.

Syntax

PrinterPause

Parameters

None.

PrinterPortCOM

PrinterPortCOM specifies information about a serial printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Port, selecting a COM port and choosing options.

Syntax

PrinterPortCOM(Name;.PRS Name;COM;Baud Rate;Parity;Stop Bits;Character Length;XONOFF;Status;Initialize;Network;Suppress)

Parameters

Name
A character expression specifying a printer name.
.PRS Name (optional)
A character expression specifying a .PRS filename.
COM
Specifies the COM port to which the printer is connected. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
COM1! 4 Port COM 1
COM2! 5 Port COM 2
COM3! 6 Port COM 3
COM4! 7 Port COM 4
Baud Rate
Specifies the baud rate. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Baud110! 0 Baud rate 110
Baud150! 1 Baud rate 150
Baud300! 2 Baud rate 300
Baud600! 3 Baud rate 600
Baud1200! 4 Baud rate 1200
Baud2400! 5 Baud rate 2400
Baud4800! 6 Baud rate 4800
Baud9600! 7 Baud rate 9600
Baud19200! 8 Baud rate 19200
Parity
Specifies the parity. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
ParityEven! 0
ParityOdd! 1
ParityNone! 2
Stop Bits
Specifies the stop bits. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
StopBit1! 0
StopBit2! 1
Character Length
Specifies the character length. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
CharacterLength7! 0
CharacterLength8! 1
XONOFF (optional)
Specifies whether the XON/XOFF option is active. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoXONOFF! 0 XON/OFF option disabled
XONOFF! 1 XON/OFF option active
Status (optional)
Specifies whether to activate Skip Status Check. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
SkipStatusCheckOff! 0
SkipStatusCheckOn! 1
Initialize (optional)
Specifies whether to initialize the serial port. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
InitializeSerialPortOff! 0
InitializeSerialPortOn! 1
Network (optional)
Specifies whether the printer is a network printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NonNetwork! 0 Not a network printer
NetworkPrinter! 1 Network printer
Suppress (optional)
If connected to a network printer, specifies whether the top of the form is suppressed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SuppressTopOfFormOff! 0 Do not suppress the top of form
SuppressTopOfFormOn! 1 Suppress the top of form

Example

To specify that the HP LaserJet III network printer is connected to port COM2, 2400 baud rate, no parity, two stop bits, character length of 8, and to suppress the top of the form, the command is:

PrinterPortCOM("HP Laserjet III"; "HP3.PRS"; COM2!; Baud2400!; ParityNone!; StopBit2!; CharacterLength8!;;;; NetworkPrinter!; SuppressTopOfFormOn!)

See Also

PrinterPortFilename

PrinterPortFilename prints a document to a file rather than to a printer. This command is the equivalent of choosing File, Print/Fax, Select, highlighting a printer, Edit, Port, Filename.

Syntax

PrinterPortFilename(Printer Name;.PRS Name;NewName;Prompt)

Parameters

Printer Name
A character expression specifying a printer name.
.PRS Name (optional)
A character expression specifying a .PRS filename.
NewName (optional)
A character expression specifying a new filename. This parameter should be left blank if using PromptForFilename! in the Prompt parameter.
Prompt (optional)
Specifies whether to prompt for a new filename. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NoPrompt! 0 Do not prompt
PromptForFilename! 1 Prompt

Example

To print to a new file each time, the command is:

PrinterPortFilename("ORIGINAL";"HP3.PRS";;PromptForFilename!)

PrinterPortHardware

PrinterPortHardware specifies the hardware setup for a printer. This command is the equivalent of choosing File, Print/Fax, Select, highlighting a printer, Edit, Port, Print to Hardware Port, Advanced Hardware Port.

Syntax

PrinterPortHardware(Name;.PRS Name;Type;IRQ;Address)

Parameters

Name
A character expression specifying a printer name.
.PRS Name (optional)
A character expression specifying a .PRS filename.
Type
Specifies a hardware type. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
HardwareOff! 1
HardwareOn! 2
HardwareAdvance! 4
IRQ (optional)
Specifies a printer IRQ address. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
IRQ2! 4 IRQ number 2
IRQ3! 8 IRQ number 3
IRQ4! 16 IRQ number 4
IRQ5! 32 IRQ number 5
IRQ6! 64 IRQ number 6
IRQ7! 128 IRQ number 7
Address (optional)
A numeric expression specifying a printer's base memory address.

Example

To indicate the HP III printer hardware port is located in IRQ4 at the address B800:000, the command is:

PrinterPortHardware("HP Laser Jet III";"HP3.PRS";HardwareAdvance!;IRQ4;B800:0000)

PrinterPortLPT

PrinterPortLPT specifies information about a parallel printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Port, and selecting an LPT port.

Syntax

PrinterPortLPT(Name;.PRS Name;LPT;Status;Network;Suppress)

Parameters

Name
A character expression specifying a filename.
.PRS Name (optional)
A character expression specifying a .PRS filename.
LPT
Specifies the LPT port to which the printer is connected. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
LPT1! 0 Port LPT 1
LPT2! 1 Port LPT 2
LPT3! 2 Port LPT 3
Status (optional)
Specifies whether to activate Skip Status Check. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
SkipStatusCheckOn! 0
SkipStatusCheckOff! 1
Network (optional)
Specifies whether the printer is a network printer. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
NonNetwork! 0 Not a network printer
NetworkPrinter! 1 Network printer
Suppress (optional)
If connected to a network printer, specifies whether the top of the form is suppressed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SuppressTopOfFormOff! 0 Do not suppress the top of form
SuppressTopOfFormOn! 1 Suppress the top of form

Example

To specify the HP LaserJet III network printer is connected to port LPT1 and suppresses the top of the form, the command is:

PrinterPortLPT("HP Laserjet III";"HP3.PRS";LPT1!;;NetworkPrinter!;SuppressTopOfFormOn!)

PrinterPortNetworkQueue

PrinterPortNetworkQueue specifies information about the network printer and its queue. This command is the equivalent of choosing File, Print/Fax, Select, highlighting a printer, Edit, Network Port, Server/Queue Name, typing a name, then either selecting or deselecting Suppress Top of Form.

Syntax

PrinterPortNetworkQueue(Name;.PRS Name;NetQueue;Suppress)

Parameters

Name
A character expression specifying a filename.
.PRS Name (optional)
A character expression specifying a .PRS filename.
NetQueue
A character expression specifying the name of a network queue.
Suppress (optional)
If connected to a network printer, specifies whether the top of the form is suppressed. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
SuppressTopOfFormOff! 0 Do not suppress the top of form
SuppressTopOfFormOn! 1 Suppress the top of form

Example

To specify the printer as a HP Laserjet III on the network queue WPSUPRT2 and suppress the top of form, the command is:

PrinterPortNetworkQueue("HP Laserjet III";"HP3.PRS";"WPSUPRT2";SuppressTopOfFormOn!)

PrinterSelect

PrinterSelect selects a printer. The printer selected remains the default until another printer is selected. This command is the equivalent of choosing File, Print/Fax, Select, and selecting a printer.

Syntax

PrinterSelect(Printer;Filename)

Parameters

Printer
A character expression specifying a printer name.
Filename (optional)
A character expression specifying a .PRS file.

Example

To select an HP LaserJet 4, the command is:

PrinterSelect("HP LaserJet 4";"HP4.PRS")

PrinterSelectPrs

PrinterSelectPrs selects a printer based on its .PRS filename. This command is the equivalent of choosing File, Print/Fax, Select, List *.PRS, highlight a .PRS file, Select.

Syntax

PrinterSelectPrs(Filename)

Parameters

Filename
A character expression specifying a .PRS file.

Example

To select a .PRS file named FONTS.PRS, the command is:

PrinterSelectPrs("FONTS.PRS")

PrinterSheetFeeder

PrinterSheetFeeder specifies a sheet feeder for a printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Sheet Feeder, and selecting a sheet feeder.

Syntax

PrinterSheetFeeder(Printer;Filename;Sheet Feeder)

Parameters

Printer
A character expression specifying a printer name.
Filename (optional)
A character expression specifying the name of a printer .PRS file.
Sheet Feeder
A character expression specifying a sheet feeder. To specify no sheet feeder, leave this parameter blank.

Example

To specify an HP LaserJet 4 sheet feeder for an HP LaserJet 4 printer, the command is:

PrinterSheetFeeder("HP LaserJet 4";"HP4.PRS";"HP LaserJet 4 (SF)")

PrinterUpdate

PrinterUpdate updates a .PRS file with changes made to the corresponding .ALL file. This command is the equivalent of choosing File, Print/Fax, Select, Update.

Syntax

PrinterUpdate(Printer;Filename)

Parameters

Printer
A character expression specifying a printer name.
Filename (optional)
A character expression specifying the .PRS file of a printer.

Example

To update the HP LaserJet III, the command is:

PrinterUpdate("HP LaserJet III";"HP3.PRS")

PrinterVectorConfigured

PrintVectorConfigured determines whether to print graphics in a document using vectors. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Use HP-GL/2 Vector Graphics.

Syntax

PrinterVectorConfigured(Printer;Filename;State)

Parameters

Printer
A character expression specifying a printer name.
Filename
A character expression specifying the .PRS file of a printer.
State
Determines whether to print a document using vector graphics. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
VectorOff! 0 Do not print using vector graphics
VectorOn! 1 Print using vector graphics

Example

To specify that documents be sent to an HP LaserJet 4 printer using vector graphics, the command is:

PrinterVectorConfigured("HP LaserJet 4";"HP4.PRS";On!)

PrintFullDoc

PrintFullDoc prints the current document. This command is the equivalent of choosing File, Print/Fax, Full Document, Print.

Syntax

PrintFullDoc

Parameters

None.

PrintGraphicsJob

PrintGraphicsJob determines whether to print a document graphically. This command is the equivalent of choosing File, Print/Fax, and selecting Print Job Graphically.

Syntax

PrintGraphicsJob(State)

Parameters

State
Determines whether to print a document graphically. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Do not print graphically
On! 1 Print graphically

Example

To print a document graphically, the command is:

PrintGraphicsJob(On!)

PrintGraphicsQuality

PrintGraphicsQuality specifies graphics print quality for the current document. This command is the equivalent of choosing File, Print/Fax, Graphics Quality, and selecting an option.

Syntax

PrintGraphicsQuality(Resolution)

Parameters

Resolution
Specifies the resolution with which to print graphics. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DoNotPrint! 0
Draft! 1
Medium! 2
High! 3

Example

To print graphics with high resolution, the command is:

PrintGraphicsQuality(High!)

See Also

PrintGraphicsQualitySetup

PrintGraphicsQualitySetup changes the default resolution of printing graphics. This command is the equivalent of choosing File, Print/Fax, Setup, Graphics Quality, and selecting an option.

Syntax

PrintGraphicsQualitySetup(Resolution)

Parameters

Resolution
Specifies print quality. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DoNotPrint! 0
Draft! 1
Medium! 2
High! 3

Example

To change the default resolution of printing graphics to high resolution, the command is:

PrintGraphicsQualitySetup(High!)

See Also

PrintInkColor

PrintInkColor specifies how to print color in the current document. This command is the equivalent of choosing File, Print/Fax, Print Color, and selecting an option.

Syntax

PrintInkColor(Color)

Parameters

Color
Specifies how color printing is handled. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Black! 0
FullColor! 1
SolidColor! 2

Example

To print a document with solid color, the command is:

PrintInkColor(SolidColor!)

See Also

PrintInkColorSetup

PrintInkColorSetup specifies the default method for printing color. This command is the equivalent of choosing File, Print/Fax, Setup, Print Color, and selecting an option.

Syntax

PrintInkColorSetup(Color)

Parameters

Color
Specifies the default method of color printing. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Black! 0
FullColor! 1
SolidColor! 2

Example

To specify Solid Color as the default method for printing color, the command is:

PrintInkColorSetup(SolidColor!)

See Also

PrintMultiplePages

PrintMultiplePages prints specified pages. This command is the equivalent of choosing File, Print/Fax, Multiple Pages, and selecting options in the Print Multiple Pages dialog box.

Syntax

PrintMultiplePages(Page Range;Secondary Page Range;Chapter Range;Volume Range; Odd/Even Pages;DocSummary;Pamphlet;Order)

Parameters

Page Range (optional)
A character expression specifying a range of pages to print.
Secondary Page Range (optional)
A character expression specifying a secondary range of pages to print.
Chapter Range (optional)
A character expression specifying a range of chapters to print.
Volume Range (optional)
A character expression specifying a range of volumes to print.
Odd/Even Pages (optional)
Determines whether to print all, odd, or even pages. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
PrintAll! 0
PrintOdd! 2
PrintEven! 4
DocSummary (optional)
Determines whether to print a document summary. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
NoDocSummary! 0
DocSummary! 1
Pamphlet (optional)
Indicates whether to print a document as a booklet, with logical pages numbered and printed in correct sequence. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
NoBooklet! 0
Booklet! 1
Order (optional)
Determines whether to print pages in ascending or descending order. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
Forward! 0
Backward! 1

Example

To print all pages of the current document, including the document summary, the command is:

PrintMultiplePages("(all)";;;;PrintAll!;DocSummary!;NoBooklet!;Forward!)

PrintNetworkBanner

PrintNetworkBanner determines whether to print a banner (lead page) identifying the user with the current document. This command is the equivalent of choosing File, Print/Fax, Network Options, and selecting (or deselecting) Banner.

Syntax

PrintNetworkBanner(State)

Parameters

State
Determines whether to print a banner with a print job. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
No! 0
Yes! 1

Example

To print a banner with a print job, the command is:

PrintNetworkBanner(Yes!)

PrintNetworkBannerSetup

PrintNetworkBannerSetup changes the default of whether to print a banner (lead page) which identifies the user sending the job. This command is the equivalent of choosing File, Print/Fax, Setup, and selecting (or deselecting) Banners.

Syntax

PrintNetworkBannerSetup(State)

Parameters

State
Determines whether to print a banner with a print job. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
No! 0
Yes! 1

Example

To print a banner with all network print jobs, the command is:

PrintNetworkBannerSetup(Yes!)

PrintNetworkForm

PrintNetworkForm specifies a form number. The form number refers to a Novell® NetWare® setting for which you must consult NetWare documentation for more specific information. This command is the equivalent of choosing File, Print/Fax, Network Options, entering a form number.

Syntax

PrintNetworkForm(Number)

Parameters

Number
A numeric expression specifying a form number.

Example

To specify form 0, the command is:

PrintNetworkForm(0)

PrintNetworkFormSetup

PrintNetworkFormSetup specifies a default form number. The form number refers to a NetWare setting. Consult NetWare documentation for more specific information. This command is the equivalent of choosing File, Print/Fax, Setup, and entering a form number.

Syntax

PrintNetworkFormSetup(Number)

Parameters

Number
A numeric expression specifying a form number.

Example

To specify form 0, the command is:

PrintNetworkFormSetup(0)

PrintPage

PrintPage prints the current page. This command is the equivalent of choosing File, Print/Fax, Page, Print.

Syntax

PrintPage

Parameters

None.

PrintPCL4PointSize

PrintPCL4PointSize determines the minimum point size at which graphics fonts are sent to a printer as soft fonts. This command is the equivalent of choosing File, Print/Fax, Setup, Threshold Point Size, and specifying a point size.

Syntax

PrintPCL4PointSize(Point Size)

Parameters

Point Size
A numeric expression specifying the point size at which Corel WordPerfect 6.2 graphics fonts will be sent to an HP LaserJet printer as soft fonts. The default size is 24pt.

Example

To specify that graphics fonts 30 points or larger in size be sent to the printer as soft fonts, the command is:

PrintPCL4PointSize(30)

PrintPreview

PrintPreview displays the current document in a WYSIWYG graphical format. This command is the equivalent of choosing File, Print Preview.

Syntax

PrintPreview

Parameters

None.

PrintPreviewButtonBar

PrintPreviewButtonBar acts as a toggle in Print Preview to display or hide the Button Bar. This command has no effect unless the program is in Print Preview. This command is the equivalent of choosing View, Button Bar while in Print Preview.

Syntax

PrintPreviewButtonBar

Parameters

None.

PrintPreviewButtonBarEdit

PrintPreviewButtonBarEdit displays the Edit Button Bar dialog box in Print Preview. This command is the equivalent of choosing View, Button Bar Setup, and Edit while in Print Preview.

Syntax

PrintPreviewButtonBarEdit

Parameters

None.

PrintPreviewButtonBarOptions

PrintPreviewButtonBarOptions displays the Button Bar Options dialog box in Print Preview. This command is the equivalent of choosing View, Button Bar Setup, and Options while in Print Preview.

Syntax

PrintPreviewButtonBarOptions

Parameters

None.

PrintPreviewCancel

PrintPreviewCancel cancels changes made to Print Preview. This command is the equivalent of pressing Escape (Esc) while in Print Preview.

Syntax

PrintPreviewCancel

Parameters

None.

PrintPreviewDownArrow

PrintPreviewDownArrow scrolls down the Print Preview window, bringing into view portions of the document not initially visible. This command is the equivalent of pressing Down Arrow while in Print Preview.

Syntax

PrintPreviewDownArrow

Parameters

None.

See Also

PrintPreviewEnd

PrintPreviewEnd displays the right half of a page in Print Preview if Zoom is set at 200%. While in Print Preview, this command is the equivalent of pressing End.

Syntax

PrintPreviewEnd

Parameters

None.

PrintPreviewExit

PrintPreviewExit exits Print Preview and returns to a document window. This command is the equivalent of choosing File, Close while in Print Preview.

Syntax

PrintPreviewExit

Parameters

None.

See Also

PrintPreviewFacingPages

PrintPreviewFacingPages displays two consecutive pages side by side in Print Preview, with even-numbered pages on the left and odd-numbered pages on the right. This command is the equivalent of choosing View, Facing Pages while in Print Preview.

Syntax

PrintPreviewFacingPages

Parameters

None.

See Also

PrintPreviewFileMenu

PrintPreviewFileMenu displays the File pull-down menu while in Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of choosing File while in Print Preview.

Syntax

PrintPreviewFileMenu

Parameters

None.

See Also

PrintPreviewFullPage

PrintPreviewFullPage displays a full document page in Print Preview. This command is the equivalent of choosing View, Full Page while in Print Preview.

Syntax

PrintPreviewFullPage

Parameters

None.

See Also

PrintPreviewGoToPage

PrintPreviewGoToPage displays the Go To Page dialog box in Print Preview. This command is the equivalent of choosing Pages, Go To Page while in Print Preview.

Syntax

PrintPreviewGoToPage

Parameters

None.

See Also

PrintPreviewHelpMenu

PrintPreviewHelpMenu displays the Help pull-down menu while in Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of choosing File while in Print Preview.

Syntax

PrintPreviewHelpMenu

Parameters

None.

See Also

PrintPreviewHome

PrintPreviewHome is used in conjunction with other commands, such as PrintPreviewDownArrow and PrintPreviewLeftArrow, to view a document one screen at a time. This command is the equivalent of pressing Home while in Print Preview.

Syntax

PrintPreviewHome

Parameters

None.

See Also

PrintPreviewInvert

PrintPreviewInvert inverts the display of Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of choosing File, Print/Fax, Fax Services, View, View, Invert.

Syntax

PrintPreviewInvert

Parameters

None.

See Also

PrintPreviewLeftArrow

PrintPreviewLeftArrow scrolls left across a Print Preview window, bringing into view portions of the document not initially visible. The program must be in Print Preview for this command to have any effect. This command is the equivalent of pressing Left Arrow while in Print Preview.

Syntax

PrintPreviewLeftArrow

Parameters

None.

See Also

PrintPreviewMenu

PrintPreviewMenu displays the menu while in Print Preview. The program must be in Print Preview for this command to have any effect.

Syntax

PrintPreviewMenu

Parameters

None.

See Also

PrintPreviewNextPage

PrintPreviewNextPage displays the next page or pair of facing pages in the view window. This command is the equivalent of choosing Pages, Next Page while in Print Preview.

Syntax

PrintPreviewNextPage

Parameters

None.

See Also

PrintPreviewPageDown

PrintPreviewPageDown displays the next page in Print Preview. This command is the equivalent of pressing Page Down while in Print Preview.

Syntax

PrintPreviewPageDown

Parameters

None.

See Also

PrintPreviewPagesMenu

PrintPreviewPagesMenu displays the Pages pull-down menu while in Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of choosing Pages while in Print Preview.

Syntax

PrintPreviewPagesMenu

Parameters

None.

See Also

PrintPreviewPageUp

PrintPreviewPageUp displays the previous page in Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of pressing Page Up while in Print Preview.

Syntax

PrintPreviewPageUp

Parameters

None.

See Also

PrintPreviewPreviousPage

PrintPreviewPreviousPage displays the previous page or previous pair of facing pages in Print Preview. This command is the equivalent of choosing Pages, Previous Page while in Print Preview.

Syntax

PrintPreviewPreviousPage

Parameters

None.

See Also

PrintPreviewReferencePage

PrintPreviewReferencePage displays a small page representation where an area may be selected to magnify in Print Preview. This command is the equivalent of choosing View, Select Area while in Print Preview.

Syntax

PrintPreviewReferencePage

Parameters

None.

See Also

PrintPreviewRightArrow

PrintPreviewRightArrow scrolls right across a Print Preview window, bringing into view portions of the document not initially visible. This command is the equivalent of pressing Right Arrow while in Print Preview.

Syntax

PrintPreviewRightArrow

Parameters

None.

See Also

PrintPreviewScreenDown

PrintPreviewScreenDown scrolls down a document one screen at a time in Print Preview. This command is the equivalent of pressing the plus key (+) on the numeric keypad (with Num Lock off) while in Print Preview.

Syntax

PrintPreviewScreenDown

Parameters

None.

See Also

PrintPreviewScreenUp

PrintPreviewScreenUp scrolls up a document one screen at a time in Print Preview. This command is the equivalent of pressing the minus key (-) on the numeric keypad (with Num Lock off) while in Print Preview.

Syntax

PrintPreviewScreenUp

Parameters

None.

See Also

PrintPreviewSetup

PrintPreviewSetup displays the Print Preview Options dialog box. This command is the equivalent of choosing File, Setup while in Print Preview.

Syntax

PrintPreviewSetup

Parameters

None.

See Also

PrintPreviewThumbnails1

PrintPreviewThumbnails1 displays a small page representation in the left half of the Print Preview window. The program must be in Print Preview for this command to work. This command is the equivalent of choosing View, Thumbnails, 1 Page while in Print Preview.

Syntax

PrintPreviewThumbnails1

Parameters

None.

See Also

PrintPreviewThumbnails2

PrintPreviewThumbnails2 displays two small representations in the Print Preview window. This command is the equivalent of choosing View, Thumbnails, 2 Page while in Print Preview.

Syntax

PrintPreviewThumbnails2

Parameters

None.

See Also

PrintPreviewThumbnails32

PrintPreviewThumbnails32 displays 32 small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 32 Page while in Print Preview.

Syntax

PrintPreviewThumbnails32

Parameters

None.

See Also

PrintPreviewThumbnails4

PrintPreviewThumbnails4 displays four small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 4 Page while in Print Preview.

Syntax

PrintPreviewThumbnails4

Parameters

None.

See Also

PrintPreviewThumbnails8

PrintPreviewThumbnails8 displays eight small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 8 Page while in Print Preview.

Syntax

PrintPreviewThumbnails8

Parameters

None.

See Also

PrintPreviewThumbnailsOther

PrintPreviewThumbnailsOther displays the Thumbnails Other dialog box in Print Preview. This command is the equivalent of choosing View, Thumbnails, Other while in Print Preview.

Syntax

PrintPreviewThumbnailsOther

Parameters

None.

See Also

PrintPreviewUpArrow

PrintPreviewUpArrow scrolls up a Print Preview window, bringing into view portions of a document not initially visible. This command is the equivalent of pressing Up Arrow while in Print Preview.

Syntax

PrintPreviewUpArrow

Parameters

None.

See Also

PrintPreviewViewMenu

PrintPreviewViewMenu displays the View pull-down menu while in Print Preview. The program must be in Print Preview for this command to have any effect. This command is the equivalent of choosing View while in Print Preview.

Syntax

PrintPreviewViewMenu

Parameters

None.

See Also

PrintPreviewZoom100

PrintPreviewZoom100 displays a document at its printed size in Print Preview. This command is the equivalent of choosing View, 100% View while in Print Preview.

Syntax

PrintPreviewZoom100

Parameters

None.

See Also

PrintPreviewZoom200

PrintPreviewZoom200 displays a document at twice its printed size in Print Preview. This command is the equivalent of choosing View, 200% View while in Print Preview.

Syntax

PrintPreviewZoom200

Parameters

None.

See Also

PrintPreviewZoomArea

PrintPreviewZoomArea converts a pointer to a magnifying glass, enabling the user to zoom an area in Print Preview. This command is the equivalent of choosing View, Zoom Area while in Print Preview.

Syntax

PrintPreviewZoomArea

Parameters

None.

See Also

PrintPreviewZoomIn

PrintPreviewZoomIn increases the display size of a document by 25% in Print Preview. This command is the equivalent of choosing View, Zoom In while in Print Preview.

Syntax

PrintPreviewZoomIn

Parameters

None.

See Also

PrintPreviewZoomOut

PrintPreviewZoomOut decreases the display size of a document by 25% in Print Preview. This command is the equivalent of choosing View, Zoom Out while in Print Preview.

Syntax

PrintPreviewZoomOut

Parameters

None.

See Also

PrintPreviewZoomReset

PrintPreviewZoomReset resets Print Preview to the Zoom option that was selected when Print Preview was entered. This command is the equivalent of choosing File, Print Preview, View, Reset.

Syntax

PrintPreviewZoomReset

Parameters

None.

PrintSelection

PrintSelection prints blocked text. This command is the equivalent of choosing File, Print/Fax, Blocked Text, Print while text is blocked. This command is not recordable. To use this command, you must type it into the macro.

Syntax

PrintSelection

Parameters

None.

PrintSetupDlg

PrintSetupDlg displays the Print Setup dialog box. This command is the equivalent of choosing File, Print/Fax, Print Setup.

For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.

Syntax

PrintSetupDlg

Parameters

None.

PrintTextQuality

PrintTextQuality specifies print quality for current document text. This command is the equivalent of choosing File, Print/Fax, Text Quality, and selecting an option.

Syntax

PrintTextQuality(Resolution)

Parameters

Resolution
Specifies resolution of printed text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DoNotPrint! 0
Draft! 1
Medium! 2
High! 3

Example

To print the current document text with high resolution, the command is:

PrintTextQuality(High!)

See Also

PrintTextQualitySetup

PrintTextQualitySetup changes the default resolution of printing text. This command is the equivalent of choosing File, Print/Fax, Setup, Text Quality, and selecting an option.

Syntax

PrintTextQualitySetup(Resolution)

Parameters

Resolution
Specifies resolution for printed text. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent
DoNotPrint! 0
Draft! 1
Medium! 2
High! 3

Example

To change the default resolution of printing text to high resolution, the command is:

PrintTextQualitySetup(High!)

See Also

PullDownDlg

PullDownDlg displays the pull down menus. This command is not recordable. To use this command, you must type it into the macro. This command is the equivalent of pressing Alt+=.

Syntax

PullDownDlg

Parameters

None.

QuickCorrect

QuickCorrect™ specifies whether the QuickCorrect feature is on or off. This command is equivalent to choosing Tools, Writing Tools, QuickCorrect, and clicking Replace words as you type.

Syntax

QuickCorrect(State)

Parameters

State
Specifies whether QuickCorrect is off or on. Select an enumerated type or its numeric equivalent.
Enumerated Type Numeric Equivalent Description
Off! 0 Turn off QuickCorrect
On! 1 Turn on QuickCorrect

Example

To turn on QuickCorrect, the command is:

QuickCorrect(On!)

See Also

QuickCorrectAddItem

QuickCorrectAddItem adds a QuickCorrect entry. This command is equivalent to choosing Tools, Writing Tools, QuickCorrect, Add Entry, specifying the word to replace, then specifying its replacement.

Syntax

QuickCorrectAddItem(Word;Replacement)

Parameters

Word
A character expression specifying the word to replace.
Replacement
A character expression specifying the replacement text.

Example

To add a QuickCorrect entry that replaces towne with town, the command is:

QuickCorrectAddItem("towne";"town")

See Also

QuickCorrectDeleteItem

QuickCorrectDeleteItem deletes a QuickCorrect entry. This command is equivalent of choosing Tools, Writing Tools, QuickCorrect, Delete Entry, highlighting the entry to delete, Yes.

Syntax

QuickCorrectDeleteItem(Item)

Parameters

Item
A character expression specifying the QuickCorrect entry to delete.

Example

To delete the QuickCorrect entry that replaces towne with town,