Chapter 2

Corel^® WordPerfect^® Product Commands
D

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)

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)

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)

Attributes

enumeration (optional)

FontMatchItalic!

FontMatchNormal!

FontMatchOutline!

FontMatchShadow!

FontMatchSmallCaps!

Weight

enumeration (optional)

Width

enumeration (optional)

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

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.

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)

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.

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.

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.

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