Insert the current page number at the insertion point.
PageNumberDisplayFormat
Syntax
PageNumberDisplayFormat()
Description
Display a formatted page number at the insertion point in the current document window.
PageNumberFormat
Syntax
PageNumberFormat(Format As String)
Description
Specify a page number format including text, page, total page, chapter, volume, or secondary page numbers.
Parameters
Format: string Combine macro function codes and text to create a page number format.
PageNumberIncrement
Syntax
PageNumberIncrement()
Description
Increase the current page number by one.
PageNumberingAdjustDlg
Syntax
PageNumberingAdjustDlg()
Description
Display the Value/Adjust Number dialog box.
PageNumberingCountDlg
Syntax
PageNumberingCountDlg()
Description
Display the Page Count for Total Pages dialog box. Displaying this dialog box also updates the total page count.
PageNumberingDlg
Syntax
PageNumberingDlg()
Description
Display the Select Page Numbering Format dialog box.
PageNumberingInsertDlg
Syntax
PageNumberingInsertDlg()
Description
Display the Insert Number in Text dialog box.
PageNumberMethod
Syntax
PageNumberMethod(Method As _PageNumberMethod_Method_enum)
Description
Specify a page numbering method.
Parameters
Method: enumeration LowerLetters!
LowerRoman!
Numbers!
UpperLetters!
UpperRoman!
PageNumberPosition
Syntax
PageNumberPosition(Position As _PageNumberPosition_Position_enum, Default As _PageNumberPosition_Default_enum, [Font As String], [FontSize As Integer], [Red As Integer], [Green As Integer], [Blue As Integer], [Shade As Integer], [Attributes])
Description
Specify the position and appearance of page numbering. Use Font, Color, Shade, and Attributes parameters only if the Default parameter is DontUseDefaultValues!.
Parameters
Position: enumeration BottomAlternating!
BottomCenter!
BottomLeft!
BottomRight!
InsideTopAlternating!
None!
OutsideBottomAlternating!
TopAlternating!
TopCenter!
TopLeft!
TopRight!
Default: enumeration DontUseDefaultValues!
UseDefaultValues!
Font: string (optional) The font face for the page number.
FontSize: measurement (optional) The font size for the page number.
Red: numeric (optional) Value: 0-255.
Green: numeric (optional) Value: 0-255.
Blue: numeric (optional) Value: 0-255.
Shade: numeric (optional) Percent: 0-100.
Attributes: enumeration (optional) Bold!
DoubleUnderline!
Every!
ExtraLarge!
Fine!
Italics!
Large!
Outline!
Redline!
Shadow!
Small!
SmallCaps!
Strikeout!
Subscript!
Superscript!
Underline!
VeryLarge!
PageNumberSettingsDlg
Syntax
PageNumberSettingsDlg()
Description
Display the Numbering Value dialog box.
PageSetupDlg
Syntax
PageSetupDlg()
Description
Display the Page Setup dialog box.
PageSuppressDlg
Syntax
PageSuppressDlg()
Description
Display the Suppress dialog box.
PageZoomFull
Syntax
PageZoomFull()
Description
Display Page view, then zoom the current page to Full Page.
PaneNext
Syntax
PaneNext()
Description
Move the focus to the next pane in the Equation Editor.
PanePrevious
Syntax
PanePrevious()
Description
Move the focus to the previous pane in the Equation Editor.
PaperSizeAdd
Syntax
PaperSizeAdd(Name As String, Width As Integer, Length As Integer, WidthAdjust As Integer, LengthAdjust As Integer, Flags As _PaperSizeAdd_Flags_enum, Location As _PaperSizeAdd_Location_enum, Type As _PaperSizeAdd_Type_enum, [Use As _PaperSizeAdd_Use_enum], [ReturnAddressHoriz As Integer], [ReturnAddressVert As Integer], [MailingAddressHoriz As Integer], [MailingAddressVert As Integer])
Description
Create a page definition for the Page Size dialog box. Use address position parameters if the Type parameter is Envelope!.
Parameters
Name: string Use if the Type parameter is Other!.
Width: measurement The width of the page.
Length: measurement The length of the page.
WidthAdjust: measurement Move the page contents left (positive value) or right (negative value).
LengthAdjust: measurement Move the page contents up (positive value) or down (negative value).
Flags: enumeration FormCurrentlyLoaded!
Landscape!
LandscapeLoaded!
LandscapePrimaryLoaded!
Portrait!
PortraitLoaded!
PortraitPrimaryLoaded!
PrimaryForm!
Location: enumeration The printer paper feed.
Continuous!
Manual!
Type: enumeration AllOthers!
Bond!
CardStock!
ClayBased!
Envelope!
Glossy!
Labels!
Letterhead!
Other!
Standard!
Transparency!
Use: enumeration (optional) Europe!
Japan!
Latin_America!
None!
US!
ReturnAddressHoriz: measurement (optional) Left and right position for the return address.
ReturnAddressVert: measurement(optional) Top and bottom position for the return address.
MailingAddressHoriz: measurement(optional) Left and right position for the return address.
MailingAddressVert: measurement(optional) Top and bottom position for the return address.
PaperSizeDelete
Syntax
PaperSizeDelete(Name As String)
Description
Delete a page definition.
Parameters
Name: string The name of the paper definition.
PaperSizeDlg
Syntax
PaperSizeDlg()
Description
Display the Page Size dialog box.
PaperSizeResave
Syntax
PaperSizeResave(OldName As String, NewName As String, Width As Integer, Length As Integer, WidthAdjustment As Integer, LengthAdjustment As Integer, Flags As _PaperSizeResave_Flags_enum, Location As _PaperSizeResave_Location_enum, Type As _PaperSizeResave_Type_enum, Use As _PaperSizeResave_Use_enum, ReturnAddressHoriz As Integer, ReturnAddressVert As Integer, MailingAddressHoriz As Integer, MailingAddressVert As Integer)
Description
Edit and save a page definition from the Page Size dialog box. Use address position parameters if the Type parameter is Envelope!.
Parameters
OldName: string The original name of the page definition.
NewName: string The name for the edited page definition.
Width: measurement The width of the page.
Length: measurement The length of the page.
WidthAdjustment: measurement Move the page contents right (positive value) or left (negative value).
LengthAdjustment: measurement Move the page contents up (positive value) or down (negative value).
Flags: enumeration Specify the orientation.
FormCurrentlyLoaded!
Landscape!
LandscapeLoaded!
LandscapePrimaryLoaded!
Portrait!
PortraitLoaded!
PortraitPrimaryLoaded!
PrimaryForm!
Location: enumeration The printer paper feed.
Continuous!
Manual!
Type: enumeration AllOthers!
Bond!
CardStock!
ClayBased!
Envelope!
Glossy!
Labels!
Letterhead!
Other!
Standard!
Transparency!
Use: enumeration Europe!
Japan!
Latin_America!
None!
US!
ReturnAddressHoriz: measurement The left and right position for the return address.
ReturnAddressVert: measurement The top and bottom position for the return address.
MailingAddressHoriz: measurement The left and right position for the mailing address.
MailingAddressVert: measurement The top and bottom position for the mailing address.
PaperSizeSelect
Syntax
PaperSizeSelect(Name As String, [Width As Integer], [Height As Integer], [Type As _PaperSizeSelect_Type_enum])
Description
Specify a page size for the current document.
Parameters
Name: string The name of a paper definition.
Width: measurement (optional) The width of the page.
Height: measurement (optional) The height of the page.
Type: enumeration (optional) Bond!
Cardstock!
ClayBased!
Envelope!
Glossy!
Labels!
Letterhead!
Other!
Standard!
Transparency!
ParagraphBorderDlg
Syntax
ParagraphBorderDlg()
Description
Display the Paragraph Border/Fill dialog box.
ParagraphBreakShippingMacro
Syntax
ParagraphBreakShippingMacro()
Description
Play the shipping macro PARABRK.WCM to display the Paragraph Breaks dialog box, where graphical paragraph break markers can be edited and selected to insert after the next [HRt]. PARABRK.WCM must be installed.
ParagraphDown
Syntax
ParagraphDown()
Description
Move the insertion point to the beginning of the next paragraph (after [HRt] or [HRt]). Recordable substitute: PosParagraphNext().
ParagraphFormatDlg
Syntax
ParagraphFormatDlg()
Description
Display the Paragraph Format dialog box.
ParagraphHangingIndent
Syntax
ParagraphHangingIndent()
Description
Align the first line of a paragraph with the left margin and indent the remaining lines to the next tab stop.
ParagraphNumberDefDlg
Syntax
ParagraphNumberDefDlg()
Description
Display the Change Outline Level dialog box.
ParagraphSetNumber
Syntax
ParagraphSetNumber(Level As Integer, StartValue As Integer)
Description
Specify the level and starting value for paragraph numbering.
Parameters
Level: numeric The level of paragraph numbering.
StartValue: numeric The start value of paragraph numbering.
ParagraphSpacing
Syntax
ParagraphSpacing(AmtSpc As Double, [DotSpc As Integer])
Description
Lets you specify the spacing between paragraphs. The default spacing is the font point size plus two points.
Parameters
AmtSpc: numeric Default: 1.0.
DotSpc: numeric (optional)
ParagraphUp
Syntax
ParagraphUp()
Description
Move the insertion point to the beginning of the previous paragraph. Recordable substitute: PosParagraphPrevious.
Paste
Syntax
Paste()
Description
Paste the Clipboard contents at the insertion point.
PasteLink
Syntax
PasteLink(FormatName As String, FormatId As Integer, LinkType As _PasteLink_LinkType_enum)
Description
Insert an object from the Clipboard into the current document, thus creating a link with the server application that created the object.
Parameters
FormatName: string The format of the linked object. Consult your server application's documentation for a valid format name.
FormatId: numeric The identification number of the format of the linked object. Consult your server application's documentation for a valid format ID.
LinkType: enumeration Dde!
Ole!
PauseCommand
Syntax
PauseCommand(Token As Integer)
Description
Pause a macro until a specified macro method is executed. For example, Enter executes the HardReturn method. PauseCommand does not prompt the user to press a key, so it is often used with PROMPT.
Parameters
Token: method name The method to pause.
PauseKey
Syntax
PauseKey(Key As _PauseKey_Key_enum, [Character As String])
Description
Pause a macro until a specified key or character is pressed.
Parameters
Key: enumeration The key to resume macro execution. Default: Enter!. Any! resumes when any key is pressed, including Backspace, Delete, and Ctrl+Enter.
Any!
Cancel!
Character!
Close!
Enter!
Character: string (optional) The case-sensitive character that resumes macro execution when pressed. Use if the Key parameter is Character!.
PauseSet
Syntax
PauseSet(Token As Integer)
Description
Specify a method to replace a [HRt] that ends a PAUSE method.
Parameters
Token: method name A method to resume a paused macro. Usually represents a keystroke.
PerfectExpert
Syntax
PerfectExpert([State As _PerfectExpert_State_enum]) As Boolean
Description
Open the User Assistant.
Return Value
True - The User Assistant opened.
False - The User Assistant did not open.
PersonalInfoDlg
Syntax
PersonalInfoDlg() As Boolean
Description
Display the Corel Address Book with the personal information record selected. If the personal information has not been previously specified, the first record in the current address book is selected.
Return Value
Returns True if the Select button was clicked to dismiss the dialog box, False if the Close button was clicked to dismiss the dialog box.
PersonalInfoFormatAddr
Syntax
PersonalInfoFormatAddr(Format As String) As String
Description
Return the personal information stored in the address book using the specified format.
Parameters
Format: string The format specification used when returning the personal information. Use AddressBookFormatGetFormat() or AddressBookFormatGetCurrent() to retrieve an address format specification.
PersonalInfoGetField
Syntax
PersonalInfoGetField(Field) As String
Description
Return the value of a field from the current personal information stored in the address book.
Parameters
Field: any If this parameter is a number, the method will try to return the value of the field with that code number. If this parameter is a string, the method will try to return the value of the field with that name.
PlayClipBoardShippingMacro
Syntax
PlayClipBoardShippingMacro()
Description
Play the shipping macro READCLP.WCM to speak Clipboard text. READCLP.WCM must be installed. ProVoice or Monologue text-to-speech software is required.
PlayFileShippingMacro
Syntax
PlaySelectionShippingMacro()
Description
Play the shipping macro READFILE.WCM to speak a text file or play a .WAV, .AVI, or .MID file. READFILE.WCM must be installed. ProVoice or Monologue text-to-speech software is required.
PlaySelectionShippingMacro
Syntax
PlaySelectionShippingMacro()
Description
Play the shipping macro READSEL.WCM to speak selected text. Not recordable. READSEL.WCM must be installed. ProVoice or Monologue text-to-speech software is required.
PleadingShippingMacro
Syntax
PleadingShippingMacro()
Description
Play the shipping macro PLEADING.WCM to display the Pleading Paper dialog box, in which you specify and generate pleading options. PLEADING.WCM must be installed.
PosBlockBeg
Syntax
PosBlockBeg()
Description
Move the insertion point to the beginning of the selected text, then deselect the text. Included for DOS compatibility. Windows equivalent: PosSelectTop.
PosBlockBottom
Syntax
PosBlockBottom()
Description
Move the insertion point to the bottom of the selected text. Included for DOS compatibility. Windows equivalent: PosSelectBottom().
PosBlockTop
Syntax
PosBlockTop()
Description
Move the insertion point to the top of the selected text. Included for DOS compatibility. Windows equivalent: PosSelectTop().
PosCellDown
Syntax
PosCellDown()
Description
Move the insertion point down one row. Recordable equivalent: PosTableCellDown().
PosCellNext
Syntax
PosCellNext()
Description
Move the insertion point to the beginning of the next cell in the current table. If the insertion point is in the last cell of a table, the insertion point is moved to the beginning of that cell. Recordable equivalent: PosTableTopCellNext().
PosCellPrevious
Syntax
PosCellPrevious()
Description
Move the insertion point to the beginning of the previous cell in the current table. If the insertion point is in the first cell of a table, the insertion point is moved to the beginning of that cell. Recordable equivalent: PosTableCellPrevious().
PosCellUp
Syntax
PosCellUp()
Description
Move the insertion point up one cell. Recordable equivalent: PosTableCellUp().
PosCharacter
Syntax
PosCharacter(CharToMoveTo As String)
Description
Move the insertion point forward to a specified character. Maximum forward movement is 2,000 characters. Case sensitive. If the specified character is not found, this method does nothing.
Parameters
CharToMoveTo: The single search character.
PosCharNext
Syntax
PosCharNext()
Description
Move the insertion point to the next character to the right.
PosCharPrevious
Syntax
PosCharPrevious()
Description
Move the insertion point to the previous character.
PosColBottom
Syntax
PosColBottom()
Description
Move the insertion point to the beginning of the last line before a page break. Move to the end of the document if there is no page break. In columns, move the insertion point to the beginning of the last line of the column. In tables, move to the beginning of the last line of the last cell in the current column that contains data.
PosColFirst
Syntax
PosColFirst()
Description
Move the insertion point to the beginning of the line. In columns, move the insertion point to the beginning of the line in the first column. In tables, no effect.
PosColLast
Syntax
PosColLast()
Description
Move the insertion point to the beginning of the current line. In columns, move the insertion point to the beginning of the current line in the last column. In tables, this method has no effect.
PosColNext
Syntax
PosColNext()
Description
Move the insertion point to the beginning of the current line in the next column or to the current line in the current row of the next table column.
PosColPrevious
Syntax
PosColPrevious()
Description
Move the insertion point to the beginning of the current line in the previous column or to the beginning of the current row and line in the previous table column.
PosColTop
Syntax
PosColTop()
Description
In columns, move the insertion point to the beginning of the current column. In tables, move to the beginning of the current row in the previous column. If there are multiple lines in the current cell, move the insertion point to the beginning of the previous line in the current cell. In regular (non-column) text, move the insertion point to the beginning of the previous line.
PosDocBottom
Syntax
PosDocBottom()
Description
Move the insertion point to the end of the document, after all codes.
PosDocTop
Syntax
PosDocTop()
Description
Move the insertion point to the beginning of the document, after any initial codes.
PosDocVeryTop
Syntax
PosDocVeryTop()
Description
Move the insertion point to the beginning of a document, before any codes.
PosEndnote
Syntax
PosEndnote([EndnoteNumber As Integer])
Description
Moves the insertion point to an endnote.
Parameters
EndnoteNumber: numeric The number of the endnote.
PosFootnote
Syntax
PosFootnote([FootnoteNumber As Integer])
Description
Moves the insertion point to a footnote.
Parameters
FootnoteNumber: The number of the footnote.
PosFunction
Syntax
PosFunction(Function As _PosFunction_Function_enum)
Description
Move the insertion point to the right of the next occurrence of the code specified in the Function parameter.
Parameters
Function: enumeration CancelHyphenation!
HardEndOfLine!
HardHyphen!
HardSpace!
SoftEndOfLine!
Tab!
PosGoPrevious
Syntax
PosGoPrevious()
Description
Move the insertion point to its previous position.
PosGoToDlg
Syntax
PosGoToDlg()
Description
Display the Go To dialog box.
PosHeading
Syntax
PosHeading([HeadingNumber As Integer])
Description
Move the insertion point to a heading.
Parameter
HeadingNumber: numeric The number of the heading.
PosIndex
Syntax
PosIndex()
Description
Move the insertion point to the index.
PosLine
Syntax
PosLine([LineNumber As Integer])
Description
Lets you specify the line number to which to move the insertion point.
Parameter
LineNumber: The line number
PosLineBeg
Syntax
PosLineBeg()
Description
Move the insertion point to the beginning of the current line.
PosLineDown
Syntax
PosLineDown()
Description
Move the insertion point down one line.
PosLineEnd
Syntax
PosLineEnd()
Description
Move the insertion point to the end of the current line.
PosLineUp
Syntax
PosLineUp()
Description
Move the insertion point up one line.
PosLineVeryBeg
Syntax
PosLineVeryBeg()
Description
Move the insertion point to the beginning of a line, before codes.
PosLineVeryEnd
Syntax
PosLineVeryEnd()
Description
Move the insertion point to the end of the current line after codes, except [HRt] and [SRt].
PosNextComment
Syntax
PosNextComment()
Description
Move the insertion point to the next comment.
PosNextEndnote
Syntax
PosNextEndnote()
Description
Move the insertion point to the next endnote.
PosNextFootnote
Syntax
PosNextFootnote()
Description
Move the insertion point to the next footnote.
PosNextHeading
Syntax
PosNextHeading()
Description
Move the insertion point to the next heading.
PosNextTOC
Syntax
PosNextTOC()
Description
Move the insertion point to the next table of contents.
PosNextIndex
Syntax
PosNextIndex()
Description
Move the insertion point to the next index.
PosNextTOA
Syntax
PosNextTOA()
Description
Move the insertion point to the next table of authorities.
PosPage
Syntax
PosPage(Volume As _PosPage_Volume_enum, Chapter As _PosPage_Chapter_enum, Page As _PosPage_Page_enum, [Direction As _PosPage_Direction_enum])
Description
Move the insertion point to a specified page.
Parameters
Volume: enumeration NoneSpecified!
Chapter: enumeration NoneSpecified!
Page: enumeration NoneSpecified!
Direction: enumeration (optional) Down!
Up!
PosPageBottom
Syntax
PosPageBottom()
Description
Move the insertion point to the beginning of the last line on the current page. On the last page of a document, move to the end of the last line.
PosPageNext
Syntax
PosPageNext()
Description
Move the insertion point to the beginning of the next page. On the last page of the document, move to the end.
PosPagePrevious
Syntax
PosPagePrevious()
Description
Move the insertion point to the beginning of the previous page. On the first page of the document, move to the top of the page.
PosPageTop
Syntax
PosPageTop()
Description
Move the insertion point to the beginning of the current page. In columns, move to the beginning of the current column.
PosParagraphNext
Syntax
PosParagraphNext()
Description
Move the insertion point to the beginning of the next paragraph. In the last paragraph of a document, move to the end.
PosParagraphPrevious
Syntax
PosParagraphPrevious()
Description
Move the insertion point to the beginning of the current paragraph. At the beginning of a paragraph, move to the beginning of the previous paragraph.
PosPrevFootnote
Syntax
PosPrevFootnote()
Description
Move the insertion point to the previous endnote.
PosPrevEndnote
Syntax
PosPrevEndnote()
Description
Move the insertion point to the previous endnote.
PosPrevHeading
Syntax
PosPrevHeading()
Description
Move the insertion point to the previous heading.
PosPrevComment
Syntax
PosPrevComment()
Description
Move the insertion point to the previous comment.
PosPrevTOC
Syntax
PosPrevTOC()
Description
Move the insertion point to the previous table of contents.
PosPrevIndex
Syntax
PosPrevIndex()
Description
Move the insertion point to the previous index.
PosPrevTOA
Syntax
PosPrevTOA()
Description
Move the insertion point to the previous table of authorities.
PosScreenDown
Syntax
PosScreenDown()
Description
Move the insertion point to the bottom of the screen, then down one screen at a time with each repetition of the method.
PosScreenLeft
Syntax
PosScreenLeft()
Description
Move the insertion point to the left edge of the screen, then left one screen at a time with each repetition of the method.
PosScreenRight
Syntax
PosScreenRight()
Description
Move the insertion point to the right edge of the screen, then right one screen at a time with each repetition of the method.
PosScreenUp
Syntax
PosScreenUp()
Description
Move the insertion point to the top of the screen, then up one screen at a time with each repetition of the method.
PosSelectBottom
Syntax
PosSelectBottom()
Description
Move the insertion point to the end of the selected text.
PosSelectTop
Syntax
PosSelectTop()
Description
Move the insertion point to the beginning of selected text.
PosTableBegin
Syntax
PosTableBegin()
Description
Move the insertion point to the first cell of a table.
PosTableBlockBeg
Syntax
PosTableBlockBeg()
Description
Deselect all selected table cells except the first cell in the selection.
PosTableCell
Syntax
PosTableCell(Cell As String)
Description
Move the insertion point to a specified cell.
Parameters
Cell: string The cell you want to have the insertion point move to.
PosTableCellBottom
Syntax
PosTableCellBottom()
Description
Move the insertion point to the beginning of the last line in a cell.
PosTableCellDown
Syntax
PosTableCellDown()
Description
Move the insertion point down one table row to the beginning of the first line in the cell.
PosTableCellNext
Syntax
PosTableCellNext()
Description
Move the insertion point to the beginning of the next cell.
PosTableCellPrevious
Syntax
PosTableCellPrevious()
Description
Move the insertion point to the beginning of the previous cell. If there are two or more lines in the current cell but only one line in the previous cell, move to the beginning of the previous cell. If there are one or more lines in both the current and previous cells, move to the beginning of the current line in the previous cell.
PosTableCellTop
Syntax
PosTableCellTop()
Description
Move the insertion point to the beginning of the cell.
PosTableCellUp
Syntax
PosTableCellUp()
Description
Move the insertion point up one table cell.
PosTableColBottom
Syntax
PosTableColBottom()
Description
Move the insertion point to the beginning of the last cell in the current column. If select mode is on, the selection is extended.
PosTableColumnBottom
Syntax
PosTableColumnBottom()
Description
Move the insertion point to the beginning of the last cell in the current column. If select mode is on, select mode is turned off before the insertion point moves.
PosTableColumnTop
Syntax
PosTableColumnTop()
Description
Move the insertion point to the beginning of the table column.
PosTableEnd
Syntax
PosTableEnd()
Description
Move the insertion point to the beginning of the last table cell.
PosTableGoPrevious
Syntax
PosTableGoPrevious()
Description
Return the insertion point to its previous position in a table.
PosTableRowBegin
Syntax
PosTableRowBegin()
Description
Move the insertion point to the beginning of the current row.
PosTableRowEnd
Syntax
PosTableRowEnd()
Description
Move the insertion point to the beginning of the last cell in the row.
PosTableScreenDown
Syntax
PosTableScreenDown()
Description
Move the insertion point to the beginning of the last complete cell of the current column in the current screen, and down one screen with each repetition of the method.
PosTableScreenLeft
Syntax
PosTableScreenLeft()
Description
Move the insertion point to the beginning of the first complete cell in the row, and left one screen at a time with each repetition.
PosTableScreenRight
Syntax
PosTableScreenRight()
Description
Move the insertion point to the beginning of the last complete table cell of the row in the current screen, and right one screen at a time with each repetition.
PosTableScreenUp
Syntax
PosTableScreenUp()
Description
Move the insertion point to the beginning of first table cell of the screen in a table, and up one screen with each repetition.
PosTableTopCellNext
Syntax
PosTableTopCellNext()
Description
Move the insertion point to the beginning of the next cell. If the cells contain two or more lines, move to the beginning of the current line in the next cell. If the insertion point is in the last cell of a table, a new table row is created at the bottom of the table.
PosTableTopCellPrevious
Syntax
PosTableTopCellPrevious()
Description
Move the insertion point to the top of the previous table cell.
PosTOC
Syntax
PosTOC()
Description
Move the insertion point to the table of contents.
PosTOA
Syntax
PosTOA()
Description
Move the insertion point to the table of authorities.
PosWordNext
Syntax
PosWordNext()
Description
Move the insertion point to the beginning of the next word. Words separated by two hyphens or an em dash are treated as one word.
PosWordPrevious
Syntax
PosWordPrevious()
Description
Move the insertion point to the beginning of the previous word. If the insertion point is located within a word, the insertion point is moved to the beginning of the current word. Words separated by two hyphens or an em dash are treated as one word.
PowerBarEditDlg
Syntax
PowerBarEditDlg()
Description
Display the Toolbar Editor - Power Bar dialog box.
PowerBarOptionsDlg
Syntax
PowerBarOptionsDlg()
Description
Display the Power Bar Options dialog box.
PowerBarShow
Syntax
PowerBarShow([State As _PowerBarShow_State_enum])
Description
Display (On!) or hide (Off!) the Power Bar. If no parameter is specified, this method toggles the Power Bar display.
Parameters
State: enumeration (optional) Off!
On!
PowerTableNumericFormat
Syntax
PowerTableNumericFormat()
Description
Change the number format of a cell.
PrefApplicationBarEdit
Syntax
PrefApplicationBarEdit([State As _PrefApplicationBarEdit_State_enum])
Description
Edit the Application Bar by adding or removing items.
Parameters
State: enumeration (optional) Off!
On!
PrefBackupPath
Syntax
PrefBackupPath([BackupDir As String], [UpdateQuickList As _PrefBackupPath_UpdateQuickList_enum])
Description
Specify the document backup directory and whether to update the QuickList.
Parameters
BackupDir: string (optional) The directory where backup files are stored.
UpdateQuickList: enumeration (optional) No!
Yes!
PrefBeep
Syntax
PrefBeep([Error As _PrefBeep_Error_enum], [Hyphenation As _PrefBeep_Hyphenation_enum], [SearchFailure As _PrefBeep_SearchFailure_enum])
Description
Specify when to turn Beep on or off.
Parameters
Error: enumeration (optional) Off!
On!
Hyphenation: enumeration (optional) Off!
On!
SearchFailure: enumeration (optional) Off!
On!
PrefButtonBar
Syntax
PrefButtonBar()
Description
Display the Toolbar Preferences dialog box.
PrefDisplayDlg
Syntax
PrefDisplayDlg()
Description
Display the Display Preferences dialog box.
PrefDisplaySet
Syntax
PrefDisplaySet([DefaultView As _PrefDisplaySet_DefaultView_enum], [ShowTableGridLines As _PrefDisplaySet_ShowTableGridLines_enum], [ShowComments As _PrefDisplaySet_ShowComments_enum], [ShowGraphics As _PrefDisplaySet_ShowGraphics_enum], [TextInSystemColors As _PrefDisplaySet_TextInSystemColors_enum], [ShowHiddenText As _PrefDisplaySet_ShowHiddenText_enum], [SculpturedDialogs As _PrefDisplaySet_SculpturedDialogs_enum], [VerticalScrollBar As _PrefDisplaySet_VerticalScrollBar_enum], [HorizontalScrollBar As _PrefDisplaySet_HorizontalScrollBar_enum], [ShowHotSpots As _PrefDisplaySet_ShowHotSpots_enum], [ShowShadowCursor As _PrefDisplaySet_ShowShadowCursor_enum], [ShowTabBarIcons As _PrefDisplaySet_ShowTabBarIcons_enum], [ShowMarginIcons As _PrefDisplaySet_ShowMarginIcons_enum], [ShowRealWYSBYGI As _PrefDisplaySet_ShowRealWYSBYGI_enum])
Description
Specify how to display features.
Parameters
DefaultView: enumeration (optional) ViewDraft!
ViewPage!
ViewTwoPage!
ShowTableGridLines: enumeration (optional) No!
Yes!
ShowComments: enumeration (optional) No!
Yes!
ShowGraphics: enumeration (optional) No!
Yes!
TextInSystemColors: enumeration (optional) No!
Yes!
ShowHiddenText: enumeration (optional) No!
Yes!
SculpturedDialogs: enumeration (optional) No effect in version 7.
No!
Yes!
VerticalScrollBar: enumeration (optional) No!
Yes!
HorizontalScrollBar: enumeration (optional) Hide!
Show!
ShowHotSpots: enumeration (optional) Set the QuickSpot display state. No effect after version 7.
No!
Yes!
ShowMarginIcons: enumeration (optional) No!
Yes!
ShowRealWYSIWYG: enumeration (optional) No!
Yes!
ShowShadowCursor: enumeration (optional) No!
Yes!
ShowTabBarIcons: enumeration (optional) No!
Yes!
PrefDocSummary
Syntax
PrefDocSummary([SubjectSearchText As String], [DefaultDescriptiveType As String], [CreateOnExit As _PrefDocSummary_CreateOnExit_enum], [UseDescrOnOpen As _PrefDocSummary_UseDescrOnOpen_enum], [MakeFilenameDescrOnSaveAs As _PrefDocSummary_MakeFilenameDescrOnSaveAs_enum])
Description
Specify subject search text and default descriptive type for a document summary, and whether to create the summary automatically when saving a document.
Parameters
SubjectSearchText: string (optional) The text before the subject line.
DefaultDescriptiveType: string (optional) The description of the file type.
Display the Document Summary Preferences dialog box.
PrefEnvironment
Syntax
PrefEnvironment([UserName As String], [UserInitials As String], [UserColorRed As Integer], [UserColorGreen As Integer], [UserColorBlue As Integer], [ConfirmCodeDeletion As _PrefEnvironment_ConfirmCodeDeletion_enum], [ConfirmTableFormulaDeletion As _PrefEnvironment_ConfirmTableFormulaDeletion_enum], [SetQuickMarkOnSave As _PrefEnvironment_SetQuickMarkOnSave_enum], [ActivateHypertext As _PrefEnvironment_ActivateHypertext_enum], [FormatForDefaultPrinter As _PrefEnvironment_FormatForDefaultPrinter_enum], [SaveWorkspace As _PrefEnvironment_SaveWorkspace_enum], [AutoWordSelect As _PrefEnvironment_AutoWordSelect_enum], [GoToQuickMarkOnOpen As _PrefEnvironment_GoToQuickMarkOnOpen_enum], [Use51LetterStyle As _PrefEnvironment_Use51LetterStyle_enum])
SaveWorkSpace: enumeration (optional) Save the current WorkSpace on exit.
Always!
Never!
PromptOnExit!
AutoWordSelect: enumeration (optional) Off!
On!
GoToQuickMarkOnOpen: enumeration (optional) No!
Yes!
Use51LetterStyle: enumeration (optional) No!
Yes!
PrefEnvSettingsDlg
Syntax
PrefEnvSettingsDlg()
Description
Display the Environment Settings dialog box.
PrefHyphenation
Syntax
PrefHyphenation([Prompt As _PrefHyphenation_Prompt_enum])
Description
Turn on Hyphenation and specify prompt conditions.
Parameters
Prompt: enumeration (optional) Always!
Never!
WhenRequired!
PrefImportDlg
Syntax
PrefImportDlg()
Description
Display the Convert Preferences dialog box.
PrefImportOptions
Syntax
PrefImportOptions([FieldDelimiters As String], [RecordDelimiters As String], [StripCharacter As String], [EncapsulationCharacter As String]
Description
Specify how certain characters are interpreted during document imports.
Parameters
FieldDelimiters: string (optional) The delimiters for imported files.
RecordDelimiters: string (optional) The record delimiters for imported files.
StripCharacter: string (optional) The characters to strip out of imported files.
EncapsulationCharacter: string (optional) The encapsulated character for the imported files.
PrefLanguageSet
Syntax
PrefLanguageSet(LanguageCode As String)
Description
Specify a language.
Parameters
LanguageCode: string The interface language.
PrefLiteCodes
Syntax
PrefLiteCodes([Show As _PrefLiteCodes_Show_enum], [Space As _PrefLiteCodes_Space_enum], [HardReturn As _PrefLiteCodes_HardReturn_enum], [Tab As _PrefLiteCodes_Tab_enum], [Indent As _PrefLiteCodes_Indent_enum], [SoftHyphen As _PrefLiteCodes_SoftHyphen_enum], [Advance As _PrefLiteCodes_Advance_enum], [Center As _PrefLiteCodes_Center_enum], [CenterPage As _PrefLiteCodes_CenterPage_enum], [FlushRight As _PrefLiteCodes_FlushRight_enum])
Description
Display document symbols in new and current document windows.
PrefLocationOfDocuments([Path As String], [UseDefExt As _PrefLocationOfDocuments_UseDefExt_enum], [DefExt As String], [UpdateQuickList As _PrefLocationOfDocuments_UpdateQuickList_enum], [DefFormat As String], [UseExplorerStyleFileDialogs As _PrefLocationOfDocuments_UseExplorerStyleFileDialogs_enum], [UseOrigFileFormat As _PrefLocationOfDocuments_UseOrigFileFormat_enum], [UseODMAIntegration As _PrefLocationOfDocuments_UseODMAIntegration_enum])
Description
Specify the location of document and backup files and the default file format.
Parameters
Path: string (optional) The directory for the backup files.
UseDefExt: enumeration (optional) Use the default extension on Open and Save.
No!
Yes!
DefExt: string (optional) The default filename extension.
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
DefFormat: string (optional) The default document file format.
PrefLocationOfGraphicsFiles([GraphicsDir As String], [GraphicsSupplDir As String], [UpdateQuickList As _PrefLocationOfGraphicsFiles_UpdateQuickList_enum], [GraphicsFancyBordersDir As String])
Description
Specify the location of graphics files.
Parameters
GraphicsDir: string (optional) The directory for graphics files
GraphicsSupplDir: string (optional) The directory for supplemental graphics..
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
GraphicsFancyBordersDir: string (optional) The directory for fancy border files.
PrefLocationOfMacroFiles
Syntax
PrefLocationOfMacroFiles([MacroDir As String], [MacroSupplDir As String], [UpdateQuickList As _PrefLocationOfMacroFiles_UpdateQuickList_enum])
Description
Specify the location of macro files.
Parameters
MacroDir: string (optional) The directory for macros files.
MacroSupplDir: string (optional) The macro supplemental directory.
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
PrefLocationOfPrinterFiles
Syntax
PrefLocationOfPrinterFiles([PrinterDir As String], [PrinterSupplDir As String], [LabelFile As String], [LabelsDisplay As _PrefLocationOfPrinterFiles_LabelsDisplay_enum], [UpdateQuickList As _PrefLocationOfPrinterFiles_UpdateQuickList_enum])
Description
Specify the location of label files and set related options.
Parameters
PrinterDir: string (optional) Formerly, the Printer directory was used to store WordPerfect printer driver and label files. WordPerfect printer driver files were not used in WordPerfect 8 and 7. Therefore, this directory is used for label files only.
PrinterSupplDir: string (optional) This parameter is obsolete.
LabelFile: string (optional) The label filename, including the full path.
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
PrefLocationOfSpreadsheetFiles
Syntax
PrefLocationOfSpreadsheetFiles([SpreadsheetDir As String], [SpreadsheetSupplDir As String], [DatabaseDir As String], [DatabaseSupplDir As String], [UpdateQuickList As _PrefLocationOfSpreadsheetFiles_UpdateQuickList_enum])
Description
Specify the location of spreadsheet and database files.
Parameters
SpreadsheetDir: string (optional) The directory for spreadsheet files.
SpreadsheetSupplDir: string (optional) The supplemental spreadsheet directory.
DatabaseDir: string (optional) The directory for database files.
DatabaseSupplDir: string (optional) The supplemental database directory.
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
PrefLocationOfTemplates
Syntax
PrefLocationOfTemplates([TemplateDir As String], [TemplateSupplPath As String], [File As String], [SupplFile As String], [DefExt As String], [UpdateQuickList As _PrefLocationOfTemplates_UpdateQuickList_enum], [UpdateDefaultTemplate As _PrefLocationOfTemplates_UpdateDefaultTemplate_enum])
Description
Specify the location of template files.
Parameters
TemplateDir: string (optional) The directory for template files.
TemplateSupplPath: string (optional) The supplemental directory.
File: string (optional) The templates filename.
SupplFile: string (optional) The supplemental filename.
DefExt: string (optional) The default filename extension.
UpdateQuickList: enumeration (optional) Update the QuickList with changes.
No!
Yes!
UpdateDefaultTemplate: enumeration (optional) No!
Yes!
PrefMenu
Syntax
PrefMenu([DisplayShortcuts As _PrefMenu_DisplayShortcuts_enum], [DisplayLastOpened As _PrefMenu_DisplayLastOpened_enum], [DisplayHelpPrompts As _PrefMenu_DisplayHelpPrompts_enum])
Description
Display QuickTips, shortcut keys next to menu items, and the most recently opened documents at the bottom of the File menu.
Parameters
DisplayShortcuts: enumeration (optional) No!
Yes!
DisplayLastOpened: enumeration (optional) No!
Yes!
DisplayHelpPrompts: enumeration (optional) No!
Yes!
PrefMergeCodes
Syntax
PrefMergeCodes(Show As _PrefMergeCodes_Show_enum)
Description
Change how merge codes appear in the document.
Parameters
Show: enumeration Hide!
Show!
ShowAsBars!
ShowAsMarkers!
PrefMergeExtensions
Syntax
PrefMergeExtensions([UseDefaultFormExt As _PrefMergeExtensions_UseDefaultFormExt_enum], [FormFileExt As String], [UseDefaultDataExt As _PrefMergeExtensions_UseDefaultDataExt_enum], [DataFileExt As String])
Description
Specify merge form and data file extension options.
Parameters
UseDefaultFormExt: enumeration (optional) No!
Yes!
FormFileExt: string (optional) The extension for form files.
UseDefaultDataExt: enumeration (optional) No!
Yes!
DataFileExt: string (optional) The extension for data files.
PrefMetafileOptions
Syntax
PrefMetafileOptions(State As _PrefMetafileOptions_State_enum)
Description
Specify what format to use for imported graphics files.
Parameters
State: enumeration Convert to WordPerfect (.WPG) format, retain both formats, or retain Metafile (.WMF) format.
ConvertToWPG!
RetainWindowsAndWPG!
RetainWindowsFormat!
PrefPowerBar
Syntax
PrefPowerBar([Font As String], [Size As Integer], [Style As _PrefPowerBar_Style_enum], [ShowQuickTips As _PrefPowerBar_ShowQuickTips_enum])
Description
Specify how the Power Bar looks.
Parameters
Font: string (optional) The font face.
Size: numeric (optional) The font size.
Style: enumeration (optional) A button style.
Picture!
PictureAndText!
Text!
ShowQuickTips: enumeration (optional) No!
Yes!
PrefPowerBarEdit
Syntax
PrefPowerBarEdit([Action As _PrefPowerBarEdit_Action_enum])
Description
Open and close the Power Bar Preferences dialog box.
Parameters
Action: enumeration (optional) Enter!
Exit!
PrefPrintEnvironment
Syntax
PrefPrintEnvironment(FormatForDefaultPrinter As _PrefPrintEnvironment_FormatForDefaultPrinter_enum)
Description
Turn on or off Reformat documents for the WordPerfect default printer on open.
Parameters
FormatForDefaultPrinter: enumeration No!
Yes!
PrefPrintRedline
Syntax
PrefPrintRedline([Method As _PrefPrintRedline_Method_enum], [Character As String])
Description
Specify the default method and character of redlined text for new documents. Follow this method with PrefSave to save the setting for future WordPerfect sessions. Use RedlineMethod() and RedlineCharacter() to change the redline method and/or character of the current document.
Parameters
Method: enumeration (optional) Accept the printer setting, or specify a column of characters down the right, left, or alternating sides of redlined text.
Alternating!
Left!
PrinterDependent!
Right!
Character: string (optional) The character to display down the side of redlined text. Omit if Method parameter is PrinterDependent!.
PrefPrintSizeRatio
Syntax
PrefPrintSizeRatio([Fine As Integer], [Small As Integer], [Large As Integer], [VeryLarge As Integer], [ExtraLarge As Integer], [SuperSubscript As Integer])
Description
Specify the size for each font attribute as a percent of the selected font size.
Parameters
Fine: numeric (optional) Value: 1-100.
Small: numeric (optional) Value: 1-100.
Large: numeric (optional) Value: 1-100.
VeryLarge: numeric (optional) Value: 1-100.
ExtraLarge: numeric (optional) Value: 1-100.
SuperSubscript: numeric (optional) Value: 1-100.
PrefRevealCodes
Syntax
PrefRevealCodes([FontFace As String], [FontSize As Integer], [WindowSize As Integer], [ShowOnNew As _PrefRevealCodes_ShowOnNew_enum], [ShowSpacesAsBullets As _PrefRevealCodes_ShowSpacesAsBullets_enum], [WrapAtWindow As _PrefRevealCodes_WrapAtWindow_enum], [ShowInDetail As _PrefRevealCodes_ShowInDetail_enum], [Sculptured As _PrefRevealCodes_Sculptured_enum], [ForeColorRed As Integer], [ForeColorGreen As Integer], [ForeColorBlue As Integer], [BackColorRed As Integer], [BackColorGreen As Integer], [BackColorBlue As Integer], [ShowHelpPrompts As _PrefRevealCodes_ShowHelpPrompts_enum], [UseSystemColors As _PrefRevealCodes_UseSystemColors_enum])
Description
Specify Reveal Code settings.
Parameters
FontFace: string (optional) The font face for reveal codes.
FontSize: numeric (optional) The font size for reveal codes.
WindowSize: numeric (optional) A percent of the screen.
ShowOnNew: enumeration (optional) Display the codes in current and new documents.
No!
Yes!
ShowSpacesAsBullets: enumeration (optional) No!
Yes!
WrapAtWindow: enumeration (optional) Wrap the lines at the window edge.
No!
Yes!
ShowInDetail: enumeration (optional) No!
Yes!
Sculptured: enumeration (optional) No!
Yes!
ForeColorRed: numeric (optional) Value: 0-255.
ForeColorGreen: numeric (optional) Value: 0-255.
ForeColorBlue: numeric (optional) Value: 0-255.
BackColorRed: numeric (optional) Value: 0-255.
BackColorGreen: numeric (optional) Value: 0-255.
BackColorBlue: numeric (optional) Value: 0-255.
ShowHelpPrompts: enumeration (optional) No!
Yes!
UseSystemColors: enumeration (optional) No!
Yes!
PrefRevealCodesDlg
Syntax
PrefRevealCodesDlg()
Description
Display the Display Preferences dialog box with Reveal Codes selected.
PrefRuler
Syntax
PrefRuler([RulerOnNew As _PrefRuler_RulerOnNew_enum], [TabsToGrid As _PrefRuler_TabsToGrid_enum], [ShowRulerGuides As _PrefRuler_ShowRulerGuides_enum])
Description
Specify how the Ruler looks.
Parameters
RulerOnNew: enumeration (optional) No!
Yes!
TabsToGrid: enumeration (optional) Tabs "snap" to invisible grid lines every 1/16th of an inch or 1/5th of a centimeter.
No!
Yes!
ShowRulerGuides: enumeration (optional) Display a Ruler Bar guide when tab stops move.
No!
Yes!
SculpturedRuler: enumeration (optional) No!
Yes!
PrefSave
Syntax
PrefSave()
Description
Save preference method changes as defaults for future sessions.
PrefStatusBarEdit
Syntax
PrefStatusBarEdit([State As _PrefStatusBarEdit_State_enum])
Description
Edit the default Application Bar. Precede with PrefStatusBar(). Default: toggle.
Parameters
State: enumeration (optional) Off!
On!
PrefStatusBarOptions
Syntax
PrefStatusBarOptions([FontFace As String], [FontSize As Integer], [Bold As _PrefStatusBarOptions_Bold_enum], [BoxStyle As _PrefStatusBarOptions_BoxStyle_enum], [EvenSpaced As _PrefStatusBarOptions_EvenSpaced_enum])
Description
Specify the size and font of the Application Bar text.
Parameters
FontFace: string (optional) The font face for the Application Bar.
FontSize: numeric (optional) The font size for the Application Bar.
Bold: enumeration (optional) Bold status bar font.
No!
Yes!
BoxStyle: enumeration (optional) Flat!
Inset!
Raised!
EvenSpaced: enumeration (optional) Space items evenly.
No!
Yes!
PrefStatusBarOptionsDlg
Syntax
PrefStatusBarOptionsDlg()
Description
Display the Application Bar Options dialog box.
PrefTaskBar
Syntax
PrefTaskBar([Box], [TextOrIcon], [Width])
Description
Specify the items for the Application Bar, and their position and width.
Parameters
Box: enumeration (optional) AlignChar!
CapsLockState!
CombinedAbsPosition!
CombinedPosition!
CurrentTag!
Date!
Font!
GeneralStatus!
InsertMode!
Keyboard!
LGCName!
NumLockState!
Printer!
ScrollLockState!
Select!
Time!
Zoom!
TextOrIcon: numeric (optional) The display type of the items on the Application Bar.
Width: numeric (optional) The width of the items on the Application Bar.
PrefTOA
Syntax
PrefTOA([Underlining As _PrefTOA_Underlining_enum], [Runs As _PrefTOA_Runs_enum])
Description
Specify a table of authorities format.
Parameters
Underlining: enumeration (optional) Allow underlining in the full form.
Allowed!
NotAllowed!
Runs: enumeration (optional) Allowed!
NotAllowed!
PrefUnitsOfMeasure
Syntax
PrefUnitsOfMeasure([DisplayUnits As _PrefUnitsOfMeasure_DisplayUnits_enum], [StatusBarUnits As _PrefUnitsOfMeasure_StatusBarUnits_enum])
Description
Specify the unit-of-measure settings.
Parameters
DisplayUnits: enumeration (optional) Centimeters!
InchesI!
InchesQuote!
Millimeter!
Point!
Wpu!
StatusBarUnits: enumeration (optional) The unit of measure for the Application Bar and Ruler.
Centimeters!
InchesI!
InchesQuote!
Millimeter!
Point!
Wpu!
PrefZoom
Syntax
PrefZoom(Type As _PrefZoom_Type_enum, [Percent As Integer])
