Chapter 2

Corel^® WordPerfect^® Product Commands
F

FancyPageBorder

Purpose

Specify a Fancy Border for the current page. This command places a Fancy Border code in the current document at the beginning of the paragraph where the insertion point is located.

Syntax

FancyPageBorder (Filename: string)

Parameters

Filename

string

See Also

PageBorderDlg, TextBorderCreate

FancyPageBorderInParagraph

Purpose

Return a value indicating whether the current paragraph contains a Fancy Border code. The current paragraph is the paragraph where the insertion point is located. (This command returns 0 if the current paragraph contains a Fancy Border code following the insertion point. Since the Fancy Border code is always inserted at the beginning of the current paragraph when created or edited, this condition could exist only if the code was moved manually.)

Syntax

boolean := FancyPageBorderInParagraph ()

See Also

?PageBorder

FancyPageBorderOccur

Purpose

Return True if Fancy Page Borders are active at the insertion point, False if not. This command will return False if there is no Fancy Border code in the document before the insertion point, even if a Fancy Border code follows the insertion point on the same page.

Syntax

boolean := FancyPageBorderOccur ()

See Also

?PageBorder

FancyPageBorderOff

Purpose

Turn off Fancy Page Borders. This command inserts a Fancy Border End code at the insertion point. If the insertion point is located following the Fancy Border definition code and on the same page, rather than inserting a Fancy Border End code, the Fancy Border definition code is removed.

Syntax

FancyPageBorderOff ()

FigurePaletteDlg

Purpose

Display the Image Tools palette in order to edit an image.

Syntax

FigurePaletteDlg ()

See Also

FigurePaletteDlgEnd

FigurePaletteDlgEnd

Purpose

Close the Image Tools palette.

Syntax

FigurePaletteDlgEnd ()

See Also

FigurePaletteDlg

FigureRetrieveDlg

Purpose

Display the Insert Image dialog box.

Syntax

FigureRetrieveDlg ()

FileChangeAttributes

Purpose

Rename a file and specify a file type.

Syntax

FileChangeAttributes (Filename: string; {Attributes: enumeration; })

Parameters

Filename

string

Attributes

enumeration (optional)

Archive!

Hidden!

Normal!

ReadOnly!

System!

FileChangeDir

Purpose

Change the Documents or Graphics Files directory.

Syntax

FileChangeDir (Directory: string)

Parameters

Directory

string

FileCopy

Purpose

Copy a source file to a destination file.

Syntax

FileCopy (SourceFile: string; DestinationFile: string)

Parameters

SourceFile

string

DestinationFile

string

See Also

FileDelete, FileMove

FileDelete

Purpose

Delete a specific file.

Syntax

FileDelete (Filename: string)

Parameters

Filename

string (optional)

See Also

FileCopy, FileMove

FileExists

Purpose

Return whether a specified file exists.

Syntax

FileExists (Variable: variable; Filename: string)

Parameters

Variable

variable True (exists) or False (not exist).

Filename

string

FileInsert

Purpose

Retrieve a file into the current document at the insertion point.

Syntax

FileInsert (Filename: string; AutoDetect: enumeration; InsertIntoDoc: enumeration)

Parameters

Filename

string (optional)

AutoDetect

enumeration (optional)

No!

Yes!

InsertIntoDoc

enumeration (optional) Display a prompt before a file is inserted. Default: Insert! - insert file without prompt.

Insert!

Prompt!

See Also

FileOpen

FileInsertDlg

Purpose

Display the Insert File dialog box, which allows you to retrieve an existing file.

Syntax

FileInsertDlg ()

FileMove

Purpose

Rename and move a file.

Syntax

FileMove (SourceFile: string; DestinationFile: string)

Parameters

SourceFile

string (optional)

DestinationFile

string (optional) The new filename and/or location.

See Also

FileCopy, FileDelete

FileNew

Purpose

Create a new document based on a new or existing template. If the maximum nine documents are open, the macro ends or goes to the ONERROR label.

Syntax

FileNew ()

FileOpen

Purpose

Retrieve a specified file into a new document window. If the maximum nine document windows are open, the macro ends or goes to the ONERROR label.

Syntax

FileOpen (Filename: string; Format: enumeration)

Parameters

Filename

string

Format

enumeration (optional)

See Also

Close, FileOpenDlg, LastOpenedAdd

FileOpenDlg

Purpose

Display the Open File dialog box.

Syntax

FileOpenDlg ()

See Also

FileOpen

FileRemoveDirectory

Purpose

Remove a directory.

Syntax

FileRemoveDirectory (Directory: string)

Parameters

Directory

string

FileSave

Purpose

Save the current file or display the Save As dialog box for a new document.

Syntax

FileSave (Filename: string; ExportType: enumeration; Overwrite: enumeration)

Parameters

Filename

string (optional)

ExportType

enumeration (optional)

Overwrite

enumeration (optional) Automatically overwrite a file with the same name, or prompt the user to enter a new filename.

No!

Prompt!

Yes!

See Also

FileSaveAsDlg

FileSaveAsDlg

Purpose

Display the Save As dialog box, which allows you to save a file.

Syntax

FileSaveAsDlg ()

See Also

FileSave

FileStampShippingMacro

Purpose

Play the shipping macro FILESTMP.WCM to display the File Stamp Options dialog box. The dialog box allows you to insert the path and filename of a document in a header or footer. FILESTMP.WCM must be installed.

Syntax

FileStampShippingMacro ()

FillColors

Purpose

Specify a fill color for boxes and tables. Precede with commands such as BoxFill, FillStyleCreate, or TableBorderEditBegin and end with commands such as BoxUpdateDisplay and BoxEnd, FillStyleEnd, or TableBorderEditEnd.

Syntax

FillColors (ForeColorName: string; ForeRed: numeric; ForeGreen: numeric; ForeBlue: numeric; ForeShade: numeric; BackColorName: string; BackRed: numeric; BackGreen: numeric; BackBlue: numeric; BackShade: numeric)

Parameters

ForeColorName

string (optional)

ForeRed

numeric (optional) Value: 0-255.

ForeGreen

numeric (optional) Value: 0-255.

ForeBlue

numeric (optional) Value: 0-255.

ForeShade

numeric (optional) Percent: 0-100.

BackColorName

string (optional)

BackRed

numeric (optional) Value: 0-255.

BackGreen

numeric (optional) Value: 0-255.

BackBlue

numeric (optional) Value: 0-255.

BackShade

numeric (optional) Percent: 0-100.

See Also

BoxFill, BoxUpdateDisplay, FillSetGradient, FillSetWPG2, FillStyleCreate, FillStyleEnd, TableSecondFillColors

FillSetGradient

Purpose

Customize a gradient fill. Precede with FillStyleCreate or FillStyleEdit and end with FillStyleEnd.

Syntax

FillSetGradient (Gradient: enumeration; Angle: numeric; XLocation: numeric; YLocation: numeric; Calculate: numeric; State: enumeration)

Parameters

Gradient

enumeration

LinearGradient!

RadialGradient!

RectangularGradient!

Angle

numeric (optional)

XLocation

numeric (optional) The percentage of horizontal offset. A 10% offset places the center of the gradient effect toward the left edge; 50% centers it horizontally.

YLocation

numeric (optional) The percentage of vertical offset. A 10% offset places the center of the gradient effect toward the top edge; 50% centers it vertically.

Calculate

numeric (optional) The number of steps to create a gradient. Default: 30. Both maximum (999) and minimum (1) produce a solid appearance. The optimum is approximately 120.

State

enumeration (optional) Turn the gradient fill on or off.

No!

Yes!

See Also

?FillGradientType, FillColors, FillStyleCreate, FillStyleDelete, FillStyleEdit, FillStyleEnd

FillSetWPG2

Purpose

Specify a pattern set and a pattern from the set. Precede with commands such as BoxFill, FillStyleCreate, or TableBorderEditBegin and end with commands such as BoxUpdateDisplay, FillStyleEnd, or TableBorderEditEnd.

Syntax

FillSetWPG2 (PatternSet: numeric; Index: enumeration)

Parameters

PatternSet

numeric Only 0 is available.

Index

enumeration Specify a pattern.

See Also

?FillWPG2Pattern, FillColors, FillStyleCreate, FillStyleEdit

FillStyleCopy

Purpose

Copy a fill style.

Syntax

FillStyleCopy (StyleName: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)

Parameters

StyleName

any

FromLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

DestName

string (optional) Rename a copied fill style.

See Also

FillStyleCreate, FillStyleDelete, FillStyleEdit

FillStyleCreate

Purpose

Create a fill style.

Syntax

FillStyleCreate (TemplateName: string; Library: enumeration)

Parameters

TemplateName

string

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

FillColors, FillSetGradient, FillSetWPG2, FillStyleCopy, FillStyleDelete, FillStyleEdit, FillStyleEnd

FillStyleDelete

Purpose

Delete a fill style.

Syntax

FillStyleDelete (StyleName: any; Library: enumeration)

Parameters

StyleName

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

FillStyleCopy, FillStyleCreate, FillStyleEdit

FillStyleEdit

Purpose

Begin a FillStyleEdit-FillStyleEnd statement.

Syntax

FillStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

?Fill, FillStyleCreate, FillStyleEnd

FillStyleEnd

Purpose

Save or cancel changes to a fill style.

Syntax

FillStyleEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

FillStyleCreate, FillStyleEdit

FillStyleName

Purpose

Name a user-created fill style. Precede with FillStyleEdit and end with FillStyleEnd.

Syntax

FillStyleName (FillName: string)

Parameters

FillName

string

FillStyleRetrieve

Purpose

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

Syntax

FillStyleRetrieve (Filename: string; Library: enumeration)

Parameters

Filename

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

Library

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!

See Also

FillStyleSave

FillStyleSave

Purpose

Save a fill style.

Syntax

FillStyleSave (Filename: string; Library: enumeration)

Parameters

Filename

string

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

FillStyleRetrieve

FindDlg

Purpose

Display the Find and Replace Text dialog box.

Syntax

FindDlg ()

See Also

ReplaceDlg

FirstLineIndent

Purpose

Specify the distance between the left margin and the first word of indented text.

Syntax

FirstLineIndent (Width: measurement)

Parameters

Width

measurement

FloatingCellBegin

Purpose

Move the insertion point in a floating cell to the beginning of the cell.

Syntax

FloatingCellBegin ()

See Also

FloatingCellEnd

FloatingCellCreate

Purpose

Create a floating cell.

Syntax

FloatingCellCreate ()

See Also

FloatingCellEdit, FloatingCellEnd, FloatingCellNumberFormat

FloatingCellEdit

Purpose

Search backward for a floating cell and move the insertion point to the beginning of the first one found. If not found searching backward, the search continues from the insertion point forward.

Syntax

FloatingCellEdit ()

See Also

FloatingCellCreate, FloatingCellFormula, FloatingCellNumAlignCurrency, FloatingCellNumberDateFormat, FloatingCellNumberDecDigits, FloatingCellNumberFormat, FloatingCellNumberNegNumber, FloatingCellNumberRound, FloatingCellNumberUseCurrency, FloatingCellNumberUseCommas, FloatingCellNumSelectCurrency

FloatingCellEnd

Purpose

Move the insertion point in a floating cell to the end of the cell.

Syntax

FloatingCellEnd ()

See Also

FloatingCellBegin

FloatingCellFormula

Purpose

Specify a floating cell formula. Precede with FloatingCellCreate or FloatingCellEdit.

Syntax

FloatingCellFormula (Formula: string)

Parameters

Formula

string

See Also

FloatingCellCreate, FloatingCellEdit

FloatingCellNumAlignCurrency

Purpose

Align the currency symbols in a floating cell. Precede with FloatingCellCreate or FloatingCellEdit.

Syntax

FloatingCellNumAlignCurrency (Align: enumeration)

Parameters

Align

enumeration

No!

Yes!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat, FloatingCellNumberUseCurrency, FloatingCellNumSelectCurrency

FloatingCellNumberDateFormat

Purpose

Specify a floating cell date format.

Syntax

FloatingCellNumberDateFormat (Format: numeric)

Parameters

Format

numeric 1 March 5, 1993

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat