╔═════╦═════════════════════════════╦═════╗ ║ ╔═╦═╝ Corel Corporation Limited ╚═╦═╗ ║ ╠═╬═╝ ╚═╬═╣ ╠═╬═╗ Corel WP 6.2 Product Macros ╔═╬═╣ ║ ╚═╩═╗ 01/01/97 ╔═╩═╝ ║ ╚═════╩═════════════════════════════╩═════╝
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.
This manual is divided into three sections. A brief description of each section follows.
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.
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.
The glossary defines terms specific to macros. If you encounter a term that is unfamiliar to you, refer to the glossary for a definition.
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.
Unless otherwise noted, mouse actions refer to the left button. Most instructions in this manual refer to the mouse.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
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.
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
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!)
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.
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.
Corel WordPerfect 6.2 includes an online macros manual. To access the manual, choose Macros from the Help menu.
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.
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")
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.
Advance(Type;Amount)
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 |
Example
To print text 3.5" to the right of the current cursor position, the command is:
Advance(AdvanceRight!;3.5")
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.
AdvanceDlg
None.
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.
AFCEditBegin
None.
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.
AFCEditEnd(State;Driver)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Do not save changes |
Save! | 1 | Save changes |
Enumerated Type | Numeric Equivalent | Description |
PRSAFC | 0 | Printer driver |
DRSAFC | 1 | Graphics driver |
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!)
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.
AFCEditFont(Font;Attribute;AFC)
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 |
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!)
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.
AltEqual
None.
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.
AltHome
None.
AltKeySelectsMenuBar determines whether the Alt key selects the menu bar. This command is the equivalent of choosing View, Screen Setup, Alt key.
AltKeySelectsMenuBar(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Does not select menu bar |
Yes! | 1 | Selects menu bar |
To specify the Alt key to select the menu bar, the command is:
AltKeySelectsMenuBar(Yes!)
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.
AppendFilenameDlg
None.
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.
AppendToFile(Filename)
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")
AttributeAppearanceOff turns off specified font attribute(s) where this command is encountered. This command is the equivalent of choosing Font, Font, and deselecting attributes.
AttributeAppearanceOff(Attribute)
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 |
To turn off the attributes Shadow, Underline, and Small Caps, the command is:
AttributeAppearanceOff(Shadow!;Underline!;SmallCaps!)
AttributeAppearanceOn turns on the specified font attributes where this command is encountered. This command is the equivalent of choosing Font, Font, and selecting attributes.
AttributeAppearanceOn(Attribute)
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 |
To turn on Shadow, Bold, and Small Caps, the command is:
AttributeAppearanceOn(Shadow!;Bold!;SmallCaps!)
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.
AttributeAppearanceToggle(Attribute)
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 |
To toggle Italics and Redline, the command is:
AttributeAppearanceToggle(Italics!;Redline!)
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.
AttributeNormal
None.
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.
AttributePosition(Position)
Enumerated Type | Numeric Equivalent | Description |
Superscript! | 5 | Superscript position |
Subscript! | 6 | Subscript position |
NormalPosition! | 7 | Normal position |
To set the position of subsequent or blocked text as superscript, the command is:
AttributePosition(Superscript!)
AttributePositionToggle toggles the specified text position. This command is not recordable. To use this command, you must type it into the macro.
AttributePositionToggle(Position)
Enumerated Type | Numeric Equivalent | Description |
Superscript! | 5 | Toggles Superscript position |
Subscript! | 6 | Toggles Subscript position |
NormalPosition! | 7 | Toggles Normal position |
To toggle a subscript position, the command is:
AttributePositionToggle(Subscript!)
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.
AttributeRelativeSize(Size)
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 |
To select a font size of Large, the command is:
AttributeRelativeSize(Large!)
AttributeRelativeSizeToggle toggles the specified relative font size. This command is not recordable. To use this command, you must type it into the macro.
AttributeRelativeSizeToggle(Size)
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 |
To toggle the size of Fine, the command is:
AttributeRelativeSizeToggle(Fine!)
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.
AttributeSizeRatios(Size;Ratio)
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 |
To specify a ratio of 130 for the attribute Large, the command is:
AttributeSizeRatios(Large!;130)
AutoCodePlacement determines whether Auto Code Placement is on or off. This command is the equivalent of choosing File, Setup, Environment, Auto Code Placement.
AutoCodePlacement(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Auto Code Placement is off |
On! | 1 | Auto Code Placement is on |
To turn off Auto Code Placement, the command is:
AutoCodePlacement(Off!)
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.
BackTab
None.
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.
Backup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Backup is off |
On! | 1 | Backup is on |
To turn off Backup, the command is:
Backup(Off!)
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.
BackupDlg
None.
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.
BackupMinutes(Minutes)
To set a timed backup interval of fifteen minutes, the command is:
BackupMinutes(15)
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.
BackupOriginalDoc(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Original Document Backup off |
Yes! | 1 | Original Document Backup on |
To turn on Original Document Backup, the command is:
BackupOriginalDoc(On!)
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.
BarcodeDlg
None.
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.
BarcodePOSTNET(ZIP Code;Merge Field)
Enumerated Type | Numeric Equivalent | Description |
MergeFieldAllowed! | 1 | Merge field provides ZIP Code |
To enter a ZIP Code contained in a merge field named Zip, the command is:
BarcodePOSTNET("Zip";MergeFieldAllowed!)
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.
BaselinePlacement(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Baseline Placement is off |
On! | 1 | Baseline Placement is on |
To turn on Baseline Placement, the command is:
BaselinePlacement(On!)
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.
BaselinePlacementSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Baseline Placement is off |
On! | 1 | Baseline Placement is on |
To turn on the Baseline Placement option for all documents, the command is:
BaselinePlacementSetup(On!)
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.
BeepOnError(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No beep when an error occurs |
Yes! | 1 | Beep sounds when an error occurs |
To sound a beep when an error occurs, the command is:
BeepOnError(Yes!)
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.
BeepOnHyphenation(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No beep on hyphenation |
Yes! | 1 | Beep sounds on hyphenation |
To turn off the hyphenation beep, the command is:
BeepOnHyphenation(No!)
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.
BeepOnSearchFailure(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No beep when a search fails |
Yes! | 1 | Beep when a search fails |
To sound a beep when a search fails, the command is:
BeepOnSearchFailure(Yes!)
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.
BeepOptionsDlg
None.
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.
Binding(Edge;Offset)
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 |
To set a binding offset of .75" at the top of a document, the command is:
Binding(TopEdge!;.75")
BlockDelete deletes blocked text. This command is the equivalent of pressing Ctrl+F4 and choosing Delete from the Move Block dialog box.
BlockDelete
None.
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.
BlockKey
None.
BlockOff turns off Block. When Block is on, this command is the equivalent of choosing Edit, Block.
BlockOff
None.
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).
BlockOn(Mode)
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 |
To block an entire page, the command is:
BlockOn(PageMode!)
BlockProtect turns Block Protect on or off. This command is the equivalent of choosing Layout, Other, Block Protect.
BlockProtect(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Block Protect off |
On! | 1 | Block Protect on |
To turn on Block Protect, the command is:
BlockProtect(On!)
BlockRectangle blocks a rectangular section of text. When Block is on, this command is the equivalent of choosing Edit, Select, Rectangle.
BlockRectangle
None.
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.
BlockSave(Filename)
To name and save blocked text with the filename BLOCK.DOC, the command is:
BlockSave("BLOCK.DOC")
BlockTabularColumn blocks a tabular column. With Block on, this command is the equivalent of choosing Edit, Select, Tabular Column.
BlockTabularColumn
None.
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.
BoldKey
None.
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.
BookmarkBlock(Name)
To find a bookmark named Block This and to block the corresponding text, the command is:
BookmarkBlock("Block This")
BookmarkCreate creates a Bookmark. This command is the equivalent of pressing Alt+F5, Bookmark, Create, and entering a name.
BookmarkCreate(Name)
To create a Bookmark named Find Me, the command is:
BookmarkCreate("Find Me")
BookmarkDelete deletes a bookmark. This command is the equivalent of displaying the Mark dialog box by pressing Alt+F5, Bookmark, selecting a bookmark, Delete.
BookmarkDelete(Name)
To delete a bookmark named Last Page, the command is:
BookmarkDelete("Last Page")
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.
BookmarkDlg
None.
BookmarkFind moves the cursor to a specified bookmark. This command is the equivalent of pressing Alt+F5, Bookmark, selecting a bookmark, Find.
BookmarkFind(Name)
To find a bookmark named Entry, the command is:
BookmarkFind("Entry")
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.
BookmarkMove(Name)
To move a bookmark named Read This, the command is:
BookmarkMove("Read This")
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.
BookmarkRename(Current Name;New Name)
To rename a bookmark named Edit as Copy, the command is:
BookmarkRename("Edit";"Copy")
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.
BorderBottomLine(Type)
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 |
To create a paragraph border with a double bottom border line, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderBottomLine(DoubleLine!)
TextBorderEnd(Save!)
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.
BorderColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)
To create a Magenta paragraph border, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderUseBorderColor(Yes!)
BorderColor("Magenta";255;0;255;100)
TextBorderEnd(Save!)
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.
BorderCornerRadius(Radius)
To create a paragraph border with very rounded corners, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderCornerRadius(.5")
TextBorderEnd(Save!)
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.
BorderDropShadow(Location;Size;Color Name;Red Value;Green Value;Blue Value;Shading Value)
Enumerated Type | Numeric Equivalent | Description |
NoShadow! | 0 | None |
UpperLeft! | 1 | Upper left |
LowerLeft! | 2 | Lower left |
LowerRight! | 3 | Lower right |
UpperRight! | 4 | Upper right |
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!)
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.
BorderFillColor(Foreground Color Name;Red Value;Green Value;Blue Value;Shading Value;Background Color Name;Red Value;Green Value;Blue Value;Shading Value)
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.
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!)
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.
BorderInsideSpacing(Left;Right;Top;Bottom)
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!)
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.
BorderLeftLine(Type)
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 |
To create a thick left paragraph border line, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderLeftLine(ThickLine!)
TextBorderEnd(Save!)
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.
BorderOutsideSpacing(Left;Right;Top;Bottom)
To create outside spacing of .2" on all sides of a border, the command is:
BorderOutsideSpacing(.2";.2";.2";.2")
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.
BorderRightLine(Type)
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 |
To create a Paragraph border with a dashed right line, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderRightLine(DashedLine!)
TextBorderEnd(Save!)
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.
BorderSeparatorLine(Type)
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 |
To create a double-line separator in a paragraph border, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderSeparatorLine(DoubleLine!)
TextBorderEnd(Save!)
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.
BorderSetSpacing(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Automatic Spacing selected |
Yes! | 1 | Automatic Spacing not selected |
To specify that Automatic Spacing is selected, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderSetSpacing(No!)
TextBorderEnd(Save!)
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.
BorderStyleCopy(Style Name;Current Location;Destination;New Name)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To copy a style named MyStyle from the personal style library to the shared style library, the command is:
BorderStyleCopy("MyStyle";PersonalLibrary!;SharedLibrary!)
BorderStyleCreate names a new border style. This command is the equivalent of choosing Graphics, Borders, Styles, Create, and naming a style.
BorderStyleCreate(Style Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To give a paragraph border style the name Highlight, the command sequence is:
BorderStyleCreate("Highlight")
TextBorderEnd(Save!)
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.
BorderStyleDelete(Style Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To delete a paragraph border style named Example in the current document, the command sequence is:
BorderStyleDelete("Example";CurrentDoc!)
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.
BorderStyleDlg
None.
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.
BorderStyleEdit(Style Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To edit the Thin Thick Border line style, the command is:
BorderStyleEdit(ThinThickBorder!)
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.
BorderStyleEditDlg
None.
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.
BorderStyleEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To save the changes made to a border style, the command is:
BorderStyleEnd(Save!)
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.
BorderStyleName(Style Name)
To rename a border style from Nouveau to Traditional, the command sequence is:
BorderStyleEdit("Nouveau")
BorderStyleName("Traditional")
BorderStyleEnd(Save!)
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.
BorderStyleRetrieve(Style Library;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To retrieve styles contained in a style library named Format into a personal style library, the command is:
BorderStyleRetrieve("Format";PersonalLibrary!)
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.
BorderStyleSave(Style Library;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal style library |
SharedLibrary! | 2 | Shared style library |
To save all styles from the Shared Style Library to a style library named Designs, the command is:
BorderStyleSave("Designs";SharedLibrary!)
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.
BorderTopLine(Type)
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 |
To create a paragraph border with an extra thick top line, the command sequence is:
TextBorderCreate(SingleBorder!;NoFill!;ParagraphBorder!)
BorderTopLine(ExtraThickLine!)
TextBorderEnd(Save!)
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.
BorderUseBorderColor(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Color not used |
Yes! | 1 | Color used |
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!)
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.
BoxAttachTo(Location)
Enumerated Type | Numeric Equivalent | Description |
Page! | 2 | Attach to page |
Paragraph! | 3 | Attach to paragraph |
Character! | 64 | Attach to character |
To attach a graphics box to a character, the command sequence is:
BoxCreate(FigureBox!)
BoxAttachTo(Character!)
BoxEnd(Save!)
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.
BoxAutoPosition(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not position vertically at cursor |
Yes! | 1 | Position vertically at cursor |
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!)
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.
BoxBorderDlg
None.
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.
BoxBorderStyle(Style Name)
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 |
To select Extra Thick lines as the border style for a figure box, the command sequence is:
BoxCreate(FigureBox!)
BoxBorderStyle(ExtraThickBorder!)
BoxEnd(Save!)
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.
BoxCaptionEdit
None.
This command has no parameters, but is used with other commands to create or edit caption contents:
BoxCaptionEdit
Type("Brad's Ferrari")
SubstructureExit
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.
BoxCaptionInitialStyle(Style)
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 |
To specify Comment Style as the caption initial style, the command sequence is:
BoxStyleCreate("Test")
BoxCaptionInitialStyle(CommentStyle!)
BoxStyleEnd(Save!)
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.
BoxCaptionNumberStyle(Number Style)
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 |
To specify Bullet Style as the caption numbering style, the command sequence is:
BoxStyleCreate("Test")
BoxCaptionNumberStyle(BulletStyle!)
BoxStyleEnd(Save!)
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.
BoxCaptionOptionsDlg
None.
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.
BoxCaptionPosition(Side of Box;Relation To Border;Position;Offset)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left side |
Top! | 1 | Top |
Right! | 3 | Right side |
Bottom! | 4 | Bottom |
Enumerated Type | Numeric Equivalent | Description |
OutsideBorder! | 0 | Outside of border |
InsideBorder! | 1 | Inside of border |
OnBorder! | 2 | On the border |
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 |
To position a caption within the top border of a graphics box, the command sequence is:
BoxCreate(FigureBox!)
BoxCaptionPosition(Top!;InsideBorder!;;;)
BoxEnd(Save!)
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.
BoxCaptionRotation(Rotation)
Enumerated Type | Numeric Equivalent | Description |
None! | 0 | No rotation |
Degrees90! | 1 | 90 degrees |
Degrees180! | 2 | 180 degrees |
Degrees270! | 3 | 270 degrees |
To rotate a caption 90 degrees, the command sequence is:
BoxCreate(FigureBox!)
BoxCaptionRotation(Degrees90!)
BoxEnd(Save!)
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.
BoxCaptionWidth(Width)
Enumerated Type | Numeric Equivalent | Description |
AutoWidth! | 2 | Use auto width |
To specify a caption width of 1", the command sequence is:
BoxCreate(FigureBox!)
BoxCaptionWidth(1")
BoxEnd(Save!)
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.
BoxChangeLineHeight(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not change line height |
Yes! | 1 | Change line height |
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!)
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.
BoxChangeStyle(Style Name)
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 |
To change a box style from graphics to text, the command sequence is:
BoxCreate(FigureBox!)
BoxChangeStyle(TextBox!)
BoxEnd(Save!)
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.
BoxCharPositionDlg
None.
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.
BoxContentEdit
None.
This command has no parameters and is used with other commands to create or edit box contents:
BoxContentEdit
Type("Example Box")
SubstructureExit
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.
BoxContentOptionsDlg
None.
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.
BoxContentPosition(Horizontal;Vertical)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Position left |
Center! | 2 | Position center |
Right! | 3 | Position right |
Enumerated Type | Numeric Equivalent | Description |
Top! | 1 | Position top |
Center! | 2 | Position center |
Bottom! | 4 | Position bottom |
To position contents at the left and bottom of a box, the command sequence is:
BoxCreate(FigureBox!)
BoxContentPosition(Left!;Bottom!)
BoxEnd(Save!)
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.
BoxContentPreserveAspectRatio(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not preserve |
Yes! | 1 | Preserve |
To preserve the image width/height ratio, the command sequence is:
BoxCreate(FigureBox!)
BoxContentPreserveAspectRatio(Yes!)
BoxEnd(Save!)
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.
BoxContentType(Type Name)
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 |
To specify box contents as a graphics image, the command sequence is:
BoxCreate(FigureBox!)
BoxContentType(Image!)
BoxEnd(Save!)
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.
BoxCounter(Counter Type)
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 |
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!)
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.
BoxCreate(Box Style)
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 |
To create an Equation Box, the command sequence is:
BoxCreate(EquationBox!)
BoxEnd(Save!)
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.
BoxCreateDlg
None.
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.
BoxDelete(Box Number)
To delete Equation Box 3, the command sequence is:
BoxDelete(3)
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.
BoxDlg
None.
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.
BoxEdit(Box Number)
Box Number A numeric expression specifying a box number to edit.
To edit graphics box 3 of a document, the command sequence is:
BoxEdit(3)
BoxEnd
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.
BoxEditDlg
None.
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.
BoxEditByCounter(Counter;{Number})
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 |
To edit text box 2.5 in a document, the command sequence is:
BoxEditByCounter(TextBoxCounter!;{2;5})
BoxEnd(Save!)
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.
BoxEditNext(Box Type)
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 |
To edit the next occurrence of a user box, the command sequence is:
BoxEditNext(UserBox!)
BoxEnd(Save!)
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.
BoxEditPrevious(Box Type)
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 |
To edit the previous occurrence of a button box, the command sequence is:
BoxEditPrevious(ButtonBox!)
BoxEnd(Save!)
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.
BoxEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To save changes made to graphics box number 1, the command sequence is:
BoxEdit(1)
BoxEnd(Save!)
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.
BoxEquationDefaultFont(Size)
To select the default font but specify a non-default font size of 14p, the command is:
BoxEquationDefaultFont(14p)
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.
BoxEquationFilename(Filename)
Filename A character expression specifying the name of an equation file.
To specify an equation filename STAT.DOC, the command is:
BoxEquationFilename("STAT.DOC")
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.
BoxEquationFont(Name;Size)
To select 14p Helvetica, the command is:
BoxEquationFont("Helvetica";14p)
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.
BoxEquationPositionToError
None.
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.
BoxEquationSave(Filename)
Filename A character expression specifying the name of the equation file.
To save an equation named Formula, the command is:
BoxEquationSave("Formula")
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.
BoxEquationSaveAsGraphic(Filename;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 |
To save an equation named Calculus in Corel Presentations 2.0 format, the command is:
BoxEquationSaveAsGraphic("Calculus";Presentations_20!)
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.
BoxEquationSettingsDlg
None.
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.
BoxExactPositionDlg
None.
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.
BoxFillStyle(Style Name)
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 |
To define a Corel WordPerfect fill style of 30%, the command sequence is:
BoxCreate(FigureBox!)
BoxFillStyle(Fill30!)
BoxEnd(Save!)
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.
BoxHeight(Height)
Enumerated Type | Numeric Equivalent | Description |
AutoHeight! | 2 | Select auto height |
To set box height to 4", the command sequence is:
BoxCreate(FigureBox!)
BoxHeight(4")
BoxEnd(Save!)
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.
BoxHorizontalAlignment(Alignment;Position;Offset;Left Column;Right Column)
Enumerated Type | Numeric Equivalent | Description |
AlignMargins! | 1 | Align to margins |
AlignColumns! | 2 | Align to columns |
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left align |
Center! | 2 | Center align |
Right! | 3 | Right align |
FullAlign! | 7 | Full align |
To center a graphics box between two columns, the command sequence is:
BoxCreate(FigureBox!)
BoxHorizontalAlignment(AlignColumns!;Center!;0";1;2)
BoxEnd(Save!)
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.
BoxHorizontalPosition(Position)
To position a graphics box 2" from the left edge of the page, the command sequence is:
BoxCreate(FigureBox!)
BoxHorizontalPosition(2.5")
BoxEnd(Save!)
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.
BoxImageBlackWhiteThreshold(Threshold)
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!)
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.
BoxImageBrightness(Brightness)
To set the brightness of an image color to .5, the command sequence is:
BoxCreate(FigureBox!)
BoxImageBrightness(0.5)
BoxEnd(Save!)
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.
BoxImageClipboardRetrieve
None.
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.
BoxImageClipboardSave
None.
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.
BoxImageContrast(Contrast)
To set the contrast of an image color to .7, the command sequence is:
BoxCreate(FigureBox!)
BoxImageContrast(.7)
BoxEnd(Save!)
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.
BoxImageDitherMethod(Method;Source)
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 |
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 |
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!)
BoxImageFill specifies a graphics image fill type. In the Image Editor, this command is the equivalent of choosing Edit, Fill.
BoxImageFill(Fill Type)
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 |
To set an image fill type to transparent, the command sequence is:
BoxCreate(FigureBox!)
BoxImageFill(Transparent!)
BoxEnd(Save!)
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.
BoxImageFlipX(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not reverse image |
Yes! | 1 | Reverse image |
To reverse an image on its horizontal axis, the command sequence is:
BoxCreate(FigureBox!)
BoxImageFlipX(Yes!)
BoxEnd(Save!)
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.
BoxImageFlipY(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not reverse image |
Yes! | 1 | Reverse image |
To reverse an image on its vertical axis, the command sequence is:
BoxCreate(FigureBox!)
BoxImageFlipY(Yes!)
BoxEnd(Save!)
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.
BoxImageHalftoneOptions(Source;LPI;Halftone Angle)
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. |
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!)
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.
BoxImageInvertColors(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not invert colors |
Yes! | 1 Invert colors |
To invert the colors of the current image, the command sequence is:
BoxCreate(FigureBox!)
BoxImageInvertColors(Yes!)
BoxEnd(Save!)
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.
BoxImageMonochrome(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not converted |
Yes! | 1 | Converted |
To convert a color image to black and white, the command sequence is:
BoxCreate(FigureBox!)
BoxImageMonochrome(Yes!)
BoxEnd(Save!)
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.
BoxImageMove(X Position;Y Position)
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!)
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.
BoxImagePresentations
None.
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.
BoxImageRetrieve(Image Location;Filename;Format)
Enumerated Type | Numeric Equivalent | Description |
LeaveExternal! | 0 | Use image on Disk |
MakeInternal! | 1 | Standard retrieve |
UseInternal! | 2 | Use existing image in document |
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. |
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!)
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.
BoxImageRotate(Degree)
To rotate an image 90 degrees, the command sequence is:
BoxCreate(FigureBox!)
BoxImageRotate(90.0)
BoxEnd(Save!)
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.
BoxImageSave(Filename;Format)
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 |
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!)
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.
BoxImageScaling(Width;Height)
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!)
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.
BoxImageSettingsDlg
None.
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.
BoxImageShowBackground(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not visible |
Yes! | 1 | Visible |
To show an image background, the command sequence is:
BoxCreate(FigureBox!)
BoxImageShowBackground(Yes!)
BoxEnd(Save!)
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.
BoxInsertFullPageOn(State)
Enumerated Type | Numeric Equivalent | Description |
Following Page! | 0 | Insert graphics box on following page |
Current Page! | 1 | Insert graphics box on current page |
To show an image background, the command sequence is:
BoxCreate(FigureBox!)
BoxInsertFullPageOn(Current Page!)
BoxEnd(Save!)
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.
BoxOverlap(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Overlap not allowed |
Yes! | 1 | Overlap allowed |
To allow a graphics box to overlap other boxes, the command sequence is:
BoxCreate(FigureBox!)
BoxOverlap(Yes!)
BoxEnd(Save!)
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.
BoxPagePositionDlg
None.
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.
BoxParagraphPositionDlg
None.
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.
BoxResetBorder
None.
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).
BoxResetCaption
None.
To reset the caption of graphics box number 2, the command sequence is:
BoxEdit(2)
BoxResetCaption
BoxEnd(Save!)
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).
BoxResetContent
None.
To reset the content values of graphics box number 1, the command sequence is:
BoxEdit(1)
BoxResetContent
BoxEnd(Save!)
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.
BoxResetContentRender
None.
To reset the content render of graphics box number 2, the command sequence is:
BoxEdit(2)
BoxResetContentRender
BoxEnd(Save!)
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.
BoxResetCounter
None.
To reset the counter value of graphics box 3, the command sequence is:
BoxEdit(3)
BoxResetCounter
BoxEnd(Save!)
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.
BoxResetFill
None.
To reset the box fill values of graphics box number 2, the command sequence is:
BoxEdit(2)
BoxResetFill
BoxEnd(Save!)
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.
BoxResetPosition
None.
To reset the box position values of graphics box number 1, the command sequence is:
BoxEdit(1)
BoxResetPosition
BoxEnd(Save!)
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.
BoxResetTextFlow
None.
To reset text flow values of graphics box number 1, the command sequence is:
BoxEdit(1)
BoxResetTextFlow
BoxEnd(Save!)
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.
BoxSizeDlg
None.
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.
BoxStaysOnPage(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Moves with text |
Yes! | 1 | Stays on page |
To allow the box to move with the surrounding text, the command sequence is:
BoxCreate(FigureBox!)
BoxStaysOnPage(No!)
BoxEnd(Save!)
BoxStyleCopy copies the specified style from one location to another. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, Copy.
BoxStyleCopy(Style Name;Current Location;Destination;New Name)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current Document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared Library |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current Document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared Library |
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!)
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.
BoxStyleCreate(Style Name)
To create a box style called NewBox, the command sequence is:
BoxStyleCreate("NewBox")
BoxStyleEnd(Save!)
BoxStyleDelete deletes a style from the specified location. This command is the equivalent of choosing Graphics, Graphics Boxes, Styles, highlighting a style, Delete.
BoxStyleDelete(Style Name;Style Library)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current Document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared Library |
To delete a box style called OldBox from the current document, the command is:
BoxStyleDelete("OldBox";CurrentDoc!)
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.
BoxStyleDlg
None.
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.
BoxStyleEdit(Style Name)
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 |
To edit the Watermark Image Box style to allow it to overlap other boxes, the command sequence is:
BoxStyleEdit(WatermarkImageBox!)
BoxOverlap(Yes!)
BoxStyleEnd(Save!)
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.
BoxStyleEditDlg
None.
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.
BoxStyleEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To save changes to an edited Figure Box style, the command sequence is:
BoxStyleEdit(FigureBox!)
BoxOverlap(Yes!)
BoxStyleEnd(Save!)
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.
BoxStyleName(Style Name)
To rename a style from Picture to Portrait, the command sequence is:
BoxStyleEdit("Picture")
BoxStyleName("Portrait")
BoxStyleEnd(Save!)
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.
BoxStyleRetrieve(Style Library;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current Document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared Library |
To retrieve all styles in a style library named RETRO into your Shared Style Library, the command is:
BoxStyleRetrieve("RETRO";SharedLibrary!)
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.
BoxStyleSave(Library Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current Document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared Library |
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!)
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.
BoxTextAngle(Degree)
Enumerated Type | Numeric Equivalent | Description |
None! | 0 | No rotation |
Degrees90! | 1 | 90 degrees |
Degrees180! | 2 | 180 degrees |
Degrees270! | 3 | 270 degrees |
To rotate box text 180 degrees, the command sequence is:
BoxCreate(TextBox!)
BoxTextAngle(Degrees180!)
BoxEnd(Save!)
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.
BoxTextDefaultStyle(Style)
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 |
To specify Normal Style as the default for box text, the command sequence is:
BoxStyleEdit(TextBox!)
BoxTextDefaultStyle(BoxTextStyle!)
BoxStyleEnd(Save!)
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.
BoxTextFilename(Filename)
To specify a text filename of DRAFT.FIL, the command sequence is:
BoxCreate(TextBox!)
FileRetrieve("DRAFT.FIL")
BoxTextFilename("DRAFT.FIL")
BoxEnd(Save!)
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.
BoxTextFlow(Direction)
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 |
To allow text to wrap around the box, the command sequence is:
BoxCreate(FigureBox!)
BoxTextFlow(BothSides!)
BoxEnd(Save!)
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.
BoxTextFlowContour
None.
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.
BoxTextFlowSquare
None.
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.
BoxTextSettingsDlg
None.
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.
BoxVerticalAlignment(Position;Offset)
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) |
To vertically center a figure box that has been attached to a page, the command sequence is:
BoxCreate(FigureBox!)
BoxVerticalAlignment(Center!)
BoxEnd(Save!)
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.
BoxVerticalPosition(Position)
To position a figure box 3" from the top of the page, the command sequence is:
BoxCreate(FigureBox!)
BoxVerticalPosition(3")
BoxEnd(Save!)
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.
BoxWidth(Width)
Enumerated Type | Numeric Equivalent | Description |
AutoWidth! | 2 | Use automatic width |
To set a figure box width to 3", the command sequence is:
BoxCreate(FigureBox!)
BoxWidth(3")
BoxEnd(Save!)
ButtonBar determines whether the Button Bar is displayed. This command is not recordable. To use this command, you must type it into the macro.
ButtonBar(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Not displayed |
On! | 1 | Displayed |
To display the Button Bar, the command is:
ButtonBar(On!)
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.
ButtonBarPosition(Position)
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 |
To position the Button Bar at the bottom of a document window, the command is:
ButtonBarPosition(Bottom!)
ButtonBarSelect selects the specified Button Bar. This command is the equivalent of choosing View, Button Bar Setup, Select, highlighting a Button Bar, Select.
ButtonBarSelect(Button Bar)
To select a Button Bar named MYMACROS, the command is:
ButtonBarSelect("MYMACROS")
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).
ButtonBarSetupGraphics(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Button Bars not visible |
On! | 1 | Button Bars visible |
To allow Button Bars to be visible while in Graphics Mode, the command is:
ButtonBarSetupGraphics(On!)
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).
ButtonBarSetupText(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Button Bars not visible |
On! | 1 | Button Bars visible |
To allow Button Bars to be visible while in Text Mode, the command is:
ButtonBarSetupText(On!)
ButtonBarStyle specifies a Button Bar style. This command is the equivalent of choosing View, Button Bar Setup, Options, and selecting a style.
ButtonBarStyle(Style)
Enumerated Type | Numeric Equivalent | Description |
Text! | 1 | Text only |
Icon! | 2 | Icon only |
Both! | 3 | Text and Icon |
To specify that a Button Bar display icons only, the command is:
ButtonBarStyle(Icons!)
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.
CancelKey
None.
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.
CapBeginSentence(State)
Enumerated Type | Numeric Equivalent |
Off! | 0 |
On! | 1 |
To specify that the first letter of each sentence is automatically capitalized, the command is:
CapBeginSentence(On!)
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.
CartridgesAndFontsBegin
None.
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.
CartridgesAndFontsEnd(State;Printer Name;.PRS Filename)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
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")
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.
CartridgesAndFontsMarkFont(Font Source;Library Name;Font Name;Type of Mark)
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 "*" |
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")
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.
CartridgesAndFontsQuantity(Font Source;Quantity)
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")
Center aligns one line of text. This command is the equivalent of choosing Layout, Alignment, Center.
Center
None.
CenterCurrentPage specifies whether to center the current page vertically. This command is the equivalent of choosing Layout, Page, Center Current Page.
CenterCurrentPage(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not center page |
On! | 1 | Center page |
To center a current page vertically, the command is:
CenterCurrentPage(On!)
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.
CenterPages(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not center pages |
On! | 1 | Center pages |
To center all pages vertically in the current document, the command is:
CenterPages(On!)
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.
CGAFastText(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | CGA Fast Text off |
Yes! | 1 | CGA Fast Text on |
To turn the CGA Fast Text option on, the command is:
CGAFastText(Yes!)
ChapterNumber specifies a chapter number. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, New Number, and specifying a number.
ChapterNumber(Number)
To specify chapter 5, the command is:
ChapterNumber(5)
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.
ChapterNumberDecrement
None.
ChapterNumberDisplay types the chapter number at the cursor. This command is the equivalent of choosing Layout, Page, Page Numbering, Chapter, Display in Document.
ChapterNumberDisplay
None.
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.
ChapterNumberIncrement
None.
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.
ChapterNumberMethod(Number Method)
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 |
To select uppercase roman numerals as the numbering method, the command is:
ChapterNumberMethod(UpperRoman!)
ClearDoc clears a document screen without saving changes. This command is the equivalent of choosing File, Exit, No, No.
ClearDoc
None.
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.
ClipboardAppendTo
None.
ClipboardRetrieve retrieves the contents of a clipboard into a document screen. This command is the equivalent of choosing File, Go To Shell, Retrieve.
ClipboardRetrieve
None.
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.
ClipboardSaveTo
None.
ClipboardSetNumber specifies the number of a Clipboard. This command is the equivalent of choosing File, Go To Shell, Clipboard Number.
ClipboardSetNumber(Number)
To specify Clipboard 10, the command is:
ClipboardSetNumber(10)
Closes a document screen without saving changes. This command is the equivalent of choosing File, Close, No.
Close
None.
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.
CloseAllDocuments
None.
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.
CloseDlg
None.
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.
ColorAdd(Palette Name;Position;Red Value;Green Value;Blue Value;Color Name:)
To add a color named Autumn to a palette named Seasons, the command is:
ColorAdd("Seasons";0;251;160;90;"Autumn")
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.
ColorDelete(Palette Name;Color Name)
To delete Cyan from Crayon Palette, the command is:
ColorDelete("Crayon Palette";"Cyan")
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.
ColorDlg
None.
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.
ColorModify(Palette Name;Current Color Name;Red Value;Green Value;Blue Value;New Color Name)
To modify Black in the Crayon Palette and rename it Slate, the command is:
ColorModify("Crayon Palette";"Black";51;91;91;"Slate")
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.
ColorPaletteCreate(Palette Name)
To create a palette named Hues of Blue, the command is:
ColorPaletteCreate("Hues of Blue")
ColorPaletteDelete names a palette to delete. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Delete.
ColorPaletteDelete(Palette Name)
To delete a palette named Hues of Blue, the command is:
ColorPaletteDelete("Hues of Blue")
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.
ColorPaletteDlg
None.
ColorPaletteRename renames an existing palette. This command is the equivalent of choosing File, Setup, Color Palette, selecting a palette, Rename, and renaming the palette.
ColorPaletteRename(Current Palette Name;New Palette Name)
To change the name Craig Pyle's Palette to Puget Sound Blues, the command is:
ColorPaletteRename("Craig Pyle's Palette";"Puget Sound Blues")
ColorPaletteSelect names a palette to select. This command is the equivalent of choosing File, Setup, Color Palette, highlighting a palette, Select.
ColorPaletteSelect(Palette Name)
To select the palette called Multi-Colors, the command is:
ColorPaletteSelect("Multi-Colors")
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.
ColorSchemeAssign(Scheme Name;Attribute;Foreground/Background)
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)
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.
ColorSchemeCopy(Current Name;New Name)
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")
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.
ColorSchemeCreate(Scheme Name)
To create a color scheme named Eclectic Selections, the command is:
ColorSchemeCreate("Eclectic Selections")
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.
ColorSchemeDelete(Scheme Name)
To delete a color scheme named Mousy Browns, the command is:
ColorSchemeDelete("Mousy Browns")
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.
ColorSchemeSelect(Scheme Name)
To select a color scheme named London Fog, the command is:
ColorSchemeSelect("London Fog")
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.
ColorUnits(Unit)
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 |
To select the Hue Luminosity Saturation display unit, the command is:
ColorUnits(HLS!)
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.
ColumnsDefinition(Type of Column;Section Spacing;{Width;Fixed})
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 |
Enumerated Type | Numeric Equivalent | Description |
NotFixed! | 0 | Columns not fixed |
Fixed! | 1 | Columns fixed |
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!})
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.
ColumnsDefinitionDlg
None.
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.
ColumnsDefinitionSimple(Number of Columns;Type of Column;Section Spacing;Width Between Columns)
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 |
To define two parallel columns, with .5" between them, the command is:
ColumnsDefinitionSimple(2;Parallel!;1.0;0.5")
ColumnsOff turns columns off. This command is the equivalent of choosing Layout, Columns, Off.
ColumnsOff
None.
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.
ColumnsTablesDlg
None.
CommentConvert converts a comment to text. The last comment appearing upstream of the cursor will be merged into the document, whether it is directly adjacent to the cursor position or not. If no comments are found upstream of the cursor, the first one downstream is targeted instead, whether it is directly adjacent to the cursor position or not. This command is the equivalent of choosing Layout, Comment, Convert to Text.
CommentConvert
None.
CommentCreate opens the Comment editing screen. This command is the equivalent of choosing Layout, Comment, Create.
CommentCreate
None.
CommentEdit opens the Comment editing screen. The last comment appearing upstream of the cursor will be loaded in the screen, whether it is directly adjacent to the cursor position or not. If no comments are found upstream of the cursor, the first one downstream is targeted instead, whether it is directly adjacent to the cursor position or not. If a comment has not been created, a "Not Found" error is generated. This command is the equivalent of choosing Layout, Comment, Edit.
CommentEdit
None.
CommentsDisplaySetup specifies whether comments are displayed in documents. This command is the equivalent of choosing View, Screen Setup, Window Options, Display Comments.
CommentsDisplaySetup(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not display comments |
Yes! | 1 | Display comments |
To display comments, the command is:
CommentsDisplaySetup(Yes!)
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.
ComposeDlg
None.
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.
CompressedPrintForList(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Compressed font |
Yes! | 1 | Normal font |
To print the File Manager files list in a compressed font, the command is:
CompressedPrintForList(Yes!)
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.
ConditionalEndOfPage(Number Of Lines)
To keep ten lines of text together, the command is:
ConditionalEndOfPage(10)
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.
ConvertCaseDlg
None.
ConvertCaseInitialCaps converts the currently blocked text to initial caps. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Initial Caps.
ConvertCaseInitialCaps
None.
ConvertCaseLowercase converts the currently blocked text to lowercase letters. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Lowercase.
ConvertCaseLowercase
None.
ConvertCaseUppercase converts the currently blocked text to uppercase letters. With text blocked, this command is the equivalent of choosing Edit, Convert Case, Uppercase.
ConvertCaseUppercase
None.
ConvertCodePage specifies a Code Page for the current document. This command is the equivalent of choosing Save, Code Page, highlighting a language set, Select.
ConvertCodePage(Code Page)
To convert to a Code Page of Hebrew, the command is:
ConvertCodePage(862)
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.
Copy
None.
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.
CopyAndPaste
None.
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.
CounterBoxNumberingDlg
None.
CounterCreate specifies a graphics box reference number. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, Create, entering a name, Numbering Method.
CounterCreate(Type;{Number})
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 |
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 |
To define a user box counter as lowercase letters, the command is:
CounterCreate(UserBoxCounter!;{LowLetter!})
CounterDecrement decreases a counter by one. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, highlighting a graphics box type, Decrement.
CounterDecrement(Type;Level)
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 |
To decrement a figure box number at level one, the command is:
CounterDecrement(FigureCounter!;1)
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.
CounterDelete(Type)
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 |
To delete a user-created counter named My Counter, the command is:
CounterDelete("My Counter")
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.
CounterDisplay(Type;Level)
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 |
To display a number from a user-created counter named My Counter, the command is:
CounterDisplay("My Counter";1)
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.
CounterDlg
None.
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.
CounterEditLevel(Type;Level)
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 |
To specify two levels in a figure box, the command is:
CounterEditLevel(FigureCounter!;2)
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.
CounterEditLevelMethod(Type;Level;Method)
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 |
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 |
To specify uppercase letters for the first level of a figure box counter, the command is:
CounterEditLevelMethod(FigureCounter!;1;UpLetter!)
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.
CounterEditLevelName(Type;OldName;NewName)
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 |
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")
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.
CounterEditMethod(Type;Method)
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 |
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 |
To specify a figure box counter numbering method as uppercase letters, the command is:
CounterEditMethod(FigureCounter!;UpLetter!)
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.
CounterEditName(OldName;NewName)
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")
CounterIncrement increments a specified counter by one. This command is the equivalent of choosing Graphics, Graphics Boxes, Numbering, selecting a counter, Increment.
CounterIncrement(Type;Level)
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 |
To increment the first level of a table box, the command is:
CounterIncrement(TableBoxCounter!;1)
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.
CounterSetMethod(Type;Level;Method)
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 |
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 |
To specify the second level of a text box as lowercase roman numerals, the command is:
CounterSetMethod(TextBoxCounter!;2;LowRoman!)
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.
CounterSetValue(Type;{Value})
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 |
To set the figure box counter level at 5, the command is:
CounterSetValue(FigureCounter!;{5})
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.
CreateSummaryOnSaveExit(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not create a summary |
Yes! | 1 | Create a summary |
To automatically create a document summary when saving a document, the command is:
CreateSummaryOnSaveExit(Yes!)
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.
CrossRefBothReference(Target;Reference;Type)
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 |
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 |
To mark a page reference with a target named Next, the command is:
CrossRefBothReference("Next";RefPage!)
CrossRefEnterSubstructure
PosPageNext
SubstructureExit
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.
CrossRefBothTarget
None.
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.
CrossRefEnterSubstructure
None.
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.
CrossRefMarkBothDlg
None.
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.
CrossRefMarkReference(Name;Type;Counter)
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 |
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 |
To mark a cross-reference named Next and tie it to a secondary page, the command is:
CrossRefMarkReference("Next";RefSecondaryPage!)
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.
CrossRefMarkReferenceDlg
None.
CrossRefMarkTarget names a cross-reference target. This command is the equivalent of choosing Tools, Cross-Reference, Target, and entering a target name.
CrossRefMarkTarget(Name)
To define a target named Index, the command is:
CrossRefMarkTarget("Index")
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.
CrossRefMarkTargetDlg
None.
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.
CtrlDelKey
None.
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.
CtrlInsKey
None.
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.
CtrlNumPlus
None.
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.
CursorSpeed(Speed)
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 |
To set the cursor speed at 30 characters per second, the command is:
CursorSpeed(Cps30!)
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.
Cut
None.
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.
CutAndPaste
None.
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.
DateCode
None.
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.
DateDlg
None.
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.
DateFormat(String)
To change a date format to read 31.July 1993, the command is:
DateFormat("[Day#]"+".[Month]"+"[Year(4)#]")
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.
DateFormatDlg
None.
DateText inserts the system date at the current cursor position. This command is the equivalent of choosing Tools, Date, Text.
DateText
None.
DecimalAlignmentCharacter specifies a decimal character. This command is the equivalent of choosing Layout, Character, Decimal/Align Character, and entering a character.
DecimalAlignmentCharacter(Character)
To change the decimal character from a period to a comma, the command is:
DecimalAlignmentCharacter(",")
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.
DelayCodes(Number)
To delay a specified code for three pages, the command is:
DelayCodes(3)
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.
DelayCodesDlg
None.
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.
DeleteAppend(Filename)
To append the current block of text to a file named HORIZON, the command is:
DeleteAppend("HORIZON")
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.
DeleteAppendFilenameDlg
None.
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.
DeleteCharNext
None.
DeleteCharPrevious deletes the character to the left of the cursor. This command is the equivalent of pressing Backspace.
DeleteCharPrevious
None.
DeleteToBeginningOfWord deletes all characters to the left of the cursor in the current word. This command is the equivalent of pressing Home, Backspace.
DeleteToBeginningOfWord
None.
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.
DeleteToEndOfLine
None.
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.
DeleteToEndOfPage
None.
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.
DeleteToEndOfPageDlg
None.
DeleteToEndOfWord deletes all characters from the cursor to the beginning of the next word. This command is the equivalent of pressing Home, Delete.
DeleteToEndOfWord
None.
DeleteWord deletes the current word or space. This command is the equivalent of pressing Ctrl+Backspace.
DeleteWord
None.
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.
DirectoryCreate(Name)
To create a directory named PERSONAL on the C: drive, the command is:
DirectoryCreate("C:\PERSONAL")
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.
DirectoryDefault(Name)
To change the default directory to C:\COREL\WP62\MACROS, the command is:
DirectoryDefault("C:\COREL\WP62\MACROS")
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.
DirectoryRemove(Name)
To remove an empty directory named C:\TEMP, the command is:
DirectoryRemove("C:\TEMP")
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.
DisplayListMode(State)
Enumerated Type | Numeric Equivalent | Description |
DOSFilenames! | 1 | Display DOS filenames |
DescriptiveNames! | 2 | Display descriptive names |
To display descriptive names in File Manager, the command is:
DisplayListMode(DescriptiveNames!)
DisplayMode specifies a display mode. This command is the equivalent of choosing View, Text Mode, Graphics Mode or Page Mode.
DisplayMode(State)
Enumerated Type | Numeric Equivalent | Description |
Text! | 1 | Text mode |
Graphics! | 2 | Graphical mode |
FullPage! | 3 | Graphical mode with headers, footer, page numbers, and margins |
To specify Page Mode display, the command is:
DisplayMode(FullPage!)
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.
DisplayOnStatusLine(Choice)
Enumerated Type | Numeric Equivalent | Description |
Nothing! | 0 | Nothing in the bottom left corner of the window |
Filename! | 1 | Filename |
Font! | 2 | Font |
To display the filename of a document on the status line, the command is:
DisplayOnStatusLine(Filename!)
DisplayPitch specifies character width on the screen. This command is the equivalent of choosing Layout, Document, Display Pitch.
DisplayPitch(State;Width)
Enumerated Type | Numeric Equivalent | Description |
Automatic! | 0 | Predetermined |
Manual! | 1 | User-defined |
To specify a manual display pitch of 0.2", the command is:
DisplayPitch(Manual!;0.2")
DisplayRewrite rewrites the document screen. This command is the equivalent of pressing Ctrl+F3, Rewrite.
DisplayRewrite
None.
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.
DisplaySetupDlg
None.
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.
DisplayUnits(State)
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 |
To specify millimeters as the unit of measure, the command is:
DisplayUnits(Millimeters!)
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.
DisplayZoom(State)
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 |
To zoom a graphic mode document screen to the current page width, the command is:
DisplayZoom(ZoomPageWidth!)
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.
DisplayZoomSetup(State)
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 |
To display the page width including margins from one edge of the screen to another, the command is:
DisplayZoomSetup(ZoomPageWidth!)
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.
DocCompare(Filename;Type)
Enumerated Type | Numeric Equivalent | Description |
Phrase! | 0 | Phrase changes |
Word! | 1 | Word changes |
Sentence! | 2 | Sentence changes |
Paragraph! | 3 | Paragraph changes |
To compare the current document with a document named ORIGINAL sentence for sentence, the command is:
DocCompare("ORIGINAL";Sentence!)
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.
DocCompareDlg
None.
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.
DocCompareRemoveRedline(Choice)
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 |
To remove redline and strikeout codes and strikeout text, the command is:
DocCompareRemoveRedline(RemoveAll!)
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.
DocCompareRemoveRedlineDlg
None.
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.
DocInformation
None.
DocInitialFont specifies a default document font. This command is the equivalent of choosing Layout, Document, Initial Font, and selecting a font and point size.
DocInitialFont(Name;Size;Family;Attributes;Weight;Width;Source;Type)
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 |
Enumerated Type | Numeric Equivalent | Description |
FontMatchNormal! | 0 | Normal |
FontMatchItalic! | 1 | Italic |
FontMatchOutline! | 2 | Outline |
FontMatchShadow! | 4 | Shadow |
FontMatchSmallCaps! | 8 | Small caps |
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 |
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 |
Enumerated Type | Numeric Equivalent | Description |
PRSFile! | 16 | .PRS file |
DRSFile! | 20 | .DRS file |
Enumerated Type | Numeric Equivalent | Description |
Speedo! | 134 | Speedo |
Intellifont! | 135 | Intellifont |
Type1! | 138 | Type 1 |
TrueType! | 139 | True Type |
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 |
To select CG Times 12pt as a document default font, the command is:
DocInitialFont("CG Times";12)
DocSummaryDelete deletes the document summary of the current document. This command is the equivalent of choosing Layout, Document, Summary, Delete, Yes.
DocSummaryDelete
None.
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.
DocSummaryDescriptiveTypeSetup(String)
To define "Personal Primary Files" as the default descriptive type, the command is:
DocSummaryDescriptiveTypeSetup("Personal Primary Files")
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.
DocSummaryDlg
None.
DocSummaryExtract extracts the document summary from the current document. This command is the equivalent of choosing File, Summary, Extract, Yes.
DocSummaryExtract
None.
DocSummaryField defines a field. This command is the equivalent of choosing Layout, Document, Summary, and adding text to fields.
DocSummaryField(Field;Text)
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 |
To enter JD in the Typist field, the command is:
DocSummaryField(Typist!;"JD")
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.
DocSummaryFieldOrder(Documents;{Fields})
Enumerated Type | Numeric Equivalent | Description |
CurrentDocument! | 1 | Current document |
NewDocuments! | 2 | Subsequent documents only |
Both! | 3 | Current and new documents |
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 |
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!})
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.
DocSummaryPrint(Filename)
To print the document summary of a file named SUMMARY, the command is:
DocSummaryPrint("C:\COREL\WP62\SUMMARY")
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.
DocSummarySave(Filename;Choice;Source)
Enumerated Type | Numeric Equivalent | Description |
Append! | 0 | Appends summary to existing file |
Replace! | 1 | Replaces existing file with document summary |
To append the document summary of a current document to a file named SUMMARY, the command is:
DocSummarySave("SUMMARY";Append!)
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.
DocSummarySelectDlg
None.
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.
DocSummarySetupDlg
None.
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.
DOSCommand(Command)
To list all files in C:\, the command is:
DOSCommand("dir c:\")
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.
DotLeader(Character;Spaces)
To specify a comma (,) dot leader character with five spaces between each character, the command is:
DotLeader(",";5)
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).
DoubleSidedPrint(Print)
Enumerated Type | Numeric Equivalent | Description |
None! | 0 | None |
LongEdge! | 1 | Long Edge |
ShortEdge! | 3 | Short Edge |
To turn on Double-sided Printing and select a short edge for binding, the command is:
DoubleSidedPrint(ShortEdge!)
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.
DoubleSmartQuote(State;OpeningDoubleQuote;ClosingDoubleQuote)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turns on Double Smart Quotes |
On! | 1 | Turns off Double Smart Quotes |
To specify " as the double quote characters, the command is:
DoubleSmartQuote(On!;34;34)
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.
DownArrow
None.
DropCapBegin begins the creation or editing of a drop cap. This command is the equivalent of choosing Font, Drop Cap.
DropCapBegin
None.
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.
DropCapBorderDlg
None.
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.
DropCapBorderStyle(Name)
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 |
To specify a double border as the drop cap border style, the command is:
DropCapBorderStyle(DoubleBorder!)
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.
DropCapCharacters(Number)
To include three characters in a drop cap, the command is:
DropCapBegin
DropCapCharacters(3)
DropCapEnd(Save!)
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.
DropCapCharacterSize(Size)
To specify four text lines as the height of a drop cap, the command sequence is:
DropCapBegin
DropCapCharacterSize(4)
DropCapEnd(Save!)
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.
DropCapCustomDlg
None.
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.
DropCapDlg
None.
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.
DropCapEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancels changes to drop cap |
Save! | 1 | Saves changes to drop cap |
To save editing changes to a drop cap, the command is:
DropCapEnd(Save!)
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.
DropCapFillStyle(Fill Style Name)
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 |
To specify a drop cap with no fill, the command sequence is:
DropCapBegin
DropCapFillStyle(NoFill!)
DropCapEnd(Save!)
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.
DropCapFontDlg
None.
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.
DropCapHorizontalAdjustment(Adjustment)
To specify that fifty percent of a drop cap should be in the margin, the command sequence is:
DropCapBegin
DropCapHorizontalAdjustment(50)
DropCapEnd(Save!)
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.
DropCapIncludeDescender(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No space for descender |
Yes! | 1 | Allow space for descender |
To allow space for descending characters in a drop cap, the command sequence is:
DropCapBegin
DropCapIncludeDescender(Yes!)
DropCapEnd(Save!)
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.
DropCapIncludeDiacritic(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No space for diacritic |
Yes! | 1 | Allow space for diacritic |
To allow space for diacritical marks in a drop cap, the command sequence is:
DropCapBegin
DropCapIncludeDiacritic(Yes!)
DropCapEnd(Save!)
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.
DropCapKerning(Adjustment)
To move a drop cap .01", the command sequence is:
DropCapBegin
DropCapKerning(0.01")
DropCapEnd(Save!)
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.
DropCapNoWrap(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Text wrapping |
Yes! | 1 | No text wrapping |
To specify that text does not wrap around a drop cap, the command sequence is:
DropCapBegin
DropCapNoWrap(Yes!)
DropCapEnd(Save!)
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.
DropCapOff
None.
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.
DropCapUsePrevious
None.
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.
DropCapVerticalAdjustment(Adjustment)
To specify two blank lines between a drop cap and paragraph text, the command sequence is:
DropCapBegin
DropCapVerticalAdjustment(2.0)
DropCapEnd(Save!)
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.
DuplicateCodesAllow(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No code duplication |
Yes! | 1 | Code duplication |
To specify that Corel WordPerfect inserts codes even when they duplicate existing conditions, the command is:
DuplicateCodesAllow(Yes!)
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.
EditCodeRight
None.
EndCenterOrAlignment places an End Centering/Alignment code at the cursor. This command is the equivalent of choosing Layout, Other, End Centering/Alignment.
EndCenterOrAlignment
None.
EndField places an ENDFIELD merge code at the cursor. This command is the equivalent of pressing F9.
EndField
None.
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.
EndFieldKey
None.
EndnoteCreate displays an Endnote editing screen. This command is the equivalent of choosing Layout, Endnote, Create.
EndnoteCreate
None.
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.
EndnoteEdit (Endnote Number)
To edit the second endnote of a document, the command is:
EndnoteEdit(2)
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.
EndnoteEditDlg
None.
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.
EndnoteMinimum(Measurement)
To keep at least .75" of endnote text together on each page, the command is:
EndnoteMinimum(.75")
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.
EndnoteNewNumber(Number)
To start endnote numbering at 7, the command is:
EndnoteNewNumber(7)
EndnoteNumberDecrement decreases the endnote number by one. This command is the equivalent of choosing Layout, Endnote, New Number, Decrement Number.
EndnoteNumberDecrement
None.
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.
EndnoteNumberDisplay
None.
EndnoteNumberIncrement increases the endnote number by one. This command is the equivalent of choosing Layout, Endnote, New Number, Increment Number.
EndnoteNumberIncrement
None.
EndnoteNumberMethod selects an endnote numbering method. This command is the equivalent of choosing Layout, Endnote, New Number, Numbering Method, and selecting a numbering method.
EndnoteNumberMethod(Numbering Method;Character)
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 |
To specify the asterisk (*) as an endnote numbering method, the command is:
EndnoteNumberMethod(Characters!;"*")
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.
EndnoteOptionsDlg
None.
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.
EndnotePlacement(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not reset |
Yes! | 1 | Reset |
To reset endnote numbering, the command is:
EndnotePlacement(Yes!)
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.
EndnotePlacementDlg
None.
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.
EndnoteSetNumberDlg
None.
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.
EndnotesSpaceBetween(Spacing)
To specify .25" blank space between endnotes, the command is:
EndnotesSpaceBetween(.25")
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.
EndnoteStyleDlg
None.
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.
EndnoteStyleInDocDlg
None.
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.
EndOfSentenceSpacing(Spacing)
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 |
To change end of sentence spacing of single to double, the command is
EndOfSentenceSpacing(SingleToDouble!)
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.
EnterKey
None.
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.
EnvelopeAddressEnd
None.
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.
EnvelopeAddressPosition(Return Address Horizontal;Return Address Vertical;Mailing Address Horizontal;Mailing Address Vertical;Envelope Name)
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)")
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.
EnvelopeBarcode(Digits;Merge Field)
Enumerated Type | Numeric Equivalent | Description |
MergeFieldAllowed! | 1 | Merge field allowed |
To create a Bar Code for the ZIP code 12345, the command is:
EnvelopeBarcode("12345")
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.
EnvelopeBarcodePosition(Position)
Enumerated Type | Numeric Equivalent | Description |
AboveAddress! | 0 | Print above address |
BelowAddress! | 1 | Print below address |
To specify that the Barcode be printed below the address, the command is:
EnvelopeBarcodePosition(BelowAddress!)
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.
EnvelopeBarcodeSetup(Setup)
Enumerated Type | Numeric Equivalent | Description |
ManuallyCreateBarcode! | 0 | Manually create Bar Code |
AutomaticallyCreateBarcode! | 1 | Automatically create Bar Code |
RemoveBarcodeOption! | 2 | Remove Bar Code option |
To remove the POSTNET Bar Code Field from an envelope setup, the command is:
EnvelopeBarcodeSetup(RemoveBarcodeOption!)
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.
EnvelopeBegin
None.
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.
EnvelopeDlg
None.
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.
EnvelopeEnd(Type)
Enumerated Type | Numeric Equivalent | Description |
EnvelopeCancel! | 0 | Cancel |
EnvelopeClose! | 1 | Close |
EnvelopeInsert! | 2 | Insert |
EnvelopePrint! | 3 |
To print an envelope, the command is:
EnvelopeEnd(EnvelopePrint!)
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.
EnvelopeMailingAddressBegin
None.
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.
EnvelopeOmitReturnAddress(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not omit |
Yes! | 1 | Omit |
To omit a return address, the command is:
EnvelopeOmitReturnAddress(On!)
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.
EnvelopeReturnAddressBegin
None.
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.
EnvelopeSaveAddressAsDefault(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not save |
Yes! | 1 | Save |
To make a return address the default, the command is:
EnvelopeSaveAddressAsDefault(Yes!)
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.
EnvelopeSize(Envelope Name)
To select a standard 9.5" x 4.13" envelope, the command is:
EnvelopeSize("Envelope (COM 10)")
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.
EnvelopeSizeSetup(Envelope Name)
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)")
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.
EnvironmentSetupDlg
None.
It might be helpful to think of this command as the F7 key. ExitDlg will execute whatever the F7 key is designed to do in the state WordPerfect is in when the macro encounters this command: it exits the current structure (e.g. while editing a comment), the current dialog (when programmatic dialog input is enabled) or, from a document editing screen, 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.
ExitDlg
None.
The following code both displays the Exit dialog AND closes it using the ExitDlg command.
SPEED(50) // Slows action down for the effect to be seen
DLGINPUT(On!) // Allow programmatic keystrokes within dialogs
ExitDlg // F7 from editing screen: prompt to save before exiting
// Now the following is only made possible by "DLGINPUT(On!)" above:
LeftArrow // Draw attention
RightArrow
LeftArrow
RightArrow
ExitDlg // Exit from Save dialog ( = Cancel in this case)
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.
ExitWordPerfect
None.
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.
ExitWordPerfectDlg
None.
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.
ExtendedBackwardSearchDlg
None.
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.
ExtendedReplaceDlg
None.
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.
ExtendedSearchDlg
None.
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).
FastSave(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not formatted |
Yes! | 1 | Formatted |
To format a document for printing when it is saved, the command is:
FastSave(No!)
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.
Fax
None.
FaxBegin designates the beginning of the fax sending process. This command must be used in conjunction with other fax commands.
FaxBegin
None.
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
FaxDestination specifies key information about the fax recipient. This command must be used in conjunction with other fax commands.
FaxDestination(Fax Number;Voice Number;Recipient;Route;Billing)
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
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.
FaxDialOutSelect(Name)
To specify Home Office as a dial out setting, the command is:
FaxDialOutSelect("Home Office")
FaxEnd designates the end of the fax sending process. This command must be used in conjunction with other fax commands.
FaxEnd
None.
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
FaxError specifies the name of the file to which fax error messages are appended.
FaxError(Filename)
To specify FAXERROR.LOG as the fax error file, the command is:
FaxError("FAXERROR.LOG")
FaxFile specifies the characteristics of a fax file. This command must be used in conjunction with other fax commands.
FaxFile(Filename;File Mode;Delete;Resolution Mode)
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 |
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not delete the fax after sending |
Yes! | 1 | Delete the fax after sending |
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 |
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
FaxParameters specifies the coversheet and scheduling information for a fax. This command must be used in conjunction with other fax commands.
FaxParameters(Date;Time;Priority;Coversheet;Subject;From)
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
FaxRasterize converts a source document to a bitmap fax format. This command must be used in conjunction with other fax commands.
FaxRasterize(Source;Destination;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 |
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
FaxRasterizeCover creates a fax cover sheet. This command must be used in combination with other fax commands such as FaxRasterize.
FaxRasterizeCover(Source;Destination;Resolution;Recipient;Recipient Phone;Sender;Pages;Subject)
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 |
To create a fax cover, the command is:
FaxRasterizeCover("LATEST.FAX"; "COPY.FAX"; FXStandard!; "Yvonne Barrus"; "801-478-8451"; "Camille Blackburn"; "2"; "Designs")
FaxScheduleBegin designates the beginning of the fax scheduling process. This command must be used in conjunction with other fax commands.
FaxScheduleBegin
None.
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
FaxScheduleEnd designates the end of the fax scheduling process. This command must be used in conjunction with other fax commands.
FaxScheduleEnd
None.
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
FaxStatusBegin designates the beginning of a fax process. This command must be used in conjunction with other fax commands.
FaxStatusBegin
None.
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
FaxStatusEnd designates the end of a fax process. This command must be used in conjunction with other fax commands.
FaxStatusEnd
None.
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
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.
FileCopy(Source File;Destination File;Subdocs)
Enumerated Type | Numeric Equivalent | Description |
Subdocs! | 1 | Copy subdocuments |
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!)
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.
FileDelete(Filename;Subdocs)
Enumerated Type | Numeric Equivalent | Description |
Subdocs! | 1 | Delete subdocuments |
To delete a master document OLD.DOC but not its subdocuments, the command is:
FileDelete("C:\COREL\WP62\OLD.DOC")
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.
FileListDlg
None.
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.
FileManagerDlg
None.
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.
FileManagerSaveSetup
None.
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.
FileManagerSetupDlg
None.
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.
FileManagerSortBySetup(Sort)
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 |
To sort files by filename, the command is:
FileManagerSortBySetup(Filename!)
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.
FileManagerSortDescending(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not descending order |
Yes! | 1 | Descending order |
To list files in descending order, the command is:
FileManagerSortDescending(Yes!)
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.
FileManagerUseSpeedupFile(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use Speedup file |
Yes! | 1 | Use Speedup file |
To use the Descriptive Name Speedup File, the command is:
FileManagerUseSpeedupFile(Yes!)
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.
FileMoveRename(Source File;Destination File;Subdocs)
Enumerated Type | Numeric Equivalent | Description |
Subdocs! | 1 | Move subdocuments |
To move and rename OLD.DOC, the command is:
FileMoveRename("C:\WP62\OLD.DOC";"C:\WP62\DATA\NEW.DOC")
FileNew opens a new document screen. This command is the equivalent of choosing File, New.
FileNew
None.
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.
FileOpen(Filename;File Format)
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 |
To open WP.DOC, saved as a WordPerfect Corporation WordPerfect 4.2 document, the command is:
FileOpen("C:\WP42\WP.DOC";WordPerfect_42!)
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.
FileOpenAsCopy(Filename;File Format)
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 |
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!)
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.
FileOpenAsCopyDlg
None.
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.
FileOpenDlg
None.
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.
FileRetrieve(Filename;File Format)
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 |
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!)
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.
FileRetrieveDlg
None.
FileSave saves the active document, and optionally, specifies a file format. This command is the equivalent of choosing File, Save.
FileSave(Filename; File Format)
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 |
To save NEW.DOC in Corel WordPerfect 5.1 format, the command is:
FileSave("C:\COREL\WP62\NEW.DOC";WordPerfect_51/52!)
FileSaveDefaultFormat specifies the default save format. This command is the equivalent of choosing File, Save, Setup, Default Save Format, and selecting a format.
FileSaveDefaultFormat(File Format)
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 |
To set the default save format as Corel WordPerfect 5.1, the command is:
FileSaveDefaultFormat(WordPerfect_51/52!)
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.
FileSaveDlg
None.
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.
FillColors(Foreground Color;Red Value;Green Value;Blue Value;Shading Value; Background Color;Red Value;Green Value;Blue Value;Shading Value)
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)
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.
FillSetGradient(Type;Position;X Offset;Y Offset;Steps)
Enumerated Type | Numeric Equivalent | Description |
LinearGradient! | 0 | Linear |
RadialGradient! | 1 | Radial |
RectangularGradient! | 2 | Rectangular |
Enumerated Type | Numeric Equivalent | Description |
CalculateSteps! | 0 | Calculate steps |
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 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.
FillSetWPG2(Pattern Set;Pattern)
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 |
To select pattern set 0 and pattern WPG2_Arch, the command is:
FillSetWPG2(0;WPG2_Arch!)
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.
FillStyleCopy(Style;Source;Destination;Style Name)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To copy 50% Shaded Fill from the current document to the personal library, the command is:
FillStyleCopy(Fill50!;CurrentDoc!;PersonalLibrary!)
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.
FillStyleCreate(Style Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To create a style named Button Fill, the command is:
FillStyleCreate("Button Fill")
FillStyleDelete deletes a style. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Delete.
FillStyleDelete(Style Name;Source)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To delete a style named My Style, the command is:
FillStyleDelete("My Style";CurrentDoc!)
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.
FillStyleDlg
None.
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.
FillStyleEdit(Style Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To edit the fill style named My Button, the command is:
FillStyleEdit("My Button")
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.
FillStyleEditDlg
None.
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.
FillStyleEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Do not save changes |
Save! | 1 | Save changes |
To save changes after creating a new style, the command is:
FillStyleEnd(Save!)
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.
FillStyleName(New Name)
To rename a user-created fill style New Style, the command is:
FillStyleName("New Style")
FillStyleRetrieve retrieves a fill style. This command is the equivalent of choosing Graphics, Fill Styles, Retrieve, and entering the name of a style.
FillStyleRetrieve(Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To retrieve a fill style named My Style into the current document, the command is:
FillStyleRetrieve("My Style";CurrentDoc!)
FillStyleSave saves a fill style. This command is the equivalent of choosing Graphics, Fill Styles, selecting a style, Save.
FillStyleSave (Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal Library |
SharedLibrary! | 2 | Shared library |
To save a style library named MYSTYLE.STY, the command is:
FillStyleSave("C:\COREL\WP62\MYSTYLE.STY";CurrentDoc!)
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.
FirstLineIndent(Amount)
To indent the first line of each new paragraph 1.5", the command is:
FirstLineIndent(1.5")
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.
FloatingCellBegin
None.
FloatingCellCreate creates a floating cell. This command is the equivalent of choosing Layout, Tables, Create Floating Cell, OK.
FloatingCellCreate
None.
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.
FloatingCellCreateDlg
None.
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.
FloatingCellDlg
None.
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.
FloatingCellEdit
None.
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.
FloatingCellEditDlg
None.
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.
FloatingCellEnd
None.
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.
FloatingCellFormula(Formula)
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")
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.
FloatingCellNumAlignCurrency(Align)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not align symbol |
Yes! | 1 | Align symbol |
To create a floating cell that formats numbers as currency and aligns the currency symbols, the command sequence is:
FloatingCellCreate
FloatingCellNumberFormat(Currency!)
FloatingCellNumAlignCurrency(Yes!)
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.
FloatingCellNumberDateFormat(Format)
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 |
To edit a floating cell and specify the date format mm/dd/yy, the command sequence is:
FloatingCellEdit
FloatingCellNumberDateFormat(2)
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.
FloatingCellNumberDecDigits(Number)
To edit a floating cell and display two digits after the decimal point, the command sequence is:
FloatingCellEdit
FloatingCellNumberDecDigits(2)
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.
FloatingCellNumberFormat(Format)
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 |
To create a floating cell in the scientific notation format, the command sequence is:
FloatingCellCreate
FloatingCellNumberFormat(Scientific!)
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.
FloatingCellNumberNegNumber(Type)
Enumerated Type | Numeric Equivalent | Description |
Minus! | 0 | Minus sign |
Parentheses! | 1 | Parentheses |
CRDR! | 2 | Credit/Debit |
To edit a floating cell and display negative numbers in parentheses, the command sequence is:
FloatingCellEdit
FloatingCellNumberNegNumber(Parentheses!)
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.
FloatingCellNumberRound(Round)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not round numbers |
Yes! | 1 | Round numbers |
To edit a floating cell and round numbers for calculation, the command sequence is:
FloatingCellEdit
FloatingCellNumberRound(Yes!)
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.
FloatingCellNumberUseCommas(Commas)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use commas |
Yes! | 1 | Use commas |
To create a floating cell that displays numbers with commas, the command sequence is:
FloatingCellCreate
FloatingCellNumberUseCommas(Yes!)
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.
FloatingCellNumberUseCurrency(Use)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use symbol |
Yes! | 1 | Use symbol |
To create a floating cell that displays currency symbols, the command sequence is:
FloatingCellCreate
FloatingCellNumberUseCurrency(Yes!)
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.
FloatingCellNumSelectCurrency(Symbol)
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 |
To edit a cell and specify the dollar sign ($) as the currency symbol, the command sequence is:
FloatingCellEdit
FloatingCellNumSelectCurrency(Dollar!)
FlushRight aligns text against the right margin. This command is the equivalent of choosing Layout, Alignment, Flush Right.
FlushRight
None.
Font selects a font. This command is the equivalent of choosing Font, Font, and selecting a font.
Font(Name;Font Family;Attributes;Weight;Width;Source;Font Type;Character Set)
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 |
Enumerated Type | Numeric Equivalent |
FontMatchNormal! | 0 |
FontMatchItalic! | 1 |
FontMatchOutline! | 2 |
FontMatchShadow! | 4 |
FontMatchSmallCaps! | 8 |
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 |
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 |
Enumerated Type | Numeric Equivalent |
PRSFile! | 16 |
DRSFile! | 20 |
Enumerated Type | Numeric Equivalent |
Speedo! | 134 |
Intellifont! | 135 |
Type1! | 138 |
TrueType! | 139 |
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 |
To select the font named Courier 10 Roman (Speedo), the command is:
Font("Courier 10 Roman (Speedo)")
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.
FontDlg
None.
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.
FontMatchBegin
None.
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.
FontMatchEnd(State;PRS Filename;Type)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancels changes |
Save! | 1 | Saves changes |
Enumerated Type | Numeric Equivalent | Description |
PRSFile! | 16 | Printer font |
DRSFile! | 20 | Graphics font |
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 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.
FontMatchTable(Typeface;Attribute;Group;Format;Size;Type;Name;Remove)
Enumerated Type | Numeric Equivalent | Description |
PRSFile! | 16 | Printer font |
DRSFile! | 20 | Graphics font |
Enumerated Type | Numeric Equivalent | Description |
RemoveMapping! | 1 | Remove font mappings |
To match a Courier 10pt Bold font with a graphics font, the command is:
FontMatchTable("Courier";"Bold";DRSFile!;"Courier 10 Bold (Speedo)")
FontSize sets the font size of a selected font. This command is the equivalent of choosing Font, Font, Size, and entering a size.
FontSize(Point Size)
To set the font size to 14p, the command is:
FontSize(14p)
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.
FooterA(Footer;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Cancel |
Create! | 1 | Create |
Edit! | 2 | Edit |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Odd pages |
EvenPages! | 2 | Even pages |
AllPages! | 3 | All pages |
To create Footer A and print it on odd pages, the command is:
FooterA(Create!;OddPages!)
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.
FooterB(Footer;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Cancel |
Create! | 1 | Create |
Edit! | 2 | Edit |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Odd pages |
EvenPages! | 2 | Even pages |
AllPages! | 3 | All pages |
To Edit Footer B and print it on even pages, the command is:
FooterB(Edit!;EvenPages!)
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.
FooterSeparationDistance(Spacing)
To specify .5" of blank space above footers, the command is:
FooterSeparationDistance(0.5")
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.
FootnoteContinuedMessage(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No message |
Yes! | 1 | Continued message |
To print a continued message, the command is:
FootnoteContinuedMessage(Yes!)
FootnoteCreate displays a Footnote editing screen. This command is the equivalent of choosing Layout, Footnote, Create.
FootnoteCreate
None.
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.
FootnoteEdit(Footnote Number)
Parameters
To edit the third footnote of a document, the command is:
FootnoteEdit(3)
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.
FootnoteEditDlg
None.
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.
FootnoteMinimum(Amount)
To keep 1" of footnote text together, the command is:
FootnoteMinimum(1")
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.
FootnoteNewNumber(Number)
To start footnote numbering at three, the command is:
FootnoteNewNumber(3)
FootnoteNumberDecrement decreases a footnote number by one. This command is the equivalent of choosing Layout, Footnote, New Number, Decrement Number.
FootnoteNumberDecrement
None.
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.
FootnoteNumberDisplay
None.
FootnoteNumberIncrement increases a footnote number by one. This command is the equivalent of choosing Layout, Footnote, New Number, Increment Number.
FootnoteNumberIncrement
None.
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.
FootnoteNumberMethod(Numbering Method;Character Method)
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 |
To specify the asterisk (*) as the footnote numbering method, the command is:
FootnoteNumberMethod(Characters!;"*")
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.
FootnoteOptionsDlg
None.
FootnotePosition specifies where footnotes will be printed. This command is the equivalent of choosing Layout, Footnote, Options, Footnotes at Bottom of Page.
FootnotePosition(Position)
Enumerated Type | Numeric Equivalent | Description |
BottomOfPage! | 0 | Bottom of page |
AfterText! | 1 | After text |
To position footnotes at the bottom of the page, the command is:
FootnotePosition(BottomOfPage!)
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.
FootnoteRestartEachPage(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not restart |
Yes! | 1 | Restart |
To restart footnote numbering on every page, the command is:
FootnoteRestartEachPage(Yes!)
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.
FootnoteSeparatorLine(Separator Line;Space;Alignment;Width;Position)
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 |
Enumerated Type | Numeric Equivalent |
Left! | 0 |
Full! | 1 |
Center! | 2 |
Right! | 3 |
SetPosition! | 4 |
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")
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.
FootnoteSetNumberDlg
None.
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.
FootnotesSpaceBetween(Spacing)
To specify .25" blank space between footnotes, the command is:
FootnotesSpaceBetween(.25")
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.
FootnoteStyleDlg
None.
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.
FootnoteStyleInDocDlg
None.
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.
ForcePage(State)
Enumerated Type | Numeric Equivalent |
Even! | 0 |
Odd! | 1 |
New! | 2 |
To insert a blank page, forcing an even page number to odd, the command is:
ForcePage(Odd!)
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.
FormatCharacterDlg
None.
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.
FormatDlg
None.
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.
FormatDocDlg
None.
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.
FormatForDefaultPrinter(State)
Enumerated Type | Numeric Equivalent |
No! | 0 |
Yes! | 1 |
To format a document for the default printer, the command is:
FormatForDefaultPrinter(Yes!)
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.
FormatLineDlg
None.
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.
FormatMarginsDlg
None.
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.
FormatOtherDlg
None.
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.
FormatPageDlg
None.
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).
FramedWindowSetup(State)
Enumerated Type | Numeric Equivalent |
Off! | 0 |
On! | 1 |
To display a document window in a frame, the command is:
FramedWindowSetup(On!)
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.
GenerateDlg
None.
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.
GenerateDoc(State;Undo)
Enumerated Type | Numeric Equivalent | Description |
DontSave! | 0 | Don't save subdocs |
Save! | 1 | Save subdocs |
Enumerated Type | Numeric Equivalent | Description |
NoUndo! | 0 | Allow Undo is off |
Undo! | 1 | Allow Undo is active |
To generate a document, save subdocuments and disable the Allow Undo feature, the command is:
GenerateDoc(Save!;NoUndo!)
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.
GenerateUndo(Undo)
Enumerated Type | Numeric Equivalent | Description |
NoUndo! | 0 | Allow Undo is off |
Undo! | 1 | Allow Undo is active |
To disable the Allow Undo feature for all subsequent documents to be generated, the command is:
GenerateUndo(NoUndo!)
GetProfileData gets information about a document from SoftSolutions. In order to use GetProfileData, you must have SoftSolutions installed on your system.
GetProfileData
Refer to your SoftSolutions handbook for parameters.
To return the available information from SoftSolutions concerning the author and data set of the current document, the command is:
GetProfileData("%A%D")
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.
GoToDlg
None.
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.
GoToDos
None.
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.
GoToKey
None.
GoToMail executes your mail program.
GoToMail
None.
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
GoToShell
None.
The Grammatik command executes Grammatik®, a grammar checking program. This command is the equivalent of choosing Tools, Writing Tools, Grammatik.
Grammatik
None.
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.
GraphicsColorsAssign(Name;Type;Red Value;Green Value;Blue Value)
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) |
To modify a check box background color in a color scheme named My Colors, the command is:
GraphicsColorsAssign("My Colors";CheckBoxBackground!;255;207;191)
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.
GraphicsColorsCopy(Source Color Scheme Name;Target Color Scheme Name)
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")
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.
GraphicsColorsCreate(Color Scheme Name)
To create a color scheme named My Colors, the command is:
GraphicsColorsCreate("My Colors")
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.
GraphicsColorsDelete(Color Scheme Name)
To delete a color scheme named My Colors, the command is:
GraphicsColorsDelete("My Colors")
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.
GraphicsColorsSelect(Color Scheme Name)
To select a color scheme My Colors, the command is:
GraphicsColorsSelect("My Colors")
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.
GraphicsDlg
None.
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.
GraphicsFontsActivate(Type;State)
Enumerated Type | Numeric Equivalent | Description |
Speedo! | 134 | Bitstream Speedo fonts |
Bullet! | 135 | Bullet fonts |
Type1! | 138 | Type 1 fonts |
TrueType! | 139 | True Type fonts |
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not activate |
Yes! | 1 | Activate |
To deactivate the Bitstream Speedo screen fonts, the command is:
GraphicsFontsActivate(Speedo!;No!)
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.
GraphicsFontsPathsDlg
None.
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.
GraphicsFontsSelectBegin
None.
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.
GraphicsFontsSelectEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancels selections |
Save! | 1 | Saves selections |
To save font selections, the command is:
GraphicsFontsSelectEnd(Save!)
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.
GraphicsFontsSelectMarkFont(Font;Mark)
Enumerated Type | Numeric Equivalent | Description |
DRSMark! | 0 | Mark Font |
DRSUnmark! | 1 | Unmark Font |
To mark the Swiss 721 Roman (Speedo), the command is:
GraphicsFontsSelectMarkFont("Swiss 721 Roman (Speedo)";DRSMark!)
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.
GraphicsFontsUpdate
None.
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.
GraphicsLineColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)
To make the color of a graphics line red, the command is:
GraphicsLineColor("Red";255;0;0;100)
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.
GraphicsLineCreate
None.
GraphicsLineDelete deletes a graphics line. This command is the equivalent of selecting a graphics line, pressing Delete, and typing Y.
GraphicsLineDelete(Graphics Line Number)
To delete graphics line three, the command is:
GraphicsLineDelete(3)
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.
GraphicsLineDlg
None.
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.
GraphicsLineEdit(Graphics Line Number)
To edit graphics line one, the command is:
GraphicsLineEdit(1)
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.
GraphicsLineEditNext
None.
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.
GraphicsLineEditPrevious
None.
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.
GraphicsLineEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancels changes |
Save! | 1 | Saves changes |
To end a series of commands modifying a graphics line and save changes, the command is:
GraphicsLineEnd(Save!)
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.
GraphicsLineHorizontalPosition(Location;Position;Column Number)
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 |
To center a graphics line horizontally on a page, the command is:
GraphicsLineHorizontalPosition(Center!)
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.
GraphicsLineLength(Length)
To create a 2.5" graphics line, the command is:
GraphicsLineLength(2.5")
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.
GraphicsLineSpacing(Amount Above Line;Amount Below Line)
To specify .25" space above and below a graphics line, the command is:
GraphicsLineSpacing(.25";.25")
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.
GraphicsLineStyle(Style)
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 |
To create a dotted graphics line, the command is:
GraphicsLineStyle(DottedLine!)
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.
GraphicsLineThickness(Width)
Enumerated Type | Numeric Equivalent | Description |
AutoThickness! | 2 | Corel WordPerfect auto selects line thickness |
To make a graphics line .75" thick, the command is:
GraphicsLineThickness(.75")
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.
GraphicsLineType(Orientation)
Enumerated Type | Numeric Equivalent | Description |
Horizontal! | 0 | Horizontal graphics line |
Vertical! | 1 | Vertical graphics line |
To create a vertical graphics line, the command is:
GraphicsLineType(Vertical!)
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.
GraphicsLineUseColor(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use predefined line style color |
Yes! | 1 | Use predefined line style color |
To format a graphics line with the predefined line style color, the command is:
GraphicsLineUseColor(Yes!)
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.
GraphicsLineVerticalPosition(Location;Position)
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 |
To position a vertical line at the top of a page, the command is:
GraphicsLineVerticalPosition(Top!)
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.
GraphicsScreenAutoselect
None.
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.
GraphicsScreenOptionsDlg
None.
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.
GraphicsScreenSelect(Filename;General Type;Specific Type)
To select an IBM VGA 640x480 16 color screen type, the command is:
GraphicsScreenSelect("VGA.VRS";"IBM VGA";"VGA 640x480 16 Color")
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.
HardColumnBreak
None.
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.
HardPageBreak
None.
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.
HardPageBreakKey
None.
HardReturn ends a line. This command is the equivalent of pressing Enter.
HardReturn
None.
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.
HardReturnDisplayCharacter(Character)
To display a dollar sign ($) at each hard return, the command is:
HardReturnDisplayCharacter("$")
Words separated by a HardSpace command are kept together on one line. This command is the equivalent of pressing Hard Space (Home, Space Bar).
HardSpace
None.
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.
HeaderA(Header;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Cancel |
Create! | 1 | Create |
Edit! | 2 | Edit |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Odd pages |
EvenPages! | 2 | Even pages |
AllPages! | 3 | All pages |
To edit Header A and print it on even pages, the command is:
HeaderA(Edit!;EvenPages!)
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.
HeaderB(Header;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Cancel |
Create! | 1 | Create |
Edit! | 2 | Edit |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Odd pages |
EvenPages! | 2 | Even pages |
AllPages! | 3 | All pages |
To create Header B and print it on even pages, the command is:
HeaderB(Create!;EvenPages!)
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.
HeaderFooterWatermarkDlg
None.
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.
HeaderSeparationDistance(Spacing)
To specify .5" blank space below headers, the command is:
HeaderSeparationDistance(.5")
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.
Help
None.
HiddenText turns the Hidden Text option on or off. This command is the equivalent of pressing Alt+F5 and choosing Hidden Text, Hidden Text.
HiddenText(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Not hidden text |
On! | 1 | Hidden Text |
To create hidden text, the command is:
HiddenText(On!)
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.
HiddenTextDlg
None.
HiddenTextShowAll shows or hides hidden text. This command is the equivalent of pressing Alt+F5 and choosing Hidden Text, Show All Hidden Text.
HiddenTextShowAll(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Hides hidden text |
On! | 1 | Shows hidden text |
To show hidden text, the command is:
HiddenTextShowAll(On!)
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.
HomeKey
None.
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.
HorizontalBarSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Bar not displayed |
On! | 1 | Bar displayed |
To display the horizontal bar, the command is:
HorizontalBarSetup(Yes!)
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).
HorizontalBarSetupGraphics(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Horizontal scroll bar not visible |
On! | 1 | Horizontal scroll bar visible |
To allow the horizontal scroll bar to be visible while in Graphics Mode, the command is:
HorizontalBarSetupGraphics(On!)
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).
HorizontalBarSetupText(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Horizontal scroll bar not visible |
On! | 1 | Horizontal scroll bar visible |
To allow the horizontal scroll bar to be visible while in Text Mode, the command is:
HorizontalBarSetupText(On!)
Hypertext activates all hypertext links. This command is the equivalent of choosing Tools, Hypertext, Hypertext is Active.
Hypertext(State)
Enumerated Type | Numeric Equivalent | Description |
Inactive! | 0 | Hypertext not active |
Active! | 1 | Hypertext active |
To activate hypertext, the command is:
Hypertext(Active!)
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.
HypertextCreate(Hypertext Link;Document/Macro Link;Current Document Link;Hypertext Identifier)
Enumerated Type | Numeric Equivalent | Description |
GoToBookmark! | 0 | Jump to bookmark |
RunMacro! | 1 | Run macro |
Enumerated Type | Numeric Equivalent | Description |
HighlightedText! | 0 | Highlighted |
Button! | 1 | Button |
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!)
HypertextDelete deletes a hypertext link. With the cursor on the link, this command is the equivalent of choosing Tools, Hypertext, Delete Link(s).
HypertextDelete
None.
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.
HypertextDlg
None.
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.
HypertextEdit(Hypertext Link;Document/Macro Link;Current Document Link;Hypertext Identifier)
Enumerated Type | Numeric Equivalent | Description |
GoToBookmark! | 0 | Bookmark |
RunMacro! | 1 | Macro |
Enumerated Type | Numeric Equivalent | Description |
HighlightedText! | 0 | Display as highlighted text |
Button! | 1 | Display as a button |
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 jumps from a link to a bookmark, or runs a macro. This command is the equivalent of choosing Tools, Hypertext, Jump/Run.
HypertextJumpRun
None.
HypertextNext advances to the next hypertext link in a document. This command is the equivalent of choosing Tools, Hypertext, Go to Next Link.
HypertextNext
None.
HypertextPrevious returns to the previous hypertext link in a document. This command is the equivalent of choosing Tools, Hypertext, Go to Previous Link.
HypertextPrevious
None.
HypertextReturnFrom returns from a bookmark to the bookmark's hypertext link. This command is the equivalent of choosing Tools, Hypertext, Return from Jump.
HypertextReturnFrom
None.
Hyphenation determines whether to turn on hyphenation. This command is the equivalent of choosing Layout, Line, Hyphenation.
Hyphenation(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Hyphenation Off |
On! | 1 | Hyphenation On |
To turn hyphenation on, the command is:
Hyphenation(On!)
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 (/).
HyphenationIgnore
None.
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.
HyphenationPrompt(Prompt)
Enumerated Type | Numeric Equivalent | Description |
Never! | 0 | Do not prompt |
WhenRequired! | 1 | Prompt when required |
Always! | 2 | Prompt always |
To stop at each word to be hyphenated, and display the prompt "Position Hyphen; Press ESC," the command is:
HyphenationPrompt(Always!)
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.
HyphenationSoftReturn
None.
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.
HyphenationZoneLeft(Left Zone)
To set the lower limit of a hyphenation zone to 10%, the command is:
HyphenationZoneLeft(10)
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.
HyphenationZoneRight(Right Zone)
To set the upper limit of a hyphenation zone to 4%, the command is:
HyphenationZoneRight(4)
Indent indents all lines in a paragraph without changing the current margin settings. This command is the equivalent of pressing Indent (F4).
Indent
None.
IndentLeftRight indents both left and right margins of all lines in a paragraph. This command is the equivalent of pressing Indent (Shift-F4).
IndentLeftRight
None.
IndexDefinition specifies an index format. This command is the equivalent of choosing Tools, Index, Define, and selecting options.
IndexDefinition(Heading Style;Subheading Style;Numbering Mode;Combine Sequential Page Numbers;Concordance Filename;Page Number Format)
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 |
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.
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 |
Enumerated Type | Numeric Equivalent | Description |
NoCombine! | 0 | Does not combine numbers |
Combine! | 1 | Combines numbers |
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!)
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.
IndexDefinitionDlg
None.
IndexMark marks text to index. This command is the equivalent of choosing Tools, Index, Mark, and entering a heading and subheading.
IndexMark(Heading;Subheading)
To insert an index code for "Ham, baked," the command is:
IndexMark("Ham";"baked")
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.
IndexMarkDlg
None.
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.
InitialCodesDoc
None.
To change the document paper size to Letter (Landscape) in Initial Codes, the command sequence is:
InitialCodesDoc
PaperSizeSelect("Letter (Landscape)")
SubstructureExit
InitialCodesDocDlg displays the Initial Codes dialog box. This command is the equivalent of choosing Layout, Document, Document Initial Codes.
InitialCodesDocDlg
None.
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.
InitialCodesSetup
None.
To insert a LineSpacing(2.0) command in Setup Initial Codes, the command sequence is:
InitialCodesSetup
LineSpacing(2.0)
SubstructureExit
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.
InitialCodesSetupDlg
None.
InsertFilename inserts the current filename at the cursor. This command is the equivalent of choosing Layout, Other, Insert Filename, Insert Filename.
InsertFilename
None.
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.
InsertFilenameDlg
None.
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.
InsertFilenameWithPath
None.
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.
IrregularCap(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off lowercasing |
On! | 1 | Turn on lowercasing |
To lowercase the second of two initial capitals, the command is:
IrregularCap(On!)
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.
ItalicsKey
None.
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.
ItemDown
None.
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.
ItemLeft
None.
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.
ItemRight
None.
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.
ItemUp
None.
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.
Justification(Type)
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) |
To center all subsequent lines of text, the command is:
Justification(Center!)
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.
Kerning(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turns kerning off |
On! | 1 | Turns kerning on |
To turn kerning on, the command is:
Kerning(On!)
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.
KeyboardCopy(From;To)
To copy a keyboard file named MYKEYBRD to a file named NEWKYBRD, the command is:
KeyboardCopy("MYKEYBRD";"NEWKYBRD")
KeyboardCreate creates a keyboard file. This command is the equivalent of choosing File, Setup, Keyboard Layout, Create, and entering a name.
KeyboardCreate(Filename)
To create a keyboard file named MYKEYBRD, the command is:
KeyboardCreate("MYKEYBRD")
KeyboardDelete deletes a keyboard file. This command is the equivalent of choosing File, Setup, Keyboard Layout, selecting a layout, and choosing Delete.
KeyboardDelete(Filename)
To delete a keyboard file named MYKEYBRD, the command is:
KeyboardDelete("MYKEYBRD")
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.
KeyboardLayoutDlg
None.
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.
KeyboardOriginal(Equation)
Enumerated Type | Numeric Equivalent | Description |
Equation! | 4 | Equation Editor keyboard |
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!)
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.
KeyboardRename(From;To)
To rename a keyboard file named MYKEYBRD to NEWKYBRD, the command is:
KeyboardRename("MYKEYBRD";"NEWKYBRD")
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.
KeyboardSelect(Filename;Equation)
Enumerated Type | Numeric Equivalent | Description |
Equation! | 4 | Equation Editor keyboard |
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!)
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.
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)
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 |
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")
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.
LabelsDelete(Filename;Labels Name)
To delete a labels definition named My Labels, the command is:
LabelsDelete("WP_WP_US.LAB";"My Labels")
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.
LabelsDisplay(Label Type)
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 |
To display only tractor-fed labels in the Labels dialog box, the command is:
LabelsDisplay(TractorFed!)
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.
LabelsDlg
None.
LabelsFileCreate creates a labels file. This command is the equivalent of choosing Layout, Page, Labels, Label File, Create, and entering a filename.
LabelsFileCreate(Filename)
To create a labels file named CUSTOM.LAB in the C:\COREL\WP62 directory, the command is:
LabelsFileCreate("C:\COREL\WP62\CUSTOM.LAB")
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.
LabelsFileDescription(Filename;Description)
To add the description Label Library to a labels file named CUSTOM.LAB, the command is:
LabelsFileDescription("C:\COREL\WP62\CUSTOM.LAB";"Label Library")
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.
LabelsFileSelect(Filename)
To select a labels file named CUSTOM.LAB, the command is:
LabelsFileSelect("C:\COREL\WP62\CUSTOM.LAB")
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.
LabelsOff
None.
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.
LabelsSelect(Filename;Labels Name)
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 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.
Language(Language Code)
To specify Spanish as the language of a section of text, the command is:
Language("ES")
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.
LanguageSelectDlg
None.
Leading specifies leading adjustment. This command is the equivalent of choosing Layout, Other, Printer Functions, Leading Adjustment, and specifying a leading adjustment.
Leading(Amount)
To specify a leading adjustment of 0.1", the command is:
Leading(0.1")
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.
LeaveBlockOn(State)
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. |
To turn on the Leave Block On After Block Operation feature, the command is:
LeaveBlockOn(Yes!)
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.
LeftArrow
None.
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.
LineCreateDlg
None.
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.
LineDrawArrow(Key)
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. |
To draw a line from the cursor position to the right margin, the command is:
LineDrawArrow(HomeHomeRightArrow!)
or
LineDrawArrow(152)
LineDrawChange specifies a line draw character. This command is the equivalent of choosing Graphics, Line Draw, and selecting a line draw character.
LineDrawChange(Mode;Type)
Enumerated Type | Numeric Equivalent | Description |
ModeInsert! | 0 | Insert Mode |
ModeMove! | 2 | Cursor can move without drawing a line |
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 |
To draw a double line using Line Draw, the command is:
LineDrawChange(ModeInsert!;DoubleLine!)
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.
LineDrawDlg
None.
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.
LineDrawSolidCharacter(Character)
To specify the pound sign as a line draw character, the command is:
LineDrawSolidCharacter("#")
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.
LineEditDlg
None.
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.
LineHeight(Height)
Enumerated Type | Numeric Equivalent | Description |
Auto! | 0 | Corel WordPerfect auto-selects line height |
To specify a line height of .275", the command is:
LineHeight(.275")
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
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})
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Line Numbering Off |
On! | 1 | Line Numbering On |
Enumerated Type | Numeric Equivalent |
DontRestartNumbersEachPage! | 0 |
RestartNumbersEachPage! | 1 |
Enumerated Type | Numeric Equivalent |
DontCountBlankLines! | 0 |
CountBlankLines! | 1 |
Enumerated Type | Numeric Equivalent |
DontNumberAllNewspaperColumns! | 0 |
NumberAllNewspaperColumns! | 1 |
Enumerated Type | Numeric Equivalent |
PosNumberFromLeftEdgeOfPage! | 0 |
PosNumberFromLeftMargin | 1 |
Enumerated Type | Numeric Equivalent |
UseDefaultValues! | 0 |
DontUseDefaultValues! | 1 |
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 |
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})
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.
LineNumberingDlg
None.
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.
LineNumberingMethod(Numbering Method)
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 |
To specify uppercase letters as the Line Numbering method, the command is:
LineNumberingMethod(UpperLetters!)
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.
LineNumberSet(Starting Number)
To specify 5 as the beginning line number, the command is:
LineNumberSet(5)
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.
LineSegmentColor(Color;Red Value;Green Value;Blue Value;Shading Value)
To specify a blue line segment, the command is:
LineSegmentColor("Blue";0;0;255;100)
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.
LineSegmentCreate(Position)
To stack a line in the first (inside) position, the command is:
LineSegmentCreate(0)
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.
LineSegmentDelete(Position)
To delete an inside stacked line of a border, the command is:
LineSegmentDelete(0)
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.
LineSegmentEdit(Position)
To edit an inside stacked line, the command is:
LineSegmentEdit(0)
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.
LineSegmentEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Don't save changes |
Save! | 1 | Save changes |
To save changes made to a line segment, the command is:
LineSegmentEnd(Save!)
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.
LineSegmentSetUser(Dash/Space)
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
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.
LineSegmentSetUserData(Length)
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
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.
LineSegmentSetUserEnd
None.
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.
LineSegmentSetWPG2(Pattern Set;Line Pattern Number)
Number | Line Pattern |
0 | ——— |
1 | — — |
2 | – – – |
3 | - - - - |
4 | -------- |
5 | ................ |
6 | . . . . . . . . |
7 | . . . . . . . |
8 | — · — · |
9 | — · · — · · — |
10 | — — · — — |
11 | — — · · — — · |
12 | —— — —— — |
13 | —— -- —— — |
14 | — — |
15 | — — |
To specify the dash-dot line pattern, the command sequence is:
LineSegmentEdit(0)
LineSegmentSetWPG2(0;8)
LineSegmentEnd(Save!)
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.
LineSegmentSpacing(Distance)
To set the distance between line segments at 0.5", the command is:
LineSegmentSpacing(0.5")
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.
LineSegmentWidth(Width)
To set the width of a line segment at 0.2", the command is:
LineSegmentWidth(0.2")
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.
LineSpacing(Spacing)
To specify single-spaced line spacing, the command is:
LineSpacing(1.0)
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.
LineStyleCopy(Line;Source Library;Recipient Library;New Name)
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 |
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 |
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 |
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")
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.
LineStyleCreate(Name;Source)
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 |
To create a line style named Custom in the current document, the command is:
LineStyleCreate("Custom";CurrentDoc!)
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.
LineStyleDelete(Style Name;Source)
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 |
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 |
To delete a line style named Custom from the personal library, the command is:
LineStyleDelete("Custom";PersonalLibrary!)
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.
LineStyleDlg
None.
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.
LineStyleEdit(Line;Source)
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 |
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 |
To edit the Thick Line style located in the shared library, the command is:
LineStyleEdit(ThickLine!;SharedLibrary!)
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.
LineStyleEditDlg
None.
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.
LineStyleEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To save line style changes, the command is:
LineStyleEnd(Save!)
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.
LineStyleName(Name)
To rename the current line style to Custom, the command is:
LineStyleName("Custom")
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.
LineStyleRetrieve(Filename;Library)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Retrieve current document's library |
PersonalLibrary! | 1 | Retrieve personal library |
SharedLibrary! | 2 | Retrieve shared library |
To retrieve a line style library named CUSTOMLN from the personal library, the command is:
LineStyleRetrieve("CUSTOMLN";PersonalLibrary!)
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.
LineStyleSave(Filename;Library)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Save current document's library |
PersonalLibrary! | 1 | Save personal library |
SharedLibrary! | 2 | Save shared library |
To save a current document line style library with the filename CURRENT, the command is:
LineStyleSave("CURRENT";CurrentDoc!)
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.
ListDefinition(Name)
To select a list definition named Subject List, the command is:
ListDefinition("Subject List")
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.
ListDefinitionCreate(Name;List Style;Numbering Mode;Graphics;Page Numbering)
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 |
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 |
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 |
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 #]")
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.
ListDefinitionDelete(Name)
To delete a list definition named Old List, the command is:
ListDefinitionDelete("Old List")
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.
ListDefinitionDlg
None.
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.
ListDefinitionEditBox(Name;Graphics)
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 |
To change a list definition named List 1 to include figure boxes, the command is:
ListDefinitionEditBox("List 1";FigureCounter!)
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.
ListDefinitionMode(Name;Numbering Mode)
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 |
To change the numbering mode to flush right in a list definition named List 2, the command is:
ListDefinitionMode("List 2";DefFlushRight!)
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.
ListDefinitionRename(Name;New Name)
To rename a list definition named List 1 to List One, the command is:
ListDefinitionRename("List 1";"List One")
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.
ListDefinitionRetrieve(Filename;List Name)
To retrieve a list definition named List One from a document named MYFILE, the command is:
ListDefinitionRetrieve("MYFILE";"List One")
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.
ListDefinitionStyle(Name;New Style)
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 |
To change the list style to Index 2 for a list definition named List One, the command is:
ListDefinitionStyle("List One";Index2Style!)
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.
ListEditPageFormat(Name;Page Numbering)
Enumerated Type | Numeric Equivalent | Description |
DocFormat! | 0 | Same page numbering style as in document |
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!)
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.
ListKey
None.
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.
ListMark(List Name)
To mark selected text to be added to a list named List One, the command is:
ListMark("List One")
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.
ListMarkDlg
None.
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.
LocationOfBackupFiles(Path)
To specify C:\COREL\WP62\BACKUP as the directory where backup files are saved, the command is:
LocationOfBackupFiles("C:\COREL\WP62\BACKUP")
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.
LocationOfDocFiles(Path)
To specify C:\COREL\WP62\DOCS as a directory where documents are saved, the command is:
LocationOfDocFiles("C:\COREL\WP62\DOCS")
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.
LocationOfDRSFile(Path)
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")
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.
LocationOfFilesDlg
None.
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.
LocationOfGraphicsFiles(Path)
To specify C:\COREL\WP62\GRAPHICS as the graphics files (*.WPG) directory, the command is:
LocationOfGraphicsFiles("C:\COREL\WP62\GRAPHICS")
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.
LocationOfGraphicsFontsFiles(Type;Path)
Enumerated Type | Numeric Equivalent | Description |
Speedo! | 134 | Bitstream Speedo fonts |
Bullet! | 135 | Bullet fonts |
Type1! | 138 | Type 1 fonts |
TrueType! | 139 | True Type fonts |
To change the path for the available Bitstream Speedo screen fonts to C:\PRINT\FONTS, the command is:
LocationOfGraphicsFontsFiles(Speedo!;"C:\PRINT\FONTS")
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.
LocationOfMacroKeyboardFiles(Path)
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")
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.
LocationOfPrinterFiles(Path)
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")
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.
LocationOfQuickFinderFiles(Path)
To specify C:\COREL\WP62\INDEX as the directory where QuickFinder Index files are located, the command is:
LocationOfQuickFinderFiles("C:\COREL\WP62\INDEX")
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.
LocationOfSharedGraphicsFiles(Path)
To specify F:\WP60\GRAPHICS as the directory for graphics files (*.WPG), the command is:
LocationOfSharedGraphicsFiles("F:\WP60\GRAPHICS")
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.
LocationOfSharedMacroKbdFiles(Path)
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")
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.
LocationOfSharedPrinterFiles(Path)
To specify F:\WP60\PRINT as the printer files (*.PRS and *.ALL) directory, the command is:
LocationOfSharedPrinterFiles("F:\WP60\PRINT")
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.
LocationOfSharedQFinderFiles(Path)
To specify F:\WP60\INDEX as the QuickFinder Index files directory, the command is:
LocationOfSharedQFinderFiles("F:\WP60\INDEX")
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.
LocationOfSharedSprFiles(Path)
To specify F:\WP60\SPR as a spreadsheet files directory, the command is:
LocationOfSharedSprFiles("F:\WP60\SPR")
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.
LocationOfSharedStyleFiles(Directory)
To specify a directory named LIBS on the W: drive as the default shared style library directory, the command is:
LocationOfSharedStyleFiles("W:\LIBS")
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.
LocationOfSharedTemplateFiles(Path)
To specify C:\WP62\TEMPLATES as the directory where shared template files are stored and saved, the command is:
LocationOfSharedTemplateFiles("C:\WP62\TEMPLATES")
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.
LocationOfSprFiles(Location)
To specify C:\SPREADSH as the location for spreadsheet files, the command is:
LocationOfSprFiles("C:\SPREADSH")
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.
LocationOfStyleFiles(Directory)
To specify a directory named LIBS on the C: drive as the default personal style library directory, the command is:
LocationOfStyleFiles("C:\LIBS")
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.
LocationOfSupWritingTools(Location)
To specify the location C:\COREL\WP62\SPELL for supplementary speller files, the command is:
LocationOfSupWritingTools("C:\COREL\WP62\SPELL")
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.
LocationOfTemplateFiles(Path)
To specify C:\COREL\WP62\TEMPLATES as the directory where personal template files are saved, the command is:
LocationOfTemplateFiles("C:|COREL\WP62\TEMPLATES")
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.
LocationOfWritingTools(Location)
To specify the location C:\COREL\WP62\SPELL for speller files, the command is:
LocationOfWritingTools("C:\COREL\WP62\SPELL")
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.
MacroAssignVariableDlg
None.
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.
MacroCommandsDlg
None.
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.
MacroControlDlg
None.
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.
MacroPlayDlg
None.
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.
MacroRecordDlg
None.
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.
MakeItFit(Pages;{Adjust;Adjust...;})
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 |
To fit the current document on two pages by adjusting the font size and line spacing, the command is:
MakeItFit(2;{AdjustFont!;AdjustLineSpacing!})
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.
MakeItFitDlg
None.
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.
MarginAdjustLeft(Adjustment)
To adjust the left margin .5" to the right, the command is:
MarginAdjustLeft(.5")
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.
MarginAdjustRight(Adjustment)
To make the right margin .5" smaller, the command is:
MarginAdjustRight(-.5")
MarginBottom sets the bottom margin. This command is the equivalent of choosing Layout, Margins, Bottom Margin, and specifying a measurement.
MarginBottom(Margin Setting)
To set the bottom margin 1" from the bottom edge of the page, the command is:
MarginBottom(1")
MarginLeft sets the left margin. This command is the equivalent of choosing Layout, Margins, Left Margin, and specifying a measurement.
MarginLeft(Margin Setting)
To set the left margin 1" from the left edge of the page, the command is:
MarginLeft(1")
MarginRight sets the right margin. This command is the equivalent of choosing Layout, Margins, Right Margin, and specifying a measurement.
MarginRight(Margin Setting)
To set the right margin 1" from the right edge of the page, the command is:
MarginRight(1")
MarginTop sets the top margin. This command is the equivalent of choosing Layout, Margins, Top Margin, and specifying a measurement.
MarginTop(Margin Setting)
To set the top margin 1.5" from the top edge of the page, the command is:
MarginTop(1.5")
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.
MarkTextDlg
None.
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.
MasterDocCondense(Subdoc;Save File)
Enumerated Type | Numeric Equivalent | Description |
SkipSub! | 0 | Do not save changes |
SaveSub! | 2 | Save changes |
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!)
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.
MasterDocCondenseDlg
None.
MasterDocExpand specifies a subdocument to expand. This command is the equivalent of choosing File, Master Document, Expand, and selecting a subdocument.
MasterDocExpand(Subdoc)
To expand a subdocument named SUB1.DOC, the command is:
MasterDocExpand("SUB1.DOC")
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.
MasterDocExpandDlg
None.
Math determines whether the Math feature is on. This command is the equivalent of choosing Tools, Math, On or Off.
Math(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Math off |
On! | 1 | Math on |
To turn on math, the command is:
Math(On!)
MathCalculate calculates the results of a Math document. This command is the equivalent of choosing Tools, Math, Calculate.
MathCalculate
None.
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.
MathColumn(Column Number;Column Type;Negative Numbers;Digits;Formula)
Enumerated Type | Numeric Equivalent | Description |
MathText! | 1 | Text |
MathNumeric! | 2 | Numeric |
MathTotal! | 3 | Total |
MathCalculate! | 4 | Calculate |
Enumerated Type | Numeric Equivalent | Description |
MinusSign! | 0 | Minus sign |
Parentheses! | 1 | Parentheses |
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")
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.
MathDefinitionDlg
None.
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.
MathDefinitionEnd
None.
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.
MathDefinitionStart
None.
MenuBarRemainsVisible determines whether to display pull-down menus. With pull-down Menus displayed, this command is the equivalent of choosing View, Pull-Down Menus.
MenuBarRemainsVisible(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not displayed |
Yes! | 1 | Displayed |
To display pull-down menus, the command is:
MenuBarRemainsVisible(Yes!)
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.
MergeBlankField(State)
Enumerated Type | Numeric Equivalent | Description |
Leave! | 0 | Leave field |
Remove! | 1 | Remove field |
To remove a blank field, the command is:
MergeBlankField(Remove!)
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.
MergeCode(Code Name;Code Parameters)
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 |
To insert a merge code named FieldNames! with name, address and telephone parameters, the command is:
MergeCode(FieldNames!;"name;address;city/state/zip;phone")
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.
MergeCodesDisplayEdit(Type)
Enumerated Type | Numeric Equivalent | Description |
Hide! | 0 | Hide codes |
Show! | 1 | Show codes |
Icon! | 2 | Display as Icons |
To hide merge codes, the command is:
MergeCodesDisplayEdit(Hide!)
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.
MergeCodesDisplayRun(Type)
Enumerated Type | Numeric Equivalent | Description |
Hide! | 0 | Hide codes |
Show! | 1 | Show codes |
Icon! | 2 | Display as Icons |
To show merge codes, the command is:
MergeCodesDisplayRun(Show!)
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.
MergeCodesDisplaySetup(Type)
Enumerated Type | Numeric Equivalent | Description |
Hide! | 0 | Hide codes |
Show! | 1 | Show codes |
Icon! | 2 | Display as Icons |
To display merge codes as icons, the command is:
MergeCodesDisplaySetup(Icon!)
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.
MergeCodesDlg
None.
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.
MergeCodesListDlg
None.
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.
MergeCondition(Field Names;Field Data)
This command can contain 1-3 occurrences of the Field Name parameter and 1-12 occurrences of the Field Data parameter.
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 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.
MergeDataFile(Name)
To specify a file named MYLIST as the data file from which to list fields, the command is:
MergeDataFile("MYLIST")
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.)
MergeEnvelope(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | No envelope created |
On! | 1 | Create envelope |
To create a merge envelope, the command is:
MergeEnvelope(On!)
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.)
MergeEnvelopeDefinitionBegin
None.
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.)
MergeEnvelopeDefinitionEnd
None.
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.
MergeFieldDelimiter(State;Delimiter)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Off |
Yes! | 1 | On |
To specify the Tab code followed by Hard Return as the field delimiter, the command is:
MergeFieldDelimiter(Yes!;"[TAB]"+"")
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.
MergeFieldEncapsulateCharacter(State;Encapsulate Character)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Off |
Yes! | 1 | On |
To use the pound sign (#) to mark protected data, the command is:
MergeFieldEncapsulateCharacter(Yes!;"#")
MergeFileAssociate associates form and data files. This command is the equivalent of choosing Tools, Merge, Run, and typing Form and Data filenames.
MergeFileAssociate(Form File;Data File)
To associate C:\WP62\DOC1 and C:\WP62\DOC2, the command is:
MergeFileAssociate("C:\WP62\DOC1";"C:\WP62\DOC2")
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.
MergeFileType(File Type)
Enumerated Type | Numeric Equivalent | Description |
None! | 0 | No merge document |
Form! | 1 | Form |
TableData! | 2 | Table data |
TextData! | 4 | Text data |
To create a Form document, the command is:
MergeFileType(Form!)
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.
MergeMark(Record Number)
To mark records 7, 10, and 25 for merging, the command sequence is:
MergeMark(0)
MergeMark(7)
MergeMark(10)
MergeMark(25)
MergeSelect(Marked!)
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.
MergePageBreak(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | No page break |
On! | 1 | Page break |
To create a page break between merged records, the command is:
MergePageBreak(On!)
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.
MergePrintText
None.
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.
MergeRecordDelimiter(State;Delimiter)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Off |
Yes! | 1 | On |
To specify Carriage Return and Line Feed as the record delimiter, the command is:
MergeRecordDelimiter(Yes!;"[CR]"+"[LF]")
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.
MergeRepeat(Repeat)
To merge a data record 3 times, the command is:
MergeRepeat(3)
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.
MergeRun(Primary File;Form File Name;Secondary File;Data File Name;Output Location;Output Filename)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
Clipboard! | 1 | Clipboard |
FormFile! | 2 | Form |
Enumerated Type | Numeric Equivalent | Description |
NoData! | 0 | No data |
Clipboard! | 1 | Clipboard |
DataFile! | 2 | Data file |
Enumerated Type | Numeric Equivalent | Description |
ToCurrentDoc! | 0 | To current document |
ToNewDoc! | 1 | To new document |
ToFile! | 2 | To file |
ToPrinter! | 3 | To printer |
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 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.
MergeRunDlg
None.
MergeSelect identifies records to merge. This command is the equivalent of choosing Tools, Merge, Run, Data Record Selection, and selecting options.
MergeSelect(Records;Low Range;High Range)
Enumerated Type | Numeric Equivalent | Description |
All! | 0 | All records |
Marked! | 1 | Marked records |
Range! | 2 | Range of records |
To merge records 10 through 50, the command is:
MergeSelect(Range!;10;50)
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.
MergeSortDlg
None.
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.
MergeStripCharacters(State;Strip)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Off |
Yes! | 1 | On |
To use an asterisk (*) to identify characters to strip from a data file, the command is:
MergeStripCharacters(Yes!;"*")
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.
MinusSign
None.
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.
MouseAccelerationFactor(Acceleration Factor)
To set the acceleration factor to fast, the command is:
MouseAccelerationFactor(100)
MouseAutoselect automatically selects the mouse driver. This command is the equivalent of choosing File, Setup, Mouse, Type, Auto Select.
MouseAutoselect
None.
MouseDoubleClick sets the double-click interval. This command is the equivalent of choosing File, Setup, Mouse, Double-click Interval, and specifying an interval.
MouseDoubleClick(Interval)
To set the double-click interval to one-half second, the command is:
MouseDoubleClick(50)
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.
MouseInitialize
None.
To initialize a PS/2 Logitech mouse, the command is:
MouseSelect("STANDARD.IRS";"Logitech Mouse (PS/2)")
MouseInitialize
SetupSave
MouseLeftHanded turns on or off Left-handed Mouse. This command is the equivalent of choosing File, Setup, Mouse, Left-handed Mouse.
MouseLeftHanded(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not left-handed |
Yes! | 1 | Left handed |
To set a mouse to left-handed, the command is:
MouseLeftHanded(Yes!)
MousePort selects a mouse port. This command is the equivalent of choosing File, Setup, Mouse, Port, and selecting an option.
MousePort(Port)
Numeric Expression | Description |
0 | COM port 1 |
1 | COM port 2 |
To select COM port 1, the command is:
MousePort(0)
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.
MouseSelect(Type;Name)
To select a standard Microsoft serial mouse, the command is:
MouseSelect("STANDARD.IRS";"Microsoft Mouse (Serial)")
MouseInitialize
SetupSave
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.
MouseSetupDlg
None.
MouseUnselect changes the current mouse selection to None. This command is not recordable. To use this command, you must type it into the macro.
MouseUnselect
None.
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.
MoveDlg
None.
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).
MoveModeCancel
None.
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.
MoveModeEnd
None.
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.
NotesDlg
None.
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.
OutlineBarSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Outline bar not displayed |
On! | 1 | Outline bar displayed |
To display the Outline Bar, the command is:
OutlineBarSetup(On!)
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.
OutlineBeginNew(Style Name)
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 |
To create a bullets style outline, the command is:
OutlineBeginNew(BulletsOutlnStyle!)
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.
OutlineBeginNewDlg
None.
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.
OutlineBodyText(State)
Enumerated Type | Numeric Equivalent | Description |
ShowBodyText! | 0 | Shows body text |
HideBodyText! | 1 | Hides body text |
To hide outline body text, the command is:
OutlineBodyText(HideBodyText!)
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.
OutlineBottom
None.
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.
OutlineChangeToBodyText
None.
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.
OutlineDlg
None.
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.
OutlineDown
None.
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.
OutlineEditKey
None.
OutlineEnd turns off the outline feature. This command is the equivalent of choosing Tools, Outline, End Outline.
OutlineEnd
None.
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.
OutlineFamilyCopy
None.
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.
OutlineFamilyCut
None.
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.
OutlineFamilyDemote
None.
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.
OutlineFamilyDown
None.
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.
OutlineFamilyDragDown
None.
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.
OutlineFamilyDragUp
None.
OutlineFamilyHide hides the current outline family. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Hide Family.
OutlineFamilyHide(State)
Enumerated Type | Numeric Equivalent | Description |
ShowBodyText! | 0 | Shows outline family |
HideBodyText! | 1 | Hides outline family |
To hide an outline family, the command is:
OutlineFamilyHide(HideBodyText!)
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.
OutlineFamilyLeft
None.
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.
OutlineFamilyMove
None.
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.
OutlineFamilyPromote
None.
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.
OutlineFamilyRight
None.
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.
OutlineFamilySelect
None.
OutlineFamilyShow displays a hidden outline family. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Show Family.
OutlineFamilyShow(State)
Enumerated Type | Numeric Equivalent | Description |
ShowBodyText! | 0 | Shows outline family |
HideBodyText! | 1 | Hides outline family |
To show a previously hidden outline family, the command is:
OutlineFamilyShow(ShowBodyText!)
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.
OutlineFamilyUp
None.
OutlineHideShowingBodyText hides an outline but leaves body text showing. This command is the equivalent of choosing Tools, Outline, Outline Options, Hide/Show, Hide Outline.
OutlineHideShowingBodyText
None.
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.
OutlineNumberToggleKey
None.
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.
OutlineParagraphCopy
None.
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.
OutlineParagraphDelete
None.
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.
OutlineParagraphDemote
None.
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.
OutlineParagraphDragDown
None.
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.
OutlineParagraphDragUp
None.
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.
OutlineParagraphMove
None.
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.
OutlineParagraphNumber(Level)
To adjust an outline paragraph to level 3, the command is:
OutlineParagraphNumber(3)
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.
OutlineParagraphNumberDrag
None.
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.
OutlineParagraphPromote
None.
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.
OutlineParagraphSelect
None.
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.
OutlineRight
None.
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.
OutlineSetParagraphNumber(Number)
To set an outline paragraph number as 5, the command is:
OutlineSetParagraphNumber("5")
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.
OutlineShow(Level;State)
Enumerated Type | Numeric Equivalent | Description |
ShowBodyText! | 0 | Shows body text |
HideBodyText! | 1 | Hides body text |
To show outline levels 1 through 3 and hide the body text, the command is:
OutlineShow(3;HideBodyText!)
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.
OutlineStyleCopy(Style Name;Current Location;Destination;Rename)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To copy an outline style named Bullets from the current document to the current personal library, the command is:
OutlineStyleCopy(BulletsOutlnStyle!;CurrentDoc!;PersonalLibrary!)
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.
OutlineStyleCreate(Name;Location)
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To create an outline style named My Style and save it in a shared library, the command is:
OutlineStyleCreate("My Style";Shared Library!)
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.
OutlineStyleDelete(Style Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To delete an outline style named My Style from a shared library, the command is:
OutlineStyleDelete("My Style";SharedLibrary!)
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.
OutlineStyleDescription(Description)
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!)
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.
OutlineStyleDlg
None.
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.
OutlineStyleEditBegin(Style Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To edit an outline style named Bullets in the current document, the command is:
OutlineStyleEditBegin(BulletsOutlnStyle!;CurrentDoc!)
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.
OutlineStyleEditEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancels style changes |
Save! | 1 | Saves style changes |
To save outline style changes, the command is:
OutlineStyleEditEnd(Save!)
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.
OutlineStyleLevel(Level;Style Name)
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 |
To apply a style named Heading 1 to outline level 3, the command is:
OutlineStyleLevel(3;Heading1Style!)
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.
OutlineStyleNumberFormat(Level;Format)
To specify paragraph numbering style for level 1, the command is:
OutlineStyleNumberFormat(1;"1.")
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.
OutlineStyleNumbersOnly(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Numbers only format off |
Yes! | 1 | Numbers only format on |
To specify the Numbers Only format for a style named My Style, the command sequence is:
OutlineStyleEditBegin("My Style";PersonalLibrary!)
OutlineStyleNumbersOnly(Yes!)
OutlineStyleEditEnd(Save!)
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.
OutlineStyleRename(New Name)
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!)
OutlineStyleRetrieve retrieves an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, Retrieve, entering a style name, and selecting options.
OutlineStyleRetrieve(Name;Type;Location)
Enumerated Type | Numeric Equivalent | Description |
UserStyles! | 1 | Retrieves only user styles |
SystemStyles! | 2 | Retrieves only system styles |
AllStyles! | 3 | Retrieves all style types |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To retrieve a user-created outline style named My Style from the current personal library, the command is:
OutlineStyleRetrieve("My Style";UserStyles!;PersonalLibrary!)
OutlineStyleSave saves an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, Save, entering a style name, and selecting options.
OutlineStyleSave(Name;Type;Location)
Enumerated Type | Numeric Equivalent | Description |
UserStyles! | 1 | Saves only user styles |
SystemStyles! | 2 | Saves only system styles |
AllStyles! | 3 | Saves all style types |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To save a Corel WordPerfect system outline style named Numbers in the current shared library, the command is:
OutlineStyleSave("Numbers";SystemStyles!;SharedLibrary!)
OutlineStyleSelect selects an outline style. This command is the equivalent of choosing Tools, Outline, Outline Style, highlighting an outline style, Select.
OutlineStyleSelect(Name)
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 |
To select the Bullets outline style, the command is:
OutlineStyleSelect(BulletsOutlnStyle!)
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.
OutlineTop
None.
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.
OutlineUp
None.
OutputOption specifies a printer output type. This command is the equivalent of choosing File, Print/Fax, Output Options, and selecting options.
OutputOption(Type;Bins)
Enumerated Type | Numeric Equivalent | Description |
OutputToSort! | 1 | Sorting on |
OutputToPutGroup! | 2 | Grouping on |
OutputToBins! | 16 | Output to bins |
OutputPutNone! | 64 | No special options |
To sort output into bins 1 and 2, the command is:
OutputOption(OutputToSort!;1;2)
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.
OutputOptionsOffsetJogger(State)
Enumerated Type | Numeric Equivalent | Description |
JoggerOn! | 8 | Offset Jogger On |
JoggerOff! | 10 | Offset Jogger Off |
To activate the Offset Jogger option in the Output Options dialog box, the command is:
OutputOptionsOffsetJogger(JoggerOn!)
OverstrikeCreate creates an overstrike. This command is the equivalent of choosing Layout, Character, Create Overstrike, and specifying the characters to overstrike.
OverstrikeCreate(Characters)
To overstrike characters = and \, the command is:
OverstrikeCreate("=\")
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.
OverstrikeCreateDlg
None.
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.
OverstrikeEdit(Characters)
To replace an existing overstrike with characters x, y, and z, the command is:
OverstrikeEdit("xyz")
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.
OverstrikeEditDlg
None.
PageDown is the equivalent of pressing Page Down. This command is not recordable. To use this command, you must type it into the macro.
PageDown
None.
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.
PageNumber(New Number)
To change the current page number of a page to 5, the command is:
PageNumber(5)
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.
PageNumberDecrement
None.
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.
PageNumberDisplay
None.
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.
PageNumberDisplayFormat
None.
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.
PageNumberFormat(Format)
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 #]")
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.
PageNumberIncrement
None.
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.
PageNumberingDlg
None.
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.
PageNumberMethod(Method)
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 |
To specify uppercase roman numerals as the page numbering method, the command is:
PageNumberMethod(UpperRoman!)
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.
PageNumberPosition(Position;Values;Font;Point Size;Red Value;Green Value;Blue Value;Shading Value;{Attributes})
Enumerated Type | Numeric Equivalent |
None! | 0 |
TopLeft! | 1 |
TopCenter! | 2 |
TopRight! | 3 |
TopAlternating! | 4 |
BottomLeft! | 5 |
BottomCenter! | 6 |
BottomRight! | 7 |
BottomAlternating! | 8 |
Enumerated Type | Numeric Equivalent |
UseDefaultValues! | 0 |
DontUseDefaultValues! | 1 |
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 |
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 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.
PageSuppressDlg
None.
PageUp is the equivalent of pressing Page Up. This command is not recordable. To use this command, you must type it into the macro.
PageUp
None.
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.
PaperSize(Name;Type;Width;Height;Location;Prompt;Orientation;Vertical Adjustment Direction;Vertical Adjustment Amount;Horizontal Adjustment Direction;Horizontal Adjustment Amount)
Enumerated Type | Numeric Equivalent |
Standard! | 1 |
Bond! | 2 |
Letterhead! | 3 |
Labels! | 4 |
Envelope! | 5 |
Transparency! | 6 |
Cardstock! | 7 |
Glossy! | 8 |
Special! | 9 |
Other! | 255 |
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 |
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Don't prompt to load |
Yes! | 1 | Prompt to load |
Enumerated Type | Numeric Equivalent |
PortraitFont! | 0 |
WideFormLandscapeFont! | 1 |
LandscapeFont! | 2 |
WideFormPortraitFont! | 3 |
Enumerated Type | Numeric Equivalent |
Down! | 0 |
Up! | 1 |
Enumerated Type | Numeric Equivalent |
Left! | 0 |
Right! | 3 |
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 deletes a paper size/type. This command is the equivalent of choosing Layout, Page, Paper Size/Type, highlighting a paper name, Delete.
PaperSizeDelete(Name)
To delete a paper size/type named Scratch Paper, the command is:
PaperSizeDelete("Scratch Paper")
PaperSizeSelect selects a paper size/type. This command is the equivalent of choosing Layout, Page, Paper Size/Type, highlighting a paper name, Select.
PaperSizeSelect(Name;Width;Height;Type)
Enumerated Type | Numeric Equivalent |
Standard! | 1 |
Bond! | 2 |
Letterhead! | 3 |
Labels! | 4 |
Envelope! | 5 |
Transparency! | 6 |
Cardstock! | 7 |
Glossy! | 8 |
Special! | 9 |
Other! | 255 |
To select a paper size/type named Envelope (Monarch), the command is:
PaperSizeSelect("Envelope (Monarch)";7.5";3.88";Envelope!)
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.
PaperSizeTypeDlg
None.
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.
ParagraphDown
None.
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.
ParagraphSpacing(Spacing)
To specify a spacing of 1.2 between paragraphs, the command is:
ParagraphSpacing(1.2)
ParagraphUp moves the cursor to the beginning of the previous paragraph. This command is the equivalent of pressing Ctrl+Up Arrow.
ParagraphUp
None.
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.
PasswordAddChange(Password)
To change or set the password on the current document to Confidential, the command is:
PasswordAddChange("CONFIDENTIAL")
PasswordRemove removes the password from the document. This command is the equivalent of choosing File, Save As, Password, Remove.
PasswordRemove
None.
Paste copies the contents of the buffer into the current document at the cursor position. This command is the equivalent of choosing Edit, Paste.
Paste
None.
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.
PersonalInfo(DataType;Data)
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 |
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
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.
PersonalInfoBegin(Name)
To create the Danny personal information set so you can begin entering items, the command is:
PersonalInfoBegin("Danny")
PersonalInfoDelete deletes the specified personal information set. This command is equivalent of choosing File, Templates, Personal Information, selecting a personal information set, then Delete.
PersonalInfoDelete(Name)
To delete the Danny personal information set, the command is, the command is:
PersonalInfoDelete("Danny")
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.
PersonalInfoDlg
None.
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.
PersonalInfoEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Do not save changes |
Save! | 1 | Save changes |
To save a personal information set, the command is:
PersonalInfoEnd(Save!)
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.
PersonalInfoSelect(Name)
To select the Danny personal information set, the command is:
PersonalInfoSelect("Danny")
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.
PosBlockBeg
None.
PosBlockBottom moves the cursor to the end of the block which is closest to the end of the document.
PosBlockBottom
None.
PosBlockTop moves the cursor to the end of the block which is closest to the beginning of the document.
PosBlockTop
None.
PosCharacter searches forward and positions the cursor after a specified character.
PosCharacter(Character)
To position the cursor after the first C to the right of the cursor, the command is:
PosCharacter("C")
PosCharNext moves the cursor one character to the right. This command is the equivalent of pressing Right Arrow.
PosCharNext
None.
PosCharPrevious moves the cursor one character to the left. This command is the equivalent of pressing Left Arrow.
PosCharPrevious
None.
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.
PosColBottom
None.
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.
PosColDown
None.
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.
PosColFirst
None.
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.
PosColLast
None.
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.
PosColNext
None.
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.
PosColNxtWP51
None.
PosColPrevious moves the cursor one column to the left. This command is the equivalent of pressing Alt+Left Arrow.
PosColPrevious
None.
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.
PosColPreviousWP51
None.
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.
PosColTop
None.
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.
PosColUp
None.
PosDocBottom positions the cursor at the end of the current document. This command is the equivalent of pressing Home, Home, Down Arrow.
PosDocBottom
None.
PosDocTop positions the cursor at beginning of document text. This command is the equivalent of pressing Home, Home, Up Arrow.
PosDocTop
None.
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.
PosDocVeryBottom
None.
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.
PosDocVeryTop
None.
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.
PosFunction(Code)
Enumerated Type | Numeric Equivalent |
HardSpace! | 129 |
HardHyphen! | 132 |
CancelHyphenation! | 144 |
HardEndOfLine! | 204 |
SoftEndOfLine! | 207 |
Tab! | 225 |
To position the cursor to the right of a Hard Space, the command is:
PosFunction(HardSpace!)
PosGoPrevious positions the cursor at the previous cursor position. This command is the equivalent of pressing Ctrl+Home twice.
PosGoPrevious
None.
PosLineBeg positions the cursor at the beginning of the current line of text. This command is the equivalent of pressing Home, Home, Left Arrow.
PosLineBeg
None.
PosLineDown moves the cursor down one line. This command is the equivalent of pressing Down Arrow.
PosLineDown
None.
PosLineEnd positions the cursor at the end of the current line of text. This command is the equivalent of pressing Home, Home, Right Arrow.
PosLineEnd
None.
PosLineUp moves the cursor up one line. This command is the equivalent of pressing Up Arrow.
PosLineUp
None.
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.
PosLineVeryBeg
None.
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.
PosLineVeryEnd
None.
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.
PosPage(Volume;Chapter;Page;Direction)
Enumerated Type | Numeric Equivalent |
Down! | 0 |
Up! | 1 |
To position the cursor at page 3 of chapter 2 in volume 1, the command is:
PosPage(1;2;3;Up!)
PosPageBottom positions the cursor at the bottom of a current page. It is the equivalent of pressing Ctrl+Home, Down Arrow.
PosPageBottom
None.
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.
PosPageNext
None.
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.
PosPagePrevious
None.
PosPageTop positions the cursor at the top of a current page. This command is the equivalent of pressing Ctrl+Home, Up.
PosPageTop
None.
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.
PosScreenDown
None.
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.
PosScreenLeft
None.
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.
PosScreenRight
None.
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.
PosScreenUp
None.
PosSelectBottom positions the cursor at the end (bottom) of the current block.
PosSelectBottom
None.
PosSelectTop positions the cursor at the top (beginning) of the current block.
PosSelectTop
None.
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.
PosTableBeg
None.
PosTableBlockBeg positions the cursor in the first cell of a table.
PosTableBlockBeg
None.
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.
PosTableCell(Cell)
To position the cursor in cell B3, the command is:
PosTableCell("B3")
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.
PosTableCellBottom
None.
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.
PosTableCellDown
None.
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.
PosTableCellNext
None.
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.
PosTableCellPrevious
None.
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.
PosTableCellTop
None.
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.
PosTableCellUp
None.
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.
PosTableColBottom
None.
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.
PosTableColTop
None.
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.
PosTableEnd
None.
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.
PosTableGoPrevious
None.
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.
PosTableRowBeg
None.
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.
PosTableRowEnd
None.
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.
PosTableScreenDown
None.
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.
PosTableScreenLeft
None.
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.
PosTableScreenRight
None.
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.
PosTableScreenUp
None.
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.
PosTableTopCellNext
None.
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.
PosTableTopCellPrevious
None.
PosWordNext positions the cursor at the beginning of the next word. This command is the equivalent of pressing Ctrl+Right Arrow.
PosWordNext
None.
PosWordPrevious positions the cursor at the beginning of the previous word. This command is the equivalent of pressing Ctrl+Left Arrow.
PosWordPrevious
None.
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.
PreviewGraphicsInBlackWhite(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Graphics not viewed in black and white |
Yes! | 1 | Graphics are viewed in black and white |
To view graphics in black and white, the command is:
PreviewGraphicsInBlackWhite(Yes!)
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.
PreviewTextInBlackWhite(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Print Preview not in black and white |
Yes! | 1 | Print Preview in black and white |
To view text in black and white, the command is:
PreviewTextInBlackWhite(Yes!)
PrintBlock prints selected text. This command is the equivalent of blocking text, pressing Shift+F7, Print.
PrintBlock
None.
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.
PrintCopies(Number)
To set the number of copies to print to 2, the command is:
PrintCopies(2)
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.
PrintCopiesBy(Source)
Enumerated Type | Numeric Equivalent | Description |
WordPerfect! | 0 | Corel WordPerfect generates multiple copies |
Printer! | 1 | Printer generates multiple copies |
Network! | 2 | Network generates multiple copies |
To specify Corel WordPerfect as the generation source for multiple copies of a specified document, the command is:
PrintCopiesBy(WordPerfect!)
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.
PrintCopiesBySetup(Source)
Enumerated Type | Numeric Equivalent | Description |
WordPerfect! | 0 | Corel WordPerfect generates multiple copies |
Printer! | 1 | Printer generates multiple copies |
Network! | 2 | Network generates multiple copies |
To designate Corel WordPerfect as the source of multiple copies, the command sequence is:
PrintCopiesBySetup(WordPerfect!)
SetupSave
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.
PrintCopiesSetup(Number)
To print 2 copies of every document printed, the command sequence is:
PrintCopiesSetup(2)
SetupSave
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.
PrintDlg
None.
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.
PrintDocOnDisk(Filename;Page Range;Secondary Page Range;Chapter Range;Volume Range;Odd/Even Pages;DocSummary;Pamphlet;Order)
Enumerated Type | Numeric Equivalent | Description |
PrintAll! | 0 | Print all pages |
PrintOdd! | 2 | Print odd pages |
PrintEven! | 4 | Print even pages |
Enumerated Type | Numeric Equivalent | Description |
NoDocSummary! | 0 | Do not print document summary |
DocSummary! | 1 | Print document summary |
Enumerated Type | Numeric Equivalent | Description |
NoBooklet! | 0 | Document is not a booklet |
Booklet! | 1 | Document is a booklet |
Enumerated Type | Numeric Equivalent | Description |
Forward! | 0 | Print in ascending order |
Backward! | 1 | Print in descending order |
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 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.
PrinterAdd(Name;Filename)
To add an HP LaserJet 4 to the Select Printer dialog box, the command is:
PrinterAdd("HP LaserJet 4";"C:\COREL\WP62\HP4.PRS")
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.
PrinterColorConfigured(Name;Filename;State)
Enumerated Type | Numeric Equivalent | Description |
ColorOff! | 0 | Not configured for color |
ColorOn! | 1 | Configured for color |
To indicate an HP DeskJet 500C is configured for color, the command is:
PrinterColorConfigured("HP DeskJet 500C";"HP500C.PRS";ColorOn!)
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.
PrinterCommand(Type;Command)
Enumerated Type | Numeric Equivalent | Description |
File! | 0 | Printer commands contained in a file |
Command! | 1 | Command is a single printer command |
To insert printer commands into a current document using a filename PTRCMD, the command is:
PrinterCommand(File!;"C:\COREL\WP62\PTRCMD")
To send a command to a printer including the two binary bytes 0x0D and 0x0A at the end, the command is:
PrinterCommand(Command!;"My printer command<13><10>")
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.
PrinterControlCancel(Job)
Enumerated Type | Numeric Equivalent | Description |
FirstJob! | 0 | Cancel first job in the print queue |
AllJobs! | 1 | Cancel all print jobs in print queue |
To cancel print job 3 on the Printer Control screen, the command is:
PrinterControlCancel(3)
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.
PrinterControlCancelImmediate
None.
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.
PrinterControlDlg
None.
PrinterControlGo resumes printing when Prompt to Load is on. This command is the equivalent of choosing File, Print/Fax, Control Printer, Go.
PrinterControlGo
None.
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.
PrinterControlNetworkQueue(Queue)
To specify PrintQ_0 as the network print queue, the command is:
PrinterControlNetworkQueue("PrintQ_0")
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.
PrinterControlRush(Job;Interfere)
Enumerated Type | Numeric Equivalent | Description |
LastJob! | 0 | Advance last job to beginning of queue |
Enumerated Type | Numeric Equivalent | Description |
FinishJob! | 0 | Allow current job to finish printing |
FinishPage! | 1 | Interrupt current print job |
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 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.
PrinterControlRushImmediate
None.
PrinterControlStop pauses the current print job. To resume printing, use PrinterControlGo. This command is the equivalent of choosing File, Print/Fax, Control Printer, Stop.
PrinterControlStop
None.
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.
PrinterCopy(Name;Source;Target)
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 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.
PrinterDelete(Name;Filename;Delete PRS)
Enumerated Type | Numeric Equivalent | Description |
DontDeletePRS! | 0 | Don't delete .PRS file from disk |
DeletePRS! | 1 | Delete .PRS file from disk |
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 changes a printer description. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Description, and editing the description.
PrinterDescription(Description;Filename;New Description)
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 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.
PrinterFont(Printer;Filename;New Font;Point Size;FontFamily;Attributes;Weight;Width;Source;Font Type;Character Set)
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 |
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 |
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 |
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 |
Enumerated Type | Numeric Equivalent |
PRSFile! | 16 |
DRSFile! | 20 |
Enumerated Type | Numeric Equivalent |
Speedo! | 134 |
Intellifont! | 135 |
Type1! | 138 |
TrueType! | 139 |
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 |
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 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.
PrinterFontDirectory(Printer;Filename;New Path)
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 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.
PrinterFunctionsDlg
None.
PrinterInitialize downloads soft fonts to a printer. This command is the equivalent of choosing File, Print/Fax, Initialize Printer.
PrinterInitialize
None.
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.
PrinterOtherDirectory(Directory)
To specify another printer directory named Y:\NETWORK\PRINTERS, the command is:
PrinterOtherDirectory("Y:\NETWORK\PRINTERS")
PrinterPause pauses the current print job. This command is the equivalent of choosing Layout, Other, Printer Functions, Printer Commands, Pause Printer.
PrinterPause
None.
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.
PrinterPortCOM(Name;.PRS Name;COM;Baud Rate;Parity;Stop Bits;Character Length;XONOFF;Status;Initialize;Network;Suppress)
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 |
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 |
Enumerated Type | Numeric Equivalent |
ParityEven! | 0 |
ParityOdd! | 1 |
ParityNone! | 2 |
Enumerated Type | Numeric Equivalent |
StopBit1! | 0 |
StopBit2! | 1 |
Enumerated Type | Numeric Equivalent |
CharacterLength7! | 0 |
CharacterLength8! | 1 |
Enumerated Type | Numeric Equivalent | Description |
NoXONOFF! | 0 | XON/OFF option disabled |
XONOFF! | 1 | XON/OFF option active |
Enumerated Type | Numeric Equivalent |
SkipStatusCheckOff! | 0 |
SkipStatusCheckOn! | 1 |
Enumerated Type | Numeric Equivalent |
InitializeSerialPortOff! | 0 |
InitializeSerialPortOn! | 1 |
Enumerated Type | Numeric Equivalent | Description |
NonNetwork! | 0 | Not a network printer |
NetworkPrinter! | 1 | Network printer |
Enumerated Type | Numeric Equivalent | Description |
SuppressTopOfFormOff! | 0 | Do not suppress the top of form |
SuppressTopOfFormOn! | 1 | Suppress the top of form |
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!)
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.
PrinterPortFilename(Printer Name;.PRS Name;NewName;Prompt)
Enumerated Type | Numeric Equivalent | Description |
NoPrompt! | 0 | Do not prompt |
PromptForFilename! | 1 | Prompt |
To print to a new file each time, the command is:
PrinterPortFilename("ORIGINAL";"HP3.PRS";;PromptForFilename!)
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.
PrinterPortHardware(Name;.PRS Name;Type;IRQ;Address)
Enumerated Type | Numeric Equivalent |
HardwareOff! | 1 |
HardwareOn! | 2 |
HardwareAdvance! | 4 |
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 |
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 specifies information about a parallel printer. This command is the equivalent of choosing File, Print/Fax, Select, Edit, Port, and selecting an LPT port.
PrinterPortLPT(Name;.PRS Name;LPT;Status;Network;Suppress)
Enumerated Type | Numeric Equivalent | Description |
LPT1! | 0 | Port LPT 1 |
LPT2! | 1 | Port LPT 2 |
LPT3! | 2 | Port LPT 3 |
Enumerated Type | Numeric Equivalent |
SkipStatusCheckOn! | 0 |
SkipStatusCheckOff! | 1 |
Enumerated Type | Numeric Equivalent | Description |
NonNetwork! | 0 | Not a network printer |
NetworkPrinter! | 1 | Network printer |
Enumerated Type | Numeric Equivalent | Description |
SuppressTopOfFormOff! | 0 | Do not suppress the top of form |
SuppressTopOfFormOn! | 1 | Suppress the top of form |
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 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.
PrinterPortNetworkQueue(Name;.PRS Name;NetQueue;Suppress)
Enumerated Type | Numeric Equivalent | Description |
SuppressTopOfFormOff! | 0 | Do not suppress the top of form |
SuppressTopOfFormOn! | 1 | Suppress the top of form |
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 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.
PrinterSelect(Printer;Filename)
To select an HP LaserJet 4, the command is:
PrinterSelect("HP LaserJet 4";"HP4.PRS")
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.
PrinterSelectPrs(Filename)
To select a .PRS file named FONTS.PRS, the command is:
PrinterSelectPrs("FONTS.PRS")
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.
PrinterSheetFeeder(Printer;Filename;Sheet Feeder)
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 updates a .PRS file with changes made to the corresponding .ALL file. This command is the equivalent of choosing File, Print/Fax, Select, Update.
PrinterUpdate(Printer;Filename)
To update the HP LaserJet III, the command is:
PrinterUpdate("HP LaserJet III";"HP3.PRS")
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.
PrinterVectorConfigured(Printer;Filename;State)
Enumerated Type | Numeric Equivalent | Description |
VectorOff! | 0 | Do not print using vector graphics |
VectorOn! | 1 | Print using vector graphics |
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 prints the current document. This command is the equivalent of choosing File, Print/Fax, Full Document, Print.
PrintFullDoc
None.
PrintGraphicsJob determines whether to print a document graphically. This command is the equivalent of choosing File, Print/Fax, and selecting Print Job Graphically.
PrintGraphicsJob(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not print graphically |
On! | 1 | Print graphically |
To print a document graphically, the command is:
PrintGraphicsJob(On!)
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.
PrintGraphicsQuality(Resolution)
Enumerated Type | Numeric Equivalent |
DoNotPrint! | 0 |
Draft! | 1 |
Medium! | 2 |
High! | 3 |
To print graphics with high resolution, the command is:
PrintGraphicsQuality(High!)
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.
PrintGraphicsQualitySetup(Resolution)
Enumerated Type | Numeric Equivalent |
DoNotPrint! | 0 |
Draft! | 1 |
Medium! | 2 |
High! | 3 |
To change the default resolution of printing graphics to high resolution, the command is:
PrintGraphicsQualitySetup(High!)
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.
PrintInkColor(Color)
Enumerated Type | Numeric Equivalent |
Black! | 0 |
FullColor! | 1 |
SolidColor! | 2 |
To print a document with solid color, the command is:
PrintInkColor(SolidColor!)
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.
PrintInkColorSetup(Color)
Enumerated Type | Numeric Equivalent |
Black! | 0 |
FullColor! | 1 |
SolidColor! | 2 |
To specify Solid Color as the default method for printing color, the command is:
PrintInkColorSetup(SolidColor!)
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.
PrintMultiplePages(Page Range;Secondary Page Range;Chapter Range;Volume Range; Odd/Even Pages;DocSummary;Pamphlet;Order)
Enumerated Type | Numeric Equivalent |
PrintAll! | 0 |
PrintOdd! | 2 |
PrintEven! | 4 |
Enumerated Type | Numeric Equivalent |
NoDocSummary! | 0 |
DocSummary! | 1 |
Enumerated Type | Numeric Equivalent |
NoBooklet! | 0 |
Booklet! | 1 |
Enumerated Type | Numeric Equivalent |
Forward! | 0 |
Backward! | 1 |
To print all pages of the current document, including the document summary, the command is:
PrintMultiplePages("(all)";;;;PrintAll!;DocSummary!;NoBooklet!;Forward!)
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.
PrintNetworkBanner(State)
Enumerated Type | Numeric Equivalent |
No! | 0 |
Yes! | 1 |
To print a banner with a print job, the command is:
PrintNetworkBanner(Yes!)
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.
PrintNetworkBannerSetup(State)
Enumerated Type | Numeric Equivalent |
No! | 0 |
Yes! | 1 |
To print a banner with all network print jobs, the command is:
PrintNetworkBannerSetup(Yes!)
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.
PrintNetworkForm(Number)
To specify form 0, the command is:
PrintNetworkForm(0)
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.
PrintNetworkFormSetup(Number)
To specify form 0, the command is:
PrintNetworkFormSetup(0)
PrintPage prints the current page. This command is the equivalent of choosing File, Print/Fax, Page, Print.
PrintPage
None.
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.
PrintPCL4PointSize(Point Size)
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 displays the current document in a WYSIWYG graphical format. This command is the equivalent of choosing File, Print Preview.
PrintPreview
None.
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.
PrintPreviewButtonBar
None.
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.
PrintPreviewButtonBarEdit
None.
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.
PrintPreviewButtonBarOptions
None.
PrintPreviewCancel cancels changes made to Print Preview. This command is the equivalent of pressing Escape (Esc) while in Print Preview.
PrintPreviewCancel
None.
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.
PrintPreviewDownArrow
None.
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.
PrintPreviewEnd
None.
PrintPreviewExit exits Print Preview and returns to a document window. This command is the equivalent of choosing File, Close while in Print Preview.
PrintPreviewExit
None.
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.
PrintPreviewFacingPages
None.
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.
PrintPreviewFileMenu
None.
PrintPreviewFullPage displays a full document page in Print Preview. This command is the equivalent of choosing View, Full Page while in Print Preview.
PrintPreviewFullPage
None.
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.
PrintPreviewGoToPage
None.
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.
PrintPreviewHelpMenu
None.
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.
PrintPreviewHome
None.
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.
PrintPreviewInvert
None.
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.
PrintPreviewLeftArrow
None.
PrintPreviewMenu displays the menu while in Print Preview. The program must be in Print Preview for this command to have any effect.
PrintPreviewMenu
None.
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.
PrintPreviewNextPage
None.
PrintPreviewPageDown displays the next page in Print Preview. This command is the equivalent of pressing Page Down while in Print Preview.
PrintPreviewPageDown
None.
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.
PrintPreviewPagesMenu
None.
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.
PrintPreviewPageUp
None.
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.
PrintPreviewPreviousPage
None.
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.
PrintPreviewReferencePage
None.
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.
PrintPreviewRightArrow
None.
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.
PrintPreviewScreenDown
None.
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.
PrintPreviewScreenUp
None.
PrintPreviewSetup displays the Print Preview Options dialog box. This command is the equivalent of choosing File, Setup while in Print Preview.
PrintPreviewSetup
None.
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.
PrintPreviewThumbnails1
None.
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.
PrintPreviewThumbnails2
None.
PrintPreviewThumbnails32 displays 32 small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 32 Page while in Print Preview.
PrintPreviewThumbnails32
None.
PrintPreviewThumbnails4 displays four small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 4 Page while in Print Preview.
PrintPreviewThumbnails4
None.
PrintPreviewThumbnails8 displays eight small page representations in Print Preview. This command is the equivalent of choosing View, Thumbnails, 8 Page while in Print Preview.
PrintPreviewThumbnails8
None.
PrintPreviewThumbnailsOther displays the Thumbnails Other dialog box in Print Preview. This command is the equivalent of choosing View, Thumbnails, Other while in Print Preview.
PrintPreviewThumbnailsOther
None.
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.
PrintPreviewUpArrow
None.
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.
PrintPreviewViewMenu
None.
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.
PrintPreviewZoom100
None.
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.
PrintPreviewZoom200
None.
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.
PrintPreviewZoomArea
None.
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.
PrintPreviewZoomIn
None.
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.
PrintPreviewZoomOut
None.
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.
PrintPreviewZoomReset
None.
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.
PrintSelection
None.
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.
PrintSetupDlg
None.
PrintTextQuality specifies print quality for current document text. This command is the equivalent of choosing File, Print/Fax, Text Quality, and selecting an option.
PrintTextQuality(Resolution)
Enumerated Type | Numeric Equivalent |
DoNotPrint! | 0 |
Draft! | 1 |
Medium! | 2 |
High! | 3 |
To print the current document text with high resolution, the command is:
PrintTextQuality(High!)
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.
PrintTextQualitySetup(Resolution)
Enumerated Type | Numeric Equivalent |
DoNotPrint! | 0 |
Draft! | 1 |
Medium! | 2 |
High! | 3 |
To change the default resolution of printing text to high resolution, the command is:
PrintTextQualitySetup(High!)
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+=.
PullDownDlg
None.
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.
QuickCorrect(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off QuickCorrect |
On! | 1 | Turn on QuickCorrect |
To turn on QuickCorrect, the command is:
QuickCorrect(On!)
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.
QuickCorrectAddItem(Word;Replacement)
To add a QuickCorrect entry that replaces towne with town, the command is:
QuickCorrectAddItem("towne";"town")
QuickCorrectDeleteItem deletes a QuickCorrect entry. This command is equivalent of choosing Tools, Writing Tools, QuickCorrect, Delete Entry, highlighting the entry to delete, Yes.
QuickCorrectDeleteItem(Item)
To delete the QuickCorrect entry that replaces towne with town, the command is:
QuickCorrectDeleteItem("towne")
QuickCorrectDlg displays the QuickCorrect dialog box. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
QuickCorrectDlg
None.
QuickFinderDefaultDocSummary determines whether only the default Document Summary fields are available for a QuickFinder search. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, then selecting or deselecting Default Document Summary.
QuickFinderDefaultDocSummary(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | QuickFinder search not exclusive to default fields |
Yes! | 1 | Only default fields available during QuickFinder search |
To specify that only the default Document Summary fields be made available for a QuickFinder search, the command is:
QuickFinderDefaultDocSummary(Yes!)
QuickFinderDefine defines, not creates, an index with the specified name and description. This command is equivalent to choosing File, File Manager, QuickFinder, Setup, selecting Personal or Shared, Create Index Definition, typing a description, Enter, typing a filename, Enter.
QuickFinderDefine(Type;Description;Name)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Specifies that Corel WordPerfect should use personal indexes |
Shared! | 2 | Specifies that Corel WordPerfect should use shared indexes |
To define a personal index with the description "personal documents" in the path c:\corel\wp62 with the name DOCS, the command is:
QuickFinderDefine(personal!;"Personal Documents";"c:\corel\wp62\docs")
QuickFinderDelete deletes an index description. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, selecting a description, Delete, Yes.
QuickFinderDelete(Type;Description)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
To delete an index description named "Recipes," the command is:
QuickFinderDelete(Personal!;"Recipes")
QuickFinderDirectoryPattern specifies files included in an index. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, Edit, Directories and Files to Index, Add.
QuickFinderDirectoryPattern(Type;Description;Pattern)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
To specify that a personal index with the description "My Primary Files" include all files ending with .pri, the command is:
QuickFinderDirectoryPattern(Personal!;"My Primary Files";"*.PRI")
QuickFinderDirPatternDelete deletes files from an index. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, Edit, Directories and Files to Index, selecting the files, Delete.
QuickFinderDirPatternDelete(Type;Description;Pattern)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
To delete the directory pattern *.pri in a personal index with the description "My Primary Files", the command is:
QuickFinderDirPatternDelete(Personal!;"My Primary Files";"*.pri")
QuickFinderDlg displays the QuickFinder File Indexer dialog box. This command is the equivalent of choosing File, File Manager, QuickFinder.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
QuickFinderDlg
None.
QuickFinderDocSummary determines whether all Document Summary fields are available for a QuickFinder search. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, then selecting or deselecting Document Summary.
QuickFinderDocSummary(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not all fields available during Quickfinder search |
Yes! | 1 | All fields available during QuickFinder search |
To specify that all Document Summary fields be made available for a QuickFinder search, the command is:
QuickFinderDocSummary(Yes!)
QuickFinderGenerate generates an index of a specified type for marked indexes. This command is used in conjunction with QuickFinderMark. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, marking the indexes, Generate Marked Indexes.
QuickFinderGenerate(Type)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
To generate marked indexes, the command is:
QuickFinderGenerate(Personal!)
QuickFinderMark marks indexes for full generations or incremental updates. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, selecting a file, (Un)mark to Regenerate or (Un)mark to Update.
QuickFinderMark(Type;Description;Method)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
Enumerated Type | Numeric Equivalent | Description |
NoGen! | 0 | None |
GenerateIndex! | 1 | Full generation |
UpdateIndex! | 2 | Incremental update |
To generate a personal index with the description "My Primary Files", the command is:
QuickFinderMark(Personal!;"My Primary Files";GenerateIndex!)
QuickFinderMarkAll marks all indexes of a specified type for enumerated methods. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, and marking all index descriptions.
QuickFinderMarkAll(Type;Method)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
Enumerated Type | Numeric Equivalent | Description |
NoGen! | 0 | Unmarks all indexes of the type |
GenerateIndex! | 1 | Marks all for full generation |
UpdateIndex! | 2 | Marks all for incremental update |
UpdateAutoIndex! | 3 | Marks all for incremental update except those marked for manual update |
To generate all personal indexes, the command is:
QuickFinderMarkAll(Personal!;GenerateIndex!)
QuickFinderOptions specifies a description of an index for which options can be changed. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, Edit, Options.
QuickFinderOptions(Type;Description;Numbers;IncludeFiles;Update;Document;Level;ExcludeFiles)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Personal indexes |
Shared! | 2 | Shared indexes |
Enumerated Type | Numeric Equivalent | Description |
DontIncludeNumbers! | 0 | Numbers excluded |
IncludeNumbers! | 1 | Numbers included |
Enumerated Type | Numeric Equivalent | Description |
IndexAllFiles! | 0 | All files |
IndexWPDocOnly! | 1 | Corel WordPerfect documents only |
Enumerated Type | Numeric Equivalent | Description |
AutoUpdate! | 0 | Automatic update |
ManualUpdateOnly! | 1 | Manual update |
Enumerated Type | Numeric Equivalent | Description |
IncludeEntireDoc! | 1 | Entire document |
IncludeEntireDocSummary! | 2 | Entire summary only |
IncludeTextOnly! | 3 | Text only |
IncludeSummaryOnly! | 4 | Summary only |
IncludeFilenameOnly! | 5 | Filename only |
Enumerated Type | Numeric Equivalent | Description |
LevelLine! | 1 | Index lines |
LevelSentence! | 2 | Index sentences |
LevelPara! | 3 | Index paragraphs |
LevelPage! | 4 | Index pages |
LevelSection! | 5 | Index sections |
LevelField! | 6 | Index fields |
LevelRecord! | 7 | Index records |
LevelDocument! | 8 | Index documents |
To define a personal index named "Recipes" that only includes the text of Corel WordPerfect documents and indexes according to lines, the command is:
QuickFinderOptions(Personal!; "Recipes";; IndexWPDocOnly!;; IncludeEntireDoc!; LevelLine!; "*.pri")
QuickFinderRename renames an index description. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, selecting an index description, Rename.
QuickFinderRename(Type;OldDescription;NewDescription)
Enumerated Type | Numeric Equivalent | Description |
Personal! | 1 | Specifies that Corel WordPerfect should use personal indexes |
Shared! | 2 | Specifies that Corel WordPerfect should use shared indexes |
To rename a personal index with a current description of "Personal Documents" to "My Primary Files", the command is:
QuickFinderRename(Personal!;"Personal Documents";"My Primary Files")
QuickFinderResultsLevels specifies the maximum number of search result levels or lists to return to in an attempt to find a file that subsequent searches excluded. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, Previous Results Levels, and selecting a level.
QuickFinderResultsLevels(Levels)
To specify five as the maximum number of search result lists available to return to, the command is:
QuickFinderResultsLevels(5)
QuickFinderSearchIn sets the default location for a QuickFinder search. This command is the equivalent of choosing File, File Manager, QuickFinder, Search In, and specifying a location.
QuickFinderSearchIn(Location)
Enumerated Type | Numeric Equivalent | Description |
Directory! | 0 | Search in default directory |
Subtree! | 1 | Search in subtree of default directory |
Drive! | 2 | Search in default drive |
Index! | 3 | Search in default index |
To set your hard drive as the location for a QuickFinder search, the command is:
QuickFinderSearchIn(Drive!)
QuickFinderSelect selects an index. This command is the equivalent of choosing File, File Manager, QuickFinder, Index, and selecting an index.
QuickFinderSelect(Description)
To select an index with description "My Primary Files", the command is:
QuickFinderSelect("My Primary Files")
QuickFinderWPDocsOnly determines whether QuickFinder indexes only COrel WordPerfect document. This command is the equivalent of choosing File, File Manager, QuickFinder, Setup, Corel WordPerfect Documents only.
QuickFinderWPDocsOnly(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Index all files |
Yes! | 1 | Index Corel WordPerfect documents only |
To specify that QuickFinder index Corel WordPerfect documents only, the command is:
QuickFinderWPDocsOnly(Yes!)
QuickFormat specifies a QuickFormat style that formats text based on current fonts and attributes. This command is the equivalent of choosing Layout, QuickFormat, then selecting a style.
QuickFormat(Name)
To specify the QuickFmt1 style, the command is:
QuickFormat("QuickFmt1")
QuickFormatDlg displays the QuickFormat dialog box. This command is the equivalent of choosing Layout, QuickFormat.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
QuickFormatDlg
None.
QuickFormatEnd lets you create a certain look on some text and then apply that format to other text in your document. This command is the equivalent of pressing Escape while you are applying a QuickFormat to the text in your document.
QuickFormatEnd
None.
QuickFormatStyleOn turns on the current QuickFormat style at the insertion point. This command is the equivalent of choosing Layout, QuickFormat, then selecting a style.
QuickFormatStyleOn
None.
QuickListUpdate updates the QuickList™. This command does not have an equivalent keystroke.
QuickListUpdate
None.
QuickmarkBlock finds and blocks text between QuickMark on and off codes. This command is the equivalent of choosing Edit, Bookmark, highlighting QuickMark, Find and Block.
QuickmarkBlock
None.
QuickmarkDelete removes a QuickMark from a document. This command is the equivalent of choosing Edit, Bookmark, highlighting QuickMark, Delete, Yes.
QuickmarkDelete
None.
QuickmarkFind positions the cursor on the first character after a QuickMark. This command is the equivalent of choosing Edit, Bookmark, highlighting QuickMark, Find.
QuickmarkFind
None.
QuickmarkMove moves a QuickMark to the current location of the cursor. This command is the equivalent of choosing Edit, Bookmark, highlighting QuickMark, Move.
QuickmarkMove
None.
QuickmarkSet places a unique bookmark in a document. If "Set QuickMark in Document on Save" is active, any QuickMark added by the macro will automatically be moved to the current cursor position when the document is saved. This command is the equivalent of choosing Edit, Bookmark, Set QuickMark.
QuickmarkSet
None.
QuickmarkSetOnSave inserts the QuickMark at the cursor when the document is saved. A document contains only one QuickMark at a time. When QuickmarkSetOnSave is active, any other QuickMark code is removed when the document is saved. This command is the equivalent of choosing Edit, Bookmark, Set QuickMark in Document on Save.
QuickmarkSetOnSave(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not add a QuickMark |
Yes! | 1 | Add a QuickMark at the current position of the cursor |
To specify not to create a QuickMark when a document is saved, the command is:
QuickmarkSetOnSave(No!)
QuickTableLines specifies whether table attributes display in the document window. This command is the equivalent of choosing View, Screen Setup, Window Options, Quick Table Lines.
QuickTableLines(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Display all table attributes |
On! | 1 | Do not display table attributes |
To specify that table attributes do not display in the document window, the command is:
QuickTableLines(On!)
RedlineCharacter specifies the character printed in the margin of redlined text. RedlineCharacter is available only when RedlineMethod is not defined as PrinterDependent!. This command is the equivalent of choosing Layout, Document, Redline Character.
RedlineCharacter(Character)
To specify the redline character as a greater than sign (>), the command is:
RedlineCharacter(">")
RedlineCharacterSetup specifies a default character to print with redlined text. This command will not have any effect on previously created documents. RedlineCharacterSetup is available only when RedlineMethodSetup is not defined as PrinterDependent!. This command is the equivalent of choosing File, Print/Fax, Setup, Redline Character.
RedlineCharacterSetup(Character)
To specify the default redline character as a pipe symbol (|), the command is:
RedlineCharacterSetup("|")
RedlineMethod specifies a redline method for the current document. This command is the equivalent of choosing Layout, Document, Redline Method.
RedlineMethod(Method)
Enumerated Type | Numeric Equivalent | Description |
PrinterDependent! | 0 | Print the redline if the printer is able |
LeftMargin! | 1 | Place the redline marking in the left margin |
Alternating! | 2 | Alternate the redline marking between left and right margins |
RightMargin! | 3 | Place the redline marking in the right margin |
To specify redline markings on the right side of a printout, the command is:
RedlineMethod(RightMargin!)
RedlineMethodSetup specifies a redline method for the current and all succeeding documents. It will not affect any created documents. This command is the equivalent of choosing File, Print/Fax, Setup, Redline Method.
RedlineMethodSetup(Method)
Enumerated Type | Numeric Equivalent | Description |
PrinterDependent! | 0 | Print the redline if the printer is able |
Left! | 1 | Place the redline marking in the left margin |
Alternating! | 2 | Alternate the redline marking between left and right margins |
Right! | 3 | Place the redline marking in the right margin |
To specify default redline markings to appear alternately on the right and left hand sides of a printout, the command is:
RedlineMethodSetup(Alternating!)
RepeatDlg displays the Repeat dialog box and pauses the macro until Set or Cancel is selected. This command does not specify how many times to repeat a command. This command is the equivalent of choosing Edit, Repeat.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
RepeatDlg
None.
RepeatSet sets a default repeat value. This command is the equivalent of choosing Edit, Repeat, entering a number, Set.
RepeatSet(Value)
To set a repeat value of 10, the command is:
RepeatSet(10)
RepeatValue repeats the next macro command a specified number of times. This command is the equivalent of choosing Edit, Repeat.
RepeatValue(Value)
To set the repeat value at 10, the command is:
RepeatValue(10)
ReplaceBackward searches and replaces a specific word from the current location of the cursor backward throughout a document. This command is the equivalent of choosing Edit, Replace, Backward Search, Replace.
ReplaceBackward(Method)
Enumerated Type | Numeric Equivalent | Description |
Regular! | 0 | Do not search substructures |
Extended! | 1 | Search substructures |
To start the replacement function backward from the current cursor position, including substructures, the command is:
ReplaceBackward(Extended!)
ReplaceBlock determines whether or not blocked text is replaced as you type. This command is the equivalent of choosing File, Setup, Environment, then selecting or deselecting Typing Replaces Blocked Text.
ReplaceBlock(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Blocked text is expanded as you type. |
Yes! | 1 | Blocked text is replaced as you type. |
To turn on the Typing Replaces Blocked Text feature, the command is:
ReplaceBlock(Yes!)
ReplaceConfirm specifies whether or not Corel WordPerfect should prompt the user at every occurrence of a search string. If this command is omitted, the replace feature defaults to the confirmation mode of the previous replacement command. This command is the equivalent of choosing Edit, Replace, Confirm Replacement, Replace.
ReplaceConfirm(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not prompt |
Yes! | 1 | Prompt before replacing |
To activate the replacement prompt, the command is:
ReplaceConfirm(Yes!)
ReplaceDlg displays the Search and Replace dialog box. This command is the equivalent of choosing Edit, Replace.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ReplaceDlg
None.
ReplaceForward replaces specific text from the current cursor position forward. This command is the equivalent of choosing Edit, Replace, deselecting Backward Search if necessary, Replace.
ReplaceForward(Method)
Enumerated Type | Numeric Equivalent | Description |
Regular! | 0 | Do not search substructures |
Extended! | 1 | Search substructures |
To start the replacement function forward from the current cursor position, including substructures, the command is:
ReplaceForward(Extended!)
ReplaceLimitNumberOfMatches limits the number of replacements. This command only toggles the Limit Number of Matches option; it does not execute the replace. This command is used in conjunction with ReplaceForward or ReplaceBackward. This command is the equivalent of choosing Edit, Replace, Limit Number of Matches.
ReplaceLimitNumberOfMatches(State;Number)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not limit replaces |
Yes! | 1 | Limit number of replaces |
To limit the number of replaces at three, the command is:
ReplaceLimitNumberOfMatches(Yes!;3)
ReplaceString contains a character expression to replace each occurrence of the search string. This command is the equivalent of choosing Edit, Replace, Replace With.
ReplaceString(String)
To define the replacement string as "Jonathan", the command is:
ReplaceString("Jonathan")
ReselectLastBlock selects the last block selected. This command is the equivalent of turning block on and pressing Ctrl+Home, Ctrl+Home (PosGoPrevious). This command is not recordable.
ReselectLastBlock
None.
ReselectLastSelection selects the last block selected. This command is not recordable and has no keystroke equivalent.
ReselectLastSelection
None.
RevealCodes turns Reveal Codes on or off. This command is the equivalent of choosing View, Reveal Codes.
RevealCodes(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn Reveal Codes off |
On! | 1 | Turn Reveal Codes on |
To turn off Reveal Codes, the command is:
RevealCodes(Off!)
RevealCodesDisplayDetail displays formatting information and actual settings with codes in the Reveal Codes window. This command is the equivalent of choosing View, Screen Setup, Reveal Codes, Display Details.
RevealCodesDisplayDetail(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not display detail |
Yes! | 1 | Display detail |
To display details in Reveal Codes, the command is:
RevealCodesDisplayDetail(Yes!)
RevealCodesKey turns Reveal Codes on or off. This command is used by the Keyboard Layout. On the Original keyboard, this command is the equivalent of pressing Alt+F3 or F11. This command is not recordable.
RevealCodesKey
None.
RevealCodesWindowSize resizes the Reveal Codes screen for the current document only. This command is the equivalent of choosing Ctrl+F3, Reveal Codes Window Percentage, and entering a percentage.
RevealCodesWindowSize(Size)
To reserve half of the screen for the Reveal Codes window, the command is:
RevealCodesWindowSize(50)
RevealCodesWindowSizeSetup resizes the default Reveal Codes screen. This command is the equivalent of choosing View, Screen Setup, Reveal Codes, Window Percentage.
RevealCodesWindowSizeSetup
None.
RewriteKey either rewrites the screen, as in the Equation Editor, or displays the Screen dialog box. This command is used by the Keyboard Layout. On the Original keyboard, this command is the equivalent of pressing Ctrl+F3. This command is not recordable.
RewriteKey
None.
RibbonSetup turns the Ribbon display default on or off. If no parameter is included, RibbonSetup acts as a toggle. This command is the equivalent of choosing View, Screen Setup, Screen Options, Ribbon. This command is not recordable.
RibbonSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not display the Ribbon |
On! | 1 | Display the Ribbon |
To display the Ribbon by default, the command is:
RibbonSetup(On!)
RibbonSetupGraphics specifies whether the Ribbon will display in Graphics Mode. This command is the equivalent of choosing View, Ribbon when in Graphics Mode.
RibbonSetupGraphics(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not display the Ribbon |
On! | 1 | Display the Ribbon |
To display the Ribbon while in Graphics Mode, the command is:
RibbonSetupGraphics(On!)
RibbonSetupText specifies whether the Ribbon will display in Text Mode. This command is the equivalent of choosing View, Ribbon when in Text Mode.
RibbonSetupText(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not display the Ribbon |
On! | 1 | Display the Ribbon |
To display the Ribbon while in Text Mode, the command is:
RibbonSetupText(On!)
RightArrow moves an equation right in the View Equation window of the Equation Editor. This command is the equivalent of pressing Right Arrow while in the View Equation window. This command is not recordable. To use this command, you must type it into the macro. Outside of the View Equation window, pressing Right Arrow records PosCharNext.
RightArrow
None.
RulerNewTabType specifies a new Ruler Bar® tab type. This command is not recordable. To use this command, you must type it into the macro.
RulerNewTabType(Tab Type)
Enumerated Type | Numeric Equivalent | Description |
TabLeft! | 0 | Set Left tab type |
TabCenter! | 1 | Set Center tab type |
TabRight! | 2 | Set Right tab type |
TabDecimal! | 3 | Set Decimal tab type |
TabLeftDot! | 16 | Set Left with Dot Leader tab type |
TabCenterDot! | 17 | Set Center with Dot Leader tab type |
TabRightDot! | 18 | Set Right with Dot Leader tab type |
TabDecimalDot! | 19 | Set Decimal with Dot Leader tab type |
To specify left tabs with dot leaders as the new Ruler tab type, the command is:
RulerNewTabType(TabLeftDot!)
RulerSetup specifies whether or not the Ruler displays. This command is the equivalent of choosing View, Ruler.
RulerSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off Ruler display |
On! | 1 | Turn on Ruler display |
To display the Ruler, the command is:
RulerSetup(On!)
Save saves a current document. If the document has not been named, the Save Document dialog box is displayed. This command is not recordable.
Save
None.
SaveTempDoc saves the current document in a temporary file with a .twp extension. This command is not recordable.
SaveTempDoc
None.
ScreenDlg displays the Screen dialog box. This is the equivalent of pressing Ctrl+F3 and then checking the checkbox in the upper right corner.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ScreenDlg
None.
ScreenMatchBegin must be used in connection with the ScreenMatchTable and ScreenMatchEnd commands. This command is the equivalent of choosing Font, Font, Setup, Edit Screen Font Mapping Table, highlighting a font, Select Screen Font, and choosing a font from the Screen drop-down list.
ScreenMatchBegin
None.
To map the Swiss 721 Roman (Speedo) font to display on the screen when the Helvetica printer font is used in Graphics or Page mode, the command is:
ScreenMatchBegin
ScreenMatchTable("Helvetica";"";"";"";;;DRSFile!;"Swiss 721 Roman (Speedo)")
ScreenMatchEnd(Save!)
ScreenMatchEnd must be used in connection with the ScreenMatchBegin and ScreenMatchTable commands. This command is the equivalent of choosing Font, Font, Setup, Edit Screen Font Mapping Table, highlighting a font, Select Screen Font, and choosing a font from the Screen drop-down list.
ScreenMatchEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To map the Swiss 721 Roman (Speedo) font to display on the screen when the Helvetica printer font is used in Graphics or Page mode, the command is:
ScreenMatchBegin
ScreenMatchTable("Helvetica";"";"";"";;;DRSFile!;"Swiss 721 Roman (Speedo)")
ScreenMatchEnd(Save!)
ScreenMatchTable maps screen fonts used in Graphics and Page mode when a printer font is selected. This command must be used in conjunction with the ScreenMatchBegin and ScreenMatchEnd commands. This command is the equivalent of choosing Font, Font, Setup, Edit Screen Font Mapping Table, and setting Printer and Screen Font options.
ScreenMatchTable(Typeface;Attribute;Group;Ext;PtSize;CPISize;Location;Name;Remove)
Enumerated Type | Numeric Equivalent | Description |
PRSFile! | 16 | .PRS file |
DRSFile! | 20 | .DRS file |
Enumerated Type | Numeric Equivalent | Description |
RemoveMapping! | 1 | Remove font mappings |
To map the Swiss 721 Roman (Speedo) font to display on the screen when the Helvetica printer font is used in Graphics or Page mode, the command is:
ScreenMatchBegin
ScreenMatchTable("Helvetica";"";"";"";;;DRSFile!;"Swiss 721 Roman (Speedo)")
ScreenMatchEnd(Save!)
ScreenSetupDlg displays the Screen Setup dialog box. This command is the equivalent of choosing View, Screen Setup.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ScreenSetupDlg
None.
SearchBackwardDlg displays the Search dialog box with the Backward Search option selected. All other options that were selected by a previous search will also be selected. This command is the equivalent of choosing Edit, Search, Backward Search.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SearchBackwardDlg
None.
SearchCaseSensitive selects the Case Sensitive Search option in the Search dialog box. Only the text that matches the search string exactly will be located. This command only marks or unmarks the option; it does not execute a search. This command is the equivalent of choosing Edit, Search, Case Sensitive Search.
SearchCaseSensitive(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not case sensitive |
Yes! | 1 | Case sensitive |
To turn on Case Sensitive Search, the command is:
SearchCaseSensitive(Yes!)
SearchDlg displays the Search dialog box. This command is the equivalent of choosing Edit, Search.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SearchDlg
None.
SearchFindWholeWordsOnly selects Find Whole Words Only in the Search dialog box. This command only marks or unmarks the option; it does not execute a search. This command is the equivalent of choosing Edit, Search, Find Whole Words Only.
SearchFindWholeWordsOnly(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Locate all occurrences |
Yes! | 1 | Locate only whole words |
To restrict a search to whole words only, the command is:
SearchFindWholeWordsOnly(Yes!)
SearchNext executes a forward search. This command is the equivalent of choosing Edit, Search, Search.
SearchNext(Type)
Enumerated Type | Numeric Equivalent | Description |
Regular! | 0 | Search text only |
Extended! | 1 | Search text, headers, footers, graphics... |
To execute a forward extended search, the command is:
SearchNext(Extended!)
SearchPrevious executes a backward search. This command is the equivalent of choosing Edit, Search, Backward Search, Search.
SearchPrevious(Type)
Enumerated Type | Numeric Equivalent | Description |
Regular! | 0 | Search text only |
Extended! | 1 | Search text, headers, footers, graphics... |
To search backward, the command is:
SearchPrevious
SearchString specifies a string to search for. This command must be used in conjunction with either the SearchNext or SearchPrevious commands. This command is the equivalent of choosing Edit, Search, and entering a search string.
SearchString(String)
To specify a search string of "NOTE", the command is:
SearchString("NOTE")
SecondaryPageNumber specifies a secondary page number and inserts the code into a document. This command is the equivalent of choosing Layout, Page, Page Numbering, Secondary Page Number, and inserting a page number.
SecondaryPageNumber(Number)
To define a secondary page number as 10, the command is:
SecondaryPageNumber(10)
SecondaryPageNumberDecrement decreases the current secondary page number. This command is the equivalent of choosing Layout, Page, Page Numbering, Secondary Page Number, Decrement Number.
SecondaryPageNumberDecrement
None.
SecondaryPageNumberDisplay displays the current secondary page number in the document. The page number is entered as a code and will, therefore, update as the document is modified. This command is the equivalent of choosing Layout, Page, Page Numbering, Secondary Page Number, Display in Document.
SecondaryPageNumberDisplay
None.
SecondaryPageNumberIncrement increases the current secondary page number. This command is the equivalent of choosing Layout, Page, Page Numbering, Secondary Page Number, Increment Number.
SecondaryPageNumberIncrement
None.
SecondaryPageNumberMethod specifies a secondary page number display. This is the equivalent of choosing Layout, Page, Page Numbering, Secondary Page Number, Numbering Method, and selecting an option.
SecondaryPageNumberMethod(Type)
Enumerated Type | Numeric Equivalent | Description |
Numbers! | 0 | Arabic numbers |
LowerLetters! | 1 | Lower case letters |
UpperLetters! | 2 | Upper case letters |
LowerRoman! | 3 | Lower case roman numerals |
UpperRoman! | 4 | Upper case roman numerals |
To display secondary page numbers in Upper Roman numerals, the command is:
SecondaryPageNumberMethod(UpperRoman!)
SetupDlg displays the Setup dialog box. This command is the equivalent of pressing Shift+F1 and then checking the checkbox in the upper right corner.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SetupDlg
None.
SetupKey executes the Setup key (Shift+F1). This command is used within dialog boxes that contain a Setup button. This command is not recordable and is usually used in conjunction with the DLGINPUT(On!) command.
SetupKey
None.
SetupSave saves Setup changes. This command is automatically executed when any Setup option is changed. This command is not recordable and has no equivalent keystroke.
SetupSave
None.
ShellDlg displays the Shell dialog box. This command is the equivalent of choosing File, Go To Shell.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ShellDlg
None.
ShiftTabKey executes the Shift+Tab keystroke within dialog boxes which positions the highlight on the previous option. This command is not recordable. This command is the equivalent of pressing Shift+Tab within a dialog box.
ShiftTabKey
None.
SingleSmartQuote turns Single Smart Quotes on or off and specifies quote characters. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, selecting Turn on Single Quotes, then specifying quote characters.
SingleSmartQuote(State;OpeningSingleQuote;ClosingSingleQuote)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off Single Smart Quotes |
On! | 1 | Turn on Single Smart Quotes |
To specify ' as both the opening and closing single quote character, the command is:
SingleSmartQuote(On!;39;39)
SingleSpaceInSentence eliminates double spaces between the words in a sentence and replaces them with single spaces. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, Double Space to Single Space.
SingleSpaceInSentence(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off Double Space to Single Space |
On! | 1 | Turn on Double Space to Single Space |
To replace double spaces between words with single spaces in sentences, the command is:
SingleSpaceInSentence(On!)
SoftHyphen inserts a soft hyphen within a word. If the hyphen is needed to divide a word, it will appear. Otherwise, the hyphen will only appear in Reveal Codes. The soft hyphen will only print if the word is divided. This command is the equivalent of pressing Ctrl+-.
SoftHyphen
None.
Sort specifies a file to sort and a file to which the changes are written. The current document is the default. This command is the equivalent of choosing Tools, Sort, selecting the source and destination files, OK, selecting the key and action options, Perform Action.
Sort(Source;Destination;Undo)
Enumerated Type | Numeric Equivalent | Description |
NoUndo! | 0 | Allow Undo is off |
Undo! | 1 | Allow Undo is active |
To sort the current document without the Allow Undo feature active, and save in a file named RESULT, the command is:
Sort(;"RESULT";NoUndo!)
SortAction specifies whether to sort a file or select only certain records. This command is the equivalent of choosing Tools, Sort, OK, Select Records Only.
SortAction(Type)
Enumerated Type | Numeric Equivalent | Description |
Sort! | 0 | Sort |
SelectOnly! | 1 | Select only |
To select only certain records without changing their order, the command is:
SortAction(SelectOnly!)
SortCaseOrder specifies case priority. This command is the equivalent of choosing Tools, Sort, OK, Sort Uppercase First.
SortCaseOrder(Type)
Enumerated Type | Numeric Equivalent | Description |
LowercaseFirst! | 0 | Lowercase first |
UppercaseFirst! | 1 | Uppercase first |
To prioritize uppercase entries, the command is:
SortCaseOrder(UppercaseFirst!)
SortDlg displays the Sort (Source and Destination) dialog box. This command is the equivalent of choosing Tools, Sort.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SortDlg
None.
SortKeys specifies sort key options. This command is the equivalent of choosing Tools, Sort, OK, Sort Keys (Sort Priority), Edit.
SortKeys(Field;Line;Word;Type;Order)
Enumerated Type | Numeric Equivalent | Description |
Alphanumeric! | 0 | Numbers and letters, letters last |
Numeric! | 1 | Numbers only |
Enumerated Type | Numeric Equivalent | Description |
Ascending! | 0 | A-Z and 0-9 |
Descending! | 1 | Z-A and 9-0 |
To sort ZIP Codes that are the only word on the only line in the sixth field of a secondary file, the command is:
SortKeys(6;1;1;Numeric!;Ascending!)
SortSelectString inserts a character string into the Select Records option of the Sort dialog box. This command is the equivalent of choosing Tools, Sort, OK, Select Records.
SortSelectString(String)
To sort and select only records that contain the ZIP Code 84057 in the field defined by Key1, the command is:
SortSelectString("Key1=84057")
SortType specifies a source file format. ParagraphSort! sorts the file leaving paragraphs intact; LineSort! sorts each line of the file individually; ColumnSort! sorts parallel columns; TableSort! sorts a table where rows act as lines and cells act as fields; and MergeSort! sorts a secondary file. This command is the equivalent of choosing Tools, Sort, OK, Record Type.
SortType(Type)
Enumerated Type | Numeric Equivalent | Description |
ParagraphSort! | 0 | Paragraph sort |
LineSort! | 1 | Line sort |
ColumnSort! | 2 | Columns sort |
TableSort! | 3 | Table sort |
MergeSort! | 4 | Secondary file sort |
To specify the source file is a secondary file, the command is:
SortType(MergeSort!)
SortUndo specifies whether the Allow Undo feature is active for all subsequent documents to be sorted. This command is the equivalent of choosing Tools, Sort, OK, Allow Undo.
SortUndo(Undo)
Enumerated Type | Numeric Equivalent | Description |
NoUndo! | 0 | Allow Undo is off |
Undo! | 1 | Allow Undo is active |
To specify that the Allow Undo feature is disabled for all subsequent documents to be sorted, the command is:
SortUndo(NoUndo!)
SoundAddDlg displays the Add Sound Clip to Document dialog box. This command is the equivalent of choosing Tools, Sound Clip, Add.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundAddDlg
None.
SoundClipAddInstance inserts a sound clip from the Sound Clips in Document dialog box into a document. The SoundClipCreate command must be used before this command is available. This command is not recordable.
SoundClipAddInstance(String)
To insert a sound clip with the description "Exit," the command is:
SoundClipAddInstance("Exit")
SoundClipCreate inserts a sound clip from a document into the Sound Clips in Document dialog box. This command is the equivalent of choosing Tools, Sound Clip, Play, Add Clip, and entering a filename and a description.
SoundClipCreate(Descript;Name;Loc;Type;Lvol;Rvol)
Enumerated Type | Numeric Equivalent | Description |
OnDisk! | 0 | Disk |
InDoc! | 1 | Document |
Enumerated Type | Numeric Equivalent | Description |
MIDI! | 0 | MIDI |
DigitalAudio! | 1 | Digital audio |
To give a sound clip on disk the description "Duplicate of Exit" and insert it into the document, the command is:
SoundClipCreate("Duplicate of Exit";"c:\corel\wp62\exit.snd";OnDisk!;DigitalAudio!;10;10)
SoundClipDelete deletes a sound clip. This command is the equivalent of choosing Tools, Sound Clip, Play, highlighting a sound clip, Delete.
SoundClipDelete(Name)
To delete a sound clip named OPEN.SND, the command is:
SoundClipDelete("OPEN.SND")
SoundClipEditDescription changes the description of a sound clip. This command is the equivalent of choosing Tools, Sound Clip, Play, highlighting a sound clip, Edit Desc, and entering a new description.
SoundClipEditDescription(OldDescript;NewDescript)
To change the description of a sound clip from "Exit" to "Close," the command is:
SoundClipEditDescription("Exit";"Close")
SoundClipPlay plays a sound clip with a specified description. This command is the equivalent of choosing Tools, Sound Clip, Play, highlighting a sound clip, Play.
SoundClipPlay(Descript;Start;Lvol;Rvol)
To play a sound clip with the description "Close," the command is:
SoundClipPlay("Close")
SoundClipPlayNextDlg displays the Listen and Type dialog box. This command has no keystroke equivalent.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundClipPlayNextDlg
None.
SoundClipRecordDlg displays the Record Sound Clip dialog box. This command is the equivalent of pressing Ctrl+D.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundClipRecordDlg
None.
SoundClipSave saves a sound clip path and filename. This command is the equivalent of choosing Tools, Sound Clip, Play, highlighting a sound clip, Save.
SoundClipSave(Description;Name)
To save a sound clip with the description "Close" in a file named CLOSE.SND, the command is:
SoundClipSave("Close";"CLOSE.SND")
SoundFilePlay plays a sound clip file. The sound clip does not need to appear in the Sound Clips In Document dialog box. This command has no equivalent.
SoundFilePlay(Name;Start;Lvol;Rvol)
To play a sound clip named CLOSE.SND without retrieving the sound clip into the current document, the command is:
SoundFilePlay("CLOSE.SND")
SoundPlayDlg displays the Sound Clips In Document dialog box. This command is the equivalent of choosing Tools, Sound Clip, Play.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundPlayDlg
None.
SoundRecordDlg displays the Record Sound Clip dialog box. This command is the equivalent of choosing Tools, Sound, Record.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundRecordDlg
None.
SoundRecordingQuality specifies the technical setup of a sound clip. This command is the equivalent of choosing Tools, Sound Clip, Play, Setup, Recording Quality Setup.
SoundRecordingQuality(Quality;Rate;Bits;Mode)
Enumerated Type | Numeric Equivalent | Description |
OtherQuality! | 0 | User-defined rates and bits |
GoodQuality! | 64 | Voice clip quality |
BetterQuality! | 192 | Music clip quality |
Enumerated Type | Numeric Equivalent | Description |
At5513Hz! | 5513 | 5513 Hz |
At7350Hz! | 7350 | 7350 Hz |
At8000Hz! | 8000 | 8000 Hz |
At11025Hz! | 11025 | 11025 Hz |
At16000Hz! | 16000 | 16000 Hz |
At22050Hz! | 22050 | 22050 Hz |
At32000Hz! | 32000 | 32000 Hz |
At44100Hz! | 44100 | 44100 Hz |
Enumerated Type | Numeric Equivalent | Description |
EightBit! | 8 | 8 bits |
SixteenBit! | 16 | 16 bits |
Enumerated Type | Numeric Equivalent | Description |
Mono! | 0 | Mono recording |
Stereo! | 1 | Stereo recording |
To record a 16 bit voice quality clip at 8000Hz in stereo, the command is:
SoundRecordingQuality(GoodQuality!;8000Hz!;SixteenBit!;Stereo!)
SoundRecordingQualityDlg displays the Recording Quality Setup dialog box. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup, Recording Quality Setup.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundRecordingQualityDlg
None.
SoundSelect specifies the sound driver installed in the machine. This command is used in conjunction with the SetupSave command. This command is the equivalent of choosing Tools, Sound Clip, Play, Setup, Type, Select.
SoundSelect(Filename;String)
To select the Compaq Business Audio sound driver, the command is:
SoundSelect("CMPQ.ARS";"Compaq Business Audio")
SetupSave
SoundSetInterrupt assigns a specific interrupt value to be used by a sound card. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup, Hardware Setup, Interrupt Request Level, and selecting an IRQ setting.
SoundSetInterrupt(Interrupt)
Enumerated Type | Numeric Equivalent | Description |
IRQ2! | 4 | Interrupt 2 |
IRQ3! | 8 | Interrupt 3 |
IRQ4! | 16 | Interrupt 4 |
IRQ5! | 32 | Interrupt 5 |
IRQ6! | 64 | Interrupt 6 |
IRQ7! | 128 | Interrupt 7 |
IRQ10! | 1024 | Interrupt 10 |
IRQ15! | 32768 | Interrupt 15 |
To specify sound card on interrupt 10, the command is:
SoundSetInterrupt(IRQ10!)
SoundSetIOAddress specifies the hexadecimal number of a sound card address. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup, Hardware Setup, Base Address (Hexadecimal).
SoundSetIOAddress(Address)
To set the base address of the sound card at 534, the command is:
SoundSetIOAddress(534)
SoundSetMasterVolume specifies the volume of the sound emitted from the sound card. Although there are two parameters for this command, they currently function as one unit and are specified the same. This command is the equivalent of choosing Tools, Sound Clip, Play, Volume, and entering a volume percentage.
SoundSetMasterVolume(Left;Right)
To set the volume at 50, the command is:
SoundSetMasterVolume(50;50)
SoundSetSynthesizerPort specifies the port a synthesizer is hooked up to. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup, Hardware Setup, External Synthesis (via MIDI Port).
SoundSetSynthesizerPort(Port)
Enumerated Type | Numeric Equivalent | Description |
MIDIOFF! | 3 | Turns MIDI off |
LPT1! | 0 | LPT 1 |
LPT2! | 1 | LPT 2 |
LPT3! | 2 | LPT 3 |
COM1! | 4 | COM 1 |
COM2! | 5 | COM 2 |
COM3! | 6 | COM 3 |
COM4! | 7 | COM 4 |
SoundCard! | 8 | Sound Card |
SoundCardMIDIPort! | 9 | MIDI port |
To define the synthesizer that is plugged into the sound card MIDI port, the command is:
SoundSetSynthesizerPort(SoundCardMIDIPort!)
SoundSetupDlg displays the Sound Setup dialog box. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SoundSetupDlg
None.
SoundStopPlay stops playing after a specified time or after the entire clip plays. This command is the equivalent of pressing Ctrl+S, then choosing Stop while playing a sound clip.
SoundStopPlay(Time;Entire)
Enumerated Type | Numeric Equivalent | Description |
AllClip! | 0 | Play the entire clip |
To play an entire sound clip, the command is:
SoundStopPlay(AllClip!)
SoundUnselect deselects the sound card. This command is the equivalent of choosing Tools, Sound Clip, Sound Setup, Type, and pressing the space bar.
SoundUnselect
None.
SpaceDisplayCharacter specifies a character to display when the space bar is pressed. This command is the equivalent of choosing View, Screen Setup, Space Character, and entering a character.
SpaceDisplayCharacter(Character)
To display an asterisk (*) when the space bar is pressed, the command is:
SpaceDisplayCharacter ("*")
SpecialCodesDlg displays the Special Codes dialog box. This command is the equivalent of choosing Layout, Special Codes.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpecialCodesDlg
None.
SpecificDeleteStringBegin deletes specific codes. SpecificDeleteStringBegin must be followed by a macro command corresponding to a specific code to delete. This command must be used in conjunction with other commands, such as ReplaceBackward, ReplaceForward, and SpecificStringEnd. This command is the equivalent of choosing Edit, Replace, Specific Codes, selecting a code type, specifying a specific code, Search and Delete.
SpecificDeleteStringBegin
None.
To find and delete left margin codes of 2", the command sequence is:
SpecificDeleteStringBegin
MarginLeft(2")
SpecificStringEnd
ReplaceForward()
SpecificReplaceStringBegin replaces a specific code with another specific code. A macro command corresponding to a specific replacement code must follow SpecificReplaceStringBegin. The code being replaced is specified using SpecificSearchStringBegin. SpecificReplaceStringBegin must be used in conjunction with other commands, such as ReplaceBackward, ReplaceForward, SpecificSearchStringBegin, and SpecificStringEnd. This command is the equivalent of choosing Edit, Replace, Specific Codes, selecting a specific code to search for, selecting a specific code to replace with, OK, Replace.
SpecificReplaceStringBegin
None.
To replace 2" left margin codes with 3" left margin codes, the command sequence is:
SpecificSearchStringBegin
LeftMargin(2")
SpecificStringEnd
SpecificReplaceStringBegin
LeftMargin(3")
SpecificStringEnd
ReplaceForward()
SpecificSearchStringBegin finds a specific code. A macro command corresponding to a specific code to find must follow SpecificSearchStringBegin. This command must be used in conjunction with SpecificStringEnd. This command is the equivalent of choosing Edit, Search, Specific Codes, selecting a code type, specifying a specific code, Search.
SpecificSearchStringBegin
None.
To search for a right justification code, the command sequence is:
SpecificSearchStringBegin
Justification(Right!)
SpecificStringEnd
SearchNext()
SpecificStringEnd marks the end of SpecificDeleteStringBegin, SpecificReplaceStringBegin, or SpecificSearchStringBegin.
SpecificStringEnd
None.
SpellerDlg opens the Speller dialog box. This command is the equivalent of choosing Tools, Writing Tools, Speller.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpellerDlg
None.
SpellerDoc spell checks the current document. This command is the equivalent of choosing Tools, Writing Tools, Speller, Document.
SpellerDoc
None.
SpellerEditSupDictionary opens the Edit Supplemental Dictionary dialog box. This command is the equivalent of choosing Tools, Writing Tools, Speller, Edit Supplemental Dictionary.
SpellerEditSupDictionary
None.
SpellerGrammatikDisable specifies text not to be checked by Speller or Grammatik. If Block is on when this command is used, Speller and Grammatik are disabled for the blocked text. If Block is not on when the command is used, SpellerGrammatikDisable acts as a toggle. This command is the equivalent of choosing Tools, Writing Tools, Disable Speller/Grammatik.
SpellerGrammatikDisable
None.
SpellerPage spell checks the current page. This command is the equivalent of choosing Tools, Writing Tools, Speller, Page.
SpellerPage
None.
SpellerWord spell checks the current word. This command is the equivalent of choosing Tools, Writing Tools, Speller, Word.
SpellerWord
None.
SpreadsheetCreateLink establishes a link to a spreadsheet or spreadsheet range without importing it into Corel WordPerfect. This command must be used in conjunction with other commands, such as SpreadsheetImportFilename, SpreadsheetImportRange, and SpreadsheetImportType. This command is the equivalent of choosing Tools, Spreadsheet, Create Link, specifying a spreadsheet, range, and import type, Link.
SpreadsheetCreateLink
None.
SpreadsheetCreateLinkDlg displays the Create Spreadsheet Link dialog box. This command is the equivalent of choosing Tools, Spreadsheet, Create Link.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpreadsheetCreateLinkDlg
None.
SpreadsheetCreateLinkPerform establishes a link to a spreadsheet or spreadsheet range and imports it into Corel WordPerfect. This command must be used in conjunction with other commands, such as SpreadsheetImportFilename, SpreadsheetImportRange, and SpreadsheetImportType. This command is the equivalent of choosing Tools, Spreadsheet, Create Link, specifying a spreadsheet, range, and import type, Link & Import.
SpreadsheetCreateLinkPerform
None.
SpreadsheetEditLink modifies a link to a spreadsheet or spreadsheet range without importing it into Corel WordPerfect. This command must be used in conjunction with other commands, such as SpreadsheetImportFilename, SpreadsheetImportRange, and SpreadsheetImportType. This command is the equivalent of choosing Tools, Spreadsheet, Edit Link, specifying a spreadsheet, range, and import type, Link.
SpreadsheetEditLink
None.
SpreadsheetEditLinkDlg opens the Edit Spreadsheet Link dialog box, if there is a Spreadsheet link in the document to edit. Otherwise, a Not Found error message is displayed. This command is the equivalent of choosing Tools, Spreadsheet, Edit Link.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpreadsheetEditLinkDlg
None.
SpreadsheetEditLinkPerform modifies a link to a spreadsheet or spreadsheet range and imports it into Corel WordPerfect. This command must be used in conjunction with other commands, such as SpreadsheetImportFilename, SpreadsheetImportRange, and SpreadsheetImportType. This command is the equivalent of choosing Tools, Spreadsheet, Edit Link, specifying a spreadsheet, range, and import type, Link & Import. The current document must have a Spreadsheet link to edit.
SpreadsheetEditLinkPerform
None.
SpreadsheetImportDlg opens the Import Spreadsheet dialog box. This command is the equivalent of choosing Tools, Spreadsheet, Import.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpreadsheetImportDlg
None.
SpreadsheetImportFilename specifies the name of a spreadsheet to import, link, or import and link. This command must be used in conjunction with other commands, such as SpreadsheetCreateLink, SpreadsheetCreateLinkPerform, SpreadsheetEditLink, SpreadsheetEditLinkPerform, SpreadsheetImportPerform, SpreadsheetImportRange, and SpreadsheetImportType.
SpreadsheetImportFilename(Filename)
To create a link to a range named BOOKS in a spreadsheet named SALES.1Q, the command sequence is:
SpreadsheetImportFilename("C:\PL\SALES.1Q")
SpreadsheetImportRange("BOOKS")
SpreadsheetImportType(Table!)
SpreadsheetCreateLink
SpreadsheetImportPerform imports a spreadsheet or spreadsheet range into the active document. This command must be used in conjunction with other commands, such as SpreadsheetImportFilename, SpreadsheetImportRange, and SpreadsheetImportType. This command is the equivalent of choosing Tools, Spreadsheet, Import, specifying a spreadsheet, range, and import type, Import.
SpreadsheetImportPerform
None.
SpreadsheetImportRange specifies a spreadsheet range to import, link, or import and link. This command must be used in conjunction with other commands, such as SpreadsheetCreateLink, SpreadsheetCreateLinkPerform, SpreadsheetEditLink, SpreadsheetEditLinkPerform, SpreadsheetImportPerform, SpreadsheetImportFilename, and SpreadsheetImportType.
SpreadsheetImportRange(Range)
To create a link to a range named BOOKS in a spreadsheet named SALES.1Q, the command sequence is:
SpreadsheetImportFilename("C:\PL\SALES.1Q")
SpreadsheetImportRange("BOOKS")
SpreadsheetImportType(Table!)
SpreadsheetCreateLink
SpreadsheetImportType determines whether to import a spreadsheet or spreadsheet range as text or as a table. This command must be used in conjunction with other commands, such as SpreadsheetCreateLink, SpreadsheetCreateLinkPerform, SpreadsheetEditLink, SpreadsheetEditLinkPerform, SpreadsheetImportPerform, SpreadsheetImportFilename, and SpreadsheetImportRange.
SpreadsheetImportType(Import Format)
Enumerated Type | Numeric Equivalent | Description |
Text! | 1 | Text format |
Table! | 5 | Table format |
To import a spreadsheet range named BOOKS in a spreadsheet named SALES.1Q as a table, the command sequence is:
SpreadsheetImportFilename("C:\SALES.1Q")
SpreadsheetImportRange("BOOKS")
SpreadsheetImportType(Table!)
SpreadsheetImportPerform
SpreadsheetLinkOptionsDlg opens the Spreadsheet Link Options dialog box. This command is the equivalent of choosing Tools, Spreadsheet, Link Options.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SpreadsheetLinkOptionsDlg
None.
SpreadsheetShowLinkCode determines whether to display spreadsheet link codes. This command is the equivalent of choosing Tools, Spreadsheet, Link Options, Show Link Codes.
SpreadsheetShowLinkCode(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Links not displayed |
Yes! | 1 | Links displayed |
To display spreadsheet link codes, the command is:
SpreadsheetShowLinkCode(Yes!)
SpreadsheetUpdateLinks updates all spreadsheet links in the current document. This command is the equivalent of choosing Tools, Spreadsheet, Link Options, Update All Links.
SpreadsheetUpdateLinks
None.
SpreadsheetUpdateOnRetrieve determines whether to update spreadsheet links every time the document containing them is retrieved. This command is the equivalent of choosing Tools, Spreadsheet, Link Options, Update on Retrieve.
SpreadsheetUpdateOnRetrieve(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Links not updated |
Yes! | 1 | Links updated |
To update all spreadsheet links when the document they are in is retrieved, the command is:
SpreadsheetUpdateOnRetrieve(Yes!)
StartProgram starts another program.
StartProgram(Program;Switches;Default Directory;Hot Key;Clear Screen)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not rewrite screen |
Yes! | 1 | Rewrite screen |
To start Corel Presentations without rewriting the Corel WordPerfect screen, the command is:
StartProgram("C:\COREL\PR20\PR.EXE";;"C:\DOCS";"P";No!)
StatusLineUnits specifies a measurement unit for the status line display. This command is the equivalent of choosing File, Setup, Environment, Units of Measure, Status Line Display, and selecting a unit of measure.
StatusLineUnits(Units)
Enumerated Type | Numeric Equivalent | Description |
Inches! | 0 | Inches (") |
InchesI! | 1 | Inches (i) |
Centimeters! | 2 | Centimeters |
Millimeters! | 3 | Millimeters |
Points! | 4 | Points |
WP1200ths! | 5 | Corel WordPerfect Units (1200ths of an inch) |
WP42Units! | 6 | WordPerfect Corporation's WordPerfect 4.2 Units (rows and columns) |
To display status line measurements in points, the command is:
StatusLineUnits(Points!)
StyleCodes edits style codes. This command must be used in conjunction with other commands, such as StyleEditBegin, StyleEditEnd, and SubstructureExit. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Style Content.
StyleCodes(Off Codes State)
Enumerated Type | Numeric Equivalent | Description |
WithoutOffCodes! | 0 | Do not include style off codes |
WithOffCodes! | 1 | Include style off codes |
To add a Times font code to a style named Heading, the command sequence is:
StyleEditBegin("Heading")
StyleCodes()
Font("Times")
SubstructureExit
StyleEditEnd(Save!)
StyleCopy copies a style between the current document, the personal library, and the shared library. This command is the equivalent of choosing Layout, Styles, selecting a style, Copy, and selecting a destination.
StyleCopy(Name;Source;Destination;New Name)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
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 |
To copy a style named Heading from the current document to the personal library, the command is:
StyleCopy("Heading";CurrentDoc!;PersonalLibrary!)
StyleCreate creates a style. This command is the equivalent of choosing Layout, Styles, Create, entering a style name, selecting a style type, and specifying whether to use the current paragraph as a pattern.
StyleCreate(Name;Type;Pattern;Location)
Enumerated Type | Numeric Equivalent | Description |
OpenStyle! | 1 | Open style |
CharacterStyle! | 2 | Character style |
ParagraphStyle! | 3 | Paragraph style |
Enumerated Type | Numeric Equivalent | Description |
CreateFromCurrent! | 1 | Current paragraph style |
CreateBulletStyle! | 2 | Bullet style using the first letter of the style name as the bullet type |
CreateNumberStyle! | 3 | Incrementing number style |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To create a paragraph style named Heading and save it in the personal library, the command is:
StyleCreate("Heading";ParagraphStyle!;;PersonalLibrary!)
StyleDefaultPersonalLibrary specifies the name of the default personal library. This command is the equivalent of choosing File, Setup, Location of Files, Style Files, Default Personal Library.
StyleDefaultPersonalLibrary(Name)
To specify a file named BOB.LIB as the default personal library, the command is:
StyleDefaultPersonalLibrary("BOB.LIB")
StyleDefaultSharedLibrary specifies the name of the default shared library. This command is the equivalent of choosing File, Setup, Location of Files, Style Files, Default Shared Library.
StyleDefaultSharedLibrary(Name)
To specify a file named WORK.LIB as the default shared library, the command is:
StyleDefaultSharedLibrary("WORK.LIB")
StyleDelete deletes a style. This command is the equivalent of choosing Layout, Styles, selecting a style, Delete, and selecting Including Codes or Leaving Codes.
StyleDelete(Name;Codes;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
IncludingCodes! | 4 | Delete style and codes |
LeavingCodes! | 5 | Delete style, leave codes |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To delete a style named Heading from the default personal library, leaving the codes that are part of the style in the document, the command is:
StyleDelete("Heading";LeavingCodes!;PersonalLibrary!)
StyleDescription changes a style description. This command must be used in conjunction with other commands, such as StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Description, and entering a description.
StyleDescription(Description)
To change the description of a style named Heading in the current document, the command sequence is:
StyleEditBegin("Heading";CurrentDoc!)
StyleDescription ("1st level heading style")
StyleEditEnd(Save!)
StyleDlg opens the Style List dialog box. This command is the equivalent of choosing Layout, Styles.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
StyleDlg
None.
StyleEditBegin marks the start of changes to a style. Any changes must appear between StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit.
StyleEditBegin(Name;Location)
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 |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To begin editing a style named Heading saved in the current document, the command is:
StyleEditBegin("Heading";CurrentDoc!)
StyleEditEnd marks the end of changes to a style and determines whether to save the changes. This command must be used in conjunction with StyleEditBegin. This command is the equivalent of choosing OK or Cancel in the Edit Style dialog box.
StyleEditEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel |
Save! | 1 | Save |
To end style editing and save changes, the command is:
StyleEditEnd(Save!)
StyleEnterKeySetting specifies the effect of pressing Enter when a style is on. This command must be used in conjunction with other commands, such as StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Enter Key Action, and selecting an option.
StyleEnterKeySetting(Function)
Enumerated Type | Numeric Equivalent | Description |
HardReturn! | 0 | Inserts a hard return |
StyleOff! | 4 | Turns off style |
StyleOffOn! | 12 | Turns style off and then on |
To specify that Enter turns off a style named Heading, the command sequence is:
StyleEditBegin("Heading")
StyleEnterKeySetting(StyleOff!)
StyleEditEnd(Save!)
StyleLinkTo specifies a style to turn on when Enter is pressed. This command must be used in conjunction with other commands, such as StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Enter Key Action, Turn Style Off and Link to:, and specifying a style.
StyleLinkTo(Name)
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 |
To link a style named Body Text to a style named Heading, the command sequence is:
StyleEditBegin("Heading")
StyleLinkTo("Body Text")
StyleEditEnd(Save!)
StyleOff moves the cursor to the right of a Character Style Off code [Char Style Off]. This command is not recordable. To use this command, you must type it into the macro.
StyleOff(Name)
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 |
To turn off a style named Description, the command is:
StyleOff("Description")
StyleOn turns on a style. This command is the equivalent of choosing Layout, Styles, highlighting a style, Select.
StyleOn(Name;SkipEmptyParagraphs)
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 |
Enumerated Type | Numeric Equivalent |
SkipEmptyParagraphs! | 1 |
To turn on a style named Heading, the command is:
StyleOn("Heading")
StylePersonalLibrary specifies the personal library file for the current document. This command is the equivalent of choosing File, Setup, Location of Files, Style Files, Directory for Personal Libraries, entering a directory name, Default Personal Library, and entering a library name.
StylePersonalLibrary(Name)
To specify a file named WORK.LIB as the personal library for the current document, the command is:
StylePersonalLibrary("WORK.LIB")
StyleRename renames a style. This command must be used in conjunction with other commands, such StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Style Name, and entering a name.
StyleRename(Name)
To rename a style from Heading to Level1, the command sequence is:
StyleEditBegin("Heading")
StyleRename("Level1")
StyleEditEnd(Save!)
StyleRetrieve retrieves the styles in a specified style file. This command is the equivalent of choosing Layout, Style, Retrieve, and entering the name of a style file.
StyleRetrieve(Name;Type;Location)
Enumerated Type | Numeric Equivalent | Description |
UserStyles! | 1 | User-created styles only |
SystemStyles! | 2 | System (Corel WordPerfect) styles only |
AllStyles! | 3 | User and system styles |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To retrieve a style file named SCRIPT.STY into the current document, the command is:
StyleRetrieve("SCRIPT.STY";AllStyles!;CurrentDoc!)
StyleSave saves styles from a library into a style file. This command is the equivalent of choosing Layout, Styles, Save, and entering a style filename.
StyleSave(Name;Type;Location)
Enumerated Type | Numeric Equivalent | Description |
UserStyles! | 1 | User styles only |
SystemStyles! | 2 | System styles only |
AllStyles! | 3 | User and system styles |
Enumerated Type | Numeric Equivalent | Description |
CurrentDoc! | 0 | Current document |
PersonalLibrary! | 1 | Personal library |
SharedLibrary! | 2 | Shared library |
To save the styles in the personal library in a style file named SCRIPT.STY, the command is:
StyleSave("SCRIPT.STY";UserStyles!;PersonalLibrary!)
StyleSharedLibrary specifies the shared library file for the current document.
This command is the equivalent of choosing File, select, Location of Files, Style files, Directory for Shared Files, entering a directory name, Default Shared Files, entering a library name.
StyleSharedLibrary(Name)
To specify a file named SHARED.LIB as the shared library for the current document, the command is:
StyleSharedLibrary("SHARED.LIB")
StyleSystemOn turns on a system style. This command is the equivalent of choosing Layout, Styles, highlighting a system style, Select.
StyleSystemOn(Name)
Enumerated Type | Numeric Equivalent | Description |
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 |
To turn on the Heading 1 system style, the command is:
StyleSystemOn(Heading1Style!)
StyleType specifies a style type. This command must be used in combination with other commands, such as StyleEditBegin and StyleEditEnd. This command is the equivalent of choosing Layout, Styles, selecting a style, Edit, Style Type, and selecting a type.
StyleType(Type)
Enumerated Type | Numeric Equivalent | Description |
OpenStyle! | 1 | Open style |
CharacterStyle! | 2 | Character style |
ParagraphStyle! | 3 | Paragraph style |
ParagraphAutoStyle! | 4 | Automatic paragraph style |
CharacterAutoStyle! | 5 | Automatic character style |
To specify a paragraph style type for a style named Heading, the command sequence is:
StyleEditBegin("Heading") StyleType(ParagraphStyle!) StyleEditEnd(Save!)
SubdividePage divides a physical page into two or more logical pages. This command is the equivalent of choosing Layout, Page, Subdivide Page, and entering the number of columns and rows.
SubdividePage(Columns;Rows)
To subdivide a physical page into four logical pages (two columns and two rows), the command is:
SubdividePage(2;2)
SubdividePageDlg displays the Subdivide Page dialog box. This command is the equivalent of choosing Layout, Page, Subdivide Page.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SubdividePageDlg
None.
SubdividePageOff ends the division of a physical page into logical pages. This command is the equivalent of choosing Layout, Page, Subdivide Page, Off.
SubdividePageOff
None.
SubdocDlg opens the Include Subdocument dialog box. This command is the equivalent of choosing File, Master Document, Subdocument.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SubdocDlg
None.
SubdocInclude inserts a document into the current document as a subdocument. This command is the equivalent of choosing File, Master Document, Subdocument, and entering a filename.
SubdocInclude(Filename)
To insert a document named CHAPTER3 as a subdocument, the command is:
SubdocInclude("CHAPTER3")
SubdocRename condenses and renames a read-only subdocument and adjusts the subdocument link. This command is the equivalent of choosing File, Master Document, Condense, marking a read-only subdocument that needs to be saved, and specifying a new name.
SubdocRename(Name;New Name)
To rename a subdocument from CHAPTER3 to CHAPTER4, the command is:
SubdocRename("CHAPTER3";"CHAPTER4")
SubjectSearchText specifies text that precedes the document summary subject field when the document is saved. This command is the equivalent of choosing File, Summary, Setup, Subject Search Text, and entering the text.
SubjectSearchText(Text)
To specify "Subject:" as the subject search text, the command is:
SubjectSearchText("Subject:")
SubstructureCancel closes a substructure without saving changes. This command must be used in conjunction with other commands, such as, BoxCaptionEdit, BoxContentEdit, CommentCreate, CommentEdit, DelayCodes, EndnoteCreate, EndnoteEdit, FooterA, FooterB, FootnoteCreate, FootnoteEdit, HeaderA, HeaderB, InitialCodesDoc, InitialCodesSetup, StyleCodes, ToAEditFullForm, WatermarkA, and WatermarkB.
SubstructureCancel
None.
SubstructureExit closes a substructure, saves changes, and exits to the document (if no Substructure is specified) or to the next of previous substructure of the same type. This command must be used in conjunction with other commands, such as, BoxCaptionEdit, BoxContentEdit, CommentCreate, CommentEdit, DelayCodes, EndnoteCreate, EndnoteEdit, FooterA, FooterB, FootnoteCreate, FootnoteEdit, HeaderA, HeaderB, InitialCodesDoc, InitialCodesSetup, StyleCodes, ToAEditFullForm, WatermarkA, and WatermarkB.
SubstructureExit(Substructure)
Enumerated Type | Numeric Equivalent | Description |
Previous! | 1 | Edit the previous substructure |
Next! | 15 | Edit the next substructure |
To exit a substructure and edit the previous substructure, the command is:
SubstructureExit(Previous!)
Suppress turns off specified page formatting items for the current page. This command is the equivalent of choosing Layout, Page, Suppress, and selecting items.
Suppress(Item1;Item2...)
Enumerated Type | Numeric Equivalent | Description |
PageNumbering! | 0 | Turn off page numbering |
PageNumberBottomCenter! | 1 | Page number at bottom center this page only |
HeaderA! | 2 | Turn off Header A |
HeaderB! | 3 | Turn off Header B |
FooterA! | 4 | Turn off Footer A |
FooterB! | 5 | Turn off Footer B |
WatermarkA! | 6 | Turn off Watermark A |
WatermarkB! | 7 | Turn off Watermark B |
To turn off page numbering and Header A on the current page, the command is:
Suppress(PageNumbering!;HeaderA!)
SwitchDlg opens the Switch to Document dialog box. This command is the equivalent of choosing Window, Switch To.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
SwitchDlg
None.
SwitchDoc switches the active document window. This command is the equivalent of choosing Window, Switch, and selecting a window.
SwitchDoc(Document)
To switch to document window 2, the command is:
SwitchDoc(2)
SwitchKey switches between the last two document windows used. If Block is on, SwitchKey opens the Case Convert dialog box.
SwitchKey
None.
Tab inserts a tab.
Tab
None.
TabAdd adds one or more absolute tab sets to the current setting without changing any other tab settings.
TabAdd(Position1;Type1;Position2;Type2;...)
Enumerated Type | Numeric Equivalent | Description |
TabLeft! | 0 | Left |
TabCenter! | 1 | Center |
TabRight! | 2 | Right |
TabDecimal! | 3 | Decimal align |
TabLeftDot! | 16 | Left with dot leader |
TabCenterDot! | 17 | Center with dot leader |
TabRightDot! | 18 | Right with dot leader |
TabDecimalDot! | 19 | Decimal align with dot leader |
To add an absolute center tab at 3.2", the command is:
TabAdd(3.2";TabCenter!)
TabCenter inserts a center aligned tab.
TabCenter(Leader)
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | No dot leader |
DotLeader! | 1 | Dot leader |
To insert a center tab with a dot leader, the command is:
TabCenter(DotLeader!)
TabDecimal inserts a decimal align tab.
TabDecimal(Leader)
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | No dot leader |
DotLeader! | 1 | Dot leader |
To insert a decimal tab with a dot leader, the command is:
TabDecimal(DotLeader!)
TabDelete deletes one absolute tab setting without affecting any other tab settings.
TabDelete(Position)
To remove an absolute tab setting at 3", the command is:
TabDelete(3")
TabDlg opens the Tab Set dialog box. This command is the equivalent of choosing Layout, Line, Tab Set.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TabDlg
None.
TabKey inserts a tab. When Outline is on, TabKey moves to the next outline level. This command is the equivalent of pressing Tab. This command is not recordable. To use this command, you must type it into the macro.
TabKey
None.
TableAdjustBegin initiates table adjustments and is used in combination with commands such as TableAdjustColumnWidth and TableAdjustEnd. This command is only recordable when the Ruler is displayed; however, it will execute even if the Ruler is not displayed. With the Ruler displayed, this command is the equivalent of making adjustments, such as column width, to a table.
TableAdjustBegin
None.
TableAdjustColumnWidth changes the width of a specified column. This command only records when the Ruler is displayed; however, it will execute properly even if the Ruler is not displayed. While the Ruler is displayed, this command is the equivalent of sizing a column by dragging a triangular column marker (located on the Ruler) to the desired position.
TableAdjustColumnWidth(Column Number;Column Width)
To adjust the width of column three to 2.75", the command is:
TableAdjustColumnWidth(3;2.75")
TableAdjustEnd completes adjustments to a table and is used in combination with commands such as TableAdjustColumnWidth and TableAdjustBegin. This command is only recordable when the Ruler is displayed; however, it will execute even if the Ruler is not displayed. With the Ruler displayed, this command is the equivalent of making adjustments, such as column width, to a table.
TableAdjustEnd
None.
TableAdjustPosition changes the position of a table relative to the left edge of the page. This command only records when the Ruler is displayed; however, it will execute properly even if the Ruler is not displayed. While the Ruler is displayed, this command is the equivalent of adjusting the position of a table by dragging the left edge table marker (located on the Ruler) to the desired position.
TableAdjustPosition(Position)
To adjust the current position of a table to two inches from the left edge of the page, the command is:
TableAdjustPosition(2")
TableAttributeOff turns off one or more character attributes in a table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Appearance or Size, and deselecting attributes to turn off.
TableAttributeOff(Attribute1;Attribute2;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn off Bold in a table, the command is:
TableAttributeOff(Bold!)
TableAttributeOn turns on one or more character attributes in a table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Appearance or Size, selecting attributes to turn on.
TableAttributeOn(Attribute1;Attribute2;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn on Bold and Underline in a table, the command is:
TableAttributeOn(Bold!;Underline!)
TableAutoFormulaEntry determines whether formulas can be entered in tables at the document level or only in table editing mode. This command is the equivalent of choosing Layout, Tables, Edit, Formula, Formula Recognition at Document Level.
TableAutoFormulaEntry(State)
Enumerated Type | Numeric Equivalent | Description |
On! | 1 | Formulas can be entered at the document level |
Off! | 0 | Formulas can only be entered at the table editing level |
To allow formula entry at the document level, the command is:
TableAutoFormulaEntry(On!)
TableAutoRowInsert turns off and on the feature which inserts a new row into a table when you press Tab with the insertion point in the last cell of the table. This command is the equivalent of placing the insertion point in a table, choosing Table, Table Format, then selecting or deselecting the Auto Row Insert box.
TableAutoRowInsert(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 1 | Move out of the table when pressing Tab |
Yes! | 0 | Add a new row to the table when pressing Tab |
To specify that pressing Tab in the last cell of the last row of the current table inserts a new row into the table, the command is:
TableAutoRowInsert(Yes!)
TableBlockOff turns off Block in the table editing mode. With Block on while in the table editing mode, this command is the equivalent of pressing Alt+F4.
TableBlockOff
None.
TableBlockOn turns on Block in the table editing mode. This command is the equivalent of pressing Alt+F4 while in table editing mode.
TableBlockOn
None.
TableBorder specifies a border type for a table. This command must be used in conjunction with other commands, such as TableBorderEditBegin and TableBorderEditEnd. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Border/Fill, Border Style, highlighting a border style, Select.
TableBorder(Type)
Enumerated Type | Numeric Equivalent | Description |
SpacingOnly! | 0 | No border |
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 border outside, thick border inside |
ThickThinBorder! | 8 | Thick border outside, thin border inside |
ThickTopBottomBorder! | 9 | Thick top and bottom borders (no side borders) |
ButtonBorder! | 10 | Button border |
ColumnBorderBetween! | 11 | Vertical separator line between columns |
ColumnBorderAll! | 12 | Outside vertical border and all interior vertical lines |
NoBorder! | 127 | Use default lines |
To specify an extra thick table border, the command sequence is:
TableBorderEditBegin
TableBorder(ExtraThickBorder!)
TableBorderEditEnd(Save!)
TableBorderEditBegin initiates table border editing. Any border change commands must appear between this command and TableBorderEditEnd. This command must be used in conjunction with other commands, such as TableBorderEditEnd. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Border/Fill, Border Style.
TableBorderEditBegin
None.
TableBorderEditEnd marks the end of table border editing. This command gives you the option to save changes or cancel changes. This command must be used in conjunction with TableBorderEditBegin.
TableBorderEditEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Cancel changes |
Save! | 1 | Save changes |
To specify and save no table border, the command sequence is:
TableBorderEditBegin
TableBorder(NoBorder!)
TableBorderEditEnd(Save!)
TableCalculate calculates formula values in the current table. This command is the equivalent of choosing Layout, Tables, Edit, Calc.
TableCalculate
None.
TableCalculateAll calculates formula values for all tables and floating cells in the current document. This command is the equivalent of choosing Layout, Tables, Calculate All.
TableCalculateAll
None.
TableCellAttributeOff turns off one or more character attributes in a table cell. This command is the equivalent of choosing Layout, Tables, Edit, Cell, Appearance or Size, and deselecting attributes to turn off.
TableCellAttributeOff(Attribute1;Attribute2;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn off Underline in a table cell, the command is:
TableCellAttributeOff(Underline!)
TableCellAttributeOn turns on one or more character attributes in a table cell. This command is the equivalent of choosing Layout, Tables, Edit, Cell, Appearance or Size, and selecting attributes to turn on.
TableCellAttributeOn(Attribute1;Attribute2;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn on Italics and Large in a table cell, the command is:
TableCellAttributeOn(Italics!;Large!)
TableCellCopy copies the contents of a cell. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, Move/Copy, Copy, and selecting a destination.
TableCellCopy(Destination;Number)
Enumerated Type | Numeric Equivalent | Description |
Down! | 0 | Down |
Right! | 3 | To the right |
Cell! | 4 | To a particular cell |
To copy the contents of a cell four times to the right, the command is:
TableCellCopy(Right!;4)
TableCellCopyDlg opens the Copy Cell dialog box. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, Move/Copy, Copy.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableCellCopyDlg
None.
TableCellCopyTo copies data in the current cell into specified cell(s). With the cursor in the cell to copy, this command is the equivalent of choosing Table, Copy, then specifying cell address.
TableCellCopyTo(Location)
To copy the current cell's data into cell 12A, the command is:
TableCellCopyTo("12A")
TableCellFillColors specifies foreground and background colors for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Lines/Fill, Fill, Fill Style, highlighting a fill style, Select, Foreground Color, highlighting a foreground color, Select, Background Color, highlighting a background color, Select.
TableCellFillColors(Foreground Color Name;Red Value;Green Value;Blue Value;Shading Value;Background Color Name;Red Value;Green Value;Blue Value;Shading Value)
To specify a cyan foreground and a magenta background, the command is:
TableCellFillColors("Cyan";0;255;255;100;"Magenta";255;0;255;100)
TableCellFillStyle specifies a shading style for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Lines/Fill, Fill, Fill Style, highlighting a fill style, Select.
TableCellFillStyle(Fill Style)
Enumerated Type | Numeric Equivalent | Description |
Fill10! | 0 | 10% shade fill |
Fill20! | 1 | 20% shade fill |
Fill30! | 2 | 30% shade fill |
Fill40! | 3 | 40% shade fill |
Fill50! | 4 | 50% shade fill |
Fill60! | 5 | 60% shade fill |
Fill70! | 6 | 70% shade fill |
Fill80! | 7 | 80% shade fill |
Fill90! | 8 | 90% shade fill |
Fill100! | 9 | 100% shade fill |
FillButton! | 10 | Button style fill |
NoFill! | 127 | No fill |
To fill a table cell with 20% shading, the command is:
TableCellFillStyle(Fill20!)
TableCellFormatDlg opens the Cell Format dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Cell.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableCellFormatDlg
None.
TableCellIgnoreCalculation specifies a cell or blocked cells to ignore when table calculations are performed. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Ignore When Calculating.
TableCellIgnoreCalculation(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not ignore |
Yes! | 1 | Ignore |
To ignore the current cell when calculating, the command is:
TableCellIgnoreCalculation(Yes!)
TableCellJustification specifies the justification for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Justification, and selecting a justification option.
TableCellJustification(Justification)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left justified |
Full! | 1 | Full justified |
Center! | 2 | Center justified |
Right! | 3 | Right justified |
FullAll! | 4 | Full justified including last line) |
DecAlign! | 5 | Decimal aligned |
To specify right justification for a cell, the command is:
TableCellJustification(Right!)
TableCellLine changes specified lines around a cell or blocked cells, or in between blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Lines/Fill, selecting the line(s) to change, highlighting a style, Select.
TableCellLine(Lines;Line Style)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left line |
Top! | 1 | Top line |
Inside! | 2 | Inside lines of a block of cells |
Right! | 3 | Right line |
Bottom! | 4 | Bottom line |
Outside! | 5 | Outside lines of a block of cells |
Enumerated Type | Numeric Equivalent | Description |
SingleLine! | 0 | Single line |
DoubleLine! | 1 | Double line |
DashedLine! | 2 | Dashed line |
DottedLine! | 3 | Dotted line |
ThickLine! | 4 | Thick line |
ExtraThickLine! | 5 | Extra thick line |
ThinThickLine! | 6 | Thin line outside, thick line inside |
ThickThinLine! | 7 | Thick line outside, thin line inside |
ButtonTopLeftLine! | 8 | Button with shadow top and left |
ButtonBottomRightLine! | 9 | Button with shadow bottom and right |
TableDefaultLine! | 126 | Default table line |
NoLine! | 127 | No line |
To create a thick line around blocked cells, the command is:
TableCellLine(Outside!;ThickLine!)
TableCellLineColor specifies the line color of a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Lines/Fill, Line Color, Choose Color, highlighting a color, Select.
TableCellLineColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)
To specify magenta cell lines, the command is:
TableCellLineColor("Magenta";255;0;255;100)
TableCellLock prevents a cell or blocked cells from being changed or unlocks locked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Lock.
TableCellLock(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not lock |
Yes! | 1 | Lock |
To lock a cell, the command is:
TableCellLock(Yes!)
TableCellNumberAlignCurrency aligns currency symbols in a block of cells. This command is the equivalent of choosing Layout, Tables, Edit, blocking cells, Cell, Number Type, Currency, Align Currency Symbol.
TableCellNumberAlignCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not align |
Yes! | 1 | Align |
To align currency symbols, the command is:
TableCellNumberAlignCurrency(Yes!)
TableCellNumberDateFormat specifies a date format for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Date, Select Date Format, and selecting a format.
TableCellNumberDateFormat(Format Number)
Number | Example |
1 | July 5, 1959 |
2 | 7/5/59 |
3 | Jul 5, 1959 |
4 | 5 July 1959 |
5 | Sunday, July 5, 1959 |
6 | 12:00 pm |
7 | 05Jul59 |
8 | July 5, 1959 (12:00pm) |
9 | 1993-01-02 |
A | 1/2 |
B | Jan 2 |
C | 08:05:03 |
To display the date in the format Sunday, July 5, 1959, the command is:
TableCellNumberDateFormat(5)
TableCellNumberDecimalDigits specifies how many digits appear after the decimal point. Use with the Fixed2! option of TableCellNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Fixed, Digits After Decimal, and specifying the number of digits.
TableCellNumberDecimalDigits(Number)
To specify that three digits appear after the decimal point, the command sequence is:
TableCellNumberFormat(Fixed2!)
TableCellNumberDecimalDigits(3)
TableCellNumberFormat specifies a number format for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, and selecting a number type.
TableCellNumberFormat(Number Format)
Enumerated Type | Numeric Equivalent | Example |
General! | 0 | 1234.5 |
Integer! | 1 | 1234 |
Fixed2! | 2 | 1234.50 |
Percent! | 3 | 75.2% |
Currency! | 4 | $1234.50 |
Accounting! | 5 | $1234.50 |
Commas! | 6 | 1,234.5 |
Scientific! | 7 | 1.2345e+03 |
DateFormat! | 8 | July 5, 1959 |
TextOnly! | 9 | 1234.5 (treated as text) |
To specify currency as the number type, the command is:
TableCellNumberFormat(Currency!)
TableCellNumberNegativeNumber specifies how to display negative numbers in the current cell or block of cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, and selecting a Negative Numbers option.
TableCellNumberNegativeNumber(Style)
Enumerated Type | Numeric Equivalent | Description |
Minus! | 0 | Minus sign |
Parentheses! | 1 | Parentheses |
CRDR! | 2 | Credit (CR) or Debit (DR) |
To display numbers using the Credit/Debit method, the command is:
TableCellNumberNegativeNumber(CRDR!)
TableCellNumberRound specifies a method for converting numbers entered as decimals to integers. Use with the Integer! option of TableCellNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Integer, Round for Calculation.
TableCellNumberRound(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Truncate |
Yes! | 1 | Round off |
To round off numbers after the decimal point when converting them to integers, the command is:
TableCellNumberRound(Yes!)
TableCellNumberSelectCurrency specifies a currency type for the current cell or block of cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Currency, Currency Symbol Select, highlighting a currency type, Select.
TableCellNumberSelectCurrency(Currency Type)
Enumerated Type | Numeric Equivalent | Description |
DefaultCurrency! | 0 | Default currency |
Dollar! | 1 | Dollar |
Peso! | 2 | Peso |
FrenchCanada! | 3 | French Canada |
Canada! | 4 | Canada |
Brazil! | 5 | Brazil |
Denmark! | 6 | Denmark |
Peseta! | 7 | Peseta |
Croatia! | 8 | Croatia |
CzechRepublic! | 9 | Czeck Republic |
SlovakRepublic! | 10 | Slovak Republic |
Finland! | 11 | Finland |
FinlandIntl! | 12 | Finland (international) |
France! | 13 | France |
Germany! | 14 | Germany |
Greece! | 15 | Greece |
Hungary! | 16 | Hungary |
Iceland! | 17 | Iceland |
Italy! | 18 | Italy |
Japan! | 19 | Japan |
Netherlands! | 20 | Netherlands |
Norway! | 21 | Norway |
NorwayIntl! | 22 | Norway (international) |
Ukraine! | 23 | Ruble |
RubleInt! | 24 | Ruble (international) |
SouthAfrica! | 25 | South Africa |
Sweden! | 26 | Sweden |
Turkey! | 27 | Turkey |
UnitedKingdom! | 28 | United Kingdom |
Switzerland! | 29 | Switzerland |
Austria! | 30 | Austria |
Belgium! | 31 | Belgium |
Ecuador! | 32 | Ecuador |
ElSalvador! | 33 | El Salvador |
Guatemala! | 34 | Guatemala |
Honduras! | 35 | Honduras |
Paraguay! | 36 | Paraguay |
Venezuela! | 37 | Venezuela |
Poland! | 38 | Poland |
Slovenia! | 39 | Slovenia |
Russia! | 40 | Russia |
To specify pesos as the currency type, the command is:
TableCellNumberSelectCurrency(Peso!)
TableCellNumberUseCommas displays commas in numbers with more than three digits to the left of the decimal point. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Use Commas.
TableCellNumberUseCommas(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No commas |
Yes! | 1 | Commas |
To display commas in numbers, the command is:
TableCellNumberUseCommas(Yes!)
TableCellNumberUseCurrency displays a currency symbol with numbers. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Number Type, Currency Symbol On.
TableCellNumberUseCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No currency symbol |
Yes! | 1 | Currency symbol |
To display a currency symbol with numbers, the command is:
TableCellNumberUseCurrency(Yes!)
TableCellsJoin combines blocked cells into one cell. This command is the equivalent of choosing Layout, Tables, Edit, blocking cells, Join, Yes.
TableCellsJoin
None.
TableCellSplitDlg displays the Split Cell dialog box. This command is the equivalent of choosing Table, Split Cell(s).
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableCellSplitDlg
None.
TableCellUseColumnAttribute determines whether to use the specified column attribute in the current cell or blocked cells. This command is the equivalent of Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Use Column, Attributes.
TableCellUseColumnAttribute(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use column attribute |
Yes! | 1 | Use column attribute |
To use the specified column attribute in the current cell, the command is:
TableCellUseColumnAttribute(Yes!)
TableCellUseColumnJust determines whether to use the current column justification in the current cell. This command is the equivalent of Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Use Column, Justification.
TableCellUseColumnJust(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use column justification |
Yes! | 1 | Use column justification |
To use the current column justification in the current cell, the command is:
TableCellUseColumnJust(Yes!)
TableCellUseColumnNumberType determines whether to use the current column number type in a cell or blocked cells. This command is the equivalent of Layout, Tables, Edit, selecting a cell or blocking cells, Cell, Use Column, Number Type.
TableCellUseColumnNumberType(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use column number type |
Yes! | 1 | Use column number type |
To use the current column number type in the current cell, the command is:
TableCellUseColumnNumberType(Yes!)
TableCellUseLineColor specifies a default line color for lines around a cell or block of cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Lines/Fill, Line Color, Use Current Color.
TableCellUseLineColor
None.
TableCellVerticalAlignment specifies vertical alignment for a cell or blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or blocking cells, Cell, and selecting a Vertical Alignment option.
TableCellVerticalAlignment(Alignment)
Enumerated Type | Numeric Equivalent | Description |
Top! | 1 | Top |
Center! | 2 | Center |
Bottom! | 4 | Bottom |
To align text at the bottom, the command is:
TableCellVerticalAlignment(Bottom!)
TableColumnAttributeOff turns off one or more character attributes in a table column. This command is the equivalent of choosing Layout, Tables, Edit, Column, Appearance or Size, and deselecting attributes to turn off.
TableColumnAttributeOff(Attribute;Attribute;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn off Bold in a table column, the command is:
TableColumnAttributeOff(Bold!)
TableColumnAttributeOn turns on one or more character attributes in a table column. This command is the equivalent of choosing Layout, Tables, Edit, Column, Appearance or Size, and selecting attributes to turn on.
TableColumnAttributeOn(Attribute;Attribute;...)
Enumerated Type | Numeric Equivalent | Description |
ExtraLarge! | 0 | Extra large |
VeryLarge! | 1 | Very large |
Large! | 2 | Large |
Small! | 3 | Small |
Fine! | 4 | Fine |
Superscript! | 5 | Superscript |
Subscript! | 6 | Subscript |
Outline! | 7 | Outline |
Italics! | 8 | Italics |
Shadow! | 9 | Shadow |
Redline! | 10 | Redline |
DoubleUnderline! | 11 | Double underline |
Bold! | 12 | Bold |
Strikeout! | 13 | Strikeout |
Underline! | 14 | Underline |
SmallCaps! | 15 | Small caps |
Every! | 16 | All attributes |
To turn on Bold in a table column, the command is:
TableColumnAttributeOn(Bold!)
TableColumnDecimalAlignDigits specifies the number of digit places that appear between the decimal point and the right edge of cells in the current column. This command applies only to cells with decimal align justification. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Decimal Align Position, Digits, and specifying the number of digits.
TableColumnDecimalAlignDigits(Number)
To specify three digit places between the decimal point and the right edge of the cells in the current column, the command is:
TableColumnDecimalAlignDigits(3)
TableColumnDecimalAlignDist specifies the distance between the decimal point and the right edge of cells in the current column. This command applies only to cells with decimal align justification. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Decimal Align Position, Distance, and specifying a distance.
TableColumnDecimalAlignDist(Distance)
To specify 0.2" between the decimal point and the right edge of the cells in the current column, the command is:
TableColumnDecimalAlignDist(0.2")
TableColumnFixedWidth designates a column width as fixed. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Fixed Width.
TableColumnFixedWidth(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Variable width |
Yes! | 1 | Fixed width |
To designate a column width as fixed, the command is:
TableColumnFixedWidth(Yes!)
TableColumnFormatDlg opens the Column Format dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Column.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableColumnFormatDlg
None.
TableColumnJustification specifies the justification for a column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Justification, and selecting a Justification option.
TableColumnJustification(Justification)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left justified |
Full! | 1 | Full justified |
Center! | 2 | Center justified |
Right! | 3 | Right justified |
FullAll! | 4 | Full justified (including last line) |
DecAlign! | 5 | Decimal aligned |
To specify right justification for a column, the command is:
TableColumnJustification(Right!)
TableColumnMarginLeft specifies the amount of space between the left edge of a column and the text in the column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Column Margin, Left, and specifying an amount of space.
TableColumnMarginLeft(Distance)
To specify a left column margin of 0.2", the command is:
TableColumnMarginLeft(0.2")
TableColumnMarginRight specifies the amount of space between the right edge of a column and the text in the column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Column Margin, Right, and specifying an amount of space.
TableColumnMarginRight(Distance)
To specify a right column margin of 0.5", the command is:
TableColumnMarginRight(0.5")
TableColumnNumberAlignCurrency aligns currency symbols in a column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Currency, Align Currency Symbol.
TableColumnNumberAlignCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not align |
Yes! | 1 | Align |
To align currency symbols in the current column, the command is:
TableColumnNumberAlignCurrency(Yes!)
TableColumnNumberDateFormat specifies a date format for displaying dates in the current column. This command must be used in conjunction with other commands, such as TableColumnNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Date, Select Date Format, and selecting a format.
TableColumnNumberDateFormat(Format Number)
Number | Example |
1 | July 5, 1959 |
2 | 7/5/59 |
3 | Jul 5, 1959 |
4 | 5 July 1959 |
5 | Sunday, July 5, 1959 |
6 | 12:00 pm |
7 | 05Jul59 |
8 | July 5, 1959 (12:00pm) |
9 | 1993-01-02 |
A | 1/2 |
B | Jan 2 |
C | 08:05:03 |
To display the date in the format Sunday, July 5, 1959, the command is:
TableEdit
TableColumnNumberFormat(DateFormat!)
TableColumnNumberDateFormat(5)
TableColumnNumberDecimalDigits specifies how many digits appear after the decimal point. It is used with the Fixed2! option of TableColumnNumberFormat. This command must be used in conjunction with other commands, such as TableColumnNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Fixed, Digits After Decimal, and specifying the number of digits.
TableColumnNumberDecimalDigits(Number)
To specify that three digits appear after the decimal point, the command sequence is:
TableColumnNumberFormat(Fixed2!)
TableColumnNumberDecimalDigits(3)
TableColumnNumberFormat specifies a number type format for the current column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, and selecting a number type format.
TableColumnNumberFormat(Number Format)
Enumerated Type | Numeric Equivalent | Example |
General! | 0 | 1234.5 |
Integer! | 1 | 1234 |
Fixed2! | 2 | 1234.50 |
Percent! | 3 | 75.2% |
Currency! | 4 | $1234.50 |
Accounting! | 5 | $1234.50 |
Commas! | 6 | 1,234.5 |
Scientific! | 7 | 1.2345e+03 |
DateFormat! | 8 | July 5, 1959 |
TextOnly! | 9 | 1234.5 (treated as text) |
To specify currency as the number type format, the command is:
TableColumnNumberFormat(Currency!)
TableColumnNumberNegNumber specifies how to display negative numbers in the current column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, and selecting a Negative Numbers option.
TableColumnNumberNegNumber(Style)
Enumerated Type | Numeric Equivalent | Description |
Minus! | 0 | Minus sign |
Parentheses! | 1 | Parentheses |
CRDR! | 2 | Credit (CR) or Debit (DR) |
To display numbers in the Credit/Debit style, the command is:
TableColumnNumberNegNumber(CRDR!)
TableColumnNumberRound specifies how to convert numbers entered as decimals to integers in the current column. Use with the Integer! option of TableColumnNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Integer, Round for Calculation.
TableColumnNumberRound(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Truncate |
Yes! | 1 | Round off |
To round off numbers after the decimal point when converting them to integers, the command is:
TableColumnNumberRound(Yes!)
TableColumnNumberSelCurrency specifies a currency type for the current column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Currency, Currency Symbol Select, highlighting a currency type, Select.
TableColumnNumberSelCurrency(Currency Type)
Enumerated Type | Numeric Equivalent | Description |
Dollar! | 1 | Dollar |
Peso! | 2 | Peso |
FrenchCanada! | 3 | French Canada |
Canada! | 4 | Canada |
Brazil! | 5 | Brazil |
Denmark! | 6 | Denmark |
Peseta! | 7 | Peseta |
Croatia! | 8 | Croatia |
CzechRepublic! | 9 | Czeck Republic |
SlovakRepublic! | 10 | Slovak Republic |
Finland! | 11 | Finland |
FinlandIntl! | 12 | Finland (international) |
France! | 13 | France |
Germany! | 14 | Germany |
Greece! | 15 | Greece |
Hungary! | 16 | Hungary |
Iceland! | 17 | Iceland |
Italy! | 18 | Italy |
Japan! | 19 | Japan |
Netherlands! | 20 | Netherlands |
Norway! | 21 | Norway |
NorwayIntl! | 22 | Norway (international) |
Ukraine! | 23 | Ruble |
RubleInt! | 24 | Russian ruble |
SouthAfrica! | 25 | South Africa |
Sweden! | 26 | Sweden |
Turkey! | 27 | Turkey |
UnitedKingdom! | 28 | United Kingdom |
Switzerland! | 29 | Switzerland |
Austria! | 30 | Austria |
Belgium! | 31 | Belgium |
Ecuador! | 32 | Ecuador |
ElSalvador! | 33 | El Salvador |
Guatemala! | 34 | Guatemala |
Honduras! | 35 | Honduras |
Paraguay! | 36 | Paraguay |
Venezuela! | 37 | Venezuela |
Poland! | 38 | Poland |
Slovenia! | 39 | Slovenia |
Russia! | 40 | Russia |
To specify pesos as the currency type, the command is:
TableColumnNumberSelCurrency(Peso!)
TableColumnNumberUseCommas displays commas in numbers with more than three digits to the left of the decimal point. Use ThousandsSeparator to display a character other than a comma as the separator. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Use Commas.
TableColumnNumberUseCommas(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No commas |
Yes! | 1 | Commas |
To display commas in numbers, the command is:
TableColumnNumberUseCommas(Yes!)
TableColumnNumberUseCurrency displays a currency symbol with numbers. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Number Type, Currency Symbol On.
TableColumnNumberUseCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No currency symbol |
Yes! | 1 | Currency symbol |
To display a currency symbol with numbers, the command is:
TableColumnNumberUseCurrency(Yes!)
TableColumnsFixedWidth designates the width of columns in a table as fixed. This command is the equivalent of choosing Layout, Tables, Edit, Table, Fixed Width.
TableColumnsFixedWidth(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Variable width |
Yes! | 1 | Fixed width |
To designate the width of columns in a table as fixed, the command is:
TableColumnsFixedWidth(Yes!)
TableColumnSize2Fit adjusts table column width to accommodate cell data. With the cursor in a table cell, this command is the equivalent of choosing Table, Size Column to Fit.
TableColumnSize2Fit
None.
TableColumnWidth specifies the width of the current column. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Column, Width, and specifying a width.
TableColumnWidth(Width)
To specify a column width of 1.5", the command is:
TableColumnWidth(1.5")
TableColumnWidthGrow increases the width of a column by a small amount (the amount depends on the unit of measure in use). This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, and pressing Ctrl+Right Arrow.
TableColumnWidthGrow
None.
TableColumnWidthShrink decreases the width of a column by a small amount (the amount depends on the unit of measure in use). This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, and pressing Ctrl+Left Arrow.
TableColumnWidthShrink
None.
TableConvertFrom converts blocked text in tabular or parallel columns to a table. This command is the equivalent of blocking text and choosing Layout, Tables, Create, and selecting an option.
TableConvertFrom(Source Format)
Enumerated Type | Numeric Equivalent | Description |
TabularColumns! | 0 | Tabular columns |
ParallelColumns! | 1 | Parallel columns |
To convert text from tabular columns to a table, the command is:
TableConvertFrom(TabularColumns!)
TableCopy copies the contents of blocked cells, the current column, or the current row. Once copied, the contents of the cells can be inserted into the table using the TableMoveModeEnd command. This command must be used in conjunction with other commands, such as TableMoveModeCancel and TableMoveModeEnd. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column or row or blocking cells, Move/Copy, and selecting an option.
TableCopy(Source)
Enumerated Type | Numeric Equivalent | Description |
Block! | 1 | Blocked cells |
Row! | 2 | Current row |
Column! | 3 | Current column |
To copy the contents of the current column, the command is:
TableCopy(Column!)
TableCreate creates a table. This command is the equivalent of choosing Layout, Tables, Create, and specifying the number of columns and rows.
TableCreate(Columns;Rows)
To create a table with three columns and five rows, the command is:
TableCreate(3;5)
TableCreateDlg opens the Create Table dialog box. This command is the equivalent of choosing Layout, Tables, Create.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableCreateDlg
None.
TableDataFill automatically fills table cells with incremented numbers. The numbers are incremented based on a number or series of numbers already contained in one of the table cells. This command is the equivalent of blocking the cell containing a number(s) to be incremented, blocking cells in which to place the incremented numbers, and choosing AutoFill.
TableDataFill
None.
TableDecimalAlignmentDigits specifies the number of digit places between the decimal point and the right edge of cells in the current table. This command applies only to cells with decimal align justification. This command is the equivalent of choosing Layout, Tables, Edit, Table, Decimal Align Position, Digits, and specifying the number of digits.
TableDecimalAlignmentDigits(Number)
To specify 3 digit places between the decimal point and the right edge of cells in the current table, the command is:
TableDecimalAlignmentDigits(3)
TableDecimalAlignmentDistance specifies the distance between the decimal point and the right edge of cells in the current table. This command applies only to cells with decimal align justification. This command is the equivalent of choosing Layout, Tables, Edit, Table, Decimal Align Position, Distance, and specifying a distance.
TableDecimalAlignmentDistance(Distance)
To specify 0.2" between the decimal point and the right edge of cells in the current table, the command is:
TableDecimalAlignmentDistance(0.2")
TableDefaultLine changes the default line style for a table. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Default Line, Line Style, highlighting a line style, Select.
TableDefaultLine(Line Style)
Enumerated Type | Numeric Equivalent | Description |
SingleLine! | 0 | Single line |
DoubleLine! | 1 | Double line |
DashedLine! | 2 | Dashed line |
DottedLine! | 3 | Dotted line |
ThickLine! | 4 | Thick line |
ExtraThickLine! | 5 | Extra thick line |
ThinThickLine! | 6 | Thin line outside, thick line inside |
ThickThinLine! | 7 | Thick line outside, thin line inside |
ButtonTopLeftLine! | 8 | Sculptured button look with shadow at top and left |
ButtonBottomRightLine! | 9 | Sculptured button look with shadow at bottom and right |
TableDefaultLine! | 126 | Use the default table line |
NoLine! | 127 | No line |
To specify a dotted line as the default table line style, the command is:
TableDefaultLine(DottedLine!)
TableDefaultLineColor specifies the default line color for a table. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Default Line, Color, Choose Color, highlighting a color, Select.
TableDefaultLineColor(Color Name;Red Value;Green Value;Blue Value;Shading Value)
To specify magenta default table lines, the command is:
TableDefaultLineColor("Magenta";255;0;255;100)
TableDeleteBlock deletes the contents of blocked cells. This command is the equivalent of choosing Layout, Tables, Edit, blocking cells, Del, Block.
TableDeleteBlock
None.
TableDeleteColumn deletes one or more table columns. This command is the equivalent of choosing Layout, Tables, Edit, selecting a column, Del, Columns, How Many, and entering the number of columns to delete.
TableDeleteColumn(Number)
To delete one column, the command is:
TableDeleteColumn(1)
TableDeleteDlg displays the Delete dialog box from which you can delete rows, columns, or cell data from a table. This command is the equivalent of choosing Table, Delete.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableDeleteDlg
None.
TableDeleteRow deletes one or more table rows. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row, Del, Rows, How Many, and entering the number of rows to delete.
TableDeleteRow(Number)
To delete two rows, the command is:
TableDeleteRow(2)
TableDlg opens the Table Edit dialog box and puts the current table in editing mode. If the cursor is not in a table, an error is returned. This command is the equivalent of choosing Layout, Tables, Edit.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableDlg
None.
TableEdit initiates editing changes to a table. This command is the equivalent of choosing Layout, Tables, Edit.
TableEdit
None.
TableEditDlg opens the Table Edit dialog box and puts the current table in editing mode. This command is not recordable.
TableEditDlg
None.
TableFill fills a table with the specified fill style. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Border/Fill, Fill Style, highlighting a fill style, Select. This command must be used in conjunction with other commands, such as TableBorderEditBegin or TableBorderEditEnd.
TableFill(Fill Style)
Enumerated Type | Numeric Equivalent | Description |
Fill10! | 0 | 10% shade fill |
Fill20! | 1 | 20% shade fill |
Fill30! | 2 | 30% shade fill |
Fill40! | 3 | 40% shade fill |
Fill50! | 4 | 50% shade fill |
Fill60! | 5 | 60% shade fill |
Fill70! | 6 | 70% shade fill |
Fill80! | 7 | 80% shade fill |
Fill90! | 8 | 90% shade fill |
Fill100! | 9 | 100% shade fill |
FillButton! | 10 | Button style fill |
NoFill! | 127 | No fill |
To specify 20% shading as the fill style for a table, the command is:
TableFill(Fill20!)
TableFormatDlg opens the Table Format dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Table.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableFormatDlg
None.
TableFormatJustification specifies justification for a table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Justification, and selecting a Justification option.
TableFormatJustification(Justification)
Enumerated Type | Numeric Equivalent | Description |
Left! | 0 | Left justified |
Full! | 1 | Full justified |
Center! | 2 | Center justified |
Right! | 3 | Right justified |
FullAll! | 4 | Full justified (including last line) |
DecAlign! | 5 | Decimal aligned |
To specify center justification for a table, the command is:
TableFormatJustification(Center!)
TableFormatRowDlg displays the Row Format dialog box. This command is the equivalent of placing the insertion point in a table, then choosing Row Format.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableFormatRowDlg
None.
TableFormatWidths specifies the width of the columns in the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Width, and specifying a width.
TableFormatWidths(Width)
To specify a column width of 1.5", the command is:
TableFormatWidths(1.5")
TableFormula specifies a formula to insert in the current cell. This command is the equivalent of choosing Layout, Tables, Edit, select a cell, Formula, and entering a formula.
TableFormula(Formula)
To calculate the average of a group of cells named Sales, the command is:
TableFormula("AVE(Sales)")
TableFormulaDlg displays the Table Formula dialog box. This command is the equivalent of placing the insertion point in a table and choosing Table, Formula.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableFormulaDlg
None.
TableGoToEdit lets you choose whether to go into the table edit mode when you leave the Create Table dialog box. This command is the equivalent of choosing Table, Create Table and checking or unchecking the Edit Table box.
TableGoToEdit(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not go into table edit mode |
Yes! | 1 | Go into table edit mode |
To specify that you go into the table edit mode when you leave the Create Table dialog box, the command is:
TableGoToEdit(Yes!)
TabLeft inserts a left aligned tab. This command is the equivalent of pressing Home, Tab for Normal! and Home, Home, Tab for DotLeader!.
TabLeft(Leader)
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | No dot leader |
DotLeader! | 1 | Dot leader |
To insert a left tab with a dot leader, the command is:
TabLeft(DotLeader!)
TableHardColumnBreak inserts a column break and continues the table in the next column when the cursor is at the beginning of a row. This command is the equivalent of pressing Ctrl+Enter while the cursor is in a table located in a text column.
TableHardColumnBreak
None.
TableHardRow inserts a page break and continues the table on the next page. This command is the equivalent of pressing Ctrl+Enter while the cursor is in a table.
TableHardRow
None.
TableHeader designates the current row as a header row. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row, Row, Header Row.
TableHeader(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Not a header row |
Yes! | 1 | Header row |
To make the current row a header row, the command is:
TableHeader(Yes!)
TableInsertColumn inserts a table column. This command is the equivalent of choosing Layout, Tables, Edit, positioning the cursor where you want the new column to appear, Ins, Columns, How Many, entering the number of columns to insert, and selecting Before Cursor Position or After Cursor Position.
TableInsertColumn(Number;Location)
Enumerated Type | Numeric Equivalent | Description |
Before! | 0 | Before cursor |
After! | 1 | After cursor |
To insert two columns after the current column, the command is:
TableInsertColumn(2;After!)
TableInsertDlg displays the Insert dialog box from which you can insert table columns and rows. This command is the equivalent of choosing Table, Insert.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableInsertDlg
None.
TableInsertRow inserts a table row. This command is the equivalent of choosing Layout, Tables, Edit, positioning the cursor where you want the new row to appear, selecting Ins, Rows, How Many, entering the number of rows to insert, and selecting Before Cursor Position or After Cursor Position.
TableInsertRow(Number;Location)
Enumerated Type | Numeric Equivalent | Description |
Before! | 0 | Before cursor |
After! | 1 | After cursor |
To insert one row before the current row, the command is:
TableInsertRow(1;Before!)
TableJoin joins the current table and the table immediately following it into one table. This command is the equivalent of choosing Layout, Tables, Join.
TableJoin
None.
TableLinesDlg opens the Table Lines dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableLinesDlg
None.
TableMarginLeft specifies an amount of space between the left edge of each cell and the text in the cell for the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Column Margins, Left, and specifying an amount of space.
TableMarginLeft(Distance)
To specify a left margin of 0.1" for the current table, the command is:
TableMarginLeft(0.1")
TableMarginRight specifies an amount of space between the right edge of each cell and the text in the cell for the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Column Margins, Right, and specifying an amount of space.
TableMarginRight(Distance)
To specify a right cell margin of 0.1" for the current table, the command is:
TableMarginRight(0.1")
TableMove moves the contents of a cell, blocked cells, the current column, or the current row. After TableMove is executed, the contents of the cell(s) can be inserted into the table with TableMoveModeEnd. TableMove must be used in conjunction with other commands, such as TableMoveModeCancel and TableMoveModeEnd. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, column, or row or blocking cells, Move/Copy, Move, moving the cursor to where you want the text moved, pressing Enter.
TableMove(Source)
Enumerated Type | Numeric Equivalent | Description |
Block! | 1 | Blocked cells |
Row! | 2 | Current row |
Column! | 3 | Current column |
Cell! | 4 | Current cell |
To move the contents of the current column, the command is:
TableMove(Column!)
TableMoveCopyDlg opens the Move dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Move/Copy.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableMoveCopyDlg
None.
TableMoveModeCancel cancels a TableMove or TableCopy. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, column, or row or blocking cells, choosing Move/Copy, Move or Copy, and pressing Esc.
TableMoveModeCancel
None.
TableMoveModeEnd completes a TableCopy or TableMove by inserting the data being copied or moved into the table at the cursor position. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, column, or row or blocking cells, Move/Copy, Move or Copy, moving the cursor to where you want the text moved or copied, and pressing Enter.
TableMoveModeEnd
None.
TableNameAdd names a cell, block of cells, row, column, or table. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell or cells to name, Names, specifying which cells to name, and entering a name.
TableNameAdd(Cells;Name)
Enumerated Type | Numeric Equivalent | Description |
Block! | 1 | Blocked cells |
Row! | 2 | Current row |
Column! | 3 | Current column |
Cell! | 4 | Current cell |
Table! | 5 | Entire table |
FloatingCell! | 6 | Floating cell |
CellsDown! | 7 | Cells below blocked cells |
CellsRight! | 8 | Cells to right of blocked cells |
To name a block of cells "Sales Figures," the command is:
TableNameAdd(Block!;"Sales Figures")
TableNameBlockDlg opens the Create Block Name dialog box. This command must be used in conjunction with other commands, such as TableBlockOn and TableEdit. This command is the equivalent of choosing Layout, Tables, Edit, blocking cells, Names, Block.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameBlockDlg
None.
TableNameCellDlg opens the Create Cell Name dialog box. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, Names, Cell.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameCellDlg
None.
TableNameCellsDlg opens the Name Cells dialog box. This command is the equivalent of choosing Layout, Tables, Edit, blocking cells, Names.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameCellsDlg
None.
TableNameChange changes a table name. This command is the equivalent of choosing Layout, Tables, Edit, Names, List, selecting a name, Edit, and entering a new name.
TableNameChange(Old Name;New Name;New Reference)
To change the name "Sales Figures" from a block in a table named "Table_C" to "1Q Sales," the command is:
TableNameChange("Table_C.Sales Figures";"1Q Sales";"B1:B7")
TableNameColumnDlg opens the Create Column Name dialog box. This command is the equivalent of choosing Layout, Tables, Edit, moving to the column you want to name, Names, Column.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameColumnDlg
None.
TableNameDelete deletes a table name. This command is the equivalent of choosing Layout, Tables, Edit, Names, List, selecting a name, Delete, Yes.
TableNameDelete(Name)
To delete the table name "Sales" in a table named "Table_C," the command is:
TableNameDelete("Table_C.Sales")
TableNameDlg opens the Names dialog box. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, row, or column, Names.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameDlg
None.
TableNameListDlg opens the List Table Names dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Names, List.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameListDlg
None.
TableNameRowDlg opens the Create Row Name dialog box. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row, Names, Row.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameRowDlg
None.
TableNameTableDlg opens the Create Table Name dialog box. This command is the equivalent of choosing Layout, Tables, Edit, Names, Table.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TableNameTableDlg
None.
TableNumberAlignCurrency specifies whether to align currency symbols in a table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Currency, Align Currency Symbol.
TableNumberAlignCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not align |
Yes! | 1 | Align |
To align currency symbols in the current table, the command is:
TableNumberAlignCurrency(Yes!)
TableNumberDateFormat specifies a date format for displaying dates in the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Date, Select Date Format, and selecting a format.
TableNumberDateFormat(Format Number)
Number | Example |
1 | July 5, 1959 |
2 | 7/5/59 |
3 | Jul 5, 1959 |
4 | 5 July 1959 |
5 | Sunday, July 5, 1959 |
6 | 12:00 pm |
7 | 05Jul59 |
8 | July 5, 1959 (12:00pm) |
9 | 1993-01-02 |
A | 1/2 |
B | Jan 2 |
C | 08:05:03 |
To display the date in the format Sunday, July 5, 1959, the command is:
TableNumberDateFormat(5)
TableNumberDecimalDigits specifies how many digits appear after the decimal point. Use with the Fixed2! option of TableNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Fixed, Digits After Decimal, and specifying a number of digits.
TableNumberDecimalDigits(Number)
To specify that three digits appear after the decimal point, the command sequence is:
TableNumberFormat(Fixed2!)
TableNumberDecimalDigits(3)
TableNumberFormat specifies a number format for the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, and selecting a number type.
TableNumberFormat(Number Format)
Enumerated Type | Numeric Equivalent | Example |
General! | 0 | 1234.5 |
Integer! | 1 | 1234 |
Fixed2! | 2 | 1234.50 |
Percent! | 3 | 75.2% |
Currency! | 4 | $1234.50 |
Accounting! | 5 | $1234.50 |
Commas! | 6 | 1,234.5 |
Scientific! | 7 | 1.2345e+03 |
DateFormat! | 8 | July 5, 1959 |
TextOnly! | 9 | 1234.5 (treated as text) |
To specify currency as the number type, the command is:
TableNumberFormat(Currency!)
TableNumberNegativeNumber specifies how to display negative numbers in the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, and selecting a Negative Numbers option.
TableNumberNegativeNumber(Style)
Enumerated Type | Numeric Equivalent | Description |
Minus! | 0 | Minus sign |
Parentheses! | 1 | Parentheses |
CRDR! | 2 | Credit (CR) or Debit (DR) |
To display numbers using the Credit/Debit method, the command is:
TableNumberNegativeNumber(CRDR!)
TableNumberRound specifies how to convert numbers entered as decimals to integers. Use with the Integer! option of TableNumberFormat. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Integer, Round for Calculation.
TableNumberRound(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Truncate |
Yes! | 1 | Round off |
To round off numbers after the decimal point when converting them to integers, the command is:
TableNumberRound(Yes!)
TableNumberSelectCurrency specifies a currency type for the current table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Currency, Currency Symbol Select, highlighting a currency type, Select.
TableNumberSelectCurrency(Currency Type)
Enumerated Type | Numeric Equivalent | Description |
DefaultCurrency! | 0 | Default currency |
Dollar! | 1 | Dollar |
Peso! | 2 | Peso |
FrenchCanada! | 3 | French Canada |
Canada! | 4 | Canada |
Brazil! | 5 | Brazil |
Denmark! | 6 | Denmark |
Peseta! | 7 | Peseta |
Croatia! | 8 | Croatia |
CzechRepublic! | 9 | Czeck Republic |
SlovakRepublic! | 10 | Slovak Republic |
Finland! | 11 | Finland |
FinlandIntl! | 12 | Finland (international) |
France! | 13 | France |
Germany! | 14 | Germany |
Greece! | 15 | Greece |
Hungary! | 16 | Hungary |
Iceland! | 17 | Iceland |
Italy! | 18 | Italy |
Japan! | 19 | Japan |
Netherlands! | 20 | Netherlands |
Norway! | 21 | Norway |
NorwayIntl! | 22 | Norway (international) |
Ukraine! | 23 | Ruble |
RubleIntl! | 24 | Ruble (international) |
SouthAfrica! | 25 | South Africa |
Sweden! | 26 | Sweden |
Turkey! | 27 | Turkey |
UnitedKingdom! | 28 | United Kingdom |
Switzerland! | 29 | Switzerland |
Austria! | 30 | Austria |
Belgium! | 31 | Belgium |
Ecuador! | 32 | Ecuador |
ElSalvador! | 33 | El Salvador |
Guatemala! | 34 | Guatemala |
Honduras! | 35 | Honduras |
Paraguay! | 36 | Paraguay |
Venezuela! | 37 | Venezuela |
Poland! | 38 | Poland |
Slovenia! | 39 | Slovenia |
Russia! | 40 | Russia |
To specify pesos as the currency type, the command is:
TableNumberSelectCurrency(Peso!)
TableNumberUseCommas specifies whether to display commas in numbers with more than three digits to the left of the decimal point. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Use Commas.
TableNumberUseCommas(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No commas |
Yes! | 1 | Commas |
To display commas in numbers, the command is:
TableNumberUseCommas(Yes!)
TableNumberUseCurrency displays a currency symbol with numbers. This command is the equivalent of choosing Layout, Tables, Edit, Table, Number Type, Currency Symbol On.
TableNumberUseCurrency(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No currency symbol |
Yes! | 1 | Currency symbol |
To display a currency symbol with numbers, the command is:
TableNumberUseCurrency(Yes!)
TablePosition specifies the position of a table. This command is the equivalent of choosing Layout, Tables, Edit, Table, Position, and specifying a position.
TablePosition(Position;Absolute Position)
Enumerated Type | Numeric Equivalent | Description |
AlignLeft! | 0 | Align left |
AlignRight! | 1 | Align right |
AlignCenter! | 2 | Align center |
AlignFull! | 3 | Align full |
AlignAbsolute! | 4 | Specify absolute position |
To position a table 1.4" from the left edge of the paper, the command is:
TablePosition(AlignAbsolute!;1.4")
TableReformatAll reformats the numbers in a table if a code changing the document's Decimal Align, Thousands Separator, or Language Code comes before the table. This command is the equivalent of choosing Layout, Tables, Reformat All Numbers.
TableReformatAll
None.
TableRetrieve retrieves the last item moved or copied. This command is the equivalent of choosing Layout, Tables, Edit, positioning the cursor, Move/Copy, selecting an item to retrieve, Retrieve.
TableRetrieve(Item)
Enumerated Type | Numeric Equivalent | Description |
Block! | 1 | Retrieve block to current position |
Row! | 2 | Add row and retrieve |
Column! | 3 | Add column and retrieve |
Cell! | 4 | Retrieve to current position |
To add a row and retrieve into it a row that was copied, the command is:
TableRetrieve(Row!)
TableRowHeight determines whether row height is automatic or fixed, and if fixed, specifies the height. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row or blocking rows, Row, Auto or Fixed, and (if Fixed) entering height.
TableRowHeight(Type;Fixed Height)
Enumerated Type | Numeric Equivalent | Description |
Auto! | 0 | Automatic |
Fixed! | 1 | Fixed |
To specify a fixed row height of 0.25", the command is:
TableRowHeight(Fixed!;0.25")
TableRowMarginBottom specifies the amount of space between the bottom of each cell and text in the cell. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row or blocking rows, Row, Bottom, and specifying an amount of space.
TableRowMarginBottom(Distance)
To specify a bottom margin of 0.05", the command is:
TableRowMarginBottom(0.05")
TableRowMarginTop specifies an amount of space between the top of each cell and text in the cell. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row or blocking rows, Row, Top, and specifying an amount of space.
TableRowMarginTop(Distance)
To specify a top margin of 0.05", the command is:
TableRowMarginTop(0.05")
TableRowNumberOfLines determines whether multiple lines or a single line within a cell are allowed in the cells in a row. This command is the equivalent of choosing Layout, Tables, Edit, selecting a row or blocking rows, Row, Single or Multiple.
TableRowNumberOfLines(State)
Enumerated Type | Numeric Equivalent | Description |
Multiple! | 0 | Allow multiple lines |
Single! | 1 | Allow one line |
To allow multiple lines in a cell, the command is:
TableRowNumberOfLines(Multiple!)
TableSplit splits a table into two tables, the second table beginning with the current row. This command is the equivalent of choosing Layout, Tables, Split.
TableSplit
None.
TableSplitColumn splits the current cell into multiple columns. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, Split, Columns, How Many, and specifying a number of columns.
TableSplitColumn(Number)
To split a cell into two columns, the command is:
TableSplitColumn(2)
TableSplitRow splits the current cell into multiple rows. This command is the equivalent of choosing Layout, Tables, Edit, selecting a cell, Split, Rows, How Many, and specifying a number of rows.
TableSplitRow(Number)
To split a cell into two rows, the command is:
TableSplitRow(2)
TableTextToFormula converts the contents of the current cell into a formula. This command is the equivalent of choosing Layout, Tables, Edit, positioning the cursor in the cell to convert, and pressing Ctrl+F.
TableTextToFormula
None.
TableUndelete undeletes the last deleted item while in table editing mode. This command is not recordable. To use this command, you must type it into the macro.
TableUndelete
None.
TableUseDefaultLinesColor specifies the Line Style line color as the default line color for a table. This command is the equivalent of choosing Layout, Tables, Edit, Lines/Fill, Default Line, Color, Use Line Style Color.
TableUseDefaultLinesColor
None.
TabRight inserts a right aligned tab. This command is the equivalent of choosing Home, Alt+F6 for Normal!, and Home, Home, Alt+F6 for Dotleader!.
TabRight(Leader)
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | No dot leader |
DotLeader! | 1 | Dot leader |
To insert a right tab with a dot leader, the command is:
TabRight(DotLeader!)
TabSet specifies tab settings. This command is the equivalent of choosing Layout, Line, Tab Set, Absolute or Relative, and specifying tab settings.
TabSet(Origin;{Position1;Type1;Position2;Type2;...})
Enumerated Type | Numeric Equivalent | Description |
Absolute! | 0 | Measure from left edge of paper |
Relative! | 1 | Relative to left margin |
Enumerated Type | Numeric Equivalent | Description |
TabLeft! | 0 | Left |
TabCenter! | 1 | Center |
TabRight! | 2 | Right |
TabDecimal! | 3 | Decimal align |
TabLeftDot! | 16 | Left with dot leader |
TabCenterDot! | 17 | Center with dot leader |
TabRightDot! | 18 | Right with dot leader |
TabDecimalDot! | 19 | Decimal align with dot leader |
To set two absolute left tabs at 3" and 4" and a right tab with dot leader at 6", the command is:
TabSet(Absolute!;{3";TabLeft!;4";TabLeft!;6";TabRightDot!})
TemplateCreate opens a new template so you can save it. This command is the equivalent of choosing File, Template, Create.
TemplateCreate
None.
TemplateDelete deletes a template. This command is the equivalent of choosing File, Template, highlighting a template, choosing Delete, then choosing Yes.
TemplateDelete(Name)
To delete the AMANDA.WPT template in the C:\COREL\WP62\TEMPLATE directory, the command is:
TemplateDelete("AMANDA.WPT")
TemplateDescription specifies a descriptive name for a template. After creating a template, this command is the equivalent of choosing File, Save, then typing a descriptive name.
TemplateDescription(Name)
To the current template the descriptive name of Amanda's Letters, the command is:
TemplateDescription("Amanda's Letters")
TemplateEdit opens an existing template so you can edit it. This command is the equivalent of choosing File, Template, highlighting a template, choosing Edit, then choosing Yes.
TemplateEdit(Name)
To edit the AMANDA.WPT template, the command is:
TemplateEdit("AMANDA.WPT")
TemplateSelect opens a template so that you can edit and save it as a Corel WordPerfect document. This command is the equivalent of choosing File, Template, highlighting the template you want to open, then choosing Select.
TemplateSelect(Name;Path)
Enumerated Type | Description |
Personal! | Current personal template directory |
Shared! | Current shared template directory |
To open the AMANDA.WPT template in the C:\COREL\WP62\TEMPLATE directory, the command is:
TemplateSelect("AMANDA.WPT;"C:\COREL\WP62\TEMPLATE")
TemplateSelectionDlg displays the Templates dialog box where you can select a template. This command is the equivalent of choosing File, Template.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TemplateDlg
None.
TextBorderCreate creates a text border. This command must be used in conjunction with TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, either Paragraph, Page, or Column, Border Style, highlighting a border style, Select, highlighting a fill style, Select.
TextBorderCreate(Border Style;Fill Style;Border Type)
Enumerated Type | Numeric Equivalent | Description |
SpacingOnly! | 0 | No border |
SingleBorder! | 1 | Single |
DoubleBorder! | 2 | Double |
DashedBorder! | 3 | Dashed |
DottedBorder! | 4 | Dotted |
ThickBorder! | 5 | Thick |
ExtraThickBorder! | 6 | Extra thick |
ThinThickBorder! | 7 | Thin outside, thick inside |
ThickThinBorder! | 8 | Thick outside, thin inside |
ThickTopBottomBorder! | 9 | Thick top and bottom, no side border |
ButtonBorder! | 10 | Button style |
ColumnBorderBetween! | 11 | Between columns |
ColumnBorderAll! | 12 | Around columns |
NoBorder! | 127 | Use default |
Enumerated Type | Numeric Equivalent | Description |
Fill10! | 0 | 10% |
Fill20! | 1 | 20% |
Fill30! | 2 | 30% |
Fill40! | 3 | 40% |
Fill50! | 4 | 50% |
Fill60! | 5 | 60% |
Fill70! | 6 | 70% |
Fill80! | 7 | 80% |
Fill90! | 8 | 90% |
Fill100! | 9 | 100% |
FillButton! | 10 | Button style |
NoFill! | 127 | No fill |
Enumerated Type | Numeric Equivalent | Description |
PageBorder! | 0 | Page |
ParagraphBorder! | 1 | Paragraph |
ColumnBorder! | 2 | Column |
To create a paragraph border with a single line and a 10% fill, the command sequence is:
TextBorderCreate(SingleBorder!;Fill10!;ParagraphBorder!)
TextBorderEnd(State!)
TextBorderCustomizeDlg displays the Customize Border dialog box. This command must be used in conjunction with TextBorderCreate. This command is the equivalent of choosing Graphics, Borders, either Paragraph, Page, or Column, Customize.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TextBorderCustomizeDlg
None.
TextBorderDlg displays the Edit Border dialog box. This command must be used in conjunction with TextBorderCreate. This command is the equivalent of choosing Graphics, Borders, and either Paragraph, Page, or Column.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TextBorderDlg
None.
TextBorderEdit initiates editing changes to the current border. If the cursor is not in text that has the specified border, an error is returned. This command must be used in conjunction with TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, either Paragraph, Page, or Column, then making an editing change to the border.
TextBorderEdit(Border Type)
Enumerated Type | Numeric Equivalent | Description |
PageBorder! | 0 | Page |
ParagraphBorder! | 1 | Paragraph |
ColumnBorder! | 2 | Column |
To change the fill style of the current page border to 10%, the command sequence is:
TextBorderEdit(PageBorder!)
TextBorderFillStyle(Fill10!)
TextBorderEnd(State!)
TextBorderEnd ends border creation or editing and determines whether to save changes. This command must be used in conjunction with other commands, such as TextBorderCreate and TextBorderEdit.
TextBorderEnd(State)
Enumerated Type | Numeric Equivalent | Description |
Cancel! | 0 | Do not save |
Save! | 1 | Save |
To create a paragraph border with a single line and a 10% fill, the command sequence is:
TextBorderCreate(SingleBorder!;Fill10!;ParagraphBorder!)
TextBorderEnd(State!)
TextBorderFillStyle specifies a fill style for the current border. If the cursor is not in text with a border, an error is returned. This command must be used in conjunction with TextBorderEdit and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, choosing either Paragraph, Page, or Column, Fill Style, highlighting a style, Select.
TextBorderFillStyle(Fill Style)
Enumerated Type | Numeric Equivalent | Description |
Fill10! | 0 | 10% |
Fill20! | 1 | 20% |
Fill30! | 2 | 30% |
Fill40! | 3 | 40% |
Fill50! | 4 | 50% |
Fill60! | 5 | 60% |
Fill70! | 6 | 70% |
Fill80! | 7 | 80% |
Fill90! | 8 | 90% |
Fill100! | 9 | 100% |
FillButton! | 10 | Button style |
NoFill! | 127 | No fill |
To change the fill style of the current page border to 10%, the command sequence is:
TextBorderEdit(PageBorder!)
TextBorderFillStyle(Fill10!)
TextBorderEnd(State!)
TextBorderStyle specifies a border style for the current border. If the cursor is not in text with a border, an error is returned. This command must be used in conjunction with TextBorderEdit and TextBorderEnd. This command is the equivalent of choosing Graphics, Borders, choosing either Paragraph, Page, or Column, Border Style, highlighting a style, Select.
TextBorderStyle(Border Style)
Enumerated Type | Numeric Equivalent | Description |
SpacingOnly! | 0 | No border |
SingleBorder! | 1 | Single |
DoubleBorder! | 2 | Double |
DashedBorder! | 3 | Dashed |
DottedBorder! | 4 | Dotted |
ThickBorder! | 5 | Thick |
ExtraThickBorder! | 6 | Extra thick |
ThinThickBorder! | 7 | Thin outside, thick inside |
ThickThinBorder! | 8 | Thick outside, thin inside |
ThickTopBottomBorder! | 9 | Thick top and bottom, no side border |
ButtonBorder! | 10 | Button style |
ColumnBorderBetween! | 11 | Between columns |
ColumnBorderAll! | 12 | Around columns |
NoBorder! | 127 | Use default |
To change the border style of the current page border to thick, the command sequence is:
TextBorderEdit(PageBorder!)
TextBorderStyle(ThickBorder!)
TextBorderEnd(State!)
TextColor specifies a text color. This command is the equivalent of choosing Font, Print Color, highlighting a color, Select.
TextColor(Name;Red Value;Green Value;Blue Value)
To specify red text, the command is:
TextColor("Red";255;0;0)
TextScreenAutoselect makes a "best guess" selection of a screen type for text mode display. This command must be used in conjunction with SetupSave. This command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Screen Type, Auto Select.
TextScreenAutoselect
None.
TextScreenOptionsDlg displays the Text Mode Screen Type/Colors dialog box. This command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TextScreenOptionsDlg
None.
TextScreenSelect selects a screen type for text mode display. This command must be used in conjunction with SetupSave. This command is the equivalent of choosing File, Setup, Display, Text Mode Screen Type/Colors, Screen Type, highlighting a general screen type, Select, highlighting a specific screen type, Select.
TextScreenSelect(Filename;General Type;Specific Type)
To select an IBM VGA 80x25 16 color screen type, the command is:
TextScreenSelect("TIBM.VRS";"IBM VGA (& compatibles)";"IBM 80x25 16 Color")
TextShade specifies the intensity of a text color, where 100% is full intensity. This command is the equivalent of choosing Font, Print Color, highlighting a color from the Palette Colors list, Shade, and specifying a percentage.
TextShade(Percentage)
To specify blue text of half intensity, the command sequence is:
TextColor("Blue";0;0;255)
TextShade(50)
Thesaurus displays the Thesaurus dialog box. This command is the equivalent of choosing Tools, Writing Tools, Thesaurus.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
Thesaurus
None.
ThousandsSeparator specifies a character that appears in numbers greater than or equal to 1000 to separate each three digits. Use with the Comma! number type specified in the TableNumberFormat types and with Math calculations. This command is the equivalent of choosing Layout, Character, Thousands Separator, and typing in the character.
ThousandsSeparator(Character)
To specify a period (.) as the thousands separator, the command is:
ThousandsSeparator(".")
ToACombinePageNumbers determines whether to combine sequential page numbers in all new tables of authorities. This command is the equivalent of choosing Tools, Table of Authorities, Define, Create or Edit, Setup, Combine Sequential Page Numbers.
ToACombinePageNumbers(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not combine |
Yes! | 1 | Combine |
To combine sequential page numbers in all new tables of authorities, the command is:
ToACombinePageNumbers(Yes!)
ToADefinition specifies a section and inserts a table of authorities definition. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Select.
ToADefinition(Section Name)
To specify a section named SWITCHS and insert a definition, the command is:
ToADefinition("SWITCHS")
ToADefinitionCombine determines whether to combine sequential page numbers in a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, Create or Edit, Combine Sequential Page Numbers.
ToADefinitionCombine(Section Name;State)
Enumerated Type | Numeric Equivalent | Description |
NoCombine! | 0 | Do not combine |
Combine! | 1 | Combine |
To combine sequential page numbers in a section named SWITCHS, the command is:
ToADefinitionCombine("SWITCHS";Combine!)
ToADefinitionCreate creates a table of authorities definition. This command is the equivalent of choosing Tools, Table of Authorities, Define, Create, entering a name, selecting a Numbering Mode option, and specifying options.
ToADefinitionCreate(Section Name;Style;Numbering Mode;Underlining;Sequential Pages;Page Number Format)
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 |
Enumerated Type | Numeric Equivalent | Description |
DefNone! | 0 | No numbers |
DefFollows! | 1 | Number follows entry |
DefParentheses! | 2 | Number in parentheses follows entry |
DefFlushRight! | 3 | Number flush right |
DefLeader! | 4 | Number flush right with dot leader |
Enumerated Type | Numeric Equivalent | Description |
NoToAUnderline! | 0 | No underlining |
ToAUnderline! | 1 | Underlining |
Enumerated Type | Numeric Equivalent | Description |
NoCombine! | 0 | Do not combine |
Combine! | 1 | Combine |
To create a definition for a section named SWITCHS with flush right page numbers and dot leaders, the command is:
ToADefinitionCreate("SWITCHS"; ToAStyle!; DefLeader!; ToAUnderline!; Combine!)
ToADefinitionDelete deletes a table of authorities section definition. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Delete.
ToADefinitionDelete(Section Name)
To delete a section definition named SWITCHS, the command is:
ToADefinitionDelete("SWITCHS")
ToADefinitionDlg displays the Define Table of Authorities dialog box. This command is the equivalent of choosing Tools, Table of Authorities, Define.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ToADefinitionDlg
None.
ToADefinitionMode changes the display of page references in a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Edit, and selecting a Numbering Mode option.
ToADefinitionMode(Section Name;Numbering Mode)
Enumerated Type | Numeric Equivalent | Description |
DefNone! | 0 | No numbers |
DefFollows! | 1 | Number follows entry |
DefParentheses! | 2 | Number in parentheses follows entry |
DefFlushRight! | 3 | Number flush right |
DefLeader! | 4 | Number flush right with dot leader |
To change the display of page references in a section called SWITCHS to flush right with no dot leader, the command is:
ToADefinitionMode("SWITCHS";DefFlushRight!)
ToADefinitionRename renames a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Edit, Name, and entering a name.
ToADefinitionRename(Current Name;New Name)
To rename a section from SWITCHS to UTAH SWITCHS, the command is:
ToADefinitionRename("SWITCHS";"UTAH SWITCHS")
ToADefinitionRetrieve retrieves a section from another document into the current document. This command is the equivalent of choosing Tools, Table of Authorities, Define, Retrieve, entering a filename, and marking sections to retrieve.
ToADefinitionRetrieve(Filename;Section Name)
To retrieve a section named SWITCHS in a file named PROBATE, the command is:
ToADefinitionRetrieve("PROBATE";"SWITCHS")
ToADefinitionStyle changes the style for a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Edit, Style, Select, and highlighting a style.
ToADefinitionStyle(Section Name;Style)
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 |
To specify the TableofCont1 style for a section named SWITCHS, the command is:
ToADefinitionStyle("SWITCHS";ToC1Style!)
ToADefinitionUnderline determines whether underlining is allowed in a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Edit, Allow Underlining.
ToADefinitionUnderline(Section Name;Underlining)
Enumerated Type | Numeric Equivalent | Description |
NoToAUnderline! | 0 | No underlining |
ToAUnderline! | 1 | Underlining |
To allow underlining in a section named SWITCHS, the command is:
ToADefinitionUnderline("SWITCHS";ToAUnderline!)
ToAEditFullForm initiates editing changes to a full form. Use SubstructureExit to end editing and save changes. This command is the equivalent of choosing Tools, Table of Authorities, Edit Full, selecting a form, Full Form, making the editing changes, and pressing F7.
ToAEditFullForm(Short Form)
To edit a full form with the short form Brown v. Board of Education, the command sequence is:
ToAEditFullForm("Brown v. Board of Education")
Type("385 U.S.")
SubstructureExit
ToAEditFullFormDlg displays the Edit Table of Authorities Marks dialog box. This command is the equivalent of choosing Tools, Table of Authorities, Edit Full.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ToAEditFullFormDlg
None.
ToAEditPageFormat changes the page format for a section. This command is the equivalent of choosing Tools, Table of Authorities, Define, highlighting a section, Edit, Page Number Format, Different from Document, and entering a custom page format by accessing Number Codes or adding text.
ToAEditPageFormat(Section Name;Page Format)
Enumerated Type | Numeric Equivalent | Description |
DocFormat! | 0 | Current document format |
To include a chapter number and a period in front of the page number for a section named SWITCHS, the command is:
ToAEditPageFormat("SWITCHS";"[chpt #]"+".[page #]"+"")
ToAEditSection reassigns a reference to a different section. This command is the equivalent of choosing Tools, Table of Authorities, Edit Full, highlighting a reference, Section, highlighting a section, Select.
ToAEditSection(Short Form;Section)
To reassign a reference with the short form Brown v. Board of Education to a section named SWITCHS, the command is:
ToAEditSection("Brown v. Board of Education";"SWITCHS")
ToAEditShortForm renames a short form. This command is the equivalent of choosing Tools, Table of Authorities, Edit Full, Short Form, and entering a new short form.
ToAEditShortForm(Current;New)
To rename a short form Brown v. Board of Education to Brown v. United States, the command is:
ToAEditShortForm("Brown v. Board of Education";"Brown v. United States")
ToAMark marks blocked text as a table of authorities reference. This command is the equivalent of blocking the text to mark, then choosing Tools, Table of Authorities, Mark Full, Section Name, entering a name, Short Form, and entering a short form.
ToAMark(Short Form;Section Name)
To mark a reference with the short form Brown v. Board of Education and include it in a section named SWITCHS, the command is:
ToAMark("Brown v. Board of Education";"SWITCHS")
ToAMarkFullFormDlg displays the ToA Full Form dialog box. This command is the equivalent of blocking text and choosing Tools, Table of Authorities, Mark Full.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ToAMarkFullFormDlg
None.
ToAMarkShortForm marks a short form. This command is the equivalent of choosing Tools, Table of Authorities, Mark Short, and entering a short form.
ToAMarkShortForm(Short Form)
To mark the short form Brown v. Board of Education, the command is:
ToAMarkShortForm("Brown v. Board of Education")
ToAMarkShortFormDlg displays the Mark ToA Short Form dialog box. This command is the equivalent of choosing Tools, Table of Authorities, Mark Short.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ToAMarkShortFormDlg
None.
ToAUnderlining determines whether underlining is allowed in tables of authorities as a default. This command is the equivalent of choosing Tools, Table of Authorities, Define, Edit, Setup, Allow Underlining.
ToAUnderlining(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | No underlining |
Yes! | 1 | Underlining |
To allow underlining in tables of authorities as a default, the command is:
ToAUnderlining(Yes!)
ToCDefinition defines a table of contents and inserts the definition. This command is the equivalent of choosing Tools, Table of Contents, Define, specifying a number of levels, and specifying options.
ToCDefinition({Style1;Format1;Style2;Format2...};Wrap;Page Number Format)
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 |
Enumerated Type | Numeric Equivalent | Description |
DefNone! | 0 | No numbers |
DefFollows! | 1 | Number follows entry |
DefParentheses! | 2 | Number in parentheses follows entry |
DefFlushRight! | 3 | Number flush right |
DefLeader! | 4 | Number flush right with dot leader |
Enumerated Type | Numeric Equivalent | Description |
NoLevelWrap! | 0 | Do not wrap |
LevelWrap! | 1 | Wrap |
Enumerated Type | Numeric Equivalent | Description |
DocFormat! | 0 | Current document format |
To create a single-level table of contents with flush right dot leader page numbers, the command is:
ToCDefinition({ToC1Style!;DefLeader!};LevelWrap!)
ToCDefinitionDlg displays the Define Table of Contents dialog box. This command is the equivalent of choosing Tools, Table of Contents, Define.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
TocDefinitionDlg
None.
ToCMark marks blocked text for inclusion in a table of contents. This command is the equivalent of blocking the text, then choosing Tools, Table of Contents, Mark, and specifying a level.
ToCMark(Level)
To mark text for level 1 of a table of contents, the command is:
ToCMark(1)
ToCMarkDlg displays the Mark Table of Contents dialog box. This command is the equivalent of blocking the text, then choosing Tools, Table of Contents, Mark.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
ToCMarkDlg
None.
Type inserts text at the cursor position. This command is the equivalent of typing in a document window.
Type(Text)
To insert the word "bourgeoisie" in a document, the command is:
Type("bourgeoisie")
TypeChar inserts a character from the Corel WordPerfect character sets. This command is the equivalent of pressing Ctrl+W, selecting a character set and character, and choosing Insert.
TypeChar(Set Number;Character Number)
To insert the section symbol (§), which is character 6 of set 4, the command is:
TypeChar(4;6)
Typeover determines whether Typeover mode is on or off. This command is the equivalent of pressing the Insert (Ins) key.
Typeover(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Off |
On! | 1 | On |
To turn on Typeover mode, the command is:
Typeover(On!)
TypeoverKey toggles the current Typeover mode state. This command is the equivalent of pressing the Insert (Ins) key. This command is not recordable. To use this command, you must type it into the macro.
TypeoverKey
None.
Undelete restores up to the last three deletions. This command is the equivalent of choosing Edit, Undelete, Restore.
Undelete(Level)
To cancel the last deletion, the command is:
Undelete(1)
UndeleteDlg displays the Undelete dialog box. This command is the equivalent of choosing Edit, Undelete.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
UndeleteDlg
None.
UnderlineKey is used by the Keyboard Layout to map the underline keystroke. On the Original keyboard layout this command is the equivalent of pressing F8. This command is not recordable. To use this command, you must type it into the macro.
UnderlineKey
None.
UnderlineSpaces toggles the Underline Spaces option on and off. This command is the equivalent of choosing Font, Font, Underline, Spaces.
UnderlineSpaces(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not underline spaces |
Yes! | 1 | Underline spaces |
To underline spaces in a document, the command is:
UnderlineSpaces(Yes!)
UnderlineTabs toggles the Underline Tabs option on and off. This command is the equivalent of choosing Font, Font, Underline, Tabs.
UnderlineTabs(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not underline tabs |
Yes! | 1 | Underline tabs |
To underline tabs, the command is:
UnderlineTabs(Yes!)
Undo restores the last document change. Choosing Undo a second time restores the last undo. This command is the equivalent of choosing Edit, Undo.
Undo
None.
UndoAllow specifies whether the Undo feature is available. Undo restores the last document change. This command is the equivalent of choosing File, Setup, Environment, Allow Undo.
UndoAllow(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Makes Undo not available |
Yes! | 1 | Makes Undo available |
To allow Undo, the command is:
UndoAllow(Yes!)
UpArrow moves an equation up in the View Equation window of the Equation Editor. This command is the equivalent of pressing Up 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 Up Arrow records PosLineUp.
UpArrow
None.
UseRegQuotesWithNumbers specifies whether to use the feature that uses straight quotes with numbers. This command is the equivalent of choosing Tools, Writing Tools, QuickCorrect, Options, then selecting Use Regular Quotes with Numbers.
UseRegQuotesWithNumbers(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turn off Use Regular Quotes with Numbers |
On! | 1 | Turn on Use Regular Quotes with Numbers |
To turn on the Use Regular Quotes with Numbers feature, the command is:
UseRegQuotesWithNumbers(On!)
VerticalBarSetup toggles the Vertical Scroll Bar on and off in the current display mode. This command is the equivalent of choosing View, Screen Setup, Window Options, Vert. Scroll Bar (either Graphics or Text depending on the current display mode).
VerticalBarSetup(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turns off vertical scroll bar |
On! | 1 | Turns on vertical scroll bar |
To automatically display the vertical scroll bar, the command is:
VerticalBarSetup(On!)
VerticalBarSetupGraphics specifies whether the vertical scroll bar will display in Graphics Mode. This command is the equivalent of choosing View, Screen Setup, Window Options, Vertical Scroll Bar (Graphics) while in Graphics Mode.
VerticalBarSetupGraphics(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not display the vertical scroll bar |
On! | 1 | Display the vertical scroll bar |
To display the vertical scroll bar while in Graphics Mode, the command is:
VerticalBarSetupGraphics(On!)
VerticalBarSetupText specifies whether the vertical scroll bar will display in Text Mode. This command is equivalent to choosing View, Screen Setup, Window Options, Vertical Scroll Bar (Text) while in Text Mode.
VerticalBarSetupText(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Do not display the vertical scroll bar |
On! | 1 | Display the vertical scroll bar |
To display the vertical scroll bar while in Text Mode, the command is:
VerticalBarSetupText(On!)
VolumeNumber specifies a current volume number. This command is the equivalent of choosing Layout, Page, Page Numbering, Volume, New Number, and entering a number.
VolumeNumber(Number)
To specify the current page as volume 5, the command is:
VolumeNumber(5)
VolumeNumberDecrement decreases the current volume number by one. This command is the equivalent of choosing Layout, Page, Page Numbering, Volume, Decrement Number.
VolumeNumberDecrement
None.
VolumeNumberDisplay displays a current volume number. This command is the equivalent of choosing Layout, Page, Page Numbering, Volume, Display in Document.
VolumeNumberDisplay
None.
VolumeNumberIncrement increases a current volume number by one. This command is the equivalent of choosing Layout, Page, Page Numbering, Volume, Increment Number.
VolumeNumberIncrement
None.
VolumeNumberMethod specifies a numbering type to display volume numbers. This command is the equivalent of choosing Layout, Page, Page Numbering, Volume, Numbering Method, and selecting a type.
VolumeNumberMethod(Type)
Enumerated Type | Numeric Equivalent | Description |
Numbers! | 0 | Arabic numbers |
LowerLetters! | 1 | Lowercase letters |
UpperLetters! | 2 | Uppercase letters |
LowerRoman! | 3 | Lowercase roman numerals |
UpperRoman! | 4 | Uppercase roman numerals |
To display volume numbers as uppercase roman numerals, the command is:
VolumeNumberMethod(UpperRoman!)
WatermarkA either creates, edits, or turns off Watermark A. Create and Edit opens the Watermark Editor. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Watermarks, Watermark A, and selecting Create, Edit, or Off.
WatermarkA(State;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turns off Watermark A |
Create! | 1 | Creates Watermark A |
Edit! | 2 | Edits Watermark A |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Watermark on odd pages |
EvenPages! | 2 | Watermark on even pages |
AllPages! | 3 | Watermark on all pages |
If you do not specify a page parameter, the default value AllPages! is used. For the Edit and Off states, no page parameter need be entered unless there is more than one WatermarkA in the document.
To create Watermark A on all pages, the command is:
WatermarkA(Create!;AllPages!)
WatermarkB either creates, edits, or turns off Watermark B. Create and Edit opens the Watermark Editor. This command is the equivalent of choosing Layout, Header/Footer/Watermark, Watermarks, Watermark B, and selecting Create, Edit, or Off.
WatermarkB(State;Pages)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Turns off Watermark B |
Create! | 1 | Creates Watermark B |
Edit! | 2 | Edits Watermark B |
Enumerated Type | Numeric Equivalent | Description |
OddPages! | 1 | Watermark on odd pages |
EvenPages! | 2 | Watermark on even pages |
AllPages! | 3 | Watermark on all pages |
To edit the Watermark B and force it to appear on odd pages regardless of the old definition, the command is:
WatermarkB(Edit!;OddPages!)
WidowOrphan turns Widow/Orphan on and off. This command is the equivalent of choosing Layout, Other, Widow/Orphan Protect.
WidowOrphan(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Deactivates Widow/Orphan |
On! | 1 | Activates Widow/Orphan |
To activate Widow/Orphan, the command is:
WidowOrphan(On!)
WindowCascade overlaps document windows so the title bar of each window displays. This command is the equivalent of choosing Window, Cascade.
WindowCascade
None.
WindowDlg displays the Window dialog box. This command is the equivalent of pressing Ctrl+F3, and choosing Window.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
WindowDlg
None.
WindowFrame frames a current document window. This command is the equivalent of choosing Window, Frame.
WindowFrame
None.
WindowMaximize expands a framed or minimized window to a full-sized window. This command is the equivalent of choosing Window, Maximize.
WindowMaximize
None.
WindowMinimize reduces a framed or maximized window to a smaller window. This command is the equivalent of choosing Window, Minimize.
WindowMinimize
None.
WindowMove moves the top left corner of a current document window to a specified position on a screen grid that is relative to the currently selected screen driver. This command is only available if the current window is framed or re-sized. This command is the equivalent of pressing Ctrl+F3, Window, Move, and positioning the window with the arrow keys.
WindowMove(Col;Row)
To move a framed and sized window to coordinates 100, 100, the command is:
WindowMove(100;100)
WindowNext activates the last accessed document window. This command is the equivalent of choosing Window, Next.
WindowNext
None.
WindowPrevious activates the previous document window in the order the windows were last accessed. This command is the equivalent of choosing Window, Previous.
WindowPrevious
None.
WindowSize specifies the height and width of a window. A current window must be framed for this command to function. This command is the equivalent of pressing Ctrl+F3, Window, Size, and sizing the window with the mouse.
WindowSize(Col;Row;Width;Height)
To define a window that begins at 50 pixels from the left edge of the screen and 100 pixels from the top and extends to 200 and 350 pixels respectively, the command is:
WindowSize(50;100;200;350)
WindowTile reduces open document windows and displays them side by side with no overlapping. This command is the equivalent of choosing Window, Tile.
WindowTile
None.
WordLetterSpacing specifies the display spacing between words and letters. Normal is the specification suggested by the font manufacturer; Optimal is the specification suggested by Corel, Inc. This command is the equivalent of choosing Layout, Other, Printer Functions, Word Spacing and Letterspacing, then choosing word and letterspacing options.
WordLetterSpacing(Word;Letter)
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | Spacing recommended by the font manufacturer |
Optimal! | 100 | Spacing recommended by Corel, Inc. |
Enumerated Type | Numeric Equivalent | Description |
Normal! | 0 | Spacing recommended by the font manufacturer |
Optimal! | 100 | Spacing recommended by Corel, Inc. |
To specify normal word spacing with letterspacing 80 percent of Optimal, the command is:
WordLetterSpacing(Normal!;80)
WordSpacingJustificationLimits adjusts spaces between words to justify text on a line when full justification is active. When a word spacing limit is reached, character spacing begins. This command is the equivalent of choosing Layout, Other, Printer Functions, Word Spacing Justification Limits, and specifying limits.
WordSpacingJustificationLimits(Min;Max)
To specify minimum and maximum justification limits of 40% and 300% respectively, the command is:
WordSpacingJustificationLimits(40;300)
WP51CursorMovement activates or deactivates the Corel WordPerfect 5.1 for DOS cursor movement. This command is the equivalent of choosing File, Setup, Environment, WordPerfect 5.1 Cursor Movement, OK.
WP51CursorMovement(State)
Enumerated Type | Numeric Equivalent | Description |
Off! | 0 | Deactivate Corel WordPerfect 5.1 cursor movement |
On! | 1 | Activate Corel WordPerfect 5.1 cursor movement |
To deactivate Corel WordPerfect 5.1 cursor movement, the command is:
WP51CursorMovement(Off!)
WP51Keyboard activates or deactivates the Corel WordPerfect 5.1 for DOS keyboard. This command is the equivalent of choosing File, Setup, Environment, WordPerfect 5.1 Keyboard (F1 = Cancel).
WP51Keyboard(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | Do not use Corel WordPerfect 5.1 keyboard |
Yes! | 1 | Use Corel WordPerfect 5.1 keyboard |
To deselect the Corel WordPerfect 5.1 keyboard, the command is:
WP51Keyboard(No!)
WPCharDlg displays the Corel WordPerfect Characters dialog box. This command is the equivalent of choosing Font, WP Characters.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
WPCharDlg
None.
WPDocsOnly either displays all documents or only Corel WordPerfect documents in the File Manager. This command is the equivalent of choosing File, File Manager, OK, Sort by, WP Documents Only.
WPDocsOnly(State)
Enumerated Type | Numeric Equivalent | Description |
No! | 0 | All documents |
Yes! | 1 | Only Corel WordPerfect documents |
To display only Corel WordPerfect documents in File Manager, the command is:
WPDocsOnly(Yes!)
WPHelpDlg displays the Corel WordPerfect Info dialog box. This command is the equivalent of choosing Help, WP Info.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
WPHelpDlg
None.
WritingToolsDlg displays the Writing Tools dialog box. This command is the equivalent of choosing Tools, Writing Tools.
For information on recording dialog boxes, see Recording Dialog Boxes in Using Product Commands.
WritingToolsDlg
None.
A number representing a measurement, followed by an optional unit of measurement character (such as ", c, p, or u). If a unit of measurement character is not specified, the program's current unit of measurement will be used. Do not enclose a measurement expression in quotation marks.
Unit of measurement characters are listed below:
" or i | inches |
c | centimeters |
m | millimeters |
p | points |
w | 1200ths of an inch |
u | WordPerfect Corporation's WordPerfect 4.2 units (lines/columns) |
This document contains the same text as distributed by Corel Corporation Limited for WP 6.2 Macros in electronic form. It was created on 12/20/96 using the Folio VIEWS v2.0 product, and converted to HTML format in 2020, with minor modifications to the tables of contents to ease navigability, adding back clearly missing text from the printed WP 6.0 Macro Product Commands Manual or from the WP 6.2 online help, or marking it as missing. Later on, I have added comments, or additional information, clearly marked like this where the original text was insufficiently clear, or missing some important bit of information.
Copyright Corel Corporation Limited 1996
All Rights Reserved.