Chapter 3
Corel® WordPerfect® System Variables
G - P
?GraphicSelected
Purpose
Return True if a box is selected, False if not.
Syntax
boolean := ?GraphicSelected ()
?GraphicsLineBottomSpacing
Purpose
Return the amount of space below a graphics line in the active unit of measure.
Syntax
measurement := ?GraphicsLineBottomSpacing ()
See Also
?GraphicsLineTopSpacing, GraphicsLineSpacing
?GraphicsLineColorBlue
Purpose
Return the blue value of a graphics line color.
Syntax
numeric := ?GraphicsLineColorBlue ()
See Also
?GraphicsLineColorGreen, ?GraphicsLineColorRed, ?GraphicsLineColorShading, ?GraphicsLineUseColor, GraphicsLineColor
?GraphicsLineColorGreen
Purpose
Return the green value of a graphics line color.
Syntax
numeric := ?GraphicsLineColorGreen ()
See Also
?GraphicsLineColorBlue, ?GraphicsLineColorRed, ?GraphicsLineColorShading, ?GraphicsLineUseColor, GraphicsLineColor
?GraphicsLineColorRed
Purpose
Return the red value of a graphics line color.
Syntax
numeric := ?GraphicsLineColorRed ()
See Also
?GraphicsLineColorBlue, ?GraphicsLineColorGreen, ?GraphicsLineColorShading, ?GraphicsLineUseColor, GraphicsLineColor
?GraphicsLineColorShading
Purpose
Return the shade of a graphics line color.
Syntax
numeric := ?GraphicsLineColorShading ()
See Also
GraphicsLineColor
?GraphicsLineCount
Purpose
Return the number of graphics lines in the active document.
Syntax
numeric := ?GraphicsLineCount ()
?GraphicsLineHorizontalAlign
Purpose
Return the horizontal alignment of a graphics line.
Syntax
numeric := ?GraphicsLineHorizontalAlign ()
See Also
?GraphicsLineHorizontalPosition, ?GraphicsLineVerticalAlign, GraphicsLineHorizontalPosition
?GraphicsLineHorizontalColumn
Purpose
Return the column number. When the horizontal position of a graphics line is Between Columns, the value is the number of the column to the left of the line.
Syntax
measurement := ?GraphicsLineHorizontalColumn ()
See Also
?GraphicsLineHorizontalPosition, GraphicsLineHorizontalPosition
?GraphicsLineHorizontalPosition
Purpose
Return the horizontal position of a graphics line in WordPerfect units.
Syntax
measurement := ?GraphicsLineHorizontalPosition ()
See Also
?GraphicsLineHorizontalAlign, ?GraphicsLineVerticalPosition, GraphicsLineHorizontalPosition
?GraphicsLineLength
Purpose
Return the length of a graphics line in the current unit of measure.
Syntax
measurement := ?GraphicsLineLength ()
See Also
GraphicsLineLength
?GraphicsLineNum
Purpose
Return the current graphics line number.
Syntax
numeric := ?GraphicsLineNum ()
?GraphicsLineStyle
Purpose
Return the graphics line style.
Syntax
any := ?GraphicsLineStyle ()
See Also
GraphicsLineStyle
?GraphicsLineThickness
Purpose
Return the thickness of a graphics line.
Syntax
any := ?GraphicsLineThickness ()
See Also
GraphicsLineThickness
?GraphicsLineTopSpacing
Purpose
Return the spacing above a graphics line.
Syntax
measurement := ?GraphicsLineTopSpacing ()
See Also
?GraphicsLineBottomSpacing, GraphicsLineSpacing
?GraphicsLineType
Purpose
Return the type of graphics line that is active. The line can be horizontal or vertical.
Syntax
numeric := ?GraphicsLineType ()
See Also
GraphicsLineType
?GraphicsLineUseColor
Purpose
Return whether a current line style color or a different color is used.
Syntax
boolean := ?GraphicsLineUseColor ()
See Also
GraphicsLineColor, GraphicsLineUseColor
?GraphicsLineVerticalAlign
Purpose
Return the vertical alignment of a graphics line.
Syntax
numeric := ?GraphicsLineVerticalAlign ()
See Also
?GraphicsLineHorizontalAlign, ?GraphicsLineVerticalPosition, GraphicsLineVerticalPosition
?GraphicsLineVerticalPosition
Purpose
Return the vertical position of a graphics line.
Syntax
measurement := ?GraphicsLineVerticalPosition ()
See Also
?GraphicsLineHorizontalPosition, ?GraphicsLineVerticalAlign, GraphicsLineVerticalPosition
?HeaderAInParagraph
Purpose
Return whether a Header A code is in the active paragraph.
Syntax
boolean := ?HeaderAInParagraph ()
See Also
?HeaderAOccur, ?HeaderBInParagraph, ?HeaderBOccur, HeaderA
?HeaderAOccur
Purpose
Return the pages on which Header A appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?HeaderAOccur ()
See Also
?HeaderAInParagraph, ?HeaderBInParagraph, ?HeaderBOccur, HeaderA
?HeaderBInParagraph
Purpose
Return whether a Header B code is in the active paragraph.
Syntax
boolean := ?HeaderBInParagraph ()
See Also
?HeaderAInParagraph, ?HeaderAOccur, ?HeaderBOccur, HeaderB
?HeaderBOccur
Purpose
Return the pages on which Header B appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?HeaderBOccur ()
See Also
?HeaderAInParagraph, ?HeaderAOccur, ?HeaderBInParagraph, HeaderB
?HeaderSeparator
Purpose
Return the spacing above a header in WordPerfect units.
Syntax
any := ?HeaderSeparator ()
See Also
HeaderSeparationDistance
?HiddenTextActive
Purpose
Return True if hidden text is active (hidden text is hidden), False if not (hidden text is displayed).
Syntax
boolean := ?HiddenTextActive ()
See Also
HiddenText, HiddenTextShowAll
?HypertextLast
Purpose
Return the filename of a hypertext link source.
Syntax
string := ?HypertextLast ()
See Also
Hypertext, HypertextInfo
?HypertextType
Purpose
Return whether a hypertext link jumps to a bookmark or plays a macro.
Syntax
numeric := ?HypertextType ()
See Also
Hypertext
?Hyphenation
Purpose
Return the hyphenation state.
Syntax
boolean := ?Hyphenation ()
See Also
Hyphenation
?Indent
Purpose
Return the indentation of the active paragraph. Note: A Hanging Indent is simply an Indent followed by a Back Tab (margin release). Therefore, ?Indent returns 1 for paragraphs with hanging indentation.
Syntax
numeric := ?Indent ()
See Also
Indent
?IndexDefinition
Purpose
Return the current index heading style.
Syntax
string := ?IndexDefinition ()
See Also
IndexDefineDlg, IndexDefinition
?Initials
Purpose
Return the initials of the current user. This command is valid only if Corel WordPerfect is running on a network.
Syntax
string := ?Initials ()
?InOutline
Purpose
Return True if the insertion point is in an outline, False if not.
Syntax
boolean := ?InOutline ()
?InTable
Purpose
Return True if the insertion point is in a table, False if not.
Syntax
boolean := ?InTable ()
?InterimVersion
Purpose
Return the interim release number of the current version of Corel WordPerfect. For example, the value assigned to the initial release is 0, and the first interim is 1.
Syntax
numeric := ?InterimVersion ()
?IrregularCap
Purpose
Return True if QuickCorrect checks for irregular capitalization, False if not.
Syntax
boolean := ?IrregularCap ()
See Also
IrregularCap
?Justification
Purpose
Return the current text justification.
Syntax
numeric := ?Justification ()
See Also
?Align, ?CellJustification, Justification
?Kerning
Purpose
Return the state of Automatic Kerning.
Syntax
boolean := ?Kerning ()
See Also
Kerning
?KeyCapsLock
Purpose
Return True if Caps Lock is on, False if not.
Syntax
boolean := ?KeyCapsLock ()
?LabelsToDisplay
Purpose
Return whether label definitions are listed for laser or tractor-feed printers, or both types.
Syntax
numeric := ?LabelsToDisplay ()
See Also
LabelsDefine
?Language
Purpose
Return the Corel WordPerfect code for the active language. For example, U.S. English is US.
Syntax
string := ?Language ()
See Also
Language, LanguageDlg
?LeftChar
Purpose
Return the character immediately to the left of the insertion point.
Syntax
string := ?LeftChar ()
See Also
?RightChar
?LeftCode
Purpose
Return the code to the left of the insertion point.
Syntax
numeric := ?LeftCode ()
See Also
?RightCode
?LeftHyphZone
Purpose
Return the lower limit of a hyphenation zone as a percent of a word.
Syntax
numeric := ?LeftHyphZone ()
See Also
?RightHyphZone
?LeftMarginAdj
Purpose
Return the left margin adjustment for the current paragraph.
Syntax
measurement := ?LeftMarginAdj ()
See Also
?RightMarginAdj, MarginAdjustLeft
?Line
Purpose
Return the vertical position of the insertion point relative to the top of the page.
Syntax
measurement := ?Line ()
?LineHeight
Purpose
Return fixed or automatic line height.
Syntax
numeric := ?LineHeight ()
See Also
LineHeight
?LineNumber
Purpose
Return the first line number of the active document.
Syntax
numeric := ?LineNumber ()
See Also
LineNumbering, LineNumberSet
?LineNumbering
Purpose
Return True if line numbering is on, False if not.
Syntax
boolean := ?LineNumbering ()
See Also
LineNumbering
?LineNumberingInterval
Purpose
Return the interval between numbered lines.
Syntax
numeric := ?LineNumberingInterval ()
See Also
LineNumbering, LineNumberingMethod
?LineNumberMethod
Purpose
Return the line numbering method.
Syntax
numeric := ?LineNumberMethod ()
See Also
LineNumberingMethod
?LineNumCountBlankLines
Purpose
Return True if line numbering counts blank lines, False if not.
Syntax
boolean := ?LineNumCountBlankLines ()
See Also
LineNumbering, LineNumberingMethod
?LineNumNewspaperCols
Purpose
Return True if line numbering numbers newspaper columns, False if not.
Syntax
boolean := ?LineNumNewspaperCols ()
See Also
LineNumbering, LineNumberingMethod
?LineNumPosition
Purpose
Return the line numbering position.
Syntax
measurement := ?LineNumPosition ()
See Also
LineNumbering, LineNumberingMethod
?LineSegmentBlue
Purpose
Return the blue value of a table line segment color.
Syntax
numeric := ?LineSegmentBlue ()
See Also
?LineSegmentGreen, ?LineSegmentRed, ?LineSegmentShading, LineSegmentColor
?LineSegmentCount
Purpose
Return the number of line segments in a line style.
Syntax
numeric := ?LineSegmentCount ()
See Also
LineSegmentCreate
?LineSegmentGreen
Purpose
Return the green value of a line segment color.
Syntax
numeric := ?LineSegmentGreen ()
See Also
?LineSegmentBlue, ?LineSegmentRed, ?LineSegmentShading, LineSegmentColor
?LineSegmentRed
Purpose
Return the red value of a line segment color.
Syntax
numeric := ?LineSegmentRed ()
See Also
?LineSegmentBlue, ?LineSegmentGreen, ?LineSegmentShading, LineSegmentColor
?LineSegmentSetUserData
Purpose
Return the dash length of the active graphics line pattern.
Syntax
any := ?LineSegmentSetUserData ()
See Also
LineSegmentSetUserData
?LineSegmentShading
Purpose
Return the shade of a line segment color.
Syntax
any := ?LineSegmentShading ()
See Also
LineSegmentColor
?LineSegmentSpacing
Purpose
Return the distance between stacked line segments.
Syntax
any := ?LineSegmentSpacing ()
See Also
LineSegmentSpacing
?LineSegmentWidth
Purpose
Return the line segment thickness of the current graphics line pattern.
Syntax
any := ?LineSegmentWidth ()
See Also
LineSegmentWidth
?LineSegmentWPG2Pattern
Purpose
Return the Corel WordPerfect line segment pattern.
Syntax
any := ?LineSegmentWPG2Pattern ()
See Also
LineSegmentSetWPG2
?LineSpacing
Purpose
Return a value representing the distance between lines of text at the insertion point.
Syntax
numeric := ?LineSpacing ()
See Also
LineSpacing
?ListDefinition
Purpose
Return the name of the last list created.
Syntax
string := ?ListDefinition ()
See Also
ListDefinition
?MacroExecute
Purpose
Return True if a macro is playing, False if not.
Syntax
boolean := ?MacroExecute ()
See Also
MacroExecuteQuick
?MacroPlaying
Purpose
Return True if a macro is playing, False if not.
Syntax
boolean := ?MacroPlaying ()
See Also
MacroFilePlay, MacroTemplatePlay
?MacroRecord
Purpose
Return True if a macro is recording, False if not.
Syntax
boolean := ?MacroRecord ()
?MajorVersion
Purpose
Return the major version number of the Corel WordPerfect program you are using.
Syntax
numeric := ?MajorVersion ()
See Also
?MinorVersion
?MarginBottom
Purpose
Return the size of the bottom margin in WordPerfect units.
Syntax
measurement := ?MarginBottom ()
See Also
?MarginLeft, ?MarginRight, ?MarginTop, MarginBottom
?MarginLeft
Purpose
Return the size of the left margin in WordPerfect units.
Syntax
measurement := ?MarginLeft ()
See Also
?MarginBottom, ?MarginRight, ?MarginTop, MarginLeft
?MarginRight
Purpose
Return the size of the right margin in WordPerfect units.
Syntax
measurement := ?MarginRight ()
See Also
?MarginBottom, ?MarginLeft, ?MarginTop, MarginRight
?MarginTop
Purpose
Return the size of the top margin in WordPerfect units.
Syntax
measurement := ?MarginTop ()
See Also
?MarginBottom, ?MarginLeft, ?MarginRight, MarginTop
?MergeDone
Purpose
Return True if a merge executed while the macro is running has finished, False if not.
Syntax
boolean := ?MergeDone ()
?MinorVersion
Purpose
Return the minor version number of the Corel WordPerfect program you are using.
Syntax
numeric := ?MinorVersion ()
See Also
?MajorVersion
?Name
Purpose
Return the active filename.
Syntax
string := ?Name ()
?Network
Purpose
Return True if Corel WordPerfect is running on a network, False if not.
Syntax
boolean := ?Network ()
?NotFound
Purpose
Return True if the object of the last search was not found, False if not.
Syntax
boolean := ?NotFound ()
?NumberOpenDocuments
Purpose
Return the number of open documents.
Syntax
numeric := ?NumberOpenDocuments ()
?ODMAName
Purpose
Return the active ODMA filename.
Syntax
string := ?ODMAName ()
See Also
?ODMAPath
?ODMAPath
Purpose
Return the active ODMA document ID (not including the filename).
Syntax
string := ?ODMAPath ()
See Also
?ODMAName
?Overstrike
Purpose
Return the active overstrike characters.
Syntax
string := ?Overstrike ()
See Also
OverstrikeCreate
?Page
Purpose
Return the active page number.
Syntax
numeric := ?Page ()
See Also
TotalPages
?PageBorder
Purpose
Return whether the active page has a page border. This command does not detect Fancy page borders.
Syntax
any := ?PageBorder ()
See Also
?Border, FancyPageBorderOccur, TextBorderCreate, FancyPageBorderInParagraph
?PageNumberFormat
Purpose
Return the text of the active page numbering format.
Syntax
string := ?PageNumberFormat ()
See Also
PageNumberFormat
?PageNumberingOn
Purpose
Return the state of page numbering.
Syntax
boolean := ?PageNumberingOn ()
See Also
PageNumberingDlg
?PageNumberingValue
Purpose
Return the new page number specified in Page Settings in the Numbering Value dialog box.
Syntax
any := ?PageNumberingValue ()
See Also
PageNumberingDlg
?PageNumberMethod
Purpose
Return the active page numbering method.
Syntax
numeric := ?PageNumberMethod ()
See Also
PageNumberMethod
?PageNumberPosition
Purpose
Return the active page number position.
Syntax
numeric := ?PageNumberPosition ()
See Also
PageNumberPosition
?PageSuppress
Purpose
Return the items suppressed on the current page. If two or more items are suppressed, the value returned is the sum of the items' values.
Syntax
numeric := ?PageSuppress ()
See Also
PageSuppressDlg
?PaperLength
Purpose
Return the current paper length in WordPerfect units of measure.
Syntax
measurement := ?PaperLength ()
See Also
?PaperWidth, PaperSizeAdd, PaperSizeResave, PaperSizeSelect
?PaperSizeType
Purpose
Return the paper type selected in the Paper Size dialog box.
Syntax
numeric := ?PaperSizeType ()
See Also
PaperSizeAdd, PaperSizeResave, PaperSizeSelect
?PaperWidth
Purpose
Return the current paper width in WordPerfect units of measure.
Syntax
measurement := ?PaperWidth ()
See Also
?PaperLength, ?PaperSizeType, PaperSizeAdd, PaperSizeResave, PaperSizeSelect
?ParagraphBorder
Purpose
Return whether the current paragraph has a paragraph border.
Syntax
any := ?ParagraphBorder ()
See Also
?Border, ParagraphBorderDlg, TextBorderCreate
?ParagraphNumber
Purpose
Return the level number of the current outline style. If the program is not in outline mode, the value is 0.
Syntax
any := ?ParagraphNumber ()
See Also
ParagraphNumberDefDlg
?ParagraphNumberMethod
Purpose
Return the paragraph numbering method in the current outline style.
Syntax
any := ?ParagraphNumberMethod ()
See Also
ParagraphNumberDefDlg
?Path
Purpose
Return the current file path without the filename.
Syntax
string := ?Path ()
?PathBackup
Purpose
Return the backup directory as specified in Files Settings.
Syntax
string := ?PathBackup ()
See Also
PrefBackupPath, PrefLocationOfDocuments
?PathCurrent
Purpose
Return the current directory.
Syntax
string := ?PathCurrent ()
?PathDatabase
Purpose
Return the database directory as specified in Files Settings.
Syntax
string := ?PathDatabase ()
See Also
?PathDatabaseSupplemental, PrefLocationOfDocuments
?PathDatabaseSupplemental
Purpose
Return the supplemental database directory as specified in Files Settings.
Syntax
string := ?PathDatabaseSupplemental ()
See Also
?PathDatabase, PrefLocationOfDocuments
?PathDocument
Purpose
Return the documents directory as specified in Files Settings.
Syntax
string := ?PathDocument ()
See Also
PrefLocationOfDocuments
?PathGraphics
Purpose
Return the graphics directory as specified in Files Settings.
Syntax
string := ?PathGraphics ()
See Also
?PathGraphicsSupplemental, PrefLocationOfGraphicsFiles
?PathGraphicsSupplemental
Purpose
Return the supplemental graphics directory as specified in Files Settings.
Syntax
string := ?PathGraphicsSupplemental ()
See Also
?PathGraphics, PrefLocationOfGraphicsFiles
?PathLabels
Purpose
Return the labels directory and filename as specified in Files Settings.
Syntax
string := ?PathLabels ()
See Also
?PathPrinters, PrefLocationOfPrinterFiles
?PathMacros
Purpose
Return the macros directory as specified in Files Settings.
Syntax
string := ?PathMacros ()
See Also
?PathMacrosSupplemental, PrefLocationOfMacroFiles
?PathMacrosSupplemental
Purpose
Return the supplemental macros directory as specified in Files Settings.
Syntax
string := ?PathMacrosSupplemental ()
See Also
?PathMacros, PrefLocationOfMacroFiles
?PathPrinters
Purpose
Return the folder specified for label files in the Files Settings dialog box. Formerly, Corel WordPerfect printer driver files were also stored in this folder.
Syntax
string := ?PathPrinters ()
See Also
?PathLabels, PrefLocationOfPrinterFiles
?PathProgram
Purpose
Return the Corel WordPerfect program directory, where WPWIN8.EXE is located.
Syntax
string := ?PathProgram ()
See Also
PrefLocationDlg
?PathShared
Purpose
Return the Corel WordPerfect PerfectFit directory.
Syntax
string := ?PathShared ()
See Also
PrefLocationDlg
?PathSpreadsheet
Purpose
Return the spreadsheet directory as specified in Files Settings.
Syntax
string := ?PathSpreadsheet ()
See Also
?PathSpreadsheetSupplemental, PrefLocationOfSpreadsheetFiles
?PathSpreadsheetSupplemental
Purpose
Return the supplemental spreadsheet directory as specified in Files Settings.
Syntax
string := ?PathSpreadsheetSupplemental ()
See Also
?PathSpreadsheet, PrefLocationOfSpreadsheetFiles
?PathTemplate
Purpose
Return the template directory as specified in Files Settings.
Syntax
string := ?PathTemplate ()
See Also
?PathTemplateSupplemental, PrefLocationOfTemplates
?PathTemplateSupplemental
Purpose
Return the supplemental template directory as specified in Files Settings.
Syntax
string := ?PathTemplateSupplemental ()
See Also
?PathTemplate, PrefLocationOfTemplates
?PauseKey
Purpose
Return the keystroke specified to resume a paused macro.
Syntax
string := ?PauseKey ()
See Also
MacroPause, PauseKey
?Position
Purpose
Return the horizontal position of the insertion point in WordPerfect units.
Syntax
measurement := ?Position ()
See Also
PosLineBeg, PosLineDown, PosLineEnd, PosLineUp, PosLineVeryBeg, PosLineVeryEnd
?PowerBarActive
Purpose
Return True if the Power Bar is active, False if not.
Syntax
boolean := ?PowerBarActive ()
See Also
PowerBarShow