Chapter 2

Corel^® WordPerfect^® Product Commands
B

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

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

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

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

See Also

BoxDelete, BoxEdit, BoxEnd

BoxDelete

Purpose

Delete a graphics box.

Syntax

BoxDelete (BoxType: enumeration; BoxNumber: numeric)

Parameters

BoxType

enumeration

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.

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.

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)

Attributes

enumeration (optional)

Weight

enumeration (optional)

Width

enumeration (optional)

Source

enumeration (optional)

DRSFile!

PRSFile!

Type

enumeration (optional)

Intellifont!

Speedo!

TrueType!

Type1!

CharacterSet

enumeration (optional)

See Also

?BoxEquationFont, ?BoxEquationFontSize, BoxEquationDefaultFont, BoxEquationFontSize