Chapter 2

See Graphic.

Corel® WordPerfect® Product Commands




AbbreviationCreate

Purpose

Create an abbreviation.

Syntax

AbbreviationCreate (AbbreviationName: string; Template: enumeration; Text: string)

Parameters

AbbreviationName

string

Template

enumeration (optional)

CurrentDoc!

PersonalLibrary!

QuickWords!

SharedLibrary!

Text

string (optional)

See Also

AbbreviationDelete, AbbreviationExpand


AbbreviationDelete

Purpose

Delete an abbreviation.

Syntax

AbbreviationDelete (AbbreviationName: string; Template: enumeration)

Parameters

AbbreviationName

string

Template

enumeration (optional)

CurrentDoc!

PersonalLibrary!

QuickWords!

SharedLibrary!

See Also

AbbreviationCreate, AbbreviationExpand


AbbreviationDlg

Purpose

Display the Abbreviations dialog box.

Syntax

AbbreviationDlg ()

See Also

AbbreviationCreate, AbbreviationDelete, AbbreviationExpand, AbbreviationsShippingMacro


AbbreviationExpand

Purpose

Expand an abbreviation.

Syntax

AbbreviationExpand (AbbreviationName: string; Template: enumeration)

Parameters

AbbreviationName

string (optional)

Template

enumeration (optional)

CurrentDoc!

PersonalLibrary!

QuickWords!

SharedLibrary!

See Also

AbbreviationCreate, AbbreviationDelete, ExpandAllAbbrevShippingMacro


AbbreviationsShippingMacro

Purpose

Play the shipping macro ABBREV.WCM to display the Abbreviations dialog box in a modeless state. ABBREV.WCM must be installed.

Syntax

AbbreviationsShippingMacro ()


AboutDlg

Purpose

Display the About Corel WordPerfect dialog box, which displays product and license information.

Syntax

AboutDlg ()


AddressBookDlg

Purpose

Display the Address Book dialog box. You can also pre-select certain options using the parameters. If OK is clicked to dismiss the dialog, the Address Book will remember the currently selected addresses.

Syntax

boolean := AddressBookDlg (SelectionType: enumeration; CurrentSelections: enumeration; AddressBook: string; DialogTitle: string; OKButtonText: string)

Parameters

SelectionType

enumeration (optional) Default = SingleSelection!

MultipleSelection!

SingleSelection!

CurrentSelections

enumeration (optional) Default = Ignore!

Ignore!

Reselect!

AddressBook

string (optional) The name of the address book to view.

DialogTitle

string (optional) Change the text of the title bar.

OKButtonText

string (optional) Change the text of the OK button. Default = OK.

See Also

?AddressBookSelection, AddressBookInsertAddr, AddressBookSelectionGetField, AddressBookSelectionFormatAddr


AddressBookFormatAdd

Purpose

Create a custom address format and add it to the list of address formats.

Syntax

AddressBookFormatAdd (Name: string; Format: string)

Parameters

Name

string The name of the new custom format.

Format

string The address format string. Data fields are designated by enclosing the field code number in square brackets ([ ]). Use the Codes button on the Macro Bar to insert hard return or tab codes. Although the codes look like bracketed text, they are codes in the text string. For example:

AddressBookFormatAdd (Name: “Test”; Format: “[12289][HRt][14889][HRt][14887], [14888] [14890]”)

Use AddressBookGetFieldCount, AddressBookGetFieldNumber, and AddressBookGetFieldName to get the names and code numbers of the address book fields.

See Also

AddressBookFormatDelete, AddressBookGetFieldCount, AddressBookGetFieldName, AddressBookGetFieldNumber


AddressBookFormatDelete

Purpose

Delete a custom address format from the list of address formats. System (predefined) address formats cannot be deleted from the address format list.

Syntax

AddressBookFormatDelete (Name: string)

Parameters

Name

string The name of the custom format to delete.

See Also

AddressBookFormatAdd


AddressBookFormatGetCount

Purpose

Return the number of available address formats. Address formats can be referenced by index number to return information about the format. See AddressBookFormatGetName() and AddressBookFormatGetFormat(). Some address formats are provided with the program (predefined) and cannot be deleted. These formats are indexed one through the number of formats provided. User-defined address format indexes begin following the predefined formats and are indexed in order of creation.

For example, if there are five predefined address formats and four user-defined address formats, the predefined formats would have index numbers ranging from one to five, and the user-defined formats would have index numbers ranging from six to nine in the order which they were created. If a user-defined address format is deleted, the index number of each succeeding format is reduced by one.Therefore, the address format index numbers will always be sequential. Also, the index number of a user-defined address format may change if a previously created address format is deleted.

Syntax

numeric := AddressBookFormatGetCount ()

See Also

AddressBookFormatGetName, AddressBookFormatGetFormat


AddressBookFormatGetCurrent

Purpose

Return the format name or specification of the current address format.

Syntax

string := AddressBookFormatGetCurrent (Item: enumeration)

Parameters

Item

enumeration Specify the item to return.

Format!

Name!

See Also

AddressBookFormatAdd, AddressBookFormatGetFormat


AddressBookFormatGetFormat

Purpose

Return the specification of the address format specified in Index.

Syntax

string := AddressBookFormatGetFormat (Index: numeric)

Parameters

Index

numeric Use AddressBookFormatGetCount to determine the value of this parameter.

See Also

AddressBookFormatGetCurrent


AddressBookFormatGetName

Purpose

Return the name of the specified address format.

Syntax

string := AddressBookFormatGetName (Index: numeric)

Parameters

Index

numeric Use AddressBookFormatGetCount to determine the value of this parameter.

See Also

AddressBookFormatGetCurrent, AddressBookFormatGetCount


AddressBookGetCount

Purpose

Return the number of available address books.

Syntax

numeric := AddressBookGetCount ()

See Also

AddressBookFormatAdd, AddressBookGetFieldCount


AddressBookGetFieldCount

Purpose

Return the number of available fields in the specified address book.

Syntax

numeric := AddressBookGetFieldCount (AddressBook: string)

Parameters

AddressBook

string The name of the address book to get the field count from.

See Also

AddressBookFormatAdd, AddressBookGetName, AddressBookGetFieldNumber


AddressBookGetFieldName

Purpose

Return the name of a specific field in the specified address book.

Syntax

string := AddressBookGetFieldName (AddressBook: string; Index: numeric)

Parameters

AddressBook

string The name of the address book containing the desired field.

Index

numeric The index number of the desired field.

See Also

AddressBookFormatAdd, AddressBookGetName, AddressBookGetFieldCount


AddressBookGetFieldNumber

Purpose

Return the code number of a specific field in the address book specified. The field code number is not the same as the field index number. Field code numbers always remain the same even if other fields are deleted. The table below lists the default system (predefined) data fields and their code numbers. Custom Fields are numbered sequentially in the order they are created beginning at 32768.

Code #

Field Name

12289

Name

12290

E-Mail Type

12291

E-Mail Address

12292

Comments

14854

First Name

14856

Business Phone Number

14857

Home Phone Number

14865

Last Name

14870

Organization

14871

Title

14872

Department

14873

Mailstop

14874

Phone Number

14876

Cellular Phone Number

14883

Fax Number

14886

Country

14887

City

14888

State

14889

Address

14890

ZIP Code

24587

Greeting

Syntax

numeric := AddressBookGetFieldNumber (AddressBook: string; Index: numeric)

Parameters

AddressBook

string The name of the address book containing the desired field.

Index

numeric The index number of the desired field.

See Also

AddressBookFormatAdd, AddressBookGetName, AddressBookGetFieldCount, AddressBookGetFieldName


AddressBookGetName

Purpose

Return the name of the specified address book.

Syntax

string := AddressBookGetName (Index: numeric)

Parameters

Index

numeric The index number of the desired address book.

See Also

AddressBookGetCount


AddressBookInsertAddr

Purpose

Display the Corel Address Book dialog box so you can insert an address.

Syntax

AddressBookInsertAddr ()

See Also

AddressBookDlg


AddressBookRecordAddField

Purpose

Define a field value in a new address book record. Repeat for each field value defined. Precede with AddressBookRecordCreate and follow with AddressBookRecordEnd.

Syntax

AddressBookRecordAddField (Field: any; Value: string)

Parameters

Field

any The field name or code number.

Value

string The field value.

See Also

AddressBookRecordEnd, AddressBookRecordCreate


AddressBookRecordCreate

Purpose

Create a record in the specified address book. Follow with AddressBookRecordAddField and AddressBookRecordEnd.

Syntax

AddressBookRecordCreate (AddressBook: string)

Parameters

AddressBook

string The name of the address book the new record will be added to.

See Also

AddressBookRecordEnd, AddressBookRecordAddField


AddressBookRecordEnd

Purpose

End the record creation process and save the new record. Precede with AddressBookRecordCreate and AddressBookRecordAddField.

Syntax

AddressBookRecordEnd (State: enumeration; RecordType: enumeration)

Parameters

State

enumeration Save the new record to the specified address book or cancel without saving.

Cancel!

Save!

RecordType

enumeration (optional) Specify the type of the new record. Default: Person!

Organization!

Person!

See Also

AddressBookRecordCreate, AddressBookRecordAddField


AddressBookSelectionFormatAddr

Purpose

Return the address that was last selected in the address book and formats it using the specified address format.

Syntax

string := AddressBookSelectionFormatAddr (Format: string; Index: numeric)

Parameters

Format

string The format specification used to format the specified address. You can use AddressBookFormatGetFormat or AddressBookFormatGetCurrent to retrieve an address format specification.

Index

numeric (optional) The index number of the desired address record relative to the current selection. For example, if six address records were selected and you wanted the second record in the list, you would put 2 in this parameter. If this parameter is not included, the first record in the list will be formatted.

See Also

AddressBookDlg, PersonalInfoFormatAddr


AddressBookSelectionGetField

Purpose

Return the value of a field from the last address book record that was selected. Use the Index parameter if the last selection was a multiple record selection.

Syntax

string := AddressBookSelectionGetField (Field: any; Index: numeric)

Parameters

Field

any Specify the field to retrieve. If this parameter is a number, the command will try to locate the field with that code number. If this parameter is a string, the command will try to locate the field with that name.

Index

numeric (optional) Specify the record to retrieve the field information from. Use this parameter when the last address book selection was a multiple record selection. For example, to return information from the fifth record of a multiple record selection, set this parameter to 5. If the last selection was a multiple record selection and this parameter is left blank, the command will return information from the first record in the selection.

See Also

AddressBookDlg, PersonalInfoGetField


AddressMergeShippingMacro

Purpose

Play the shipping macro ADRS2MRG.WCM to copy the address book into a merge data file. ADRS2MRG.WCM must be installed.

Syntax

AddressMergeShippingMacro ()


Advance

Purpose

Move the insertion point a specified distance from the top or left of the page, or from the insertion point.

Syntax

Advance (Where: enumeration; Amount: measurement)

Parameters

Where

enumeration

AdvanceDown!

AdvanceFromLeftEdge!

AdvanceFromTop!

AdvanceLeft!

AdvanceRight!

AdvanceUp!

Down!

Left!

Right!

ToLine!

ToPosition!

Up!

Amount

measurement

See Also

AdvanceDlg, BaselinePlacement, Binding, MarginAdjustLeft, MarginAdjustRight


AdvanceDlg

Purpose

Display the Advance dialog box.

Syntax

AdvanceDlg ()

See Also

Advance


AllFontsShippingMacro

Purpose

Play the shipping macro ALLFONTS.WCM to create a list of available fonts for the current printer. ALLFONTS.WCM must be installed.

Syntax

AllFontsShippingMacro ()


Append

Purpose

Add a copy of the selected text or graphics to the end of the Clipboard contents. If the Clipboard is empty, the macro ends.

Syntax

Append ()

See Also

AppendToFile, ClipboardAppendTo, ClipboardSaveTo, DeleteAppend, EditCopy, EditCut


AppendToFile

Purpose

Add the selected text, or the current document if no text is selected, to the end of another file.

Syntax

AppendToFile (Filename: string)

Parameters

Filename

string (optional) The file to append to.

See Also

Append, ClipboardAppendTo


ApplicationBarShow

Purpose

Display (On!) or hide (Off!) the Application Bar. If no parameter is specified, this command toggles the Application Bar display.

Syntax

ApplicationBarShow (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


AppMaximize

Purpose

Maximize the application window. If the window is already maximized, the macro ends.

Syntax

AppMaximize ()

See Also

AppMinimize, AppRestore, DocMaximize, DocMinimize


AppMinimize

Purpose

Minimize the application window to an icon. If the window is already minimized, the macro ends.

Syntax

AppMinimize ()

See Also

AppMaximize, AppRestore, DocMaximize, DocMinimize


AppMove

Purpose

Reposition an application window that has been reduced in size. If Corel WordPerfect is maximized, the macro ends or goes to the ONERROR label.

Syntax

AppMove ()

See Also

DocMove


AppRestore

Purpose

Restore the application window to its previous size. If Corel WordPerfect is already restored, the macro ends or goes to the ONERROR label.

Syntax

AppRestore ()

See Also

AppMaximize, AppMinimize, DocRestore


AppSize

Purpose

Resize the current application window. If the window is maximized, the macro ends or goes to the ONERROR label.

Syntax

AppSize ()

See Also

DocSize


AppTaskList

Purpose

Activate the Taskbar and display the Start menu.

Syntax

AppTaskList ()


AssociateDlg

Purpose

Display the Associate dialog box, which allows you to assign menus, toolbars, and keyboards to selected features.

Syntax

AssociateDlg ()

See Also

MergeFileAssociate, TemplateSetAssociation


AttributeAppearanceOff

Purpose

Turn off the specified attributes at the insertion point. One or more attribute parameters is required.

Syntax

AttributeAppearanceOff ({Attrib: enumeration; })

Parameters

Attrib

enumeration (optional)

Bold!

DoubleUnderline!

Every!

Italics!

Outline!

Redline!

Shadow!

SmallCaps!

Strikeout!

Underline!

See Also

AttributeAppearanceOn, AttributeAppearanceToggle, AttributeNormal, AttributeRelativeSize, AttributeRelativeSizeToggle, AttributeSizeRatios


AttributeAppearanceOn

Purpose

Turn on the specified attributes at the insertion point. One or more parameters is required.

Syntax

AttributeAppearanceOn ({Attrib: enumeration; })

Parameters

Attrib

enumeration (optional)

Bold!

DoubleUnderline!

Every!

Italics!

Outline!

Redline!

Shadow!

SmallCaps!

Strikeout!

Underline!

See Also

AttributeAppearanceOff, AttributeAppearanceToggle, AttributeNormal, AttributeRelativeSize, AttributeRelativeSizeToggle


AttributeAppearanceToggle

Purpose

Toggle attributes, usually of the selected text. One or more attribute parameters is required.

Syntax

AttributeAppearanceToggle ({Attrib: enumeration; })

Parameters

Attrib

enumeration (optional)

Bold!

DoubleUnderline!

Every!

Italics!

Outline!

Redline!

Shadow!

SmallCaps!

Strikeout!

Underline!

See Also

AttributeAppearanceOn, AttributeAppearanceOff, AttributeNormal, AttributeRelativeSize, AttributeRelativeSizeToggle


AttributeNormal

Purpose

Turn off the current font attributes except color. To record, first add an Attribute Normal button to a toolbar in Settings.

Syntax

AttributeNormal ()

See Also

AttributeAppearanceOn, AttributeAppearanceOff, AttributeRelativeSize, AttributeRelativeSizeToggle


AttributePosition

Purpose

Specify subscript or superscript font attributes.

Syntax

AttributePosition (Position: enumeration)

Parameters

Position

enumeration

NormalPosition!

Subscript!

Superscript!

See Also

AttributeNormal, AttributePositionToggle, AttributeSizeRatios, FontSubscriptToggle, FontSuperscriptToggle


AttributePositionToggle

Purpose

Toggle subscript, normal, and superscript font attributes.

Syntax

AttributePositionToggle (Position: enumeration)

Parameters

Position

enumeration

NormalPosition!

Subscript!

Superscript!

See Also

AttributeNormal, AttributePosition, FontSubscriptToggle, FontSuperscriptToggle


AttributeRelativeSize

Purpose

Specify a relative font size for selected or subsequent text.

Syntax

AttributeRelativeSize (Size: enumeration)

Parameters

Size

enumeration

ExtraLarge!

Fine!

Large!

NormalSize!

Small!

VeryLarge!

See Also

AttributeRelativeSizeToggle


AttributeRelativeSizeToggle

Purpose

Toggle relative font sizes.

Syntax

AttributeRelativeSizeToggle (Size: enumeration)

Parameters

Size

enumeration

ExtraLarge!

Fine!

Large!

NormalSize!

Small!

VeryLarge!

See Also

AttributeRelativeSize


AttributeSizeRatios

Purpose

Specify relative font size ratios.

Syntax

AttributeSizeRatios (Attrib: enumeration; Percentage: numeric)

Parameters

Attrib

enumeration

ExtraLarge!

Fine!

Large!

Small!

SuperSubscript!

VeryLarge!

Percentage

numeric

See Also

AttributeRelativeSize, AttributeRelativeSizeToggle


AutoCodePlacement

Purpose

Turn automatic code placement on or off. Default: Some codes are automatically placed at the beginning of a page or paragraph. When off, all codes are inserted at the insertion point. Not recordable.

Syntax

AutoCodePlacement (State: enumeration)

Parameters

State

enumeration

Off!

On!


AutoWordSelect

Purpose

Turn Automatically Select Words on or off. Changes the current Corel WordPerfect session only.

Syntax

AutoWordSelect (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?AutoWordSelect


BackTab

Purpose

Insert a [Hd Back Tab] code at the insertion point. This code will move the current line of text left one tab from the insertion point.

Syntax

BackTab ()

See Also

Tab, TabInsert


Backup

Purpose

Turn Timed Document Backup on or off and return the current state.

Syntax

boolean := Backup (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

BackupMinutes, BackupOriginalDoc


BackupMinutes

Purpose

Specify the number of minutes between timed backups.

Syntax

BackupMinutes (Minutes: numeric)

Parameters

Minutes

numeric

See Also

Backup, BackupOriginalDoc, PrefSave


BackupOriginalDoc

Purpose

Turn Original Document Backup on or off.

Syntax

BackupOriginalDoc (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

Backup, BackupMinutes, PrefSave


BarcodeDlg

Purpose

Display the POSTNET Barcode dialog box.

Syntax

BarcodeDlg ()

See Also

BarcodePOSTNET


BarcodePOSTNET

Purpose

Specify a ZIP Code or merge field containing a ZIP Code.

Syntax

BarcodePOSTNET (Zip: string; State: enumeration)

Parameters

Zip

string A five, nine, or eleven-digit ZIP Code. If the ZIP Code is in a merge field, the parameter can be a string that specifies the field.

State

enumeration (optional) Enable a merge field to provide a ZIP Code. Required only when a merge field is specified in the ZIP parameter.

MergeFieldAllowed!

See Also

BarcodeDlg


BaselinePlacement

Purpose

Turn the Baseline placement for typesetting option on or off.

Syntax

BaselinePlacement (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?BaselineMode


Binding

Purpose

Specify a binding offset for a specified paper edge. Use this command to specify two-sided document settings. This command inserts a [Binding Width] code at the beginning of the current page.

Syntax

Binding (Edge: enumeration; Offset: measurement)

Parameters

Edge

enumeration

BottomEdge!

LeftEdge!

RightEdge!

TopEdge!

Offset

measurement

See Also

?Binding, BindingOptionsDlg, DoubleSidedPrint, PrintTwoSidedDocCodesDlg, PrintUseTwoSidedDocCodes


BindingOptionsDlg

Purpose

Display the Print dialog box with the Two-Sided Printing tab active.

Syntax

BindingOptionsDlg ()

See Also

Binding, PrintDlg


BlockProtect

Purpose

Turn Block Protect on or off.

Syntax

BlockProtect (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?BlockProtect, ConditionalEndOfPage, KeepTextTogetherDlg, WidowOrphan, BlockProtectToggle


BlockProtectToggle

Purpose

Toggle Block Protect on or off. The objects or text that are being block protected must be selected.

Syntax

BlockProtectToggle ()

See Also

?BlockProtect, BlockProtect


BoldKey

Purpose

Toggle Bold on or off at the insertion point.

Syntax

BoldKey ()

See Also

AttributeAppearanceToggle


BookmarkBlock

Purpose

Find and select a specified bookmark. If the type of the specified bookmark is not selected, the insertion point is moved to the bookmark and select mode is activated, but nothing is selected.

Syntax

BookmarkBlock (Name: string)

Parameters

Name

string (optional)

See Also

BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename


BookmarkCreate

Purpose

Create a bookmark.

Syntax

BookmarkCreate (Name: string; Selected: enumeration)

Parameters

Name

string

Selected

enumeration (optional)

No!

Yes!

See Also

?BookmarkList, BookmarkBlock, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename


BookmarkDelete

Purpose

Delete a specified bookmark.

Syntax

BookmarkDelete (Name: string)

Parameters

Name

string (optional)

See Also

BookmarkBlock, BookmarkCreate, BookmarkDlg, BookmarkFind, BookmarkMove, BookmarkRename


BookmarkDlg

Purpose

Display the Bookmark dialog box.

Syntax

BookmarkDlg ()

See Also

BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkFind, BookmarkMove, BookmarkRename


BookmarkFind

Purpose

Find a specified bookmark.

Syntax

BookmarkFind (Name: string)

Parameters

Name

string (optional)

See Also

BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkMove, BookmarkRename


BookmarkMove

Purpose

Move a bookmark to the insertion point.

Syntax

BookmarkMove (Name: string)

Parameters

Name

string (optional)

See Also

BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkRename


BookmarkRename

Purpose

Rename a bookmark.

Syntax

BookmarkRename (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string

See Also

BookmarkBlock, BookmarkCreate, BookmarkDelete, BookmarkDlg, BookmarkFind, BookmarkMove


BorderBottomLine

Purpose

Specify the style of a bottom border line. Precede with BorderStyleCreate or BorderStyleEdit, and end with BorderStyleEnd.

Syntax

BorderBottomLine (Style: any)

Parameters

Style

any Use a string for user-defined style names.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?BorderBottomLine, BorderLeftLine, BorderRightLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderColor

Purpose

Specify the color of a graphics box, paragraph, page, or column border. Empty parameters use current program settings. Precede with BorderStyleCreate or BorderStyleEdit and BorderUseBorderColor, and end with BorderStyleEnd. The values of a selected color are displayed in the Define Color Printing Palette dialog box.

Syntax

BorderColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

See Also

?BorderColorBlue, ?BorderColorGreen, ?BorderColorRed, ?BorderColorShading, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, BorderUseBorderColor, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderCornerRadius

Purpose

Specify the curve of border corners.

Syntax

BorderCornerRadius (Radius: measurement)

Parameters

Radius

measurement Higher measurements produce more rounded corners.

See Also

?BorderCornerRadius, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderDropShadow

Purpose

Specify the location, size, and color of a border shadow. The values of a selected color are displayed in the Define Color Printing Palette dialog box.

Syntax

BorderDropShadow (Location: enumeration; Size: measurement; ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

Location

enumeration (optional)

LowerLeft!

LowerRight!

NoShadow!

UpperLeft!

UpperRight!

Size

measurement (optional) Default: .125"

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

See Also

BorderStyleCreate, BorderStyleEdit, BorderStyleEnd


BorderInsideSpacing

Purpose

Specify the inside border spacing. Not available for page borders. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.

Syntax

BorderInsideSpacing (Bottom: measurement; Left: measurement; Right: measurement; Top: measurement)

Parameters

Bottom

measurement (optional)

Left

measurement (optional)

Right

measurement (optional)

Top

measurement (optional)

See Also

?BorderInsideSpacingTop, ?BorderInsideSpacingBottom, BorderOutsideSpacing, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderLeftLine

Purpose

Specify the left line style of a border.

Syntax

BorderLeftLine (Style: any)

Parameters

Style

any Use a string for user-defined styles.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?BorderLeftLine, BorderBottomLine, BorderRightLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderOutsideSpacing

Purpose

Specify the outside border spacing.

Syntax

BorderOutsideSpacing (Left: measurement; Right: measurement; Top: measurement; Bottom: measurement)

Parameters

Left

measurement

Right

measurement

Top

measurement

Bottom

measurement

See Also

BorderInsideSpacing, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderRightLine

Purpose

Specify a right line border style.

Syntax

BorderRightLine (Style: any)

Parameters

Style

any Use a string for user-defined styles.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?BorderRightLine, BorderBottomLine, BorderLeftLine, BorderSeparatorLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderSeparatorLine

Purpose

Specify a separator line style in a paragraph or column border. Precede with BorderStyleCreate or BorderStyleEdit and end with BorderStyleEnd.

Syntax

BorderSeparatorLine (Style: any)

Parameters

Style

any Use a string for user-defined styles.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?BorderSeparatorLine, BorderBottomLine, BorderLeftLine, BorderRightLine, BorderTopLine, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderSetSpacing

Purpose

Turn Auto spacing on or off in the current border style. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.

Syntax

BorderSetSpacing (State: enumeration)

Parameters

State

enumeration Yes! = Set border spacing on

No! = Auto border spacing on

No!

Yes!

See Also

?BorderSetSpacing, BorderInsideSpacing, BorderOutsideSpacing, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderStyleCopy

Purpose

Copy a border style.

Syntax

BorderStyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)

Parameters

Style

any Enclose user-defined styles in quotation marks.

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

FromLibrary

enumeration (optional)

CurrentDocument!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration (optional)

CurrentDocument!

PersonalLibrary!

SharedLibrary!

DestName

string (optional) The new name for a style.

See Also

BorderStyleRetrieve, BorderStyleSave


BorderStyleCreate

Purpose

Create a new border style.

Syntax

BorderStyleCreate (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BorderStyleDelete, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderStyleDelete

Purpose

Delete a border style.

Syntax

BorderStyleDelete (Style: any; Library: enumeration)

Parameters

Style

any Enclose user-defined styles in quotation marks.

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BorderStyleCopy, BorderStyleRetrieve, BorderStyleSave, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderStyleEdit

Purpose

Specify a border style to edit.

Syntax

BorderStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any Enclose user-defined styles in quotation marks.

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

?Border, BorderStyleCreate, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderStyleEnd

Purpose

Exit border style create or edit mode with or without saving changes. Precede this command with BorderStyleCreate or BorderStyleEdit.

Syntax

BorderStyleEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

BorderStyleCreate, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderStyleName

Purpose

Rename a user-defined border style. Precede with BorderStyleEdit.

Syntax

BorderStyleName (Style: string)

Parameters

Style

string

See Also

BorderStyleCreate, BorderStyleEdit


BorderStyleRetrieve

Purpose

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

Syntax

BorderStyleRetrieve (Filename: string; FromLibrary: enumeration)

Parameters

Filename

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

FromLibrary

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

BorderStyleSave, StyleCopy


BorderStyleSave

Purpose

Save border styles to a specified library.

Syntax

BorderStyleSave (Filename: string; Library: enumeration)

Parameters

Filename

string The full path required.

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BorderStyleCopy, BorderStyleRetrieve


BorderTopLine

Purpose

Specify the top line style of a border. Precede with BorderStyleCreate or BorderStyleEdit and end with BorderStyleEnd.

Syntax

BorderTopLine (Style: any)

Parameters

Style

any Enclose user-defined styles in quotation marks.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?BorderTopLine, BorderBottomLine, BorderLeftLine, BorderRightLine, BorderSeparatorLine, TextBorderCreate, TextBorderEdit, TextBorderEnd


BorderUseBorderColor

Purpose

Specify whether the current border uses the line style color or the border color. Precede with BorderStyleCreate or BorderStyleEdit, follow with BorderColor, and end with BorderStyleEnd.

Syntax

BorderUseBorderColor (State: enumeration)

Parameters

State

enumeration No! = Use line style color

Yes! = Use border color

No!

Yes!

See Also

?BorderUseBorderColor, BorderColor, BorderStyleCreate, BorderStyleEdit, BorderStyleEnd, TextBorderCreate, TextBorderEdit, TextBorderEnd


BoxAttachTo

Purpose

Anchor a graphics box to a page, paragraph, or character. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

BoxAttachTo (Anchor: enumeration)

Parameters

Anchor

enumeration

Character!

Page!

Paragraph!

See Also

?BoxAttachTo, BoxCreate, BoxEdit, BoxEnd, BoxHorizontalPosition, BoxVerticalPosition


BoxBackwardOne

Purpose

Move the selected object(s) back one layer. Precede with BoxCreate or BoxEdit.

Syntax

BoxBackwardOne ()

See Also

BoxCreate, BoxEdit, BoxForwardOne


BoxBorder

Purpose

Specify a box border style. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

BoxBorder (Style: any)

Parameters

Style

any

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

See Also

BoxBorderDlg, BoxCreate, BoxEdit, BoxEnd


BoxBorderDlg

Purpose

Display the Box Border/Fill Styles dialog box.

Syntax

BoxBorderDlg ()

See Also

BoxBorder


BoxCaptionEdit

Purpose

Begin the caption editing commands. Follow with commands such as Type that furnish caption text.

Syntax

BoxCaptionEdit ()

See Also

BoxCaptionEditEnd


BoxCaptionEditEnd

Purpose

End the caption editing commands. Precede with BoxCaptionEdit and commands such as Type that modify caption text.

Syntax

BoxCaptionEditEnd ()

See Also

BoxCaptionEdit, SubstructureExit


BoxCaptionFormatting

Purpose

Specify the caption width.

Syntax

BoxCaptionFormatting (SizeAuto: any)

Parameters

SizeAuto

any To base the width on the current unit of measure, use a measurement expression. To base the width on a percent of the box width, use a number. To set the width automatically, use AutoWidth!.

See Also

?BoxCaptionFormatting, BoxCreate, BoxEdit, BoxEnd


BoxCaptionInitialStyle

Purpose

Specify an initial caption style.

Syntax

BoxCaptionInitialStyle (Style: any)

Parameters

Style

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

?BoxCaptionDefaultInitialStyle, BoxCreate, BoxEdit, BoxEnd


BoxCaptionNumberStyle

Purpose

Specify a caption numbering style. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

BoxCaptionNumberStyle (Style: any)

Parameters

Style

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

?BoxCaptionDefaultNumberStyle, BoxCreate, BoxEdit, BoxEnd


BoxCaptionPosition

Purpose

Specify the caption position.

Syntax

BoxCaptionPosition (Side: enumeration; Border: enumeration; Alignment: enumeration; AlignmentOffset: any)

Parameters

Side

enumeration The caption side.

Bottom!

Left!

Right!

Top!

Border

enumeration The caption relative to the border.

InsideBorder!

OnBorder!

OutsideBorder!

Alignment

enumeration (optional) The caption position.

Bottom!

Center!

Left!

Right!

Top!

AlignmentOffset

any (optional)

See Also

?BoxCaptionPositionAlignment, ?BoxCaptionPositionBorder, ?BoxCaptionPositionOffset


BoxCaptionRotation

Purpose

Rotate the captions. Precede with a command such as BoxCreate and BoxUpdateDisplay, and end with BoxEnd.

Syntax

BoxCaptionRotation (Rotation: enumeration)

Parameters

Rotation

enumeration

Degrees180!

Degrees270!

Degrees90!

None!

See Also

?BoxCaptionRotation, BoxCreate, BoxEdit, BoxEnd, BoxUpdateDisplay


BoxChangeLineHeight

Purpose

Specify whether line height changes when a box is attached to a character. Default: Yes!

Syntax

BoxChangeLineHeight (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxChangeLineHeight, BoxCreate, BoxEdit, BoxEnd


BoxChangeStyle

Purpose

Specify a box style.

Syntax

BoxChangeStyle (BoxType: any)

Parameters

BoxType

any Enclose user-defined styles in quotation marks.

ButtonBox!

EquationBox!

FigureBox!Macro List Text = InlineEquationBox!

NoBox!

TableBox!

TextBox!

UserBox!

WatermarkImageBox!

See Also

BoxCreate, BoxEdit, BoxEnd, BoxStyleCreate, BoxStyleName


BoxContentEdit

Purpose

Create and edit graphics box contents. Follow with commands that furnish box contents.

Syntax

BoxContentEdit ()

See Also

BoxContentPosition, BoxContentType


BoxContentPosition

Purpose

Position box contents.

Syntax

BoxContentPosition (Horizontal: enumeration; Vertical: enumeration)

Parameters

Horizontal

enumeration

Center!

Left!

Right!

Vertical

enumeration

Bottom!

Center!

Top!

See Also

?BoxContentHorizontalPosition, ?BoxContentVerticalPosition, BoxContentEdit, BoxCreate, BoxEdit, BoxEnd


BoxContentPreserveAspectRatio

Purpose

Preserve the image width/height ratio when the box changes.

Syntax

BoxContentPreserveAspectRatio (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxContentPreserveAspectRatio, BoxCreate, BoxEdit, BoxEnd


BoxContentType

Purpose

Specify the graphics box content type.

Syntax

BoxContentType (Content: enumeration)

Parameters

Content

enumeration

Empty!

Macro!

Equation!

Presentation!

External!

Text!

Image!

Video!

LinkedText!

 

See Also

?BoxContentType, BoxCreate, BoxEdit, BoxEnd


BoxCounter

Purpose

Assign a new counter to the current box or box style.

Syntax

BoxCounter (CounterName: any)

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

See Also

?BoxCounter, BoxCreate, BoxEdit, BoxEditByCounter, BoxEnd


BoxCreate

Purpose

Create a graphics box. Follow with box editing commands and BoxEnd.

Syntax

BoxCreate (BoxType: any)

Parameters

BoxType

any

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InLineEquationBox!

WatermarkImageBox!

NoBox!

 

See Also

BoxDelete, BoxEdit, BoxEnd


BoxDelete

Purpose

Delete a graphics box.

Syntax

BoxDelete (BoxType: enumeration; BoxNumber: numeric)

Parameters

BoxType

enumeration

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

BoxNumber

numeric

See Also

BoxCreate, BoxEdit, BoxEnd


BoxEdit

Purpose

Specify the number of a graphics box to edit.

Syntax

BoxEdit (BoxNumber: numeric)

Parameters

BoxNumber

numeric

See Also

BoxCreate, BoxDelete, BoxEditByCounter, BoxEditNext, BoxEditPrevious, BoxEnd


BoxEditByCounter

Purpose

Specify the counter name and number of a graphics box to edit.

Syntax

BoxEditByCounter (CounterName: any; {CounterLevelNumber: numeric; })

Parameters

CounterName

any

EquationCounter!

FigureCounter!

None!

TableBoxCounter!

TextBoxCounter!

UserBoxCounter!

CounterLevelNumber

numeric (optional) Repeat for each counter level.

See Also

BoxCreate, BoxDelete, BoxEdit, BoxEditNext, BoxEditPrevious, BoxEnd


BoxEditNext

Purpose

Begin the editing commands for the next box or a specified box type. Follow with box editing commands and BoxEnd.

Syntax

BoxEditNext (BoxType: enumeration)

Parameters

BoxType

enumeration (optional) Default: box after the insertion point, regardless of type.

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

See Also

BoxEdit, BoxEditByCounter, BoxEditPrevious


BoxEditPrevious

Purpose

Begin the editing commands for the previous box or a specified box type.

Syntax

BoxEditPrevious (BoxType: enumeration)

Parameters

BoxType

enumeration (optional) Default: box immediately before the insertion point, regardless of type.

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

See Also

BoxEdit, BoxEditByCounter, BoxEditNext


BoxEnd

Purpose

Save the editing changes to a graphics box and display or hide the Graphics Box feature bar.

Syntax

BoxEnd (State: enumeration; BoxOptionsBar: enumeration)

Parameters

State

enumeration (optional)

Cancel!

Save!

BoxOptionsBar

enumeration (optional) Display or hide the Graphics feature bar.

DontHide!

Hide!

See Also

BoxCreate, BoxDelete, BoxEdit


BoxEquationColor

Purpose

Specify a box equation color and shading value. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

BoxEquationColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

See Also

?BoxEquationColorBlue, ?BoxEquationColorGreen, ?BoxEquationColorRed, ?BoxEquationColorShading, BoxContentEdit, BoxCreate, BoxEdit, BoxEnd


BoxEquationDefaultFont

Purpose

Specify a default font and size.

Syntax

BoxEquationDefaultFont (FontSize: any)

Parameters

FontSize

any

DefaultSize!

See Also

?BoxEquationFont, ?BoxEquationFontSize, BoxEquationFont


BoxEquationFilename

Purpose

Specify the name of an equation file and designate the box contents as an equation. To retrieve an equation file use FileOpen.

Syntax

BoxEquationFilename (Filename: string)

Parameters

Filename

string

See Also

BoxCreate, BoxEdit, BoxEnd


BoxEquationFont

Purpose

Specify an equation font. Use with BoxEquationFontSize.

Syntax

BoxEquationFont (FontName: string; FontSize: measurement; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)

Parameters

FontName

string

FontSize

measurement (optional)

Family

enumeration (optional)

FamilyAestheticOrnamented!

FamilyITCZapfDingbats!

FamilyAlbertus!

FamilyLetterGothic!

FamilyBodoni!

FamilyMadrone!

FamilyBroadway!

FamilyMicrostyle!

FamilyBrush!

FamilyOldEnglish!

FamilyCenturySchoolbook!

FamilyOptima!

FamilyComputer!

FamilyParkAvenue!

FamilyCourier!

FamilyPonderosa!

FamilyHelvetica!

FamilyPTBarnum!

FamilyHobo!

FamilyRevue!

FamilyITCBenquiat!

FamilySignetRoundhand!

FamilyITCGaramond!

FamilyTekton!

FamilyITCLubalinGraph!

FamilyTimesRoman!

FamilyITCRonda!

FamilyUncial!

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchShadow!

FontMatchNormal!

FontMatchSmallCaps!

FontMatchOutline!

 

Weight

enumeration (optional)

WeightBlack!

WeightMaximum!

WeightBold!

WeightMedium!

WeightBook!

WeightRegular!

WeightDemiBold!

WeightRoman!

WeightDemiLight!

WeightSemiBold!

WeightExtraBlack!

WeightSemiLight!

WeightExtraBold!

WeightThin!

WeightExtraHeavy!

WeightUltraBlack!

WeightExtraLight!

WeightUltraHeavy!

WeightExtraThin!

WeightUltraLight!

WeightHeavy!

WeightUltraThin!

WeightLight!

WeightUnknown!

Width

enumeration (optional)

WidthCompressed!

WidthSemiCondensed!

WidthCondensed!

WidthSemiExpanded!

WidthDoubleWide!

WidthTripleWide!

WidthExpanded!

WidthUltraCompressed!

WidthExtraCondensed!

WidthUltraCondensed!

WidthExtraExpanded!

WidthUltraExpanded!

WidthNormal!

WidthUnknown!

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

FontMatchArabic!

FontMatchJapaneseKana!

FontMatchArabicScript!

FontMatchMath!

FontMatchASCII!

FontMatchMathExtension!

FontMatchBoxDrawing!

FontMatchMultinational1!

FontMatchCyrillic!

FontMatchMultinational2!

FontMatchGreek!

FontMatchTypographicSymbols!

FontMatchHebrew!

FontMatchUserDefined!

FontMatchIconicSymbols!

 

See Also

?BoxEquationFont, ?BoxEquationFontSize, BoxEquationDefaultFont, BoxEquationFontSize


BoxEquationFontSize

Purpose

Specify an equation font size.

Syntax

BoxEquationFontSize (Size: measurement)

Parameters

Size

measurement

See Also

?BoxEquationFont, ?BoxEquationFontSize, BoxEquationFont


BoxEquationRedisplay

Purpose

Enlarge or reduce an equation display.

Syntax

BoxEquationRedisplay (Zoom: numeric)

Parameters

Zoom

numeric (optional)

See Also

BoxContentEdit, BoxCreate, BoxEdit, BoxEnd


BoxEquationSaveAsGraphic

Purpose

Save an equation box as a graphics file.

Syntax

BoxEquationSaveAsGraphic (Filename: string; Format: enumeration)

Parameters

Filename

string

Format

enumeration (optional) Default: current graphics format.

Presentations_20!

WordPerfectGraphic_10!

WordPerfectGraphic_20!

See Also

BoxEquationFilename


BoxFill

Purpose

Select a box fill style.

Syntax

BoxFill (FillStyleName: any)

Parameters

FillStyleName

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

BoxContentEdit, BoxCreate, BoxEdit, BoxEnd


BoxForwardOne

Purpose

Move the selected object(s) forward one layer.

Syntax

BoxForwardOne ()

See Also

BoxBackwardOne


BoxHeight

Purpose

Specify the box height according to the height of box contents or a fixed measurement.

Syntax

BoxHeight (Height: any)

Parameters

Height

any Specify AutoHeight! or a fixed height.

AutoHeight!

See Also

?BoxHeight, BoxCreate, BoxEdit, BoxEnd, BoxWidth


BoxHorizontalAlignment

Purpose

Specify the alignment of a box attached to a page or paragraph.

Syntax

BoxHorizontalAlignment (Alignment: enumeration; Position: enumeration; Offset: measurement; LeftColumn: numeric; RightColumn: numeric)

Parameters

Alignment

enumeration

AlignColumns!

AlignMargins!

Position

enumeration The horizontal position after alignment to margins or columns.

Center!

FullAlign!

Left!

Right!

Offset

measurement (optional) The image position relative to the alignment point. Left is a negative number, right is positive.

LeftColumn

numeric (optional) Use when a box aligns to columns.

RightColumn

numeric (optional) Use when a box aligns to columns.

See Also

?BoxHorizontalAlignment, ?BoxHorizontalAlignTo, ?BoxHorizontalOffset, BoxCreate, BoxEdit, BoxEnd, BoxHorizontalPosition


BoxHorizontalPosition

Purpose

Specify the horizontal position of a box relative to the left edge of the page.

Syntax

BoxHorizontalPosition (Position: measurement)

Parameters

Position

measurement

See Also

BoxCreate, BoxEdit, BoxEnd, BoxHorizontalAlignment


BoxImageBlackWhiteThreshold

Purpose

Specify the point at which colors and/or grays in the current image convert to black and white.

Syntax

BoxImageBlackWhiteThreshold (Threshold: numeric)

Parameters

Threshold

numeric Value: 1-255. Values below the threshold convert to black, those above convert to white. Default: 127.

See Also

?BoxImageBlackWhiteThreshold, BoxCreate, BoxEdit, BoxEnd, BoxImageMonochrome


BoxImageBrightness

Purpose

Adjust the brightness (saturation) of a color or black and white image.

Syntax

BoxImageBrightness (Amount: numeric)

Parameters

Amount

numeric Value: -1.0 to 1.0. Black: -1.0. White: 1.0.

See Also

?BoxImageBrightness, BoxCreate, BoxEdit, BoxEnd, BoxImageContrast


BoxImageContrast

Purpose

Specify the contrast between light and dark areas of an image.

Syntax

BoxImageContrast (Contrast: numeric)

Parameters

Contrast

numeric Value: -1.0 to 1.0. Slight: -1.0. Strong: 1.0.

See Also

?BoxImageContrast, BoxCreate, BoxEdit, BoxEnd


BoxImageDitherMethod

Purpose

Specify a dither method and source.

Syntax

BoxImageDitherMethod (Method: enumeration; Source: enumeration)

Parameters

Method

enumeration

Default!

ErrorDiffusionDither!

Halftoning!

OrderedDither!

Source

enumeration

Default!

External!

Printer!

WordPerfect!


BoxImageFill

Purpose

Specify an image fill type. Images can have normal fill, no fill, or white fill.

Syntax

BoxImageFill (ImageFillType: enumeration)

Parameters

ImageFillType

enumeration

Normal!

Transparent!

White!

See Also

?BoxImageFill


BoxImageFlipX

Purpose

Flip an image box on its X (horizontal) axis, turning the image upside down.

Syntax

BoxImageFlipX (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxImageFlipX, BoxCreate, BoxEdit, BoxEnd, BoxImageFlipY


BoxImageFlipY

Purpose

Reverse an image box on its Y (vertical) axis, turning the image from side to side.

Syntax

BoxImageFlipY (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxImageFlipY, BoxCreate, BoxEdit, BoxEnd, BoxImageFlipX


BoxImageHalfToneOptions

Purpose

Specify the default or user-defined halftone values for the current printer.

Syntax

BoxImageHalfToneOptions (HalfTone: enumeration; LPI: numeric; Plane0: numeric; Plane1: numeric; Plane2: numeric; Plane3: numeric)

Parameters

HalfTone

enumeration

DefaultValues!

SetValues!

LPI

numeric (optional) The number of lines per inch for user-defined values.

Plane0

numeric (optional) The first halftone angle for user-defined values.

Plane1

numeric (optional) The second halftone angle for user-defined values.

Plane2

numeric (optional) The third halftone angle for user-defined values.

Plane3

numeric (optional) The fourth halftone angle for user-defined values.


BoxImageInvertColors

Purpose

Convert the image colors to their complements.

Syntax

BoxImageInvertColors (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxImageInvertColors, BoxCreate, BoxEdit, BoxEnd


BoxImageMonochrome

Purpose

Convert a color image to black and white, and specify the threshold for blackness.

Syntax

BoxImageMonochrome (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxImageMonochrome, BoxCreate, BoxEdit, BoxEnd, BoxImageBlackWhiteThreshold, BoxImageFill


BoxImageMove

Purpose

Move an image within a box.

Syntax

BoxImageMove (XPosition: numeric; YPosition: numeric)

Parameters

XPosition

numeric The horizontal position. Value: -5.0 to 5.0. Default: 0 (centered).

YPosition

numeric The vertical position. Value: -5.0 to 5.0. Default: 0 (centered).

See Also

?BoxImageTranslationY, ?BoxImageTranslationX, BoxCreate, BoxEdit, BoxEnd


BoxImageRetrieve

Purpose

Retrieve an image.

Syntax

BoxImageRetrieve (Action: enumeration; Filename: string; FileFormat: enumeration)

Parameters

Action

enumeration

LeaveExternal!

MakeInternal!

UseInternal!

Filename

string

FileFormat

enumeration (optional)

AdobePhotoShop!

Macintosh_PICT!

AutoCAD_DXF!

MacPaint!

BIFFCharts!

Micrografx!

Bitmap!

MicrografxPicturePublisher4!

CALSBitmap!

PCPaintbrushX!

CGM!

Presentations_20!

CompuserveGIF!

ScitexCT!

CompuserveGIF24!

TaggedImageFileFormat!

CorelPhotoPaint!

TarGA!

CorelVentura!

WindowsMetaFile!

CorelWavelen!

WordPerfectGraphic_10!

EncapsulatedPostScript!

WordPerfectGraphic_20!

EnhancedWindowsMetaFile!

WPChartingData_10!

FAX_TIFF!

WPChartingData_10E!

GEMIMG!

WPChartingData_20!

HewlettPackardGraphicPlotter!

WPChartingStyle_10!

JPEG!

WPChartingStyle_10E!

KodakPhotoCD!

WPChartingStyle_20!

LotusPIC!

WPWorksPaint_20!

See Also

BoxCreate, BoxEdit, BoxEnd


BoxImageRotate

Purpose

Rotate an image within a box.

Syntax

BoxImageRotate (Rotation: numeric)

Parameters

Rotation

numeric Value: 0.0 to 359.0.

See Also

?BoxImageRotation, BoxCreate, BoxEdit, BoxEnd


BoxImageSave

Purpose

Save an image, and optionally rename it and specify a graphics format.

Syntax

BoxImageSave (Filename: string; Format: enumeration)

Parameters

Filename

string

Format

enumeration

Presentations_20!

WordPerfectGraphic_10!

WordPerfectGraphic_20!

See Also

BoxCreate, BoxEdit, BoxEnd


BoxImageScaling

Purpose

Scale an image within a box.

Syntax

BoxImageScaling (XScale: numeric; YScale: numeric)

Parameters

XScale

numeric The image width. Value: 0.01 to 9.99. Default: 1.0.

YScale

numeric The image height. Value: 0.01 to 9.99. Default: 1.0.

See Also

?BoxImageScalingX, ?BoxImageScalingY, BoxCreate, BoxEdit, BoxEnd


BoxImageShowBackground

Purpose

Display the background colors or gradient saved with an image.

Syntax

BoxImageShowBackground (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxImagePageBackground, BoxCreate, BoxEdit, BoxEnd


BoxInitialStyleDlg

Purpose

Display the Text Box Initial Style dialog box. Specify a box before this command.

Syntax

BoxInitialStyleDlg ()


BoxOLEEditObject

Purpose

Edit the graphics box contents with the OLE server.

Syntax

BoxOLEEditObject ()


BoxOverlap

Purpose

Allow a box to overlap other boxes. Precede with BoxCreate or BoxEdit and follow with BoxEnd. This command takes effect only for boxes that are attached to a page or a paragraph.

Syntax

BoxOverlap (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxOverlap, BoxHorizontalAlignment, BoxHorizontalPosition, BoxVerticalAlignment, BoxVerticalPosition


BoxPosDlg

Purpose

Display the Box Position dialog box.

Syntax

BoxPosDlg ()


BoxResetBorder

Purpose

Reset the border values for the current box to the values of the corresponding box style. For example, border changes made to a specific figure box reset to the default border values assigned to the Figure Box style. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

BoxResetBorder ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetCaption

Purpose

Reset the caption values for the current box to the caption values of the corresponding box style. For example, caption changes made to a specific text box are reset to the default caption values assigned to the Text Box style. Precede with BoxEdit and end with BoxEnd.

Syntax

BoxResetCaption ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetContent

Purpose

Reset the content values for the current box to the content values of the corresponding box style. For example, content changes made to a specific user box are reset to the values assigned to the User Box style. Precede with BoxEdit and end with BoxEnd.

Syntax

BoxResetContent ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetContentRender

Purpose

Reset the content render values for the current box to the values of the corresponding box style. For example, content render changes made to a specific equation box are reset to the default content render values assigned to the Equation Box style.

Syntax

BoxResetContentRender ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetCounter

Purpose

Reset the counter values for the current box to the values of the corresponding box style. For example, counter changes made to an equation box are reset to the default counter values of the Equation Box style.

Syntax

BoxResetCounter ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetFill

Purpose

Reset the fill values for the current box to the values of the corresponding box style. For example, fill style changes made to a figure box are reset to the fill values of the Figure Box style.

Syntax

BoxResetFill ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetPosition

Purpose

Reset the position values for the current box to the position values for the corresponding box style. For example, position changes made to a figure box are reset to default position values of the Figure Box style.

Syntax

BoxResetPosition ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxResetTextFlow

Purpose

Reset the text wrapping values for the current box to the values of the corresponding box style. For example, text wrapping changes made to a user box are reset to the text flow values of the User Box style.

Syntax

BoxResetTextFlow ()

See Also

BoxCreate, BoxEdit, BoxEnd


BoxSaveLookAsStyle

Purpose

Save the settings for the current box as a style. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.

Syntax

BoxSaveLookAsStyle (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BoxStyleCreate


BoxStaysOnPage

Purpose

Specify whether a graphics box is allowed to move with the surrounding text. Although you may use BoxStaysOnPage to set this option for boxes that are attached to a paragraph or character, it takes effect only for boxes that are attached to a page. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.

Syntax

BoxStaysOnPage (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?BoxStaysOnPage


BoxStyleCopy

Purpose

Copy a box style from one library to another and/or rename the style.

Syntax

BoxStyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)

Parameters

Style

any

ButtonBox!

EquationBox!

FigureBox!

InlineEquationBox!

NoBox!

TableBox!

TextBox!

UserBox!

WatermarkImageBox!

FromLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

DestName

string (optional) The new name of the style.

See Also

BoxStyleCreate, BoxStyleDelete, BoxStyleEdit, BoxStyleRetrieve


BoxStyleCreate

Purpose

Create a box style and specify the library where it resides.

Syntax

BoxStyleCreate (Style: any; Library: enumeration)

Parameters

Style

any

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BoxStyleDelete, BoxStyleEdit, BoxStyleRetrieve, GraphicBoxStyleDlg


BoxStyleDelete

Purpose

Delete a user-defined box style.

Syntax

BoxStyleDelete (Style: any; Library: enumeration)

Parameters

Style

any

ButtonBox!

EquationBox!

FigureBox!

InlineEquationBox!

NoBox!

TableBox!

TextBox!

UserBox!

WatermarkImageBox!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BoxStyleCreate, BoxStyleEdit, BoxStyleRetrieve, GraphicBoxStyleDlg


BoxStyleEdit

Purpose

Begin box style editing.

Syntax

BoxStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any Enclose user-defined styles in quotation marks.

ButtonBox!

EquationBox!

FigureBox!

InlineEquationBox!

NoBox!

TableBox!

TextBox!

UserBox!

WatermarkImageBox!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BoxStyleCreate, BoxStyleDelete, BoxStyleEdit, BoxStyleEnd, BoxStyleRetrieve


BoxStyleEnd

Purpose

Exit the graphics style create or edit mode with or without saving changes. Precede this command with BoxStyleCreate or BoxStyleEdit.

Syntax

BoxStyleEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

BoxStyleCreate, BoxStyleEdit


BoxStyleName

Purpose

Specify a box style name. Precede with BoxStyleCreate.

Syntax

BoxStyleName (StyleName: string)

Parameters

StyleName

string

See Also

BoxStyleCreate


BoxStyleRetrieve

Purpose

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

Syntax

BoxStyleRetrieve (Filename: string; Library: enumeration)

Parameters

Filename

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

Library

enumeration 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! Not used.

See Also

BoxStyleCopy, BoxStyleSave


BoxStyleSave

Purpose

Save all styles in the current document or a specified style library to another style library, replacing all styles already in it.

Syntax

BoxStyleSave (Filename: string; Library: enumeration)

Parameters

Filename

string The style library to save to.

Library

enumeration The current style location.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

BoxStyleCopy, BoxStyleRetrieve


BoxTextAngle

Purpose

Rotate the text in a text box.

Syntax

BoxTextAngle (Angle: enumeration)

Parameters

Angle

enumeration

Degrees180!

Degrees270!

Degrees90!

None!

See Also

?BoxTextAngle, BoxCreate, BoxEdit, BoxEnd


BoxTextDefaultStyle

Purpose

Specify the default text box style.

Syntax

BoxTextDefaultStyle (Style: any)

Parameters

Style

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

?BoxTextDefaultStyle, BoxCreate, BoxEdit, BoxEnd


BoxTextEdit

Purpose

Begin the text box editing commands. Follow with commands that modify box contents such as Type and end with BoxTextEditEnd.

Syntax

BoxTextEdit ()

See Also

BoxContentEdit, BoxTextEditEnd


BoxTextEditEnd

Purpose

End the text box editing commands. Precede with BoxTextEdit and commands such as Type which modify box text.

Syntax

BoxTextEditEnd ()

See Also

BoxTextEdit, SubstructureExit


BoxTextFilename

Purpose

Specify a file to insert into a text box.

Syntax

BoxTextFilename (Filename: string)

Parameters

Filename

string


BoxTextFlow

Purpose

Specify the side(s) of a box to wrap text around.

Syntax

BoxTextFlow (Wrap: enumeration)

Parameters

Wrap

enumeration

BothSides!

Columnar!

LargestSide!

LeftSide!

NeitherSide!

NoWrapping!

RightSide!

See Also

?BoxWrapping, BoxCreate, BoxEdit, BoxEnd


BoxTextFlowContour

Purpose

Contour the text outside a box to the shape of an image inside the box.

Syntax

BoxTextFlowContour ()

See Also

BoxTextFlow, BoxTextFlowSquare


BoxTextFlowSquare

Purpose

Contour the text outside a box evenly around all sides of the box. Precede with BoxTextFlowContour.

Syntax

BoxTextFlowSquare ()

See Also

BoxTextFlow, BoxTextFlowContour


BoxToBack

Purpose

Move the selected object(s) to the back.

Syntax

BoxToBack ()


BoxToFront

Purpose

Move the selected object(s) to the front.

Syntax

BoxToFront ()


BoxUpdateDisplay

Purpose

Update the appearance of a box after editing changes. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and followed by BoxEnd.

Syntax

BoxUpdateDisplay ()


BoxVerticalAlignment

Purpose

Align a box with the page or character it is attached to. This command is not valid with paragraph-attached boxes. Precede with BoxCreate or BoxEdit and follow with BoxEnd.

Syntax

BoxVerticalAlignment (Alignment: enumeration; Offset: any)

Parameters

Alignment

enumeration

Baseline!

BaseOffset!

Bottom!

Center!

FullAlign!

Top!

Offset

any (optional)

See Also

?BoxVerticalAlignment, ?BoxVerticalOffset, BoxCreate, BoxEdit, BoxEnd, BoxVerticalPosition


BoxVerticalPosition

Purpose

Specify the vertical position of a box attached to a page or paragraph. For example, the distance from the top of the page (or top margin) to the top of the box. Not valid for boxes attached to characters.

Syntax

BoxVerticalPosition (Alignment: any)

Parameters

Alignment

any

See Also

BoxCreate, BoxEdit, BoxEnd, BoxVerticalAlignment, TextBoxCreate


BoxWidth

Purpose

Base the box width on the width of box contents or specify a fixed measurement.

Syntax

BoxWidth (Width: any)

Parameters

Width

any Use a number to specify a fixed width.

AutoWidth!

See Also

?BoxWidth, BoxCreate, BoxEdit, BoxEnd, BoxHeight


BoxWrapDlg

Purpose

Display the Wrap Text dialog box.

Syntax

BoxWrapDlg ()


BulletDlg

Purpose

Display the Bullets & Numbers dialog box.

Syntax

BulletDlg ()


BulletSetCounter

Purpose

Specify a bullet style name and counter value.

Syntax

BulletSetCounter (CounterName: string; Value: numeric)

Parameters

CounterName

string

Value

numeric


ButtonBarAddItem

Purpose

Add items such as macros, buttons, and separators to a toolbar. use any combination of parameters to identify an item.

Syntax

ButtonBarAddItem (ButtonBarName: string; Template: enumeration; ItemName: string; Offset: numeric; Type: enumeration; MacroName: string; ItemText: string; Prompt: string; HelpFile: string; HelpId: string; Script: string)

Parameters

ButtonBarName

string The toolbar to edit.

Template

enumeration (optional) The toolbar location.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

ItemName

string For predefined items, use a macro command name.

Offset

numeric (optional) The position of an added item. First position: 0. Default: last.

Type

enumeration

Feature!

Launch!

Macro!

Script!

Separator!

MacroName

string (optional)

ItemText

string (optional) The text to display on a user-defined item.

Prompt

string (optional) The text to display for the new item on the status bar.

HelpFile

string (optional) The Help file to use if Help is the added item. Not used in the current version of the application.

HelpId

string (optional) The ID number of the Help file specified in the HelpFile parameter. Not used in the current version of the application.

Script

string (optional)


ButtonBarCreateDlg

Purpose

Display the Create Toolbar dialog box.

Syntax

ButtonBarCreateDlg ()


ButtonBarDeleteItem

Purpose

Remove an item from a toolbar. Default: Last item on the current toolbar. Use any combination of parameters to identify an item.

Syntax

ButtonBarDeleteItem (ButtonBarName: string; Template: enumeration; ItemName: string; Offset: numeric)

Parameters

ButtonBarName

string The toolbar name.

Template

enumeration (optional) The toolbar location.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

ItemName

string (optional) For predefined items, use a macro command name.

Offset

numeric (optional) The position of the item to remove. First position: 0.


ButtonBarEditDlg

Purpose

Display the Toolbar Editor dialog box.

Syntax

ButtonBarEditDlg ()


ButtonBarOptionsDlg

Purpose

Display the Toolbar Options dialog box.

Syntax

ButtonBarOptionsDlg ()


ButtonBarScrollbarToggle

Purpose

Turn the toolbar scroll bar on or off.

Syntax

ButtonBarScrollbarToggle (State: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

State

enumeration (optional) Default = On!

Off!

On!

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!


ButtonBarSelect

Purpose

Select a toolbar.

Syntax

ButtonBarSelect (ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!


ButtonBarSetFont

Purpose

Specify a toolbar font face and size.

Syntax

ButtonBarSetFont (Font: string; Size: numeric)

Parameters

Font

string

Size

numeric

See Also

ButtonBarSetLocation, ButtonBarSetRows, ButtonBarSetStyle


ButtonBarSetLocation

Purpose

Specify a toolbar position.

Syntax

ButtonBarSetLocation (Location: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

Location

enumeration

Bottom!

Left!

Palette!

Right!

Top!

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!

See Also

ButtonBarSetFont, ButtonBarSetRows, ButtonBarSetStyle


ButtonBarSetRows

Purpose

Specify the number of rows on a toolbar.

Syntax

ButtonBarSetRows (Rows: numeric; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

Rows

numeric

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!

See Also

ButtonBarSetFont, ButtonBarSetLocation, ButtonBarSetStyle


ButtonBarSetStyle

Purpose

Specify a toolbar style.

Syntax

ButtonBarSetStyle (Style: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

Style

enumeration

Picture!

PictureAndText!

Text!

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!

See Also

ButtonBarSetFont, ButtonBarSetLocation, ButtonBarSetRows


ButtonBarShow

Purpose

Display or hide the toolbar. Recordable substitute: ButtonBarShowToggle.

Syntax

ButtonBarShow (State: enumeration; ButtonBarName: string; LoadedFromDefaultTemplate: enumeration)

Parameters

State

enumeration

Off!

On!

ButtonBarName

string

LoadedFromDefaultTemplate

enumeration

No!

Yes!

See Also

?ButtonBarActive, ViewToolbarsDlg


ButtonBarShowToggle

Purpose

Display or hide the toolbar.

Syntax

ButtonBarShowToggle ()

See Also

ButtonBarShow


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.

333 Europa

863 Canada/French

437 US IBM Default

865 Norway

710 Arabic

866 Cyrillic

850 PC Multilingual

895 Czech-Kamenicky

852 Eastern Europe

897 Hungarian

853 Turkish

8510 Alternate Greek

860 Portugal

8600 Alternate Portugal

861 Icelandic

8601 Alternate Portugal

862 Hebrew

8660 Alternate Cyrillic

Windows

numeric (optional) The Windows code page setting.

1004 Windows US

ISO 8859-1 Latin #1

1250 Windows Latin-2

ISO 8859-2 Latin #2

1251 Windows Cyrillic

ISO 8859-6 Latin/Arabic

1252 Windows US Standard

ISO 8859-7 Latin/Greek

1253 Windows Greek

ISO 8859-8 Latin/Hebrew

1254 Windows Turkish

 

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 ()


DateCode

Purpose

Insert a code to display the current date at the insertion point. The date code updates to the system date when the document is retrieved or reformatted.

Syntax

DateCode ()

See Also

DateText


DateFormat

Purpose

Specify a date format, and insert the Date Fmt code at the insertion point.

Syntax

DateFormat (DateFormatString: string)

Parameters

DateFormatString

string A combination of text characters, date, and/or time codes. Select date and time codes from the Macro Codes dialog. Click Codes on the Macro Bar to display the Macro Codes dialog.

See Also

DateFormatDlg


DateFormatDlg

Purpose

Display the Document Date/Time Format dialog box.

Syntax

DateFormatDlg ()

See Also

DateFormat


DateText

Purpose

Insert the system date as text at the insertion point.

Syntax

DateText ()

See Also

DateCode


DDEChangeUpdateMode

Purpose

Specify a manual or automatic DDE link update method.

Syntax

DDEChangeUpdateMode (LinkName: string; UpdateMode: enumeration)

Parameters

LinkName

string

UpdateMode

enumeration (optional)

Automatic!

Manual!


DDECreateLink

Purpose

Establish a link between a Corel WordPerfect document and a file in another application. Data changes in the source file are automatically made in the Corel WordPerfect document.

Syntax

DDECreateLink (LinkName: string; Source: string; UpdateMode: enumeration; Format: enumeration)

Parameters

LinkName

string

Source

string The application, file, and optionally, an item within the file that is linked to a Corel WordPerfect document. Separate the application and filename with a vertical bar (|). If an item (a section of a file) is specified, separate the item from the file name with a second vertical bar.

UpdateMode

enumeration (optional)

Automatic!

Manual!

Format

enumeration (optional)

METAFILE!

WP7DOC!

OEMTEXT!

WP7TEXT!

RTF!

WP8DOC!

TEXT!

WP8TEXT!

WB1!

WPDOC!

WP6DOC!

WPG2!

WP6TEXT!

 

DDECreateLinkDlg

Purpose

Display the Links dialog box.

Syntax

DDECreateLinkDlg ()


DDEDeleteLink

Purpose

Remove a DDE link.

Syntax

DDEDeleteLink ({LinkName: string; })

Parameters

LinkName

string (optional)


DDEDeleteLinkDlg

Purpose

Display the Links dialog box.

Syntax

DDEDeleteLinkDlg ()


DDEEditLink

Purpose

Change the properties of a DDE link.

Syntax

DDEEditLink (LinkName: string; NewName: string; NewSource: string)

Parameters

LinkName

string

NewName

string (optional)

NewSource

string (optional)


DDEEditLinkDlg

Purpose

Display the Change Links dialog box.

Syntax

DDEEditLinkDlg ()


DDEPasteLink

Purpose

Establish a link between a Corel WordPerfect document and a file in another application. Data changes in the source file are automatically made in the Corel WordPerfect document. After copying a selection in another application to the Clipboard, use DDEPasteLink to link it to a Corel WordPerfect document.

Syntax

DDEPasteLink (Format: enumeration)

Parameters

Format

enumeration (optional)

METAFILE!

WP7DOC!

OEMTEXT!

WP7TEXT!

RTF!

WP8DOC!

TEXT!

WP8TEXT!

WB1!

WPDOC!

WP6DOC!

WPG2!

WP6TEXT!

 

DDEUpdateLink

Purpose

Update a specified DDE link. If the optional LinkName parameter is left off, all links in the current document are updated.

Syntax

DDEUpdateLink ({LinkName: string; })

Parameters

LinkName

string (optional)


DDEUpdateLinkDlg

Purpose

Display the Links dialog box.

Syntax

DDEUpdateLinkDlg ()


DecimalAlignmentCharacter

Purpose

Specify the ASCII numeric equivalent of a decimal character.

Syntax

DecimalAlignmentCharacter (Character: string)

Parameters

Character

string The decimal separator character.

See Also

?DecimalAlignmentCharacter


DelayCodes

Purpose

Postpone the effects of codes for one or more pages.

Syntax

DelayCodes (PagesToDelay: numeric)

Parameters

PagesToDelay

numeric


DelayCodesDlg

Purpose

Display the Delay Codes dialog box.

Syntax

DelayCodesDlg ()


DeleteAppend

Purpose

Delete a selection and append it to the Clipboard.

Syntax

DeleteAppend ()


DeleteCharNext

Purpose

Delete the character to the right of the insertion point.

Syntax

DeleteCharNext ()

See Also

DeleteCharPrevious


DeleteCharPrevious

Purpose

Delete the character to the left of the insertion point.

Syntax

DeleteCharPrevious ()

See Also

DeleteCharNext


DeleteToBeginningOfWord

Purpose

Delete the text and codes from the insertion point to the beginning of the current word. The insertion point must be in a word.

Syntax

DeleteToBeginningOfWord ()

See Also

DeleteToEndOfWord


DeleteToEndOfLine

Purpose

Delete the text and codes from the insertion point to the end of the current line. Does not delete hard returns or hard page breaks.

Syntax

DeleteToEndOfLine ()


DeleteToEndOfPage

Purpose

Delete the text and codes from the insertion point to the end of the current page. Does not delete hard page breaks.

Syntax

DeleteToEndOfPage ()


DeleteToEndOfWord

Purpose

Delete the text and codes from the insertion point to the end of the current word.

Syntax

DeleteToEndOfWord ()

See Also

DeleteToBeginningOfWord


DeleteWord

Purpose

Delete the current word or space.

Syntax

DeleteWord ()


DirectoryCreate

Purpose

Create a new directory.

Syntax

DirectoryCreate (Directory: string)

Parameters

Directory

string The path and directory name.


DirectoryExists

Purpose

Return whether a specified directory exists.

Syntax

DirectoryExists (Variable: variable; Directory: string)

Parameters

Variable

variable True or False.

Directory

string


Display

Purpose

Display macro execution when a macro is played. A macro runs faster with display off. A “Macro Play” message appears on the status bar.

Syntax

boolean := Display (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

InhibitInput


DisplayMode

Purpose

Display the current document in Draft or Page mode. Included for DOS compatibility. DOS enumerations do not correspond exactly with Corel WordPerfect 8 View options. FastDraft! stops macro execution, Text! and Graphics! specify Draft mode, and FullPage! specifies Page mode. Recordable substitutes: ViewDraft, ViewPage, and ViewTwoPage.

Syntax

DisplayMode (DisplayMode: enumeration)

Parameters

DisplayMode

enumeration

FastDraft!

FullPage!

Graphics!

Text!

WebPage!


DisplayZoom

Purpose

Specify the current zoom setting.

Syntax

DisplayZoom (Percent: numeric)

Parameters

Percent

numeric Percent: 25-400.


DocCompare

Purpose

Compare the current document with an original copy of the document and mark differences with Redline and Strikeout.

Syntax

DocCompare (Filename: string; CompFlags: enumeration)

Parameters

Filename

string The original document.

CompFlags

enumeration The scope of comparison.

Paragraph!

Phrase!

Sentence!

Word!

See Also

DocCompareAddMarkingsDlg, DocCompareRemoveMarkingsDlg


DocCompareAddMarkingsDlg

Purpose

Display the Add Markings dialog box.

Syntax

DocCompareAddMarkingsDlg ()

See Also

DocCompare, DocCompareRemoveMarkingsDlg


DocCompareRemoveMarkingsDlg

Purpose

Display the Remove Markings dialog box.

Syntax

DocCompareRemoveMarkingsDlg ()

See Also

DocCompare, DocCompareAddMarkingsDlg


DocCompareRemoveRedline

Purpose

Remove Strikeout and Redline codes and Strikeout text, or remove only Strikeout codes and text.

Syntax

DocCompareRemoveRedline (Flag: enumeration)

Parameters

Flag

enumeration

LeaveRedline!

RemoveAll!

See Also

DocCompare


DocInitialFont

Purpose

Set the default font for the current document.

Syntax

DocInitialFont (Name: string; PointSize: measurement; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)

Parameters

Name

string

PointSize

measurement (optional)

Family

enumeration (optional)

FamilyAestheticOrnamented!

FamilyITCZapfDingbats!

FamilyAlbertus!

FamilyLetterGothic!

FamilyBodoni!

FamilyMadrone!

FamilyBroadway!

FamilyMicrostyle!

FamilyBrush!

FamilyOldEnglish!

FamilyCenturySchoolbook!

FamilyOptima!

FamilyComputer!

FamilyParkAvenue!

FamilyCourier!

FamilyPonderosa!

FamilyHelvetica!

FamilyPTBarnum!

FamilyHobo!

FamilyRevue!

FamilyITCBenguiat!

FamilySignetRoundhand!

FamilyITCGaramond!

FamilyTekton!

FamilyITCLubalinGraph!

FamilyTimesRoman!

FamilyITCRonda!

FamilyUncial!

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchNormal!

FontMatchOutline!

FontMatchShadow!

FontMatchSmallCaps!

Weight

enumeration (optional)

WeightBlack!

WeightMaximum!

WeightBold!

WeightMedium!

WeightBook!

WeightRegular!

WeightDemiBold!

WeightRoman!

WeightDemiLight!

WeightSemiBold!

WeightExtraBlack!

WeightSemiLight!

WeightExtraBold!

WeightThin!

WeightExtraHeavy!

WeightUltraBlack!

WeightExtraLight!

WeightUltraHeavy!

WeightExtraThin!

WeightUltraLight!

WeightHeavy!

WeightUltraThin!

WeightLight!

WeightUnknown!

Width

enumeration (optional)

WidthCompressed!

WidthSemiCondensed!

WidthCondensed!

WidthSemiExpanded!

WidthDoubleWide!

WidthTripleWide!

WidthExpanded!

WidthUltraCompressed!

WidthExtraCondensed!

WidthUltraCondensed!

WidthExtraExpanded!

WidthUltraExpanded!

WidthNormal!

WidthUnknown!

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

FontMatchArabic!

FontMatchJapaneseKana!

FontMatchArabicScript!

FontMatchMath!

FontMatchASCII!

FontMatchMathExtension!

FontMatchBoxDrawing!

FontMatchMultinational1!

FontMatchCyrillic!

FontMatchMultinational2!

FontMatchGreek!

FontMatchTypographicSymbols!

FontMatchHebrew!

FontMatchUserDefined!

FontMatchIconicSymbols!

 

See Also

?DocumentFont, DocInitialFontDlg


DocInitialFontDlg

Purpose

Display the Document Initial Font dialog box.

Syntax

DocInitialFontDlg ()

See Also

DocInitialFont


DocMaximize

Purpose

Maximize the current document window. If the document is already maximized, the macro ends or goes to the ONERROR label.

Syntax

DocMaximize ()

See Also

AppMaximize, AppMinimize, AppRestore, DocMinimize, DocRestore


DocMinimize

Purpose

Minimize the current document window. If the document is already minimized, the macro ends or goes to the ONERROR label.

Syntax

DocMinimize ()

See Also

AppMaximize, AppMinimize, AppRestore, DocMaximize, DocRestore


DocMove

Purpose

Reposition or resize the current document if the application window has been minimized.

Syntax

DocMove ()

See Also

AppMove


DocNext

Purpose

Move the current document to the back and the most recently opened document to the front.

Syntax

DocNext ()

See Also

DocPrevious


DocPrevious

Purpose

Activate the previous document window, if the document is still open.

Syntax

DocPrevious ()

See Also

DocNext


DocRedlineMethodDlg

Purpose

Display the Redline dialog box.

Syntax

DocRedlineMethodDlg ()


DocRestore

Purpose

Restore the current document to the size it was before it was minimized or maximized. If the document is already restored, the macro ends or goes to the ONERROR label.

Syntax

DocRestore ()

See Also

AppMaximize, AppMinimize, AppRestore, DocMaximize, DocMinimize


DocSize

Purpose

Move or resize the current minimized document window. If the window is maximized, an error is displayed and the macro ends or goes to the ONERROR label.

Syntax

DocSize ()

See Also

AppSize


DocSummaryConfig

Purpose

Specify the fields to include in the current document summary.

Syntax

DocSummaryConfig ({DocSumFieldName: enumeration; })

Parameters

DocSumFieldName

enumeration (optional) Repeat the parameter for as many fields as need to be specified. Enclose repeating parameters in braces ({}) and separate with semi-colons.

Abstract!

Language!

Account!

MailStop!

Address!

Matter!

Attachments!

Office!

Author!

Owner!

Authorization!

Project!

BillTo!

Publisher!

BlindCopy!

Purpose!

CarbonCopy!

ReceivedFrom!

Category!

RecordedBy!

CheckedBy!

RecordedDate!

Client!

Reference!

Comments!

RevisionDate!

CreationDate!

RevisionNotes!

DateCompleted!

RevisionNumber!

Department!

Section!

DescriptiveName!

Security!

DescriptiveType!

Source!

Destination!

Status!

Disposition!

Subject!

Division!

TelephoneNumber!

DocumentNumber!

Typist!

Editor!

VersionDate!

ForwardTo!

VersionNotes!

Group!

VersionNumber!

Keywords!

 

See Also

DocSumSet


DocSummaryDelete

Purpose

Delete the current document summary information.

Syntax

DocSummaryDelete ()

See Also

DocSummaryDlg


DocSummaryDlg

Purpose

Display the Document Summary dialog box.

Syntax

DocSummaryDlg ()

See Also

DocSummaryDelete


DocSummaryPrint

Purpose

Print the current document summary.

Syntax

DocSummaryPrint ()

See Also

DocSummaryDlg, Print


DocSummarySaveAs

Purpose

Save the current document summary with a filename.

Syntax

DocSummarySaveAs (Filename: string; ExportType: enumeration; AppendReplace: enumeration)

Parameters

Filename

string

ExportType

enumeration (optional)

AmiPro_10!

RTF!

AmiPro_12!

RTFJ!

AmiPro_12A!

WindowsWrite!

AmiPro_12B!

WordForWindows_10!

AmiPro_30!

WordForWindows_11!

ANSIDelimitedTextWindows!

WordForWindows_12!

ANSIGenericWordProcessor_Windo!

WordForWindows_1A!

ANSIText_Windows!

WordForWindows_20!

ASCIIStandard!

WordForWindows_20a!

ASCIIStripped!

WordForWindows_20b!

DelimitedText!

WordForWindows_50!

DisplayWrite_40!

WordPerfect_42!

DisplayWrite_42!

WordPerfect_50!

DisplayWrite_50!

WordPerfect_51!

Excel_40!

WordPerfect_5xA!

FFT!

WordPerfect_60!

Kermit_7bit_Transfer!

WordPerfect_7!

MicroSoftWord_40!

WordStar_33!

MicroSoftWord_50!

WordStar_331!

MicroSoftWord_55!

WordStar_34!

MultiMate_33!

WordStar_40!

MultiMate_40!

WordStar_50!

MultiMateAdvantage_36!

WordStar_55!

MultiMateAdvantageII_10!

WordStar_60!

NavyDIF!

WordStar2000_10!

OfficeWriter_60!

WordStar2000_20!

OfficeWriter_61!

WordStar2000_30!

OfficeWriter_611!

XyWriteIIIPlus_355!

OfficeWriter_62!

XyWriteIIIPlus_356!

RFT!

 

AppendReplace

enumeration (optional)

Append!

Replace!


DocSumSet

Purpose

Modify the data of the specified document summary field. Repeat both parameters for each field of the summary. Enclose repeating parameters in braces ({}).

Syntax

DocSumSet ({DocSumFieldName: enumeration; DocSumFieldData: string; })

Parameters

DocSumFieldName

enumeration (optional) The fields to modify.

Abstract!

Keywords!

Account!

Language!

Address!

MailStop!

Attachments!

Matter!

Author!

Office!

Authorization!

Owner!

BillTo!

Project!

BlindCopy!

Publisher!

CarbonCopy!

Purpose!

Category!

ReceivedFrom!

CheckedBy!

RecordedBy!

Client!

RecordedDate!

Comments!

Reference!

CreationDate!

RevisionNotes!

DateCompleted!

RevisionNumber!

Department!

Section!

DescriptiveName!

Security!

DescriptiveType!

Source!

Destination!

Status!

Disposition!

Subject!

Division!

TelephoneNumber!

DocumentNumber!

Typist!

Editor!

VersionDate!

ForwardTo!

VersionNotes!

Group!

VersionNumber!

DocSumFieldData

string (optional) The data for a document summary field. If CreationDate!, DateCompleted!, RecordedDate!, RevisionDate!, or VersionDate! is specified in the DocSumFieldName parameter, the date must be entered in the sequence of Year, Month, Day. For example: “1994, 9, 14". If the date format is incorrect, the specified date field is not updated.


DotLeader

Purpose

Specify the ASCII number of a dot leader character, and the number of spaces between each character.

Syntax

DotLeader (Character: string; SpaceCount: numeric)

Parameters

Character

string The ASCII number of a dot leader character.

SpaceCount

numeric The number of spaces between the visible dot leader characters.

See Also

?DotLeader


DoubleSidedPrint

Purpose

Turn double-sided printing (Duplex) on or off, and specify a binding edge. This command inserts a code in the document at the beginning of the current page.

Syntax

DoubleSidedPrint (Flags: enumeration)

Parameters

Flags

enumeration

LongEdge!

None!

ShortEdge!

See Also

Binding, PrintTwoSided, PrintTwoSidedDocCodesDlg, PrintUseTwoSidedDocCodes


DoubleSmartQuote

Purpose

Turn Double SmartQuotes on or off and specify a quote character.

Syntax

DoubleSmartQuote (State: enumeration; OpenDoubleQuote: numeric; CloseDoubleQuote: numeric)

Parameters

State

enumeration (optional)

Off!

On!

OpenDoubleQuote

numeric (optional) The numeric equivalent of the quote character.

CloseDoubleQuote

numeric (optional) The numeric equivalent of the quote character.

See Also

SingleSmartQuote, UseRegQuotesWithNumbers


DraftZoom100

Purpose

Display Draft view with screen text and graphics at 100%. Draft view does not display headers, footers, or other substructures.

Syntax

DraftZoom100 ()

See Also

DraftZoomMargin


DraftZoomMargin

Purpose

Display Draft view with screen text and graphics reaching the margins. Draft view does not display headers, footers, and other substructures.

Syntax

DraftZoomMargin ()

See Also

DraftZoom100


DropCapAdjustDlg

Purpose

Display the Drop Cap Options dialog box.

Syntax

DropCapAdjustDlg ()


DropCapBegin

Purpose

Begin a drop cap. Follow with drop cap editing commands and DropCapEnd.

Syntax

DropCapBegin ()


DropCapBorderFillDlg

Purpose

Display the Drop Cap Border/Fill dialog box.

Syntax

DropCapBorderFillDlg ()

See Also

DropCapBorderStyle, DropCapFillStyle


DropCapBorderStyle

Purpose

Specify a drop cap border style. Use with DropCapBegin and DropCapEnd.

Syntax

DropCapBorderStyle (BorderStyleName: any)

Parameters

BorderStyleName

any Enclose custom styles in quotation marks.

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

See Also

DropCapBegin, DropCapBorderFillDlg, DropCapEnd


DropCapCharacters

Purpose

Specify the number of characters in a drop cap.

Syntax

DropCapCharacters (Number: numeric)

Parameters

Number

numeric

See Also

DropCapCharacterSize


DropCapCharacterSize

Purpose

Specify the size of a drop cap character(s).

Syntax

DropCapCharacterSize (Size: numeric)

Parameters

Size

numeric

See Also

DropCapCharacters


DropCapContourWrap

Purpose

Wrap text around a drop cap.

Syntax

DropCapContourWrap (State: any)

Parameters

State

any

No!

Yes!


DropCapControlBar

Purpose

Display the Drop Cap feature bar.

Syntax

DropCapControlBar ()


DropCapEnd

Purpose

End a drop cap and save the changes. Precede with DropCapBegin and drop cap editing commands.

Syntax

DropCapEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!


DropCapFillStyle

Purpose

Specify a drop cap fill style.

Syntax

DropCapFillStyle (FillStyleName: any)

Parameters

FillStyleName

any Enclose custom styles in quotation marks.

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

DropCapBorderFillDlg


DropCapFontDlg

Purpose

Display the Drop Cap Font dialog box.

Syntax

DropCapFontDlg ()


DropCapHorizontalAdjustment

Purpose

Specify the percentage of a drop cap that is located in the margin.

Syntax

DropCapHorizontalAdjustment (Adjustment: numeric)

Parameters

Adjustment

numeric Percent.

See Also

DropCapVerticalAdjustment


DropCapIncludeDescender

Purpose

Allow descending characters in a drop cap.

Syntax

DropCapIncludeDescender (State: any)

Parameters

State

any

No!

Yes!

See Also

DropCapIncludeDiacritic


DropCapIncludeDiacritic

Purpose

Include diacritic marks in a drop cap.

Syntax

DropCapIncludeDiacritic (State: enumeration)

Parameters

State

enumeration

No!

Yes!


DropCapKerning

Purpose

Specify the spacing between drop cap characters.

Syntax

DropCapKerning (Adjustment: measurement)

Parameters

Adjustment

measurement


DropCapNoWrap

Purpose

Prevent text from wrapping around a drop cap.

Syntax

DropCapNoWrap (State: any)

Parameters

State

any

No!

Yes!


DropCapOff

Purpose

End the drop cap of the current paragraph.

Syntax

DropCapOff ()


DropCapPositionOtherDlg

Purpose

Display the Drop Cap Position dialog box.

Syntax

DropCapPositionOtherDlg ()


DropCapSizeDlg

Purpose

Display the Drop Cap Size dialog box.

Syntax

DropCapSizeDlg ()


DropCapVerticalAdjustment

Purpose

Specify the number of blank lines between a drop cap and the text that follows it.

Syntax

DropCapVerticalAdjustment (Adjustment: numeric)

Parameters

Adjustment

numeric

See Also

DropCapHorizontalAdjustment


EditBoxDlg

Purpose

Display the Edit Box dialog box.

Syntax

EditBoxDlg ()

See Also

GraphicEditBox


EditBoxDlgClose

Purpose

Close the Edit Box dialog box.

Syntax

EditBoxDlgClose ()

See Also

GraphicEditBox


EditComment

Purpose

Display the Comment feature bar.

Syntax

EditComment ()


EditCopy

Purpose

Replace the Clipboard contents with the selected text or graphic.

Syntax

EditCopy ()


EditCut

Purpose

Replace the Clipboard contents with the selected text or graphic and delete the selection from the current document.

Syntax

EditCut ()


EditPaste

Purpose

Paste the Clipboard contents into the current document at the insertion point.

Syntax

EditPaste (ClipboardFormat: string; FormatId: numeric; LinkType: enumeration)

Parameters

ClipboardFormat

string (optional) The registered Clipboard format. If the information you wish to paste is in a registered Clipboard format, this parameter is required and the FormatId parameter is ignored. Several different formats are supported. The options displayed in the Paste Special dialog box will depend on the contents in the Clipboard.

FormatId

numeric (optional) The predefined Clipboard format ID number. If the information you wish to paste is in a Clipboard predefined format, this parameter is required and the ClipboardFormat parameter is ignored. Predefined Clipboard format ID numbers include:

5 = ANSI text.

6 = Old IBM PC character set.

7 = Device Independent Bitmap (DIB).

8 = Bitmap.

9 = Metafilepict.

LinkType

enumeration (optional)

DDE!

OLE!


EditPasteSimple

Purpose

Paste the Clipboard contents without text attributes (unless beginning and ending attribute codes are included in the pasted selection).

Syntax

EditPasteSimple ()


EndCenterOrAlignment

Purpose

Insert a [END Cntr/Align] code, which turns off Center, Flush Right, and alignment tabs at the insertion point for the current line only.

Syntax

EndCenterOrAlignment ()


EndnoteCreate

Purpose

Open a new endnote window, in order to create an endnote. Follow with commands that insert text and codes. End with SubstructureExit.

Syntax

EndnoteCreate ()

See Also

Close


EndnoteEdit

Purpose

Open a specific endnote window, in order to edit the endnote.

Syntax

EndnoteEdit (EndnoteNumber: string)

Parameters

EndnoteNumber

string (optional) Letters, arabic numbers, or roman numerals.

See Also

Close, EndnoteEditDlg


EndnoteEditDlg

Purpose

Display the Edit Endnote dialog box.

Syntax

EndnoteEditDlg ()

See Also

EndnoteEdit


EndnoteFootnoteConvert

Purpose

Convert footnotes to endnotes or endnotes to footnotes in the current document.

Syntax

EndnoteFootnoteConvert (Action: enumeration)

Parameters

Action

enumeration

EndnoteToFootnote!

FootnoteToEndnote!


EndnoteFootnoteNext

Purpose

Go to the next endnote/footnote.

Syntax

EndnoteFootnoteNext ()


EndnoteFootnotePrev

Purpose

Go to the previous endnote/footnote.

Syntax

EndnoteFootnotePrev ()


EndnoteMinimum

Purpose

Specify the amount of endnote text to keep together.

Syntax

EndnoteMinimum (Size: measurement)

Parameters

Size

measurement If less than 1, precede the decimal with 0. Default: 0.5".

See Also

EndnoteOptionsDlg


EndnoteNewNumber

Purpose

Insert an [Endnote Num Set] code to begin new numbering for subsequent endnotes.

Syntax

EndnoteNewNumber (EndnoteNumber: string)

Parameters

EndnoteNumber

string The new starting number or character.


EndnoteNumberDecrement

Purpose

Decrease the current endnote number by one.

Syntax

EndnoteNumberDecrement ()

See Also

EndnoteNewNumber


EndnoteNumberDisplay

Purpose

Display the current endnote number.

Syntax

EndnoteNumberDisplay ()

See Also

EndnoteNewNumber


EndnoteNumberIncrement

Purpose

Increase the current endnote number by one.

Syntax

EndnoteNumberIncrement ()

See Also

EndnoteNewNumber


EndnoteNumberMethod

Purpose

Specify an endnote numbering method.

Syntax

EndnoteNumberMethod (NumberingMethod: enumeration; Characters: string)

Parameters

NumberingMethod

enumeration

Characters!

Numbers!

LowerLetters!

UpperLetters!

LowerRoman!

UpperRoman!

Characters

string (optional) Use when the first parameter is Characters!.

See Also

EndnoteNewNumber


EndnoteOptions

Purpose

Specify endnote options beginning at the insertion point.

Syntax

EndnoteOptions (NumberingMethod: enumeration; Characters: string; BetweenSpacing: measurement; MinimumHeight: measurement)

Parameters

NumberingMethod

enumeration (optional)

Characters!

Numbers!

LowerLetters!

UpperLetters!

LowerRoman!

UpperRoman!

Characters

string (optional) Use up to five characters when the numbering method is Characters!.

BetweenSpacing

measurement (optional) The space between endnotes.

MinimumHeight

measurement (optional) How much of an endnote to keep together on a page.

See Also

EndnoteOptionsDlg


EndnoteOptionsDlg

Purpose

Display the Endnote Options dialog box.

Syntax

EndnoteOptionsDlg ()

See Also

EndnoteOptions


EndnotePlacement

Purpose

Mark where to generate an endnote list, and specify whether to reset numbering for subsequent endnotes. This command applies to endnotes before the Endnote Placement code, or after the last Endnote Placement code.

Syntax

EndnotePlacement (Restart: enumeration)

Parameters

Restart

enumeration (optional)

No!

Yes!

See Also

EndnotePlacementDlg


EndnotePlacementDlg

Purpose

Display the Endnote Placement dialog box.

Syntax

EndnotePlacementDlg ()

See Also

EndnotePlacement


EndnoteSetNumberDlg

Purpose

Display the Endnote Number dialog box.

Syntax

EndnoteSetNumberDlg ()


EndnotesSpaceBetween

Purpose

Specify the distance between endnotes.

Syntax

EndnotesSpaceBetween (Width: measurement)

Parameters

Width

measurement

See Also

EndnoteOptions


EndnoteToFootnoteShippingMacro

Purpose

Play the shipping macro ENDFOOT.WCM to convert endnotes to footnotes in the current document or selected text. ENDFOOT.WCM must already be installed.

Syntax

EndnoteToFootnoteShippingMacro ()

See Also

FootnoteToEndnoteShippingMacro, EndnoteFootnoteConvert


EndOfSentenceSpacing

Purpose

Specify the number of spaces at the end of a sentence.

Syntax

EndOfSentenceSpacing (Type: enumeration)

Parameters

Type

enumeration

DoubleToSingle!

None!

SingleToDouble!

See Also

?EndOfSentenceSpacing


EnterKey

Purpose

Perform an Enter function.

Syntax

EnterKey ()


EnvelopeDlg

Purpose

Display the Envelope dialog box.

Syntax

EnvelopeDlg ()


EquationBaseFontDlg

Purpose

Display the Equation Font dialog box.

Syntax

EquationBaseFontDlg ()


EquationCreate

Purpose

Create an equation box and open the Equation Editor.

Syntax

EquationCreate ()

See Also

Close


EquationPalette

Purpose

Display the Equation Palette in the Equation Editor.

Syntax

EquationPalette (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

EquationPaletteToggle


EquationPaletteToggle

Purpose

Toggle the Equation Editor palette on and off.

Syntax

EquationPaletteToggle ()

See Also

EquationPalette


EquationRetrieveDlg

Purpose

Display the Retrieve Equation Text dialog box.

Syntax

EquationRetrieveDlg ()


EquationZoomDlg

Purpose

Display the Zoom Equation Display dialog box.

Syntax

EquationZoomDlg ()


ExecScrapBook

Purpose

Run the Scrapbook program. You can then drag images from the Scrapbook and drop them into your document.

Syntax

ExecScrapBook ()


ExitWordPerfect

Purpose

Exit Corel WordPerfect.

Syntax

ExitWordPerfect ()


ExpandAllAbbrevShippingMacro

Purpose

Play the shipping macro EXPNDALL.WCM to expand all abbreviations in the current document. EXPNDALL.WCM must be installed.

Syntax

ExpandAllAbbrevShippingMacro ()

See Also

AbbreviationExpand


ExpandDlg

Purpose

Display the Expand Master Document dialog box.

Syntax

ExpandDlg ()


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)

AmiPro_12!

OfficeWriter_62!

AmiPro_12A!

P1EXE!

AmiPro_12B!

RFT!

AmiPro_20!

RTF!

AmiPro_30!

RTFJ!

ANSIDelimitedTextWindows!

SGML!

ANSIGenericWordProcessor_Windo!

WaiSing_251!

ANSIText_Windows!

WindowsWrite!

AreAHangol!

WordForWindows_10!

Aruga_23!

WordForWindows_11!

ASCIIStandard!

WordForWindows_12!

ASCIIStripped!

WordForWindows_1A!

DelimitedText!

WordForWindows_20!

DisplayWrite_40!

WordForWindows_20a!

DisplayWrite_42!

WordForWindows_20b!

DisplayWrite_50!

WordForWindows_20c!

Excel_40!

WordForWindows_50!

FFT!

WordForWindows_60!

Hana!

WordPerfect_42!

HTML!

WordPerfect_50!

Ichitaro_3x!

WordPerfect_51!

Ichitaro_4x!

WordPerfect_5xA!

Ichitaro_5x!

WordPerfect_60!

Kermit_7bit_Transfer!

WordPerfect_7!

Matu_4!

WordStar_33!

Matu_5!

WordStar_331!

Matu_6!

WordStar_34!

MicroSoftWord_40!

WordStar_40!

MicroSoftWord_50!

WordStar_50!

MicroSoftWord_55!

WordStar_55!

MultiMate_33!

WordStar_60!

MultiMate_40!

WordStar2000_10!

MultiMateAdvantage_36!

WordStar2000_20!

MultiMateAdvantageII_10!

WordStar2000_30!

NavyDIF!

WPS_Chinese!

OfficeWriter_60!

XyWriteIIIPlus_355!

OfficeWriter_61!

XyWriteIIIPlus_356!

OfficeWriter_611!

 

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)

AmiPro_12!

OfficeWriter_611!

AmiPro_12A!

OfficeWriter_62!

AmiPro_12B!

P1EXE!

AmiPro_20!

RFT!

AmiPro_30!

RTF!

ANSIDelimitedTextWindows!

RTFJ!

ANSIGeneratedWordProcessor_Win!

SGML!

ANSIText_Windows!

WaiSing_251!

AreAHangol!

WindowsWrite!

Aruga_23!

WordForWindows_10!

ASCIIStandard!

WordForWindows_11!

ASCIIStripped!

WordForWindows_12!

DelimitedText!

WordForWindows_1A!

DisplayWrite_40!

WordForWindows_20!

DisplayWrite_42!

WordForWindows_20a!

DisplayWrite_50!

WordForWindows_20b!

EDGAR!

WordForWindows_20c!

Excel_40!

WordForWindows_50!

FFT!

WordForWindows_60!

Hana!

WordPerfect_42!

HTML!

WordPerfect_50!

Ichitaro_3x!

WordPerfect_51!

Ichitaro_4x!

WordPerfect_5xA!

Ichitaro_5x!

WordPerfect_60!

Kermit_7bit_Transfer!

WordPerfect_7!

Matu_4!

WordStar_33!

Matu_5!

WordStar_331!

Matu_6!

WordStar_34!

MicroSoftWord_40!

WordStar_40!

MicroSoftWord_50!

WordStar_50!

MicroSoftWord_55!

WordStar_55!

MultiMate_33!

WordStar_60!

MultiMate_40!

WordStar2000_10!

MultiMateAdvantage_36!

WordStar2000_20!

MultiMateAdvantageII_10!

WordStar2000_30!

NavyDIF!

WPS_Chinese!

OfficeWriter_60!

XyWriteIIIPlus_355!

OfficeWriter_61!

XyWriteIIIPlus_356!

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.

WPG2_12Gray!

WPG2_Honeycomb!

WPG2_25Gray!

WPG2_Lines1!

WPG2_50Gray!

WPG2_Lines2!

WPG2_Arch!

WPG2_Lines3!

WPG2_Balls!

WPG2_Lines4!

WPG2_Bricks1!

WPG2_Lines5!

WPG2_Bricks2!

WPG2_Lines6!

WPG2_Chainlink!

WPG2_Lines7!

WPG2_Checkboard1!

WPG2_Lines8!

WPG2_Checkboard2!

WPG2_Mesh!

WPG2_Crosses!

WPG2_Patio!

WPG2_Crosshatch1!

WPG2_Plaid!

WPG2_Crosshatch2!

WPG2_Solid!

WPG2_Crosshatch3!

WPG2_Triangles!

WPG2_Crosshatch4!

WPG2_Waves!

WPG2_Fishscale!

WPG2_Weave!

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

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

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

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

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

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

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

2 3/5/93

8 March 5, 1993 (4:18pm)

3 Mar 5, 1993

9 1993-03-05

4 5 March 1993

10 3/05

5 Friday, March 5, 1993

11 Mar 05

6 4:18 pm

12 04:18:53 (hh:mm:ss)

7 05Mar93

 

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat


FloatingCellNumberDecDigits

Purpose

Specify the number of digits after the decimal point in a floating cell. The insertion point must be between floating cell codes (Flt Cell).

Syntax

FloatingCellNumberDecDigits (Number: numeric)

Parameters

Number

numeric

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat, FloatingCellNumberRound


FloatingCellNumberFormat

Purpose

Specify a number type for floating cells.

Syntax

FloatingCellNumberFormat (CellNumType: enumeration)

Parameters

CellNumType

enumeration

Accounting!

General!

Commas!

Integer!

Currency!

Percent!

DateFormat!

Scientific!

Fixed2!

TextOnly!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberDecDigits, FloatingCellNumberNegNumber, FloatingCellNumberRound, FloatingCellNumberUseCurrency, FloatingCellNumberUseCommas, FloatingCellNumSelectCurrency


FloatingCellNumberNegNumber

Purpose

Specify how to display negative numbers in a floating cell.

Syntax

FloatingCellNumberNegNumber (NegDisplay: enumeration)

Parameters

NegDisplay

enumeration

CRDR!

Minus!

Parentheses!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat


FloatingCellNumberRound

Purpose

Round numbers for calculation in a floating cell.

Syntax

FloatingCellNumberRound (Round: enumeration)

Parameters

Round

enumeration

No!

Yes!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberDecDigits, FloatingCellNumberFormat


FloatingCellNumberUseCommas

Purpose

Use commas in floating cell numbers.

Syntax

FloatingCellNumberUseCommas (Commas: enumeration)

Parameters

Commas

enumeration

No!

Yes!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumberFormat


FloatingCellNumberUseCurrency

Purpose

Use currency symbols in a floating cell.

Syntax

FloatingCellNumberUseCurrency (Currency: enumeration)

Parameters

Currency

enumeration

No!

Yes!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumAlignCurrency, FloatingCellNumberFormat, FloatingCellNumSelectCurrency


FloatingCellNumSelectCurrency

Purpose

Specify a currency symbol for floating cells.

Syntax

FloatingCellNumSelectCurrency (IntlCurrency: enumeration)

Parameters

IntlCurrency

enumeration

Austria!

Israel!

Belgium!

Italy!

BelgiumFrench!

Japan!

Brazil!

Korea!

Canada!

Netherlands!

China!

Norway!

Croatia!

NorwayIntl!

CzechRepublic!

Paraguay!

DefaultCurrency!

Peseta!

Denmark!

Peso!

Dollar!

Poland!

Ecuador!

Portugal!

ElSalvador!

Ruble!

Finland!

RussianRuble!

FinlandIntl!

Singapore!

France!

SlovakRepublic!

FrenchCanada!

Slovenia!

Germany!

SouthAfrica!

Greece!

Sweden!

Guatemala!

Switzerland!

Honduras!

Taiwan!

HongKong!

Turkey!

Hungary!

UnitedKingdom!

Iceland!

Venezuela!

See Also

FloatingCellCreate, FloatingCellEdit, FloatingCellNumAlignCurrency, FloatingCellNumberFormat, FloatingCellNumberUseCurrency


FlushRight

Purpose

Align text at the right margin.

Syntax

FlushRight ()

See Also

FlushRightWithDotLeaders


FlushRightWithDotLeaders

Purpose

Right justify a line of text with dot leaders.

Syntax

FlushRightWithDotLeaders ()

See Also

FlushRight


Font

Purpose

Specify font options.

Syntax

Font (Name: string; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)

Parameters

Name

string

Family

enumeration (optional)

FamilyAestheticOrnamented!

FamilyITCZapfDingbats!

FamilyAlbertus!

FamilyLetterGothic!

FamilyBodon!

FamilyMadrone!

FamilyBroadway!

FamilyMicrostyle!

FamilyBrush!

FamilyOldEnglish!

FamilyCenturySchoolbook!

FamilyOptima!

FamilyComputer!

FamilyParkAvenue!

FamilyCourier!

FamilyPonderosa!

FamilyHelvetica!

FamilyPTBarnum!

FamilyHobo!

FamilyRevue!

FamilyITCBenguiat!

FamilySignetRoundhand!

FamilyITCGaramond!

FamilyTekton!

FamilyITCLubalinGraph!

FamilyTimesRoman!

FamilyITCRonda!

FamilyUncial!

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchNormal!

FontMatchOutline!

FontMatchShadow!

FontMatchSmallCaps!

Weight

enumeration (optional)

WeightBlack!

WeightMaximum!

WeightBold!

WeightMedium!

WeightBook!

WeightRegular!

WeightDemiBold!

WeightRoman!

WeightDemiLight!

WeightSemiBold!

WeightExtraBlack!

WeightSemiLight!

WeightExtraBold!

WeightThin!

WeightExtraHeavy!

WeightUltraBlack!

WeightExtraLight!

WeightUltraHeavy!

WeightExtraThin!

WeightUltraLight!

WeightHeavy!

WeightUltraThin!

WeightLight!

WeightUnknown!

Width

enumeration (optional)

WidthCompressed!

WidthSemiCondensed!

WidthCondensed!

WidthSemiExpanded!

WidthDoubleWide!

WidthTripleWide!

WidthExpanded!

WidthUltraCompressed!

WidthExtraCondensed!

WidthUltraCondensed!

WidthExtraExpanded!

WidthUltraExpanded!

WidthNormal!

WidthUnknown!

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

TrueType!

Speedo!

Type1!

CharacterSet

enumeration (optional)

FontMatchArabic!

FontMatchJapaneseKana!

FontMatchArabicScript!

FontMatchMath!

FontMatchASCII!

FontMatchMathExtension!

FontMatchBoxDrawing!

FontMatchMultinational1!

FontMatchCyrillic!

FontMatchMultinational2!

FontMatchGreek!

FontMatchTypographicSymbols!

FontMatchHebrew!

FontMatchUserDefined!

FontMatchIconicSymbols!

 

See Also

QuickFontEx


FontDlg

Purpose

Display the Font dialog box.

Syntax

FontDlg ()

See Also

Font


FontDnShippingMacro

Purpose

Play the shipping macro FONTDN.WCM to reduce the font size of the selected text by two points. FONTDN.WCM must be installed.

Syntax

FontDnShippingMacro ()


FontDoubleUnderlineToggle

Purpose

Toggle Double Underline at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontDoubleUnderlineToggle ()

See Also

AttributeAppearanceToggle


FontExtraLargeToggle

Purpose

Toggle Extra Large at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.

Syntax

FontExtraLargeToggle ()

See Also

AttributeRelativeSizeToggle


FontFineToggle

Purpose

Toggle Fine at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.

Syntax

FontFineToggle ()

See Also

AttributeRelativeSizeToggle


FontHiddenToggle

Purpose

Toggle Hidden at the insertion point.

Syntax

FontHiddenToggle ()

See Also

AttributeAppearanceToggle


FontItalicToggle

Purpose

Toggle Italic at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontItalicToggle ()

See Also

AttributeAppearanceToggle


FontLargeToggle

Purpose

Toggle Large at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.

Syntax

FontLargeToggle ()

See Also

AttributeRelativeSizeToggle


FontOutlineToggle

Purpose

Toggle the Outline font attribute at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontOutlineToggle ()

See Also

AttributeAppearanceToggle


FontRedlineToggle

Purpose

Toggle Redline at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontRedlineToggle ()

See Also

AttributeAppearanceToggle


FontShadowToggle

Purpose

Toggle Shadow at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontShadowToggle ()

See Also

AttributeAppearanceToggle


FontSize

Purpose

Specify the size of a selected font at the insertion point.

Syntax

FontSize (FontSize: measurement)

Parameters

FontSize

measurement

See Also

Font


FontSmallCapsToggle

Purpose

Toggle Small Caps at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontSmallCapsToggle ()

See Also

AttributeAppearanceToggle


FontSmallToggle

Purpose

Toggle Small at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.

Syntax

FontSmallToggle ()

See Also

AttributeRelativeSizeToggle


FontStrikeoutToggle

Purpose

Toggle Strikeout at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontStrikeoutToggle ()

See Also

AttributeAppearanceToggle


FontSubscriptToggle

Purpose

Toggle Subscript at the insertion point. Recordable substitute: AttributePositionToggle.

Syntax

FontSubscriptToggle ()

See Also

AttributePositionToggle


FontSuperscriptToggle

Purpose

Toggle Superscript at the insertion point. Recordable substitute: AttributePositionToggle.

Syntax

FontSuperscriptToggle ()

See Also

AttributePositionToggle


FontUnderlineToggle

Purpose

Toggle Underline at the insertion point. Recordable substitute: AttributeAppearanceToggle.

Syntax

FontUnderlineToggle ()

See Also

AttributeAppearanceToggle


FontUpShippingMacro

Purpose

Play the shipping macro FONTUP.WCM to increase the font size of the selected text by two points. FONTUP.WCM must be installed.

Syntax

FontUpShippingMacro ()


FontVeryLargeToggle

Purpose

Toggle Very Large at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.

Syntax

FontVeryLargeToggle ()

See Also

AttributeRelativeSizeToggle


FooterA

Purpose

Create, edit, or discontinue Footer A, and specify footer position.

Syntax

FooterA (Action: enumeration; Occurrence: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional)

AllPages!

EvenPages!

NoPages!

OddPages!

See Also

?FooterAOccur, NewHFWOccurrence


FooterB

Purpose

Create, edit, or discontinue Footer B, and specify footer position.

Syntax

FooterB (Action: enumeration; Occurrence: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional)

AllPages!

EvenPages!

NoPages!

OddPages!

See Also

?FooterBOccur, NewHFWOccurrence


FooterSeparationDistance

Purpose

Specify the distance between text and footers.

Syntax

FooterSeparationDistance (Distance: measurement)

Parameters

Distance

measurement Default: .167".


FootnoteContinuedMessage

Purpose

Print “(continued...)” when a footnote continues on the next page.

Syntax

FootnoteContinuedMessage (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

FootnoteOptionsDlg


FootnoteCreate

Purpose

Open a footnote window, in order to create a footnote. Subsequent commands insert text and codes. SubstructureExit closes the window and places a reference to the footnote at the insertion point.

Syntax

FootnoteCreate ()

See Also

Close


FootnoteEdit

Purpose

Open a specified footnote window in order to edit the footnote. Subsequent commands apply to the footnote window until SubstructureExit.

Syntax

FootnoteEdit (FootnoteNumber: string)

Parameters

FootnoteNumber

string (optional) Footnotes can be numbered with arabic numerals, roman numerals, or letters.

See Also

Close, FootnoteEditDlg


FootnoteEditDlg

Purpose

Display the Edit Footnote dialog box.

Syntax

FootnoteEditDlg ()

See Also

FootnoteEdit


FootnoteEndnoteDlg

Purpose

Display the Footnote/Endnote dialog box.

Syntax

FootnoteEndnoteDlg ()


FootnoteMinimum

Purpose

Specify the amount of footnote text to keep together on a page.

Syntax

FootnoteMinimum (Width: measurement)

Parameters

Width

measurement

See Also

FootnoteOptions


FootnoteNewNumber

Purpose

Specify a new footnote number and increment subsequent footnotes from that number.

Syntax

FootnoteNewNumber (FootnoteNumber: string)

Parameters

FootnoteNumber

string

See Also

FootnoteNewNumberDlg


FootnoteNewNumberDlg

Purpose

Display the Footnote Number dialog box.

Syntax

FootnoteNewNumberDlg ()


FootnoteNumberDecrement

Purpose

Decrease the last footnote number by one.

Syntax

FootnoteNumberDecrement ()

See Also

FootnoteNumberIncrement


FootnoteNumberDisplay

Purpose

Insert the current footnote number at the insertion point.

Syntax

FootnoteNumberDisplay ()

See Also

FootnoteNewNumber


FootnoteNumberIncrement

Purpose

Increase the last footnote number by one.

Syntax

FootnoteNumberIncrement ()

See Also

FootnoteNumberDecrement


FootnoteNumberMethod

Purpose

Specify a footnote numbering method. Recordable substitute: FootnoteOptions.

Syntax

FootnoteNumberMethod (NumberingMethod: enumeration; Character: string)

Parameters

NumberingMethod

enumeration

Characters!

Numbers!

LowerLetters!

UpperLetters!

LowerRoman!

UpperRoman!

Character

string (optional) Use up to five characters when the numbering method is Characters!.


FootnoteOptions

Purpose

Specify the footnote options from the insertion point forward.

Syntax

FootnoteOptions (NumberingMethod: enumeration; Characters: string; BetweenSpacing: measurement; MinimumHeight: measurement; Restart: enumeration; PrintContinued: enumeration; FootnotePosition: enumeration; Separator: enumeration)

Parameters

NumberingMethod

enumeration (optional)

Characters!

Numbers!

LowerLetters!

UpperLetters!

LowerRoman!

UpperRoman!

Characters

string (optional) Use up to five characters when the numbering method is Characters!.

BetweenSpacing

measurement (optional)

MinimumHeight

measurement (optional) How much of a footnote to keep together on a page.

Restart

enumeration (optional) Restart the footnote numbers on every page.

Off!

On!

PrintContinued

enumeration (optional) Print “(continued)...” on the last footnote line of the first page and “...(continued)” on the first footnote line of the next page.

No!

Yes!

FootnotePosition

enumeration (optional)

AfterText!

BottomOfPage!

Separator

enumeration (optional)

MarginToMargin!

NoLine!

ShortLine!

See Also

FootnoteOptionsDlg


FootnoteOptionsDlg

Purpose

Display the Advanced Footnote Options dialog box.

Syntax

FootnoteOptionsDlg ()

See Also

FootnoteOptions


FootnotePosition

Purpose

Print footnotes at the bottom of the page or just below the last line of text. Recordable substitute: FootnoteOptions.

Syntax

FootnotePosition (Position: enumeration)

Parameters

Position

enumeration

AfterText!

BottomOfPage!


FootnoteRestartEachPage

Purpose

Restart the footnote numbering on each page. Recordable substitute: FootnoteOptions.

Syntax

FootnoteRestartEachPage (State: enumeration)

Parameters

State

enumeration

No!

Yes!


FootnoteSeparatorLine

Purpose

Specify a separator line between text and footnotes.

Syntax

FootnoteSeparatorLine (Style: any; SpaceAboveLine: measurement; SpaceBelowLine: measurement; Alignment: enumeration; Width: measurement; Position: measurement)

Parameters

Style

any

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

SpaceAboveLine

measurement The space between the separator line and the last line of text.

SpaceBelowLine

measurement The space between the separator line and the first footnote.

Alignment

enumeration

Center!

Full!

Left!

Right!

SetPosition!

Width

measurement (optional) The separator line width.

Position

measurement (optional) The distance of a separator line from the left edge of the page.

See Also

FootnoteOptionsDlg


FootnoteSpaceBetween

Purpose

Specify the amount of blank space between footnotes.

Syntax

FootnoteSpaceBetween (Space: measurement)

Parameters

Space

measurement Default: .167".

See Also

FootnoteOptionsDlg


FootnoteToEndnoteShippingMacro

Purpose

Play the shipping macro FOOTEND.WCM, which converts footnotes to endnotes in the current document or selected text. FOOTEND.WCM must be installed.

Syntax

FootnoteToEndnoteShippingMacro ()

See Also

EndnoteToFootnoteShippingMacro, EndnoteFootnoteConvert


ForcePage

Purpose

Force a page break or specify that a certain page always has an odd or even number.

Syntax

ForcePage (EvenOddNew: enumeration)

Parameters

EvenOddNew

enumeration

Even!

New!

Odd!


ForcePageDlg

Purpose

Display the Force Page dialog box.

Syntax

ForcePageDlg ()


FormatMarginsDlg

Purpose

Display the Margins dialog box.

Syntax

FormatMarginsDlg ()


GenerateDlg

Purpose

Display the Generate dialog box.

Syntax

GenerateDlg ()


GenerateDoc

Purpose

Generate indexes, tables of contents, lists, cross references, tables of authorities, and master documents.

Syntax

GenerateDoc (SaveSubDocs: enumeration; UndoAction: enumeration; Hypertext: enumeration)

Parameters

SaveSubDocs

enumeration (optional) Save the subdocuments in a master document. Required only to generate a master document.

DontSave!

Save!

UndoAction

enumeration (optional) Required only to generate a master document.

NoUndo!

Undo!

Hypertext

enumeration (optional)

CreateHypertext!

See Also

GenerateDlg


GetAcceleratorText

Purpose

Assign the accelerator text of a macro command to a variable. When a command is mapped to a keystroke, the accelerator text represents the keystroke.

Syntax

GetAcceleratorText (Variable: variable; Token: command name)

Parameters

Variable

variable

Token

command name

See Also

GetData


GetData

Purpose

Assign information to a variable about the state of Corel WordPerfect or a Corel WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions.

Syntax

GetData (Variable: variable; Group: enumeration; Item: enumeration; Template: enumeration; ItemNum: any)

Parameters

Variable

variable

Group

enumeration The group a variable belongs to. Summary! extracts data from the document summary by order of entry. SummaryTag! extracts data from the document summary by field tab number.

Abbreviation!

QuickWords!

Bookmark!

ReplaceString!

Font!

Styles!

ODMA!

Summary!

OutlineStyles!

SummaryTag!

PaperSize!

Table!

Printer!

TableNames!

Item

enumeration The item type. For example, Count! returns the number of available fields in the document summary. Name!, Data!, Type!, and Tag! return information from the document summary field specified by the ItemNum parameter.

Author!

Name!

ContentFormat!

Port!

Count!

Tag!

Data!

TitleText!

DMSDefined!

Type!

DMSInfo!

Width!

Length!

 

Template

enumeration The location of specified items.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

ItemNum

any (optional) The item number from which the Item parameter gets information. For example, ItemNum can specify a particular document summary field.

Abstract!

Language!

Account!

MailStop!

Address!

Matter!

Attachments!

Office!

Author!

Owner!

Authorization!

Project!

BillTo!

Publisher!

BlindCopy!

Purpose!

CarbonCopy!

ReceivedFrom!

Category!

RecordedBy!

CheckedBy!

RecordedDate!

Client!

Reference!

Comments!

RevisionDate!

CreationDate!

RevisionNotes!

DateCompleted!

RevisionNumber!

Department!

Section!

DescriptiveName!

Security!

DescriptiveType!

Source!

Destination!

Status!

Disposition!

Subject!

Division!

TelephoneNumber!

DocumentNumber!

Typist!

Editor!

VersionDate!

ForwardTo!

VersionNotes!

Group!

VersionNumber!

Keywords!

 

GotoDosShippingMacro

Purpose

Play the shipping macro GOTODOS.WCM to switch to DOS. GOTODOS.WCM must be installed.

Syntax

GotoDosShippingMacro ()


GoToQuickmarkOnOpen

Purpose

Return a value indicating whether Go to Quickmark on file open is selected in the Bookmark dialog box.

Syntax

boolean := GoToQuickmarkOnOpen ()


GraphicBoxStyleDlg

Purpose

Display the Box Style dialog box.

Syntax

GraphicBoxStyleDlg ()


GraphicCreateBox

Purpose

Display the Insert Image dialog box.

Syntax

GraphicCreateBox (BoxStyleName: any)

Parameters

BoxStyleName

any (optional)

See Also

GraphicEditBox


GraphicCreateChart

Purpose

Create a chart with Corel Presentations.

Syntax

GraphicCreateChart ()


GraphicCreateTextArt

Purpose

Start TextArt to create a TextArt image. TextArt allows you to add special effects to text.

Syntax

GraphicCreateTextArt ()


GraphicCustomMenuDlg

Purpose

Display the Edit Graphics Menu dialog box.

Syntax

GraphicCustomMenuDlg ()


GraphicEditBox

Purpose

Display the Edit Box dialog box. If the current document contains more than one graphics box and none of them are selected, the Select Box to Edit dialog box displays. Also, if the current document does not contain a graphics box, an invalid function error is returned.

Syntax

GraphicEditBox (BoxNumber: numeric)

Parameters

BoxNumber

numeric (optional)

See Also

GraphicCreateBox


GraphicsBoxCaptionDlg

Purpose

Display the Box Caption dialog box.

Syntax

GraphicsBoxCaptionDlg ()


GraphicsBoxContentDlg

Purpose

Display the Box Content dialog box.

Syntax

GraphicsBoxContentDlg ()


GraphicsBoxFindDlg

Purpose

Display the Select Box to Edit dialog box. The current document must contain at least two boxes.

Syntax

GraphicsBoxFindDlg ()


GraphicsBoxSizeDlg

Purpose

Display the Box Size dialog box.

Syntax

GraphicsBoxSizeDlg ()


GraphicsFigureEditAllDlg

Purpose

Display the Image Settings dialog box.

Syntax

GraphicsFigureEditAllDlg ()


GraphicsLineColor

Purpose

Specify the color of a graphics line.

Syntax

GraphicsLineColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0 to 100.

See Also

?GraphicsLineColorBlue, ?GraphicsLineColorGreen, ?GraphicsLineColorRed, ?GraphicsLineColorShading, GraphicsLineCreate, GraphicsLineEnd


GraphicsLineCreate

Purpose

Create a graphics line.

Syntax

GraphicsLineCreate (LineType: enumeration)

Parameters

LineType

enumeration (optional)

HorizontalLine!

VerticalLine!

See Also

GraphicsLineDelete, GraphicsLineEdit, GraphicsLineEnd, HLineCreate, LineCreateDlg, VLineCreate


GraphicsLineDelete

Purpose

Delete a graphics line.

Syntax

GraphicsLineDelete (Line: numeric)

Parameters

Line

numeric

See Also

GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineEdit

Purpose

Specify a graphics line to edit.

Syntax

GraphicsLineEdit (Line: numeric)

Parameters

Line

numeric

See Also

GraphicsLineCreate, GraphicsLineDelete, GraphicsLineEditNext, GraphicsLineEditPrevious, GraphicsLineEnd, LineEditDlg


GraphicsLineEditNext

Purpose

Begin editing of the next graphics line.

Syntax

GraphicsLineEditNext (LineType: enumeration)

Parameters

LineType

enumeration (optional)

HorizontalLine!

VerticalLine!

See Also

GraphicsLineEdit, GraphicsLineEditPrevious, GraphicsLineEnd


GraphicsLineEditPrevious

Purpose

Begin editing of the previous graphics line.

Syntax

GraphicsLineEditPrevious (LineType: enumeration)

Parameters

LineType

enumeration (optional)

HorizontalLine!

VerticalLine!

See Also

GraphicsLineEdit, GraphicsLineEditNext, GraphicsLineEnd


GraphicsLineEnd

Purpose

Save or cancel changes made to a graphics line.

Syntax

GraphicsLineEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

GraphicsLineCreate, GraphicsLineDelete, GraphicsLineEdit


GraphicsLineHorizontalPosition

Purpose

Position a graphics line horizontally.

Syntax

GraphicsLineHorizontalPosition (Position: enumeration; AbsPos: measurement; LeftColNum: numeric)

Parameters

Position

enumeration

BetweenColumns!

Left!

Center!

Right!

FullAlign!

Set!

AbsPos

measurement (optional) Exact position on a page for a graphics line. Use if Position parameter is Set!.

LeftColNum

numeric (optional) The column to the left of a graphics line. Use if the Position parameter is BetweenColumns!.

See Also

?GraphicsLineHorizontalAlign, ?GraphicsLineHorizontalColumn, ?GraphicsLineHorizontalPosition, GraphicsLineCreate, GraphicsLineEdit


GraphicsLineLength

Purpose

Specify the length of graphics lines. 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. Precede with GraphicsLineCreate or GraphicsLineEdit and follow with GraphicsLineEnd.

Syntax

GraphicsLineLength (Length: measurement)

Parameters

Length

measurement

See Also

?GraphicsLineLength, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineSpacing

Purpose

Specify the amount of white space between a graphics line and text. Precede with GraphicsLineCreate or GraphicsLineEdit and follow with GraphicsLineEnd.

Syntax

GraphicsLineSpacing (TopSpace: measurement; BottomSpace: measurement)

Parameters

TopSpace

measurement The space above a horizontal graphics line or to the left of a vertical graphics line between the line and text.

BottomSpace

measurement (optional) The space below a horizontal graphics line or to the right of a vertical graphics line between the line and text. Default: amount entered for the TopSpace parameter.

See Also

?GraphicsLineBottomSpacing, ?GraphicsLineTopSpacing, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineStyle

Purpose

Specify a graphics line style. Precede with GraphicsLineCreate or GraphicsLineEdit and follow with GraphicsLineEnd.

Syntax

GraphicsLineStyle (Style: any)

Parameters

Style

any Enclose custom styles in quotation marks.

ButtonBottomRight!

HeavySingleLine!

ButtonTopLeft!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?GraphicsLineStyle, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineThickness

Purpose

Specify the thickness of a graphics line. Precede with GraphicsLineCreate or GraphicsLineEdit and follow with GraphicsLineEnd.

Syntax

GraphicsLineThickness (Thickness: any)

Parameters

Thickness

any Specify the thickness of a graphics line.

See Also

?GraphicsLineThickness, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineType

Purpose

Specify whether a graphics line is horizontal or vertical.

Syntax

GraphicsLineType (LineType: enumeration)

Parameters

LineType

enumeration

Horizontal!

Vertical!

See Also

?GraphicsLineType, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineUpdateDisplay

Purpose

Update a graphics line display after editing.

Syntax

GraphicsLineUpdateDisplay (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!


GraphicsLineUseColor

Purpose

Select or deselect the default line style color for a graphics line. Precede with GraphicsLineCreate or GraphicsLineEdit and follow with GraphicsLineEnd.

Syntax

GraphicsLineUseColor (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?GraphicsLineUseColor, GraphicsLineColor, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


GraphicsLineVerticalPosition

Purpose

Specify the vertical position of a graphics line.

Syntax

GraphicsLineVerticalPosition (Position: enumeration; Where: measurement)

Parameters

Position

enumeration

Baseline!

FullAlign!

Bottom!

Set!

Center!

Top!

Where

measurement (optional) The exact position of a graphics line if the Position parameter is Set!.

See Also

?GraphicsLineVerticalAlign, ?GraphicsLineVerticalPosition, GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd, GraphicsLineHorizontalPosition


GraphicsStylesDlg

Purpose

Display the Graphics Styles dialog box.

Syntax

GraphicsStylesDlg ()


Guidelines

Purpose

Show or hide guidelines and return the current state. To return the current state without changing any guideline settings, omit the parameters.

Syntax

numeric := Guidelines (ShowTableGuides: enumeration; ShowMarginGuides: enumeration; ShowColumnGuides: enumeration; ShowHeaderFooterGuides: enumeration)

Parameters

ShowTableGuides

enumeration (optional)

No!

Yes!

ShowMarginGuides

enumeration (optional)

No!

Yes!

ShowColumnGuides

enumeration (optional)

No!

Yes!

ShowHeaderFooterGuides

enumeration (optional)

No!

Yes!

See Also

GuidelinesDlg


GuidelinesDlg

Purpose

Display the Guidelines dialog box.

Syntax

GuidelinesDlg ()

See Also

Guidelines


HardColumnBreak

Purpose

Insert a hard column break at the insertion point and begin a new column.

Syntax

HardColumnBreak ()

See Also

ColumnsOff


HardPageBreak

Purpose

Insert a hard page break at the insertion point and begin a new page.

Syntax

HardPageBreak ()

See Also

HardPageBreakInsert


HardPageBreakInsert

Purpose

Insert a page break in columns without positioning the insertion point in the next column.

Syntax

HardPageBreakInsert ()

See Also

HardPageBreak


HardPageBreakKey

Purpose

Insert a hard page break at the insertion point and begin a new page. Recordable substitute: HardPageBreak.

Syntax

HardPageBreakKey ()


HardReturn

Purpose

Insert a [HRt] code and begin a new line.

Syntax

HardReturn ()

See Also

HardReturnInsert


HardReturnInsert

Purpose

Insert a [HRt] code in Outline mode.

Syntax

HardReturnInsert ()

See Also

HardReturn


HardSpace

Purpose

Insert a [HSpace] code at the insertion point. A hard space holds two words together.

Syntax

HardSpace ()


HeaderA

Purpose

Create, edit, or discontinue Header A, and specify the pages on which it will appear.

Syntax

HeaderA (Action: enumeration; Occurrence: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional) The location of Header A.

AllPages!

EvenPages!

NoPages!

OddPages!

See Also

?HeaderAOccur, ?HeaderBOccur


HeaderB

Purpose

Create, edit, or discontinue Header B, and specify the pages on which it will appear.

Syntax

HeaderB (Action: enumeration; Occurrence: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional) The location of Header B.

AllPages!

EvenPages!

NoPages!

OddPages!

See Also

?HeaderAOccur, ?HeaderBOccur


HeaderFooterDistanceDlg

Purpose

Display the Distance dialog box.

Syntax

HeaderFooterDistanceDlg ()


HeaderFooterDlg

Purpose

Display the Headers/Footers dialog box.

Syntax

HeaderFooterDlg ()


HeaderFooterNext

Purpose

Advance to the next header/footer.

Syntax

HeaderFooterNext ()


HeaderFooterPlacement

Purpose

Specify the pages on which headers and footers will appear. They can be placed on odd-numbered pages only, even-numbered pages only, or on all pages.

Syntax

HeaderFooterPlacement (State: enumeration)

Parameters

State

enumeration (optional)

AllPages!

EvenPages!

NoPages!

OddPages!


HeaderFooterPlacementDlg

Purpose

Display the Pages dialog box.

Syntax

HeaderFooterPlacementDlg ()

See Also

NewHFWOccurrence


HeaderFooterPrev

Purpose

Advance to the next header/footer.

Syntax

HeaderFooterPrev ()


HeaderSeparationDistance

Purpose

Specify the distance between text and headers.

Syntax

HeaderSeparationDistance (Distance: measurement)

Parameters

Distance

measurement If less than 1, precede the decimal with 0.

See Also

?HeaderSeparator


HelpAskThePerfectExpert

Purpose

Display the Ask the PerfectExpert dialog box.

Syntax

HelpAskThePerfectExpert ()


HelpCoachDlg

Purpose

Display the Ask the PerfectExpert dialog box.

Syntax

HelpCoachDlg ()

See Also

HelpShowMe


HelpContents

Purpose

Display the Help Topics window with the Contents tab active.

Syntax

HelpContents ()


HelpFilesPath

Purpose

Return the location of the Corel WordPerfect Help files.

Syntax

string := HelpFilesPath ()


HelpHelpTopics

Purpose

Display the Help Topics window with the last selected tab displayed.

Syntax

HelpHelpTopics ()


HelpHowDoI

Purpose

Display instructions on how to use Help.

Syntax

HelpHowDoI ()

See Also

HelpHowToUseHelp


HelpHowToUseHelp

Purpose

Display instructions on how to use Help.

Syntax

HelpHowToUseHelp ()

See Also

HelpHowDoI


HelpKeystrokes

Purpose

Open Help for keystrokes.

Syntax

HelpKeystrokes ()

See Also

HelpContents, HelpHowToUseHelp


HelpMacroManual

Purpose

Open the Macros Help file.

Syntax

HelpMacroManual ()

See Also

HelpContents, HelpHowToUseHelp


HelpOnlineSupportDlg

Purpose

Display the Help Online dialog box.

Syntax

HelpOnlineSupportDlg ()

See Also

WebLaunchWebBrowser, LaunchOnlineService


HelpSearchForHelpOn

Purpose

Display the Help Topics window with the Index tab active.

Syntax

HelpSearchForHelpOn ()

See Also

HelpHelpTopics


HelpShowMe

Purpose

Display the Ask the PerfectExpert dialog box.

Syntax

HelpShowMe ()

See Also

HelpCoachDlg


HelpWhatIs

Purpose

Activate the Windows What's This feature. (Use PAUSE to pause a macro when it encounters HelpWhatIs.)

Syntax

HelpWhatIs ()

See Also

HelpHowDoI


HiddenText

Purpose

Turn Hidden Text on or off for selected text.

Syntax

HiddenText (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

HiddenTextShowAll


HiddenTextShowAll

Purpose

Display or hide hidden text.

Syntax

HiddenTextShowAll (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?HiddenTextActive, HiddenText


HideBars

Purpose

Display the Hide Bars Information dialog box (unless user-disabled) before hiding scroll bars, toolbars, etc.

Syntax

HideBars (State: enumeration)

Parameters

State

enumeration (optional) Default: toggle.

Off!

On!


HighlightColor

Purpose

Set the color and shade of the highlighter.

Syntax

HighlightColor (Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

Shade

numeric Percent: 0-100.


HighlightColorDlg

Purpose

Display the Highlight Color dialog box.

Syntax

HighlightColorDlg ()


HighlightPrint

Purpose

Toggle highlight printing and display on or off in the current document for the current session. Highlight Print/Show is active by default for all new and just-opened documents.

Syntax

HighlightPrint ()


HighlightRemove

Purpose

Remove highlighting from the selected text and turn off the selection. If select mode is off and the insertion point is between Highlight codes, this command removes the codes and turns off the selection. If select mode is off and the insertion point is not between Highlight codes, this command does nothing. If select mode is on and the selection contains no highlighting, the selection is turned off.

Syntax

HighlightRemove ()


HighlightToggle

Purpose

Toggle highlighting on or off. If text is selected, this command highlights the selected text and turns the selection off. If nothing is selected, highlight mode is turned on or off.

Syntax

HighlightToggle ()


HLineCreate

Purpose

Create a horizontal line. The line will extend from the left margin to the right margin.

Syntax

HLineCreate ()


Hypertext

Purpose

Activate or deactivate all hyperlinks.

Syntax

Hypertext (State: enumeration)

Parameters

State

enumeration

Active!

Inactive!


HypertextCreate

Purpose

Create a hyperlink to a find a bookmark, launch a web browser and find a URL, or play a macro, and specify the appearance of the hyperlink.

Syntax

HypertextCreate (Action: enumeration; Macro: string; Bookmark: string; Display: enumeration)

Parameters

Action

enumeration

GoToBookmark!

RunMacro!

Macro

string (optional) The document filename, web document URL (Internet address), or macro name if the Action parameter is RunMacro!.

Bookmark

string (optional) Bookmark in the current document if the Action parameter is GoToBookmark!.

Display

enumeration (optional)

Button!

HighlightedText!

See Also

HypertextDelete, HypertextEdit, HypertextExecute, HypertextInfo


HypertextCreateDlg

Purpose

Display the Create Hyperlink dialog box.

Syntax

HypertextCreateDlg ()


HypertextDelete

Purpose

Delete the hyperlink that contains the insertion point.

Syntax

HypertextDelete ()

See Also

HypertextCreate, HypertextEdit, HypertextExecute


HypertextEdit

Purpose

Edit a hyperlink.

Syntax

HypertextEdit (Action: enumeration; Macro: string; Bookmark: string; Appearance: enumeration)

Parameters

Action

enumeration

GoToBookmark!

RunMacro!

Macro

string (optional) The document filename, web document URL (Internet address), or macro name if the Action parameter is RunMacro!.

Bookmark

string (optional) Bookmark in the current document if the Action parameter is GoToBookmark!.

Appearance

enumeration (optional)

Button!

HighlightedText!

See Also

HypertextCreate, HypertextDelete, HypertextExecute


HypertextEditDlg

Purpose

Display the Edit Hyperlink dialog box.

Syntax

HypertextEditDlg ()


HypertextExecute

Purpose

Perform a hyperlink.

Syntax

HypertextExecute ()

See Also

HypertextCreate, HypertextDelete, HypertextEdit


HypertextInfo

Purpose

Return the specified information pertaining to the current hyperlink. If the insertion point is not on a hyperlink, information regarding the previous hyperlink is returned. If there are no hyperlinks preceding the insertion point, information regarding the next hyperlink is returned. If there are no hyperlinks in the current document, 0 is always returned, regardless of the value of the Data parameter.

Syntax

any := HypertextInfo (Data: enumeration)

Parameters

Data

enumeration Specify the link information to return.

Action!

Appearance!

Bookmark!

Name!

See Also

HypertextCreate


HypertextNext

Purpose

Advance to the next hyperlink.

Syntax

HypertextNext ()

See Also

HypertextPrevious


HypertextPrevious

Purpose

Return to the previous hyperlink.

Syntax

HypertextPrevious ()

See Also

HypertextNext


HypertextReturnFrom

Purpose

Return the insertion point from a bookmark to the bookmark's hyperlink.

Syntax

HypertextReturnFrom ()


HypertextStyleEdit

Purpose

Edit the Hyperlink Style.

Syntax

HypertextStyleEdit ()


Hyphen

Purpose

Insert a hyphen.

Syntax

Hyphen ()


Hyphenation

Purpose

Turn Hyphenation on or off.

Syntax

Hyphenation (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?Hyphenation, HyphenationIgnore


HyphenationIgnore

Purpose

Cancel hyphenation of the current word.

Syntax

HyphenationIgnore ()

See Also

Hyphenation


HyphenationSoftReturn

Purpose

Insert a hyphenation soft return code [Hyph SRt] at the insertion point. This code will break the word, if hyphenation is necessary, at the specified point.

Syntax

HyphenationSoftReturn ()


HyphenationZoneLeft

Purpose

Specify the lower limit of a hyphenation zone.

Syntax

HyphenationZoneLeft (HZone: numeric)

Parameters

HZone

numeric

See Also

?LeftHyphZone, HyphenationZoneRight


HyphenationZoneRight

Purpose

Specify the upper limit of a hyphenation zone.

Syntax

HyphenationZoneRight (HZone: numeric)

Parameters

HZone

numeric

See Also

?RightHyphZone, HyphenationZoneLeft


ImportCreateDlg

Purpose

Display the Create Data Link dialog box.

Syntax

ImportCreateDlg ()


ImportDlg

Purpose

Display the Import Data dialog box.

Syntax

ImportDlg ()


ImportDoEdit

Purpose

Modify and perform an existing link between a spreadsheet or database and the current document.

Syntax

ImportDoEdit ()

See Also

ImportDoImport, ImportDoLink, ImportDoUpdate


ImportDoImport

Purpose

Import ASCII text, ANSI text, table data, spreadsheet data, or database data.

Syntax

ImportDoImport ()

See Also

ImportDoEdit, ImportDoLink, ImportDoUpdate


ImportDoLink

Purpose

Create and perform a link between a spreadsheet or database and the current document.

Syntax

ImportDoLink ()

See Also

ImportDoEdit, ImportDoImport, ImportDoUpdate


ImportDoUpdate

Purpose

Update linked data in the current document to match the data in linked spreadsheet or database files.

Syntax

ImportDoUpdate ()

See Also

ImportDoEdit, ImportDoImport, ImportDoLink


ImportEditDlg

Purpose

Display the Edit Data Link dialog box.

Syntax

ImportEditDlg ()


ImportOptionsDlg

Purpose

Display the Link Options dialog box.

Syntax

ImportOptionsDlg ()


ImportSetAsciiEncap

Purpose

Specify an ASCII encapsulation character for importing spreadsheet or database data saved as ASCII delimited text.

Syntax

ImportSetAsciiEncap (EncapsulationChar: string)

Parameters

EncapsulationChar

string

See Also

ImportSetAsciiFieldDelimiter, ImportSetAsciiRecordDelimiter, ImportSetAsciiStrip


ImportSetAsciiFieldDelimiter

Purpose

Specify the characters to mark the beginning or end of a field when importing spreadsheet or database data saved as ASCII delimited text.

Syntax

ImportSetAsciiFieldDelimiter (FieldDelimiter: string)

Parameters

FieldDelimiter

string

See Also

ImportSetAsciiEncap, ImportSetAsciiRecordDelimiter, ImportSetAsciiStrip


ImportSetAsciiRecordDelimiter

Purpose

Specify the characters to mark the beginning or end of a record when importing spreadsheet or database data saved as ASCII delimited text.

Syntax

ImportSetAsciiRecordDelimiter (RecordDelimiter: string)

Parameters

RecordDelimiter

string

See Also

ImportSetAsciiEncap, ImportSetAsciiFieldDelimiter, ImportSetAsciiStrip


ImportSetAsciiStrip

Purpose

Delete extra characters when importing spreadsheet or database data saved as ASCII delimited text.

Syntax

ImportSetAsciiStrip (StripChars: string)

Parameters

StripChars

string

See Also

ImportSetAsciiEncap, ImportSetAsciiFieldDelimiter, ImportSetAsciiRecordDelimiter


ImportSetDataSource

Purpose

Specify the data source for an ODBC import.

Syntax

ImportSetDataSource (Source: string)

Parameters

Source

string


ImportSetDestination

Purpose

Specify a format for linked or imported spreadsheet or database data.

Syntax

ImportSetDestination (DestinationType: enumeration)

Parameters

DestinationType

enumeration

MergeData!

TabbedText!

WPTable!

See Also

ImportSetSource


ImportSetDictPath

Purpose

Specify the Novell NetWare SQL dictionary path for imported spreadsheet or database data. Available only for Pioneer Q+E drivers.

Syntax

ImportSetDictPath (DictionaryPath: string)

Parameters

DictionaryPath

string

See Also

ImportSetFilePath, ImportSetPassword, ImportSetUserID


ImportSetFields

Purpose

Specify the database fields to import.

Syntax

ImportSetFields (FieldNames: string)

Parameters

FieldNames

string Separate fields with a comma, enclosed in quotation marks.

See Also

ImportSetFileName, ImportSetIncludeNames


ImportSetFileName

Purpose

Specify a source file to link to or import from.

Syntax

ImportSetFileName (Filename: string)

Parameters

Filename

string

See Also

ImportSetFields


ImportSetFilePath

Purpose

Specify a NetWare SQL file path. Available only for Pioneer Q+E drivers.

Syntax

ImportSetFilePath (FilePath: string)

Parameters

FilePath

string

See Also

ImportSetDictPath, ImportSetPassword, ImportSetUserID


ImportSetIncludeNames

Purpose

Use the field names as headings for imported database data.

Syntax

ImportSetIncludeNames (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

ImportSetFields


ImportSetPanel

Purpose

Specify a Corel DataPerfect panel to retrieve.

Syntax

ImportSetPanel (PanelName: string)

Parameters

PanelName

string

See Also

ImportSetFields, ImportSetFileName


ImportSetPassword

Purpose

Specify a password to import SQL data. Available only for Pioneer Q+E drivers.

Syntax

ImportSetPassword (Password: string)

Parameters

Password

string


ImportSetQuery

Purpose

Specify the field conditions for a database import query. For examples of valid conditions, choose Example from the Define Selection Conditions dialog box.

Syntax

ImportSetQuery (FieldName1: string; FieldName2: string; FieldName3: string; Condition1Field1: string; Condition1Field2: string; Condition1Field3: string; Condition2Field1: string; Condition2Field2: string; Condition2Field3: string; Condition3Field1: string; Condition3Field2: string; Condition3Field3: string; Condition4Field1: string; Condition4Field2: string; Condition4Field3: string)

Parameters

FieldName1

string (optional)

FieldName2

string (optional)

FieldName3

string (optional)

Condition1Field1

string (optional)

Condition1Field2

string (optional)

Condition1Field3

string (optional)

Condition2Field1

string (optional)

Condition2Field2

string (optional)

Condition2Field3

string (optional)

Condition3Field1

string (optional)

Condition3Field2

string (optional)

Condition3Field3

string (optional)

Condition4Field1

string (optional)

Condition4Field2

string (optional)

Condition4Field3

string (optional)


ImportSetRange

Purpose

Specify a range of spreadsheet cells to import.

Syntax

ImportSetRange (Range: string)

Parameters

Range

string


ImportSetServer

Purpose

Specify a server for a NetWare SQL database import. Available only for Pioneer Q+E drivers.

Syntax

ImportSetServer (ServerName: string)

Parameters

ServerName

string


ImportSetSizeToFit

Purpose

Size table columns to fit data after it is imported.

Syntax

ImportSetSizeToFit (State: enumeration)

Parameters

State

enumeration

No!

Yes!


ImportSetSource

Purpose

Specify the format of spreadsheet or database data to import.

Syntax

ImportSetSource (SourceType: enumeration)

Parameters

SourceType

enumeration

ANSIText!

ODBC!

ASCII!

ODBC_NO_SQL!

Clipper!

Oracle!

DataPerfect!

Paradox!

DB2!

Spreadsheet!

dBase!

SQLBase!

FoxPro!

SQLServer!

InFormix!

Sybase!

NetWare!

XDB!


ImportSetSQLQuery

Purpose

Specify the conditions for a database link or import query. For examples of valid conditions, choose Example from the Define Selection Conditions dialog box.

Syntax

ImportSetSQLQuery (SQLQuery: string)

Parameters

SQLQuery

string


ImportSetTable

Purpose

Specify a table to import.

Syntax

ImportSetTable (TableName: string)

Parameters

TableName

string


ImportSetUserID

Purpose

Specify a NetWare SQL database user identification. Available only for Pioneer Q+E drivers.

Syntax

ImportSetUserID (UserId: string)

Parameters

UserId

string

See Also

ImportSetDictPath, ImportSetFilePath, ImportSetPassword


ImportUpdateDlg

Purpose

Display the Update import dialog box.

Syntax

ImportUpdateDlg ()


Indent

Purpose

Indent a paragraph one tab stop to the right without changing the margins.

Syntax

Indent ()

See Also

?Indent


IndentLeftRight

Purpose

Indent both sides of a paragraph equally from the left and right margin.

Syntax

IndentLeftRight ()


IndexDefineDlg

Purpose

Display the Define Index dialog box.

Syntax

IndexDefineDlg ()


IndexDefinition

Purpose

Create and insert an index definition.

Syntax

IndexDefinition (Heading: any; Subheading: any; NumMode: enumeration; PgCombine: enumeration; Concordance: string; UserFormat: string)

Parameters

Heading

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Subheading

any The subheading style.

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

NumMode

enumeration The page numbering method after a heading.

DefFlushRight!

DefFollows!

DefLeader!

DefNone!

DefParentheses!

PgCombine

enumeration Combine sequential page numbers (for example, 51-53) or not (51, 52, 53).

Combine!

NoCombine!

Concordance

string (optional)

UserFormat

string (optional) The page number format. Default: document format.

See Also

?IndexDefinition, IndexMark


IndexMark

Purpose

Mark the text to be indexed. You can specify both a heading and a subheading.

Syntax

IndexMark (Heading: string; Subheading: string)

Parameters

Heading

string (optional)

Subheading

string (optional)

See Also

IndexDefinition


InhibitInput

Purpose

Enable or disable keyboard and menu input during macro execution.

Syntax

boolean := InhibitInput (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

Display


InitialCapShippingMacro

Purpose

Play the shipping macro CAPITAL.WCM to capitalize the first letter of the current word. CAPITAL.WCM must be installed.

Syntax

InitialCapShippingMacro ()


InitialCodesDoc

Purpose

Begin initial codes. All codes between InitialCodesDoc and SubstructureExit are placed in initial codes.

Syntax

InitialCodesDoc ()


InitialCodesStyleDlg

Purpose

Display the Styles Editor dialog box. Recordable equivalent: Format, Document, Initial Codes Style.

Syntax

InitialCodesStyleDlg ()


InsertDefaultBullet

Purpose

Insert another bullet or number of the last type inserted.

Syntax

InsertDefaultBullet ()


InsertFilename

Purpose

Insert the filename of the current document.

Syntax

InsertFilename ()

See Also

InsertFilenameWithPath


InsertFilenameWithPath

Purpose

Insert the path and filename of the current document.

Syntax

InsertFilenameWithPath ()

See Also

InsertFilename


InsertOtherCodesDlg

Purpose

Display the Other Codes dialog box.

Syntax

InsertOtherCodesDlg ()


InternetPublisherDlg

Purpose

Display the Internet Publisher dialog box.

Syntax

InternetPublisherDlg ()

See Also

WebNewDlg, WebViewInWebBrowser, WebPublish, WebFormatAsWebDocument


InvokeDialog

Purpose

Display a specified dialog box but do not pause the macro for input.

Syntax

InvokeDialog (Dialog: command name)

Parameters

Dialog

command name


IrregularCap

Purpose

Corrects two consecutive uppercase letters followed by a lowercase letter at the beginning of a word. The second uppercase letter is made lowercase.

Syntax

IrregularCap (State: enumeration)

Parameters

State

enumeration

Off!

On!


IsTokenValid

Purpose

Indicate whether a specified macro command can be executed given the current state of the program. For example, when the Clipboard is empty, the EditPaste command is invalid. This command is equivalent to checking whether an option grayed is in the interface. Menu items and dialog boxes are represented by the macro commands that execute them. For example, to check the Open dialog, use FileOpenDlg.

Syntax

boolean := IsTokenValid (Variable: variable; Token: command name)

Parameters

Variable

variable The value of the variable specified in this parameter is set to True if token specified in the Token parameter is available, False if not.

Token

command name The macro command (token) specifying item or dialog to check.


Justification

Purpose

Align text on the right or left margins, on both margins (including or not including the last line), or center it between the margins.

Syntax

Justification (Justification: enumeration)

Parameters

Justification

enumeration

Center!

DecAlign!

Full!

FullAll!

Left!

Right!

See Also

?Justification, TableFormatJustification


JustifyAll

Purpose

Align all lines of text, including the last line of a paragraph, between the left and right margins from the current paragraph forward.

Syntax

JustifyAll ()

See Also

JustifyCenter, JustifyFull, JustifyLeft, JustifyRight


JustifyCenter

Purpose

Center all lines of text from the current paragraph forward.

Syntax

JustifyCenter ()

See Also

JustifyAll, JustifyFull, JustifyLeft, JustifyRight


JustifyFull

Purpose

Align text, except the last line of each paragraph, along the left and right margins from the current paragraph forward.

Syntax

JustifyFull ()

See Also

JustifyAll, JustifyCenter, JustifyLeft, JustifyRight


JustifyLeft

Purpose

Align text at the left margin from the current paragraph forward.

Syntax

JustifyLeft ()

See Also

JustifyAll, JustifyCenter, JustifyFull, JustifyRight


JustifyRight

Purpose

Align text at the right margin from the current paragraph forward.

Syntax

JustifyRight ()

See Also

JustifyAll, JustifyCenter, JustifyFull, JustifyLeft


KeepTextTogetherDlg

Purpose

Display the Keep Text Together dialog box.

Syntax

KeepTextTogetherDlg ()

See Also

BlockProtect, ConditionalEndOfPage, WidowOrphan


Kerning

Purpose

Turn Automatic Kerning on or off.

Syntax

Kerning (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?Kerning


KerningSpacing

Purpose

Move the character to the right of the insertion point a specified distance to the left or right.

Syntax

KerningSpacing (KerningSpacingValue: measurement)

Parameters

KerningSpacingValue

measurement (optional) The distance to move the character. Negative values move left, positive values move right.

See Also

Advance, Kerning


KeyboardSelect

Purpose

Select a keyboard, such as WPWin 6.0 Keyboard, Equation Editor Keyboard, or WPDOS 6.0 Compatible Keyboard.

Syntax

KeyboardSelect (Keyboard: string)

Parameters

Keyboard

string (optional)

See Also

KeyboardSelectDlg


KeyboardSelectDlg

Purpose

Display the Keyboard Settings dialog box.

Syntax

KeyboardSelectDlg ()

See Also

KeyboardSelect


LabelsDefine

Purpose

Create a customized labels definition.

Syntax

LabelsDefine (Filename: string; LabelName: string; LabelFlags: enumeration; SheetWidth: measurement; SheetLength: measurement; ColumnsPerPage: numeric; RowsPerPage: numeric; LabelWidth: measurement; LabelLength: measurement; LeftOffset: measurement; TopOffset: measurement; BetweenColumns: measurement; BetweenRows: measurement; MarginLeft: measurement; MarginRight: measurement; MarginTop: measurement; MarginBottom: measurement)

Parameters

Filename

string

LabelName

string

LabelFlags

enumeration

Laser!

LaserandTractorFed!

TractorFed!

SheetWidth

measurement

SheetLength

measurement

ColumnsPerPage

numeric

RowsPerPage

numeric

LabelWidth

measurement

LabelLength

measurement

LeftOffset

measurement The distance from the left edge of the page to the left edge of the first label column.

TopOffset

measurement The distance from the top edge of the page to the top edge of the first label row.

BetweenColumns

measurement

BetweenRows

measurement

MarginLeft

measurement

MarginRight

measurement

MarginTop

measurement

MarginBottom

measurement

See Also

LabelsDlg, LabelsFileCreate, LabelsFileDescription, LabelsOff, LabelsSelect, PaperSizeAdd, PaperSizeResave, PaperSizeSelect


LabelsDelete

Purpose

Delete a labels definition.

Syntax

LabelsDelete (Filename: string; LabelName: string)

Parameters

Filename

string

LabelName

string


LabelsDlg

Purpose

Display the Labels dialog box.

Syntax

LabelsDlg ()


LabelsFileCreate

Purpose

Create a labels file.

Syntax

LabelsFileCreate (Filename: string)

Parameters

Filename

string

See Also

LabelsFileDescription, LabelsFileSelect


LabelsFileDescription

Purpose

Create a description for a labels file.

Syntax

LabelsFileDescription (Filename: string; Description: string)

Parameters

Filename

string

Description

string

See Also

LabelsFileCreate, LabelsFileSelect


LabelsFileSelect

Purpose

Select a labels file.

Syntax

LabelsFileSelect (Filename: string)

Parameters

Filename

string

See Also

LabelsFileDescription


LabelsOff

Purpose

Turn off labels mode.

Syntax

LabelsOff ()

See Also

LabelsFileSelect, LabelsSelect


LabelsSelect

Purpose

Select a label definition.

Syntax

LabelsSelect (Filename: string; LabelName: string)

Parameters

Filename

string

LabelName

string


Language

Purpose

Specify a language for a document or a selection of text.

Syntax

Language (Language: string)

Parameters

Language

string Two characters that specify a language.


LanguageDlg

Purpose

Display the Language dialog box.

Syntax

LanguageDlg ()


LastOpenedAdd

Purpose

Place a filename at the top of Last Opened on the File menu.

Syntax

LastOpenedAdd ({Filename: string; })

Parameters

Filename

string (optional)


LaunchOnlineService

Purpose

Start an online service and specify an address.

Syntax

LaunchOnlineService (ProgramPath: string; Address: string)

Parameters

ProgramPath

string The path and filename of online service program.

Address

string

See Also

HelpOnlineSupportDlg, WebLaunchWebBrowser


Leading

Purpose

Specify the leading adjustment.

Syntax

Leading (Adjustment: measurement)

Parameters

Adjustment

measurement


LineBreak

Purpose

Insert a Ln Brk (Line Break) code at the insertion point. This command begins a new line without ending the paragraph. It was created for use in web documents, but it also works in regular documents.

Syntax

LineBreak ()


LineCreateDlg

Purpose

Display the Create Graphics Line dialog box.

Syntax

LineCreateDlg ()

See Also

GraphicsLineCreate


LineEditDlg

Purpose

Display the Edit Graphics Line dialog box.

Syntax

LineEditDlg ()

See Also

GraphicsLineEdit, LineCreateDlg


LineHeight

Purpose

Specify the line height, measured from baseline to baseline in single-spaced text. Fixed line height: specify unit of measurement by preceding LineHeight with DEFAULTUNITS or by specifying a unit of measurement identifier (“, c, p, w) in the Height parameter. Auto line height: measured as point size of the current font plus two points.

Syntax

LineHeight (Height: any)

Parameters

Height

any Select Auto! or specify a fixed line height and unit of measurement.

Auto!

See Also

LineHeightDlg


LineHeightDlg

Purpose

Display the Line Height dialog box.

Syntax

LineHeightDlg ()

See Also

LineHeight


LineHyphenationDlg

Purpose

Display the Line Hyphenation dialog box.

Syntax

LineHyphenationDlg ()


LineNumbering

Purpose

Turn Line Numbering on or off, and set numbering attributes. When the Default parameter is DontUseDefaultValues!, you can specify font, color, Shade, and AttributesOn parameters. You can see the values of a selected color in the Define Color Printing Palette dialog box.

Syntax

LineNumbering (State: enumeration; RestartAtNewPage: enumeration; CountBlankLines: enumeration; NumberColumns: enumeration; PositionRelativeToLeftEdge: enumeration; Position: measurement; FirstPrintingNumber: numeric; NumberInterval: numeric; Default: enumeration; FontFace: string; FontSize: measurement; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric; {AttributesOn: enumeration; })

Parameters

State

enumeration

Off!

On!

RestartAtNewPage

enumeration (optional)

DontRestartNumbersEachPage!

RestartNumbersEachPage!

CountBlankLines

enumeration (optional)

CountBlankLines!

DontCountBlankLines!

NumberColumns

enumeration (optional)

DontNumberAllNewspaperColumns!

NumberAllNewspaperColumns!

PositionRelativeToLeftEdge

enumeration (optional)

PosNumberFromLeftEdgeOfPaper!

PosNumberFromLeftMargin!

Position

measurement (optional) Where to print line numbers.

FirstPrintingNumber

numeric (optional)

NumberInterval

numeric (optional)

Default

enumeration (optional)

DontUseDefaultValues!

UseDefaultValues!

FontFace

string (optional)

FontSize

measurement (optional)

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

AttributesOn

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

ExtraLarge!

SmallCaps!

Fine!

Strikeout!

Italics!

Subscript!

Large!

Superscript!

Outline!

Underline!

Redline!

VeryLarge!

See Also

?LineNumbering, ?LineNumCountBlankLines, ?StartingLineNumber, LineNumberingMethod, LineNumberSet


LineNumberingDlg

Purpose

Display the Line Numbering dialog box.

Syntax

LineNumberingDlg ()

See Also

LineNumbering


LineNumberingMethod

Purpose

Specify a method for numbering lines.

Syntax

LineNumberingMethod (NumberingMethod: enumeration)

Parameters

NumberingMethod

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

?LineNumberMethod, LineNumbering, LineNumberSet


LineNumberSet

Purpose

Specify the first line number on a page.

Syntax

LineNumberSet (Number: numeric)

Parameters

Number

numeric

See Also

LineNumbering, LineNumberingMethod


LineNumberShippingMacro

Purpose

Play the shipping macro LINENUM.WCM to move the insertion point to a specified line and line position in a macro. LINENUM.WCM must be installed.

Syntax

LineNumberShippingMacro ()


LineSegmentColor

Purpose

Specify the color of a line segment. Use with commands such as LineSegmentCreate and LineSegmentEnd.

Syntax

LineSegmentColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100. Although Shade is optional, omitting it defaults the line color to black, regardless of the other parameter values.

See Also

?LineSegmentBlue, ?LineSegmentGreen, ?LineSegmentRed, ?LineSegmentShading, LineSegmentCreate, LineSegmentEnd, LineStyleEdit, LineStyleEnd


LineSegmentCreate

Purpose

Create a custom line style of stacked lines. Use with commands such as LineStyleEdit.

Syntax

LineSegmentCreate (Position: numeric)

Parameters

Position

numeric First (inside) position: 1.

See Also

LineSegmentDelete, LineSegmentEnd, LineStyleEdit, TableEdit


LineSegmentDelete

Purpose

Delete a single line of a stacked custom line. Use with commands such as LineStyleEdit and LineSegmentEnd.

Syntax

LineSegmentDelete (Position: numeric)

Parameters

Position

numeric First (inside) position: 1.

See Also

LineSegmentCreate, LineStyleEdit, LineStyleEnd


LineSegmentEdit

Purpose

Specify a line segment to edit. Follow with editing commands and LineSegmentEnd.

Syntax

LineSegmentEdit (Position: numeric)

Parameters

Position

numeric First (inside) position: 0.

See Also

LineSegmentColor, LineSegmentEnd, LineSegmentSpacing, LineSegmentWidth


LineSegmentEnd

Purpose

Save or cancel changes to a line segment. Precede with LineSegmentCreate or LineSegmentEdit.

Syntax

LineSegmentEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

LineSegmentCreate, LineSegmentEdit


LineSegmentSetUser

Purpose

Begin the sequence that defines a custom line pattern, and specify the number of dashes and spaces in the pattern. Follow with the number of LineSegmentSetUserData commands equal to the number of dashes and spaces specified, and by LineSegmentSetUserEnd.

Syntax

LineSegmentSetUser (OnOffs: numeric)

Parameters

OnOffs

numeric The number of dashes/spaces.

See Also

LineSegmentSetUserData, LineSegmentSetUserEnd, LineSegmentSetWPG2


LineSegmentSetUserData

Purpose

Specify a dash or space length in a custom line pattern. Precede with LineSegmentSetUser and follow with LineSegmentEnd.

Syntax

LineSegmentSetUserData (SegSize: measurement)

Parameters

SegSize

measurement The length of a dash or space.

See Also

LineSegmentSetUser, LineSegmentSetUserEnd, LineSegmentSetWPG2


LineSegmentSetUserEnd

Purpose

End the sequence that defines a custom line pattern.

Syntax

LineSegmentSetUserEnd ()

See Also

LineSegmentSetUser, LineSegmentSetUserData, LineSegmentSetWPG2


LineSegmentSetWPG2

Purpose

Set a line segment pattern to a predefined WPG2 line pattern.

Syntax

LineSegmentSetWPG2 (Style: numeric; LineStyle: enumeration)

Parameters

Style

numeric The pattern set. The only valid entry is 0.

LineStyle

enumeration

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

?LineSegmentWPG2Pattern, LineSegmentSetUser, LineSegmentSetUserData, LineSegmentSetUserEnd


LineSegmentSpacing

Purpose

Specify the distance between lines in a stacked custom line.

Syntax

LineSegmentSpacing (Spacing: measurement)

Parameters

Spacing

measurement

See Also

?LineSegmentSpacing


LineSegmentWidth

Purpose

Set the thickness (width) of a line segment.

Syntax

LineSegmentWidth (Width: measurement)

Parameters

Width

measurement

See Also

?LineSegmentWidth, LineSegmentCreate, LineSegmentEdit, LineSegmentEnd


LineSpacing

Purpose

Specify line spacing for the current and subsequent paragraphs. When recorded, the tenths position is used. When typed, tenths is optional.

Syntax

LineSpacing (Spacing: numeric)

Parameters

Spacing

numeric

See Also

?LineSpacing


LineSpacingDlg

Purpose

Display the Line Spacing dialog box.

Syntax

LineSpacingDlg ()

See Also

LineSpacing


LineStyleCopy

Purpose

Copy a graphics line style.

Syntax

LineStyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; DestName: string)

Parameters

Style

any

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

FromLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration

CurrentDocument!

PersonalLibrary!

SharedLibrary!

DestName

string (optional) The new line name.

See Also

GraphicsLineCreate, GraphicsLineEdit, GraphicsLineEnd


LineStyleCreate

Purpose

Create a graphics line style. Use with LineStyleEdit and LineStyleEnd.

Syntax

LineStyleCreate (Name: string; Library: enumeration)

Parameters

Name

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

LineStyleEnd


LineStyleDelete

Purpose

Delete a user-defined graphics line style. Corel WordPerfect line styles cannot be deleted.

Syntax

LineStyleDelete (Name: any; Library: enumeration)

Parameters

Name

any

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!


LineStyleEdit

Purpose

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

Syntax

LineStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

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)

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Numbering

enumeration (optional) The list numbering mode.

DefFlushRight!

DefNone!

DefFollows!

DefParentheses!

DefLeader!

 

Counter

any (optional)

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

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)

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Numbering

enumeration (optional)

DefFlushRight!

DefNone!

DefFollows!

DefParentheses!

DefLeader!

 

Counter

any (optional)

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

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

ButtonBox!

TableBox!

EquationBox!

TextBox!

FigureBox!

UserBox!

InlineEquationBox!

WatermarkImageBox!

NoBox!

 

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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


MarkList

Purpose

Display the List feature bar.

Syntax

MarkList ()

See Also

MarkListUpdateList


MarkListUpdateList

Purpose

Update the List feature bar.

Syntax

MarkListUpdateList (ListName: string)

Parameters

ListName

string

See Also

MarkList


MarkTableOfAuthorities

Purpose

Display the Table of Authorities feature bar.

Syntax

MarkTableOfAuthorities ()


MarkTableOfContents

Purpose

Display the Table of Contents feature bar.

Syntax

MarkTableOfContents ()


MarkTOAUpdateList

Purpose

Update the Table of Authorities feature bar.

Syntax

MarkTOAUpdateList (ShortForm: string)

Parameters

ShortForm

string The list name in a table of authorities.


MasterDocCondense

Purpose

Condense selected subdocuments and save changes.

Syntax

MasterDocCondense (Filename: string; Action: enumeration)

Parameters

Filename

string (optional)

Action

enumeration

SaveSub!

SkipSub!

See Also

MasterDocCondenseDlg


MasterDocCondenseDlg

Purpose

Display the Condense/Save Subdocuments dialog box.

Syntax

MasterDocCondenseDlg ()

See Also

MasterDocCondense


MasterDocExpand

Purpose

Expand a subdocument. Specify a subdocument with SubDocInclude.

Syntax

MasterDocExpand (Filename: string)

Parameters

Filename

string (optional)


MasterDocSubdocDlg

Purpose

Display the Include Subdocument dialog box.

Syntax

MasterDocSubdocDlg ()


MatchElement

Purpose

Specify that Find and Replace finds a tag that meets certain conditions. The command applies only to searches for specific elements. Begin your search with SpecificSearchStringBegin and end it with SpecificStringEnd. Use SGMLInsertElement to specify which element name you are searching for. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.

Syntax

MatchElement (Attribute: string; Value: string; Type: enumeration; EditAttribute: enumeration)

Parameters

Attribute

string (optional)

Value

string (optional)

Type

enumeration

End!

Start!

EditAttribute

enumeration (optional)

No!

Yes!

See Also

SpecificSearchStringBegin, SpecificStringEnd, SGMLInsertElement


MatchExtendSelection

Purpose

In a Find and Replace search, extend the selected text to include matches that are not in the original selection.

Syntax

MatchExtendSelection ()


MatchFindIfInElements

Purpose

Specify that Find and Replace search only in the specified SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.

Syntax

MatchFindIfInElements (State: enumeration; Action: enumeration; {Element: string; })

Parameters

State

enumeration

No!

Yes!

Action

enumeration (optional) If Action is AnyOrder!, then a match will occur only within any of the specified elements. If Action is ListedOrder!, then the match will occur only within any of the specified elements when the elements are in the order of the element string. For example, if you specify to find a word that is within <TITLE> which is within <titlpage>, a match will not be made if the word is within <TITLE> which is not within <titlpage>.

AnyOrder!

ListedOrder!

Element

string (optional)


MatchLimit

Purpose

Limit a Replace All search to a specified number of occurrences.

Syntax

MatchLimit (State: enumeration; LimitValue: numeric)

Parameters

State

enumeration Limit a Find and Replace search.

No!

Yes!

LimitValue

numeric (optional)


MatchPositionAfter

Purpose

Place the insertion point after matched text in a Find and Replace search.

Syntax

MatchPositionAfter ()

See Also

MatchPositionBefore


MatchPositionBefore

Purpose

Place the insertion point before matched text in a Find and Replace search.

Syntax

MatchPositionBefore ()

See Also

MatchPositionAfter


MatchSelection

Purpose

Select matched text in a Find and Replace search.

Syntax

MatchSelection ()


MatchSkipIfInElements

Purpose

Specify that Find and Replace search all of the document except within the specified SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.

Syntax

MatchSkipIfInElements ({Element: string; })

Parameters

Element

string (optional)


MatchWithAttributes

Purpose

Match only text with specified attributes in a Find and Replace search.

Syntax

MatchWithAttributes (State: enumeration; {Attribute: enumeration; })

Parameters

State

enumeration

No!

Yes!

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

ExtraLarge!

SmallCaps!

Fine!

Strikeout!

Italics!

Subscript!

Large!

Superscript!

Outline!

Underline!

Redline!

VeryLarge!

See Also

MatchWithFont, MatchWithFontSize


MatchWithFont

Purpose

Match only text with specified font attributes in a Find and Replace search.

Syntax

MatchWithFont (State: enumeration; Typeface: string; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)

Parameters

State

enumeration

No!

Yes!

Typeface

string (optional)

Family

enumeration (optional)

FamilyAestheticOrnamented!

FamilyITCZapfDingbats!

FamilyAlbertus!

FamilyLetterGothic!

FamilyBodoni!

FamilyMadrone!

FamilyBroadway!

FamilyMicrostyle!

FamilyBrush!

FamilyOldEnglish!

FamilyCenturySchoolbook!

FamilyOptima!

FamilyComputer!

FamilyParkAvenue!

FamilyCourier!

FamilyPonderosa!

FamilyHelvetica!

FamilyPTBarnum!

FamilyHobo!

FamilyRevue!

FamilyITCBenguiat!

FamilySignetRoundhand!

FamilyITCGaramon!

FamilyTekton!

FamilyITCLubalinGraph!

FamilyTimesRoman!

FamilyITCRonda!

FamilyUncial!

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchNormal!

FontMatchOutline!

FontMatchShadow!

FontMatchSmallCaps!

Weight

enumeration (optional)

WeightBlack!

WeightMaximum!

WeightBold!

WeightMedium!

WeightBook!

WeightRegular!

WeightDemiBold!

WeightRoman!

WeightDemiLight!

WeightSemiBold!

WeightExtraBlack!

WeightSemiLight!

WeightExtraBold!

WeightThin!

WeightExtraHeavy!

WeightUltraBlack!

WeightExtraLight!

WeightUltraHeavy!

WeightExtraThin!

WeightUltraLight!

WeightHeavy!

WeightUltraThin!

WeightLight!

WeightUnknown!

Width

enumeration (optional)

WidthCompressed!

WidthSemiCondensed!

WidthCondensed!

WidthSemiExpanded!

WidthDoubleWide!

WidthTripleWide!

WidthExpanded!

WidthUltraCompressed!

WidthExtraCondensed!

WidthUltraCondensed!

WidthExtraExpanded!

WidthUltraExpanded!

WidthNormal!

WidthUnknown!

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

FontMatchArabic!

FontMatchJapaneseKana!

FontMatchArabicScript!

FontMatchMath!

FontMatchASCII!

FontMatchMathExtension!

FontMatchBoxDrawing!

FontMatchMultinational1!

FontMatchCyrillic!

FontMatchMultinational2!

FontMatchGreek!

FontMatchTypographicSymbols!

FontMatchHebrew!

FontMatchUserDefined!

FontMatchIconicSymbols!

 

See Also

MatchWithAttributes, MatchWithFontSize


MatchWithFontSize

Purpose

Match only text with a specified font size in a Find and Replace search.

Syntax

MatchWithFontSize (State: enumeration; FontSize: measurement)

Parameters

State

enumeration

No!

Yes!

FontSize

measurement (optional)

See Also

MatchWithAttributes, MatchWithFont


MenuAddFeature

Purpose

Add a feature to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddFeature (Menu: string; Name: command name; Offset: numeric)

Parameters

Menu

string

Name

command name

Offset

numeric (optional)


MenuAddMacro

Purpose

Add a macro to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddMacro (Menu: string; Name: string; MacroName: string; Hint: string; Offset: numeric)

Parameters

Menu

string

Name

string

MacroName

string

Hint

string (optional)

Offset

numeric (optional)


MenuAddProgram

Purpose

Add a program to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddProgram (Menu: string; Name: string; ProgramName: string; Hint: string; Offset: numeric)

Parameters

Menu

string

Name

string

ProgramName

string

Hint

string (optional)

Offset

numeric (optional)


MenuAddScript

Purpose

Add a keyboard script to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddScript (Menu: string; Name: string; Script: string; Hint: string; Offset: numeric)

Parameters

Menu

string

Name

string

Script

string

Hint

string (optional)

Offset

numeric (optional)


MenuAddSeparator

Purpose

Add a separator to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddSeparator (Menu: string; Offset: numeric)

Parameters

Menu

string

Offset

numeric (optional)


MenuAddSubMenu

Purpose

Add a submenu to the current Corel WordPerfect menu.

Syntax

boolean := MenuAddSubMenu (Menu: string; Name: string; Hint: string; Offset: numeric)

Parameters

Menu

string

Name

string

Hint

string (optional)

Offset

numeric (optional)


MenuDeleteItemEx

Purpose

Delete an item from the current Corel WordPerfect menu.

Syntax

boolean := MenuDeleteItemEx (Menu: string; Name: string; Offset: numeric)

Parameters

Menu

string

Name

string (optional)

Offset

numeric (optional) This parameter is optional only when you are deleting a feature from a menu. If you want to delete a macro or a program, then this parameter is required.


MenuSelect

Purpose

Choose a menu.

Syntax

MenuSelect (MenuName: string)

Parameters

MenuName

string (optional)

See Also


MenuSelectDlg

Purpose

Display the Menu Bar Settings dialog box.

Syntax

MenuSelectDlg ()

See Also

MenuSelect


MergeAddressBook

Purpose

Specify an address book to associate with the current form file.

Syntax

MergeAddressBook (AddressBook: string)

Parameters

AddressBook

string The name of the address book to associate. If this parameter is left blank, the current association for the form file is removed whether it is associated with an address book or a data file.


MergeAddressBookSaveAs

Purpose

Save address book records as a merge data file.

Syntax

MergeAddressBookSaveAs (OutputFile: string; AddressBook: string)

Parameters

OutputFile

string The path and filename of the new merge data file.

AddressBook

string (optional) The address book to save as a merge data file. If this parameter is blank, the currently selected records are used; if not, all records in the specified address book are used. Address book selections can include records from multiple address books.


MergeBlankField

Purpose

Leave or remove a blank field. If blank fields are removed, the remaining fields shift up one line.

Syntax

MergeBlankField (State: enumeration)

Parameters

State

enumeration

Leave!

Remove!


MergeCode

Purpose

Insert a merge code.

Syntax

MergeCode (Codes: enumeration; String: string)

Parameters

Codes

enumeration

Assign!

Keyboard!

AssignLocal!

Label!

Beep!

Look!

Break!

MrgCmnd!

Call!

NestData!

CancelOff!

NestForm!

CancelOn!

NestMacro!

Caps!

Next!

CaseOf!

NextRecord!

ChainData!

NtoC!

ChainForm!

OnCancel!

ChainMacro!

OnError!

Char!

PageOff!

Codes!

PageOn!

Comment!

PostNet!

Continue!

Print!Macro List Text = ProcessOff!

CtoN!

ProcessOn!

Date!

Prompt!

Default!

Quit!

DisplayStop!

RepeatRow!

Document!

Return!

Else!

ReturnCancel!

EmbedMacro!

ReturnError!

EndField!

Rewrite!

EndFor!

StatusPrompt!

EndIf!

StepOff!

EndRecord!

StepOn!

EndSwitch!

Stop!

EndWhile!

StrLen!

Field!

StrPos!

FieldNames!

SubstData!

FirstCap!

SubstForm!

ForEach!

SubStr!

ForNext!

Switch!

GetString!

System!

Go!

ToLower!

If!

ToUpper!

IfBlank!

Variable!

IfExists!

Wait!

IfNotBlank!

While!

Insert!

 

String

string (optional) The field parameters.


MergeCodesDisplayEdit

Purpose

Display or hide merge codes, or display them as markers.

Syntax

MergeCodesDisplayEdit (Display: enumeration)

Parameters

Display

enumeration

Hide!

Marker!

Show!

See Also

MergeCodesDisplayRun


MergeCodesDisplayRun

Purpose

Display or hide merge codes, or display them as markers in a merged document.

Syntax

MergeCodesDisplayRun (Display: enumeration)

Parameters

Display

enumeration

Hide!

Marker!

Show!

See Also

MergeCodesDisplayEdit


MergeCodesDlg

Purpose

Display the Insert Merge Codes dialog box.

Syntax

MergeCodesDlg ()


MergeCondition

Purpose

Define a condition to select records from a data file.

Syntax

MergeCondition (Condition1: string; Condition2: string; Condition3: string; Condition4: string; Condition5: string; Condition6: string; Condition7: string; Condition8: string; Condition9: string; Condition10: string; Condition11: string; Condition12: string; Condition13: string; Condition14: string; Condition15: string)

Parameters

Condition1

string (optional)

Condition2

string (optional)

Condition3

string (optional)

Condition4

string (optional)

Condition5

string (optional)

Condition6

string (optional)

Condition7

string (optional)

Condition8

string (optional)

Condition9

string (optional)

Condition10

string (optional)

Condition11

string (optional)

Condition12

string (optional)

Condition13

string (optional)

Condition14

string (optional)

Condition15

string (optional)


MergeDataFile

Purpose

Specify the data file to associate with a form file.

Syntax

MergeDataFile (DataFile: string)

Parameters

DataFile

string (optional)

See Also

SortAction, SortType


MergeDlg

Purpose

Display the Merge dialog box.

Syntax

MergeDlg ()


MergeEndField

Purpose

Insert an [ENDFIELD] code at the insertion point. Recordable substitute: MergeCode.

Syntax

MergeEndField ()


MergeEndRecord

Purpose

Insert an [ENDRECORD] code at the insertion point. Recordable substitute: MergeCode.

Syntax

MergeEndRecord ()


MergeEnvelope

Purpose

Create an envelope for merged records.

Syntax

MergeEnvelope (State: enumeration)

Parameters

State

enumeration

Off!

On!


MergeEnvelopeDefinitionBegin

Purpose

Begin a MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. Contains address information.

Syntax

MergeEnvelopeDefinitionBegin ()

See Also

MergeEnvelope, MergeEnvelopeDefinitionEnd


MergeEnvelopeDefinitionEnd

Purpose

End a merge envelope definition. Precede with MergeEnvelopeDefinitionBegin.

Syntax

MergeEnvelopeDefinitionEnd ()

See Also

MergeEnvelope, MergeEnvelopeDefinitionBegin


MergeFileAssociate

Purpose

Associate form and data files. MergeDataFile creates a recordable association.

Syntax

MergeFileAssociate (FormFile: string; DataFile: string)

Parameters

FormFile

string

DataFile

string (optional)


MergeFileAssociateAddressBook

Purpose

Associate a form file with an address book data source. This command also removes a data file association from the form file, if such an association exists.

Syntax

MergeFileAssociateAddressBook (FormFile: string; AddressBook: string)

Parameters

FormFile

string The path and filename of the form file to associate with the address book.

AddressBook

string (optional) The name of the address book to use as a data source for the form file. If this is blank, all associations will be removed.


MergeFileAssociateODBC

Purpose

Associate a form file with an ODBC data source and table.

Syntax

MergeFileAssociateODBC (FormFile: string; DataSource: string; TableName: string)

Parameters

FormFile

string

DataSource

string (optional)

TableName

string (optional)


MergeFilesDlg

Purpose

Display the Perform Merge dialog box.

Syntax

MergeFilesDlg ()


MergeFileType

Purpose

Specify the file type to merge.

Syntax

MergeFileType (FileType: enumeration)

Parameters

FileType

enumeration

Form!

None!

TableData!

TextData!


MergeFormDlg

Purpose

Display the Create Merge File dialog box.

Syntax

MergeFormDlg ()


MergeMark

Purpose

Mark a record to include in a merge.

Syntax

MergeMark (RecordNum: numeric)

Parameters

RecordNum

numeric A record number.


MergeODBC

Purpose

Specify an ODBC data source and table to associate with the current form file.

Syntax

MergeODBC (DataSource: string; TableName: string)

Parameters

DataSource

string

TableName

string


MergePageBreak

Purpose

Separate merged documents with a page break.

Syntax

MergePageBreak (State: enumeration)

Parameters

State

enumeration

Off!

On!


MergePrintText

Purpose

Print a data file without page breaks between the records.

Syntax

MergePrintText ()

See Also

MergeFileType


MergeRepeat

Purpose

Specify the number of times to merge each record.

Syntax

MergeRepeat (NumberToRepeat: numeric)

Parameters

NumberToRepeat

numeric


MergeRun

Purpose

Merge a form file and a data file.

Syntax

MergeRun (FormFileType: enumeration; FormFile: string; DataFileType: enumeration; DataFile: string; OutputFileType: enumeration; OutputFile: string; AddressBook: string; EmailAddress: string; SubjectLine: string; DataSource: string; TableName: string)

Parameters

FormFileType

enumeration

Clipboard!

Current!

FormFile!

FormFile

string (optional)

DataFileType

enumeration If this parameter is set to AddressBook!, the DataFile parameter is ignored.

AddressBook!

Clipboard!

DataFile!

NoData!

ODBC!

DataFile

string (optional)

OutputFileType

enumeration

ToCurrentDoc!

ToEMail!

ToFile!

ToNewDoc!

ToPrinter!

OutputFile

string (optional) Merge the output file when OutputFileType parameter is ToFile!.

AddressBook

string (optional) The name of the address book to use as the data source for the merge. This parameter is ignored if the DataFileType parameter is not set to AddressBook! If the Address Book parameter is set to AddressBook! and this parameter is left blank, the currently selected address book records are used as the data source for the merge.

EmailAddress

string (optional)

SubjectLine

string (optional)

DataSource

string (optional)

TableName

string (optional)


MergeSelect

Purpose

Specify the records to merge.

Syntax

MergeSelect (SelectType: enumeration; Begin: numeric; End: numeric)

Parameters

SelectType

enumeration If the data source for the merge is an Address Book, use the All! enumeration.

All!

Marked!

Range!

Begin

numeric (optional) The low end of a range.

End

numeric (optional) The high end of a range.

See Also

MergeMark


MergeTableDataDlg

Purpose

Display the Create Data File dialog box.

Syntax

MergeTableDataDlg ()


MergeTextDataDlg

Purpose

Display the Create Merge File dialog box.

Syntax

MergeTextDataDlg ()


MinusSign

Purpose

Insert a minus sign (hyphen character) at the insertion point.

Syntax

MinusSign ()


MoveModeEnd

Purpose

End the command sequence to move text.

Syntax

MoveModeEnd ()


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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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.

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

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


PageBorderDlg

Purpose

Display the Page Border/Fill dialog box.

Syntax

PageBorderDlg ()

See Also

?PageBorder, FancyPageBorder


PageNumber

Purpose

Specify a new page number for the current page.

Syntax

PageNumber (Page: numeric)

Parameters

Page

numeric

See Also

?PageNumberingOn, PageNumberDisplay


PageNumberDecrement

Purpose

Decrease the current page number by one.

Syntax

PageNumberDecrement ()

See Also

PageNumberIncrement


PageNumberDisplay

Purpose

Insert the current page number at the insertion point.

Syntax

PageNumberDisplay ()

See Also

PageNumberDisplayFormat


PageNumberDisplayFormat

Purpose

Display a formatted page number at the insertion point in the current document window.

Syntax

PageNumberDisplayFormat ()

See Also

PageNumberDisplay, PageNumberFormat


PageNumberFormat

Purpose

Specify a page number format including text, page, total page, chapter, volume, or secondary page numbers.

Syntax

PageNumberFormat (Format: string)

Parameters

Format

string Combine macro function codes and text to create a page number format.

See Also

?PageNumberFormat, PageNumberDisplayFormat


PageNumberIncrement

Purpose

Increase the current page number by one.

Syntax

PageNumberIncrement ()

See Also

PageNumberDecrement


PageNumberingAdjustDlg

Purpose

Display the Value/Adjust Number dialog box.

Syntax

PageNumberingAdjustDlg ()


PageNumberingCountDlg

Purpose

Display the Page Count for Total Pages dialog box. Displaying this dialog box also updates the total page count.

Syntax

PageNumberingCountDlg ()


PageNumberingDlg

Purpose

Display the Select Page Numbering Format dialog box.

Syntax

PageNumberingDlg ()


PageNumberingInsertDlg

Purpose

Display the Insert Number in Text dialog box.

Syntax

PageNumberingInsertDlg ()


PageNumberMethod

Purpose

Specify a page numbering method.

Syntax

PageNumberMethod (Method: enumeration)

Parameters

Method

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

?PageNumberMethod, ?ParagraphNumberMethod


PageNumberPosition

Purpose

Specify the position and appearance of page numbering. Use Font, Color, Shade, and Attributes parameters only if the Default parameter is DontUseDefaultValues!.

Syntax

PageNumberPosition (Position: enumeration; Default: enumeration; Font: string; FontSize: measurement; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric; {Attributes: enumeration; })

Parameters

Position

enumeration

BottomAlternating!

BottomCenter!

BottomLeft!

BottomRight!

InsideTopAlternating!

None!

OutsideBottomAlternating!

TopAlternating!

TopCenter!

TopLeft!

TopRight!

Default

enumeration

DontUseDefaultValues!

UseDefaultValues!

Font

string (optional)

FontSize

measurement (optional)

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

Attributes

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

?PageNumberPosition


PageNumberSettingsDlg

Purpose

Display the Numbering Value dialog box.

Syntax

PageNumberSettingsDlg ()


PageSetupDlg

Purpose

Display the Page Setup dialog box.

Syntax

PageSetupDlg ()


PageSuppressDlg

Purpose

Display the Suppress dialog box.

Syntax

PageSuppressDlg ()

See Also

?PageSuppress


PageZoomFull

Purpose

Display Page view, then zoom the current page to Full Page.

Syntax

PageZoomFull ()

See Also

DisplayZoom, ZoomToFullPage


PaneNext

Purpose

Move the focus to the next pane in the Equation Editor.

Syntax

PaneNext ()

See Also

PanePrevious


PanePrevious

Purpose

Move the focus to the previous pane in the Equation Editor.

Syntax

PanePrevious ()

See Also

PaneNext


PaperSizeAdd

Purpose

Create a page definition for the Page Size dialog box. Use address position parameters if the Type parameter is Envelope!.

Syntax

PaperSizeAdd (Name: string; Width: measurement; Length: measurement; WidthAdjust: measurement; LengthAdjust: measurement; Flags: enumeration; Location: enumeration; Type: enumeration; Use: enumeration; ReturnAddressHoriz: measurement; ReturnAddressVert: measurement; MailingAddressHoriz: measurement; MailingAddressVert: measurement)

Parameters

Name

string Use if the Type parameter is Other!.

Width

measurement

Length

measurement

WidthAdjust

measurement Move the page contents left (positive value) or right (negative value).

LengthAdjust

measurement Move the page contents up (positive value) or down (negative value).

Flags

enumeration

FormCurrentlyLoaded!

Landscape!

LandscapeLoaded!

LandscapePrimaryLoaded!

Portrait!

PortraitLoaded!

PortraitPrimaryLoaded!

PrimaryForm!

Location

enumeration The printer paper feed.

Continuous!

Manual!

Type

enumeration

AllOthers!

Bond!

CardStock!

ClayBased!

Envelope!

Glossy!

Labels!

Letterhead!

Other!

Standard!

Transparency!

Use

enumeration (optional)

Europe!

Japan!

Latin_America!

None!

US!

ReturnAddressHoriz

measurement (optional)

ReturnAddressVert

measurement (optional)

MailingAddressHoriz

measurement (optional)

MailingAddressVert

measurement (optional)

See Also

?PaperSizeType, Binding, LabelsDefine, PaperSizeDelete, PaperSizeResave, PaperSizeSelect


PaperSizeDelete

Purpose

Delete a page definition.

Syntax

PaperSizeDelete (Name: string)

Parameters

Name

string

See Also

?CurrentPaperName, PaperSizeAdd, PaperSizeDlg


PaperSizeDlg

Purpose

Display the Page Size dialog box.

Syntax

PaperSizeDlg ()

See Also

?CurrentPaperName, ?PaperSizeType, PaperSizeAdd, PaperSizeDelete, PaperSizeResave


PaperSizeResave

Purpose

Edit and save a page definition from the Page Size dialog box. Use address position parameters if the Type parameter is Envelope!.

Syntax

PaperSizeResave (OldName: string; NewName: string; Width: measurement; Length: measurement; WidthAdjustment: measurement; LengthAdjustment: measurement; Flags: enumeration; Location: enumeration; Type: enumeration; Use: enumeration; ReturnAddressHoriz: measurement; ReturnAddressVert: measurement; MailingAddressHoriz: measurement; MailingAddressVert: measurement)

Parameters

OldName

string

NewName

string

Width

measurement

Length

measurement

WidthAdjustment

measurement Move the page contents right (positive value) or left (negative value).

LengthAdjustment

measurement Move the page contents up (positive value) or down (negative value).

Flags

enumeration Specify the orientation.

FormCurrentlyLoaded!

Landscape!

LandscapeLoaded!

LandscapePrimaryLoaded!

Portrait!

PortraitLoaded!

PortraitPrimaryLoaded!

PrimaryForm!

Location

enumeration The printer paper feed.

Continuous!

Manual!

Type

enumeration

AllOthers!

Bond!

CardStock!

ClayBased!

Envelope!

Glossy!

Labels!

Letterhead!

Other!

Standard!

Transparency!

Use

enumeration

Europe!

Japan!

Latin_America!

None!

US!

ReturnAddressHoriz

measurement

ReturnAddressVert

measurement

MailingAddressHoriz

measurement

MailingAddressVert

measurement

See Also

?CurrentPaperName, PaperSizeAdd, PaperSizeDelete


PaperSizeSelect

Purpose

Specify a page size for the current document.

Syntax

PaperSizeSelect (Name: string; Width: measurement; Height: measurement; Type: enumeration)

Parameters

Name

string The name of a paper definition.

Width

measurement (optional)

Height

measurement (optional)

Type

enumeration (optional)

Bond!

Cardstock!

ClayBased!

Envelope!

Glossy!

Labels!

Letterhead!

Other!

Standard!

Transparency!

See Also

?CurrentPaperName, PaperSizeAdd, PaperSizeDelete, PaperSizeResave


ParagraphBorderDlg

Purpose

Display the Paragraph Border/Fill dialog box.

Syntax

ParagraphBorderDlg ()

See Also

?ParagraphBorder


ParagraphBreakShippingMacro

Purpose

Play the shipping macro PARABRK.WCM to display the Paragraph Breaks dialog box, where graphical paragraph break markers can be edited and selected to insert after the next [HRt]. PARABRK.WCM must be installed.

Syntax

ParagraphBreakShippingMacro ()


ParagraphDown

Purpose

Move the insertion point to the beginning of the next paragraph (after [HRt] or [HRt]). Recordable substitute: PosParagraphNext.

Syntax

ParagraphDown ()

See Also

ParagraphUp, PosParagraphNext


ParagraphFormatDlg

Purpose

Display the Paragraph Format dialog box.

Syntax

ParagraphFormatDlg ()


ParagraphHangingIndent

Purpose

Align the first line of a paragraph with the left margin and indent the remaining lines to the next tab stop.

Syntax

ParagraphHangingIndent ()


ParagraphNumberDefDlg

Purpose

Display the Change Outline Level dialog box.

Syntax

ParagraphNumberDefDlg ()

See Also

?ParagraphNumber, ?ParagraphNumberMethod


ParagraphSetNumber

Purpose

Specify the level and starting value for paragraph numbering.

Syntax

ParagraphSetNumber (Level: numeric; StartValue: numeric)

Parameters

Level

numeric

StartValue

numeric

See Also

?ParagraphNumber, ?ParagraphNumberMethod


ParagraphSpacing

Purpose

Specify the spacing between paragraphs. Default: font point size plus two points.

Syntax

ParagraphSpacing (AmtSpc: numeric)

Parameters

AmtSpc

numeric Default: 1.0.

See Also

?SpacingBelowPar


ParagraphUp

Purpose

Move the insertion point to the beginning of the previous paragraph. Recordable substitute: PosParagraphPrevious.

Syntax

ParagraphUp ()

See Also

ParagraphDown, PosParagraphPrevious


Paste

Purpose

Paste the Clipboard contents at the insertion point.

Syntax

Paste ()

See Also

Copy, CopyAndPaste, Cut


PasteLink

Purpose

Insert an object from the Clipboard into the current document, thus creating a link with the server application that created the object.

Syntax

PasteLink (FormatName: string; FormatId: numeric; LinkType: enumeration)

Parameters

FormatName

string The format of the linked object. Consult your server application's documentation for a valid format name.

FormatId

numeric The identification number of the format of the linked object. Consult your server application's documentation for a valid format ID.

LinkType

enumeration

Dde!

Ole!

See Also

Paste


PauseCommand

Purpose

Pause a macro until a specified macro command is executed. For example, Enter executes the HardReturn command. PauseCommand does not prompt the user to press a key, so it is often used with PROMPT.

Syntax

PauseCommand (Token: command name)

Parameters

Token

command name

See Also

MacroPause, PauseKey


PauseKey

Purpose

Pause a macro until a specified key or character is pressed.

Syntax

PauseKey (Key: enumeration; Character: string)

Parameters

Key

enumeration The key to resume macro execution. Default: Enter!. Any! resumes when any key is pressed, including Backspace, Delete, and Ctrl+Enter.

Any!

Cancel!

Character!

Close!

Enter!

Character

string (optional) The case-sensitive character that resumes macro execution when pressed. Use if the Key parameter is Character!.

See Also

?PauseKey, MacroPause, PauseCommand


PauseSet

Purpose

Specify a command to replace a [HRt] that ends a PAUSE command.

Syntax

PauseSet (Token: command name)

Parameters

Token

command name A command to resume a paused macro. Usually represents a keystroke.

See Also

MacroPause, PauseKey, PauseSet


PerfectExpert

Purpose

Open the User Assistant.

Syntax

PerfectExpert ()


PersonalInfoDlg

Purpose

Display the Corel Address Book with the personal information record selected. If the personal information has not been previously specified, the first record in the current address book is selected.

Syntax

boolean := PersonalInfoDlg ()

See Also

AddressBookDlg


PersonalInfoFormatAddr

Purpose

Return the personal information stored in the address book using the specified format.

Syntax

string := PersonalInfoFormatAddr (Format: string)

Parameters

Format

string The format specification used when returning the personal information. Use AddressBookFormatGetFormat or AddressBookFormatGetCurrent to retrieve an address format specification.

See Also

PersonalInfoDlg, AddressBookSelectionFormatAddr, AddressBookFormatAdd, AddressBookFormatGetFormat, AddressBookFormatGetCurrent


PersonalInfoGetField

Purpose

Return the value of a field from the current personal information stored in the address book.

Syntax

string := PersonalInfoGetField (Field: any)

Parameters

Field

any If this parameter is a number, the command will try to return the value of the field with that code number. If this parameter is a string, the command will try to return the value of the field with that name.

See Also

AddressBookSelectionGetField


PlayClipBoardShippingMacro

Purpose

Play the shipping macro READCLP.WCM to speak Clipboard text. READCLP.WCM must be installed. ProVoice or Monologue text-to-speech software is required.

Syntax

PlayClipBoardShippingMacro ()


PlayFileShippingMacro

Purpose

Play the shipping macro READFILE.WCM to speak a text file or play a .WAV, .AVI, or .MID file. READFILE.WCM must be installed. ProVoice or Monologue text-to-speech software is required.

Syntax

PlayFileShippingMacro ()


PlaySelectionShippingMacro

Purpose

Play the shipping macro READSEL.WCM to speak selected text. Not recordable. READSEL.WCM must be installed. ProVoice or Monologue text-to-speech software is required.

Syntax

PlaySelectionShippingMacro ()


PleadingShippingMacro

Purpose

Play the shipping macro PLEADING.WCM to display the Pleading Paper dialog box, in which you specify and generate pleading options. PLEADING.WCM must be installed.

Syntax

PleadingShippingMacro ()


PosBlockBeg

Purpose

Move the insertion point to the beginning of the selected text, then deselect the text. Included for DOS compatibility. Windows equivalent: PosSelectTop.

Syntax

PosBlockBeg ()

See Also

PosBlockBottom, PosBlockTop, PosSelectTop


PosBlockBottom

Purpose

Move the insertion point to the bottom of the selected text. Included for DOS compatibility. Windows equivalent: PosSelectBottom.

Syntax

PosBlockBottom ()

See Also

PosBlockBeg, PosBlockTop, PosSelectBottom


PosBlockTop

Purpose

Move the insertion point to the top of the selected text. Included for DOS compatibility. Windows equivalent: PosSelectTop.

Syntax

PosBlockTop ()

See Also

PosBlockBeg, PosBlockBottom, PosSelectTop


PosCellDown

Purpose

Move the insertion point down one row. Recordable equivalent: PosTableCellDown.

Syntax

PosCellDown ()

See Also

PosTableCellDown


PosCellNext

Purpose

Move the insertion point to the beginning of the next cell in the current table. If the insertion point is in the last cell of a table, the insertion point is moved to the beginning of that cell. Recordable equivalent: PosTableTopCellNext.

Syntax

PosCellNext ()

See Also

PosTableCellNext


PosCellPrevious

Purpose

Move the insertion point to the beginning of the previous cell in the current table. If the insertion point is in the first cell of a table, the insertion point is moved to the beginning of that cell. Recordable equivalent: PosTableCellPrevious.

Syntax

PosCellPrevious ()

See Also

PosTableCellPrevious


PosCellUp

Purpose

Move the insertion point up one cell. Recordable equivalent: PosTableCellUp.

Syntax

PosCellUp ()

See Also

PosTableCellUp


PosCharacter

Purpose

Move the insertion point forward to a specified character. Maximum forward movement is 2,000 characters. Case sensitive. If the specified character is not found, this command does nothing. Not recordable.

Syntax

PosCharacter (CharToMoveTo: string)

Parameters

CharToMoveTo

string The single search character.

See Also

PosCharNext, PosCharPrevious


PosCharNext

Purpose

Move the insertion point to the next character to the right.

Syntax

PosCharNext ()

See Also

PosCharacter, PosCharPrevious


PosCharPrevious

Purpose

Move the insertion point to the previous character.

Syntax

PosCharPrevious ()

See Also

PosCharacter, PosCharNext


PosColBottom

Purpose

Move the insertion point to the beginning of the last line before a page break. Move to the end of the document if there is no page breaks. In columns, move the insertion point to the beginning of the last line of the column. In tables, move to the beginning of the last line of the last cell in the current column that contains data.

Syntax

PosColBottom ()

See Also

PosColTop


PosColFirst

Purpose

Move the insertion point to the beginning of the line. In columns, move the insertion point to the beginning of the line in the first column. In tables, no effect.

Syntax

PosColFirst ()

See Also

PosColLast


PosColLast

Purpose

Move the insertion point to the beginning of the current line. In columns, move the insertion point to the beginning of the current line in the last column. In tables, this command has no effect.

Syntax

PosColLast ()

See Also

PosColFirst


PosColNext

Purpose

Move the insertion point to the beginning of the current line in the next column or to the current line in the current row of the next table column.

Syntax

PosColNext ()

See Also

PosColPrevious


PosColPrevious

Purpose

Move the insertion point to the beginning of the current line in the previous column or to the beginning of the current row and line in the previous table column.

Syntax

PosColPrevious ()

See Also

PosColNext


PosColTop

Purpose

In columns, move the insertion point to the beginning of the current column. In tables, move to the beginning of the current row in the previous column. If there are multiple lines in the current cell, move the insertion point to the beginning of the previous line in the current cell. In regular (non-column) text, move the insertion point to the beginning of the previous line.

Syntax

PosColTop ()

See Also

PosColBottom


PosDocBottom

Purpose

Move the insertion point to the end of the document, after all codes.

Syntax

PosDocBottom ()

See Also

PosDocTop


PosDocTop

Purpose

Move the insertion point to the beginning of the document, after any initial codes.

Syntax

PosDocTop ()

See Also

PosDocBottom, PosDocVeryTop


PosDocVeryTop

Purpose

Move the insertion point to the beginning of a document, before any codes.

Syntax

PosDocVeryTop ()

See Also

PosDocTop


PosFunction

Purpose

Move the insertion point to the right of the next occurrence of the code specified in the Function parameter.

Syntax

PosFunction (Function: enumeration)

Parameters

Function

enumeration

CancelHyphenation!

HardEndOfLine!

HardHyphen!

HardSpace!

SoftEndOfLine!

Tab!

See Also

PosCharacter


PosGoPrevious

Purpose

Move the insertion point to its previous position.

Syntax

PosGoPrevious ()

See Also

PosGoToDlg


PosGoToDlg

Purpose

Display the Go To dialog box.

Syntax

PosGoToDlg ()

See Also

PosGoPrevious


PosLineBeg

Purpose

Move the insertion point to the beginning of the current line.

Syntax

PosLineBeg ()

See Also

?Position, PosLineDown, PosLineEnd, PosLineUp, PosLineVeryBeg, PosLineVeryEnd


PosLineDown

Purpose

Move the insertion point down one line.

Syntax

PosLineDown ()

See Also

?Position, PosLineBeg, PosLineEnd, PosLineUp, PosLineVeryBeg, PosLineVeryEnd


PosLineEnd

Purpose

Move the insertion point to the end of the current line.

Syntax

PosLineEnd ()

See Also

?Position, PosLineBeg, PosLineDown, PosLineUp, PosLineVeryBeg, PosLineVeryEnd


PosLineUp

Purpose

Move the insertion point up one line.

Syntax

PosLineUp ()

See Also

?Position, PosLineBeg, PosLineDown, PosLineEnd, PosLineVeryBeg, PosLineVeryEnd


PosLineVeryBeg

Purpose

Move the insertion point to the beginning of a line, before codes.

Syntax

PosLineVeryBeg ()

See Also

?Position, PosLineBeg, PosLineDown, PosLineEnd, PosLineUp, PosLineVeryEnd


PosLineVeryEnd

Purpose

Move the insertion point to the end of the current line after codes, except [HRt] and [SRt].

Syntax

PosLineVeryEnd ()

See Also

?Position, PosLineBeg, PosLineDown, PosLineEnd, PosLineUp, PosLineVeryBeg


PosPage

Purpose

Move the insertion point to a specified page.

Syntax

PosPage (Volume: enumeration; Chapter: enumeration; Page: enumeration; Direction: enumeration)

Parameters

Volume

enumeration

NoneSpecified!

Chapter

enumeration

NoneSpecified!

Page

enumeration

NoneSpecified!

Direction

enumeration (optional)

Down!

Up!

See Also

PosGoToDlg


PosPageBottom

Purpose

Move the insertion point to the beginning of the last line on the current page. On the last page of a document, move to the end of the last line.

Syntax

PosPageBottom ()

See Also

PosPageNext, PosPagePrevious, PosPageTop


PosPageNext

Purpose

Move the insertion point to the beginning of the next page. On the last page of the document, move to the end.

Syntax

PosPageNext ()

See Also

PosPageBottom, PosPagePrevious, PosPageTop


PosPagePrevious

Purpose

Move the insertion point to the beginning of the previous page. On the first page of the document, move to the top of the page.

Syntax

PosPagePrevious ()

See Also

PosPageBottom, PosPageNext, PosPageTop


PosPageTop

Purpose

Move the insertion point to the beginning of the current page. In columns, move to the beginning of the current column.

Syntax

PosPageTop ()

See Also

PosPageBottom, PosPageNext, PosPagePrevious


PosParagraphNext

Purpose

Move the insertion point to the beginning of the next paragraph. In the last paragraph of a document, move to the end.

Syntax

PosParagraphNext ()

See Also

PosParagraphPrevious


PosParagraphPrevious

Purpose

Move the insertion point to the beginning of the current paragraph. At the beginning of a paragraph, move to the beginning of the previous paragraph.

Syntax

PosParagraphPrevious ()

See Also

PosParagraphNext


PosScreenDown

Purpose

Move the insertion point to the bottom of the screen, then down one screen at a time with each repetition of the command.

Syntax

PosScreenDown ()

See Also

PosScreenLeft, PosScreenRight, PosScreenUp, SelectScreenDown


PosScreenLeft

Purpose

Move the insertion point to the left edge of the screen, then left one screen at a time with each repetition of the command.

Syntax

PosScreenLeft ()

See Also

PosScreenDown, PosScreenRight, PosScreenUp, SelectScreenLeft


PosScreenRight

Purpose

Move the insertion point to the right edge of the screen, then right one screen at a time with each repetition of the command.

Syntax

PosScreenRight ()

See Also

PosScreenDown, PosScreenLeft, PosScreenUp, SelectScreenRight


PosScreenUp

Purpose

Move the insertion point to the top of the screen, then up one screen at a time with each repetition of the command.

Syntax

PosScreenUp ()

See Also

PosScreenDown, PosScreenLeft, PosScreenRight, SelectScreenUp


PosSelectBottom

Purpose

Move the insertion point to the end of the selected text.

Syntax

PosSelectBottom ()

See Also

PosSelectTop


PosSelectTop

Purpose

Move the insertion point to the beginning of selected text.

Syntax

PosSelectTop ()

See Also

PosSelectBottom


PosTableBegin

Purpose

Move the insertion point to the first cell of a table.

Syntax

PosTableBegin ()

See Also

PosTableEnd, PosTableRowBegin


PosTableBlockBeg

Purpose

Deselect all selected table cells except the first cell in the selection.

Syntax

PosTableBlockBeg ()

See Also

PosTableEnd


PosTableCell

Purpose

Move the insertion point to a specified cell.

Syntax

PosTableCell (Cell: string)

Parameters

Cell

string


PosTableCellBottom

Purpose

Move the insertion point to the beginning of the last line in a cell.

Syntax

PosTableCellBottom ()

See Also

PosTableCellTop


PosTableCellDown

Purpose

Move the insertion point down one table row to the beginning of the first line in the cell.

Syntax

PosTableCellDown ()

See Also

PosTableCellUp


PosTableCellNext

Purpose

Move the insertion point to the beginning of the next cell.

Syntax

PosTableCellNext ()

See Also

PosTableCellPrevious


PosTableCellPrevious

Purpose

Move the insertion point to the beginning of the previous cell. If there are two or more lines in the current cell but only one line in the previous cell, move to the beginning of the previous cell. If there are one or more lines in both the current and previous cells, move to the beginning of the current line in the previous cell.

Syntax

PosTableCellPrevious ()

See Also

PosTableCellNext


PosTableCellTop

Purpose

Move the insertion point to the beginning of the cell.

Syntax

PosTableCellTop ()

See Also

PosTableCellBottom


PosTableCellUp

Purpose

Move the insertion point up one table cell.

Syntax

PosTableCellUp ()

See Also

PosTableCellDown


PosTableColBottom

Purpose

Move the insertion point to the beginning of the last cell in the current column. If select mode is on, the selection is extended.

Syntax

PosTableColBottom ()

See Also

PosTableColumnBottom


PosTableColumnBottom

Purpose

Move the insertion point to the beginning of the last cell in the current column. If select mode is on, select mode is turned off before the insertion point moves.

Syntax

PosTableColumnBottom ()

See Also

PosTableColumnTop


PosTableColumnTop

Purpose

Move the insertion point to the beginning of the table column.

Syntax

PosTableColumnTop ()

See Also

PosTableColumnBottom


PosTableEnd

Purpose

Move the insertion point to the beginning of the last table cell.

Syntax

PosTableEnd ()

See Also

PosTableBegin, PosTableRowBegin, PosTableRowEnd


PosTableGoPrevious

Purpose

Return the insertion point to its previous position in a table.

Syntax

PosTableGoPrevious ()


PosTableRowBegin

Purpose

Move the insertion point to the beginning of the current row.

Syntax

PosTableRowBegin ()

See Also

PosTableBegin, PosTableRowEnd


PosTableRowEnd

Purpose

Move the insertion point to the beginning of the last cell in the row.

Syntax

PosTableRowEnd ()

See Also

PosTableEnd, PosTableRowBegin


PosTableScreenDown

Purpose

Move the insertion point to the beginning of the last complete cell of the current column in the current screen, and down one screen with each repetition of the command.

Syntax

PosTableScreenDown ()

See Also

PosTableScreenLeft, PosTableScreenRight, PosTableScreenUp


PosTableScreenLeft

Purpose

Move the insertion point to the beginning of the first complete cell in the row, and left one screen at a time with each repetition.

Syntax

PosTableScreenLeft ()

See Also

PosTableScreenDown, PosTableScreenRight, PosTableScreenUp


PosTableScreenRight

Purpose

Move the insertion point to the beginning of the last complete table cell of the row in the current screen, and right one screen at a time with each repetition.

Syntax

PosTableScreenRight ()

See Also

PosTableScreenDown, PosTableScreenLeft, PosTableScreenUp


PosTableScreenUp

Purpose

Move the insertion point to the beginning of first table cell of the screen in a table, and up one screen with each repetition.

Syntax

PosTableScreenUp ()

See Also

PosTableScreenDown, PosTableScreenLeft, PosTableScreenRight


PosTableTopCellNext

Purpose

Move the insertion point to the beginning of the next cell. If the cells contain two or more lines, move to the beginning of the current line in the next cell. If the insertion point is in the last cell of a table, a new table row is created at the bottom of the table.

Syntax

PosTableTopCellNext ()

See Also

PosTableTopCellPrevious


PosTableTopCellPrevious

Purpose

Move the insertion point to the top of the previous table cell.

Syntax

PosTableTopCellPrevious ()

See Also

PosTableTopCellNext


PosWordNext

Purpose

Move the insertion point to the beginning of the next word. Words separated by two hyphens or an em dash are treated as one word.

Syntax

PosWordNext ()

See Also

PosCellNext, PosColNext, PosPageNext, PosWordPrevious


PosWordPrevious

Purpose

Move the insertion point to the beginning of the previous word. If the insertion point is located within a word, the insertion point is moved to the beginning of the current word. Words separated by two hyphens or an em dash are treated as one word.

Syntax

PosWordPrevious ()

See Also

PosCellPrevious, PosColPrevious, PosPagePrevious, PosWordNext


PowerBarEditDlg

Purpose

Display the Toolbar Editor - Power Bar dialog box.

Syntax

PowerBarEditDlg ()

See Also

ButtonBarEditDlg, PrefPowerBarEdit


PowerBarOptionsDlg

Purpose

Display the Power Bar Options dialog box.

Syntax

PowerBarOptionsDlg ()

See Also

ButtonBarOptionsDlg, PrefPowerBar, PrefPowerBarEdit


PowerBarShow

Purpose

Display (On!) or hide (Off!) the Power Bar. If no parameter is specified, this command toggles the Power Bar display.

Syntax

PowerBarShow (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

?PowerBarActive, ViewToolbarsDlg


PowerTableNumericFormat

Purpose

Change the number format of a cell.

Syntax

PowerTableNumericFormat ()

See Also

TableNumberFormat


PrefApplicationBarEdit

Purpose

Edit the Application Bar by adding or removing items.

Syntax

PrefApplicationBarEdit (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


PrefBackupPath

Purpose

Specify the document backup directory and whether to update the QuickList.

Syntax

PrefBackupPath (BackupDir: string; UpdateQuickList: enumeration)

Parameters

BackupDir

string (optional)

UpdateQuickList

enumeration (optional)

No!

Yes!


PrefBeep

Purpose

Specify when to turn Beep on or off.

Syntax

PrefBeep (Error: enumeration; Hyphenation: enumeration; SearchFailure: enumeration)

Parameters

Error

enumeration (optional)

Off!

On!

Hyphenation

enumeration (optional)

Off!

On!

SearchFailure

enumeration (optional)

Off!

On!

See Also

PrefEnvSettingsDlg, PrefSave


PrefButtonBar

Purpose

Display the Toolbar Settings dialog box.

Syntax

PrefButtonBar ()


PrefDisplayDlg

Purpose

Display the Display Settings dialog box.

Syntax

PrefDisplayDlg ()


PrefDisplaySet

Purpose

Specify how to display features.

Syntax

PrefDisplaySet (DefaultView: enumeration; ShowTableGridLines: enumeration; ShowComments: enumeration; ShowGraphics: enumeration; TextInSystemColors: enumeration; ShowHiddenText: enumeration; SculpturedDialogs: enumeration; VerticalScrollBar: enumeration; HorizontalScrollBar: enumeration; ShowHotSpots: enumeration; ShowShadowCursor: enumeration; ShowTabBarIcons: enumeration)

Parameters

DefaultView

enumeration (optional)

ViewDraft!

ViewPage!

ViewTwoPage!

ShowTableGridLines

enumeration (optional)

No!

Yes!

ShowComments

enumeration (optional)

No!

Yes!

ShowGraphics

enumeration (optional)

No!

Yes!

TextInSystemColors

enumeration (optional)

No!

Yes!

ShowHiddenText

enumeration (optional)

No!

Yes!

SculpturedDialogs

enumeration (optional) No effect in version 7.

No!

Yes!

VerticalScrollBar

enumeration (optional)

No!

Yes!

HorizontalScrollBar

enumeration (optional)

Hide!

Show!

WhenRequired!

ShowHotSpots

enumeration (optional) Set the QuickSpot display state.

No!

Yes!

ShowShadowCursor

enumeration (optional)

No!

Yes!

ShowTabBarIcons

enumeration (optional)

No!

Yes!

See Also

CommentsDisplaySetup, QuickSpotsShow, ShadowCursorShow, TabBarIconShow


PrefDocSummary

Purpose

Specify subject search text and default descriptive type for a document summary, and whether to create the summary automatically when saving a document.

Syntax

PrefDocSummary (SubjectSearchText: string; DefaultDescriptiveType: string; CreateOnExit: enumeration; UseDescrOnOpen: enumeration; MakeFilenameDescrOnSaveAs: enumeration)

Parameters

SubjectSearchText

string (optional) The text before the subject line.

DefaultDescriptiveType

string (optional)

CreateOnExit

enumeration (optional)

No!

Yes!

UseDescrOnOpen

enumeration (optional)

No!

Yes!

MakeFilenameDescrOnSaveAs

enumeration (optional)

No!

Yes!

See Also

?SaveDocumentSummaryOnExit, PrefDocSummaryDlg, PrefSave


PrefDocSummaryDlg

Purpose

Display the Document Summary Settings dialog box.

Syntax

PrefDocSummaryDlg ()

See Also

PrefDocSummary


PrefEnvironment

Purpose

Specify environment Settings.

Syntax

PrefEnvironment (UserName: string; UserInitials: string; UserColorRed: numeric; UserColorGreen: numeric; UserColorBlue: numeric; ConfirmCodeDeletion: enumeration; ConfirmTableFormulaDeletion: enumeration; SetQuickMarkOnSave: enumeration; ActivateHypertext: enumeration; FormatForDefaultPrinter: enumeration; SaveWorkSpace: enumeration; AutoWordSelect: enumeration; GoToQuickMarkOnOpen: enumeration)

Parameters

UserName

string (optional)

UserInitials

string (optional) The user ID.

UserColorRed

numeric (optional) Value: 0-255.

UserColorGreen

numeric (optional) Value: 0-255.

UserColorBlue

numeric (optional) Value: 0-255.

ConfirmCodeDeletion

enumeration (optional)

No!

Yes!

ConfirmTableFormulaDeletion

enumeration (optional)

No!

Yes!

SetQuickMarkOnSave

enumeration (optional)

No!

Yes!

ActivateHypertext

enumeration (optional)

Off!

On!

FormatForDefaultPrinter

enumeration (optional)

No!

Yes!

SaveWorkSpace

enumeration (optional) Save the current WorkSpace on exit.

Always!

Never!

PromptOnExit!

AutoWordSelect

enumeration (optional)

Off!

On!

GoToQuickMarkOnOpen

enumeration (optional)

No!

Yes!

See Also

?ActivateHypertext, ?AutoWordSelect


PrefEnvSettingsDlg

Purpose

Display the Environment Settings dialog box.

Syntax

PrefEnvSettingsDlg ()


PrefHyphenation

Purpose

Turn on Hyphenation and specify prompt conditions.

Syntax

PrefHyphenation (Prompt: enumeration)

Parameters

Prompt

enumeration (optional)

Always!

Never!

WhenRequired!

See Also

PrefEnvSettingsDlg, PrefSave


PrefImportDlg

Purpose

Display the Convert Settings dialog box.

Syntax

PrefImportDlg ()


PrefImportOptions

Purpose

Specify how certain characters are interpreted during document imports.

Syntax

PrefImportOptions (FieldDelimiters: string; RecordDelimiters: string; StripCharacter: string; EncapsulationCharacter: string)

Parameters

FieldDelimiters

string (optional)

RecordDelimiters

string (optional)

StripCharacter

string (optional)

EncapsulationCharacter

string (optional)


PrefLanguageSet

Purpose

Specify a language.

Syntax

PrefLanguageSet (LanguageCode: string)

Parameters

LanguageCode

string


PrefLiteCodes

Purpose

Display document symbols in new and current document windows.

Syntax

PrefLiteCodes (Show: enumeration; Space: enumeration; HardReturn: enumeration; Tab: enumeration; Indent: enumeration; SoftHyphen: enumeration; Advance: enumeration; Center: enumeration; CenterPage: enumeration; FlushRight: enumeration)

Parameters

Show

enumeration (optional) Display document symbols.

No!

Yes!

Space

enumeration (optional)

No!

Yes!

HardReturn

enumeration (optional)

No!

Yes!

Tab

enumeration (optional)

No!

Yes!

Indent

enumeration (optional)

No!

Yes!

SoftHyphen

enumeration (optional)

No!

Yes!

Advance

enumeration (optional)

No!

Yes!

Center

enumeration (optional)

No!

Yes!

CenterPage

enumeration (optional)

No!

Yes!

FlushRight

enumeration (optional)

No!

Yes!


PrefLocationDlg

Purpose

Display the File Settings dialog box.

Syntax

PrefLocationDlg ()


PrefLocationOfDocuments

Purpose

Specify the location of document and backup files and the default file format.

Syntax

PrefLocationOfDocuments (Path: string; UseDefExt: enumeration; DefExt: string; UpdateQuickList: enumeration; DefFormat: string; UseExplorerStyleFileDialogs: enumeration)

Parameters

Path

string (optional)

UseDefExt

enumeration (optional) Use the default extension on Open and Save.

No!

Yes!

DefExt

string (optional) The default filename extension.

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!

DefFormat

string (optional) The default document file format.

UseExplorerStyleFileDialogs

enumeration (optional)

No!

Yes!


PrefLocationOfGraphicsFiles

Purpose

Specify the location of graphics files.

Syntax

PrefLocationOfGraphicsFiles (GraphicsDir: string; GraphicsSupplDir: string; UpdateQuickList: enumeration; GraphicsFancyBordersDir: string)

Parameters

GraphicsDir

string (optional)

GraphicsSupplDir

string (optional) The graphics supplemental directory.

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!

GraphicsFancyBordersDir

string (optional)


PrefLocationOfMacroFiles

Purpose

Specify the location of macro files.

Syntax

PrefLocationOfMacroFiles (MacroDir: string; MacroSupplDir: string; UpdateQuickList: enumeration)

Parameters

MacroDir

string (optional)

MacroSupplDir

string (optional) The macro supplemental directory.

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!


PrefLocationOfPrinterFiles

Purpose

Specify the location of label files and set related options.

Syntax

PrefLocationOfPrinterFiles (PrinterDir: string; PrinterSupplDir: string; LabelFile: string; LabelsDisplay: enumeration; UpdateQuickList: enumeration)

Parameters

PrinterDir

string (optional) Formerly, the Printer directory was used to store

Corel WordPerfect printer driver and label files. Corel WordPerfect printer driver files were not used in Corel WordPerfect 8 and 7. Therefore, this directory is used for label files only.

PrinterSupplDir

string (optional) This parameter is obsolete.

LabelFile

string (optional) The label filename, including the full path.

LabelsDisplay

enumeration (optional)

DisplayBoth!

DisplayLaser!

DisplayTractorFed!

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!

See Also

?PathLabels, ?PathPrinters


PrefLocationOfSpreadsheetFiles

Purpose

Specify the location of spreadsheet and database files.

Syntax

PrefLocationOfSpreadsheetFiles (SpreadsheetDir: string; SpreadsheetSupplDir: string; DatabaseDir: string; DatabaseSupplDir: string; UpdateQuickList: enumeration)

Parameters

SpreadsheetDir

string (optional)

SpreadsheetSupplDir

string (optional) The supplemental spreadsheet directory.

DatabaseDir

string (optional)

DatabaseSupplDir

string (optional) The supplemental database directory.

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!


PrefLocationOfTemplates

Purpose

Specify the location of template files.

Syntax

PrefLocationOfTemplates (TemplateDir: string; TemplateSupplPath: string; File: string; SupplFile: string; DefExt: string; UpdateQuickList: enumeration; UpdateDefaultTemplate: enumeration)

Parameters

TemplateDir

string (optional)

TemplateSupplPath

string (optional) The supplemental directory.

File

string (optional) The templates filename.

SupplFile

string (optional) The supplemental filename.

DefExt

string (optional) The default filename extension.

UpdateQuickList

enumeration (optional) Update the QuickList with changes.

No!

Yes!

UpdateDefaultTemplate

enumeration (optional)

No!

Yes!


PrefMenu

Purpose

Display Quick Tips, shortcut keys next to menu items, and the most recently opened documents at the bottom of the File menu.

Syntax

PrefMenu (DisplayShortcuts: enumeration; DisplayLastOpened: enumeration; DisplayHelpPrompts: enumeration)

Parameters

DisplayShortcuts

enumeration (optional)

No!

Yes!

DisplayLastOpened

enumeration (optional)

No!

Yes!

DisplayHelpPrompts

enumeration (optional)

No!

Yes!

See Also

PrefEnvSettingsDlg, PrefSave


PrefMergeCodes

Purpose

Change how merge codes appear in the document.

Syntax

PrefMergeCodes (Show: enumeration)

Parameters

Show

enumeration

Hide!

Show!

ShowAsBars!

ShowAsMarkers!


PrefMergeExtensions

Purpose

Specify merge form and data file extension options.

Syntax

PrefMergeExtensions (UseDefaultFormExt: enumeration; FormFileExt: string; UseDefaultDataExt: enumeration; DataFileExt: string)

Parameters

UseDefaultFormExt

enumeration (optional)

No!

Yes!

FormFileExt

string (optional)

UseDefaultDataExt

enumeration (optional)

No!

Yes!

DataFileExt

string (optional)

See Also

MergeFileType, PrefSave


PrefMetafileOptions

Purpose

Specify what format to use for imported graphics files.

Syntax

PrefMetafileOptions (State: enumeration)

Parameters

State

enumeration Convert to Corel WordPerfect (.WPG) format, retain both formats, or retain Metafile (.WMF) format.

ConvertToWPG!

RetainWindowsAndWPG!

RetainWindowsFormat!


PrefPowerBar

Purpose

Specify how the Power Bar looks.

Syntax

PrefPowerBar (Font: string; Size: numeric; Style: enumeration; ShowQuickTips: enumeration)

Parameters

Font

string (optional) The font face.

Size

numeric (optional) The font size.

Style

enumeration (optional) A button style.

Picture!

PictureAndText!

Text!

ShowQuickTips

enumeration (optional)

No!

Yes!


PrefPowerBarEdit

Purpose

Open and close the Power Bar Settings dialog box.

Syntax

PrefPowerBarEdit (Action: enumeration)

Parameters

Action

enumeration (optional)

Enter!

Exit!


PrefPrintEnvironment

Purpose

Turn Reformat documents for the WordPerfect default printer on open on or off.

Syntax

PrefPrintEnvironment (FormatForDefaultPrinter: enumeration)

Parameters

FormatForDefaultPrinter

enumeration

No!

Yes!

See Also

?FormatForDefaultPrinter


PrefPrintRedline

Purpose

Specify the default method and character of redlined text for new documents. Follow this command with PrefSave to save the setting for future Corel WordPerfect sessions. Use RedlineMethod and RedlineCharacter to change the redline method and/or character of the current document.

Syntax

PrefPrintRedline (Method: enumeration; Character: string)

Parameters

Method

enumeration (optional) Accept the printer setting, or specify a column of characters down the right, left, or alternating sides of redlined text.

Alternating!

Left!

PrinterDependent!

Right!

Character

string (optional) The character to display down the side of redlined text. Omit if Method parameter is PrinterDependent!.

See Also

PrefSave, RedlineCharacter, RedlineMethod


PrefPrintSizeRatio

Purpose

Specify the size for each font attribute as a percent of the selected font size.

Syntax

PrefPrintSizeRatio (Fine: numeric; Small: numeric; Large: numeric; VeryLarge: numeric; ExtraLarge: numeric; SuperSubscript: numeric)

Parameters

Fine

numeric (optional) Value: 1-100.

Small

numeric (optional) Value: 1-100.

Large

numeric (optional) Value: 1-100.

VeryLarge

numeric (optional) Value: 1-100.

ExtraLarge

numeric (optional) Value: 1-100.

SuperSubscript

numeric (optional) Value: 1-100.

See Also

PrefSave


PrefRevealCodes

Purpose

Specify Reveal Code Settings.

Syntax

PrefRevealCodes (FontFace: string; FontSize: numeric; WindowSize: numeric; ShowOnNew: enumeration; ShowSpacesAsBullets: enumeration; WrapAtWindow: enumeration; ShowInDetail: enumeration; Sculptured: enumeration; ForeColorRed: numeric; ForeColorGreen: numeric; ForeColorBlue: numeric; BackColorRed: numeric; BackColorGreen: numeric; BackColorBlue: numeric; ShowHelpPrompts: enumeration; UseSystemColors: enumeration)

Parameters

FontFace

string (optional)

FontSize

numeric (optional)

WindowSize

numeric (optional) A percent of the screen.

ShowOnNew

enumeration (optional) Display the codes in current and new documents.

No!

Yes!

ShowSpacesAsBullets

enumeration (optional)

No!

Yes!

WrapAtWindow

enumeration (optional) Wrap the lines at the window edge.

No!

Yes!

ShowInDetail

enumeration (optional)

No!

Yes!

Sculptured

enumeration (optional)

No!

Yes!

ForeColorRed

numeric (optional) Value: 0-255.

ForeColorGreen

numeric (optional) Value: 0-255.

ForeColorBlue

numeric (optional) Value: 0-255.

BackColorRed

numeric (optional) Value: 0-255.

BackColorGreen

numeric (optional) Value: 0-255.

BackColorBlue

numeric (optional) Value: 0-255.

ShowHelpPrompts

enumeration (optional)

No!

Yes!

UseSystemColors

enumeration (optional)

No!

Yes!

See Also

PrefRevealCodesDlg


PrefRevealCodesDlg

Purpose

Display the Display Settings dialog box with Reveal Codes selected.

Syntax

PrefRevealCodesDlg ()

See Also

PrefRevealCodes


PrefRuler

Purpose

Specify how the Ruler looks.

Syntax

PrefRuler (RulerOnNew: enumeration; TabsToGrid: enumeration; ShowRulerGuides: enumeration; SculpturedRuler: enumeration)

Parameters

RulerOnNew

enumeration (optional)

No!

Yes!

TabsToGrid

enumeration (optional) Tabs “snap” to invisible grid lines every 1/16th of an inch or 1/5th of a centimeter.

No!

Yes!

ShowRulerGuides

enumeration (optional) Display a Ruler Bar guide when tab stops move.

No!

Yes!

SculpturedRuler

enumeration (optional)

No!

Yes!

See Also

PrefEnvSettingsDlg, PrefSave


PrefSave

Purpose

Save preference command changes as defaults for future sessions.

Syntax

PrefSave ()

See Also

PrefPrintRedline


PrefStatusBar

Purpose

Specify default status bar items, their position, and their width. Precede and follow with PrefStatusBarEdit.

Syntax

PrefStatusBar ({Box: enumeration; Position: numeric; Width: numeric; })

Parameters

Box

enumeration (optional) Specify an item to display or hide on the status bar. Repeat Box, Position, and Width parameters for each item. Enclose repeated parameters in braces ({}) separated by semicolons.

AlignChar!

Outline!

CapsLockState!

Page!

CombinedAbsPosition!

Position!

CombinedPosition!

Printer!

Date!

ScrollLockState!

Font!

Select!

GeneralStatus!

Time!

InsertMode!

Time12!

Keyboard!

Time24!

Line!

Zoom!

NumLockState!

 

Position

numeric (optional)

Width

numeric (optional)


PrefStatusBarEdit

Purpose

Edit the default status bar. Precede with PrefStatusBar. Default: toggle.

Syntax

PrefStatusBarEdit (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


PrefStatusBarOptions

Purpose

Specify the size and font of the status bar text.

Syntax

PrefStatusBarOptions (FontFace: string; FontSize: numeric; Bold: enumeration; BoxStyle: enumeration; EvenSpaced: enumeration)

Parameters

FontFace

string (optional)

FontSize

numeric (optional)

Bold

enumeration (optional) Bold status bar font.

No!

Yes!

BoxStyle

enumeration (optional)

Flat!

Inset!

Raised!

EvenSpaced

enumeration (optional) Space items evenly.

No!

Yes!

See Also

PrefStatusBarEdit


PrefStatusBarOptionsDlg

Purpose

Display the Status Bar Options dialog box.

Syntax

PrefStatusBarOptionsDlg ()

See Also

PrefStatusBar


PrefTaskBar

Purpose

Specify the items for the Application Bar, and their position and width.

Syntax

PrefTaskBar ({Box: enumeration; Width: numeric; TextOrIcon: numeric; })

Parameters

Box

enumeration (optional)

AlignChar!

Keyboard!

CapsLockState!

LGCName!

CombinedAbsPosition!

NumLockState!

CombinedPosition!

Printer!

CurrentTag!

ScrollLockState!

Date!

Select!

Font!

Time!

GeneralStatus!

Zoom!

InsertMode!

 

Width

numeric (optional)

TextOrIcon

numeric (optional)


PrefTOA

Purpose

Specify a table of authorities format.

Syntax

PrefTOA (Underlining: enumeration; Runs: enumeration)

Parameters

Underlining

enumeration (optional) Allow underlining in the full form.

Allowed!

NotAllowed!

Runs

enumeration (optional)

Allowed!

NotAllowed!


PrefUnitsOfMeasure

Purpose

Specify the unit of measure settings.

Syntax

PrefUnitsOfMeasure (DisplayUnits: enumeration; StatusBarUnits: enumeration)

Parameters

DisplayUnits

enumeration (optional)

Centimeters!

InchesI!

InchesQuote!

Millimeter!

Point!

Wpu!

StatusBarUnits

enumeration (optional) The unit of measure for the status bar and Ruler.

Centimeters!

InchesI!

InchesQuote!

Millimeter!

Point!

Wpu!


PrefZoom

Purpose

Specify the document window view.

Syntax

PrefZoom (Type: enumeration; Percent: numeric)

Parameters

Type

enumeration

FixedPercent!

FullPage!

MarginWidth!

PageWidth!

Percent

numeric (optional) Normal: 100.

See Also

DraftZoom100


Print

Purpose

Print according to specified options. If no print-time commands are used prior to this command, the document will be printed according to the current default settings. If the Action parameter is left blank, the document will be printed using the current print action.

Syntax

Print (Action: enumeration)

Parameters

Action

enumeration (optional)

AdvancedMultiplePages!

CurrentPage!

DocumentOnDisk!

DocumentSummary!

FullDocument!

MultiplePages!

SelectedText! Print selected text. If nothing is selected, the command does nothing. If a partial line of text is selected, the entire line prints.

See Also

DocSummaryPrint, PrintAction


PrintAction

Purpose

Specify a print action and return the current print action.

Syntax

numeric := PrintAction (Action: enumeration)

Parameters

Action

enumeration (optional)

AdvancedMultiplePages!

CurrentPage!

DocumentOnDisk!

DocumentSummary!

FullDocument!

MultiplePages!

SelectedText!

See Also

Print


PrintAdvancedRangeData

Purpose

Specify the pages to print. Follow this command with Print(AdvancedMultiplePages!).The following rules apply to all PrintAdvancedRangeData parameter specifications:1. To specify all Pages, Secondary Pages, Chapters, or Volumes use (“all”).2. Use the same numbering method as the document uses. For example, if the current Page number method is (A,B,C,...) and you want to print the first three pages, use (“A-C”) in the Pages parameter, not (“1-3").3. If you do not wish to specify a range or value for a parameter, use a null string (”").

Syntax

PrintAdvancedRangeData (Pages: string; SecondaryPages: string; Chapters: string; Volumes: string)

Parameters

Pages

string

SecondaryPages

string

Chapters

string

Volumes

string

See Also

Print


PrintBooklet

Purpose

Turn booklet printing on or off.

Syntax

numeric := PrintBooklet (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


PrintCopies

Purpose

Specify the number of copies to print.

Syntax

numeric := PrintCopies (NumberOfCopies: numeric)

Parameters

NumberOfCopies

numeric

See Also

Print


PrintDestination

Purpose

Specify to print to a printer, file, or printer port.

Syntax

any := PrintDestination (Destination: any)

Parameters

Destination

any (optional) Use a string specifying a path and filename to print to a file. Use a string specifying the name of a printer to print to a specific printer. Use PromptForFilename! to prompt the user for a filename to print to. Use DriverPort! to print to the current printer port.

DriverPort!

PromptForFilename!

See Also

?CurrentPrinterPort, Print


PrintDlg

Purpose

Display the Print dialog box.

Syntax

PrintDlg ()

See Also

BindingOptionsDlg, Print


PrinterCommand

Purpose

Insert a [Ptr Cmnd] code at the insertion point.

Syntax

PrinterCommand (Flag: enumeration; Command: string)

Parameters

Flag

enumeration Specify whether the Command parameter contains a printer command or filename.

Command!

File!

Command

string The printer command or name of a file that contains one or more printer commands.

See Also

PrinterCommandDlg, Print


PrinterCommandDlg

Purpose

Display the Printer Command dialog box.

Syntax

PrinterCommandDlg ()

See Also

PrinterCommand, Print


PrinterPause

Purpose

Insert a [Pause Ptr] code at the insertion point, in order to pause the current print job.

Syntax

PrinterPause ()

See Also

Print


PrinterSelectByName

Purpose

Specify a printer to print to.

Syntax

string := PrinterSelectByName (PrinterName: any)

Parameters

PrinterName

any (optional) The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.

Default!

See Also

Print, PrinterSelectDlg


PrinterSelectDlg

Purpose

Display the Print to dialog box with the Printer tab selected.

Syntax

PrinterSelectDlg ()

See Also

Print, PrinterSelectByName


PrintGraphically

Purpose

Turn the Print graphically option on or off.

Syntax

boolean := PrintGraphically (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


PrintGraphics

Purpose

Turn graphics printing on or off.

Syntax

boolean := PrintGraphics (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


PrintHistoryDlg

Purpose

Display the Print Status and History dialog box.

Syntax

PrintHistoryDlg ()

See Also

Print


PrintImageBinding

Purpose

Specify the binding edge. Use this command with PrintImageOffset and PrintTwoSided. This is a print-time option and does not insert a code in the document.

Syntax

numeric := PrintImageBinding (Edge: enumeration)

Parameters

Edge

enumeration (optional)

BottomEdge!

InsideEdge!

LeftEdge!

OutsideEdge!

RightEdge!

TopEdge!

See Also

PrintTwoSided, PrintUseTwoSidedDocCodes, PrintImageOffset, Print


PrintImageOffset

Purpose

Specify the binding edge offset. Use this command with PrintImageBinding. This is a print-time option and does not insert a code in the document.

Syntax

measurement := PrintImageOffset (Offset: measurement)

Parameters

Offset

measurement (optional) The distance to shift a page image. WordPerfect Units (1/1200 in) are assumed unless the DefaultUnits command precedes this command, or the units of the parameter are specified. To specify units for this parameter, include a unit indicator following the value. For example, PrintImageOffset(Offset: 1") specifies the value 1 as inches.

See Also

PrintImageBinding, Print


PrintInColor

Purpose

Turn color printing on or off. This is a print-time option and does not insert a code in the document. PrintInColor takes effect only when the current printer is capable of color printing, regardless of the value returned.

Syntax

boolean := PrintInColor (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


PrintInReverseOrder

Purpose

Turn reverse order printing on or off. This is a print-time option and does not insert a code in the document.

Syntax

boolean := PrintInReverseOrder (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


PrintRangeFrom

Purpose

Specify the first page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeTo and Print(Action: MultiplePages!).

Syntax

numeric := PrintRangeFrom (Page: numeric)

Parameters

Page

numeric (optional)

See Also

Print, PrintRangeTo


PrintRangeTo

Purpose

Specify the last page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeFrom and Print(Action: MultiplePages!).

Syntax

numeric := PrintRangeTo (Page: numeric)

Parameters

Page

numeric (optional) If this parameter equals zero, print to the end of the document.

See Also

Print, PrintRangeFrom


PrintResolution

Purpose

Specify the print resolution (quality).

Syntax

numeric := PrintResolution (Quality: enumeration)

Parameters

Quality

enumeration (optional) The print quality. Some printers allow more levels of print quality. To specify print quality on those printers, use 0-10. Refer to the specific printer documentation for print quality levels.

High!

Low!

Medium!

See Also

Print, PrintResolutionDpiY, PrintResolutionDpiX


PrintResolutionDpiX

Purpose

Specify the horizontal dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIY. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.

Syntax

numeric := PrintResolutionDpiX (DPI: numeric)

Parameters

DPI

numeric (optional)

See Also

Print, PrintResolution, PrintResolutionDpiY


PrintResolutionDpiY

Purpose

Specify the vertical dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIX. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.

Syntax

numeric := PrintResolutionDpiY (DPI: numeric)

Parameters

DPI

numeric (optional)

See Also

Print, PrintResolution, PrintResolutionDpiX


PrintSettings

Purpose

Add, delete, update, and use printer named settings. Use other print option commands to set current options. Then use this command to save those options as a named setting.

Syntax

PrintSettings (Action: enumeration; SettingName: any)

Parameters

Action

enumeration

Add!

Delete!

Update!

Use!

SettingName

any (optional) The name of the driver Named Setting. To apply the action specified in the Action parameter to the default setting, use Default!.

Default!

DriverSettings!

See Also

Print


PrintSortOrder

Purpose

Specify how to sort the pages of multiple-copy print jobs.

Syntax

numeric := PrintSortOrder (Order: enumeration)

Parameters

Order

enumeration (optional)

Collate!

Group!

See Also

Print


PrintSourceFileName

Purpose

Specify a document on disk to print.

Syntax

string := PrintSourceFileName (Filename: string)

Parameters

Filename

string (optional)

See Also

PrintTwoSided, PrintAdvancedRangeData, PrintBooklet, PrintWithDocumentSummary, PrintUseTwoSidedDocCodes, Print, PrintInReverseOrder


PrintTo

Purpose

Print a specified file on disk to a specified printer.

Syntax

PrintTo (Filename: string; PrinterName: string; PrinterDevice: string; PrinterPort: string)

Parameters

Filename

string The path and filename of the file to print.

PrinterName

string The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.

PrinterDevice

string Not used.

PrinterPort

string Not used.

See Also

PrintDestination, Print


PrintTwoSided

Purpose

Turn two-sided printing on or off and specify options. Use PrintTwoSided with PrintUseTwoSidedDocCodes(State: False!) to ensure predictable results. This is a print-time option and does not insert a code in the document.

Syntax

numeric := PrintTwoSided (Option: enumeration)

Parameters

Option

enumeration (optional)

EvenOnly!

LongEdge!

None!

OddOnly!

ShortEdge!

See Also

Binding, DoubleSidedPrint, PrintTwoSidedDocCodesDlg, PrintUseTwoSidedDocCodes, PrintImageBinding, Print


PrintTwoSidedDocCodesDlg

Purpose

Display the Two-Sided Document Settings dialog box.

Syntax

PrintTwoSidedDocCodesDlg ()

See Also

Binding, DoubleSidedPrint, PrintTwoSided, Print


PrintUseTwoSidedDocCodes

Purpose

Turn Use two-sided document settings on or off.

Syntax

boolean := PrintUseTwoSidedDocCodes (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

?Binding, Binding, DoubleSidedPrint, PrintTwoSided, PrintTwoSidedDocCodesDlg, PrintImageBinding


PrintWithDocumentSummary

Purpose

Turn document summary printing on or off.

Syntax

boolean := PrintWithDocumentSummary (State: enumeration)

Parameters

State

enumeration (optional)

False!

True!

See Also

Print


ProofReadAsYouGoOff

Purpose

Turn off Spell-As-You-Go and Grammar-As-You-Go.

Syntax

ProofReadAsYouGoOff ()

See Also

ProofReadGrammar


ProofReadGrammar

Purpose

Mark and correct grammar errors as you type.

Syntax

ProofReadGrammar ()

See Also

ProofReadAsYouGoOff


PublishToBaristaDlg

Purpose

Display the Publish to Barista dialog box and specify a filename.

Syntax

PublishToBaristaDlg (FileName: string)

Parameters

FileName

string


PublishToEnvoyDlg

Purpose

Publish the current document to the Envoy viewer and display it in Envoy.

Syntax

PublishToEnvoyDlg ()


QuattroPro

Purpose

Insert a Corel Quattro Pro OLE object file in the current document.

Syntax

QuattroPro ()

See Also

OLEInsertObject


QuickCorrect

Purpose

Specify whether QuickCorrect will replace words as you type.

Syntax

QuickCorrect (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?QuickCorrect, QuickCorrectAddItem, QuickCorrectDeleteItem, QuickCorrectDlg, QuickCorrectReplaceWord


QuickCorrectAddItem

Purpose

Add a QuickCorrect entry.

Syntax

QuickCorrectAddItem (Item: string; Replacement: string; Type: enumeration)

Parameters

Item

string

Replacement

string

Type

enumeration

QCException!

QuickCorrect!

QuickLink!

See Also

QuickCorrect, QuickCorrectDeleteItem, QuickCorrectDlg, QuickCorrectReplaceWord


QuickCorrectAutoCreateException

Purpose

Turns the QuickCorrect Create Auto Exception List on or off.

Syntax

QuickCorrectAutoCreateException (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect


QuickCorrectCapsFixQry

Purpose

Return True if the QuickCorrect CapsFix option is on, False if not.

Syntax

boolean := QuickCorrectCapsFixQry ()

See Also

QuickCorrect, QuickCorrectCapsFixSet


QuickCorrectCapsFixSet

Purpose

Turn the QuickCorrect CapsFix option on or off.

Syntax

QuickCorrectCapsFixSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect, QuickCorrectCapsFixQry


QuickCorrectDeleteItem

Purpose

Delete a QuickCorrect entry.

Syntax

QuickCorrectDeleteItem (Item: string)

Parameters

Item

string

See Also

QuickCorrect, QuickCorrectAddItem, QuickCorrectDlg, QuickCorrectReplaceWord


QuickCorrectDlg

Purpose

Display the QuickCorrect dialog box.

Syntax

QuickCorrectDlg ()

See Also

QuickCorrect, QuickCorrectAddItem, QuickCorrectDeleteItem, QuickCorrectReplaceWord


QuickCorrectOtherWords

Purpose

Turn Correct other mis-typed words when possible on or off.

Syntax

QuickCorrectOtherWords (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect


QuickCorrectQuickBulletsQry

Purpose

Return True if the QuickCorrect QuickBullets option is on, False if not.

Syntax

boolean := QuickCorrectQuickBulletsQry ()

See Also

QuickCorrect, QuickCorrectQuickBulletsSet


QuickCorrectQuickBulletsSet

Purpose

Turn the QuickCorrect QuickBullets option on or off.

Syntax

QuickCorrectQuickBulletsSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect, QuickCorrectQuickBulletsQry


QuickCorrectQuickIndentQry

Purpose

Return True if the QuickCorrect QuickIndent option is on, False if not.

Syntax

boolean := QuickCorrectQuickIndentQry ()

See Also

QuickCorrect, QuickCorrectQuickIndentSet


QuickCorrectQuickIndentSet

Purpose

Turn the QuickCorrect QuickIndent option on or off.

Syntax

QuickCorrectQuickIndentSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect, TabForced, QuickCorrectQuickIndentQry


QuickCorrectQuickLinesQry

Purpose

Return True if the QuickCorrect QuickLines option is on, False if not.

Syntax

boolean := QuickCorrectQuickLinesQry ()

See Also

QuickCorrect, QuickCorrectQuickIndentSet


QuickCorrectQuickLinesSet

Purpose

Turn the QuickCorrect QuickLines option on or off. QuickLines replace character lines with graphic lines.

Syntax

QuickCorrectQuickLinesSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect, QuickCorrectQuickLinesQry


QuickCorrectQuickOrdinalsQry

Purpose

Return True if the QuickCorrect QuickOrdinals option is on, False if not. QuickOrdinals superscripts ordinal text.

Syntax

boolean := QuickCorrectQuickOrdinalsQry ()

See Also

QuickCorrect, QuickCorrectQuickOrdinalsSet


QuickCorrectQuickOrdinalsSet

Purpose

Turn the QuickCorrect QuickOrdinals option on or off.

Syntax

QuickCorrectQuickOrdinalsSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect, QuickCorrectQuickOrdinalsQry


QuickCorrectQuickSymbolsSet

Purpose

Turn the QuickSymbols option on or off.

Syntax

QuickCorrectQuickSymbolsSet (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickCorrect


QuickCorrectReplaceWord

Purpose

Replace the current word in the document with specified text. The Insertion point must be in the word to be replaced. The specified text must correspond to a QuickCorrect entry.

Syntax

QuickCorrectReplaceWord (String: string)

Parameters

String

string

See Also

QuickCorrect, QuickCorrectAddItem, QuickCorrectDeleteItem, QuickCorrectDlg


QuickFontEx

Purpose

Insert a QuickFont into the document.

Syntax

QuickFontEx (FontFace: string; FontSize: measurement; Red: numeric; Green: numeric; Blue: numeric; FontType: enumeration; {Attributes: enumeration; })

Parameters

FontFace

string

FontSize

measurement

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

FontType

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

Attributes

enumeration (optional)

Bold!

DoubleUnderline!

Every!

Italics!

Outline!

Redline!

Shadow!

SmallCaps!

Strikeout!

Underline!

See Also

Font


QuickFormat

Purpose

Format text based on selected fonts and attributes, or paragraph styles, or both.

Syntax

QuickFormat (Format: enumeration)

Parameters

Format

enumeration

Attributes!

CharacterStyle!

Graphics!

Off!

Styles!

StylesAndAttributes!

TableCells!

TableStruct!

See Also

QuickFormatDiscontinue, QuickFormatDlg, QuickFormatToggle


QuickFormatDiscontinue

Purpose

Turn off the QuickFormat link for all paragraphs with the associated heading.

Syntax

QuickFormatDiscontinue (AllParagraphs: enumeration)

Parameters

AllParagraphs

enumeration

False!

True!

See Also

QuickFormat, QuickFormatDlg, QuickFormatToggle


QuickFormatDlg

Purpose

Display the QuickFormat dialog box.

Syntax

QuickFormatDlg ()

See Also

QuickFormat, QuickFormatDiscontinue, QuickFormatToggle


QuickFormatToggle

Purpose

Display the QuickFormat dialog box.

Syntax

QuickFormatToggle ()

See Also

QuickFormat, QuickFormatDiscontinue, QuickFormatDlg


QuickLink

Purpose

Turn QuickLink on or off.

Syntax

QuickLink (State: enumeration)

Parameters

State

enumeration

Off!

On!


QuickmarkFind

Purpose

Move the insertion point to the first character after a QuickMark.

Syntax

QuickmarkFind ()

See Also

QuickmarkSet


QuickmarkSet

Purpose

Place a unique bookmark, or QuickMark, in a document at the insertion point. If Set QuickMark in Document on Save is on, the QuickMark moves to the insertion point when the document is saved.

Syntax

QuickmarkSet ()

See Also

QuickmarkFind, TotalPages


QuickSpotsShow

Purpose

Turn QuickSpots on or off for the current session and return the current state. To return the current state without changing the setting, omit the parameter. This command does not change display settings for QuickSpots.

Syntax

boolean := QuickSpotsShow (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

PrefDisplaySet


QuickWords

Purpose

Turn Expand QuickWords when you type them on or off.

Syntax

QuickWords (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

QuickWordsDlg


QuickWordsDlg

Purpose

Display the QuickCorrect dialog box with the QuickWords tab displayed.

Syntax

QuickWordsDlg ()

See Also

QuickWords


Redisplay

Purpose

Rewrite the screen contents without moving the insertion point.

Syntax

Redisplay ()


RedlineCharacter

Purpose

Specify a character to redline text.

Syntax

RedlineCharacter (Character: string)

Parameters

Character

string

See Also

?RedlineCharacter, PrefPrintRedline, RedlineMethod


RedlineMethod

Purpose

Specify a redline method.

Syntax

RedlineMethod (RedlineMethod: enumeration)

Parameters

RedlineMethod

enumeration

Alternating!

LeftMargin!

PrinterDependent!

RightMargin!

See Also

?RedlineMethod, PrefPrintRedline, RedlineCharacter


Redo

Purpose

Reverse the last Undo made to the document or reverse the specified Undo.

Syntax

Redo (Number: numeric)

Parameters

Number

numeric (optional) The number of redo levels.

See Also

Undo


RepeatDlg

Purpose

Display the Repeat dialog box.

Syntax

RepeatDlg ()

See Also

RepeatValue


RepeatSet

Purpose

Specify the Repeat default number.

Syntax

RepeatSet (Value: numeric)

Parameters

Value

numeric

See Also

RepeatValue


RepeatValue

Purpose

Specify the number of times to repeat an action.

Syntax

RepeatValue (Value: numeric)

Parameters

Value

numeric (optional)

See Also

RepeatDlg


ReplaceAll

Purpose

Replace all occurrences of a matched word, code, or phrase. Precede with commands such as SearchString, ReplaceString, and SearchNext.

Syntax

ReplaceAll (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional) An extended search includes substructures such as headers and footnotes.

Extended!

Regular!

See Also

ReplaceString, SearchNext, SearchPrevious, SearchString


ReplaceBackward

Purpose

Replace specified text or codes from the current insertion point to the beginning of the document. Precede with other commands such as SearchString and ReplaceString.

Syntax

ReplaceBackward (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional) An extended search includes substructures such as headers and footnotes.

Extended!

Regular!

See Also

ReplaceCurrent, ReplaceForward, ReplaceString, SearchPrevious, SearchString


ReplaceConfirm

Purpose

Specify whether Find and Replace Text prompts the user to confirm replacement in Corel WordPerfect for DOS. Included for DOS compatibility. No effect in Corel WordPerfect for Windows. Use ReplaceAll or ReplaceCurrent.

Syntax

ReplaceConfirm (State: enumeration)

Parameters

State

enumeration Prompt for confirmation before replacing text.

No!

Yes!

See Also

ReplaceDlg


ReplaceCurrent

Purpose

Replace a matched word, code, or phrase. Precede with commands such as SearchString, and SearchNext.

Syntax

ReplaceCurrent ()

See Also

ReplaceString, ReplaceWithAttributes, SearchNext, SearchString


ReplaceDlg

Purpose

Display the Find and Replace Text dialog box.

Syntax

ReplaceDlg ()

See Also

FindDlg


ReplaceForward

Purpose

Replace the specified text or codes from the insertion point to the end of the document. Precede with other commands such as SearchString or ReplaceString.

Syntax

ReplaceForward (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional) An extended search includes substructures such as headers and footnotes.

Extended!

Regular!

See Also

ReplaceBackward, ReplaceString, SearchString


ReplaceString

Purpose

Specify the search text or codes.

Syntax

ReplaceString (RplcStrg: string)

Parameters

RplcStrg

string

See Also

SearchString, SelectedReplaceString


ReplaceWithAttributes

Purpose

Specify the font attributes and/or relative font size for the replacement text.

Syntax

ReplaceWithAttributes (State: enumeration; Attribute: enumeration)

Parameters

State

enumeration

No!

Yes!

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

ReplaceCurrent, ReplaceString, SearchNext, SearchPrevious, SearchString


ReplaceWithCase

Purpose

Specify the case(s) of the replacement text.

Syntax

ReplaceWithCase (State: enumeration)

Parameters

State

enumeration

No!

Yes!


ReplaceWithFont

Purpose

Specify the font and font style of the replacement text.

Syntax

ReplaceWithFont (State: enumeration; Name: string; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)

Parameters

State

enumeration

No!

Yes!

Name

string (optional) The font name.

Family

enumeration (optional)

FamilyAestheticOrnamented!

FamilyITCZapfDingbats!

FamilyAlbertus!

FamilyLetterGothic!

FamilyBodoni!

FamilyMadrone!

FamilyBroadway!

FamilyMicrostyle!

FamilyBrush!

FamilyOldEnglish!

FamilyCenturySchoolbook!

FamilyOptima!

FamilyComputer!

FamilyParkAvenue!

FamilyCourier!

FamilyPonderosa!

FamilyHelvetica!

FamilyPTBarnum!

FamilyHobo!

FamilyRevue!

FamilyITCBenguiat!

FamilySignetRoundhand!

FamilyITCGaramond!

FamilyTekton!

FamilyITCLubalinGraph!

FamilyTimesRoman!

FamilyITCRonda!

FamilyUncial!

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchNormal!

FontMatchOutline!

FontMatchShadow!

FontMatchSmallCaps!

Weight

enumeration (optional)

WeightBlack!

WeightMaximum!

WeightBold!

WeightMedium!

WeightBook!

WeightRegular!

WeightDemiBold!

WeightRoman!

WeightDemiLight!

WeightSemiBold!

WeightExtraBlack!

WeightSemiLight!

WeightExtraBold!

WeightThin!

WeightExtraHeavy!

WeightUltraBlack!

WeightExtraLight!

WeightUltraHeavy!

WeightExtraThin!

WeightUltraLight!

WeightHeavy!

WeightUltraThin!

WeightLight!

WeightUnknown!

Width

enumeration (optional)

WidthCompressed!

WidthSemiCondensed!

WidthCondensed!

WidthSemiExpanded!

WidthDoubleWide!

WidthTripleWide!

WidthExpanded!

WidthUltraCompressed!

WidthExtraCondensed!

WidthUltraCondensed!

WidthExtraExpanded!

WidthUltraExpanded!

WidthNormal!

WidthUnknown!

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

FontMatchArabic!

FontMatchArabicScript!

FontMatchASCII!

FontMatchBoxDrawing!

FontMatchCyrillic!

FontMatchGreek!

FontMatchHebrew!

FontMatchIconicSymbols!

FontMatchJapaneseKana!

FontMatchMath!

FontMatchMathExtension!

FontMatchMultinational1!

FontMatchMultinational2!

FontMatchTypographicSymbols!

FontMatchUserDefined!


ReplaceWithFontSize

Purpose

Specify the font size of the replacement text.

Syntax

ReplaceWithFontSize (State: enumeration; FontSize: measurement)

Parameters

State

enumeration

No!

Yes!

FontSize

measurement (optional)


ReselectLastBlock

Purpose

Select the last selected text. Recordable substitute: ReselectLastSelection.

Syntax

ReselectLastBlock ()


ReselectLastSelection

Purpose

Select the last selected text.

Syntax

ReselectLastSelection ()


ResetKeyboardMenu

Purpose

Reset the keyboard and menus to the Corel WordPerfect default settings.

Syntax

ResetKeyboardMenu ()


RevealCodes

Purpose

Turn Reveal Codes on or off.

Syntax

RevealCodes (State: enumeration)

Parameters

State

enumeration (optional) Default: toggle.

Off!

On!


ReverseShippingMacro

Purpose

Play the shipping macro REVERSE.WCM to reverse the foreground and background colors in selected text and cells. REVERSE.WCM must be installed.

Syntax

ReverseShippingMacro ()


ReviewDocAnnotationAccept

Purpose

Incorporate the selected annotation into the current document and select the next annotation. If an annotation is not currently selected, the next annotation is selected. If there are no annotations following the insertion point, a not found condition is returned. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationAccept ()

See Also

ReviewDocAnnotationAcceptAll, ReviewDocAnnotationRejectAll, ReviewDocAnnotationReject


ReviewDocAnnotationAcceptAll

Purpose

Incorporate all annotations into the current document. If the current document contains no annotations, a not found condition is returned. Substructures like Headers and Footers are treated independently. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationAcceptAll ()

See Also

ReviewDocAnnotationAccept, ReviewDocAnnotationRejectAll, ReviewDocAnnotationReject


ReviewDocAnnotationFirst

Purpose

Select the first annotation in the current document. If the current document contains no annotations, a not found condition is returned. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationFirst ()

See Also

ReviewDocAnnotationNext, ReviewDocAnnotationPrev


ReviewDocAnnotationNext

Purpose

Select the next annotation in the current document. If there are no annotations following the insertion point, a not found condition is returned. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationNext ()

See Also

ReviewDocAnnotationFirst, ReviewDocAnnotationPrev


ReviewDocAnnotationPrev

Purpose

Select the previous annotation in the current document. If there are no annotations before the insertion point, a not found condition is returned. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationPrev ()

See Also

ReviewDocAnnotationFirst, ReviewDocAnnotationNext


ReviewDocAnnotationReject

Purpose

Delete the selected annotation and select the next annotation. If an annotation is not currently selected, the next annotation is selected. If there are no annotations following the insertion point, a not found condition is returned. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationReject ()

See Also

ReviewDocAnnotationAcceptAll, ReviewDocAnnotationAccept, ReviewDocAnnotationRejectAll


ReviewDocAnnotationRejectAll

Purpose

Delete all annotations in the current document. If the current document contains no annotations, a not found condition is returned. Substructures like Headers and Footers are treated independently. Use this command in Review Document Author mode. If Review Document Author mode is not active, this command fails unless display is on; in which case, the user is prompted to activate Author mode before proceeding.

Syntax

ReviewDocAnnotationRejectAll ()

See Also

ReviewDocAnnotationAcceptAll, ReviewDocAnnotationAccept, ReviewDocAnnotationReject


ReviewDocAuthorDlg

Purpose

Display the Review Document Author Mode dialog box and activate Author mode.

Syntax

ReviewDocAuthorDlg ()

See Also

ZZZ Don't Delete This Record!!!, ReviewDocReviewerDlg, ReviewDocDlg


ReviewDocDisplayModeToggle

Purpose

Turn annotation display on or off.

Syntax

ReviewDocDisplayModeToggle ()


ReviewDocDlg

Purpose

Display the Review Document dialog box.

Syntax

ReviewDocDlg ()


ReviewDocManualModeToggle

Purpose

Enter or exit the Review Document Author or Reviewer annotation modes. When entering Author mode, this command activates the Author mode and selects the first annotation.

Syntax

ReviewDocManualModeToggle (Mode: enumeration)

Parameters

Mode

enumeration (optional) Specify the annotation mode.

Author!

Off!

Reviewer!

See Also

ReviewDocAuthorDlg, ReviewDocReviewerDlg


ReviewDocReviewerDlg

Purpose

Display the Review Document Reviewer mode dialog box and activate Reviewer mode.

Syntax

ReviewDocReviewerDlg ()

See Also

ReviewDocAuthorDlg, ReviewDocDlg


ReviewDocSetCurrentUserColor

Purpose

Set the annotation color for the current reviewer.

Syntax

ReviewDocSetCurrentUserColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

See Also

ReviewDocReviewerDlg


RulerBarShow

Purpose

Display (On!) or hide (Off!) the Ruler and save the setting as the new default.

Syntax

RulerBarShow (State: enumeration)

Parameters

State

enumeration (optional) Default: toggle.

Off!

On!

See Also

?RulerBarActive, ViewToolbarsDlg


SaveAll

Purpose

Save all unsaved documents.

Syntax

SaveAll ()


SaveAllShippingMacro

Purpose

Play the shipping macro SAVEALL.WCM to display a list of open documents to select for saving. SAVEALL.WCM must be installed.

Syntax

SaveAllShippingMacro ()


SaveToDriveAMacro

Purpose

Play the shipping macro SAVETOA.WCM to save the current document and make a copy of it on drive A. SAVETOA.WCM must be installed.

Syntax

SaveToDriveAMacro ()


SaveUndoInformation

Purpose

Save Undo and Redo information with the current document. Saving Undo/Redo information increases the document size.

Syntax

SaveUndoInformation (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

SetUndoLevels


ScrollScreenLeft

Purpose

Scroll to the left side of the document window.

Syntax

ScrollScreenLeft ()

See Also

ScrollScreenRight


ScrollScreenRight

Purpose

Scroll to the right side of the document window.

Syntax

ScrollScreenRight ()

See Also

ScrollScreenLeft


SearchCaseSensitive

Purpose

Make Find case-sensitive.

Syntax

SearchCaseSensitive (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

SearchString


SearchFindWholeWordsOnly

Purpose

Specify whether Find matches only a whole word (Yes!) or also matches partial words (No!).

Syntax

SearchFindWholeWordsOnly (State: enumeration)

Parameters

State

enumeration

No!

Yes!


SearchInSelection

Purpose

Restrict the search to the selected text.

Syntax

SearchInSelection (State: enumeration)

Parameters

State

enumeration

No!

Yes!


SearchNext

Purpose

Search forward to find the next occurrence of the last search performed.

Syntax

SearchNext (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional) An extended search includes substructures such as headers and footnotes.

Extended!

Regular!

See Also

SearchPrevious, SearchString


SearchNextCurrentWord

Purpose

Find the next occurrence of the current selection or word.

Syntax

SearchNextCurrentWord (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional)

Extended!

Regular!


SearchPrevious

Purpose

Search backward to find the previous occurrence of the last search.

Syntax

SearchPrevious (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional) An extended search includes substructures such as headers and footnotes.

Extended!

Regular!

See Also

SearchNext, SearchString


SearchPreviousCurrentWord

Purpose

Find the previous occurrence of the current selection or word.

Syntax

SearchPreviousCurrentWord (SearchMode: enumeration)

Parameters

SearchMode

enumeration (optional)

Extended!

Regular!


SearchString

Purpose

Specify a search string. Follow with SearchNext or SearchPrevious.

Syntax

SearchString (StrgToLookFor: string)

Parameters

StrgToLookFor

string The text and/or codes to search for.

See Also

SearchNext, SearchPrevious


SearchWordForms

Purpose

Find and/or replace word forms.

Syntax

SearchWordForms (State: enumeration)

Parameters

State

enumeration

No!

Yes!


SearchWrap

Purpose

Specify whether Find searches from the beginning of a document after it reaches the end of a document.

Syntax

SearchWrap (State: enumeration)

Parameters

State

enumeration

No!

Yes!


SecondaryPageNumber

Purpose

Specify a secondary page number and insert the code into a document. The code is inserted at the beginning of the page where the insertion point is located.

Syntax

SecondaryPageNumber (Page: numeric)

Parameters

Page

numeric

See Also

?SecondaryPageNumber, PageNumber


SecondaryPageNumberDecrement

Purpose

Decrease the current secondary page number by one.

Syntax

SecondaryPageNumberDecrement ()


SecondaryPageNumberDisplay

Purpose

Insert a code at the insertion point that displays the current secondary page number. The number is updated as the document is modified.

Syntax

SecondaryPageNumberDisplay ()


SecondaryPageNumberIncrement

Purpose

Increase the current secondary page number by one.

Syntax

SecondaryPageNumberIncrement ()


SecondaryPageNumberMethod

Purpose

Specify a numbering method for secondary page numbers.

Syntax

SecondaryPageNumberMethod (NumberingMethod: enumeration)

Parameters

NumberingMethod

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

?SecondaryPageNumberMethod


SelectAll

Purpose

Select all text and graphics in the current document.

Syntax

SelectAll ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectCell

Purpose

Select the current cell. Not valid for floating cells.

Syntax

SelectCell ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectCellDown

Purpose

Select from insertion point down one row. In the bottom row, it does not select text or codes below a table.

Syntax

SelectCellDown ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDownArrow, SelectCellUp


SelectCellDownArrow

Purpose

Select the current cell and one cell down. In the bottom row, it selects the current cell down to the line below the table. Not valid for floating cells.

Syntax

SelectCellDownArrow ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDown, SelectCellUp


SelectCellLeft

Purpose

Select the current cell (cell containing the insertion point) and extend the selection to the previous cell. If the current cell is the first cell in the first row (A1), select the current cell. If the current cell is in the first column (column A) and not in the first row, select the current cell, extend the selection up one row, then continue to extend the selection to the rightmost column. The resulting selection includes the current row and the previous row with the insertion point in the last column of the previous row.

Syntax

SelectCellLeft ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellRight


SelectCellRight

Purpose

Select the current cell and the next cell to the right. In the farthest right cell, select the entire current row and the row below.

Syntax

SelectCellRight ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellLeft


SelectCellUp

Purpose

Select the current cell and one cell above. In the top row of a table, do not select text or codes above the table.

Syntax

SelectCellUp ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectCellUpArrow

Purpose

Select the current cell and one cell above. In the top row of a table, select from the insertion point to the line above the table.

Syntax

SelectCellUpArrow ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDownArrow, SelectCellUp


SelectCharNext

Purpose

Select the text or code one character position to the right of the insertion point.

Syntax

SelectCharNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCharPrevious


SelectCharPrevious

Purpose

Select the text or code one character position to the left of the insertion point.

Syntax

SelectCharPrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCharNext


SelectColumnBottom

Purpose

Select the text and codes from the insertion point to the bottom of the current column.

Syntax

SelectColumnBottom ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnTop


SelectColumnNext

Purpose

Select the text and codes from the insertion point to the right one column. In the farthest right column, select the text and codes from the insertion point to the beginning of the current line.

Syntax

SelectColumnNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnPrevious


SelectColumnPrevious

Purpose

Select the text and codes from the insertion point to the top of the current column and from the bottom up to and including the corresponding line in the column to the left. In the farthest left column, select the text and codes from the insertion point to the beginning of the current line.

Syntax

SelectColumnPrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnNext


SelectColumnTop

Purpose

Select the text and codes from the insertion point to the top of the current column.

Syntax

SelectColumnTop ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnBottom


SelectDelete

Purpose

Delete the selected text.

Syntax

SelectDelete ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectDocBottom

Purpose

Select the text and codes from the insertion point to the end of the document.

Syntax

SelectDocBottom ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocTop


SelectDocTop

Purpose

Select the text and codes from the insertion point to the beginning of the document.

Syntax

SelectDocTop ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocBottom, SelectDocVeryTop


SelectDocVeryTop

Purpose

Select the text and codes from the insertion point to the very beginning of the document, before all codes.

Syntax

SelectDocVeryTop ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocBottom, SelectDocTop


SelectedReplaceString

Purpose

Replace a search string with specified text.

Syntax

SelectedReplaceString (RplcString: string; State: enumeration)

Parameters

RplcString

string

State

enumeration (optional)

UseAlways!

See Also

ReplaceString


SelectLineBegin

Purpose

Select the text and codes from the insertion point to the beginning of the current line.

Syntax

SelectLineBegin ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineEnd


SelectLineDown

Purpose

Select the text and codes from the insertion point down one line.

Syntax

SelectLineDown ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineUp


SelectLineEnd

Purpose

Select the text and codes from the insertion point to the end of the current line.

Syntax

SelectLineEnd ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineBegin


SelectLineUp

Purpose

Select the text and codes from the insertion point backward to the corresponding position on the line above.

Syntax

SelectLineUp ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineDown


SelectLineVeryBegin

Purpose

Select the text and codes from the insertion point to the beginning of the current line, before any codes.

Syntax

SelectLineVeryBegin ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, PosLineVeryBeg, SelectLineBegin, SelectLineVeryEnd


SelectLineVeryEnd

Purpose

Select the text and codes from the insertion point to the end of the current line, after all text and codes.

Syntax

SelectLineVeryEnd ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, PosLineVeryEnd, SelectLineBegin, SelectLineEnd, SelectLineVeryBegin


SelectMode

Purpose

Turn Select on or off. Default: toggle. Use the Arrow keys to extend a selection.

Syntax

SelectMode (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectOff

Purpose

Turn off Select.

Syntax

SelectOff ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectOn

Purpose

Turn on Select and specify the mode.

Syntax

SelectOn (SelectMode: enumeration)

Parameters

SelectMode

enumeration

CharMode!

CharNoCellMode!

DocMode!

PageMode!

ParagraphMode!

RectangleMode!

SentenceMode!

TabularColumnsMode!

WordMode!

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectOnEmptyDoc

Purpose

Activate Select and specify a Select mode in an empty document.

Syntax

SelectOnEmptyDoc (SelectMode: enumeration)

Parameters

SelectMode

enumeration

CharMode!

CharNoCellMode!

DocMode!

PageMode!

ParagraphMode!

RectangleMode!

SentenceMode!

TabularColumnsMode!

WordMode!

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectPage

Purpose

Select everything on the current page.

Syntax

SelectPage ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectPageNext

Purpose

Select the text and codes from the insertion point to the beginning of the next page. On the last page, select text and codes from the insertion point to the end of the document.

Syntax

SelectPageNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectPagePrevious


SelectPagePrevious

Purpose

Select the text and codes from the insertion point to the beginning of the previous page. On the first page, select the text and codes from the insertion point to the beginning of the document.

Syntax

SelectPagePrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectPageNext


SelectParagraph

Purpose

Select the current paragraph and the subsequent codes until the text resumes.

Syntax

SelectParagraph ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectParagraphNext

Purpose

Select the text and codes from the insertion point to the beginning of the next paragraph. In the last paragraph, select the text and codes from the insertion point to the end.

Syntax

SelectParagraphNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectParagraphPrevious


SelectParagraphPrevious

Purpose

Select the text and codes from the insertion point to the beginning of the current paragraph. At the beginning of a paragraph, select the text and codes from the insertion point to the beginning of the preceding paragraph.

Syntax

SelectParagraphPrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectParagraphNext


SelectRectangle

Purpose

Select a rectangle. SelectMode must be on (press F8) to record. Use the positioning keys to extend the selection.

Syntax

SelectRectangle ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectSave

Purpose

Save the selected text as a new file.

Syntax

SelectSave (Filename: string)

Parameters

Filename

string

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectScreenDown

Purpose

Select the text and codes from the insertion point to the bottom of the screen. If the insertion point is already at the bottom of the screen, select the text and codes from the insertion point to the bottom of the next screen.

Syntax

SelectScreenDown ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectScreenUp


SelectScreenLeft

Purpose

Select the current line from the insertion point to the left side of the screen. If the insertion point is already at the left side, select the current line from the insertion point to the left side of the next screen, or to the left margin of a document. Not recordable.

Syntax

SelectScreenLeft ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, PosScreenLeft, SelectScreenRight


SelectScreenRight

Purpose

Select the current line from the insertion point to the right side of the screen. If the insertion point is already at the right side, select the current line from the insertion point to the right side of the next screen, or to the right margin of a document. Not recordable.

Syntax

SelectScreenRight ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, PosScreenRight, SelectScreenLeft


SelectScreenUp

Purpose

Select the text and codes from the insertion point to the top of the screen. If the insertion point is already at the top of the screen, select the text and codes from the insertion point to the top of the next screen.

Syntax

SelectScreenUp ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectScreenDown


SelectSentence

Purpose

Select the current sentence.

Syntax

SelectSentence ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectSentenceNext

Purpose

Select the text and codes from the insertion point to the beginning of the next sentence.

Syntax

SelectSentenceNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectSentencePrevious


SelectSentencePrevious

Purpose

Select the text and codes from the insertion point to the end of the previous sentence.

Syntax

SelectSentencePrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectSentenceNext


SelectTable

Purpose

Select all cells in the current table. If the insertion point is not in a table, the macro ends or goes to the ONERROR label.

Syntax

SelectTable ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumn, SelectTableRow


SelectTableColumn

Purpose

Select all cells in the current column of a table.

Syntax

SelectTableColumn ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTable, SelectTableRow


SelectTableColumnExtendLeft

Purpose

Select the text and codes from the insertion point to the beginning of the current row.

Syntax

SelectTableColumnExtendLeft ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumnExtendRight


SelectTableColumnExtendRight

Purpose

Select the text and codes from the insertion point to the beginning of the last column.

Syntax

SelectTableColumnExtendRight ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumnExtendLeft


SelectTableRow

Purpose

Select all cells in the current row.

Syntax

SelectTableRow ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTable, SelectTableColumn


SelectTabularColumn

Purpose

Select one or more tabular columns. SelectMode must be on to record (press F8). Use the positioning keys to extend the selection.

Syntax

SelectTabularColumn ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectToggle

Purpose

Toggle Select mode.

Syntax

SelectToggle ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectWord

Purpose

Select the current word.

Syntax

SelectWord ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectWordNext

Purpose

Select the text and codes from the insertion point to the beginning of the next word.

Syntax

SelectWordNext ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SelectWordPrevious

Purpose

Select the text and codes from the insertion point to the end of the previous word.

Syntax

SelectWordPrevious ()

See Also

?BlockActive, ?SelectedText, ?SelectedTextSize


SetDocumentMapping

Purpose

Specify a character map for one-byte characters, as opposed to extended characters, when additional character maps are installed.

Syntax

SetDocumentMapping (MapName: string; Location: enumeration; Filename: string)

Parameters

MapName

string

Location

enumeration

MapExternal!

MapInternal!

Filename

string (optional)


SettingsDlg

Purpose

Display the Settings dialog box.

Syntax

SettingsDlg ()


SetUndoLevels

Purpose

Specify the number of Undo/Redo items to maintain in the document.

Syntax

SetUndoLevels (Levels: numeric)

Parameters

Levels

numeric Value: 0-300.

See Also

SaveUndoInformation


SGMLAddToAttrList

Purpose

Append a value to an existing attribute value. The attribute named must be present in the previous start tag. The value in the previous start tag is appended with a space followed by the value. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLAddToAttrList (Name: string; Value: string)

Parameters

Name

string

Value

string

See Also

SGMLReplaceAttribute, SGMLBoxAddToAttrList


SGMLBoxAddToAttrList

Purpose

Append a value to an existing graphics box element attribute value. The element and attribute name must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLBoxAddToAttrList (Element: string; Name: string; Value: string)

Parameters

Element

string

Name

string

Value

string

See Also

SGMLAddToAttrList, SGMLBoxMarkup


SGMLBoxAttribute

Purpose

Set the attribute value of a graphics box element. The element must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLBoxAttribute (Element: string; Name: string; Value: string)

Parameters

Element

string

Name

string

Value

string

See Also

SGMLNewAttribute, SGMLReplaceAttribute, SGMLBoxMarkup


SGMLBoxDeleteAttribute

Purpose

Delete a graphics box element attribute. The element and named attribute must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLBoxDeleteAttribute (Element: string; Name: string)

Parameters

Element

string

Name

string

See Also

SGMLDeleteAttribute, SGMLBoxMarkup


SGMLBoxDeleteMarkup

Purpose

Delete an element of the selected graphics box. This command is valid only if the Corel WordPerfet SGML program component is installed.

Syntax

SGMLBoxDeleteMarkup (Type: enumeration)

Parameters

Type

enumeration

Box!

Caption!

Content!

See Also

SGMLBoxMarkup


SGMLBoxElementDlg

Purpose

Select SGML elements for the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLBoxElementDlg ()


SGMLBoxMarkup

Purpose

Set the element for a graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLBoxMarkup (Type: enumeration; Name: string)

Parameters

Type

enumeration

Box!

Caption!

Content!

Name

string

See Also

SGMLBoxAddToAttrList, SGMLBoxAttribute, SGMLBoxDeleteAttribute, SGMLBoxDeleteMarkup


SGMLCharRef

Purpose

Insert a character reference. The character needs to be mapped as an 8-bit ASCII character in the document type. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLCharRef (Character: string)

Parameters

Character

string


SGMLContentModelDlg

Purpose

Display the Element Content dialog box, which allows you to view an element's content model. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLContentModelDlg (Element: string)

Parameters

Element

string (optional)


SGMLCreateDocType

Purpose

Create a document type entry. You must include at least a document type name and a logic filename. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLCreateDocType (DocTypeName: string; LogicFile: string; LayoutFile: string; AliasFile: string; OptFile1: string; OptFile2: string; OptFile3: string; OptFile4: string; OptFile5: string; OptFile6: string; OptFile7: string; OptFile8: string; OptFile9: string; OptFile10: string)

Parameters

DocTypeName

string

LogicFile

string

LayoutFile

string (optional)

AliasFile

string (optional)

OptFile1

string (optional)

OptFile2

string (optional)

OptFile3

string (optional)

OptFile4

string (optional)

OptFile5

string (optional)

OptFile6

string (optional)

OptFile7

string (optional)

OptFile8

string (optional)

OptFile9

string (optional)

OptFile10

string (optional)


SGMLDeleteAttribute

Purpose

Delete an attribute. The attribute must be present in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLDeleteAttribute (Name: string)

Parameters

Name

string

See Also

SGMLAddToAttrList, SGMLBoxDeleteAttribute


SGMLDeleteDocType

Purpose

Delete a document type entry. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLDeleteDocType (DocTypeName: string)

Parameters

DocTypeName

string


SGMLDocTypeDlg

Purpose

Display the Document Types dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLDocTypeDlg ()


SGMLEditAttributeDlg

Purpose

Display the Edit Attribute dialog box. This command differs from SGMLEditAttributesDlg in that it allows you to edit a specific attribute of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLEditAttributeDlg (Name: string)

Parameters

Name

string

See Also

SGMLEditAttributesDlg, SGMLEditBoxAttributeDlg


SGMLEditAttributesDlg

Purpose

Display the Edit Attributes dialog box. This command differs from SGMLEditAttributeDlg in that it allows you to edit all the attributes of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLEditAttributesDlg ()

See Also

SGMLEditAttributeDlg, SGMLEditBoxAttributeDlg


SGMLEditBoxAttributeDlg

Purpose

Display the Edit Attribute dialog box. This command differs from SGMLEditBoxAttributesDlg in that it allows you to edit a specific attribute of an element of the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLEditBoxAttributeDlg (Element: string; Name: string)

Parameters

Element

string

Name

string

See Also

SGMLEditAttributesDlg, SGMLEditAttributeDlg


SGMLEditBoxAttributesDlg

Purpose

Edit the attributes of a box element.

Syntax

SGMLEditBoxAttributesDlg (Element: string)

Parameters

Element

string


SGMLElementsDlg

Purpose

Display the SGML Elements dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLElementsDlg ()


SGMLEntityRef

Purpose

Insert an entity reference. For text references, entity references must be declared in the document type. For file references, entity references must be user declared or declared in the document type. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLEntityRef (Name: string)

Parameters

Name

string

See Also

SGMLFileRefNew


SGMLFileRefDataType

Purpose

Specify the data type of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefDataType (FileRefName: string; DataType: enumeration)

Parameters

FileRefName

string

DataType

enumeration

CDATA!

NDATA!

None!

SDATA!

SUBDOC!


SGMLFileRefDelAttribute

Purpose

Delete a file reference notation attribute. Can be used only if a user-declared file reference exists for the specified FileRefName. An attribute of the specified Name must already exist for the file reference. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefDelAttribute (FileRefName: string; Name: string)

Parameters

FileRefName

string

Name

string


SGMLFileRefDelete

Purpose

Delete a file reference declaration and all entity references that use the file reference declaration. Only user-declared file references can be deleted. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefDelete (Name: string)

Parameters

Name

string


SGMLFileRefDlg

Purpose

Display the File References dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefDlg ()


SGMLFileRefFilePath

Purpose

Specify the file path of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefFilePath (FileRefName: string; FilePath: string)

Parameters

FileRefName

string

FilePath

string


SGMLFileRefNew

Purpose

Create a file reference declaration. A file reference of the Name cannot already exist. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefNew (Name: string; PublicID: string; FilePath: string; DataType: enumeration; NotationName: string)

Parameters

Name

string

PublicID

string

FilePath

string (optional)

DataType

enumeration (optional)

CDATA!

NDATA!

None!

SDATA!

SUBDOC!

NotationName

string (optional)


SGMLFileRefNewAttribute

Purpose

Create a file reference notation attribute. Can be used only if a user-declared file reference exists for the specified FileRefName. An attribute of the specified Name cannot already exist for the file reference. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefNewAttribute (FileRefName: string; Name: string; Value: string)

Parameters

FileRefName

string

Name

string

Value

string


SGMLFileRefNotation

Purpose

Specify the notation for a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefNotation (FileRefName: string; Notation: string)

Parameters

FileRefName

string

Notation

string


SGMLFileRefPubID

Purpose

Specify the public identifier for a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefPubID (FileRefName: string; PublicID: string)

Parameters

FileRefName

string

PublicID

string


SGMLFileRefRename

Purpose

Change the name of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFileRefRename (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string


SGMLFindElementEnd

Purpose

Position the insertion point after the current element's end tag. If the element is defined by the layout file to be a Corel WordPerfect type (for example, a header, footer, or image), and the element's end is located at the end of the WordPerfect type, the type is also exited. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindElementEnd ()


SGMLFindElementStart

Purpose

Position the insertion point at the beginning of the current element. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindElementStart (CursorPos: enumeration)

Parameters

CursorPos

enumeration (optional)

After!

Before!


SGMLFindNextTable

Purpose

Position the insertion point in the next table. Can be used only with a document type that allows table tagging. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindNextTable ()


SGMLFindStartTag

Purpose

Find the start of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindStartTag (Name: string; Direction: enumeration; AttributeEditFind: enumeration)

Parameters

Name

string (optional)

Direction

enumeration (optional)

Either! Searches backward first, then forward for the start tag.

Next!

Previous!

AttributeEditFind

enumeration (optional)

No!

Yes! Limits the find to start tags with attributes present or start tags with attributes declared in the document type.


SGMLGetAttributeData

Purpose

Assign information to a variable about the attributes of the current element. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetAttributeData (Variable: variable; Item: enumeration; Type: enumeration; Element: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the attributes of a given type.

DefaultValue! Returns the default value for the attribute specified in the document type. The string returned can be CONREF, CURRENT, IMPLIED, REQUIRED, or a string up to 1000 characters.

ErrorType! Returns one of the following values, representing the type of error for the attribute:

0 No error

1 Unknown attribute

2 Invalid character in NAME attribute

3 Invalid character in NMTOKEN attribute

4 Invalid character in NUMBER attribute

5 Invalid character in NUTOKEN attribute

6 An attribute value exceeds NAMELEN

7 Only one value is allowed

8 Attribute length exceeds LITLEN

9 No mapping for an attribute extended character

10 Attribute has no value assigned

11 Entity open (&...) in the attribute is not validated

12 Char Ref (&#...) in the attribute is not validated

13 An attribute value is not in the declared list

14 Attribute is not the declared FIXED value

15 Attribute is not a declared entity

16 Attribute is not a data or SUBDOC entity

17 More than one attribute has the same name

Name! Returns the name of the attribute specified by ItemNum.

Status! Returns one of the following values, representing the statue of the attribute:

0 Does not have a value currently specified

1 Has a value

2 Has a value but is in error

Type! Returns one of the following values:

0 Unknown

1 FIXED

2 The declared type was a list

3 CDATA

4 ENTITIES

5 ENTITY

6 ID

7 IDREF

8 IDREFS

9 NAME

10 NAMES

11 NMTOKEN

12 NMTOKENS

13 NOTATION

14 NUMBER

15 NUMBERS

16 NUTOKEN

17 NUTOKENS

Value! Returns the value of an attribute specified in the tag. (Value! always returns an error if the attribute has not been given a value.)

Type

enumeration Specify the type of attribute a variable belongs to.

All! Returns information about all attributes available in the open or previous element, relative to the insertion point.

InTag! Returns information about the attributes that have been given a value in the open or previous element, relative to the insertion point.

Invalid! Returns information about the attributes that have been given an invalid value in the open or previous element, relative to the insertion point.

NotInTag! Returns information about the attributes that have not been given a value in the open or previous element, relative to the insertion point.

Element

enumeration Specify which element to act on. Previous elements are used for empty elements.

Open!

Previous!

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.


SGMLGetElementData

Purpose

Assign information to a variable about the elements available in a Corel WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetElementData (Variable: variable; Item: enumeration; Type: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the elements of a given type.

LSIType! Returns one of the following values:

0 Watermark B

1 Endnote

2 Header A

3 Header B

4 Footer A

5 Footer B

6 Footnote

7 Image Box

8 Watermark A

9 Table

10 Text Box

11 Equation Box

12 Normal (unspecified)

Name! Returns the name of the element specified by ItemNum.

Type

enumeration

All! Returns information about all elements available in the document.

Open! Returns information about all elements that are open at the insertion point.

Previous!

Valid! Returns information about elements that are valid to insert at the insertion point (with the exception of inclusions).

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.


SGMLGetFileRefData

Purpose

Assign information to a variable about the external file references available in a Corel WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetFileRefData (Variable: variable; Item: enumeration; Type: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the file references of a given type.

DataType! Returns one of the following values:

0 None

1 CDATA

2 NDATA

3 SDATA

4 SUBDOC

FilePath! Returns the file path of the file reference.

Name! Returns the name of the file reference.

Notation! Returns the notation type of the file reference.

PublicID! Returns the public identifier of the file reference.

Type

enumeration

DTD! Returns information about all file references declared in the document type.

User! Returns information about all file references the user has defined in the document.

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.


SGMLIDIDREFListDlg

Purpose

Display the list of ID and IDREF attributes. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLIDIDREFListDlg ()


SGMLIgnore

Purpose

Insert SGML IGNORE codes. If you insert IGNORE codes around selected text that includes start and end tags, other SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLIgnore ()


SGMLInsertElement

Purpose

Insert an element. If you insert an element around selected text that includes start and end tags, SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLInsertElement (Name: string)

Parameters

Name

string


SGMLLoadDocType

Purpose

Select a document type for the current document. The document type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI) and an alias file (.LNM). This command is valid only if the Corel WordPerfect program component is installed.

Syntax

SGMLLoadDocType (DocTypeName: string)

Parameters

DocTypeName

string


SGMLLogicErrorDlg

Purpose

Display the Logic Errors dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLLogicErrorDlg ()


SGMLNewAttribute

Purpose

Create an attribute value. The name of the attribute must be different from any attribute in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLNewAttribute (Name: string; Value: string)

Parameters

Name

string

Value

string

See Also

SGMLReplaceAttribute, SGMLBoxAttribute


SGMLOpenFileDlg

Purpose

Display the Open SGML File dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLOpenFileDlg ()

See Also

SGMLOpenFileOptions


SGMLOpenFileOptions

Purpose

Specify the document type and options for retrieving an SGML document. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLOpenFileOptions (WhiteSpaceConvert: enumeration; OmitTags: enumeration; DocTypeName: string)

Parameters

WhiteSpaceConvert

enumeration (optional) This parameter is obsolete, but it has been left in the program for compatibility with previous versions of Corel WordPerfect.

No!

Yes!

OmitTags

enumeration

No!

Yes!

DocTypeName

string

See Also

SGMLOpenFileDlg


SGMLPrefDlg

Purpose

Display the SGML Settings dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLPrefDlg ()


SGMLPreferences

Purpose

Specify a default directory for the document type files and the display settings for tags in the document and in Reveal Codes. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLPreferences (DocTypeDir: string; Show: enumeration; RevealCode: enumeration; Red: numeric; Green: numeric; Blue: numeric; FontSize: measurement)

Parameters

DocTypeDir

string (optional)

Show

enumeration (optional)

Hide!

Show!

ShowAsMarkers!

RevealCode

enumeration (optional)

ShowAttributes!

ShowLayout!

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

FontSize

measurement (optional)


SGMLRenameElement

Purpose

Rename the element previous to the insertion point. Does not change the element attributes. This command is valid only if the Corel WordPerfect SGML program component is installed. Not recordable.

Syntax

SGMLRenameElement (Name: string)

Parameters

Name

string


SGMLReplaceAttribute

Purpose

Replace the current attribute value. The attribute must be present in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLReplaceAttribute (Name: string; Value: string)

Parameters

Name

string

Value

string

See Also

SGMLAddToAttrList, SGMLNewAttribute, SGMLBoxAttribute


SGMLRootElement

Purpose

Change the root element of the current document type. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLRootElement (Element: string)

Parameters

Element

string


SGMLRootElementDlg

Purpose

Display the Select Root Element dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLRootElementDlg ()


SGMLSaveAsOptions

Purpose

Set options for saving a document in SGML format. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSaveAsOptions (DocTypeDeclaration: enumeration; SGMLDeclaration: enumeration; ConvertSRT: enumeration)

Parameters

DocTypeDeclaration

enumeration Include the Document Type Declaration in the saved SGML document. Default: Yes!

No!

Yes!

SGMLDeclarationIenumeration (optional) Include the SGML declaration at the beginning of the file. Default: No!

No!

Yes!

ConvertSRT

enumeration (optional) Convert soft returns in the document to hard returns in the saved SGML document. This command is obsolete in version 8; it has been left in the program for backwards compatibility.

No!

Yes!


SGMLSelectElement

Purpose

Select the open element at the insertion point. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectElement ()


SGMLSelectLayout

Purpose

Change the layout of the SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectLayout (LayoutFile: string)

Parameters

LayoutFile

string (optional)

See Also

SGMLSelectLayoutDlg


SGMLSelectLayoutDlg

Purpose

Display the Select Layouts dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectLayoutDlg ()

See Also

SGMLSelectLayout


SGMLSetValidation

Purpose

Specify the types of errors to find during validation. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSetValidation ({Options: enumeration; })

Parameters

Options

enumeration (optional)

CharMap!

Entity!

EntityDecl!

IdIdref!

Logic!

TextSeq!


SGMLSplitElement

Purpose

Split the current SGML element into two separate elements of the same type. The attribute values will be duplicated for each element created. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSplitElement ()


SGMLTagAllTables

Purpose

Tag all tables in a document. Can be used only with a document type that allows table tagging. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagAllTables ()


SGMLTagBox

Purpose

Tag the selected box based on the mappings specified in the layout (.LSI) file. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagBox ()


SGMLTagCurrentTable

Purpose

Tag the current table. Your document type must use one of the table methods supported by the SGML edition of Corel WordPerfect. For more information about the supported table methods, see Tag Tables in the main Help file. Any elements that are not part of the basic table structure (see below) must start and end within a single table cell. Any elements that are part of the basic table structure must start within the table.

Basic Table Structure:

For CALS: colspec, entry, row, spanspec, table, tbody, tgroup, thead, and title.

For AAP: ctbf, ctbl, ctby, ctc, cte, cth, cthd, cthr, ctr, ctsb1, ctsb2, ctsb3, ctsb4, and ctsh.

For HTML: table, tr, td, th.For WP6: table, cell, colinf, and row.

For WP6MIN: table, cell, and row.

For WP: wpcell, wprow, and wptable.

This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagCurrentTable ()


SGMLTagTablesDlg

Purpose

Display the Tag Tables dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagTablesDlg ()


SGMLTextRefDlg

Purpose

Display the Text References dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed. Not recordable.

Syntax

SGMLTextRefDlg ()


SGMLUnloadDocType

Purpose

Deselect a document type for the current document. The document type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI) and an alias file (.LNM). This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLUnloadDocType ()


SGMLValidate

Purpose

Find the next validation error. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLValidate ()


SGMLValidationDlg

Purpose

Display the Validation dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLValidationDlg ()


ShadowCursorOptions

Purpose

Set the shape, type, and color of the shadow cursor.

Syntax

ShadowCursorOptions (State: enumeration; Snap: enumeration; Shape: enumeration; ColorRed: numeric; ColorGreen: numeric; ColorBlue: numeric)

Parameters

State

enumeration (optional)

Text!

TextAndWhiteSpace!

WhiteSpace!

Snap

enumeration (optional)

Indents!

Margins!

Spaces!

Tabs!

Shape

enumeration (optional)

Arrows!

BottomArrow!

BrokenCaret!

Caret!

DottedCaret!

IBeam!

ColorRed

numeric (optional)

ColorGreen

numeric (optional)

ColorBlue

numeric (optional)


ShadowCursorShow

Purpose

Turn the shadow cursor on or off. Omitting the parameter toggles the state. This command also changes the display settings for the shadow cursor.

Syntax

boolean := ShadowCursorShow (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

PrefDisplaySet


ShiftTabKey

Purpose

Insert a [Hd Back Tab] code at the insertion point. If the insertion point is in a table, it will go to the previous table cell. If the insertion point is in an outline, it will go to the previous outline level.

Syntax

ShiftTabKey ()


ShowBoxes

Purpose

Display graphics boxes.

Syntax

ShowBoxes (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?ShowBoxes


ShowGraphics

Purpose

Toggle Graphics.

Syntax

ShowGraphics ()


ShowHiddenText

Purpose

Toggle Hidden Text.

Syntax

ShowHiddenText ()


ShowSGMLTree

Purpose

Display or hide the SGML Tree. The tree will be displayed only if an SGML document is being edited. Switching to a non-SGML document does not close the tree. As soon as all SGML documents are closed, the tree will be hidden. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

ShowSGMLTree (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


ShowSymbols

Purpose

Toggle display of document symbols for codes such as [HRt], [Indent], and [Tab].

Syntax

ShowSymbols ()


SingleSmartQuote

Purpose

Turn Single SmartQuotes on or off and specify a quote character.

Syntax

SingleSmartQuote (State: enumeration; OpenSingleQuote: numeric; CloseSingleQuote: numeric)

Parameters

State

enumeration (optional)

Off!

On!

OpenSingleQuote

numeric (optional) The numeric equivalent of the quote character.

CloseSingleQuote

numeric (optional) The numeric equivalent of the quote character.

See Also

DoubleSmartQuote, UseRegQuotesWithNumbers


SingleSpaceInSentence

Purpose

Change double spaces in a sentence to single spaces.

Syntax

SingleSpaceInSentence (State: enumeration)

Parameters

State

enumeration

Off!

On!


SoftHyphen

Purpose

Insert a soft hyphen at the insertion point. If the word needs to be hyphenated, it will break at the soft hyphen.

Syntax

SoftHyphen ()


SoftSpace

Purpose

Insert a space at the insertion point.

Syntax

SoftSpace ()

See Also

HardSpace


Sort

Purpose

Specify a file to sort and a file to which the changes are written.

Syntax

Sort (InFile: string; OutFile: string; State: enumeration)

Parameters

InFile

string (optional) Default: current document.

OutFile

string (optional) Default: current document.

State

enumeration (optional)

NoUndo!

Undo!

See Also

SortAction, SortCaseOrder, SortDlg, SortKeys, SortSelectString, SortType, SortUndo


SortAction

Purpose

Sort a file or selected records.

Syntax

SortAction (SortAction: enumeration)

Parameters

SortAction

enumeration

SelectOnly!

Sort!

See Also

?SortGetAction, ?SortGetCase, Sort, SortCaseOrder, SortKeys, SortSelectString, SortType, SortUndo


SortCaseOrder

Purpose

Specify the case priority in a sort.

Syntax

SortCaseOrder (Case: enumeration)

Parameters

Case

enumeration

LowercaseFirst!

UppercaseFirst!

See Also

?SortGetAction, ?SortGetCase, Sort, SortAction, SortKeys, SortType


SortDlg

Purpose

Display the Sort (Source and Destination) dialog box.

Syntax

SortDlg ()


SortKeys

Purpose

Specify the sort key options.

Syntax

SortKeys ({Field: numeric; Line: numeric; Word: numeric; SortType: enumeration; SortOrder: enumeration; })

Parameters

Field

numeric (optional)

Line

numeric (optional) The line to sort within a specified field. This parameter is always 1 if the sort type is Line.

Word

numeric (optional) The word to sort within a specified line and field.

SortType

enumeration (optional)

Alphanumeric!

Numeric!

SortOrder

enumeration (optional) Specify an ascending (a-z and 0-9) or descending (z-a and 9-0) sort.

Ascending!

Descending!

See Also

Sort, SortCaseOrder


SortSelectString

Purpose

Insert a character string into the Select Records text box of the Sort dialog box.

Syntax

SortSelectString (SelectString: string)

Parameters

SelectString

string

See Also

Sort


SortType

Purpose

Specify a source file format. ParagraphSort! sorts files leaving paragraphs intact. ColumnSort! sorts parallel columns. TableSort! sorts tables (rows = lines, cells = fields). MergeSort! sorts data files.

Syntax

SortType (SortType: enumeration)

Parameters

SortType

enumeration

ColumnSort!

LineSort!

MergeSort!

ParagraphSort!

TableSort!

See Also

Sort


SortUndo

Purpose

Enable or disable Undo in Sort.

Syntax

SortUndo (State: enumeration)

Parameters

State

enumeration

NoUndo!

Undo!

See Also

?SortGetUndo, Sort, SortAction


SoundClipAddInstance

Purpose

Add another reference to a sound clip already in the document.

Syntax

SoundClipAddInstance (Description: string)

Parameters

Description

string The sound clip name.


SoundClipCreate

Purpose

Insert a sound clip from a file into the Sound Clips in the Document dialog box.

Syntax

SoundClipCreate (Description: string; Filename: string; SoundFileType: enumeration; ClipType: enumeration; LeftVolume: numeric; RightVolume: numeric)

Parameters

Description

string

Filename

string

SoundFileType

enumeration

InDoc!

OnDisk!

ClipType

enumeration

DigitalAudio!

MIDI!

LeftVolume

numeric

RightVolume

numeric


SoundClipDelete

Purpose

Delete a sound clip.

Syntax

SoundClipDelete (Description: string)

Parameters

Description

string


SoundClipDlg

Purpose

Display the Sound Clips dialog box.

Syntax

SoundClipDlg ()


SoundClipPlayNext

Purpose

Play the next sound clip in the document.

Syntax

SoundClipPlayNext (Description: string; StartPos: numeric; EndPos: numeric)

Parameters

Description

string (optional)

StartPos

numeric (optional) The sound clip starting point in seconds.

EndPos

numeric (optional) The sound clip ending point in seconds.


SoundClipSetAttributes

Purpose

Specify sound clip attributes.

Syntax

SoundClipSetAttributes (Description: string; Type: enumeration; LeftVolume: numeric; RightVolume: numeric)

Parameters

Description

string

Type

enumeration

DigitalAudio!

MIDI!

LeftVolume

numeric (optional)

RightVolume

numeric (optional)


SoundClipSetDescription

Purpose

Assign a new description to a sound clip.

Syntax

SoundClipSetDescription (OldDescription: string; NewDescription: string)

Parameters

OldDescription

string

NewDescription

string


SoundClipSetFilename

Purpose

Change a sound clip to point to a different sound file on disk.

Syntax

SoundClipSetFilename (Description: string; Filename: string; Location: enumeration)

Parameters

Description

string

Filename

string

Location

enumeration

InDoc!

OnDisk!


SpecificDeleteStringBegin

Purpose

Delete specific codes. Follow with a command that specifies the specific code to delete, then SpecificStringEnd. Use with commands such as ReplaceBackward and ReplaceForward.

Syntax

SpecificDeleteStringBegin ()

See Also

MatchSelection, ReplaceBackward, ReplaceForward, SpecificReplaceStringBegin, SpecificSearchStringBegin, SpecificStringEnd


SpecificReplaceStringBegin

Purpose

Specify a specific code replacement. Follow with a command corresponding to a specific replacement code. Use with commands such as ReplaceBackward, ReplaceForward, SpecificSearchStringBegin, and SpecificStringEnd.

Syntax

SpecificReplaceStringBegin ()

See Also

ReplaceBackward, ReplaceForward, SpecificSearchStringBegin, SpecificStringEnd


SpecificSearchStringBegin

Purpose

Find a specific code. Follow with the macro command corresponding to the specific code to be found. Use with SpecificStringEnd.

Syntax

SpecificSearchStringBegin ()

See Also

SearchNext, SearchPrevious, SpecificDeleteStringBegin, SpecificReplaceStringBegin, SpecificStringEnd


SpecificStringEnd

Purpose

End a specific code search. Precede with SpecificSearchStringBegin, SpecificReplaceStringBegin, or SpecificDeleteStringBegin, and a command which specifies the specific code to search.

Syntax

SpecificStringEnd ()

See Also

SpecificDeleteStringBegin, SpecificReplaceStringBegin, SpecificSearchStringBegin


SpellAsYouGo

Purpose

Turn or toggle Spell-As-You-Go on or off, and return the original state. If the macro toolbar is active in the current document, this command causes a run-time error.

Syntax

boolean := SpellAsYouGo (State: enumeration)

Parameters

State

enumeration (optional) Omitting this parameter toggles Spell-As-You-Go on or off.

Off!

On!

See Also

IsTokenValid


SpreadsheetShowLinkCode

Purpose

Display or hide spreadsheet link codes.

Syntax

SpreadsheetShowLinkCode (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

ImportOptionsDlg


SpreadsheetUpdateOnRetrieve

Purpose

Turn the Update on retrieve option on or off for spreadsheet/database links.

Syntax

SpreadsheetUpdateOnRetrieve (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?AutoUpdate, ImportOptionsDlg


StatusBarShow

Purpose

Display or hide the status bar.

Syntax

StatusBarShow (State: enumeration)

Parameters

State

enumeration (optional) Default: toggle.

Off!

On!

See Also

?StatusBarActive, ViewToolbarsDlg


StyleCodes

Purpose

Edit style codes. Use with commands such as StyleEditBegin, StyleEditEnd, and SubstructureExit.

Syntax

StyleCodes (State: enumeration; Library: enumeration)

Parameters

State

enumeration (optional) Include codes that take effect when the style is off.

WithOffCodes!

WithoutOffCodes!

Library

enumeration (optional) The styles codes location.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleEditBegin, StyleEditEnd


StyleCopy

Purpose

Copy a style between the current document, the personal library, and the shared library.

Syntax

StyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; NewName: string)

Parameters

Style

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

FromLibrary

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

NewName

string (optional) The new style name.

See Also

StyleCreate, StyleDelete


StyleCreate

Purpose

Create a style.

Syntax

StyleCreate (Name: string; Type: enumeration; CreateFlag: enumeration; Library: enumeration)

Parameters

Name

string

Type

enumeration

AutoCharacterStyle!

AutoParagraphStyle!

CharacterStyle!

NewBulletStyle!

OpenStyle!

ParagraphStyle!

CreateFlag

enumeration (optional) The pattern to base a style on.

CreateBulletStyle!

CreateFromCurrent!

CreateFromCurrentHS!

CreateNumberStyle!

CreateOutlineStyle!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleEditBegin, StyleEditEnd


StyleDelete

Purpose

Delete a style.

Syntax

StyleDelete (Style: any; Codes: enumeration; Library: enumeration)

Parameters

Style

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Codes

enumeration Delete or leave style codes.

IncludingCodes!

LeavingCodes!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleCopy, StyleCreate


StyleDescription

Purpose

Change a style description. Use with commands such as StyleEditBegin and StyleEditEnd.

Syntax

StyleDescription (Description: string)

Parameters

Description

string

See Also

StyleCreate, StyleEditBegin, StyleEditEnd


StyleEditBegin

Purpose

Begin editing a style. End with StyleEditEnd. Use with StyleCodes.

Syntax

StyleEditBegin (Style: any; Library: enumeration)

Parameters

Style

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleEditEnd


StyleEditEnd

Purpose

Save or cancel style changes. Use with StyleEditBegin and StyleCodes.

Syntax

StyleEditEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

StyleEditBegin


StyleEnterKeySetting

Purpose

Specify the effect of pressing Enter when a style is on. Use with commands such as StyleEditBegin and StyleEditEnd.

Syntax

StyleEnterKeySetting (Action: enumeration)

Parameters

Action

enumeration

HardReturn!

StyleOff!

StyleOffOn!

See Also

StyleEditBegin, StyleEditEnd, StyleLinkTo


StyleLinkTo

Purpose

Specify a style to turn on when Enter is pressed. Use with commands such as StyleEditBegin and StyleEditEnd.

Syntax

StyleLinkTo (Style: any)

Parameters

Style

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

StyleEditBegin, StyleEditEnd, StyleEnterKeySetting


StyleOff

Purpose

Turn off a style. Begin with StyleOn.

Syntax

StyleOff (Style: any)

Parameters

Style

any (optional) Use a string to specify a user-defined style.

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

StyleOn


StyleOn

Purpose

Turn on a style. Recordable replacement: StyleSystemOn.

Syntax

StyleOn (Style: any; Action: enumeration)

Parameters

Style

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

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Action

enumeration (optional)

SkipEmptyParagraphs!

See Also

StyleOff, StyleSystemOn


StylePersonalLibrary

Purpose

Specify a DOS Personal Library style file for the current document. Included for DOS compatibility. Use StyleSave or StyleCopy to place a style in a style file.

Syntax

StylePersonalLibrary (Filename: string)

Parameters

Filename

string


StyleRename

Purpose

Rename a style. Use with commands such StyleEditBegin and StyleEditEnd.

Syntax

StyleRename (Name: string)

Parameters

Name

string The new name.

See Also

StyleEditBegin, StyleEditEnd


StyleRetrieve

Purpose

Retrieve the styles in a style file.

Syntax

StyleRetrieve (File: string; Styles: enumeration; Library: enumeration)

Parameters

File

string

Styles

enumeration

AllStyles!

SystemStyles!

UserStyles!

Library

enumeration (optional) The destination library.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleSave


StyleSave

Purpose

Save styles from a library to a style file.

Syntax

StyleSave (Filename: string; StyleType: enumeration; Library: enumeration)

Parameters

Filename

string

StyleType

enumeration

AllStyles!

SystemStyles!

UserStyles!

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleRetrieve


StyleSharedLibrary

Purpose

Specify a DOS shared library style file for the current document. Included for DOS compatibility. StyleSave or StyleCopy places a style in a style file.

Syntax

StyleSharedLibrary (Filename: string)

Parameters

Filename

string


StylesListDlg

Purpose

Display the Style List dialog box.

Syntax

StylesListDlg ()


StyleSystemOn

Purpose

Turn on a Corel WordPerfect or user-defined style.

Syntax

StyleSystemOn (Style: any; Action: enumeration)

Parameters

Style

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Action

enumeration (optional)

SkipEmptyParagraphs!


StyleType

Purpose

Specify a style type. Use with commands such as StyleEditBegin and StyleEditEnd.

Syntax

StyleType (Type: enumeration)

Parameters

Type

enumeration

AutoCharacterStyle!

AutoParagraphStyle!

CharacterStyle!

NewBulletStyle!

OpenStyle!

ParagraphStyle!

See Also

StyleEditBegin, StyleEditEnd


StyleUpdate

Purpose

Update all styles in the current document.

Syntax

StyleUpdate ()


SubdividePage

Purpose

Divide a physical page into logical pages.

Syntax

SubdividePage (Columns: numeric; Rows: numeric)

Parameters

Columns

numeric The number of logical page columns on a physical page.

Rows

numeric The number of logical page rows on a physical page.


SubdividePageDlg

Purpose

Display the Divide Page tab of the Page Setup dialog box.

Syntax

SubdividePageDlg ()


SubdividePageOff

Purpose

Turn off Subdivide Page.

Syntax

SubdividePageOff ()

See Also

SubdividePage


SubdocInclude

Purpose

Insert a document into the current document as a subdocument.

Syntax

SubdocInclude (DocumentName: string)

Parameters

DocumentName

string The file to insert.


SubstructureExit

Purpose

Close the current substructure and optionally open an existing substructure of the same type.

Syntax

SubstructureExit (Action: enumeration)

Parameters

Action

enumeration (optional)

Next!

Previous!


Suppress

Purpose

Turn off the specified page formatting items for the current page.

Syntax

Suppress ({Item: enumeration; })

Parameters

Item

enumeration

FooterA!

FooterB!

HeaderA!

HeaderB!

PageNumberBottomCenter!

PageNumbering!

WatermarkA!

WatermarkB!


SwitchDoc

Purpose

Specify a document to switch to.

Syntax

SwitchDoc (DocNum: numeric)

Parameters

DocNum

numeric


Tab

Purpose

Insert a tab.

Syntax

Tab ()

See Also

TabKey, TabSet


TabAdd

Purpose

Add one or more tab sets to the current tab setting. If the parameter SpaceBetweenTabs is included, all tabs following an added tab reset to the new type and spacing.

Syntax

TabAdd (Position: measurement; Type: enumeration; SpaceBetweenTabs: measurement)

Parameters

Position

measurement The tab position relative to left edge of the page.

Type

enumeration

TabCenter!

TabCenterDot!

TabDecimal!

TabDecimalDot!

TabLeft!

TabLeftDot!

TabRight!

TabRightDot!

SpaceBetweenTabs

measurement (optional)

See Also

Tab, TabSet


TabBarIconShow

Purpose

Turn Tab Bar Icons on or off for the current session and return the current state. This command does not change display settings for Tab Bar Icons.

Syntax

boolean := TabBarIconShow (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

PrefDisplaySet


TabCenter

Purpose

Insert a Hard Centered Tab code.

Syntax

TabCenter (Type: enumeration)

Parameters

Type

enumeration (optional)

DotLeader!

Normal!

See Also

TabDecimal, TabLeft, TabRight


TabCenterDot

Purpose

Insert a Hard Centered Tab code with a dot leader. Recordable substitute: TabCenter.

Syntax

TabCenterDot ()


TabClearAll

Purpose

Clear all tab settings.

Syntax

TabClearAll ()


TabDecimal

Purpose

Insert a hard decimal-aligned tab.

Syntax

TabDecimal (Type: enumeration)

Parameters

Type

enumeration (optional)

DotLeader!

Normal!

See Also

TabCenter, TabLeft, TabRight


TabDecimalDot

Purpose

Insert a Hard Decimal Tab code with a dot leader. Recordable substitute: TabDecimal.

Syntax

TabDecimalDot ()


TabDelete

Purpose

Delete one tab setting without affecting any other tab settings.

Syntax

TabDelete (Position: measurement)

Parameters

Position

measurement

See Also

Tab, TabAdd, TabSet


TabForced

Purpose

Insert a forced tab. Forced tabs cannot be replaced by the QuickIndent feature. Recordable substitute: TabInsert.

Syntax

TabForced ()

See Also

TabInsert, QuickCorrectQuickIndentSet


TabInsert

Purpose

Insert a tab into the document.

Syntax

TabInsert ()

See Also

TabForced


TabKey

Purpose

Perform the functions of Tab: insert a tab, go to the next table cell, or go to the next outline level, depending on the location of the insertion point.

Syntax

TabKey ()

See Also

Tab


TableAdjustBegin

Purpose

Begin table adjustments from the Ruler. Follow with commands such as TableAdjustColumnWidth and TableAdjustPosition, and end with TableAdjustEnd.

Syntax

TableAdjustBegin ()

See Also

TableAdjustEnd, TableAdjustPosition


TableAdjustColumnWidth

Purpose

Specify a column width in WordPerfect units when adjusting columns from the Ruler. Use with TableAdjustBegin and TableAdjustEnd.

Syntax

TableAdjustColumnWidth (Column: numeric; Width: measurement)

Parameters

Column

numeric The leftmost column is 0.

Width

measurement

See Also

TableAdjustBegin, TableAdjustEnd


TableAdjustEnd

Purpose

End table adjustments from the Ruler. Precede with TableAdjustBegin and commands such as TableAdjustColumnWidth and TableAdjustPosition.

Syntax

TableAdjustEnd ()

See Also

TableAdjustBegin, TableAdjustColumnWidth, TableAdjustPosition


TableAdjustPosition

Purpose

Specify the number of WordPerfect units from the left margin to the left edge of a table when adjusting table position from the Ruler.

Syntax

TableAdjustPosition (Position: measurement)

Parameters

Position

measurement

See Also

TableAdjustBegin, TableAdjustEnd, TableMarginLeft


TableAlternateFillSet

Purpose

Specify the type of alternating table fill and the cell range to which the fill is applied.

Syntax

TableAlternateFillSet (State: enumeration; Span: numeric; AlternateSpan: numeric)

Parameters

State

enumeration

CheckerBoard!

Column!

Off!

Row!

Span

numeric (optional)

AlternateSpan

numeric (optional)

See Also

TableFill, TableSecondFill


TableAppendRow

Purpose

Insert a new row below the current row.

Syntax

TableAppendRow ()

See Also

TableInsertRow


TableApplyStyle

Purpose

Apply a table style using Table SpeedFormat.

Syntax

TableApplyStyle (Style: any; ResetAttributes: enumeration; ShowIn60: enumeration)

Parameters

Style

any

NoTableStyle!

TableStyle28!

TableStyle1!

TableStyle29!

TableStyle10!

TableStyle3!

TableStyle11!

TableStyle30!

TableStyle12!

TableStyle31!

TableStyle13!

TableStyle32!

TableStyle14!

TableStyle33!

TableStyle15!

TableStyle34!

TableStyle16!

TableStyle35!

TableStyle17!

TableStyle36!

TableStyle18!

TableStyle37!

TableStyle19!

TableStyle38!

TableStyle2!

TableStyle39!

TableStyle20!

TableStyle4!

TableStyle21!

TableStyle40!

TableStyle22!

TableStyle5!

TableStyle23!

TableStyle6!

TableStyle24!

TableStyle7!

TableStyle25!

TableStyle8!

TableStyle26!

TableStyle9!

TableStyle27!

 

ResetAttributes

enumeration (optional) Clear the current table settings.

No!

Yes!

ShowIn60

enumeration (optional) Apply a style on a cell-by-cell basis.

No!

Yes!


TableAttributeOff

Purpose

Turn off the specified font attributes and relative font size attributes in a table.

Syntax

TableAttributeOff ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableAttributeOn


TableAttributeOn

Purpose

Turn on the specified character attributes in a table.

Syntax

TableAttributeOn ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableAttributeOff


TableAutoCalc

Purpose

Specify automatic calculation for tables.

Syntax

TableAutoCalc (State: enumeration)

Parameters

State

enumeration

AutoDoc!

AutoTbl!

Off!

See Also

TableCalculate, TableCalculateAll, TableCalculateDlg, TableUpdateAssociatedCharts


TableAutoFill

Purpose

Use TableDataFill to increment values across a row or down a column.

Syntax

TableAutoFill ()


TableBlockOff

Purpose

Turn off Select in a table.

Syntax

TableBlockOff ()


TableBlockOn

Purpose

Turn on Select in a table.

Syntax

TableBlockOn ()


TableBorder

Purpose

Specify a table border type. Use with commands such as TableBorderEditBegin and TableBorderEditEnd.

Syntax

TableBorder (Style: any)

Parameters

Style

any

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

See Also

TableBorderEditBegin, TableBorderEditEnd


TableBorderEditBegin

Purpose

Begin table border editing. Follow with editing commands and TableBorderEditEnd.

Syntax

TableBorderEditBegin ()

See Also

TableBorderEditEnd


TableBorderEditEnd

Purpose

Save table border editing changes. Precede with TableBorderEditBegin and editing commands.

Syntax

TableBorderEditEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

TableBorderEditBegin


TableCalculate

Purpose

Calculate the formula values in the current table or selected cells.

Syntax

TableCalculate ()

See Also

TableCalculateAll, TableFormula


TableCalculateAll

Purpose

Calculate the formula values for all tables and floating cells in the current document.

Syntax

TableCalculateAll ()

See Also

TableCalculate


TableCalculateDlg

Purpose

Display the Calculate dialog box.

Syntax

TableCalculateDlg ()

See Also

TableCalculate


TableCellAttributeOff

Purpose

Turn off the specified font appearance, position, and relative size attributes in the selected cells.

Syntax

TableCellAttributeOff ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableCellAttributeOn


TableCellAttributeOn

Purpose

Apply the specified font appearance, position, and relative size attributes of the selected cells.

Syntax

TableCellAttributeOn ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableCellAttributeOff


TableCellCopy

Purpose

Copy the content of the specified cell(s) to the Clipboard, and paste it in the cell(s) specified by the CopyType parameter.

Syntax

TableCellCopy (CopyType: enumeration; Count: numeric)

Parameters

CopyType

enumeration

Cell!

Down!

Right!

Count

numeric (optional) The number of cells to paste the copied cell into. Use when the CopyType parameter is Down! or Right!.

See Also

EditCopy, EditPaste


TableCellDiagonalLine

Purpose

Add diagonal lines to a table cell.

Syntax

TableCellDiagonalLine (Diagonal: enumeration)

Parameters

Diagonal

enumeration

BotLeftToTopRight!

None!

TopLeftToBotRight!

TwoDiagonals!


TableCellDiagonalLineQry

Purpose

Return the diagonal lines options to active in the current table selection.

Syntax

numeric := TableCellDiagonalLineQry ()

See Also

TableCellDiagonalLine


TableCellFillColors

Purpose

Specify the foreground and background colors for the current cell or selected cells.

Syntax

TableCellFillColors (ForeColorName: string; ForeColorRed: numeric; ForeColorGreen: numeric; ForeColorBlue: numeric; ForeColorShade: numeric; BackColorName: string; BackColorRed: numeric; BackColorGreen: numeric; BackColorBlue: numeric; BackColorShade: numeric)

Parameters

ForeColorName

string (optional)

ForeColorRed

numeric (optional) Value: 0-255.

ForeColorGreen

numeric (optional) Value: 0-255.

ForeColorBlue

numeric (optional) Value: 0-255.

ForeColorShade

numeric (optional) Percent: 0-100.

BackColorName

string (optional)

BackColorRed

numeric (optional) Value: 0-255.

BackColorGreen

numeric (optional) Value: 0-255.

BackColorBlue

numeric (optional) Value: 0-255.

BackColorShade

numeric (optional) Percent: 0-100.

See Also

FillColors, TableCellFillStyle


TableCellFillStyle

Purpose

Specify a shading style for the current cell or selected cells.

Syntax

TableCellFillStyle (FillPattern: any)

Parameters

FillPattern

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

TableCellFillColors


TableCellIgnoreCalculation

Purpose

Specify one or more selected cells to ignore when calculating formulas.

Syntax

TableCellIgnoreCalculation (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCalculate


TableCellJustification

Purpose

Justify the current cell or selected cells.

Syntax

TableCellJustification (Mode: enumeration)

Parameters

Mode

enumeration

Center!

DecAlign!

Full!

FullAll!

Left!

Right!

See Also

?CellJustification, ?CellSpecificJustification, TableColumnJustification, TableFormatJustification


TableCellLine

Purpose

Change the specified lines around a cell or selected cells, or between selected cells.

Syntax

TableCellLine (Position: enumeration; Style: any)

Parameters

Position

enumeration

Bottom!

Inside!

Left!

Outside!

Right!

Top!

Style

any

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

TableCellLineColor


TableCellLineColor

Purpose

Specify the line color of the current cell or selected cells.

Syntax

TableCellLineColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

See Also

TableCellLine


TableCellLock

Purpose

Lock the current cell or selected cells.

Syntax

TableCellLock (State: enumeration)

Parameters

State

enumerationMacro List Text = No!

Yes!


TableCellNumberAlignCurrency

Purpose

Align the currency symbols in the current cell or selected cells.

Syntax

TableCellNumberAlignCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellNumberSelectCurrency


TableCellNumberDateFormat

Purpose

Specify a date format for one or more selected cells.

Syntax

TableCellNumberDateFormat (DateFormatNumber: numeric)

Parameters

DateFormatNumber

numeric 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 1959-07-05

10 7/5

11 Jul 5

12 12:00:00

See Also

TableCellNumberFormat


TableCellNumberDecimalDigits

Purpose

Specify how many digits appear after the decimal. Use when the FormatType parameter of TableCellNumberFormat is Fixed2!.

Syntax

TableCellNumberDecimalDigits (NumDigits: numeric)

Parameters

NumDigits

numeric

See Also

TableCellNumberFormat


TableCellNumberFormat

Purpose

Specify a number format for the current cell or selected cells.

Syntax

TableCellNumberFormat (FormatType: enumeration)

Parameters

FormatType

enumeration

Accounting!

General!

Commas!

Integer!

Currency!

Percent!

DateFormat!

Scientific!

Fixed2!

TextOnly!

See Also

TableCellNumberAlignCurrency, TableCellNumberDateFormat, TableCellNumberDecimalDigits, TableCellNumberRound, TableCellNumberSelectCurrency


TableCellNumberNegativeNumber

Purpose

Specify how to display negative numbers in the current cell or selected cells.

Syntax

TableCellNumberNegativeNumber (NegDisplayType: enumeration)

Parameters

NegDisplayType

enumeration

CRDR!

Minus!

Parentheses!


TableCellNumberRound

Purpose

Convert round numbers entered as decimals to integers. Use when the FormatType parameter of TableCellNumberFormat is Integer!.

Syntax

TableCellNumberRound (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellNumberFormat


TableCellNumberSelectCurrency

Purpose

Specify an international currency type for the current cell or selected cells.

Syntax

TableCellNumberSelectCurrency (IntlCurrency: enumeration)

Parameters

IntlCurrency

enumeration

Austria!

Israel!

Belgium!

Italy!

BelgiumFrench!

Japan!

Brazil!

Korea!

Canada!

Netherlands!

China!

Norway!

Croatia!

NorwayIntl!

CzechRepublic!

Paraguay!

DefaultCurrency!

Peseta!

Denmark!

Peso!

Dollar!

Poland!

Ecuador!

Portugal!

ElSalvador!

Ruble!

Finland!

RussianRuble!

FinlandIntl!

Singapore!

France!

SlovakRepublic!

FrenchCanada!

Slovenia!

Germany!

SouthAfrica!

Greece!

Sweden!

Guatemala!

Switzerland!

Honduras!

Taiwan!

HongKong!

Turkey!

Hungary!

UnitedKingdom!

Iceland!

Venezuela!

See Also

TableCellNumberAlignCurrency, TableCellNumberFormat


TableCellNumberUseCommas

Purpose

Display commas in numbers with more than three digits to the left of the decimal.

Syntax

TableCellNumberUseCommas (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellNumberFormat


TableCellNumberUseCurrency

Purpose

Display a currency symbol with numbers.

Syntax

TableCellNumberUseCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellNumberFormat


TableCellRotateContents

Purpose

Rotate the contents of the selected table cell(s).

Syntax

TableCellRotateContents (Angle: enumeration)

Parameters

Angle

enumeration

Degrees180!

Degrees270!

Degrees90!

None!


TableCellsJoin

Purpose

Join the selected table cells to form one cell. Recordable substitute: TableJoinCells.

Syntax

TableCellsJoin ()


TableCellUseColumnAttribute

Purpose

Apply a specified column attribute to the current cell or selected cells.

Syntax

TableCellUseColumnAttribute (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellUseColumnJust


TableCellUseColumnJust

Purpose

Turn column justification on or off in the current cell.

Syntax

TableCellUseColumnJust (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellUseColumnAttribute, TableCellUseColumnNumberType


TableCellUseColumnNumberType

Purpose

Turn the current column number type on or off in the current cell or selected cells.

Syntax

TableCellUseColumnNumberType (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableCellUseColumnAttribute, TableCellUseColumnJust


TableCellUseLineColor

Purpose

Turn on table line color for the current cell or selected cells.

Syntax

TableCellUseLineColor ()

See Also

LineStyleEdit, TableCellLineColor


TableCellVerticalAlignment

Purpose

Align the current cell or selected cells vertically.

Syntax

TableCellVerticalAlignment (Alignment: enumeration)

Parameters

Alignment

enumeration

Bottom!

Center!

Top!

See Also

TableCellJustification


TableColumnAttributeOff

Purpose

Turn off the specified character attributes in a table column. Not recordable.

Syntax

TableColumnAttributeOff ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableColumnAttributeOn


TableColumnAttributeOn

Purpose

Turn on the specified character attributes in a table column. Not recordable.

Syntax

TableColumnAttributeOn ({Attribute: enumeration; })

Parameters

Attribute

enumeration (optional)

Bold!

Shadow!

DoubleUnderline!

Small!

Every!

SmallCaps!

ExtraLarge!

Strikeout!

Fine!

Subscript!

Italics!

Superscript!

Large!

Underline!

Outline!

VeryLarge!

Redline!

 

See Also

TableColumnAttributeOff


TableColumnDecimalAlignDigits

Purpose

Specify the number of digits to display between the decimal point and the right edge of cells with decimal align justification in the current column.

Syntax

TableColumnDecimalAlignDigits (Digits: numeric)

Parameters

Digits

numeric

See Also

TableCellJustification, TableColumnDecimalAlignDist, TableColumnJustification, TableFormatJustification


TableColumnDecimalAlignDist

Purpose

Specify the distance between the decimal and the right edge of cells with decimal align justification in the current column.

Syntax

TableColumnDecimalAlignDist (Distance: measurement)

Parameters

Distance

measurement

See Also

TableCellJustification, TableColumnDecimalAlignDigits, TableColumnJustification, TableFormatJustification


TableColumnFixedWidth

Purpose

Specify a fixed column width.

Syntax

TableColumnFixedWidth (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnWidth, TableColumnsFixedWidth


TableColumnJustification

Purpose

Specify column justification.

Syntax

TableColumnJustification (Mode: enumeration)

Parameters

Mode

enumeration

Center!

DecAlign!

Full!

FullAll!

Left!

Right!

See Also

?CellJustification, TableCellJustification, TableFormatJustification


TableColumnMarginLeft

Purpose

Specify the distance between the left edge of a column and the text in the column.

Syntax

TableColumnMarginLeft (Margin: measurement)

Parameters

Margin

measurement

See Also

TableColumnMarginRight, TableMarginLeft, TableMarginRight


TableColumnMarginRight

Purpose

Specify the distance between the right edge of a column and the text in the column.

Syntax

TableColumnMarginRight (Margin: measurement)

Parameters

Margin

measurement

See Also

TableColumnMarginLeft, TableMarginLeft, TableMarginRight


TableColumnNumberAlignCurrency

Purpose

Align the currency symbols in a column.

Syntax

TableColumnNumberAlignCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnNumberSelCurrency


TableColumnNumberDateFormat

Purpose

Specify a date format for the current column.

Syntax

TableColumnNumberDateFormat (DateFmtNum: numeric)

Parameters

DateFmtNum

numeric 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 5Jul59

8 July 5, 1959 (12:00pm)

9 1959-07-05

10 7/5

11 Jul 5

12 15:02:02

See Also

TableColumnNumberFormat


TableColumnNumberDecimalDigits

Purpose

Specify the number of digits after the decimal when TableColumnNumberFormat is Fixed2!. Precede with TableColumnNumberFormat.

Syntax

TableColumnNumberDecimalDigits (NumDigits: numeric)

Parameters

NumDigits

numeric

See Also

TableColumnNumberFormat


TableColumnNumberFormat

Purpose

Specify a number format for the current column.

Syntax

TableColumnNumberFormat (FormatType: enumeration)

Parameters

FormatType

enumeration

Accounting!

General!

Commas!

Integer!

Currency!

Percent!

DateFormat!

Scientific!

Fixed2!

TextOnly!

See Also

TableColumnNumberAlignCurrency, TableColumnNumberDateFormat, TableColumnNumberDecimalDigits, TableColumnNumberRound, TableColumnNumberSelCurrency


TableColumnNumberNegNumber

Purpose

Specify how to display negative numbers in the current column.

Syntax

TableColumnNumberNegNumber (NegDisplayType: enumeration)

Parameters

NegDisplayType

enumeration

CRDR!

Minus!

Parentheses!


TableColumnNumberRound

Purpose

Round numbers entered as decimals to integers in the current column when TableColumnNumberFormat is set to Integer!.

Syntax

TableColumnNumberRound (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnNumberFormat


TableColumnNumberSelCurrency

Purpose

Specify a currency type for the current column.

Syntax

TableColumnNumberSelCurrency (IntlCurrency: enumeration)

Parameters

IntlCurrency

enumeration

Austria!

Israel!

Belgium!

Italy!

BelgiumFrench!

Japan!

Brazil!

Korea!

Canada!

Netherlands!

China!

Norway!

Croatia!

NorwayIntl!

CzechRepublic!

Paraguay!

DefaultCurrency!

Peseta!

Denmark!

Peso!

Dollar!

Poland!

Ecuador!

Portugal!

ElSalvador!

Ruble!

Finland!

RussianRuble!

FinlandIntl!

Singapore!

France!

SlovakRepublic!

FrenchCanada!

Slovenia!

Germany!

SouthAfrica!

Greece!

Sweden!

Guatemala!

Switzerland!

Honduras!

Taiwan!

HongKong!

Turkey!

Hungary!

UnitedKingdom!

Iceland!

Venezuela!

See Also

TableColumnNumberAlignCurrency, TableColumnNumberFormat


TableColumnNumberUseCommas

Purpose

Display commas in numbers with three or more digits to the left of the decimal.

Syntax

TableColumnNumberUseCommas (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnNumberFormat


TableColumnNumberUseCurrency

Purpose

Display a currency symbol with numbers.

Syntax

TableColumnNumberUseCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnNumberFormat


TableColumnsFixedWidth

Purpose

Turn on the Fixed width option for all columns in the current table.

Syntax

TableColumnsFixedWidth (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableColumnFixedWidth


TableColumnSize2Fit

Purpose

Adjust the table column width to the width of a selected cell or to fit data.

Syntax

TableColumnSize2Fit ()


TableColumnWidth

Purpose

Specify the width of the current column.

Syntax

TableColumnWidth (ColumnWidth: measurement)

Parameters

ColumnWidth

measurement

See Also

TableColumnFixedWidth, TableFormatWidths


TableColumnWidthEqualize

Purpose

Make the widths of all the selected columns equal. This command sums the widths of the selected columns, finds the average, and applies it to each of the selected columns.

Syntax

TableColumnWidthEqualize ()

See Also

TableAdjustColumnWidth


TableColumnWidthGrow

Purpose

Increase the width of a table column.

Syntax

TableColumnWidthGrow ()


TableColumnWidthShrink

Purpose

Decrease the width of a table column.

Syntax

TableColumnWidthShrink ()


TableConvertDlg

Purpose

Display the Convert Table dialog box. If no text is selected, the macro ends or goes to the ONERROR label.

Syntax

TableConvertDlg ()


TableConvertFrom

Purpose

Convert the selected text in tabular or parallel columns to a table.

Syntax

TableConvertFrom (Type: enumeration)

Parameters

Type

enumeration

ParallelColumns!

TabularColumns!

See Also

TableCreate


TableCopy

Purpose

Copy the contents of the selected cells to the current column or the current row using (Block!). TableMoveModeEnd inserts selected cells into the table. To record, first select two or more cells.

Syntax

TableCopy (Copy: enumeration)

Parameters

Copy

enumeration

Block!

Column!

Row!

See Also

TableMove


TableCopyFormula

Purpose

Copy a formula from the current cell to another cell.

Syntax

TableCopyFormula (CellIDCntToCell: enumeration; Where: any)

Parameters

CellIDCntToCell

enumeration

Cell!

Down!

Right!

Where

any (optional) The cell address if CellIDCntToCell is Cell! or Right!


TableCreate

Purpose

Create a table.

Syntax

TableCreate (Columns: numeric; Rows: numeric)

Parameters

Columns

numeric

Rows

numeric

See Also

?BetweenTableCodes, ?TableInTable, TableConvertFrom, TableJoin, TableSplit


TableCreateDlg

Purpose

Display the Create Table dialog box.

Syntax

TableCreateDlg ()

See Also

TableCreate


TableCreateNewDlg

Purpose

Display the Create Table dialog box. Recordable equivalent: TableCreateDlg

Syntax

TableCreateNewDlg ()

See Also

TableCreate


TableDataFill

Purpose

Fill a cell with a formula or data. Select at least two cells. The first must contain data or a formula. At least one other selected cell must be empty.

Syntax

TableDataFill ()


TableDecimalAlignmentDigits

Purpose

Specify the number of digits between the decimal point and the right edge of cells.

Syntax

TableDecimalAlignmentDigits (Number: numeric)

Parameters

Number

numeric (optional)

See Also

TableDecimalAlignmentDistance, TableFormatJustification


TableDecimalAlignmentDistance

Purpose

Specify the distance between the decimal and the right edge of cells.

Syntax

TableDecimalAlignmentDistance (Position: measurement)

Parameters

Position

measurement (optional)

See Also

TableDecimalAlignmentDigits, TableFormatJustification


TableDefaultLine

Purpose

Specify the default line style of a table.

Syntax

TableDefaultLine (Style: any)

Parameters

Style

any Enclose user-defined graphics line styles in quotation marks.

ButtonBottomRightLine!

HeavySingleLine!

ButtonTopLeftLine!

NoLine!

DashedLine!

SingleLine!

DottedLine!

TableDefaultLine!

DoubleLine!

ThickLine!

ExtraThickLine!

ThickThinLine!

HeavyDoubleLine!

ThinThickLine!

See Also

TableCellLine


TableDefaultLineColor

Purpose

Specify the default line color for a table.

Syntax

TableDefaultLineColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric; Shade: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

Shade

numeric (optional) Percent: 0-100.

See Also

TableCellLineColor


TableDeleteBlock

Purpose

Delete the contents of selected cells.

Syntax

TableDeleteBlock ()

See Also

TableDeleteColumn, TableDeleteRow, TableUndelete


TableDeleteCellFormula

Purpose

Delete the formulas in the current cell.

Syntax

TableDeleteCellFormula ()


TableDeleteColumn

Purpose

Delete table columns.

Syntax

TableDeleteColumn (Number: numeric)

Parameters

Number

numeric The number of columns to delete, beginning with the current column and moving left. Default: current column or selected columns.

See Also

TableDeleteBlock, TableDeleteRow, TableUndelete


TableDeleteDlg

Purpose

Display the Delete dialog box.

Syntax

TableDeleteDlg ()

See Also

TableDeleteColumn, TableDeleteRow


TableDeleteRow

Purpose

Delete table rows.

Syntax

TableDeleteRow (Number: numeric)

Parameters

Number

numeric (optional) The number of rows to delete, beginning with the current row and moving down.

See Also

TableDeleteColumn, TableDeleteDlg


TableDeleteTable

Purpose

Delete a table and/or its contents, or convert the table data to tabbed text or merge fields.

Syntax

TableDeleteTable (DelWhat: enumeration)

Parameters

DelWhat

enumeration

ConvertOnly! Deletes table contents only.

ConvertToMerge! Converts cells of each row to ENDFIELD codes.

ConvertToMergeNames! Converts first row cells to FIELDNAMES, and cells in remaining rows to ENDFIELD codes.

ConvertToTabs! Deletes table structure and converts contents to tabbed text.

EntireTable!


TableDeleteTableDlg

Purpose

Display the Delete Table dialog box.

Syntax

TableDeleteTableDlg ()


TableDisableCellLocks

Purpose

Turn off cell locks.

Syntax

TableDisableCellLocks (State: enumeration)

Parameters

State

enumeration

No!

Yes!


TableDragToCreate

Purpose

Turn the Drag to Create Tables option on or off.

Syntax

TableDragToCreate (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


TableEdit

Purpose

Begin a table editing command sequence. If not in a table, the macro searches backward for a table to edit. If no table is found, it searches forward.

Syntax

TableEdit ()

See Also

TableCreate


TableExpertDlg

Purpose

Display the Table SpeedFormat dialog box.

Syntax

TableExpertDlg ()


TableFill

Purpose

Specify a table fill pattern. Precede with TableBorderEditBegin and follow TableBorderEditEnd.

Syntax

TableFill (Pattern: any)

Parameters

Pattern

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

TableAlternateFillSet, TableBorderEditBegin, TableBorderEditEnd, TableCellFillStyle, TableSecondFill


TableFormatDlg

Purpose

Display the Properties for Table Format tab.

Syntax

TableFormatDlg ()


TableFormatJustification

Purpose

Specify table justification.

Syntax

TableFormatJustification (Justification: enumeration)

Parameters

Justification

enumeration

Center!

DecAlign!

Full!

FullAll!

Left!

Right!

See Also

?CellJustification, Justification, TableCellJustification, TableColumnJustification


TableFormatWidths

Purpose

Set table column width.

Syntax

TableFormatWidths (Width: measurement)

Parameters

Width

measurement


TableFormula

Purpose

Specify a formula for the current cell.

Syntax

TableFormula (Formula: string)

Parameters

Formula

string

See Also

TableNameAdd


TableFormulaCBar

Purpose

Display the Table Formula feature bar, which helps you view and edit formulas in a table.

Syntax

TableFormulaCBar ()


TabLeft

Purpose

Insert a Hard Left Tab with or without a dot leader.

Syntax

TabLeft (Type: enumeration)

Parameters

Type

enumeration (optional)

DotLeader!

Normal!

See Also

TabCenter, TabDecimal, TabRight


TabLeftDot

Purpose

Insert a Hard Left Tab code with a dot leader. Recordable substitute: TabLeft.

Syntax

TabLeftDot ()


TableGridLinesToggle

Purpose

Display or hide table grid lines.

Syntax

TableGridLinesToggle ()


TableGuides

Purpose

Turn Table Guides on or off.

Syntax

TableGuides (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?TableGuides


TableHardColumnBreak

Purpose

Insert a column break and continue the table in the next column. Cannot be in the first row. In the last column, the table continues on the next page.

Syntax

TableHardColumnBreak ()

See Also

PosTableRowBegin, TableHardRow


TableHardRow

Purpose

Insert a page break and continue the table on the next page.

Syntax

TableHardRow ()

See Also

PosTableRowBegin, TableHardColumnBreak


TableHeader

Purpose

Specify the current row as a header row.

Syntax

TableHeader (State: enumeration)

Parameters

State

enumeration

No!

Yes!


TableInsertAutoRow

Purpose

Turn Auto Row Insert on or off.

Syntax

TableInsertAutoRow (State: enumeration)

Parameters

State

enumeration

No!

Yes!


TableInsertColumn

Purpose

Insert table columns before or after the insertion point.

Syntax

TableInsertColumn (Number: numeric; InsertPos: enumeration; PreserveWidths: enumeration)

Parameters

Number

numeric

InsertPos

enumeration

After!

Before!

PreserveWidths

enumeration (optional)

No!

Yes!

See Also

TableInsertRow


TableInsertDlg

Purpose

Display the Insert Columns/Rows dialog box.

Syntax

TableInsertDlg ()

See Also

TableInsertColumn, TableInsertRow


TableInsertOneRow

Purpose

Insert a new row above the current row.

Syntax

TableInsertOneRow ()


TableInsertRow

Purpose

Insert rows before or after the insertion point.

Syntax

TableInsertRow (NumberOfRows: numeric; InsertPosition: enumeration)

Parameters

NumberOfRows

numeric

InsertPosition

enumeration

After!

Before!

See Also

TableAppendRow, TableInsertColumn, TableInsertDlg


TableJoin

Purpose

Join the current and following tables. The tables must have the same number of columns.

Syntax

TableJoin ()

See Also

TableSplit


TableJoinCells

Purpose

Join the selected table cells.

Syntax

TableJoinCells ()


TableJoinCellTool

Purpose

Turn on or off the join cells tools.

Syntax

TableJoinCellTool ()


TableLineFillDlg

Purpose

Display the Table Lines/Fill dialog box. The insertion point must be in a table.

Syntax

TableLineFillDlg ()


TableMarginLeft

Purpose

Specify the distance from the left edge of all cells in a table to the cell text.

Syntax

TableMarginLeft (Margin: measurement)

Parameters

Margin

measurement

See Also

TableColumnMarginLeft, TableColumnMarginRight, TableMarginRight


TableMarginRight

Purpose

Specify the distance from the right edge of all cells in a table to the cell text.

Syntax

TableMarginRight (Margin: measurement)

Parameters

Margin

measurement

See Also

TableColumnMarginLeft, TableColumnMarginRight, TableMarginLeft


TableMove

Purpose

Move the contents of the current cell, selected cells, current column, or current row. At least two cells must be selected. Follow with TableMoveModeEnd to insert contents.

Syntax

TableMove (Move: enumeration)

Parameters

Move

enumeration

Block!

Cell!

Column!

Row!

See Also

TableCopy


TableMoveCopyDlg

Purpose

Display the Copy Formula dialog box.

Syntax

TableMoveCopyDlg ()

See Also

TableCopy, TableMove


TableMoveModeCancel

Purpose

Cancel TableMove or TableCopy.

Syntax

TableMoveModeCancel ()


TableMoveModeEnd

Purpose

Paste the contents moved or copied with TableMove or TableCopy into a table at the insertion point.

Syntax

TableMoveModeEnd ()


TableNameAdd

Purpose

Name a cell, block of cells, row, column, or table.

Syntax

TableNameAdd (RefType: enumeration; Name: string)

Parameters

RefType

enumeration

Block!

Cell!

CellsDown!

CellsRight!

Column!

FloatingCell!

Row!

Table!

Name

string (optional)

See Also

TableNameDelete


TableNameChange

Purpose

Rename an existing table.

Syntax

TableNameChange (OldName: string; NewName: string; NewRef: string)

Parameters

OldName

string

NewName

string (optional)

NewRef

string (optional)


TableNameCreateDlg

Purpose

Display the Create Name dialog box.

Syntax

TableNameCreateDlg ()


TableNameDelete

Purpose

Delete a table name.

Syntax

TableNameDelete (TableName: string)

Parameters

TableName

string

See Also

TableNameAdd


TableNameListDlg

Purpose

Display the Table Names in Current Document dialog box.

Syntax

TableNameListDlg ()

See Also

TableNameAdd


TableNumberAlignCurrency

Purpose

Align the currency symbols in a table.

Syntax

TableNumberAlignCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableNumberSelectCurrency


TableNumberDateFormat

Purpose

Specify a date format for the current table.

Syntax

TableNumberDateFormat (DateFmtNum: numeric)

Parameters

DateFmtNum

numeric 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)

See Also

TableNumberFormat


TableNumberDecimalDigits

Purpose

Specify the number of digits after the decimal.

Syntax

TableNumberDecimalDigits (NumDigits: numeric)

Parameters

NumDigits

numeric

See Also

TableNumberFormat


TableNumberFormat

Purpose

Specify a numbering type for the current table.

Syntax

TableNumberFormat (FormatType: enumeration)

Parameters

FormatType

enumeration

Accounting!

General!

Commas!

Integer!

Currency!

Percent!

DateFormat!

Scientific!

Fixed2!

TextOnly!

See Also

TableColumnNumberAlignCurrency, TableColumnNumberDateFormat, TableColumnNumberDecimalDigits, TableColumnNumberRound, TableNumberSelectCurrency, PowerTableNumericFormat


TableNumberNegativeNumber

Purpose

Specify the display of negative numbers in the current table.

Syntax

TableNumberNegativeNumber (NegDisplay: enumeration)

Parameters

NegDisplay

enumeration

CRDR!

Minus!

Parentheses!


TableNumberRound

Purpose

Round decimal numbers to integers when the FormatType parameter of TableNumberFormat is Integer!.

Syntax

TableNumberRound (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableNumberFormat


TableNumberSelectCurrency

Purpose

Specify a currency type for the current table.

Syntax

TableNumberSelectCurrency (IntlCurrency: enumeration)

Parameters

IntlCurrency

enumeration

Austria!

Israel!

Belgium!

Italy!

BelgiumFrench!

Japan!

Brazil!

Korea!

Canada!

Netherlands!

China!

Norway!

Croatia!

NorwayIntl!

CzechRepublic!

Paraguay!

DefaultCurrency!

Peseta!

Denmark!

Peso!

Dollar!

Poland!

Ecuador!

Portugal!

ElSalvador!

Ruble!

Finland!

RussianRuble!

FinlandIntl!

Singapore!

France!

SlovakRepublic!

FrenchCanada!

Slovenia!

Germany!

SouthAfrica!

Greece!

Sweden!

Guatemala!

Switzerland!

Honduras!

Taiwan!

HongKong!

Turkey!

Hungary!

UnitedKingdom!

Iceland!

Venezuela!

See Also

TableNumberAlignCurrency


TableNumberTypeDlg

Purpose

Display the Properties for Table Numeric Format tab.

Syntax

TableNumberTypeDlg ()


TableNumberUseCommas

Purpose

Display commas in numbers with more than three digits to the left of the decimal.

Syntax

TableNumberUseCommas (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableNumberFormat


TableNumberUseCurrency

Purpose

Display a currency symbol with numbers.

Syntax

TableNumberUseCurrency (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

TableNumberFormat


TablePointMode

Purpose

Toggle Formula Edit in a table.

Syntax

TablePointMode (State: enumeration)

Parameters

State

enumeration

Off!

On!


TablePosition

Purpose

Specify table position.

Syntax

TablePosition (PositionVal: enumeration; SetAbsPos: measurement)

Parameters

PositionVal

enumeration

AlignAbsolute!

AlignCenter!

AlignFull!

AlignLeft!

AlignRight!

SetAbsPos

measurement (optional) The absolute position from the left edge of the paper when PositionVal is AlignAbsolute!.


TablePosNextTable

Purpose

Move the insertion point to the beginning of the next table.

Syntax

TablePosNextTable ()

See Also

TablePosPreviousTable


TablePosPreviousTable

Purpose

Move the insertion point to the beginning of the previous table.

Syntax

TablePosPreviousTable ()

See Also

TablePosNextTable


TableQuickSum

Purpose

Calculate the sum of cells above the current cell in the current column. Or, if the cell immediately above the current cell is blank, calculates the sum of cells left of the current cell in the current row. Cells above or to the left of a blank cell are not included in the calculation.

Syntax

TableQuickSum ()


TableReformatAll

Purpose

Reformat all tables in the current document. Used particularly to reformat floating cell numbers and currency symbols if the language is changed.

Syntax

TableReformatAll ()


TableRetrieve

Purpose

Retrieve the last item moved or copied in a table.

Syntax

TableRetrieve (Reference: enumeration)

Parameters

Reference

enumeration

Block!

Cell!

Column!

Row!

See Also

TableCopy, TableMove


TableRotateCell

Purpose

Rotate the contents of the current cell by 90 degrees.

Syntax

TableRotateCell ()


TableRowCanSpanPages

Purpose

Allow a table row to span two or more pages.

Syntax

TableRowCanSpanPages (State: enumeration)

Parameters

State

enumeration

No!

Yes!


TableRowColIndicators

Purpose

Turn row and column indicators on or off.

Syntax

TableRowColIndicators ()


TableRowHeight

Purpose

Specify whether row height is automatic or fixed, and if fixed, specify the height.

Syntax

TableRowHeight (RowHeight: enumeration; Amount: measurement)

Parameters

RowHeight

enumeration

Auto!

Fixed!

Amount

measurement (optional) The row height when the Type parameter is Fixed!.

See Also

TableColumnWidth


TableRowMarginBottom

Purpose

Specify the distance between the last line of text and the bottom of the cell.

Syntax

TableRowMarginBottom (Margin: measurement)

Parameters

Margin

measurement

See Also

TableRowMarginTop


TableRowMarginTop

Purpose

Specify the distance between the top of a cell and the first line of text in the cell.

Syntax

TableRowMarginTop (Margin: measurement)

Parameters

Margin

measurement

See Also

TableRowMarginBottom


TableRowNumberOfLines

Purpose

Specify single or multiple lines in the cells of a row.

Syntax

TableRowNumberOfLines (RowLines: enumeration)

Parameters

RowLines

enumeration

Multiple!

Single!


TableSecondFill

Purpose

Specify an alternating fill style for a table.

Syntax

TableSecondFill (FillStyle: any)

Parameters

FillStyle

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

TableAlternateFillSet, TableFill, TableSecondFillColors


TableSecondFillColors

Purpose

Specify the color of a table alternating fill. Use TableBorderEditBegin before this command and follow with TableBorderEditEnd.

Syntax

TableSecondFillColors (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-225.

ForeGreen

numeric (optional) Value: 0-225.

ForeBlue

numeric (optional) Value: 0-225.

ForeShade

numeric (optional) Percent: 0-100.

BackColorName

string (optional)

BackRed

numeric (optional) Value: 0-225.

BackGreen

numeric (optional) Value: 0-225.

BackBlue

numeric (optional) Value: 0-225.

BackShade

numeric (optional) Percent: 0-100.

See Also

FillColors, TableSecondFill


TableSelectOff

Purpose

Turn off Select.

Syntax

TableSelectOff ()


TableSelectOn

Purpose

Select a row, column, cell, or table.

Syntax

TableSelectOn (SelectionMode: enumeration)

Parameters

SelectionMode

enumeration

Cell!

Column!

Row!

Table!


TableSize

Purpose

Change the number of rows or columns in an existing table. Rows are added or deleted from the bottom of the existing table. Columns are added or deleted from the right of the existing table.

Syntax

TableSize (Rows: numeric; Columns: numeric)

Parameters

Rows

numeric (optional) The number of rows in the resulting table.

Columns

numeric (optional) The number of columns in the resulting table.

See Also

TableCreate


TableSortTable

Purpose

Sort a table by the contents of a selected cell.

Syntax

TableSortTable ({SortType: enumeration; SortOrder: enumeration; })

Parameters

SortType

enumeration (optional)

Alphanumeric!

Numeric!

SortOrder

enumeration (optional)

Ascending!

Descending!


TableSplit

Purpose

Split a table into two tables. A table cannot be split on the first row. The second table begins with the current row.

Syntax

TableSplit ()

See Also

TableJoin


TableSplitCellsDlg

Purpose

Display the Split Cell dialog box.

Syntax

TableSplitCellsDlg ()


TableSplitColumn

Purpose

Split the current cell into multiple columns.

Syntax

TableSplitColumn (ColumnCount: numeric; ColumnPos: measurement)

Parameters

ColumnCount

numeric

ColumnPos

measurement (optional)

See Also

TableSplitRow


TableSplitColumnTool

Purpose

Turn the split column tool on or off.

Syntax

TableSplitColumnTool (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


TableSplitRow

Purpose

Split the current cell into multiple rows.

Syntax

TableSplitRow (RowCount: numeric; RowPos: numeric)

Parameters

RowCount

numeric

RowPos

numeric (optional)

See Also

TableSplitColumn


TableSplitRowTool

Purpose

Turn the split row tool on or off.

Syntax

TableSplitRowTool (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


TableStyleCreate

Purpose

Create a table style.

Syntax

TableStyleCreate (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!


TableStyleDelete

Purpose

Delete a table style.

Syntax

TableStyleDelete (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!


TableStyleEdit

Purpose

Edit a table style. Use with TableStyleName and TableStyleReplace.

Syntax

TableStyleEdit (Style: any; Library: enumeration)

Parameters

Style

any

NoTableStyle!

TableStyle28!

TableStyle1!

TableStyle29!

TableStyle10!

TableStyle3!

TableStyle11!

TableStyle30!

TableStyle12!

TableStyle31!

TableStyle13!

TableStyle32!

TableStyle14!

TableStyle33!

TableStyle15!

TableStyle34!

TableStyle16!

TableStyle35!

TableStyle17!

TableStyle36!

TableStyle18!

TableStyle37!

TableStyle19!

TableStyle38!

TableStyle2!

TableStyle39!

TableStyle20!

TableStyle4!

TableStyle21!

TableStyle40!

TableStyle22!

TableStyle5!

TableStyle23!

TableStyle6!

TableStyle24!

TableStyle7!

TableStyle25!

TableStyle8!

TableStyle26!

TableStyle9!

TableStyle27!

 

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!


TableStyleEnd

Purpose

Save or cancel table style settings.

Syntax

TableStyleEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!


TableStyleName

Purpose

Specify the name of a new table style. Use with TableStyleEdit.

Syntax

TableStyleName (Style: string)

Parameters

Style

string

See Also

TableStyleRetrieve, TableStyleSave


TableStyleReplace

Purpose

Specify a user-defined table style to replace the current table style. Use with TableStyleEdit.

Syntax

TableStyleReplace (Style: string; Library: enumeration)

Parameters

Style

string

Library

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!


TableStyleRetrieve

Purpose

Retrieve a table style from the specified style library.

Syntax

TableStyleRetrieve (Filename: string; Library: enumeration)

Parameters

Filename

string

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

TableStyleName


TableStyleSave

Purpose

Save a table style to the specified style library.

Syntax

TableStyleSave (Filename: string; Library: enumeration)

Parameters

Filename

string

Library

enumeration

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

TableStyleName


TableTextBoxCreate

Purpose

Create a table in a text box.

Syntax

TableTextBoxCreate (Columns: numeric; Rows: numeric)

Parameters

Columns

numeric

Rows

numeric


TableTextToFormula

Purpose

Convert the contents of the current cell to a formula. Not recordable.

Syntax

TableTextToFormula ()

See Also

TableFormula


TableToolsDlg

Purpose

Display the Tools dialog box for editing a table. If the insertion point is not in a table when this command is executed, nothing happens.

Syntax

TableToolsDlg ()


TableUndelete

Purpose

Insert the last deleted item. Available only in table editing mode.

Syntax

TableUndelete ()

See Also

TableDeleteBlock, TableDeleteColumn, TableDeleteRow


TableUpdateAssociatedCharts

Purpose

Turn the Update associated charts option on or off.

Syntax

TableUpdateAssociatedCharts (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

TableAutoCalc


TableUseDefaultLinesColor

Purpose

Specify the Line Style line color as the default line color for a table.

Syntax

TableUseDefaultLinesColor ()

See Also

TableDefaultLineColor


TabRight

Purpose

Insert a right aligned tab (with or without a dot leader) at the insertion point.

Syntax

TabRight (Type: enumeration)

Parameters

Type

enumeration (optional)

DotLeader!

Normal!

See Also

TabCenter, TabDecimal, TabLeft


TabRightDot

Purpose

Insert a Hard Right Tab code with a dot leader. Recordable substitute: TabRight.

Syntax

TabRightDot ()


TabSet

Purpose

Specify tab settings.

Syntax

TabSet (Origin: enumeration; {Position: measurement; TabType: enumeration; })

Parameters

Origin

enumeration Set tabs relative to the left edge of the paper (absolute) or the left margin setting (relative).

Absolute!

Relative!

Position

measurement (optional)

TabType

enumeration (optional)

TabCenter!

TabCenterDot!

TabDecimal!

TabDecimalDot!

TabLeft!

TabLeftDot!

TabRight!

TabRightDot!

See Also

?TabSettings, TabAdd, TabSetDlg


TabSetDlg

Purpose

Display the Tab Set dialog box.

Syntax

TabSetDlg ()

See Also

TabSet


TeamLinkEnable

Purpose

Turn TeamLinks electronic mail service on or off. A TeamLinks Integration module must be installed.

Syntax

TeamLinkEnable (State: enumeration)

Parameters

State

enumeration

Off!

On!


TemplateCopyObject

Purpose

Copy a template object such as a style or a macro, from one template to another.

Syntax

TemplateCopyObject (CopyFrom: string; ObjectType: enumeration; ObjectName: string)

Parameters

CopyFrom

string

ObjectType

enumeration

Abbreviation!

ButtonBar!

Keyboard!

Macro!

Menu!

QuickWords!

ObjectName

string


TemplateCopyObjectDlg

Purpose

Display the Copy/Remove Template Objects dialog box.

Syntax

TemplateCopyObjectDlg ()


TemplateCreate

Purpose

Create a new template based on an existing template and open the new template in edit mode.

Syntax

TemplateCreate (Filename: string; BasedOn: string)

Parameters

Filename

string The filename of the new template. If a path is not included in this parameter, the new template file is created in the default template folder.

BasedOn

string (optional) The filename of the existing template to base the new template on. If a path is not included in this parameter, the command looks for the existing template in the default template folder.


TemplateDescriptionDlg

Purpose

Display the Template Description dialog box.

Syntax

TemplateDescriptionDlg ()


TemplateDlg

Purpose

Display the Select New Document dialog box.

Syntax

TemplateDlg ()


TemplateEdit

Purpose

Edit a template.

Syntax

TemplateEdit (Filename: string)

Parameters

Filename

string The full path and filename.


TemplateFill

Purpose

Display a dialog box for entering template data. This dialog box varies depending on the fields required for the current template. If the personal information is not specified, this command first prompts the user to specify the personal information regardless of what data the current template requires.

If the current template does not require data beyond the personal information and the personal information has been set, this command updates the personal information in the document without displaying the dialog. If the current document is not based on an automated template and the personal information has been set, this command does nothing.

Syntax

TemplateFill ()


TemplateGetAssociation

Purpose

Return the name of the specified object that is associated in the current template with the specified feature or trigger. If the specified association does not exist in the current template, nothing is returned.

Syntax

string := TemplateGetAssociation (FeatureTrigger: enumeration; Object: enumeration)

Parameters

FeatureTrigger

enumeration

BoxSelected!

PostPrint!

Comment!

PostStartup!

Endnote!

PostTables!

EquationEditor!

PreClose!

Footers!

PreDocument!

Footnote!

PreNew!

Headers!

PreOpen!

Main!

PrePrint!

Outline!

PreTables!

PostClose!

SGML!

PostDocument!

Tables!

PostNew!

Watermark!

PostOpen!

 

Object

enumeration

ButtonBar!

Keyboard!

Macro!

Menu!

See Also

TemplateSetAssociation


TemplateMacroEditControlBar

Purpose

Display the Template Macro Edit feature bar.

Syntax

TemplateMacroEditControlBar (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!


TemplateSelect

Purpose

Select a document template.

Syntax

TemplateSelect (Filename: string)

Parameters

Filename

string


TemplateSetAssociation

Purpose

Assign menus, keyboards, and toolbars to selected Corel WordPerfect features or triggers in the current template.

Syntax

TemplateSetAssociation (FeatureTrigger: enumeration; Object: enumeration; ObjectName: string)

Parameters

FeatureTrigger

enumeration

BoxSelected!

PostPrint!

Comment!

PostStartup!

Endnote!

PostTables!

EquationEditor!

PreClose!

Footers!

PreDocument!

Footnote!

PreNew!

Headers!

PreOpen!

Main!

PrePrint!

Outline!

PreTables!

PostClose!

SGML!

PostDocument!

Tables!

PostNew!

Watermark!

PostOpen!

 

Object

enumeration

ButtonBar!

Keyboard!

Macro!

Menu!

ObjectName

string

See Also

AssociateDlg, MergeFileAssociate, TemplateGetAssociation


TextBorderCreate

Purpose

Create a border for the current paragraph, column, or page. Use with TextBorderEnd.

Syntax

TextBorderCreate (Style: any; FillName: any; BorderFunction: enumeration)

Parameters

Style

any

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

FillName

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

BorderFunction

enumeration

ColumnBorder!

PageBorder!

ParagraphBorder!

See Also

?Border, ?ColumnBorder, ?PageBorder, ?ParagraphBorder, TextBorderEdit, TextBorderEnd, FancyPageBorder


TextBorderEdit

Purpose

Begin editing changes to the current border.

Syntax

TextBorderEdit (BorderType: enumeration)

Parameters

BorderType

enumeration

column!

page!

paragraph!

See Also

TextBorderCreate, TextBorderEnd


TextBorderEnd

Purpose

End text border creation or editing and save or cancel changes.

Syntax

TextBorderEnd (State: enumeration)

Parameters

State

enumeration

Cancel!

Save!

See Also

TextBorderCreate, TextBorderEdit


TextBorderFillStyle

Purpose

Specify a fill style for the current border.

Syntax

TextBorderFillStyle (Fillname: any)

Parameters

Fillname

any

Fill10!

Fill60!

Fill100!

Fill70!

Fill20!

Fill80!

Fill30!

Fill90!

Fill40!

FillButton!

Fill5!

NoFill!

Fill50!

 

See Also

TextBorderEdit


TextBorderStyle

Purpose

Specify the current border style.

Syntax

TextBorderStyle (Style: any)

Parameters

Style

any

ButtonBorder!

HeavySingleBorder!

ColumnBorderAll!

NoBorder!

ColumnBorderBetween!

SingleBorder!

DashedBorder!

SpacingOnly!

DottedBorder!

ThickBorder!

DoubleBorder!

ThickThinBorder!

ExtraThickBorder!

ThickTopBottomBorder!

HeavyDoubleBorder!

ThinThickBorder!

See Also

?Border, TextBorderEdit, TextBorderEnd


TextBoxCreate

Purpose

Create a text box and display the Text Box feature bar.

Syntax

TextBoxCreate ()

See Also

Close


TextColor

Purpose

Specify a text color.

Syntax

TextColor (ColorName: string; Red: numeric; Green: numeric; Blue: numeric)

Parameters

ColorName

string (optional) 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.

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

See Also

?TextColorBlue, ?TextColorGreen, ?TextColorRed, ?TextShade, TextShade


TextShade

Purpose

Specify the intensity of a text color.

Syntax

TextShade (ShadingValue: numeric)

Parameters

ShadingValue

numeric Percent. Full intensity: 100%.

See Also

TextColor


ThirdPartyCreate

Purpose

Insert a third party function into a document.

Syntax

ThirdPartyCreate (Id: numeric; Data: raw binary data)

Parameters

Id

numeric

Data

raw binary data


ThirdPartyDelete

Purpose

Delete a third party function from a document.

Syntax

ThirdPartyDelete (Id: numeric; From: enumeration; Direction: enumeration)

Parameters

Id

numeric

From

enumeration

BegOfFile!

CurrentPos!

Direction

enumeration

Backward!

Forward!


ThirdPartyFind

Purpose

Find the third party id of the next or previous third party.

Syntax

numeric := ThirdPartyFind (From: enumeration; Direction: enumeration)

Parameters

From

enumeration

BegOfFile!

CurrentPos!

Direction

enumeration

Backward!

Forward!


ThirdPartyFindByID

Purpose

Get the data from a third party function.

Syntax

raw binary data := ThirdPartyFindByID (Id: numeric; From: enumeration; Direction: enumeration)

Parameters

Id

numeric

From

enumeration

BegOfFile!

CurrentPos!

Direction

enumeration

Backward!

Forward!


ThousandsSeparator

Purpose

Specify a character to separate each three digits. Use when the FormatType parameter of TableCellNumberFormat, TableColumnNumberFormat, or TableNumberFormat is Comma!; or use with TableCellNumberUseCommas, TableColumnNumberUseCommas, or TableNumberUseCommas.

Syntax

ThousandsSeparator (Character: string)

Parameters

Character

string

See Also

?ThousandsSeparatorChar, TableCellNumberFormat, TableCellNumberUseCommas, TableColumnNumberFormat, TableColumnNumberUseCommas, TableNumberFormat, TableNumberUseCommas


TOACreateFullFormDlg

Purpose

Display the Create Full Form dialog box.

Syntax

TOACreateFullFormDlg ()


TOADefineDlg

Purpose

Display the Define Table of Authorities dialog box.

Syntax

TOADefineDlg ()


TOADefinition

Purpose

Specify a section, define format options, and insert a table of authorities definition in the document.

Syntax

TOADefinition (SectionName: string; Style: any; Numbering: enumeration; Underline: enumeration; PageCombine: enumeration; NumberingFormat: string)

Parameters

SectionName

string

Style

any (optional)

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Numbering

enumeration (optional)

DefFlushRight!

DefFollows!

DefLeader!

DefNone!

DefParentheses!

Underline

enumeration (optional)

NoToAUnderline!

ToAUnderline!

PageCombine

enumeration (optional) Combine sequential page numbers.

Combine!

NoCombine!

NumberingFormat

string (optional)

See Also

?TOADefinition, TOADefinitionCreate


TOADefinitionCombine

Purpose

Combine sequential page numbers in a table of authorities section.

Syntax

TOADefinitionCombine (SectionName: string; Combine: enumeration)

Parameters

SectionName

string

Combine

enumeration (optional)

Combine!

NoCombine!


TOADefinitionCreate

Purpose

Create a table of authorities definition.

Syntax

TOADefinitionCreate (SectionName: string; Style: any; Numbering: enumeration; Underline: enumeration; PageCombine: enumeration; NumberingFormat: string)

Parameters

SectionName

string

Style

any (optional)

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Numbering

enumeration (optional)

DefFlushRight!

DefFollows!

DefLeader!

DefNone!

DefParentheses!

Underline

enumeration (optional) Allow underlining.

NoToAUnderline!

ToAUnderline!

PageCombine

enumeration (optional) Combine sequential page numbers.

Combine!

NoCombine!

NumberingFormat

string (optional)

See Also

TOADefinitionDelete


TOADefinitionDelete

Purpose

Delete a table of authorities section definition.

Syntax

TOADefinitionDelete (SectionName: string)

Parameters

SectionName

string

See Also

TOADefinitionCreate


TOADefinitionMode

Purpose

Specify a page numbering mode in a section.

Syntax

TOADefinitionMode (SectionName: string; Numbering: enumeration)

Parameters

SectionName

string

Numbering

enumeration (optional)

DefFlushRight!

DefFollows!

DefFollowsParenthesis!

DefLeaders!

DefNone!

See Also

TOADefinitionCreate


TOADefinitionRename

Purpose

Rename a section.

Syntax

TOADefinitionRename (OldSection: string; NewSection: string)

Parameters

OldSection

string

NewSection

string

See Also

TOADefinitionCreate


TOADefinitionRetrieve

Purpose

Retrieve a section from another document into the current document.

Syntax

TOADefinitionRetrieve (Filename: string; SectionName: string)

Parameters

Filename

string

SectionName

string

See Also

TOADefinitionCreate


TOADefinitionStyle

Purpose

Specify a table of authorities section style.

Syntax

TOADefinitionStyle (SectionName: string; Style: any)

Parameters

SectionName

string

Style

any

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

See Also

TOADefinitionCreate


TOADefinitionUnderline

Purpose

Turn Underlining on or off in a table of authorities section.

Syntax

TOADefinitionUnderline (Section: string; Action: enumeration)

Parameters

Section

string

Action

enumeration (optional)

NoToAUnderline!

ToAUnderline!


TOAEditFullForm

Purpose

Begin editing changes to a full form. SubstructureExit ends editing and saves changes.

Syntax

TOAEditFullForm (ShortForm: string)

Parameters

ShortForm

string

See Also

TOAEditFullFormDlg, TOAMark


TOAEditFullFormCBar

Purpose

Display the Table of Authorities Full Form feature bar.

Syntax

TOAEditFullFormCBar ()

See Also

TOAEditFullForm, TOAEditFullFormDlg


TOAEditFullFormDlg

Purpose

Display the Edit Full Form dialog box.

Syntax

TOAEditFullFormDlg ()

See Also

TOAEditFullForm


TOAEditPageFormat

Purpose

Specify the text for page numbering in a table of authorities.

Syntax

TOAEditPageFormat (Listname: string; NumberFormat: any)

Parameters

Listname

string

NumberFormat

any Use a string to specify a custom format.

DocFormat!

See Also

TOADefinitionCreate


TOAEditSection

Purpose

Rename a section name in the full form of a table of authorities.

Syntax

TOAEditSection (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string


TOAEditShortForm

Purpose

Rename a short form name in the full form of a table of authorities.

Syntax

TOAEditShortForm (OldName: string; NewName: string)

Parameters

OldName

string

NewName

string

See Also

TOAMark


TOAMark

Purpose

Mark the selected text as a table of authorities reference.

Syntax

TOAMark (SectionName: string; ShortForm: string)

Parameters

SectionName

string (optional)

ShortForm

string (optional)

See Also

TOADefinitionCreate


TOAMarkShortForm

Purpose

Mark the current short form citation at the insertion point.

Syntax

TOAMarkShortForm (ShortForm: string)

Parameters

ShortForm

string

See Also

TOAMark


TOCDefine

Purpose

Define a table of contents and insert the definition.

Syntax

TOCDefine (WrapLastLevel: enumeration; NumberingFormat: string; {Style: any; Numbering: enumeration; })

Parameters

WrapLastLevel

enumeration (optional) Wrap the last level.

No!

Yes!

NumberingFormat

string (optional) The page numbering format.

Style

any (optional)

AddressStyle!

Legal4Style!

BoxTextStyle!

Legal5Style!

BulletsOutlnStyle!

Legal6Style!

CaptionStyle!

Legal7Style!

CommentStyle!

Legal8Style!

CustomHTMLStyle!

LegalOutlnStyle!

Definition1Style!

Level1Style!

Definition2Style!

Level2Style!

Definition3Style!

Level3Style!

Definition4Style!

Level4Style!

Definition5Style!

Level5Style!

Definition6Style!

Level6Style!

Definition7Style!

Level7Style!

Definition8Style!

Level8Style!

DefinitionsOutlnStyle!

ListStyle!

DocStyle!

MonospacedStyle!

EndnoteNumberInDocumentStyle!

NormalStyle!

EndnoteStyle!

NumbersOutlnStyle!

EquationNumberStyle!

OutlineStyle!

FigureNumberStyle!

ParagraphOutlnStyle!

FooterAStyle!

PreformattedStyle!

FooterBStyle!

Quotation1Style!

FootnoteNumberInDocumentStyle!

Quotation2Style!

FootnoteStyle!

Quotation3Style!

HeaderAStyle!

Quotation4Style!

HeaderBStyle!

Quotation5Style!

Heading1Style!

Quotation6Style!

Heading2Style!

Quotation7Style!

Heading3Style!

Quotation8Style!

Heading4Style!

QuotationsOutlnStyle!

Heading5Style!

TableBoxNumberStyle!

Heading6Style!

TextBoxNumberStyle!

Heading7Style!

ToAStyle!

Heading8Style!

ToC1Style!

HeadingsOutlnStyle!

ToC2Style!

HypertextStyle!

ToC3Style!

Index1Style!

ToC4Style!

Index2Style!

ToC5Style!

Legal_2OutlnStyle!

UserBoxNumberStyle!

Legal1Style!

WatermarkAStyle!

Legal2Style!

WatermarkBStyle!

Legal3Style!

 

Numbering

enumeration (optional) The page numbering mode for references.

DefFlushRight!

DefFollows!

DefLeader!

DefNone!

DefParentheses!

See Also

TOCDefineDlg, TOCMark


TOCDefineDlg

Purpose

Display the Define Table of Contents dialog box.

Syntax

TOCDefineDlg ()

See Also

?TOCDefinition, TOCDefine, TOCMark


TOCMark

Purpose

Mark the selected text for the table of contents.

Syntax

TOCMark (Level: numeric)

Parameters

Level

numeric

See Also

TOCDefine


ToolbarCount

Purpose

Return the number of active toolbars.

Syntax

numeric := ToolbarCount ()


ToolbarName

Purpose

Return the name of an active toolbar.

Syntax

string := ToolbarName (Toolbar: numeric)

Parameters

Toolbar

numeric


TotalPages

Purpose

Return the total number of pages in the current document. Not recordable. If something was added to the middle of a document that increased the total number of pages, TotalPages may not return the current value. Several techniques can be used to make sure this value is current. Moving to the end of the document is one of them. The following is an example of moving to the end of the document before using TotalPages:QuickmarkSet ()PosDocBottom ()QuickMarkFind ()BookmarkDelete (Name: “QuickMark”)vPages := TotalPages ()

Syntax

numeric := TotalPages ()

See Also

?Page, QuickmarkSet


TotalPagesDisplay

Purpose

Insert a code in the text to display the total number of pages.

Syntax

TotalPagesDisplay ()


TotalPagesMethod

Purpose

Specify the page numbering method for the total number of pages.

Syntax

TotalPagesMethod (Method: enumeration)

Parameters

Method

enumeration (optional)

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

TotalPagesMethodQry


TotalPagesMethodQry

Purpose

Return the current page numbering method for the total number of pages.

Syntax

numeric := TotalPagesMethodQry ()


TransitionAdvisor

Purpose

Open the Upgrade Expert, which helps you move to Corel WordPerfect 8 from another word processor.

Syntax

TransitionAdvisor ()


TwainAcquire

Purpose

Scan an image into Corel WordPerfect. This token is valid only if the optional TWAIN support files were installed using the Corel WordPerfect custom install option and a TWAIN compatible scanning device is installed.

Syntax

TwainAcquire ()


TwainSelectSourceDlg

Purpose

Display the Select Image Source dialog box. This token is valid only if the optional TWAIN support files were installed using the custom install option and a TWAIN compatible scanning device is installed.

Syntax

TwainSelectSourceDlg ()


Type

Purpose

Insert text at the insertion point.

Syntax

Type ({Text: string; })

Parameters

Text

string (optional)

See Also

TypeChar


TypeChar

Purpose

Insert a character from the Corel WordPerfect character sets. Not recordable.

Syntax

TypeChar (CharacterSet: numeric; Offset: numeric)

Parameters

CharacterSet

numeric

Offset

numeric A Corel WordPerfect character.

See Also

Type


Typeover

Purpose

Turn Typeover on or off.

Syntax

Typeover (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?TypeoverActive


TypeoverKey

Purpose

Toggle Typeover. Recordable substitute: Typeover.

Syntax

TypeoverKey ()

See Also

Typeover


TypesetManualKerningDlg

Purpose

Display the Manual Kerning dialog box, which allows you to increase or decrease the space between two characters.

Syntax

TypesetManualKerningDlg ()

See Also

KerningSpacing


Undelete

Purpose

Restore the specified deletion at the insertion point. The first, second, or third most recent deletions can be restored.

Syntax

Undelete (Which: numeric)

Parameters

Which

numeric The level to restore (1-3).

See Also

?UndeleteBuffers, UndeleteDlg, Undo


UndeleteDlg

Purpose

Display the Undelete dialog box, which will allow you to restore one of the last three deletions.

Syntax

UndeleteDlg ()


UnderlineSpaces

Purpose

Underline spaces.

Syntax

UnderlineSpaces (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?UnderlineSpaces, UnderlineTabs


UnderlineTabs

Purpose

Underline tabs.

Syntax

UnderlineTabs (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?UnderlineTabs, UnderlineSpaces


Undo

Purpose

Restore the last or the specified document change. Choosing Undo a second time restores the last undo.

Syntax

Undo (Number: numeric)

Parameters

Number

numeric (optional) Allow for multi-level undos.

See Also

Redo, Undelete


UndoRedoDlg

Purpose

Display the Undo/Redo History dialog box, which allows you to cancel or restore recent changes to a document.

Syntax

UndoRedoDlg ()


UseRegQuotesWithNumbers

Purpose

Turn Use Regular Quotes with Numbers on or off.

Syntax

UseRegQuotesWithNumbers (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

DoubleSmartQuote, SingleSmartQuote


UserFunction

Purpose

Execute a third-party execution command.

Syntax

UserFunction (Action: string; {Data: any; })

Parameters

Action

string The action a third-party program performs. Form: <signature>:<action?. The four-character <signature> identifies a third-party application. The <action> specifies a third-party command.

Data

any (optional)


ViewDraft

Purpose

Display a document without substructures such as headers, footers, and footnotes.

Syntax

ViewDraft ()

See Also

ViewPage, ViewTwoPage


ViewOutline

Purpose

Display the Outline feature bar and insert the first-level heading.

Syntax

ViewOutline ()


ViewPage

Purpose

Display a document with substructures such as headers, footers, and footnotes.

Syntax

ViewPage ()

See Also

ViewDraft, ViewTwoPage


ViewToggle

Purpose

Toggle the view between HTML and Page.

Syntax

ViewToggle ()


ViewToolbarsDlg

Purpose

Display the Toolbars dialog box.

Syntax

ViewToolbarsDlg ()

See Also

ButtonBarShow, PowerBarShow, RulerBarShow, StatusBarShow


ViewTwoPage

Purpose

Display two document pages.

Syntax

ViewTwoPage ()

See Also

ViewDraft, ViewPage


VLineCreate

Purpose

Create a vertical line at the insertion point between the top and bottom margin.

Syntax

VLineCreate ()


VolumeNumber

Purpose

Specify the active volume number.

Syntax

VolumeNumber (Volume: numeric)

Parameters

Volume

numeric

See Also

?VolumeNumber


VolumeNumberDecrement

Purpose

Decrease the active volume number by one.

Syntax

VolumeNumberDecrement ()


VolumeNumberDisplay

Purpose

Insert the active volume number at the insertion point.

Syntax

VolumeNumberDisplay ()


VolumeNumberIncrement

Purpose

Increase the active volume number by one.

Syntax

VolumeNumberIncrement ()


VolumeNumberMethod

Purpose

Specify a numbering type to display volume numbers.

Syntax

VolumeNumberMethod (NumberingMethod: enumeration)

Parameters

NumberingMethod

enumeration

LowerLetters!

LowerRoman!

Numbers!

UpperLetters!

UpperRoman!

See Also

?VolumeNumberMethod


WatermarkA

Purpose

Create, edit, or turn off Watermark A on the specified pages.

Syntax

WatermarkA (Action: enumeration; Occurrence: enumeration; State: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional)

AllPages!

EvenPages!

NoPages!

OddPages!

State

enumeration (optional)

NoOverlay!

Overlay!

See Also

?WatermarkAOccur, WatermarkB


WatermarkB

Purpose

Create, edit, or turn off Watermark B on the specified pages.

Syntax

WatermarkB (Action: enumeration; Occurrence: enumeration; State: enumeration)

Parameters

Action

enumeration

Create!

Edit!

Off!

Occurrence

enumeration (optional)

AllPages!

EvenPages!

NoPages!

OddPages!

State

enumeration (optional)

NoOverlay!

Overlay!

See Also

?WatermarkBOccur, WatermarkA


WatermarkDlg

Purpose

Display the Watermark dialog box in order to create a watermark.

Syntax

WatermarkDlg ()


WatermarkNext

Purpose

Go to the next watermark.

Syntax

WatermarkNext ()


WatermarkPlacementDlg

Purpose

Display the Pages dialog box, in which you determine on which pages your watermark will appear.

Syntax

WatermarkPlacementDlg ()


WatermarkPrev

Purpose

Go to the previous watermark.

Syntax

WatermarkPrev ()


WatermarkShadingDlg

Purpose

Display the Watermark Shading dialog box.

Syntax

WatermarkShadingDlg ()


WatermarkShippingMacro

Purpose

Play the shipping macro WATERMRK.WCM to display the Watermark Options dialog box, where you can select Watermark A or B and graphics or text. If Graphic is selected, the Graphic Watermarks dialog box is displayed with a list of watermarks to preview or insert. If Text is selected, the Watermark Creation Macro dialog box is displayed, in which you enter watermark text to insert. WATERMARK.WCM must be installed.

Syntax

WatermarkShippingMacro ()


WebActiveLinkColor

Purpose

Set the active hypertext-link color of the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebActiveLinkColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

See Also

WebActiveLinkColorRed, WebActiveLinkColorGreen, WebActiveLinkColorBlue


WebActiveLinkColorBlue

Purpose

Return the blue value of the active hypertext-link color for the active web document. If the active document is not a web document, the blue value of the default active hypertext-link color for web documents is returned.

Syntax

numeric := WebActiveLinkColorBlue ()

See Also

WebActiveLinkColor


WebActiveLinkColorGreen

Purpose

Return the green value of the active hypertext-link color for the active web document. If the current document is not a web document, the green value of the default active hypertext-link color for web documents is returned.

Syntax

numeric := WebActiveLinkColorGreen ()

See Also

WebActiveLinkColor


WebActiveLinkColorRed

Purpose

Return the red value of the active hypertext-link color for the active web document. If the current document is not a web document, the red value of the default active hypertext-link color for web documents is returned.

Syntax

numeric := WebActiveLinkColorRed ()

See Also

WebActiveLinkColor


WebBackgroundColor

Purpose

Set the background color of the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebBackgroundColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

See Also

WebBackgroundColorRed, WebBackgroundColorGreen, WebBackgroundColorBlue


WebBackgroundColorBlue

Purpose

Return the blue value of the background color for the active web document. If the active document is not a web document, the blue value of the default background color for web documents is returned.

Syntax

numeric := WebBackgroundColorBlue ()

See Also

WebBackgroundColor


WebBackgroundColorGreen

Purpose

Return the green value of the background color for the active web document. If the active document is not a web document, the green value of the default background color for web documents is returned.

Syntax

numeric := WebBackgroundColorGreen ()

See Also

WebBackgroundColor


WebBackgroundColorRed

Purpose

Return the red value of the background color for the active web document. If the active document is not a web document, the red value of the default background color for web documents is returned.

Syntax

numeric := WebBackgroundColorRed ()

See Also

WebBackgroundColor


WebBackgroundImage

Purpose

Specify a background image for the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebBackgroundImage (Filename: string)

Parameters

Filename

string

See Also

?WebBackgroundImage


WebBaseURL

Purpose

Specify the base URL for the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebBaseURL (URL: string)

Parameters

URL

string

See Also

?WebBaseURL, WebTitleDlg


WebBoxHTMLProperties

Purpose

Specify the HTML properties of the active box. Precede with BoxCreate or BoxEdit and end with BoxEnd.

Syntax

WebBoxHTMLProperties (Properties: string)

Parameters

Properties

string

See Also

WebBoxHTMLPropertiesDlg, ?WebBoxHTMLProperties


WebBoxHTMLPropertiesDlg

Purpose

Display the Box HTML Properties dialog box. Valid only when a graphics box is selected.

Syntax

WebBoxHTMLPropertiesDlg ()

See Also

WebBoxHTMLProperties, ?WebBoxHTMLProperties


WebColorDlg

Purpose

Display the HTML Document Properties (Text/Background color) dialog box.

Syntax

WebColorDlg ()


WebColumnDefineDlg

Purpose

Specify the number and size of columns.

Syntax

WebColumnDefineDlg ()


WebCustomHTMLToggle

Purpose

Turn Web Custom HTML on or off.

Syntax

WebCustomHTMLToggle ()


WebFormsFormPropertiesDlg

Purpose

Display the Properties dialog for a form.

Syntax

WebFormsFormPropertiesDlg ()


WebFormsHiddenDlg

Purpose

Display the Properties dialog for a hidden field.

Syntax

WebFormsHiddenDlg ()


WebFormsListPropertiesDlg

Purpose

Display the Properties dialog for a selection list.

Syntax

WebFormsListPropertiesDlg ()


WebFormsProperties

Purpose

Edit the properties of the form or form field.

Syntax

WebFormsProperties ()


WebFormsRadioPropertiesDlg

Purpose

Display the Properties dialog for a radio or check box button.

Syntax

WebFormsRadioPropertiesDlg ()


WebFormsTextAreaPropertiesDlg

Purpose

Display the Properties dialog for a multi-line text field.

Syntax

WebFormsTextAreaPropertiesDlg ()


WebFormsTextPropertiesDlg

Purpose

Display the Properties dialog for a text or password field.

Syntax

WebFormsTextPropertiesDlg ()


WebInsertCheckBox

Purpose

Insert a check box into the form.

Syntax

WebInsertCheckBox ()


WebInsertForm

Purpose

Create a new web form.

Syntax

WebInsertForm ()


WebInsertHiddenField

Purpose

Insert a hidden field into the form.

Syntax

WebInsertHiddenField ()


WebInsertPassword

Purpose

Insert a password field into the form.

Syntax

WebInsertPassword ()


WebInsertRadioButton

Purpose

Insert a radio button into the form.

Syntax

WebInsertRadioButton ()


WebInsertResetButton

Purpose

Insert a reset button into the form.

Syntax

WebInsertResetButton ()


WebInsertSelectList

Purpose

Insert a selection list into the form.

Syntax

WebInsertSelectList ()


WebInsertSubmitButton

Purpose

Insert a submit button into the form.

Syntax

WebInsertSubmitButton ()


WebInsertSubmitImage

Purpose

Insert a submit image into the form.

Syntax

WebInsertSubmitImage ()


WebInsertTextArea

Purpose

Insert a text area into the form.

Syntax

WebInsertTextArea ()


WebInsertTextLine

Purpose

Insert a text line into the form.

Syntax

WebInsertTextLine ()


WebJavaCreateApplet

Purpose

Create a Java applet.

Syntax

WebJavaCreateApplet ()


WebJavaModifyApplet

Purpose

Modify a Java applet.

Syntax

WebJavaModifyApplet ()


WebJavaRunApplets

Purpose

View the Java applets that are running.

Syntax

WebJavaRunApplets ()


WebLaunchWebBrowser

Purpose

Call the web browser and go to the specified location.

Syntax

WebLaunchWebBrowser (Location: string)

Parameters

Location

string (optional) The location (URL address) to go to. This is sometimes called an Internet address, web address, or Web site. If no address is specified, the Corel Corporation URL is used.

See Also

HelpOnlineSupportDlg, LaunchOnlineService


WebLinkColor

Purpose

Specify the hypertext-link color of the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebLinkColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

See Also

WebLinkColorRed, WebLinkColorGreen, WebLinkColorBlue


WebLinkColorBlue

Purpose

Return the blue value of the hypertext-link color for the active web document. If the current document is not a web document, the blue value of the default hypertext-link color for web documents is returned.

Syntax

numeric := WebLinkColorBlue ()

See Also

WebLinkColor


WebLinkColorGreen

Purpose

Return the green value of the hypertext-link color for the active web document. If the current document is not a web document, the green value of the default hypertext-link color for web documents is returned.

Syntax

numeric := WebLinkColorGreen ()

See Also

WebLinkColor


WebLinkColorRed

Purpose

Return the red value of the hypertext-link color for the active web document. If the current document is not a web document, the red value of the default hypertext-link color for web documents is returned.

Syntax

numeric := WebLinkColorRed ()

See Also

WebLinkColor


WebMetaTags

Purpose

Specify Meta tags for the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebMetaTags (Meta: string)

Parameters

Meta

string

See Also

?WebMetaTags, WebTitleDlg


WebMonoToggle

Purpose

Turn Web Monospaced on or off.

Syntax

WebMonoToggle ()


WebNewDlg

Purpose

Display the Select New Web Document dialog box.

Syntax

WebNewDlg ()

See Also

TemplateDlg


WebPublish

Purpose

Save the current document in HTML format (.HTM).

Syntax

WebPublish (Filename: string)

Parameters

Filename

string The path and filename of the HTML document.

See Also

InternetPublisherDlg, WebPublishDlg


WebPublishDlg

Purpose

Display the Publish to Web dialog box.

Syntax

WebPublishDlg ()

See Also

InternetPublisherDlg, WebPublish


WebTextColor

Purpose

Set the regular-text color of the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebTextColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.

See Also

WebTextColorRed, WebTextColorGreen, WebTextColorBlue


WebTextColorBlue

Purpose

Return the blue value of the text color for the active web document. If the current document is not a web document, the blue value of the default text color for web documents is returned.

Syntax

numeric := WebTextColorBlue ()

See Also

WebTextColor


WebTextColorGreen

Purpose

Return the green value of the text color for the active web document. If the current document is not a web document, the green value of the default text color for web documents is returned.

Syntax

numeric := WebTextColorGreen ()

See Also

WebTextColor


WebTextColorRed

Purpose

Return the red value of the text color for the active web document. If the current document is not a web document, the red value of the default text color for web documents is returned.

Syntax

numeric := WebTextColorRed ()

See Also

WebTextColor


WebTitle

Purpose

Specify the title for the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebTitle (Title: any)

Parameters

Title

any

Auto!

See Also

?WebTitle


WebTitleDlg

Purpose

Display the Title dialog box for web documents. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebTitleDlg ()

See Also

?WebTitle, WebTitle, WebBaseURL, WebMetaTags


WebViewAsHTML

Purpose

View the active document using HTML.

Syntax

WebViewAsHTML ()


WebViewInWebBrowser

Purpose

Convert the current document to HTML format and view it in a web browser. This command is valid only if you have a web browser installed.

Syntax

WebViewInWebBrowser ()

See Also

InternetPublisherDlg


WebVisitedLinkColor

Purpose

Specify the visited hypertext-link color of the active web document. This command is valid only when Corel WordPerfect is in Web Editor mode.

Syntax

WebVisitedLinkColor (Red: numeric; Green: numeric; Blue: numeric)

Parameters

Red

numeric Value: 0-255.

Green

numeric Value: 0-255.

Blue

numeric Value: 0-255.


WebVisitedLinkColorBlue

Purpose

Return the blue value of the visited hypertext-link color for the active web document. If the current document is not a web document, the blue value of the default visited hypertext-link color for web documents is returned.

Syntax

numeric := WebVisitedLinkColorBlue ()

See Also

WebVisitedLinkColor


WebVisitedLinkColorGreen

Purpose

Return the green value of the visited hypertext-link color for the active web document. If the current document is not a web document, the green value of the default visited hypertext-link color for web documents is returned.

Syntax

numeric := WebVisitedLinkColorGreen ()

See Also

WebVisitedLinkColor


WebVisitedLinkColorRed

Purpose

Return the red value of the visited hypertext-link color for the active web document. If the current document is not a web document, the red value of the default visited hypertext-link color for web documents is returned.

Syntax

numeric := WebVisitedLinkColorRed ()

See Also

WebVisitedLinkColor


WidowOrphan

Purpose

Turn Widow/Orphan on or off.

Syntax

WidowOrphan (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?WidowOrphan, BlockProtect, ConditionalEndOfPage, KeepTextTogetherDlg


WindowCascade

Purpose

Overlap document windows to display the title bar of each window.

Syntax

WindowCascade ()


WindowTile

Purpose

Arrange all open document windows top to bottom without overlapping them.

Syntax

WindowTile ()


WindowTileVertical

Purpose

Arrange all open document windows side by side without overlapping them.

Syntax

WindowTileVertical ()

See Also

WindowTile


WordCountDlg

Purpose

Display document information, such as word and page count, and words per sentence.

Syntax

WordCountDlg ()


WordLetterspaceDlg

Purpose

Display the Word/Letter Spacing dialog box.

Syntax

WordLetterspaceDlg ()


WordLetterSpacing

Purpose

Specify the display spacing between words and letters. Normal: recommended by font manufacturer. Optimal: recommended by Corel WordPerfect.

Syntax

WordLetterSpacing (CharacterWidth: enumeration; SpaceWidth: enumeration)

Parameters

CharacterWidth

enumeration The spacing between words. Use a number to specify a percent of the Optimal! default.

Maximum!

Normal!

Optimal!

SpaceWidth

enumeration The spacing between letters. Use a number to specify a percent of the Optimal! default.

Maximum!

Normal!

Optimal!

See Also

?CharSpaceWidth


WordSpacingJustificationLimits

Purpose

Adjust the spacing between words when Full justification is on. When a word spacing limit is reached, character spacing begins.

Syntax

WordSpacingJustificationLimits (Compression: numeric; Expansion: numeric)

Parameters

Compression

numeric The minimum percent.

Expansion

numeric The maximum percent.

See Also

?SpaceExpansion


WP51CursorMovement

Purpose

Turn Corel WordPerfect 5.1 for DOS cursor movement on or off. When Corel WordPerfect 5.1 cursor movement is on, the insertion point moves through codes as if Reveal Codes were on, regardless of the state of Reveal Codes.

Syntax

WP51CursorMovement (State: enumeration)

Parameters

State

enumeration

Off!

On!


WPActivate

Purpose

Activate Corel WordPerfect. Use with DDE links to another application.

Syntax

WPActivate ()


WPCharactersDlg

Purpose

Display the WordPerfect Characters dialog box.

Syntax

WPCharactersDlg ()


WPDraw

Purpose

Open Corel WordPerfect Draw.

Syntax

WPDraw ()

See Also

GraphicCreateChart


WPGrammatik

Purpose

Open Grammatik. This product allows you to check grammar and spelling in a document.

Syntax

WPGrammatik ()

See Also

WPSpeller, WPThesaurus


WPSpeller

Purpose

Display the Spell Checker dialog box.

Syntax

WPSpeller ()

See Also

WPSpeller, WPThesaurus


WPThesaurus

Purpose

Display the Thesaurus dialog box. The Thesaurus allows you to get synonyms, antonymns, definitions, and usages examples for words.

Syntax

WPThesaurus ()


WritingToolsDisable

Purpose

Toggle grammar and spell checking on or off at the insertion point or for the selected text. This command inserts a [Writing Tools: Disabled] or [Writing Tools: Enabled] code at the insertion point, depending on the current state.

Syntax

WritingToolsDisable ()

See Also

?WritingToolsDisabledState


ZoomDlg

Purpose

Display the Zoom dialog box, which allows you to change the magnification of the active window.

Syntax

ZoomDlg ()

See Also

?Zoom, ZoomToFullPage, ZoomToMarginWidth, ZoomToPageWidth


ZoomToFullPage

Purpose

Display a full page on screen.

Syntax

ZoomToFullPage ()

See Also

ZoomDlg, ZoomToMarginWidth, ZoomToPageWidth


ZoomToMarginWidth

Purpose

Display a document at the current margin width.

Syntax

ZoomToMarginWidth ()

See Also

ZoomDlg, ZoomToFullPage, ZoomToPageWidth


ZoomToPageWidth

Purpose

Display everything contained between the left and right edges of the current page.

Syntax

ZoomToPageWidth ()

See Also

ZoomDlg, ZoomToFullPage, ZoomToMarginWidth