Chapter 2

Corel^® WordPerfect^® Product Commands
T

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)

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)

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

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)

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