Filename: string (optional) The filename of the macro.
TemplateName: string (optional) The template containing the macro.
MacroMenuDelete
Syntax
(UpdateBIF: enumeration; {MenuPos: numeric})
Description
Delete a macro from a menu.
Parameters
UpdateBIF: enumeration No!
Yes!
MenuPos: numeric (optional) The menu position.
MacroPause
Syntax
()
Description
Pause a macro until the user presses Enter or selects Pause on the Macro menu.
MacroStatusPrompt
Syntax
(State: enumeration; Prompt: string)
Description
Turn the macro status prompt line on or off.
Parameters
State: enumeration Off!
On!
Prompt: string (optional) The text of the prompt.
MacroTemplatePlay
Syntax
(Location: enumeration; MacroName: string)
Description
Play a macro located on a template.
Parameters
Location: enumeration CurrentTemplate!
DefaultTemplate!
MacroName: string The name of the macro.
MailDlg
Syntax
()
Description
Determine if a mail system is running and start it if necessary. Display the mail view and attach a copy of the active WordPerfect document; or if text was selected, paste it into the message box. If multiple mail systems are available, the highest-priority mail system is used.
MakeItFit
Syntax
(TargetPage: numeric; {Adjust: enumeration})
Description
Shrink or expand a document to fill a specified number of pages.
Parameters
TargetPage: numeric The number of pages to fill.
Adjust: enumeration (optional) FitBottomMargin!
FitFontSize!
FitLeftMargin!
FitLineSpacing!
FitRightMargin!
FitTopMargin!
MakeItFitDlg
Syntax
()
Description
Display the Make It Fit Expert dialog box.
MarginAdjustLeft
Syntax
(AmtToAdjust: measurement)
Description
Move the left margin to the left or right, relative to the current margin setting.
Parameters
AmtToAdjust: measurement (optional) A positive value increases the margin; a negative value decreases it.
MarginAdjustRight
Syntax
(AmtToAdjust: measurement)
Description
Move the right margin to the left or right, relative to the current margin setting.
Parameters
AmtToAdjust: measurement A positive value increases the margin; a negative value decreases it.
MarginBottom
Syntax
(MarginWidth: measurement)
Description
Set the bottom margin.
Parameters
MarginWidth: measurement The amount of space for the bottom margin.
MarginLeft
Syntax
(MarginWidth: measurement)
Description
Set the left margin.
Parameters
MarginWidth: measurement The amount of space for the left margin.
MarginReleaseInsert
Syntax
()
Description
Insert a [Hd Back Tab] code at the insertion point. This moves the margin back one tab.
MarginRight
Syntax
(MarginWidth: measurement)
Description
Set the right margin.
Parameters
MarginWidth: measurement The amount of space for the right margin.
MarginTop
Syntax
(MarginWidth: measurement)
Description
Set the top margin.
Parameters
MarginWidth: measurement The amount of space for the top margin.
MarkCrossRef
Syntax
()
Description
Display the Cross-Reference feature bar.
MarkCrossRefUpdateList
Syntax
(Target: string)
Description
Add a specified target name to the Target name list.
Parameters
Target: string The target name to add to the Target name list.
MarkIndex
Syntax
()
Description
Display the Index feature bar.
MarkIndexUpdateList
Syntax
(Heading: string; SubHeading: string)
Description
Create a reference to a specified heading and subheading in the index.
Parameters
Heading: string The heading for the entry.
SubHeading: string The subheading for the entry.
MarkList
Syntax
()
Description
Display the List feature bar.
MarkListUpdateList
Syntax
(ListName: string)
Description
Update the List feature bar.
Parameters
ListName: string The name of the list.
MarkTableOfAuthorities
Syntax
()
Description
Display the Table of Authorities feature bar.
MarkTableOfContents
Syntax
()
Description
Display the Table of Contents feature bar.
MarkTOAUpdateList
Syntax
(ShortForm: string)
Description
Update the Table of Authorities feature bar.
Parameters
ShortForm: string The list name in a table of authorities.
MasterDocCondense
Syntax
(Filename: string; Action: enumeration)
Description
Condense selected subdocuments and save changes.
Parameters
Filename: string (optional) The filename of the master document.
Action: enumeration SaveSub!
SkipSub!
MasterDocCondenseDlg
Syntax
()
Description
Display the Condense/Save Subdocuments dialog box.
MasterDocExpand
Syntax
(Filename: string)
Description
Expand a subdocument. Specify a subdocument with SubDocInclude.
Parameters
Filename: string (optional) The filename of the master document.
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 WordPerfect SGML program component is installed and the current document is a WordPerfect SGML document.
Parameters
Attribute: string (optional) The font attribute the search text must have.
Value: string (optional) The value of the search text.
Type: enumeration End!
Start!
EditAttribute: enumeration (optional) No!
Yes!
MatchExtendSelection
Syntax
()
Description
In a Find and Replace search, extend the selected text to include matches that are not in the original selection.
Specify that Find and Replace search only in the specified SGML elements. This command is valid only if the WordPerfect SGML program component is installed, and the current document is a WordPerfect SGML document.
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) The SGML element to find.
MatchLimit
Syntax
(State: enumeration; LimitValue: numeric)
Description
Limit a Replace All search to a specified number of occurrences.
Parameters
State: enumeration Limit a Find and Replace search.
No!
Yes!
LimitValue: numeric (optional) The number of occurrences to replace.
MatchPositionAfter
Syntax
()
Description
Place the insertion point after matched text in a Find and Replace search.
MatchPositionBefore
Syntax
()
Description
Place the insertion point before matched text in a Find and Replace search.
MatchSelection
Syntax
()
Description
Select matched text in a Find and Replace search.
MatchSkipIfInElements
Syntax
({Element: string})
Description
Specify that Find and Replace search all of the document except within the specified SGML elements. This command is valid only if the WordPerfect SGML program component is installed and the current document is a WordPerfect SGML document.
Parameters
Element: string (optional) The SGML elements to skip while searching.
MatchWithAttributes
Syntax
(State: enumeration; {Attribute: enumeration})
Description
Match only text with specified attributes in a Find and Replace search.
Hint: string (optional) The text of the tip for the submenu.
Offset: numeric (optional) The position of the submenu on the menu.
boolean:=MenuDeleteItemEx
Syntax
(Menu: string; Name: string; Offset: numeric)
Description
Delete an item from the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: string (optional) The name of the menu item to delete.
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
Syntax
(MenuName: string)
Description
Choose a menu.
Parameters
MenuName: string (optional) The name of the menu bar you want to use. The name of the menu must be enclosed by angle brackets.
MenuSelectDlg
Syntax
()
Description
Display the Menu Bar Preferences dialog box.
MergeAddressBook
Syntax
(AddressBook: string)
Description
Specify an address book to associate with the current form file.
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
Syntax
(OutputFile: string; AddressBook: string)
Description
Save address book records as a merge data file.
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
Syntax
(State: enumeration)
Description
Leave or remove a blank field. If blank fields are removed, the remaining fields shift up one line.
Parameters
State: enumeration Leave!
Remove!
MergeCode
Syntax
(Codes: enumeration; String: string)
Description
Insert a merge code.
Parameters
Codes: enumeration Assign!
AssignLocal!
Beep!
Break!
Call!
CancelOff!
CancelOn!
Caps!
CaseOf!
ChainData!
ChainForm!
ChainMacro!
Char!
Codes!
Comment!
Continue!
CtoN!
Date!
Default!
DisplayStop!
Document!
Else!
EmbedMacro!
EndField!
EndFor!
EndIf!
EndRecord!
EndSwitch!
EndWhile!
Field!
FieldNames!
FirstCap!
ForEach!
ForNext!
GetString!
Go!
If!
IfBlank!
IfExists!
IfNotBlank!
Insert!
Keyboard!
Label!
Look!
MrgCmnd!
NestData!
NestForm!
NestMacro!
Next!
NextRecord!
NtoC!
OnCancel!
OnError!
PageOff!
PageOn!
PostNet!
Print!
ProcessOff!
ProcessOn!
Prompt!
Quit!
RepeatRow!
Return!
ReturnCancel!
ReturnError!
Rewrite!
StatusPrompt!
StepOff!
StepOn!
Stop!
StrLen!
StrPos!
SubstData!
SubstForm!
SubStr!
Switch!
System!
ToLower!
ToUpper!
Variable!
Wait!
While!
String: string (optional) The field parameters.
MergeCodesDisplayEdit
Syntax
(Display: enumeration)
Description
Display or hide merge codes, or display them as markers.
Parameters
Display: enumeration Hide!
Marker!
Show!
MergeCodesDisplayRun
Syntax
(Display: enumeration)
Description
Display or hide merge codes, or display them as markers in a merged document.
Define a condition to select records from a data file.
Parameters
Condition1: string (optional) Searching condition to find a record from a data file.
Condition2: string (optional) Searching condition to find a record from a data file.
Condition3: string (optional) Searching condition to find a record from a data file.
Condition4: string (optional) Searching condition to find a record from a data file.
Condition5: string (optional) Searching condition to find a record from a data file.
Condition6: string (optional) Searching condition to find a record from a data file.
Condition7: string (optional) Searching condition to find a record from a data file.
Condition8: string (optional) Searching condition to find a record from a data file.
Condition9: string (optional) Searching condition to find a record from a data file.
Condition10: string (optional) Searching condition to find a record from a data file.
Condition11: string (optional) Searching condition to find a record from a data file.
Condition12: string (optional) Searching condition to find a record from a data file.
Condition13: string (optional) Searching condition to find a record from a data file.
Condition14: string (optional) Searching condition to find a record from a data file.
Condition15: string (optional) Searching condition to find a record from a data file.
MergeDataFile
Syntax
(DataFile: string)
Description
Specify the data file to associate with a form file.
Parameters
DataFile: string (optional) The filename of the data file.
MergeDlg
Syntax
()
Description
Display the Merge dialog box.
MergeEndField
Syntax
()
Description
Insert an [ENDFIELD] code at the insertion point. Recordable substitute: MergeCode.
MergeEndRecord
Syntax
()
Description
Insert an [ENDRECORD] code at the insertion point. Recordable substitute: MergeCode.
MergeEnvelope
Syntax
(State: enumeration)
Description
Create an envelope for merged records.
Parameters
State: enumeration Off!
On!
MergeEnvelopeDefinitionBegin
Syntax
()
Description
Begin a MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. Contains address information.
MergeEnvelopeDefinitionEnd
Syntax
()
Description
End a merge envelope definition. Precede with MergeEnvelopeDefinitionBegin.
MergeFileAssociate
Syntax
(FormFile: string; DataFile: string)
Description
Associate form and data files. MergeDataFile creates a recordable association.
Parameters
FormFile: string The filename of the form file to associate.
DataFile: string (optional) The filename of the data file to associate.
MergeFileAssociateAddressBook
Syntax
(FormFile: string; AddressBook: string)
Description
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.
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.
FormFile: string (optional) The filename of the form file.
DataFileType: enumeration If this parameter is set to AddressBook!, the DataFile parameter is ignored.
AddressBook!
Clipboard!
DataFile!
NoData!
ODBC!
DataFile: string (optional) The filename of the data file.
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) The e-mail address.