Chapter 3
Corel® WordPerfect® System Variables
Q - Z
?QuickCorrect
Purpose
Return True if QuickCorrect will replace words as you type, False if not.
Syntax
boolean := ?QuickCorrect ()
See Also
QuickCorrect
?Random
Purpose
Return a random number between 0 and 32767.
Syntax
numeric := ?Random ()
?RedlineCharacter
Purpose
Return the ASCII numeric equivalent of the redline character.
Syntax
numeric := ?RedlineCharacter ()
See Also
Char, RedlineCharacter
?RedlineMethod
Purpose
Return the redline method of the current document.
Syntax
numeric := ?RedlineMethod ()
See Also
RedlineMethod
?RevealCodesActive
Purpose
Return True if Reveal Codes is on, False if not.
Syntax
boolean := ?RevealCodesActive ()
See Also
RevealCodes
?RightChar
Purpose
Return the character at the insertion point.
Syntax
string := ?RightChar ()
See Also
?LeftChar
?RightCode
Purpose
Return the numeric equivalent of the code at the insertion point.
Syntax
numeric := ?RightCode ()
See Also
?LeftCode
?RightHyphZone
Purpose
Return the upper limit of a hyphenation zone as a percent of a word.
Syntax
numeric := ?RightHyphZone ()
See Also
?LeftHyphZone
?RightMarginAdj
Purpose
Return the right margin adjustment for the current paragraph in WordPerfect units.
Syntax
measurement := ?RightMarginAdj ()
See Also
?LeftMarginAdj, MarginAdjustRight
?Row
Purpose
Return the current row number in a table.
Syntax
numeric := ?Row ()
See Also
?RowHeader, ?RowHeight
?RowHeader
Purpose
Return whether the current table row is a header row.
Syntax
numeric := ?RowHeader ()
See Also
?Row, ?RowHeight
?RowHeight
Purpose
Return the current table row height in WordPerfect units.
Syntax
measurement := ?RowHeight ()
See Also
?Row, ?RowHeader, TableRowHeight
?RulerBarActive
Purpose
Return True if the Ruler is active, False if not.
Syntax
boolean := ?RulerBarActive ()
See Also
RulerBarShow
?SaveDocumentSummaryOnExit
Purpose
Return True if Create Summary on Save/Exit is active, False if not.
Syntax
boolean := ?SaveDocumentSummaryOnExit ()
See Also
PrefDocSummary
?SaveWorkspace
Purpose
Return the Save Workspace environment preference setting.
Syntax
numeric := ?SaveWorkspace ()
See Also
PrefEnvSettingsDlg
?SecondaryPageNumber
Purpose
Return the current secondary page number.
Syntax
numeric := ?SecondaryPageNumber ()
See Also
SecondaryPageNumber
?SecondaryPageNumberMethod
Purpose
Return the secondary page numbering method.
Syntax
numeric := ?SecondaryPageNumberMethod ()
See Also
SecondaryPageNumberMethod
?SelectedText
Purpose
Return the selected text. Returns an empty string if no text is selected. This command does not type the text, but it can be used to evaluate the text or to assign it to another variable.
Syntax
string := ?SelectedText ()
See Also
?BlockActive, SelectOn
?SelectedTextSize
Purpose
Return the number of bytes in the currently selected text.
Syntax
numeric := ?SelectedTextSize ()
See Also
?BlockActive, SelectOn
?SetQuickmarkOnSave
Purpose
Return True if Set QuickMark on Save is selected, False if not.
Syntax
boolean := ?SetQuickmarkOnSave ()
See Also
QuickmarkSet
?SGMLActive
Purpose
Return True if the current document is an SGML document, False if not.
Syntax
boolean := ?SGMLActive ()
?SGMLAttributePrompt
Purpose
Return a value representing how prompting for attributes is set in the Elements dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
numeric := ?SGMLAttributePrompt ()
?SGMLChaining
Purpose
Return True if chaining is turned on in the Elements dialog box, False if not. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
boolean := ?SGMLChaining ()
?SGMLCurrentLGC
Purpose
Return the path and filename of the current logic filename (.LGC), 0 if none is selected. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
string := ?SGMLCurrentLGC ()
?SGMLCurrentLSI
Purpose
Return the filename of the current layout file (.LSI), 0 if none is selected. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
string := ?SGMLCurrentLSI ()
?SGMLCurrentRootElement
Purpose
Return the name of the current root element, 0 if none is selected. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
string := ?SGMLCurrentRootElement ()
?SGMLDataTypeAllowed
Purpose
Return a value showing the type of data allowed at the insertion point. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
numeric := ?SGMLDataTypeAllowed ()
?SGMLDisplayCodes
Purpose
Return a value representing how the display of codes is set in the SGML Settings dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
numeric := ?SGMLDisplayCodes ()
?SGMLDisplayInclusions
Purpose
Return True if inclusions are shown in a valid element list, False if not (determined by the setting in the Elements dialog box). This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
boolean := ?SGMLDisplayInclusions ()
?SGMLLGCPath
Purpose
Return the path for the default logic files (.LGC), not including the filename. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
string := ?SGMLLGCPath ()
?ShowBoxes
Purpose
Return hidden or displayed box contents.
Syntax
boolean := ?ShowBoxes ()
See Also
ShowBoxes
?SingleSmartQuote
Purpose
Return True if QuickCorrect changes single quotes to single smart quotes, False if not.
Syntax
boolean := ?SingleSmartQuote ()
See Also
SingleSmartQuote
?SingleSpaceInSentence
Purpose
Return True if QuickCorrect changes multiple spaces within sentences to single spaces, False if not.
Syntax
boolean := ?SingleSpaceInSentence ()
See Also
SingleSpaceInSentence
?SortGetAction
Purpose
Return the state of Select Without Sorting.
Syntax
any := ?SortGetAction ()
See Also
?SortGetCase, ?SortGetUndo, SortAction
?SortGetCase
Purpose
Return the state of Uppercase First sorting.
Syntax
any := ?SortGetCase ()
See Also
SortCaseOrder
?SortGetUndo
Purpose
Return the state of Allow Undo sorting.
Syntax
any := ?SortGetUndo ()
See Also
SortUndo
?SpaceExpansion
Purpose
Return the compression limit for word spacing justification.
Syntax
numeric := ?SpaceExpansion ()
See Also
WordSpacingJustificationLimits
?SpacingBelowPar
Purpose
Return the distance between paragraphs. Default: 1.0 (font point size plus 2 points).
Syntax
numeric := ?SpacingBelowPar ()
See Also
ParagraphSpacing
?StartingLineNumber
Purpose
Return the first number to use when numbering lines of text.
Syntax
numeric := ?StartingLineNumber ()
See Also
LineNumberSet
?StatusBarActive
Purpose
Return True if the status bar is active, False if not.
Syntax
boolean := ?StatusBarActive ()
See Also
StatusBarShow
?Substructure
Purpose
Return True if a substructure is active, False if not.
Syntax
boolean := ?Substructure ()
See Also
SubstructureExit
?TableAlternateFill
Purpose
Return the state of Alternating Fill in the current table.
Syntax
numeric := ?TableAlternateFill ()
See Also
TableFill
?TableDefaultLine
Purpose
Return the default line style of the current table.
Syntax
any := ?TableDefaultLine ()
See Also
TableDefaultLine
?TableGuides
Purpose
Return the state of Table Cell Guides display.
Syntax
boolean := ?TableGuides ()
See Also
TableGuides
?TableInTable
Purpose
Return whether the insertion point is in a table.
Syntax
boolean := ?TableInTable ()
See Also
?BetweenTableCodes, TableCreate
?TableLastCell
Purpose
Return whether the current cell is the last cell of a table.
Syntax
boolean := ?TableLastCell ()
?TableSecondFillStyle
Purpose
Return the alternating fill style of a table.
Syntax
any := ?TableSecondFillStyle ()
See Also
TableFill
?TableStyle
Purpose
Return the current table style.
Syntax
any := ?TableStyle ()
See Also
TableStyleName
?TabSettings
Purpose
Return whether tabs are set from the left edge of the paper or relative to the left margin.
Syntax
numeric := ?TabSettings ()
See Also
Tab
?TemplateFile
Purpose
Return the path and filename of the default template.
Syntax
string := ?TemplateFile ()
See Also
TemplateSelect
?TemplateFileSupplemental
Purpose
Return the path and filename of the Additional Objects Template.
Syntax
string := ?TemplateFileSupplemental ()
See Also
TemplateSelect
?TemplateFillCanceled
Purpose
Return True if the last Template Fill was canceled, False if not.
Syntax
boolean := ?TemplateFillCanceled ()
See Also
TemplateFill
?TextColorBlue
Purpose
Return the blue value of the current text color.
Syntax
numeric := ?TextColorBlue ()
See Also
?TextColorGreen, ?TextColorRed, ?TextShade, TextColor
?TextColorGreen
Purpose
Return the green value of the current text color.
Syntax
numeric := ?TextColorGreen ()
See Also
?TextColorBlue, ?TextColorRed, ?TextShade, TextColor
?TextColorRed
Purpose
Return the red value of the current text color.
Syntax
numeric := ?TextColorRed ()
See Also
?TextColorBlue, ?TextColorGreen, ?TextShade, TextColor
?TextColumnNumber
Purpose
Return the number of the current column.
Syntax
numeric := ?TextColumnNumber ()
See Also
?TextColumns
?TextColumns
Purpose
Return the number of columns in the current document.
Syntax
numeric := ?TextColumns ()
See Also
?TextColumnNumber
?TextShade
Purpose
Return the percent of shading for the text.
Syntax
numeric := ?TextShade ()
See Also
TextShade
?ThousandsSeparatorChar
Purpose
Return the character that separates each three digits in numbers equal to or greater than 1,000.
Syntax
string := ?ThousandsSeparatorChar ()
See Also
ThousandsSeparator
?TimeHour
Purpose
Return the current hour on a 24-hour clock.
Syntax
numeric := ?TimeHour ()
See Also
?TimeHundredth, ?TimeMinute, ?TimeSecond
?TimeHundredth
Purpose
Return the current hundredth of a second.
Syntax
numeric := ?TimeHundredth ()
See Also
?TimeHour, ?TimeMinute, ?TimeSecond
?TimeMinute
Purpose
Return the current minute.
Syntax
numeric := ?TimeMinute ()
See Also
?TimeHour, ?TimeHundredth, ?TimeSecond
?TimeSecond
Purpose
Return the current second.
Syntax
numeric := ?TimeSecond ()
See Also
?TimeHour, ?TimeHundredth, ?TimeMinute
?TOADefinition
Purpose
Return the name of the last Table of Authorities section created.
Syntax
string := ?TOADefinition ()
See Also
?TOAShortFormMarks, ?TOAShortForms
?TOAShortFormMarks
Purpose
Return the name of the first short form used.
Syntax
string := ?TOAShortFormMarks ()
See Also
?TOADefinition, ?TOAShortForms
?TOAShortForms
Purpose
Return the name of the last short form used.
Syntax
string := ?TOAShortForms ()
See Also
?TOADefinition, ?TOAShortFormMarks
?TOCDefinition
Purpose
Return the number of levels defined for the table of contents.
Syntax
numeric := ?TOCDefinition ()
See Also
TOCDefine
?TypeoverActive
Purpose
Return True if Typeover is on, False if not.
Syntax
boolean := ?TypeoverActive ()
See Also
Typeover, TypeoverKey
?UndeleteBuffers
Purpose
Return the number of buffers that contain information available to be undeleted.
Syntax
numeric := ?UndeleteBuffers ()
See Also
Undelete, UndeleteDlg
?UnderlineSpaces
Purpose
Return whether blank spaces will be underlined in the active document.
Syntax
boolean := ?UnderlineSpaces ()
See Also
UnderlineSpaces
?UnderlineTabs
Purpose
Return whether tabs will be underlined in the active document.
Syntax
boolean := ?UnderlineTabs ()
See Also
UnderlineTabs
?UnprintableBottomMargin
Purpose
Return the size of the unprintable bottom margin in WordPerfect units.
Syntax
measurement := ?UnprintableBottomMargin ()
See Also
?UnprintableLeftMargin, ?UnprintableRightMargin, ?UnprintableTopMargin
?UnprintableLeftMargin
Purpose
Return the size of the unprintable left margin in WordPerfect units.
Syntax
measurement := ?UnprintableLeftMargin ()
See Also
?UnprintableBottomMargin, ?UnprintableRightMargin, ?UnprintableTopMargin
?UnprintableRightMargin
Purpose
Return the size of the unprintable right margin in WordPerfect units.
Syntax
measurement := ?UnprintableRightMargin ()
See Also
?UnprintableBottomMargin, ?UnprintableLeftMargin, ?UnprintableTopMargin
?UnprintableTopMargin
Purpose
Return the size of the unprintable top margin in WordPerfect units.
Syntax
measurement := ?UnprintableTopMargin ()
See Also
?UnprintableBottomMargin, ?UnprintableLeftMargin, ?UnprintableRightMargin
?UpdateQuickList
Purpose
Return True if Update Favorites with Changes is selected, False if not.
Syntax
boolean := ?UpdateQuickList ()
?UseDefaultDocExt
Purpose
Return True if Use Default Extension on Open and Save is selected in Files Settings, False if not.
Syntax
boolean := ?UseDefaultDocExt ()
?UserColorBlue
Purpose
Return the blue value of the current user-defined color.
Syntax
numeric := ?UserColorBlue ()
See Also
?UserColorGreen, ?UserColorRed
?UserColorGreen
Purpose
Return the green value of the current user-defined color.
Syntax
numeric := ?UserColorGreen ()
See Also
?UserColorBlue, ?UserColorRed
?UserColorRed
Purpose
Return the red value of the current user-defined color.
Syntax
numeric := ?UserColorRed ()
See Also
?UserColorBlue, ?UserColorGreen
?UserInitials
Purpose
Return the user initials specified in Environment Settings.
Syntax
string := ?UserInitials ()
See Also
?UserName
?UserName
Purpose
Return the user name specified in Environment Settings.
Syntax
string := ?UserName ()
See Also
?UserInitials
?VolumeNumber
Purpose
Return the current volume number.
Syntax
numeric := ?VolumeNumber ()
See Also
?VolumeNumberMethod, VolumeNumber
?VolumeNumberMethod
Purpose
Return the current volume numbering method.
Syntax
numeric := ?VolumeNumberMethod ()
See Also
?VolumeNumber, VolumeNumberMethod
?WatermarkAInParagraph
Purpose
Return whether a Watermark A code is in the active paragraph.
Syntax
boolean := ?WatermarkAInParagraph ()
See Also
?WatermarkAOccur, ?WatermarkBInParagraph, ?WatermarkBOccur, WatermarkA
?WatermarkAOccur
Purpose
Return the pages on which Watermark A appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?WatermarkAOccur ()
See Also
?WatermarkAInParagraph, ?WatermarkBInParagraph, ?WatermarkBOccur, WatermarkA
?WatermarkBInParagraph
Purpose
Return whether a Watermark B code is in the active paragraph.
Syntax
boolean := ?WatermarkBInParagraph ()
See Also
?WatermarkAInParagraph, ?WatermarkAOccur, ?WatermarkBOccur, WatermarkB
?WatermarkBOccur
Purpose
Return the pages on which Watermark B appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?WatermarkBOccur ()
See Also
?WatermarkAInParagraph, ?WatermarkAOccur, ?WatermarkBInParagraph, WatermarkB
?WatermarkGraphicShade
Purpose
Return the shading value of the active watermark.
Syntax
numeric := ?WatermarkGraphicShade ()
See Also
WatermarkShadingDlg
?WebBackgroundImage
Purpose
Return the filename (including the path) of the background image of the current web document. Returns 0 if the current document does not have a background image specified.
Syntax
string := ?WebBackgroundImage ()
See Also
WebBackgroundImage
?WebBaseURL
Purpose
Return the base URL specified for the current web document. Returns 0 if no base URL is specified.
Syntax
string := ?WebBaseURL ()
See Also
WebBaseURL
?WebBoxHTMLProperties
Purpose
Return a value representing the HTML properties of the current box. Returns 0 if no box is selected.
Syntax
string := ?WebBoxHTMLProperties ()
See Also
WebBoxHTMLPropertiesDlg, WebBoxHTMLProperties
?WebMetaTags
Purpose
Return the meta information specified for the current web document. Returns 0 if the current web document has no meta information specified or if the current document is not a web document.
Syntax
string := ?WebMetaTags ()
See Also
WebMetaTags
?WebTitle
Purpose
Return the title specified for the current web document. Returns 0 if the title of the current web document is set to the first heading or if the current document is not a web document.
Syntax
any := ?WebTitle ()
See Also
WebTitle
?WidowOrphan
Purpose
Return True if Widow/Orphan is on, False if not.
Syntax
boolean := ?WidowOrphan ()
See Also
WidowOrphan
?WritingToolsDisabledState
Purpose
Return the state of Disable Writing Tools.
Syntax
boolean := ?WritingToolsDisabledState ()
See Also
WritingToolsDisable
?Zoom
Purpose
Return the Zoom percent for the current window.
Syntax
numeric := ?Zoom ()
See Also
ZoomDlg