Chapter 2

See Graphic.

Corel® WordPerfect® Product Commands
GH


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