Chapter 2

Corel^® WordPerfect^® Product Commands
C

CapBeginSentence

Purpose

Automatically capitalize the first letter of each sentence as it is typed.

Syntax

CapBeginSentence (State: enumeration)

Parameters

State

enumeration

Off!

On!

CaseToggle

Purpose

Change the selected text to uppercase or lowercase.

Syntax

CaseToggle ()

Center

Purpose

Insert a [Hd Center on Marg] code at the insertion point, centering the current line of text from the insertion point to the next justification code or [HRt] code.

Syntax

Center ()

See Also

CenterCurrentPage, CenterPages

CenterCurrentPage

Purpose

Center the current page vertically.

Syntax

CenterCurrentPage (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?CenterCurrentPage, CenterPages

CenterPageDlg

Purpose

Display the Center Page(s) dialog box.

Syntax

CenterPageDlg ()

CenterPages

Purpose

Center the current and subsequent pages vertically.

Syntax

CenterPages (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?CenterPages, Center, CenterCurrentPage

ChangeWatermarkGraphicShade

Purpose

Change the shading of a watermark image.

Syntax

ChangeWatermarkGraphicShade (Amount: numeric)

Parameters

Amount

numeric

See Also

ChangeWatermarkTextShade

ChangeWatermarkTextShade

Purpose

Change the shading of watermark text.

Syntax

ChangeWatermarkTextShade (Amount: numeric)

Parameters

Amount

numeric

See Also

ChangeWatermarkGraphicShade

ChapterNumber

Purpose

Specify a chapter number.

Syntax

ChapterNumber (Chapter: numeric)

Parameters

Chapter

numeric

See Also

?ChapterNumber, ChapterNumberDecrement, ChapterNumberDisplay, ChapterNumberIncrement, ChapterNumberMethod

ChapterNumberDecrement

Purpose

Decrease the chapter number by one.

Syntax

ChapterNumberDecrement ()

See Also

ChapterNumber, ChapterNumberDisplay, ChapterNumberIncrement, ChapterNumberMethod

ChapterNumberDisplay

Purpose

Insert the chapter number at the insertion point.

Syntax

ChapterNumberDisplay ()

See Also

ChapterNumber, ChapterNumberDecrement, ChapterNumberIncrement, ChapterNumberMethod

ChapterNumberIncrement

Purpose

Increase the chapter number by one.

Syntax

ChapterNumberIncrement ()

See Also

ChapterNumber, ChapterNumberDecrement, ChapterNumberDisplay, ChapterNumberMethod

ChapterNumberMethod

Purpose

Specify a chapter numbering method.

Syntax

ChapterNumberMethod (Method: enumeration)

Parameters

Method

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

?ChapterNumberMethod, ChapterNumber, ChapterNumberDecrement, ChapterNumberDisplay, ChapterNumberIncrement

Char

Purpose

Prompt the user for a keystroke, then assign the ASCII numeric equivalent of the keystroke to the variable specified in the Character parameter. Only one keystroke is accepted. If more than one character is entered, only the first is accepted. Not recordable.

Syntax

Char (Character: variable; Prompt: string)

Parameters

Character

variable

Prompt

string (optional)

See Also

ZZZ Don't Delete This Record!!!

CharMappingDlg

Purpose

Display the Document Character Map dialog box.

Syntax

CharMappingDlg ()

CheckBoxShippingMacro

Purpose

Play the shipping macro CHECKBOX.WCM to create check boxes in a document that can be changed by clicking on them. CHECKBOX.WCM must be installed.

Syntax

CheckBoxShippingMacro ()

CleanUpSpaces

Purpose

Turn Cut and Paste Cleanup on or off.

Syntax

CleanUpSpaces (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?CleanUpSpaces

ClearDoc

Purpose

Close the current document without saving and leave the current window open.

Syntax

ClearDoc ()

ClearUndoLevels

Purpose

Delete all Undos associated with the current document.

Syntax

ClearUndoLevels ()

ClipboardAppendTo

Purpose

Append the currently selected text to the contents of the Clipboard.

Syntax

ClipboardAppendTo ()

See Also

Append, ClipboardRetrieve, ClipboardSaveTo

ClipboardRetrieve

Purpose

Insert the Clipboard contents at the insertion point.

Syntax

ClipboardRetrieve ()

See Also

Append, ClipboardAppendTo, ClipboardSaveTo

ClipboardSaveTo

Purpose

Save the selected text or graphics to the Clipboard, replacing existing Clipboard contents. If text or graphics are not selected before this command, macro ends or goes to the ONERROR label.

Syntax

ClipboardSaveTo ()

See Also

Append, ClipboardAppendTo, ClipboardRetrieve

ClipboardShippingMacro

Purpose

Play the shipping macro CLIPBRD.WCM to open the Clipboard Viewer. CLIPBRD.WCM must be installed.

Syntax

ClipboardShippingMacro ()

Close

Purpose

Close the current window or text editor.

Syntax

Close (Save: enumeration)

Parameters

Save

enumeration (optional) Default: prompt user to save.

No!

Yes!

See Also

CloseNoSave

CloseAllShippingMacro

Purpose

Play the shipping macro CLOSEALL.WCM to display the Close All Documents dialog box, which presents a list of all open documents with modified documents marked for saving. CLOSEALL.WCM must be installed.

Syntax

CloseAllShippingMacro ()

CloseNoSave

Purpose

Close the current document without saving it.

Syntax

CloseNoSave (Verify: enumeration)

Parameters

Verify

enumeration (optional) Prompt the user to verify close without saving. Default: no prompt.

No!

Yes!

See Also

Close

CodePage

Purpose

Specify code page settings.

Syntax

CodePage (Dos: numeric; Windows: numeric; InputFile: numeric; OutputFile: numeric)

Parameters

Dos

numeric (optional) The DOS code page setting.

Windows

numeric (optional) The Windows code page setting.

InputFile

numeric (optional) Any code number listed for the DOS or Windows parameter.

OutputFile

numeric (optional) Any code number listed for the DOS or Windows parameter.

CodePageDlg

Purpose

Display the Code Page settings dialog box.

Syntax

CodePageDlg ()

ColorAdd

Purpose

Add a color to a palette.

Syntax

ColorAdd (PaletteName: string; PositionIndex: numeric; Red: numeric; Green: numeric; Blue: numeric; ColorName: string)

Parameters

PaletteName

string

PositionIndex

numeric The color position on the palette.

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

ColorName

string This parameter has been left in for backward compatability with previous versions of Corel WordPerfect. To specify a color in Corel WordPerfect 8, use the Red, Green, and Blue parameters.

See Also

ColorDelete, ColorModify

ColorDelete

Purpose

Remove a color from a color palette.

Syntax

ColorDelete (PaletteName: string; ColorName: string)

Parameters

PaletteName

string

ColorName

string This parameter has been left in for backward compatability with previous versions of Corel WordPerfect. To specify a color in Corel WordPerfect 8, use the Red, Green, and Blue parameters.

See Also

ColorAdd, ColorModify

ColorModify

Purpose

Modify and rename a color.

Syntax

ColorModify (PaletteName: string; OldColorName: string; Red: numeric; Green: numeric; Blue: numeric; NewColorName: string)

Parameters

PaletteName

string

OldColorName

string

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

NewColorName

string

See Also

ColorAdd, ColorDelete

ColorPaletteCreate

Purpose

Name a new palette. Use with other commands such as ColorAdd.

Syntax

ColorPaletteCreate (PaletteName: string)

Parameters

PaletteName

string

See Also

ColorPaletteDelete, ColorPaletteRename, ColorPaletteSelect

ColorPaletteDelete

Purpose

Delete a palette.

Syntax

ColorPaletteDelete (PaletteName: string)

Parameters

PaletteName

string

See Also

ColorPaletteCreate, ColorPaletteRename, ColorPaletteSelect

ColorPaletteDlg

Purpose

Display the Define Color Printing Palette dialog box.

Syntax

ColorPaletteDlg ()

ColorPaletteRename

Purpose

Rename a palette.

Syntax

ColorPaletteRename (OldPaletteName: string; NewPaletteName: string)

Parameters

OldPaletteName

string

NewPaletteName

string

See Also

ColorPaletteCreate, ColorPaletteDelete, ColorPaletteSelect

ColorPaletteSelect

Purpose

Select a color palette.

Syntax

ColorPaletteSelect (PaletteName: string)

Parameters

PaletteName

string

See Also

ColorPaletteCreate, ColorPaletteDelete, ColorPaletteRename

ColumnBorderDlg

Purpose

Display the Column Border/Fill dialog box.

Syntax

ColumnBorderDlg ()

ColumnDefineDlg

Purpose

Display the Columns dialog box.

Syntax

ColumnDefineDlg ()

See Also

ColumnsDefinition

ColumnsDefinition

Purpose

Define columns.

Syntax

ColumnsDefinition (ColumnsType: enumeration; VerticalSpacing: numeric; {Spacing: measurement; SpacingDef: enumeration; })

Parameters

ColumnsType

enumeration

Newspaper!

NewspaperBalanced!

Parallel!

ParallelBlockProtect!

VerticalSpacing

numeric The spacing between sections of text in parallel columns.

Spacing

measurement (optional) Alternate between specifying column width and the desired space between the columns. Always paired with the SpacingDef parameter. Enclose Spacing and SpacingDef parameters in braces ({}) separated by semicolons. For multiple columns, alternate Spacing and SpacingDef parameters.

SpacingDef

enumeration (optional) The definition of column width and spacing between columns.

Fixed!

NotFixed!

See Also

ColumnsOff

ColumnsOff

Purpose

Turn off Columns.

Syntax

ColumnsOff ()

See Also

ColumnsDefinition

ColumnsOn

Purpose

Turn on Columns.

Syntax

ColumnsOn ()

See Also

ColumnsDefinition, ColumnsOff

CommentConvert

Purpose

Convert a comment to text.

Syntax

CommentConvert ()

See Also

CommentEdit

CommentCreate

Purpose

Open a new comment window in order to create a new comment.

Syntax

CommentCreate ()

See Also

CommentConvert, CommentEdit, CommentInformation

CommentEdit

Purpose

Open the comment editing screen in order to edit a comment.

Syntax

CommentEdit ()

See Also

CommentConvert

CommentInformation

Purpose

Display the Comment Information dialog box.

Syntax

CommentInformation ()

CommentInsertTime

Purpose

Insert the current time into a comment.

Syntax

CommentInsertTime ()

See Also

CommentCreate, CommentEdit, CommentInsertUserInitials, CommentInsertUserName

CommentInsertUserInitials

Purpose

Insert the user initials specified in Environment Settings into a comment.

Syntax

CommentInsertUserInitials ()

See Also

CommentCreate, CommentEdit, CommentInsertTime, CommentInsertUserName

CommentInsertUserName

Purpose

Insert the user name specified in the Environment Settings dialog box into a comment.

Syntax

CommentInsertUserName ()

See Also

CommentCreate, CommentEdit, CommentInsertTime, CommentInsertUserInitials

CommentNext

Purpose

Go to the next comment.

Syntax

CommentNext ()

CommentPrevious

Purpose

Go to the previous comment.

Syntax

CommentPrevious ()

CommentsDisplaySetup

Purpose

Turn comment display on or off in the current document for the current session. This command does not change display settings for comments.

Syntax

CommentsDisplaySetup (OnOff: enumeration)

Parameters

OnOff

enumeration (optional)

Off!

On!

See Also

PrefDisplaySet

ConditionalEndOfPage

Purpose

Keep a specified number of lines together at a page break. If a page break falls between the lines, the lines move to the next page.

Syntax

ConditionalEndOfPage (LinesTogether: numeric)

Parameters

LinesTogether

numeric

See Also

BlockProtect, KeepTextTogetherDlg, WidowOrphan

ConvertCaseInitialCaps

Purpose

Convert the selected text to lowercase and capitalize the first letter of each word.

Syntax

ConvertCaseInitialCaps ()

See Also

ConvertCaseLowercase, ConvertCaseUppercase

ConvertCaseLowercase

Purpose

Convert the selected text to lowercase, except the first word of each sentence and "I" and its forms, such as "I'm" and "I've."

Syntax

ConvertCaseLowercase ()

See Also

ConvertCaseInitialCaps, ConvertCaseUppercase

ConvertCaseUppercase

Purpose

Convert the selected text to uppercase.

Syntax

ConvertCaseUppercase ()

See Also

ConvertCaseInitialCaps, ConvertCaseLowercase

Copy

Purpose

Copy the selected text. Use Paste to retrieve the copied text. Recordable substitute: EditCopy.

Syntax

Copy ()

See Also

EditCopy

CopyAndPaste

Purpose

Copy the selected text to the Clipboard. Use EditPaste or MoveModeEnd to paste the copied text into the current document. Included for DOS compatibility. Recordable substitutes: EditCopy and EditPaste.

Syntax

CopyAndPaste ()

CorelVersionArchiveCurrentDlg

Purpose

Save a version of the current document.

Syntax

CorelVersionArchiveCurrentDlg ()

CorelVersionRetrieveCurrentDlg

Purpose

Retrieve any saved version of the current document.

Syntax

CorelVersionRetrieveCurrentDlg ()

CorelVersionRetrieveDocumentDlg

Purpose

Retrieve any version already saved for any document.

Syntax

CorelVersionRetrieveDocumentDlg ()

CounterCreate

Purpose

Specify a box reference number.

Syntax

CounterCreate (CounterName: any; {Method: enumeration; })

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

Method

enumeration (optional) The numbering method. To specify different numbering methods for each level, repeat the method parameter. Enclose repeating parameters in braces ({}) separated by a semicolon.

LowLetter!

LowRoman!

Numbers!

UpLetter!

UpRoman!

See Also

CounterDelete, CounterSetMethod, CounterSetValue

CounterDecrement

Purpose

Decrease a counter level by one.

Syntax

CounterDecrement (CounterName: any; Level: numeric)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

Level

numeric

See Also

CounterIncrement, CounterSetValue

CounterDelete

Purpose

Delete a user-defined counter or reset a program-defined counter.

Syntax

CounterDelete (CounterName: any)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

See Also

CounterCreate

CounterDisplay

Purpose

Display the counter value of a box or user-defined counter.

Syntax

CounterDisplay (CounterName: any; Level: numeric)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

Level

numeric

CounterDlg

Purpose

Display the Counter Numbering dialog box.

Syntax

CounterDlg ()

CounterEditLevel

Purpose

Specify the number of levels a counter contains.

Syntax

CounterEditLevel (CounterName: any; NewNumLvls: numeric)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

NewNumLvls

numeric The counter level.

See Also

CounterEditLevelMethod, CounterEditLevelName

CounterEditLevelMethod

Purpose

Change the numbering method for a multi-level counter.

Syntax

CounterEditLevelMethod (CounterName: any; LevelNum: numeric; NewMethod: enumeration)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

LevelNum

numeric

NewMethod

enumeration

LowLetter!

LowRoman!

Numbers!

UpLetter!

UpRoman!

See Also

CounterEditMethod

CounterEditLevelName

Purpose

Rename the specified level of a multi-level counter.

Syntax

CounterEditLevelName (OldCounterName: any; OldLevelName: string; NewLevelName: string)

Parameters

OldCounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

OldLevelName

string

NewLevelName

string

See Also

CounterEditName

CounterEditMethod

Purpose

Change a counter numbering method.

Syntax

CounterEditMethod (CounterName: any; NewMethod: enumeration)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

NewMethod

enumeration

LowLetter!

LowRoman!

Numbers!

UpLetter!

UpRoman!

See Also

CounterEditLevelMethod

CounterEditName

Purpose

Rename a user-defined counter.

Syntax

CounterEditName (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string

See Also

CounterEditLevelName

CounterIncrement

Purpose

Increase a counter level by one.

Syntax

CounterIncrement (CounterName: any; Level: numeric)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

Level

numeric

See Also

CounterDecrement

CounterSetMethod

Purpose

Specify a counter numbering method.

Syntax

CounterSetMethod (CounterName: any; CounterLevel: numeric; Method: enumeration)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

CounterLevel

numeric

Method

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

CounterSetValue

Purpose

Set a counter value.

Syntax

CounterSetValue (CounterName: any; {CounterLevel: numeric; })

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

CounterLevel

numeric (optional) To change counter levels, repeat the CounterLevel parameter.

CreateBoxToggle

Purpose

Enable or disable Drag to Create, which allows you to create and size boxes by clicking and dragging.

Syntax

CreateBoxToggle (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

CreateMapFile

Purpose

Create a .MAP file containing the current document's character mapping and save it with the specified filename and path.

Syntax

CreateMapFile (FileName: string)

Parameters

FileName

string (optional)

CreateRegionLink

Purpose

Indicate that a portion of the current document has been copied to the Clipboard and specify the type of link that has been established.

Syntax

CreateRegionLink (Region: enumeration)

Parameters

Region

enumeration

OBEXRegion!

OLERegion!

CrossRefMarkReference

Purpose

Create a cross-reference.

Syntax

CrossRefMarkReference (TargetName: string; RefType: enumeration; CounterName: any)

Parameters

TargetName

string The reference name.

RefType

enumeration What is referenced.

RefBox!

RefChapter!

RefCounter!

RefEndnote!

RefFootnote!

RefPage!

RefParagraph!

RefSecondaryPage!

RefVolume!

CounterName

any (optional)

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

CrossRefMarkTarget

Purpose

Create a cross-reference target.

Syntax

CrossRefMarkTarget (TagName: string)

Parameters

TagName

string (optional)

CtrlBreak

Purpose

Cancel the current action in Corel WordPerfect.

Syntax

CtrlBreak ()

CustomBoxDlg

Purpose

Display the Custom Box dialog box.

Syntax

CustomBoxDlg ()

Cut

Purpose

Remove the selected text and copy it to the Clipboard, replacing previous Clipboard contents. Included for DOS compatibility. Recordable substitute: EditCut.

Syntax

Cut ()

CutAndPaste

Purpose

Remove the selected text and copy to the Clipboard. Use EditPaste or MoveModeEnd to paste the selection in the current document. Included for DOS compatibility. Recordable substitutes: EditCut and EditPaste.

Syntax

CutAndPaste ()