Chapter 2

Corel^® WordPerfect^® Product Commands
LM

LineStyleEdit

Purpose

Edit a line style. Use with commands such as LineStyleCreate and LineStyleEnd.

Syntax

LineStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

LineStyleCreate, LineStyleDelete, LineStyleEnd

LineStyleEnd

Purpose

Save or cancel changes to a graphics line style.

Syntax

LineStyleEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

LineStyleCreate, LineStyleEdit

LineStyleName

Purpose

Rename a user-defined graphics line style. Corel WordPerfect line styles cannot be renamed. Precede with LineStyleCreate or LineStyleEdit and end with LineStyleEnd.

Syntax

LineStyleName (LineName: string)

Parameters

LineName

string

See Also

LineStyleCreate, LineStyleEdit, LineStyleEnd

LineStyleRetrieve

Purpose

Retrieve all line graphics styles from the specified document or template and add to the specified style list.

Syntax

LineStyleRetrieve (Filename: string; Style: enumeration)

Parameters

Filename

string The path and filename of a document or template containing the styles to retrieve.

Style

enumeration The destination for the retrieved styles. Use CurrentDoc! to add the styles to the current document style list. Use PersonalLibrary! to add the styles to the default template style list. Use SharedLibrary! to add the styles to the additional objects template style list. If an additional objects template is not specified in Files Settings, and SharedLibrary! is used here, the command does nothing.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

LineStyleSave

Purpose

Save a line style library.

Syntax

LineStyleSave (FileName: string; Style: enumeration)

Parameters

FileName

string

Style

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibary!

ListDefineDlg

Purpose

Display the Define List dialog box.

Syntax

ListDefineDlg ()

ListDefinition

Purpose

Select a list definition and specify where to generate the list. Use ListDefinitionCreate to create a definition.

Syntax

ListDefinition (ListName: string; Style: any; Numbering: enumeration; Counter: any; NumberingFormat: string)

Parameters

ListName

string Name or rename a selected list definition.

Style

any (optional)

Numbering

enumeration (optional) The list numbering mode.

Counter

any (optional)

NumberingFormat

string (optional) The numbering characters.

See Also

?ListDefinition, ListDefinitionCreate

ListDefinitionCreate

Purpose

Create a list definition. Follow with commands such as ListDefinitionMode and ListDefinitionStyle.

Syntax

ListDefinitionCreate (ListName: string; Style: any; Numbering: enumeration; Counter: any; NumberingFormat: string)

Parameters

ListName

string

Style

any (optional)

Numbering

enumeration (optional)

Counter

any (optional)

NumberingFormat

string (optional)

See Also

ListDefinition

ListDefinitionDelete

Purpose

Delete a list definition.

Syntax

ListDefinitionDelete (ListName: string)

Parameters

ListName

string

ListDefinitionEditBox

Purpose

Change the box type of a list definition.

Syntax

ListDefinitionEditBox (Name: string; BoxName: any)

Parameters

Name

string The list definition.

BoxName

any

ListDefinitionMode

Purpose

Change the numbering mode of a list definition.

Syntax

ListDefinitionMode (ListName: string; Numbering: enumeration)

Parameters

ListName

string

Numbering

enumeration (optional)

DefFlushRight!

DefFollows!

DefLeader!

DefNone!

DefParentheses!

ListDefinitionRename

Purpose

Rename a list definition.

Syntax

ListDefinitionRename (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string

ListDefinitionRetrieve

Purpose

Retrieve a list definition from a document.

Syntax

ListDefinitionRetrieve (Filename: string; ListName: string)

Parameters

Filename

string

ListName

string

ListDefinitionStyle

Purpose

Edit a list definition and change the list style.

Syntax

ListDefinitionStyle (ListName: string; Style: any)

Parameters

ListName

string

Style

any

See Also

ListEditPageFormat

ListEditPageFormat

Purpose

Edit the page numbering format of a list definition.

Syntax

ListEditPageFormat (ListName: string; NumberFormat: any)

Parameters

ListName

string

NumberFormat

any If there is nothing between the quotation marks, the list uses document style.

DocFormat!

See Also

ListDefinitionStyle

ListMark

Purpose

Mark the selected text as an item to add to a list when a document is generated.

Syntax

ListMark (ListName: string)

Parameters

ListName

string (optional)

LotusNotesHandle

Purpose

Return the handle to Lotus Notes. This command is valid only when Corel WordPerfect is invoked by Lotus Notes through OLE. Not recordable.

Syntax

numeric := LotusNotesHandle ()

MacroCommandInserter

Purpose

Turn the Corel WordPerfect Macro Command Inserter on or off.

Syntax

MacroCommandInserter (State: enumeration)

Parameters

State

enumeration

Off!

On!

MacroEditControlBar

Purpose

Display the Macro Edit feature bar.

Syntax

MacroEditControlBar (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

MacroExecuteQuick

Purpose

Playback the current QuickMacro.

Syntax

MacroExecuteQuick ()

MacroFileChain

Purpose

Specify a macro to play upon completion of the current macro.

Syntax

MacroFileChain (Filename: string)

Parameters

Filename

string

See Also

MacroFilePlay

MacroFilePlay

Purpose

Play a macro.

Syntax

MacroFilePlay (Filename: string)

Parameters

Filename

string

MacroMenuAdd

Purpose

Add a macro to the macro submenu.

Syntax

MacroMenuAdd (UpdateBIF: enumeration; MenuPos: numeric; Location: enumeration; Filename: string; TemplateName: string)

Parameters

UpdateBIF

enumeration

No!

Yes!

MenuPos

numeric The menu position.

Location

enumeration

CurrentTemplate!

FileOnDisk!

StandardTemplate!

Filename

string (optional)

TemplateName

string (optional)

MacroMenuDelete

Purpose

Delete a macro from a menu.

Syntax

MacroMenuDelete (UpdateBIF: enumeration; {MenuPos: numeric; })

Parameters

UpdateBIF

enumeration

No!

Yes!

MenuPos

numeric (optional) The menu position.

MacroPause

Purpose

Pause a macro until the user presses Enter or selects Pause on the Macro menu.

Syntax

MacroPause ()

MacroStatusPrompt

Purpose

Turn the macro status prompt line on or off.

Syntax

MacroStatusPrompt (State: enumeration; Prompt: string)

Parameters

State

enumeration

Off!

On!

Prompt

string (optional)

MacroTemplatePlay

Purpose

Play a macro located on a template.

Syntax

MacroTemplatePlay (Location: enumeration; MacroName: string)

Parameters

Location

enumeration

CurrentTemplate!

DefaultTemplate!

MacroName

string

MailDlg

Purpose

Determine if a mail system is running and start it if necessary; display the mail view; and attach a copy of the active Corel WordPerfect document, or if text was selected, it is pasted in the message box. If multiple mail systems are available, the highest priority mail system is used.

Syntax

MailDlg ()

MakeItFit

Purpose

Shrink or expand a document to fill a specified number of pages.

Syntax

MakeItFit (TargetPage: numeric; {Adjust: enumeration; })

Parameters

TargetPage

numeric The number of pages to fill.

Adjust

enumeration (optional)

FitBottomMargin!

FitFontSize!

FitLeftMargin!

FitLineSpacing!

FitRightMargin!

FitTopMargin!

MakeItFitDlg

Purpose

Display the Make It Fit Expert dialog box.

Syntax

MakeItFitDlg ()

MarginAdjustLeft

Purpose

Move the left margin to the left or right, relative to the current margin setting.

Syntax

MarginAdjustLeft (AmtToAdjust: measurement)

Parameters

AmtToAdjust

measurement (optional) A positive value increases the margin; a negative value decreases it.

See Also

?LeftMarginAdj, MarginAdjustRight, MarginLeft

MarginAdjustRight

Purpose

Move the right margin to the left or right, relative to the current margin setting.

Syntax

MarginAdjustRight (AmtToAdjust: measurement)

Parameters

AmtToAdjust

measurement A positive value increases the margin; a negative value decreases it.

See Also

?RightMarginAdj, MarginAdjustLeft, MarginRight

MarginBottom

Purpose

Set the bottom margin.

Syntax

MarginBottom (MarginWidth: measurement)

Parameters

MarginWidth

measurement

See Also

?MarginBottom

MarginLeft

Purpose

Set the left margin.

Syntax

MarginLeft (MarginWidth: measurement)

Parameters

MarginWidth

measurement

See Also

?MarginLeft, MarginAdjustLeft

MarginReleaseInsert

Purpose

Insert a [Hd Back Tab] code at the insertion point. This moves the margin back one tab.

Syntax

MarginReleaseInsert ()

MarginRight

Purpose

Set the right margin.

Syntax

MarginRight (MarginWidth: measurement)

Parameters

MarginWidth

measurement

See Also

?MarginRight, MarginAdjustRight

MarginTop

Purpose

Set the top margin.

Syntax

MarginTop (MarginWidth: measurement)

Parameters

MarginWidth

measurement

See Also

?MarginTop

MarkCrossRef

Purpose

Display the Cross-Reference feature bar.

Syntax

MarkCrossRef ()

See Also

MarkCrossRefUpdateList

MarkCrossRefUpdateList

Purpose

Add a specified target name to the Target name list.

Syntax

MarkCrossRefUpdateList (Target: string)

Parameters

Target

string The target name to add to the Target name list.

See Also

MarkCrossRef

MarkIndex

Purpose

Display the Index feature bar.

Syntax

MarkIndex ()

See Also

MarkIndexUpdateList

MarkIndexUpdateList

Purpose

Create a reference to a specified heading and subheading in the index.

Syntax

MarkIndexUpdateList (Heading: string; SubHeading: string)

Parameters

Heading

string

SubHeading

string

See Also

MarkIndex