TemplateCopyObject(CopyFrom As String, objecttype As _TemplateCopyObject_ObjectType_enum, ObjectName As String)
Description
Copy a template object, such as a style or a macro, from one template to another.
Parameters
CopyFrom: string The template to copy the object from.
ObjectType: enumeration Abbreviation!
ButtonBar!
Keyboard!
Macro!
Menu!
QuickWords!
ObjectName: string The name of the object to copy.
TemplateCopyObjectDlg
Syntax
TemplateCopyObjectDlg()
Description
Display the Copy/Remove Template Objects dialog box.
TemplateCreate
Syntax
TemplateCreate(Filename As String, [BasedOn As String])
Description
Create a new template based on an existing template and open the new template in edit mode.
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 method looks for the existing template in the default template folder.
TemplateDescriptionDlg
Syntax
TemplateDescriptionDlg()
Description
Display the Template Description dialog box.
TemplateDlg
Syntax
TemplateDlg()
Description
Display the Select New Document dialog box. When you use this method, the macro continues processing while the dialog box is displayed. Displaying the dialog box does not pause the macro.
TemplateEdit
Syntax
TemplateEdit(Filename As String)
Description
Edit a template.
Parameters
Filename: string The full path and filename of the template file.
TemplateFill
Syntax
TemplateFill()
Description
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 method 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 method 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 method does nothing.
TemplateGetAssociation
Syntax
TemplateGetAssociation(FeatureTrigger As _TemplateGetAssociation_FeatureTrigger_enum, Object As _TemplateGetAssociation_Object_enum) As String
Description
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.
Parameters
FeatureTrigger: enumeration BoxSelected!
Comment!
Endnote!
EquationEditor!
Footers!
Footnote!
Headers!
Main!
Outline!
PostClose!
PostDocument!
PostNew!
PostOpen!
PostPrint!
PostStartup!
PostTables!
PreClose!
PreDocument!
PreNew!
PreOpen!
PrePrint!
PreTables!
SGML!
Tables!
Watermark!
Object: enumeration ButtonBar!
Keyboard!
Macro!
Menu!
TemplateMacroEditControlBar
Syntax
TemplateMacroEditControlBar([State As _TemplateMacroEditControlBar_State_enum])
Description
Display the Template Macro Edit feature bar.
Parameters
State: enumeration (optional) Off!
On!
TemplateSelect
Syntax
TemplateSelect(Filename As String)
Description
Select a document template. This method applies the selected method to the active document, rather than creating a new document based on that template, as File | New from template does
Parameters
Filename: string The filename of the document template.
TemplateSetAssociation
Syntax
TemplateSetAssociation(FeatureTrigger As _TemplateSetAssociation_FeatureTrigger_enum, Object As _TemplateSetAssociation_Object_enum, ObjectName As String)
Description
Assign menus, keyboards, and toolbars to selected WordPerfect features or triggers in the current template.
Parameters
FeatureTrigger: enumeration BoxSelected!
Comment!
Endnote!
EquationEditor!
Footers!
Footnote!
Headers!
Main!
Outline!
PostClose!
PostDocument!
PostNew!
PostOpen!
PostPrint!
PostStartup!
PostTables!
PreClose!
PreDocument!
PreNew!
PreOpen!
PrePrint!
PreTables!
SGML!
Tables!
Watermark!
Object: enumeration ButtonBar!
Keyboard!
Macro!
Menu!
ObjectName: string The name of the object.
TextBorderCreate
Syntax
TextBorderCreate(Style, FillName, BorderFunction As _TextBorderCreate_BorderFunction_enum)
Description
Create a border for the current paragraph, column, or page. Use with TextBorderEnd(). You must pass the numeric values for Style and FillName.
Parameters
Style: any ButtonBorder!
ColumnBorderAll!
ColumnBorderBetween!
DashedBorder!
DottedBorder!
DoubleBorder!
ExtraThickBorder!
HeavyDoubleBorder!
HeavySingleBorder!
NoBorder!
SingleBorder!
SpacingOnly!
ThickBorder!
ThickThinBorder!
ThickTopBottomBorder!
ThinThickBorder! 10
12
11
3
4
2
6
14
13
127
1
0
5
9
9
7
FillName: any Fill10!
Fill100!
Fill20!
Fill30!
Fill40!
Fill5!
Fill50!
Fill60!
Fill70!
Fill80!
Fill90!
FillButton!
NoFill! 0
9
1
2
3
11
4
5
6
7
8
10
127
BorderFunction: enumeration ColumnBorder!
PageBorder!
ParagraphBorder!
TextBorderEdit
Syntax
TextBorderEdit(BorderType As _TextBorderEdit_BorderType_enum)
Description
Begin editing changes to the current border.
Parameters
BorderType: enumeration Column!
Page!
Paragraph!
TextBorderEnd
Syntax
TextBorderEnd(State As _TextBorderEnd_State_enum)
Description
End text border creation or editing, and save or cancel changes.
Parameters
State: enumeration Cancel!
Save!
TextBorderFillStyle
Syntax
TextBorderFillStyle(FillName)
Description
Specify a fill style for the current border. You must pass ther numeric value for FillName.
Parameters
FillName: any Fill10!
Fill100!
Fill20!
Fill30!
Fill40!
Fill5!
Fill50!
Fill60!
Fill70!
Fill80!
Fill90!
FillButton!
NoFill! 0
9
1
2
3
11
4
5
6
7
8
10
127
TextBorderStyle
Syntax
TextBorderStyle(Style)
Description
Specify the current border style.
Parameters
Style: any ButtonBorder!
ColumnBorderAll!
ColumnBorderBetween!
DashedBorder!
DottedBorder!
DoubleBorder!
ExtraThickBorder!
HeavyDoubleBorder!
HeavySingleBorder!
NoBorder!
SingleBorder!
SpacingOnly!
ThickBorder!
ThickThinBorder!
ThickTopBottomBorder!
ThinThickBorder! 10
12
11
3
4
2
6
14
13
127
1
0
5
9
9
7
TextBoxCreate
Syntax
TextBoxCreate()
Description
Create a text box and display the Text Box feature bar.
TextColor
Syntax
TextColor([ColorName As String], [Red As Integer], [Green As Integer], [Blue As Integer])
Description
Specify a text color.
Parameters
ColorName: string (optional) This parameter has been left in for backward compatibility with previous versions of WordPerfect. To specify a color in WordPerfect 8, use the Red, Green, and Blue parameters.
Red: numeric Value: 0-255.
Green: numeric Value: 0-255.
Blue: numeric Value: 0-255.
TextShade
Syntax
TextShade(ShadingValue As Integer)
Description
Specify the intensity of a text color.
Parameters
ShadingValue: numeric Percent. Full intensity: 100%.
ThirdPartyCreate
Syntax
ThirdPartyCreate(Id As Integer, Data)
Description
Insert a third-party function into a document.
Parameters
Id: numeric The ID for the third party function.
Data: raw binary data The data for the third party function.
ThirdPartyDelete
Syntax
ThirdPartyDelete(Id As Integer, From As _ThirdPartyDelete_From_enum, Direction As _ThirdPartyDelete_Direction_enum)
Description
Delete a third-party function from a document.
Parameters
Id: numeric The ID for the third party function.
From: enumeration BegOfFile!
CurrentPos!
Direction: enumeration Backward!
Forward!
ThirdPartyFind
Syntax
ThirdPartyFind(From As _ThirdPartyFind_From_enum, Direction As _ThirdPartyFind_Direction_enum) As Integer
Description
Find the third-party id of the next or previous third party.
Parameters
From: enumeration BegOfFile!
CurrentPos!
Direction: enumeration Backward!
Forward!
ThirdPartyFindByID
Syntax
ThirdPartyFindByID(Id As Integer, From As _ThirdPartyFindByID_From_enum, Direction As _ThirdPartyFindByID_Direction_enum)
Description
Get the data from a third-party function.
Parameters
Id: numeric The ID for the third party function.
From: enumeration BegOfFile!
CurrentPos!
Direction: enumeration Backward!
Forward!
ThousandsSeparator
Syntax
ThousandsSeparator([Character As String]) As String
Description
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().
Parameters
Character: string The character to use as a thousands separator.
TOACreateFullFormDlg
Syntax
TOACreateFullFormDlg()
Description
Display the Create Full Form dialog box.
TOADefineDlg
Syntax
TOADefineDlg()
Description
Display the Define Table of Authorities dialog box.
TOADefinition
Syntax
TOADefinition(SectionName As String, [Style], [Numbering As _TOADefinition_Numbering_enum], [Underline As _TOADefinition_Underline_enum], [PageCombine As _TOADefinition_PageCombine_enum], [NumberingFormat As String])
Description
Specify a section, define format options, and insert a table of authorities definition in the document. You must pass the numeric value for the Style.
NumberingFormat: string (optional) The numbering format for the table.
TOADefinitionCombine
Syntax
TOADefinitionCombine(SectionName As String, [Combine As _TOADefinitionCombine_Combine_enum])
Description
Combine sequential page numbers in a table of authorities section.
Parameters
SectionName: string The name of the section.
Combine: enumeration (optional) Combine!
NoCombine!
TOADefinitionCreate
Syntax
TOADefinitionCreate(SectionName As String, [Style], [Numbering As _TOADefinitionCreate_Numbering_enum], [Underline As _TOADefinitionCreate_Underline_enum], [PageCombine As _TOADefinitionCreate_PageCombine_enum], [NumberingFormat As String])
Description
Create a table of authorities definition. You must pass the numeric value for the Style.
NumberingFormat: string (optional) The numbering format for the section.
TOADefinitionDelete
Syntax
TOADefinitionDelete(SectionName As String)
Description
Delete a table of authorities section definition.
Parameters
SectionName: string The name of the section definition to delete.
TOADefinitionMode
Syntax
TOADefinitionMode(SectionName As String, [Numbering As _TOADefinitionMode_Numbering_enum])
Description
Specify a page numbering mode in a section.
Parameters
SectionName: string The name of the section definition.
Numbering: enumeration (optional) DefFlushRight!
DefFollows!
DefFollowsParenthesis!
DefLeaders!
DefNone!
TOADefinitionRename
Syntax
TOADefinitionRename(OldSection As String, NewSection As String)
Description
Rename a section.
Parameters
OldSection: string The original name of the section.
NewSection: string The new name of the section.
TOADefinitionRetrieve
Syntax
TOADefinitionRetrieve(Filename As String, SectionName As String)
Description
Retrieve a section from another document into the current document.
Parameters
Filename: string The filename of the section file.
SectionName: string The name of the section to retrieve.
TOADefinitionStyle
Syntax
TOADefinitionStyle(SectionName As String, Style)
Description
Specify a table of authorities section style. You must pass the numeric value of the Style.
Parameters
SectionName: string The name of the section.
Style: any (optional) NormalStyle! [0]
FootnoteNumberInDocumentStyle! [16]
EndnoteNumberInDocumentStyle! [17]
FigureNumberStyle! [18]
TableBoxNumberStyle! [19]
TextBoxNumberStyle! [20]
UserBoxNumberStyle! [21]
EquationNumberStyle! [22]
HypertextStyle! [23]
ToC1Style! [24]
ToC2Style! [25]
ToC3Style! [26]
ToC4Style! [27]
ToC5Style! [28]
Index1Style! [29]
Index2Style! [30]
ListStyle! [31]
ToAStyle! [32]
DocStyle! [33]
BoxTextStyle! [34]
CaptionStyle! [35]
FootnoteStyle! [36]
EndnoteStyle! [37]
CommentStyle! [38]
HeaderAStyle! [39]
HeaderBStyle! [40]
FooterAStyle! [41]
FooterBStyle! [42]
WatermarkAStyle! [43]
WatermarkBStyle!AddressStyle! [44]
ParagraphOutlnStyle! [45]
OutlineStyle! [46]
LegalOutlnStyle! [47]
BulletsOutlnStyle! [48]
HeadingsOutlnStyle! [48]
Legal_2OutlnStyle! [49]
NumbersOutlnStyle! [50]
Level1Style! [51]
Level2Style! [52]
Level3Style! [53]
Level4Style! [54]
Level5Style! [55]
Level6Style! [56]
Level7Style! [57]
Level8Style! [58]
Legal1Style! [59]
Legal2Style! [60]
Legal3Style! [61]
Legal4Style! [62]
Legal5Style! [63]
Legal6Style! [64]
Legal7Style! [65]
Legal8Style! [66]
Heading1Style! [67]
Heading2Style! [68]
Heading3Style! [69]
Heading4Style! [70]
Heading5Style! [71]
Heading6Style! [72]
Heading7Style! [73]
Heading8Style! [74]
MonospacedStyle! [75]
CustomHTMLStyle! [76]
PreformattedStyle! [77]
AddressStyle! [78]
QuotationsOutlnStyle! [79]
DefinitionsOutlnStyle! [80]
Quotation1Style! [81]
Quotation2Style! [82]
Quotation3Style! [83]
Quotation4Style! [84]
Quotation5Style! [85]
Quotation6Style! [86]
Quotation7Style! [87]
Quotation8Style! [88]
Definition1Style! [89]
Definition2Style! [90]
Definition3Style! [91]
Definition4Style! [92]
Definition5Style! [93]
Definition6Style! [94]
Definition7Style! [95]
Definition8Style! [96]
Level9Style! [97]
Legal9Style! [111]
Heading9Style! [112]
Quotation9Style! [113]
DefinitionStyle [114]
TOADefinitionUnderline
Syntax
TOADefinitionUnderline(Section As String, [Action As _TOADefinitionUnderline_Action_enum])
Description
Turn Underlining on or off in a table of authorities section.
Parameters
Section: string The name of the section.
Action: enumeration (optional) NoToAUnderline!
ToAUnderline!
TOAEditFullForm
Syntax
TOAEditFullForm(ShortForm As String)
Description
Begin editing changes to a full form. SubstructureExit ends editing and saves changes.
Parameters
ShortForm: string The name of the form.
TOAEditFullFormCBar
Syntax
TOAEditFullFormCBar()
Description
Display the Table of Authorities Full Form feature bar.
TOAEditFullFormDlg
Syntax
TOAEditFullFormDlg()
Description
Display the Edit Full Form dialog box.
TOAEditPageFormat
Syntax
TOAEditPageFormat(ListName As String, NumberFormat))
Description
Specify the text for page numbering in a table of authorities.
Parameters
Listname: string The name of the list.
NumberFormat: any Use a string to specify a custom format.
DocFormat!
TOAEditSection
Syntax
TOAEditSection(OldName As String, NewName As String)
Description
Rename a section name in the full form of a table of authorities.
Parameters
OldName: string The original name of the form.
NewName: string The new name of the form.
TOAEditShortForm
Syntax
TOAEditShortForm(OldName As String, NewName As String)
Description
Rename a short form name in the full form of a table of authorities.
Parameters
OldName: string The original name of the form.
NewName: string The new name of the form.
TOAMark
Syntax
TOAMark([SectionName As String], [ShortForm As String])
Description
Mark the selected text as a table of authorities reference.
Parameters
SectionName: string (optional) The name of the section.
ShortForm: string (optional) The name of the form.
TOAMarkShortForm
Syntax
TOAMarkShortForm(ShortForm As String)
Description
Mark the current short form citation at the insertion point.
Parameters
ShortForm: string The name of the form.
TOCDefine
Syntax
TOCDefine([WrapLastLevel As _TOCDefine_WrapLastLevel_enum], [NumberingFormat As String], [Style], [Numbering])
Description
Define a table of contents and insert the definition. You must pass the numeric value for the Style.
Parameters
WrapLastLevel: enumeration (optional) Wrap the last level.
No!
Yes!
NumberingFormat: string (optional) The page numbering format.
Style: any (optional) NormalStyle! [0]
FootnoteNumberInDocumentStyle! [16]
EndnoteNumberInDocumentStyle! [17]
FigureNumberStyle! [18]
TableBoxNumberStyle! [19]
TextBoxNumberStyle! [20]
UserBoxNumberStyle! [21]
EquationNumberStyle! [22]
HypertextStyle! [23]
ToC1Style! [24]
ToC2Style! [25]
ToC3Style! [26]
ToC4Style! [27]
ToC5Style! [28]
Index1Style! [29]
Index2Style! [30]
ListStyle! [31]
ToAStyle! [32]
DocStyle! [33]
BoxTextStyle! [34]
CaptionStyle! [35]
FootnoteStyle! [36]
EndnoteStyle! [37]
CommentStyle! [38]
HeaderAStyle! [39]
HeaderBStyle! [40]
FooterAStyle! [41]
FooterBStyle! [42]
WatermarkAStyle! [43]
WatermarkBStyle!AddressStyle! [44]
ParagraphOutlnStyle! [45]
OutlineStyle! [46]
LegalOutlnStyle! [47]
BulletsOutlnStyle! [48]
HeadingsOutlnStyle! [48]
Legal_2OutlnStyle! [49]
NumbersOutlnStyle! [50]
Level1Style! [51]
Level2Style! [52]
Level3Style! [53]
Level4Style! [54]
Level5Style! [55]
Level6Style! [56]
Level7Style! [57]
Level8Style! [58]
Legal1Style! [59]
Legal2Style! [60]
Legal3Style! [61]
Legal4Style! [62]
Legal5Style! [63]
Legal6Style! [64]
Legal7Style! [65]
Legal8Style! [66]
Heading1Style! [67]
Heading2Style! [68]
Heading3Style! [69]
Heading4Style! [70]
Heading5Style! [71]
Heading6Style! [72]
Heading7Style! [73]
Heading8Style! [74]
MonospacedStyle! [75]
CustomHTMLStyle! [76]
PreformattedStyle! [77]
AddressStyle! [78]
QuotationsOutlnStyle! [79]
DefinitionsOutlnStyle! [80]
Quotation1Style! [81]
Quotation2Style! [82]
Quotation3Style! [83]
Quotation4Style! [84]
Quotation5Style! [85]
Quotation6Style! [86]
Quotation7Style! [87]
Quotation8Style! [88]
Definition1Style! [89]
Definition2Style! [90]
Definition3Style! [91]
Definition4Style! [92]
Definition5Style! [93]
Definition6Style! [94]
Definition7Style! [95]
Definition8Style! [96]
Level9Style! [97]
Legal9Style! [111]
Heading9Style! [112]
Quotation9Style! [113]
DefinitionStyle [114]
Numbering: enumeration (optional) The page numbering mode for references.
DefFlushRight!
DefFollows!
DefLeader!
DefNone!
DefParentheses!
TOCDefineDlg
Syntax
TOCDefineDlg()
Description
Display the Define Table of Contents dialog box.
TOCMark
Syntax
TOCMark(Level As Integer)
Description
Mark the selected text for the table of contents.
Parameters
Level: numeric
TotalPages
Syntax
()
Description
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.
If you do not use any of the optional parameters available, any existing code will be removed from the document in question.
The following is an example of moving to the end of the document before using TotalPages:
QuickmarkSet ()
PosDocBottom ()
QuickMarkFind ()
BookmarkDelete (Name: "QuickMark")
vPages := TotalPages ()
TotalPagesDisplay
Syntax
TotalPagesDisplay()
Description
Insert a code in the text to display the total number of pages.
TotalPagesMethod
Syntax
TotalPagesMethod([Method As _TotalPagesMethod_Method_enum])
Description
Specify the page-numbering method for the total number of pages.
Parameters
Method: enumeration (optional) LowerLetters!
LowerRoman!
Numbers!
UpperLetters!
UpperRoman!
Note
If you do not specify an enumeration, any page numbering in your document in the Page (Page #) of (Tot Pages#) format is removed.
TwainAcquire
Syntax
TwainAcquire()
Description
Scan an image into WordPerfect. 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.
TwainSelectSourceDlg
Syntax
TwainSelectSourceDlg()
Description
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.
TypeChar
Syntax
TypeChar(CharacterSet As Integer, Offset As Integer)
Description
Insert a character from the WordPerfect character sets.
Parameters
CharacterSet: numeric The character to insert.
Offset: numeric A WordPerfect character.
Typeover
Syntax
Typeover(State As _Typeover_State_enum)
Description
Turn Typeover on or off.
Parameters
State: enumeration Off!
On!
TypeoverKey
Syntax
Typeover(State As _Typeover_State_enum)()
Description
urn Typeover on or off
TypesetManualKerningDlg
Syntax
TypesetManualKerningDlg()
Description
Display the Manual Kerning dialog box, which allows you to increase or decrease the space between two characters.
