Display the Address Book dialog box. You can also pre-select certain options using the parameters. If OK is clicked to dismiss the dialog, the Address Book will remember the currently selected addresses.
Return Value
Returns True if the OK button was clicked to dismiss the dialog, False if not.
AddressBook: string (optional) The name of the address book to view.
DialogTitle: string (optional) Change the text of the title bar.
OKButtonText: string (optional) Change the text of the OK button. Default = OK.
AddressBookFormatAdd
Syntax
(Name: string; Format: string)
Description
Create a custom address format and add it to the list of address formats.
Parameters
Name: string The name of the new custom format.
Format: string The address format string. Data fields are designated by enclosing the field code number in square brackets ([ ]). Use the Codes button on the Macro Bar to insert hard return or tab codes. Although the codes look like bracketed text, they are codes in the text string. For example:
Use AddressBookGetFieldCount, AddressBookGetFieldNumber, and AddressBookGetFieldName to get the names and code numbers of the address book fields.
AddressBookFormatDelete
Syntax
(Name: string)
Description
Delete a custom address format from the list of address formats. System (predefined) address formats cannot be deleted from the address format list.
Parameters
Name: string The name of the custom format to delete.
numeric:=AddressBookFormatGetCount
Syntax
()
Description
Return the number of available address formats.
Address formats can be referenced by index number to return information about the format. See AddressBookFormatGetNameand AddressBookFormatGetFormat. Some address formats are provided with the program (predefined) and cannot be deleted. These formats are indexed from one through the number of formats provided. User-defined address format indexes begin following the predefined formats and are indexed in order of creation. For example, if there are five predefined address formats and four user-defined address formats, the predefined formats would have index numbers ranging from one to five; and the user-defined formats would have index numbers ranging from six to nine in the order which they were created. If a user-defined address format is deleted, the index number of each succeeding format is reduced by one.
Therefore, the address-format index numbers will always be sequential. Also, the index number of a user-defined address format may change if a previously created address format is deleted.
string:=AddressBookFormatGetCurrent
Syntax
(Item: enumeration)
Description
Return the format name or specification of the current address format.
Parameters
Item: enumeration Specify the item to return.
Format!
Name!
string:=AddressBookFormatGetFormat
Syntax
(Index: numeric)
Description
Return the specification of the address format specified in Index.
Parameters
Index: numeric Use AddressBookFormatGetCount to determine the value of this parameter.
string:=AddressBookFormatGetName
Syntax
(Index: numeric)
Description
Return the name of the specified address format.
Parameters
Index: numeric Use AddressBookFormatGetCount to determine the value of this parameter.
numeric:=AddressBookGetCount
Syntax
()
Description
Return the number of available address books.
numeric:=AddressBookGetFieldCount
Syntax
(AddressBook: string)
Description
Return the number of available fields in the specified address book.
Parameters
AddressBook: string The name of the address book to get the field count from.
string:=AddressBookGetFieldName
Syntax
(AddressBook: string; Index: numeric)
Description
Return the name of a specific field in the specified address book.
Parameters
AddressBook: string The name of the address book containing the desired field.
Index: numeric The index number of the desired field.
numeric:=AddressBookGetFieldNumber
Syntax
(AddressBook: string; Index: numeric)
Description
Return the code number of a specific field in the address book specified. The field code number is not the same as the field index number. Field code numbers always remain the same even if other fields are deleted. The table below lists the default system (predefined) data fields and their code numbers. Custom Fields are numbered sequentially in the order they are created beginning at 32768.
Code # Field Name
12289 Name
12290 E-Mail Type
12291 E-Mail Address
12292 Comments
14854 First Name
14856 Business Phone Number
14857 Home Phone Number
14865 Last Name
14870 Organization
14871 Title
14872 Department
14873 Mailstop
14874 Phone Number
14876 Cellular Phone Number
14883 Fax Number
14886 Country
14887 City
14888 State
14889 Address
14890 ZIP Code
24587 Greeting
Parameters
AddressBook: string The name of the address book containing the desired field.
Index: numeric The index number of the desired field.
string:=AddressBookGetName
Syntax
(Index: numeric)
Description
Return the name of the specified address book.
Parameters
Index: numeric The index number of the desired address book.
AddressBookInsertAddr
Syntax
()
Description
Display the Corel Address Book dialog box so you can insert an address.
AddressBookRecordAddField
Syntax
(Field: any; Value: string)
Description
Define a field value in a new address-book record. Repeat for each field value defined. Precede with AddressBookRecordCreate and follow with AddressBookRecordEnd.
Parameters
Field: any The field name or code number.
Value: string The field value.
AddressBookRecordCreate
Syntax
(AddressBook: string)
Description
Create a record in the specified address book. Follow with AddressBookRecordAddField and AddressBookRecordEnd.
Parameters
AddressBook: string The name of the address book where the new record will be added.
AddressBookRecordEnd
Syntax
(State: enumeration; RecordType: enumeration)
Description
End the record creation process and save the new record. Precede with AddressBookRecordCreate and AddressBookRecordAddField.
Parameters
State: enumeration Save the new record to the specified address book or cancel without saving.
Cancel!
Save!
RecordType: enumeration (optional) Specify the type of the new record. Default: Person!
Organization!
Person!
string:=AddressBookSelectionFormatAddr
Syntax
(Format: string; Index: numeric)
Description
Return the address that was last selected in the address book and formats it using the specified address format.
Parameters
Format: string The format specification used to format the specified address. You can use AddressBookFormatGetFormat or AddressBookFormatGetCurrent to retrieve an address format specification.
Index: numeric (optional) The index number of the desired address record relative to the current selection. For example, if six address records were selected and you wanted the second record in the list, you would put 2 in this parameter. If this parameter is not included, the first record in the list will be formatted.
string:=AddressBookSelectionGetField
Syntax
(Field: any; Index: numeric)
Description
Return the value of a field from the last address book record that was selected. Use the Index parameter if the last selection was a multiple-record selection.
Return Value
Returns the value of the specified field.
Parameters
Field: any Specify the field to retrieve. If this parameter is a number, the command will try to locate the field with that code number. If this parameter is a string, the command will try to locate the field with that name.
Index: numeric (optional) Specify the record to retrieve the field information from. Use this parameter when the last address book selection was a multiple-record selection. For example, to return information from the fifth record of a multiple-record selection, set this parameter to 5. If the last selection was a multiple-record selection and this parameter is left blank, the command will return information from the first record in the selection.
AddressMergeShippingMacro
Syntax
()
Description
Play the shipping macro ADRS2MRG.WCM to copy the address book into a merge data file. ADRS2MRG.WCM must be installed.
Advance
Syntax
(Where: enumeration; Amount: measurement)
Description
Move the insertion point a specified distance from the top or left of the page, or from the insertion point.
Parameters
Where: enumeration AdvanceDown!
AdvanceFromLeftEdge!
AdvanceFromTop!
AdvanceLeft!
AdvanceRight!
AdvanceUp!
Down!
Left!
Right!
ToLine!
ToPosition!
Up!
Amount: measurement
AdvanceDlg
Syntax
()
Description
Display the Advance dialog box.
AllFontsShippingMacro
Syntax
()
Description
Play the shipping macro ALLFONTS.WCM to create a list of available fonts for the current printer. ALLFONTS.WCM must be installed.
Append
Syntax
()
Description
Add a copy of the selected text or graphics to the end of the Clipboard contents. If the Clipboard is empty, the macro ends.
AppendToFile
Syntax
(Filename: string)
Description
Add the selected text, or the current document if no text is selected, to the end of another file.
Parameters
Filename: string (optional) The file to append to.
ApplicationBarShow
Syntax
(State: enumeration)
Description
Display (On!) or hide (Off!) the Application Bar. If no parameter is specified, this command toggles the Application Bar display.
Parameters
State: enumeration (optional) Off!
On!
AppMaximize
Syntax
()
Description
Maximize the application window. If the window is already maximized, the macro ends.
AppMinimize
Syntax
()
Description
Minimize the application window to an icon. If the window is already minimized, the macro ends.
AppMove
Syntax
()
Description
Reposition an application window that has been reduced in size. If WordPerfect is maximized, the macro ends or goes to the ONERROR label.
AppRestore
Syntax
()
Description
Restore the application window to its previous size. If WordPerfect is already restored, the macro ends or goes to the ONERROR label.
AppSize
Syntax
()
Description
Resize the current application window. If the window is maximized, the macro ends or goes to the ONERROR label.
AppTaskList
Syntax
()
Description
Activate the Taskbar and display the Start menu.
AssociateDlg
Syntax
()
Description
Display the Associate dialog box, which allows you to assign menus, toolbars, and keyboards to selected features.
AttributeAppearanceOff
Syntax
({Attrib: enumeration})
Description
Turn off the specified attributes at the insertion point. One or more attribute parameters is required.
Parameters
Attrib: enumeration (optional) Bold!
DoubleUnderline!
Every!
Italics!
Outline!
Redline!
Shadow!
SmallCaps!
Strikeout!
Underline!
AttributeAppearanceOn
Syntax
({Attrib: enumeration})
Description
Turn on the specified attributes at the insertion point. One or more parameters is required.
Parameters
Attrib: enumeration (optional) Bold!
DoubleUnderline!
Every!
Italics!
Outline!
Redline!
Shadow!
SmallCaps!
Strikeout!
Underline!
AttributeAppearanceToggle
Syntax
({Attrib: enumeration})
Description
Toggle attributes, usually of the selected text. One or more attribute parameters is required.
Parameters
Attrib: enumeration (optional) Bold!
DoubleUnderline!
Every!
Italics!
Outline!
Redline!
Shadow!
SmallCaps!
Strikeout!
Underline!
AttributeNormal
Syntax
()
Description
Turn off the current font attributes except color. To record, first add an Attribute Normal button to a toolbar or the Power Bar in Preferences.
AttributePosition
Syntax
(Position: enumeration)
Description
Specify subscript or superscript font attributes.
Parameters
Position: enumeration NormalPosition!
Subscript!
Superscript!
AttributePositionToggle
Syntax
(Position: enumeration)
Description
Toggle subscript, normal, and superscript font attributes.
Parameters
Position: enumeration NormalPosition!
Subscript!
Superscript!
AttributeRelativeSize
Syntax
(Size: enumeration)
Description
Specify a relative font size for selected or subsequent text.
Parameters
Size: enumeration ExtraLarge!
Fine!
Large!
NormalSize!
Small!
VeryLarge!
AttributeRelativeSizeToggle
Syntax
(Size: enumeration)
Description
Toggle relative font sizes.
Parameters
Size: enumeration ExtraLarge!
Fine!
Large!
NormalSize!
Small!
VeryLarge!
AttributeSizeRatios
Syntax
(Attrib: enumeration; Percentage: numeric)
Description
Specify relative font size ratios.
Parameters
Attrib: enumeration ExtraLarge!
Fine!
Large!
Small!
SuperSubscript!
VeryLarge!
Percentage: numeric
AutoCodePlacement
Syntax
(State: enumeration)
Description
Turn automatic code placement on or off. Default: Some codes are automatically placed at the beginning of a page or paragraph. When off, all codes are inserted at the insertion point. Not recordable.
Parameters
State: enumeration Off!
On!
AutoScrollOn
Syntax
()
Description
Turns the Autoscroll feature on.
Note
New command
AutoWordSelect
Syntax
(State: enumeration)
Description
Turn Automatically Select Words on or off. Changes the current WordPerfect session only.
