Chapter 2

Corel^® WordPerfect^® Product Commands
NO

NewHFWOccurrence

Purpose

Specify the occurrence of headers, footers, and watermarks.

Syntax

NewHFWOccurrence (Occurrence: enumeration)

Parameters

Occurrence

enumeration

AllPages!

EvenPages!

NoPages!

OddPages!

NumberingOptionDlg

Purpose

Display the Page Numbering Options dialog box. Recordable equivalent: Format, Page, Numbering, Options.

Syntax

NumberingOptionDlg ()

OLE1InsertDlg

Purpose

Display the Insert Object dialog box.

Syntax

OLE1InsertDlg ()

See Also

OLEInsertDlg

OLE1LinksDlg

Purpose

Display the Links dialog box.

Syntax

OLE1LinksDlg ()

See Also

OLELinksDlg

OLE1PasteDlg

Purpose

Display the Paste Special dialog box.

Syntax

OLE1PasteDlg ()

See Also

OLEPasteDlg

OLEAcceptLinks

Purpose

Accept a link updated or initialized between server and client applications. Included for 6.0 compatibility only.

Syntax

OLEAcceptLinks ()

See Also

OLEInitializeLinks, OLEUpdateLink

OLECancelLink

Purpose

Cancel a link to an object.

Syntax

OLECancelLink (LinkName: string)

Parameters

LinkName

string

OLEChangeLink

Purpose

Change the file in a link.

Syntax

OLEChangeLink (ObjectName: string; Filename: string)

Parameters

ObjectName

string

Filename

string The replacement file.

OLEDeactivate

Purpose

Remove an OLE object from in-place editing mode.

Syntax

OLEDeactivate ()

OLEInitializeLinks

Purpose

Reinitialize a link with its server application. Record when you create, update, change, or perform any function on a link. Included for 6.0 compatibility only.

Syntax

OLEInitializeLinks ()

See Also

OLEAcceptLinks, OLEChangeLink, OLEUpdateLink

OLEInsertDlg

Purpose

Display the Insert Object dialog box.

Syntax

OLEInsertDlg ()

OLEInsertObject

Purpose

Specify the name of a program to insert an object into.

Syntax

OLEInsertObject (ObjectType: string; DisplayMode: enumeration)

Parameters

ObjectType

string The program name.

DisplayMode

enumeration (optional)

DisplayAsIcon!

DisplayNormal!

See Also

QuattroPro

OLEInsertObjectFile

Purpose

Insert an object file into the current document.

Syntax

OLEInsertObjectFile (Filename: string; DisplayMode: enumeration; ObjectMode: enumeration)

Parameters

Filename

string

DisplayMode

enumeration (optional)

DisplayAsIcon!

DisplayNormal!

ObjectMode

enumeration (optional)

Embedded!

Linked!

OLELinksDlg

Purpose

Display the Links dialog box.

Syntax

OLELinksDlg ()

OLEObject

Purpose

Open an OLE object in the current document.

Syntax

OLEObject ()

See Also

OLEInsertObject

OLEPasteDlg

Purpose

Display the Paste Special dialog box.

Syntax

OLEPasteDlg ()

OLESetLinkUpdate

Purpose

Specify whether a linked object is always updated or manually updated.

Syntax

OLESetLinkUpdate (ObjectName: string; UpdateType: enumeration)

Parameters

ObjectName

string

UpdateType

enumeration

UpdateAlways!

UpdateManually!

OLEUpdateLink

Purpose

Update a specified link.

Syntax

OLEUpdateLink (LinkName: string)

Parameters

LinkName

string

OLEVerb

Purpose

Perform a pre-determined action on an OLE object. The action is determined by verbs defined by the OLE server. Verb 0 is the default verb (action) and is performed and recorded by double-clicking an object. For example, the default action for a sound clip is Play. Executing OLEVerb(Verb:0) on a sound clip plays the sound clip. Verbs range from 0 to the highest number defined by an OLE server for an object. See your OLE server documentation for valid verbs.

Syntax

OLEVerb (Verb: numeric)

Parameters

Verb

numeric Specify an action. 0 is the default verb.

OutlineBarDisplay

Purpose

Turn on the Outline mode, insert the first level number and style code of the current definition, and display the Outline feature bar. Use Off! to hide the feature bar. Recordable substitute: ViewOutline or OutlineOff.

Syntax

OutlineBarDisplay (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

OutlineParagraphNumber, OutlineSetParagraphNumber, OutlineStyleDescription, OutlineStyleLevel, OutlineStyleNumberFormat

OutlineBarSetup

Purpose

Display or hide outline symbols.

Syntax

OutlineBarSetup (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

OutlineIconsDisplay

OutlineBeginNew

Purpose

Begin a new outline in a specified style.

Syntax

OutlineBeginNew (Style: enumeration)

Parameters

Style

enumeration

See Also

OutlineEnd

OutlineBodyText

Purpose

Display or hide outline body text.

Syntax

OutlineBodyText (State: enumeration)

Parameters

State

enumeration (optional) If this parameter is not included, the command toggles to the opposite state.

HideBodyText!

ShowBodyText!

See Also

OutlineHideShowingBodyText

OutlineBodyTextToggle

Purpose

Toggle the current paragraph between an outline item and body text.

Syntax

OutlineBodyTextToggle ()

See Also

OutlineChangeToBodyText

OutlineChangeToBodyText

Purpose

Change the current outline item to body text. Recordable substitute: OutlineBodyTextToggle.

Syntax

OutlineChangeToBodyText ()

See Also

OutlineBodyText, OutlineParagraphNumber

OutlineDown

Purpose

Move the insertion point to the next outline item or paragraph of body text.

Syntax

OutlineDown ()

See Also

OutlineUp

OutlineEnd

Purpose

Turn off Outline.

Syntax

OutlineEnd ()

See Also

OutlineBeginNew

OutlineFamilyCopy

Purpose

Copy the current family items to the Clipboard.

Syntax

OutlineFamilyCopy ()

See Also

MoveModeEnd, OutlineFamilyCut, OutlineFamilySelect, OutlineFamilyMove

OutlineFamilyCut

Purpose

Delete the current family items and adjust the numbering.

Syntax

OutlineFamilyCut ()

See Also

OutlineFamilyCopy, OutlineFamilySelect, OutlineFamilyMove

OutlineFamilyDemote

Purpose

Demote the current family items to the next level and adjust the numbering.

Syntax

OutlineFamilyDemote ()

See Also

OutlineFamilyPromote, OutlineFamilySelect

OutlineFamilyDown

Purpose

Move the insertion point to the beginning of the next outline family.

Syntax

OutlineFamilyDown ()

See Also

OutlineDown, OutlineFamilyLeft, OutlineFamilyRight, OutlineFamilyUp

OutlineFamilyDragDown

Purpose

Move the current family items below the next family and adjust the numbering. Recordable equivalent: OutlineParagraphDragDown.

Syntax

OutlineFamilyDragDown ()

See Also

OutlineFamilyDown, OutlineFamilyDragUp, OutlineFamilySelect, OutlineParagraphDragDown

OutlineFamilyDragUp

Purpose

Move the current family items above the previous family and adjust the numbering. Recordable equivalent: OutlineParagraphDragUp.

Syntax

OutlineFamilyDragUp ()

See Also

OutlineFamilyDragDown, OutlineFamilySelect, OutlineFamilyUp, OutlineParagraphDragUp

OutlineFamilyHide

Purpose

Hide all but the current level of the outline family.

Syntax

OutlineFamilyHide (State: enumeration)

Parameters

State

enumeration

HideBodyText!

ShowBodyText!

See Also

OutlineFamilySelect, OutlineFamilyShow

OutlineFamilyLeft

Purpose

Move the insertion point to the beginning of the previous outline family.

Syntax

OutlineFamilyLeft ()

See Also

OutlineFamilyDown, OutlineFamilyRight, OutlineFamilyUp

OutlineFamilyMove

Purpose

Move an outline family.

Syntax

OutlineFamilyMove ()

See Also

MoveModeEnd, OutlineFamilyCopy, OutlineFamilyCut, OutlineFamilySelect

OutlineFamilyPromote

Purpose

Raise the current family items one level.

Syntax

OutlineFamilyPromote ()

See Also

OutlineFamilyDemote, OutlineFamilySelect

OutlineFamilyRight

Purpose

Move the insertion point to the next outline item, skipping body text.

Syntax

OutlineFamilyRight ()

See Also

OutlineFamilyDown, OutlineFamilyLeft, OutlineFamilyUp, OutlineRight

OutlineFamilySelect

Purpose

Select the current outline family, including body text.

Syntax

OutlineFamilySelect ()

See Also

OutlineParagraphSelect

OutlineFamilyShow

Purpose

Display or hide body text in the current outline family.

Syntax

OutlineFamilyShow (State: enumeration)

Parameters

State

enumeration

HideBodyText!

ShowBodyText!

See Also

OutlineFamilyHide

OutlineFamilyUp

Purpose

Move the insertion point to the beginning of the previous outline family.

Syntax

OutlineFamilyUp ()

See Also

OutlineFamilyDown, OutlineFamilyLeft, OutlineFamilyRight, OutlineUp

OutlineHideShowingBodyText

Purpose

Hide all outline items and display the body text.

Syntax

OutlineHideShowingBodyText ()

See Also

OutlineBodyText

OutlineIconsDisplay

Purpose

Display the outline level icons.

Syntax

OutlineIconsDisplay (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

OutlineBarSetup

OutlineNumberDlg

Purpose

Display the Set Paragraph Number dialog box.

Syntax

OutlineNumberDlg ()

See Also

OutlineParagraphNumber

OutlineOff

Purpose

Close the Outline feature bar.

Syntax

OutlineOff ()

See Also

OutlineBarDisplay

OutlineParagraphCopy

Purpose

Copy the current outline item to the Clipboard.

Syntax

OutlineParagraphCopy ()

See Also

MoveModeEnd, OutlineParagraphDelete, OutlineParagraphMove, OutlineParagraphSelect

OutlineParagraphDelete

Purpose

Delete the current outline item and adjust the numbering.

Syntax

OutlineParagraphDelete ()

See Also

MoveModeEnd, OutlineParagraphCopy, OutlineParagraphMove, OutlineParagraphSelect

OutlineParagraphDemote

Purpose

Demote the current outline item one level and adjust the numbering.

Syntax

OutlineParagraphDemote ()

See Also

OutlineParagraphPromote, OutlineParagraphSelect

OutlineParagraphDragDown

Purpose

Move the current outline item down one item and adjust the numbering.

Syntax

OutlineParagraphDragDown ()

See Also

OutlineFamilyDragDown, OutlineParagraphDragUp, OutlineParagraphSelect

OutlineParagraphDragUp

Purpose

Move the current outline item up one item and adjust the numbering.

Syntax

OutlineParagraphDragUp ()

See Also

OutlineFamilyDragUp, OutlineParagraphDragDown, OutlineParagraphSelect

OutlineParagraphMove

Purpose

Delete the current outline item and adjust the numbering.

Syntax

OutlineParagraphMove ()

See Also

MoveModeEnd, OutlineParagraphCopy, OutlineParagraphDelete, OutlineParagraphSelect

OutlineParagraphNumber

Purpose

Specify an outline level. Default: current level.

Syntax

OutlineParagraphNumber (Level: numeric)

Parameters

Level

numeric (optional) Value: 1-8.

See Also

OutlineParagraphNumberInsert

OutlineParagraphNumberInsert

Purpose

Insert a paragraph number code [Para Num] in the current document at the insertion point.

Syntax

OutlineParagraphNumberInsert ()

See Also

OutlineParagraphNumber, OutlineSetParagraphNumber

OutlineParagraphPromote

Purpose

Promote the current outline item one level.

Syntax

OutlineParagraphPromote ()

See Also

OutlineParagraphDemote, OutlineParagraphSelect

OutlineParagraphSelect

Purpose

Select the current outline item or paragraph of body text.

Syntax

OutlineParagraphSelect ()

See Also

OutlineFamilySelect

OutlineRight

Purpose

Move the insertion point to the next outline item before the indent and number codes.

Syntax

OutlineRight ()

See Also

OutlineFamilyRight, OutlineUp

OutlineSetParagraphNumber

Purpose

Set the number for an outline item.

Syntax

OutlineSetParagraphNumber (WordString: string)

Parameters

WordString

string The outline paragraph setting number.

See Also

OutlineParagraphNumber, OutlineParagraphNumberInsert

OutlineShow

Purpose

Specify the lowest outline level to display and whether to show body text.

Syntax

OutlineShow (Level: numeric; State: enumeration)

Parameters

Level

numeric Value: 1-8.

State

enumeration

HideBodyText!

ShowBodyText!

See Also

OutlineBodyText, OutlineHideShowingBodyText

OutlineStyleCopy

Purpose

Copy an outline style.

Syntax

OutlineStyleCopy (Style: any; Source: enumeration; Destination: enumeration; NewName: string)

Parameters

Style

any

Source

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

Destination

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

NewName

string (optional)

See Also

OutlineStyleDelete, OutlineStyleRetrieve, OutlineStyleSave, OutlineStyleSelect

OutlineStyleCreate

Purpose

Create, name, and save an outline style.

Syntax

OutlineStyleCreate (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

OutlineBeginNew, OutlineStyleDelete, OutlineStyleEditEnd

OutlineStyleDelete

Purpose

Delete an outline style. Predefined outline styles cannot be deleted.

Syntax

OutlineStyleDelete (Style: any; Library: enumeration)

Parameters

Style

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

OutlineStyleCopy, OutlineStyleRetrieve, OutlineStyleSave, OutlineStyleSelect

OutlineStyleDescription

Purpose

Create an outline style description.

Syntax

OutlineStyleDescription (Description: string)

Parameters

Description

string

See Also

OutlineStyleEditBegin, OutlineStyleEditEnd

OutlineStyleEditBegin

Purpose

Begin editing an outline style.

Syntax

OutlineStyleEditBegin (Style: any; Library: enumeration)

Parameters

Style

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

OutlineStyleEditEnd

OutlineStyleEditEnd

Purpose

Save the outline style changes.

Syntax

OutlineStyleEditEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

OutlineStyleEditBegin

OutlineStyleLevel

Purpose

Specify an outline level and style.

Syntax

OutlineStyleLevel (Level: numeric; Style: any)

Parameters

Level

numeric Value: 1-8.

Style

any

See Also

OutlineStyleEditBegin, OutlineStyleNumberFormat

OutlineStyleNumberFormat

Purpose

Specify the numbering format for each level of a selected outline style.

Syntax

OutlineStyleNumberFormat (Level: numeric; Format: string)

Parameters

Level

numeric Value: 1-8.

Format

string The numbering format for each outline level. Select a system format or type a character expression to specify the format.

See Also

OutlineStyleEditBegin, OutlineStyleNumbersOnly

OutlineStyleNumbersOnly

Purpose

Apply the Numbers Only format to a selected outline.

Syntax

OutlineStyleNumbersOnly (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

OutlineStyleEditBegin, OutlineStyleEditEnd, OutlineStyleNumberFormat

OutlineStyleRename

Purpose

Rename a user-defined outline style.

Syntax

OutlineStyleRename (Name: string)

Parameters

Name

string The new name.

See Also

OutlineStyleEditBegin, OutlineStyleEditEnd

OutlineStyleRetrieve

Purpose

Retrieve an outline style.

Syntax

OutlineStyleRetrieve (Filename: string; Type: enumeration; Library: enumeration)

Parameters

Filename

string

Type

enumeration

AllStyles!

SystemStyles!

UserStyles!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

OutlineStyleCopy, OutlineStyleDelete, OutlineStyleSave, OutlineStyleSelect

OutlineStyleSave

Purpose

Save an outline style.

Syntax

OutlineStyleSave (Filename: string; Type: enumeration; Library: enumeration)

Parameters

Filename

string

Type

enumeration

AllStyles!

SystemStyles!

UserStyles!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

OutlineStyleCopy, OutlineStyleDelete, OutlineStyleRetrieve, OutlineStyleSelect

OutlineStyleSelect

Purpose

Select an outline style.

Syntax

OutlineStyleSelect (Style: any)

Parameters

Style

any Use a string to specify a user-defined style.

See Also

OutlineStyleCopy, OutlineStyleDelete, OutlineStyleRetrieve, OutlineStyleSave

OutlineUp

Purpose

Move the insertion point to the beginning of the previous outline paragraph, before indent and number codes.

Syntax

OutlineUp ()

See Also

OutlineDown

OverstrikeCreate

Purpose

Create an overstrike.

Syntax

OverstrikeCreate (OvrStrkStrg: string)

Parameters

OvrStrkStrg

string Two or more characters.

See Also

?Overstrike, OverstrikeCreateDlg, OverstrikeEdit

OverstrikeCreateDlg

Purpose

Display the Overstrike dialog box.

Syntax

OverstrikeCreateDlg ()

See Also

?Overstrike, OverstrikeCreate, OverstrikeEdit

OverstrikeEdit

Purpose

Replace the first overstrike to the right of the insertion point with the text in the OvrStrkStrg parameter.

Syntax

OverstrikeEdit (OvrStrkStrg: string)

Parameters

OvrStrkStrg

string The new overstrike characters.

See Also

?Overstrike, OverstrikeCreate, OverstrikeCreateDlg