Chapter 2

Corel^® WordPerfect^® Product Commands
T

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

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

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

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

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

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

FillName

any

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

See Also

TextBorderEdit

TextBorderStyle

Purpose

Specify the current border style.

Syntax

TextBorderStyle (Style: any)

Parameters

Style

any

See Also

?Border, TextBorderEdit, TextBorderEnd

TextBoxCreate

Purpose

Create a text box and display the Text Box feature bar.

Syntax

TextBoxCreate ()

See Also

Close