MacroCommandInserter(State As _MacroCommandInserter_State_enum)
Description
Turn the WordPerfect Macro Command Inserter on or off.
Parameters
State: enumeration Off!
On!
MacroEditControlBar
Syntax
MacroEditControlBar([State As _MacroEditControlBar_State_enum])
Description
Display the Macro Edit feature bar.
Parameters
State: enumeration (optional) Off!
On!
MacroExecuteQuick
Syntax
MacroExecuteQuick()
Description
Playback the current QuickMacro.
MacroFileChain
Syntax
MacroFileChain(Filename As String)
Description
Specify a macro to play upon completion of the current macro.
Parameters
Filename: string The filename of the next macro.
MacroFilePlay
Syntax
MacroFilePlay(Filename As String)
Description
Play a macro.
Parameters
Filename: string The filename of the macro to play.
MacroMenuAdd
Syntax
MacroMenuAdd(UpdateBIF As _MacroMenuAdd_UpdateBIF_enum, MenuPos As Integer, Location As _MacroMenuAdd_Location_enum, [Filename As String], [TemplateName As String])
Description
Add a macro to the macro submenu.
Parameters
UpdateBIF: enumeration No!
Yes!
MenuPos: numeric The menu position.
Location: enumeration CurrentTemplate!
FileOnDisk!
StandardTemplate!
Filename: string (optional) The filename of the macro.
TemplateName: string (optional) The template containing the macro.
MacroMenuDelete
Syntax
MacroMenuDelete(UpdateBIF As _MacroMenuDelete_UpdateBIF_enum, [MenuPos])
Description
Delete a macro from a menu.
Parameters
UpdateBIF: enumeration No!
Yes!
MenuPos: numeric (optional) The menu position.
MacroPause
Syntax
MacroPause()
Description
Pause a macro until the user presses Enter or selects Pause on the Macro menu.
MacroStatusPrompt
Syntax
MacroStatusPrompt(State As _MacroStatusPrompt_State_enum, [Prompt As 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
MacroTemplatePlay(Location As _MacroTemplatePlay_Location_enum, MacroName As String)
Description
Play a macro located on a template.
Parameters
Location: enumeration CurrentTemplate!
DefaultTemplate!
MacroName: string The name of the macro.
MailDlg
Syntax
MailDlg()
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
MakeItFit(TargetPage As Long, [Adjust])
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
MakeItFitDlg()
Description
Display the Make It Fit Expert dialog box.
MarginAdjustLeft
Syntax
MarginAdjustLeft([AmtToAdjust As Integer]) As Integer
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
MarginAdjustRight([AmtToAdjust As Integer]) As Intege
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
MarginBottom([MarginWidth As Integer]) As Integer
Description
Set the bottom margin.
Parameters
MarginWidth: measurement The amount of space for the bottom margin.
MarginLeft
Syntax
MarginLeft([MarginWidth As Integer]) As Integer
Description
Set the left margin.
Parameters
MarginWidth: measurement The amount of space for the left margin.
MarginReleaseInsert
Syntax
MarginReleaseInsert()
Description
Insert a [Hd Back Tab] code at the insertion point. This moves the margin back one tab.
MarginRight
Syntax
MarginRight([MarginWidth As Integer]) As Integer
Description
Set the right margin.
Parameters
MarginWidth: measurement The amount of space for the right margin.
MarginTop
Syntax
MarginTop([MarginWidth As Integer]) As Integer
Description
Set the top margin.
Parameters
MarginWidth: measurement The amount of space for the top margin.
MarkCrossRef
Syntax
MarkCrossRef()
Description
Display the Cross-Reference feature bar.
MarkCrossRefUpdateList
Syntax
MarkCrossRefUpdateList(Target As 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
MarkIndex()
Description
Display the Index feature bar.
MarkIndexUpdateList
Syntax
MarkIndexUpdateList(Heading As String, SubHeading As 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
MarkList()
Description
Display the List feature bar.
MarkListUpdateList
Syntax
MarkListUpdateList(ListName As String)
Description
Update the List feature bar.
Parameters
ListName: string The name of the list.
MarkTableOfAuthorities
Syntax
MarkTableOfAuthorities()
Description
Display the Table of Authorities feature bar.
MarkTableOfContents
Syntax
MarkTableOfContents()
Description
Display the Table of Contents feature bar.
MarkTOAUpdateList
Syntax
MarkTOAUpdateList(ShortForm As String)
Description
Update the Table of Authorities feature bar.
Parameters
ShortForm: string The list name in a table of authorities.
MasterDocCondense
Syntax
MasterDocCondense(Filename As String, Action As _MasterDocCondense_Action_enum)
Description
Condense selected subdocuments and save changes.
Parameters
Filename: string (optional) The filename of the master document.
Action: enumeration SaveSub!
SkipSub!
MasterDocCondenseDlg
Syntax
MasterDocCondenseDlg()
Description
Display the Condense/Save Subdocuments dialog box.
MasterDocExpand
Syntax
MasterDocExpand([Filename As String])
Description
Expand a subdocument. Specify a subdocument with SubDocInclude.
Parameters
Filename: string (optional) The filename of the master document.
MasterDocSubdocDlg
Syntax
MasterDocSubdocDlg()
Description
Display the Include Subdocument dialog box.
MatchElement
Syntax
MatchElement(Attribute As String, Value As String, Type As _MatchElement_Type_enum, [EditAttribute As _MatchElement_EditAttribute_enum])
Description
Specify that Find and Replace finds a tag that meets certain conditions. This method 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 method 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
MatchExtendSelection()
Description
In a Find and Replace search, extend the selected text to include matches that are not in the original selection.
MatchFindIfInElements
Syntax
MatchFindIfInElements(State As _MatchFindIfInElements_State_enum, [Action As _MatchFindIfInElements_Action_enum], [Element])
Description
Specify that Find and Replace search only in the specified SGML elements. This method 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
MatchLimit(State As _MatchLimit_State_enum, [LimitValue As Integer])
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
MatchPositionAfter()
Description
Place the insertion point after matched text in a Find and Replace search.
MatchPositionBefore
Syntax
MatchPositionBefore()
Description
Place the insertion point before matched text in a Find and Replace search.
MatchSelection
Syntax
MatchSelection()
Description
Select matched text in a Find and Replace search.
MatchSkipIfInElements
Syntax
MatchSkipIfInElements([Element])
Description
Specify that Find and Replace search all of the document except within the specified SGML elements. This method 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
MatchWithAttributes(State As _MatchWithAttributes_State_enum, [Attribute])
Description
Match only text with specified attributes in a Find and Replace search.
MatchWithFontSize(State As _MatchWithFontSize_State_enum, [FontSize As Integer])
Description
Match only text with a specified font size in a Find and Replace search.
Parameters
State: enumeration No!
Yes!
FontSize: measurement (optional) The point size of the font.
MenuAddFeature
Syntax
MenuAddFeature(Menu As String, Name As Integer, [Offset As Integer]) As Boolean
Description
Add a feature to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: method name The name of the feature.
Offset: numeric (optional) The position of the feature on the menu.
Note
You can add a feature to a menu using MenuAddFeature() only if the feature does not require parameters.
MenuAddMacro
Syntax
MenuAddMacro(Menu As String, Name As String, MacroName As String, [Hint As String], [Offset As Integer]) As Boolean
Description
Add a macro to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: string The filename of the macro.
MacroName: string The name of the macro.
Hint: string (optional) The text of the tip for the menu item.
Offset: numeric (optional) The position of the macro on the menu.
Example
MenuAddMacro ("HelpMenu", "MyMacro", "C:\Macros\MyMacro.WCM", "This is MyMacro", 1)
MenuAddProgram
Syntax
MenuAddProgram(Menu As String, Name As String, ProgramName As String, [Hint As String], [Offset As Integer]) As Boolean
Description
Add a program to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: string The name of the program.
ProgramName: string The filename of the program's executable.
Hint: string (optional) The text of the tip for the menu item.
Offset: numeric (optional) The position of the program on the menu.
MenuAddScript
Syntax
MenuAddScript(Menu As String, Name As String, Script As String, [Hint As String], [Offset As Integer]) As Boolean
Description
Add a keyboard script to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: string The name of the script.
Script: string The text of the script.
Hint: string (optional) The text of the tip for the menu item.
Offset: numeric (optional) The position of the script on the menu.
MenuAddSeparator
Syntax
MenuAddSeparator(Menu As String, [Offset As Integer]) As Boolean
Description
Add a separator to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Offset: numeric (optional) The position of the separator on the menu.
MenuAddSubMenu
Syntax
MenuAddSubMenu(Menu As String, Name As String, [Hint As String], [Offset As Integer]) As Boolean
Description
Add a submenu to the current WordPerfect menu.
Parameters
Menu: string The name of the menu.
Name: string The name of the submenu.
Hint: string (optional) The text of the tip for the submenu.
Offset: numeric (optional) The position of the submenu on the menu.
MenuDeleteItemEx
Syntax
MenuDeleteItemEx(Menu As String, [Name As String], [Offset As Integer]) As Boolean
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
MenuSelect(MenuName As String, [LoadedFromDefaultTemplate As _MenuSelect_LoadedFromDefaultTemplate_enum])
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
MenuSelectDlg()
Description
Display the Menu Bar Preferences dialog box.
MergeAddressBook
Syntax
MergeAddressBook(AddressBook As 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
MergeAddressBookSaveAs(OutputFile As String, [AddressBook As 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
MergeBlankField(State As _MergeBlankField_State_enum)
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
MergeCode(Codes As _MergeCode_Codes_enum, [String As 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
MergeCodesDisplayEdit(Display As _MergeCodesDisplayEdit_Display_enum)
Description
Display or hide merge codes, or display them as markers.
Parameters
Display: enumeration Hide!
Marker!
Show!
MergeCodesDisplayRun
Syntax
MergeCodesDisplayRun(Display As _MergeCodesDisplayRun_Display_enum)
Description
Display or hide merge codes, or display them as markers in a merged document.
Parameters
Display: enumeration Hide!
Marker!
Show!
MergeCodesDlg
Syntax
MergeCodesDlg()
Description
Display the Insert Merge Codes dialog box.
MergeCondition
Syntax
MergeCondition([Condition1 As String], [Condition2 As String], [Condition3 As String], [Condition4 As String], [Condition5 As String], [Condition6 As String], [Condition7 As String], [Condition8 As String], [Condition9 As String], [Condition10 As String], [Condition11 As String], [Condition12 As String], [Condition13 As String], [Condition14 As String], [Condition15 As String])
Description
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
MergeDataFile([DataFile As String])
Description
Specify the data file to associate with a form file.
Parameters
DataFile: string (optional) The filename of the data file.
MergeDlg
Syntax
MergeDlg()
Description
Display the Merge dialog box.
MergeEndField
Syntax
MergeEndField()
Description
Insert an [ENDFIELD] code at the insertion point. Recordable substitute: MergeCode().
MergeEndRecord
Syntax
MergeEndRecord()
Description
Insert an [ENDRECORD] code at the insertion point. Recordable substitute: MergeCode().
MergeEnvelope
Syntax
MergeEnvelope(State As _MergeEnvelope_State_enum)
Description
Create an envelope for merged records.
Parameters
State: enumeration Off!
On!
MergeEnvelopeDefinitionBegin
Syntax
MergeEnvelopeDefinitionBegin()
Description
Begin a MergeEnvelopeDefinitionBegin-MergeEnvelopeDefinitionEnd statement. Contains address information.
MergeEnvelopeDefinitionEnd
Syntax
MergeEnvelopeDefinitionEnd()
Description
End a merge envelope definition. Precede with MergeEnvelopeDefinitionBegin().
MergeFileAssociate
Syntax
MergeFileAssociate(FormFile As String, [DataFile As 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
MergeFileAssociateAddressBook(FormFile As String, [AddressBook As String])
Description
Associate a form file with an address book data source. This method 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.
MergeFileAssociateODBC
Syntax
MergeFileAssociateODBC(FormFile As String, [DataSource As String], [TableName As String])
Description
Associate a form file with an ODBC data source and table.
Parameters
FormFile: string The filename of the form file.
DataSource: string (optional) The filename of the ODBC data source.
TableName: string (optional) The name of the data table.
MergeFilesDlg
Syntax
MergeFilesDlg()
Description
Display the Perform Merge dialog box.
MergeFileType
Syntax
MergeFileType(FileType As _MergeFileType_FileType_enum)
Description
Specify the file type to merge.
Parameters
FileType: enumeration Form!
None!
TableData!
TextData!
MergeFormDlg
Syntax
MergeFormDlg()
Description
Display the Create Merge File dialog box.
MergeMark
Syntax
MergeMark(RecordNum As Integer)
Description
Mark a record to include in a merge.
Parameters
RecordNum: numeric A record number.
MergeODBC
Syntax
MergeODBC(DataSource As String, TableName As String)
Description
Specify an ODBC data source and table to associate with the current form file.
Parameters
DataSource: string The filename of the ODBC data source.
TableName: string The name of the table in the form file.
MergePageBreak
Syntax
MergePageBreak(State As _MergePageBreak_State_enum)
Description
Separate merged documents with a page break.
Parameters
State: enumeration Off!
On!
MergePrintText
Syntax
MergePrintText()
Description
Print a data file without page breaks between the records.
MergeRepeat
Syntax
MergeRepeat(NumberToRepeat As Integer)
Description
Specify the number of times to merge each record.
Parameters
NumberToRepeat: numeric The number of times to repeat the merge.
MergeRun
Syntax
MergeRun(FormFileType As _MergeRun_FormFileType_enum, FormFile As String, DataFileType As _MergeRun_DataFileType_enum, DataFile As String, OutputFileType As _MergeRun_OutputFileType_enum, [OutputFile As String], [AddressBook As String], [EmailAddress As String], [SubjectLine As String], [DataSource As String], [TableName As String])
Description
Merge a form file and a data file.
Parameters
FormFileType: enumeration Clipboard!
Current!
FormFile!
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.
SubjectLine: string (optional) The subject line.
DataSource: string (optional) The data source.
TableName: string (optional) The table name.
MergeSelect
Syntax
MergeSelect(SelectType As _MergeSelect_SelectType_enum, [Begin As Integer], [End As Integer])
Description
Specify the records to merge.
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.
MergeTableDataDlg
Syntax
MergeTableDataDlg()
Description
Display the Create Data File dialog box.
MergeTextDataDlg
Syntax
MergeTextDataDlg()
Description
Display the Create Merge File dialog box.
MinusSign
Syntax
MinusSign()
Description
Insert a minus sign (hyphen character) at the insertion point.
