Chapter 2
Corel® WordPerfect® Product Commands
MN
MarkList
Purpose
Display the List feature bar.
Syntax
MarkList ()
See Also
MarkListUpdateList
MarkListUpdateList
Purpose
Update the List feature bar.
Syntax
MarkListUpdateList (ListName: string)
Parameters
ListName
string
See Also
MarkList
MarkTableOfAuthorities
Purpose
Display the Table of Authorities feature bar.
Syntax
MarkTableOfAuthorities ()
MarkTableOfContents
Purpose
Display the Table of Contents feature bar.
Syntax
MarkTableOfContents ()
MarkTOAUpdateList
Purpose
Update the Table of Authorities feature bar.
Syntax
MarkTOAUpdateList (ShortForm: string)
Parameters
ShortForm
string The list name in a table of authorities.
MasterDocCondense
Purpose
Condense selected subdocuments and save changes.
Syntax
MasterDocCondense (Filename: string; Action: enumeration)
Parameters
Filename
string (optional)
Action
enumeration
SaveSub!
SkipSub!
See Also
MasterDocCondenseDlg
MasterDocCondenseDlg
Purpose
Display the Condense/Save Subdocuments dialog box.
Syntax
MasterDocCondenseDlg ()
See Also
MasterDocCondense
MasterDocExpand
Purpose
Expand a subdocument. Specify a subdocument with SubDocInclude.
Syntax
MasterDocExpand (Filename: string)
Parameters
Filename
string (optional)
MasterDocSubdocDlg
Purpose
Display the Include Subdocument dialog box.
Syntax
MasterDocSubdocDlg ()
MatchElement
Purpose
Specify that Find and Replace finds a tag that meets certain conditions. The command applies only to searches for specific elements. Begin your search with SpecificSearchStringBegin and end it with SpecificStringEnd. Use SGMLInsertElement to specify which element name you are searching for. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.
Syntax
MatchElement (Attribute: string; Value: string; Type: enumeration; EditAttribute: enumeration)
Parameters
Attribute
string (optional)
Value
string (optional)
Type
enumeration
End!
Start!
EditAttribute
enumeration (optional)
No!
Yes!
See Also
SpecificSearchStringBegin, SpecificStringEnd, SGMLInsertElement
MatchExtendSelection
Purpose
In a Find and Replace search, extend the selected text to include matches that are not in the original selection.
Syntax
MatchExtendSelection ()
MatchFindIfInElements
Purpose
Specify that Find and Replace search only in the specified SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.
Syntax
MatchFindIfInElements (State: enumeration; Action: enumeration; {Element: string; })
Parameters
State
enumeration
No!
Yes!
Action
enumeration (optional) If Action is AnyOrder!, then a match will occur only within any of the specified elements. If Action is ListedOrder!, then the match will occur only within any of the specified elements when the elements are in the order of the element string. For example, if you specify to find a word that is within <TITLE> which is within <titlpage>, a match will not be made if the word is within <TITLE> which is not within <titlpage>.
AnyOrder!
ListedOrder!
Element
string (optional)
MatchLimit
Purpose
Limit a Replace All search to a specified number of occurrences.
Syntax
MatchLimit (State: enumeration; LimitValue: numeric)
Parameters
State
enumeration Limit a Find and Replace search.
No!
Yes!
LimitValue
numeric (optional)
MatchPositionAfter
Purpose
Place the insertion point after matched text in a Find and Replace search.
Syntax
MatchPositionAfter ()
See Also
MatchPositionBefore
MatchPositionBefore
Purpose
Place the insertion point before matched text in a Find and Replace search.
Syntax
MatchPositionBefore ()
See Also
MatchPositionAfter
MatchSelection
Purpose
Select matched text in a Find and Replace search.
Syntax
MatchSelection ()
MatchSkipIfInElements
Purpose
Specify that Find and Replace search all of the document except within the specified SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed and the current document is a Corel WordPerfect SGML document.
Syntax
MatchSkipIfInElements ({Element: string; })
Parameters
Element
string (optional)
MatchWithAttributes
Purpose
Match only text with specified attributes in a Find and Replace search.
Syntax
MatchWithAttributes (State: enumeration; {Attribute: enumeration; })
Parameters
State
enumeration
No!
Yes!
Attribute
enumeration (optional)
|
Bold! |
Shadow! |
|
DoubleUnderline! |
Small! |
|
ExtraLarge! |
SmallCaps! |
|
Fine! |
Strikeout! |
|
Italics! |
Subscript! |
|
Large! |
Superscript! |
|
Outline! |
Underline! |
|
Redline! |
VeryLarge! |
See Also
MatchWithFont, MatchWithFontSize
MatchWithFont
Purpose
Match only text with specified font attributes in a Find and Replace search.
Syntax
MatchWithFont (State: enumeration; Typeface: string; Family: enumeration; Attributes: enumeration; Weight: enumeration; Width: enumeration; Source: enumeration; Type: enumeration; CharacterSet: enumeration)
Parameters
State
enumeration
No!
Yes!
Typeface
string (optional)
Family
enumeration (optional)
|
FamilyAestheticOrnamented! |
FamilyITCZapfDingbats! |
|
FamilyAlbertus! |
FamilyLetterGothic! |
|
FamilyBodoni! |
FamilyMadrone! |
|
FamilyBroadway! |
FamilyMicrostyle! |
|
FamilyBrush! |
FamilyOldEnglish! |
|
FamilyCenturySchoolbook! |
FamilyOptima! |
|
FamilyComputer! |
FamilyParkAvenue! |
|
FamilyCourier! |
FamilyPonderosa! |
|
FamilyHelvetica! |
FamilyPTBarnum! |
|
FamilyHobo! |
FamilyRevue! |
|
FamilyITCBenguiat! |
FamilySignetRoundhand! |
|
FamilyITCGaramon! |
FamilyTekton! |
|
FamilyITCLubalinGraph! |
FamilyTimesRoman! |
|
FamilyITCRonda! |
FamilyUncial! |
Attributes
enumeration (optional)
FontMatchItalic!
FontMatchNormal!
FontMatchOutline!
FontMatchShadow!
FontMatchSmallCaps!
Weight
enumeration (optional)
|
WeightBlack! |
WeightMaximum! |
|
WeightBold! |
WeightMedium! |
|
WeightBook! |
WeightRegular! |
|
WeightDemiBold! |
WeightRoman! |
|
WeightDemiLight! |
WeightSemiBold! |
|
WeightExtraBlack! |
WeightSemiLight! |
|
WeightExtraBold! |
WeightThin! |
|
WeightExtraHeavy! |
WeightUltraBlack! |
|
WeightExtraLight! |
WeightUltraHeavy! |
|
WeightExtraThin! |
WeightUltraLight! |
|
WeightHeavy! |
WeightUltraThin! |
|
WeightLight! |
WeightUnknown! |
Width
enumeration (optional)
|
WidthCompressed! |
WidthSemiCondensed! |
|
WidthCondensed! |
WidthSemiExpanded! |
|
WidthDoubleWide! |
WidthTripleWide! |
|
WidthExpanded! |
WidthUltraCompressed! |
|
WidthExtraCondensed! |
WidthUltraCondensed! |
|
WidthExtraExpanded! |
WidthUltraExpanded! |
|
WidthNormal! |
WidthUnknown! |
Source
enumeration (optional)
DRSFile!
PRSFile!
Type
enumeration (optional)
Intellifont!
Speedo!
TrueType!
Type1!
CharacterSet
enumeration (optional)
|
FontMatchArabic! |
FontMatchJapaneseKana! |
|
FontMatchArabicScript! |
FontMatchMath! |
|
FontMatchASCII! |
FontMatchMathExtension! |
|
FontMatchBoxDrawing! |
FontMatchMultinational1! |
|
FontMatchCyrillic! |
FontMatchMultinational2! |
|
FontMatchGreek! |
FontMatchTypographicSymbols! |
|
FontMatchHebrew! |
FontMatchUserDefined! |
|
FontMatchIconicSymbols! |
See Also
MatchWithAttributes, MatchWithFontSize
MatchWithFontSize
Purpose
Match only text with a specified font size in a Find and Replace search.
Syntax
MatchWithFontSize (State: enumeration; FontSize: measurement)
Parameters
State
enumeration
No!
Yes!
FontSize
measurement (optional)
See Also
MatchWithAttributes, MatchWithFont
MenuAddFeature
Purpose
Add a feature to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddFeature (Menu: string; Name: command name; Offset: numeric)
Parameters
Menu
string
Name
command name
Offset
numeric (optional)
MenuAddMacro
Purpose
Add a macro to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddMacro (Menu: string; Name: string; MacroName: string; Hint: string; Offset: numeric)
Parameters
Menu
string
Name
string
MacroName
string
Hint
string (optional)
Offset
numeric (optional)
MenuAddProgram
Purpose
Add a program to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddProgram (Menu: string; Name: string; ProgramName: string; Hint: string; Offset: numeric)
Parameters
Menu
string
Name
string
ProgramName
string
Hint
string (optional)
Offset
numeric (optional)
MenuAddScript
Purpose
Add a keyboard script to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddScript (Menu: string; Name: string; Script: string; Hint: string; Offset: numeric)
Parameters
Menu
string
Name
string
Script
string
Hint
string (optional)
Offset
numeric (optional)
MenuAddSeparator
Purpose
Add a separator to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddSeparator (Menu: string; Offset: numeric)
Parameters
Menu
string
Offset
numeric (optional)
MenuAddSubMenu
Purpose
Add a submenu to the current Corel WordPerfect menu.
Syntax
boolean := MenuAddSubMenu (Menu: string; Name: string; Hint: string; Offset: numeric)
Parameters
Menu
string
Name
string
Hint
string (optional)
Offset
numeric (optional)
MenuDeleteItemEx
Purpose
Delete an item from the current Corel WordPerfect menu.
Syntax
boolean := MenuDeleteItemEx (Menu: string; Name: string; Offset: numeric)
Parameters
Menu
string
Name
string (optional)
Offset
numeric (optional) This parameter is optional only when you are deleting a feature from a menu. If you want to delete a macro or a program, then this parameter is required.
MenuSelect
Purpose
Choose a menu.
Syntax
MenuSelect (MenuName: string)
Parameters
MenuName
string (optional)
See Also
MenuSelectDlg
Purpose
Display the Menu Bar Settings dialog box.
Syntax
MenuSelectDlg ()
See Also
MenuSelect
MergeAddressBook
Purpose
Specify an address book to associate with the current form file.
Syntax
MergeAddressBook (AddressBook: string)
Parameters
AddressBook
string The name of the address book to associate. If this parameter is left blank, the current association for the form file is removed whether it is associated with an address book or a data file.
MergeAddressBookSaveAs
Purpose
Save address book records as a merge data file.
Syntax
MergeAddressBookSaveAs (OutputFile: string; AddressBook: string)
Parameters
OutputFile
string The path and filename of the new merge data file.
AddressBook
string (optional) The address book to save as a merge data file. If this parameter is blank, the currently selected records are used; if not, all records in the specified address book are used. Address book selections can include records from multiple address books.
MergeBlankField
Purpose
Leave or remove a blank field. If blank fields are removed, the remaining fields shift up one line.
Syntax
MergeBlankField (State: enumeration)
Parameters
State
enumeration
Leave!
Remove!
MergeCode
Purpose
Insert a merge code.
Syntax
MergeCode (Codes: enumeration; String: string)
Parameters
Codes
enumeration
|
Assign! |
Keyboard! |
|
AssignLocal! |
Label! |
|
Beep! |
Look! |
|
Break! |
MrgCmnd! |
|
Call! |
NestData! |
|
CancelOff! |
NestForm! |
|
CancelOn! |
NestMacro! |
|
Caps! |
Next! |
|
CaseOf! |
NextRecord! |
|
ChainData! |
NtoC! |
|
ChainForm! |
OnCancel! |
|
ChainMacro! |
OnError! |
|
Char! |
PageOff! |
|
Codes! |
PageOn! |
|
Comment! |
PostNet! |
|
Continue! |
Print!Macro List Text = ProcessOff! |
|
CtoN! |
ProcessOn! |
|
Date! |
Prompt! |
|
Default! |
Quit! |
|
DisplayStop! |
RepeatRow! |
|
Document! |
Return! |
|
Else! |
ReturnCancel! |
|
EmbedMacro! |
ReturnError! |
|
EndField! |
Rewrite! |
|
EndFor! |
StatusPrompt! |
|
EndIf! |
StepOff! |
|
EndRecord! |
StepOn! |
|
EndSwitch! |
Stop! |
|
EndWhile! |
StrLen! |
|
Field! |
StrPos! |
|
FieldNames! |
SubstData! |
|
FirstCap! |
SubstForm! |
|
ForEach! |
SubStr! |
|
ForNext! |
Switch! |
|
GetString! |
System! |
|
Go! |
ToLower! |
|
If! |
ToUpper! |
|
IfBlank! |
Variable! |
|
IfExists! |
Wait! |
|
IfNotBlank! |
While! |
|
Insert! |
String
string (optional) The field parameters.
MergeCodesDisplayEdit
Purpose
Display or hide merge codes, or display them as markers.
Syntax
MergeCodesDisplayEdit (Display: enumeration)
Parameters
Display
enumeration
Hide!
Marker!
Show!
See Also
MergeCodesDisplayRun
MergeCodesDisplayRun
Purpose
Display or hide merge codes, or display them as markers in a merged document.
Syntax
MergeCodesDisplayRun (Display: enumeration)
Parameters
Display
enumeration
Hide!
Marker!
Show!
See Also
MergeCodesDisplayEdit
MergeCodesDlg
Purpose
Display the Insert Merge Codes dialog box.
Syntax
MergeCodesDlg ()
MergeCondition
Purpose
Define a condition to select records from a data file.
Syntax
MergeCondition (Condition1: string; Condition2: string; Condition3: string; Condition4: string; Condition5: string; Condition6: string; Condition7: string; Condition8: string; Condition9: string; Condition10: string; Condition11: string; Condition12: string; Condition13: string; Condition14: string; Condition15: string)
Parameters
Condition1
string (optional)
Condition2
string (optional)
Condition3
string (optional)
Condition4
string (optional)
Condition5
string (optional)
Condition6
string (optional)
Condition7
string (optional)
Condition8
string (optional)
Condition9
string (optional)
Condition10
string (optional)
Condition11
string (optional)
Condition12
string (optional)
Condition13
string (optional)
Condition14
string (optional)
Condition15
string (optional)
MergeDataFile
Purpose
Specify the data file to associate with a form file.
Syntax
MergeDataFile (DataFile: string)
Parameters
DataFile
string (optional)
See Also
SortAction, SortType
MergeDlg
Purpose
Display the Merge dialog box.
Syntax
MergeDlg ()
MergeEndField
Purpose
Insert an [ENDFIELD] code at the insertion point. Recordable substitute: MergeCode.
Syntax
MergeEndField ()
MergeEndRecord
Purpose
Insert an [ENDRECORD] code at the insertion point. Recordable substitute: MergeCode.
Syntax
MergeEndRecord ()
MergeEnvelope
Purpose
Create an envelope for merged records.
Syntax
MergeEnvelope (State: enumeration)
Parameters
State
enumeration
Off!
On!
MergeEnvelopeDefinitionBegin
Purpose
Begin a MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. Contains address information.
Syntax
MergeEnvelopeDefinitionBegin ()
See Also
MergeEnvelope, MergeEnvelopeDefinitionEnd
MergeEnvelopeDefinitionEnd
Purpose
End a merge envelope definition. Precede with MergeEnvelopeDefinitionBegin.
Syntax
MergeEnvelopeDefinitionEnd ()
See Also
MergeEnvelope, MergeEnvelopeDefinitionBegin
MergeFileAssociate
Purpose
Associate form and data files. MergeDataFile creates a recordable association.
Syntax
MergeFileAssociate (FormFile: string; DataFile: string)
Parameters
FormFile
string
DataFile
string (optional)
MergeFileAssociateAddressBook
Purpose
Associate a form file with an address book data source. This command also removes a data file association from the form file, if such an association exists.
Syntax
MergeFileAssociateAddressBook (FormFile: string; AddressBook: string)
Parameters
FormFile
string The path and filename of the form file to associate with the address book.
AddressBook
string (optional) The name of the address book to use as a data source for the form file. If this is blank, all associations will be removed.
MergeFileAssociateODBC
Purpose
Associate a form file with an ODBC data source and table.
Syntax
MergeFileAssociateODBC (FormFile: string; DataSource: string; TableName: string)
Parameters
FormFile
string
DataSource
string (optional)
TableName
string (optional)
MergeFilesDlg
Purpose
Display the Perform Merge dialog box.
Syntax
MergeFilesDlg ()
MergeFileType
Purpose
Specify the file type to merge.
Syntax
MergeFileType (FileType: enumeration)
Parameters
FileType
enumeration
Form!
None!
TableData!
TextData!
MergeFormDlg
Purpose
Display the Create Merge File dialog box.
Syntax
MergeFormDlg ()
MergeMark
Purpose
Mark a record to include in a merge.
Syntax
MergeMark (RecordNum: numeric)
Parameters
RecordNum
numeric A record number.
MergeODBC
Purpose
Specify an ODBC data source and table to associate with the current form file.
Syntax
MergeODBC (DataSource: string; TableName: string)
Parameters
DataSource
string
TableName
string
MergePageBreak
Purpose
Separate merged documents with a page break.
Syntax
MergePageBreak (State: enumeration)
Parameters
State
enumeration
Off!
On!
MergePrintText
Purpose
Print a data file without page breaks between the records.
Syntax
MergePrintText ()
See Also
MergeFileType
MergeRepeat
Purpose
Specify the number of times to merge each record.
Syntax
MergeRepeat (NumberToRepeat: numeric)
Parameters
NumberToRepeat
numeric
MergeRun
Purpose
Merge a form file and a data file.
Syntax
MergeRun (FormFileType: enumeration; FormFile: string; DataFileType: enumeration; DataFile: string; OutputFileType: enumeration; OutputFile: string; AddressBook: string; EmailAddress: string; SubjectLine: string; DataSource: string; TableName: string)
Parameters
FormFileType
enumeration
Clipboard!
Current!
FormFile!
FormFile
string (optional)
DataFileType
enumeration If this parameter is set to AddressBook!, the DataFile parameter is ignored.
AddressBook!
Clipboard!
DataFile!
NoData!
ODBC!
DataFile
string (optional)
OutputFileType
enumeration
ToCurrentDoc!
ToEMail!
ToFile!
ToNewDoc!
ToPrinter!
OutputFile
string (optional) Merge the output file when OutputFileType parameter is ToFile!.
AddressBook
string (optional) The name of the address book to use as the data source for the merge. This parameter is ignored if the DataFileType parameter is not set to AddressBook! If the Address Book parameter is set to AddressBook! and this parameter is left blank, the currently selected address book records are used as the data source for the merge.
EmailAddress
string (optional)
SubjectLine
string (optional)
DataSource
string (optional)
TableName
string (optional)
MergeSelect
Purpose
Specify the records to merge.
Syntax
MergeSelect (SelectType: enumeration; Begin: numeric; End: numeric)
Parameters
SelectType
enumeration If the data source for the merge is an Address Book, use the All! enumeration.
All!
Marked!
Range!
Begin
numeric (optional) The low end of a range.
End
numeric (optional) The high end of a range.
See Also
MergeMark
MergeTableDataDlg
Purpose
Display the Create Data File dialog box.
Syntax
MergeTableDataDlg ()
MergeTextDataDlg
Purpose
Display the Create Merge File dialog box.
Syntax
MergeTextDataDlg ()
MinusSign
Purpose
Insert a minus sign (hyphen character) at the insertion point.
Syntax
MinusSign ()
MoveModeEnd
Purpose
End the command sequence to move text.
Syntax
MoveModeEnd ()