Chapter 3
Corel® WordPerfect® System Variables
C - F
?CapBeginSentence
Purpose
Return True if the QuickCorrect Capitalize first letter option is on, False if not.
Syntax
boolean := ?CapBeginSentence ()
See Also
CapBeginSentence, QuickCorrectCapsFixSet, QuickCorrectCapsFixQry
?Cell
Purpose
Return the current table cell number. For example, if the insertion point is in the first cell of a table, this variable contains the value A1.
Syntax
string := ?Cell ()
See Also
TableCellNumberFormat
?CellAlignment
Purpose
Return the vertical alignment of the current cell.
Syntax
numeric := ?CellAlignment ()
See Also
TableCellVerticalAlignment
?CellBold
Purpose
Return True if the cell font attribute is Bold, False if not.
Syntax
boolean := ?CellBold ()
See Also
BoldKey, TableCellAttributeOff, TableCellAttributeOn
?CellDoubleUnderline
Purpose
Return True if the cell font attribute is Double Underline, False if not.
Syntax
boolean := ?CellDoubleUnderline ()
See Also
FontDoubleUnderlineToggle, TableCellAttributeOff, TableCellAttributeOn
?CellExtraLarge
Purpose
Return True if the cell font size is Extra Large, False if not.
Syntax
boolean := ?CellExtraLarge ()
See Also
FontExtraLargeToggle, TableCellAttributeOff, TableColumnAttributeOn
?CellFill
Purpose
Return the fill style of the current cell.
Syntax
any := ?CellFill ()
See Also
TableCellFillStyle
?CellFine
Purpose
Return True if the cell font size is Fine, False if not.
Syntax
boolean := ?CellFine ()
See Also
FontFineToggle, TableCellAttributeOff, TableCellAttributeOn
?CellFormula
Purpose
Return True if the cell contains a formula, False if not.
Syntax
boolean := ?CellFormula ()
See Also
TableFormula
?CellIgnoreWhenCalculating
Purpose
Return True if the option to ignore the current cell or selected cells when calculating formulas is on, False if not.
Syntax
boolean := ?CellIgnoreWhenCalculating ()
See Also
TableFormula
?CellItalics
Purpose
Return True if the cell font attribute is Italics, False if not.
Syntax
boolean := ?CellItalics ()
See Also
FontItalicToggle, TableCellAttributeOff, TableCellAttributeOn
?CellJustification
Purpose
Return the justification of the current cell. Return 0 if the insertion point is not in a table cell.
Syntax
numeric := ?CellJustification ()
See Also
?CellSpecificJustification, ?Justification, TableCellJustification
?CellLarge
Purpose
Return True if the cell font size is Large, False if not.
Syntax
boolean := ?CellLarge ()
See Also
FontLargeToggle, TableCellAttributeOff, TableCellAttributeOn
?CellLocked
Purpose
Return True if the current cell is locked, False if not.
Syntax
boolean := ?CellLocked ()
See Also
TableCellLock
?CellNormal
Purpose
Return True if the cell font size is Normal (meaning there are no specified attributes), False if not.
Syntax
boolean := ?CellNormal ()
See Also
Font, TableCellAttributeOff, TableCellAttributeOn
?CellOutline
Purpose
Return True if the cell font attribute is Outline, False if not.
Syntax
boolean := ?CellOutline ()
See Also
FontOutlineToggle, TableCellAttributeOff, TableCellAttributeOn
?CellRedline
Purpose
Return True if the cell font attribute is Redline, False if not.
Syntax
boolean := ?CellRedline ()
See Also
FontRedlineToggle, TableCellAttributeOff, TableColumnAttributeOn
?CellShadow
Purpose
Return True if the cell font attribute is Shadow, False if not.
Syntax
boolean := ?CellShadow ()
See Also
FontShadowToggle, TableCellAttributeOff, TableCellAttributeOn
?CellSmall
Purpose
Return True if the cell font attribute is Small, False if not.
Syntax
boolean := ?CellSmall ()
See Also
FontSmallToggle, TableCellAttributeOff, TableCellAttributeOn
?CellSmallCaps
Purpose
Return True if the cell font attribute is Small Caps, False if not.
Syntax
boolean := ?CellSmallCaps ()
See Also
FontSmallCapsToggle, TableCellAttributeOff, TableCellAttributeOn
?CellSpecificAttribute
Purpose
Return whether the current cell contains cell-specific attributes.
Syntax
numeric := ?CellSpecificAttribute ()
See Also
TableCellAttributeOff, TableCellAttributeOn
?CellSpecificJustification
Purpose
Return the state of cell justification in the current cell.
Syntax
numeric := ?CellSpecificJustification ()
See Also
?CellJustification, TableCellJustification
?CellStrikeout
Purpose
Return True if the cell font attribute is Strikeout, False if not.
Syntax
boolean := ?CellStrikeout ()
See Also
FontStrikeoutToggle, TableCellAttributeOff, TableCellAttributeOn
?CellSubscript
Purpose
Return True if the cell font attribute is Subscript, False if not.
Syntax
boolean := ?CellSubscript ()
See Also
FontSubscriptToggle, TableCellAttributeOff, TableCellAttributeOn
?CellSuperscript
Purpose
Return True if the cell font attribute is Superscript, False if not.
Syntax
boolean := ?CellSuperscript ()
See Also
FontSuperscriptToggle, TableCellAttributeOff, TableCellAttributeOn
?CellUnderline
Purpose
Return True if the cell font attribute is Underline, False if not.
Syntax
boolean := ?CellUnderline ()
See Also
FontUnderlineToggle, TableCellAttributeOff, TableCellAttributeOn
?CellVeryLarge
Purpose
Return True if the cell font attribute is Very Large, False if not.
Syntax
boolean := ?CellVeryLarge ()
See Also
FontVeryLargeToggle, TableCellAttributeOff, TableCellAttributeOn
?CellWidth
Purpose
Return the width of the current table cell in WordPerfect units.
Syntax
measurement := ?CellWidth ()
?CenterCurrentPage
Purpose
Return True if the contents of the current page only are centered vertically, False if not.
Syntax
boolean := ?CenterCurrentPage ()
See Also
CenterCurrentPage, CenterPageDlg
?CenterPages
Purpose
Return True if the contents of the current page are centered vertically by means of the Current and subsequent pages setting in the Center Page(s) dialog box, False if not.
Syntax
boolean := ?CenterPages ()
See Also
CenterPageDlg, CenterPages
?ChapterNumber
Purpose
Return the current chapter number.
Syntax
numeric := ?ChapterNumber ()
See Also
?ChapterNumberMethod, ChapterNumber
?ChapterNumberMethod
Purpose
Return current chapter numbering method.
Syntax
numeric := ?ChapterNumberMethod ()
See Also
?ChapterNumber, ChapterNumberMethod
?CharSpaceWidth
Purpose
Return the distance between letters.
Syntax
numeric := ?CharSpaceWidth ()
?CleanUpSpaces
Purpose
Return True if Cut and Paste Cleanup is on, False if not.
Syntax
boolean := ?CleanUpSpaces ()
See Also
CleanUpSpaces
?Column
Purpose
Return the number of the current text column or table column.
Syntax
numeric := ?Column ()
?ColumnBorder
Purpose
Return whether the current column setting includes a border.
Syntax
any := ?ColumnBorder ()
See Also
?Border, ColumnBorderDlg, TextBorderCreate
?ColumnDefine
Purpose
Return the current column type.
Syntax
any := ?ColumnDefine ()
See Also
ColumnDefineDlg, ColumnsDefinition
?ColumnWidth
Purpose
Return the width of the current column in WordPerfect units.
Syntax
any := ?ColumnWidth ()
See Also
ColumnsDefinition
?ConfirmCodesDelete
Purpose
Return True if Confirm deletion of codes, Stop insertion point at hidden codes is on in Environment Settings, False if not.
Syntax
boolean := ?ConfirmCodesDelete ()
See Also
PrefEnvironment, PrefEnvSettingsDlg
?ConfirmFormulaDelete
Purpose
Return True if Confirm deletion of table formulas is selected in Environment Settings, False if not.
Syntax
boolean := ?ConfirmFormulaDelete ()
See Also
PrefEnvironment, PrefEnvSettingsDlg
?CurrentButtonBar
Purpose
Return the name of the active toolbar.
Syntax
string := ?CurrentButtonBar ()
See Also
ButtonBarSelect
?CurrentKeyboard
Purpose
Return the name of the active keyboard.
Syntax
string := ?CurrentKeyboard ()
See Also
KeyboardSelect
?CurrentLabel
Purpose
Return the name of the current label definition.
Syntax
string := ?CurrentLabel ()
See Also
LabelsSelect
?CurrentMenu
Purpose
Return the name of the active menu bar.
Syntax
string := ?CurrentMenu ()
See Also
MenuSelect
?CurrentPaperName
Purpose
Return the name of the current page definition.
Syntax
string := ?CurrentPaperName ()
See Also
?PaperLength, ?PaperSizeType, ?PaperWidth, PaperSizeAdd, PaperSizeDelete, PaperSizeDlg, PaperSizeResave, PaperSizeSelect
?CurrentParagraphLevel
Purpose
Return the level of the active outline paragraph.
Syntax
numeric := ?CurrentParagraphLevel ()
See Also
OutlineParagraphNumber
?CurrentPrinterPort
Purpose
Return the name of the active printer port.
Syntax
string := ?CurrentPrinterPort ()
See Also
PrintDestination, PrintSettings
?CurrentStyle
Purpose
Return the name of the active style.
Syntax
string := ?CurrentStyle ()
See Also
StyleOff, StyleOn
?CurrentSubdoc
Purpose
Return the active substructure.
Syntax
numeric := ?CurrentSubdoc ()
See Also
SubstructureExit
?CurrentTableName
Purpose
Return the active table name, or the previous table name if the insertion point is not in a table. Returns 0 if the insertion point is not in a table and there is no previous table.
Syntax
string := ?CurrentTableName ()
See Also
TableNameListDlg
?CurrentTemplate
Purpose
Return the path and filename of the active template.
Syntax
string := ?CurrentTemplate ()
See Also
TemplateSelect
?CurrentWord
Purpose
Return the word in which the insertion point is located.
Syntax
string := ?CurrentWord ()
?DateDay
Purpose
Return the current day of the month.
Syntax
numeric := ?DateDay ()
See Also
?DateMonth, ?DateWeekday, ?DateYear, DateFormat
?DateMonth
Purpose
Return the current month.
Syntax
numeric := ?DateMonth ()
See Also
?DateDay, ?DateWeekday, ?DateYear, DateFormat
?DateWeekday
Purpose
Return the current day of the week.
Syntax
numeric := ?DateWeekday ()
See Also
?DateDay, ?DateMonth, ?DateYear, DateFormat
?DateYear
Purpose
Return the current year.
Syntax
numeric := ?DateYear ()
See Also
?DateDay, ?DateMonth, ?DateWeekday, DateFormat
?DecimalAlignmentCharacter
Purpose
Return the current decimal alignment character.
Syntax
string := ?DecimalAlignmentCharacter ()
See Also
DecimalAlignmentCharacter
?DefaultDocumentExtension
Purpose
Return the default extension for document filenames.
Syntax
string := ?DefaultDocumentExtension ()
See Also
?DefaultTemplateExtension
?DefaultTemplateExtension
Purpose
Return the default extension for template filenames.
Syntax
string := ?DefaultTemplateExtension ()
See Also
?DefaultDocumentExtension
?DefaultView
Purpose
Return the default view.
Syntax
numeric := ?DefaultView ()
?DisplayMode
Purpose
Return the current display mode.
Syntax
numeric := ?DisplayMode ()
See Also
DisplayMode
?DocBlank
Purpose
Return True if the current document is blank, False if not.
Syntax
boolean := ?DocBlank ()
?DocChanged
Purpose
Return True if the current document has been modified since the last time it was saved, False if not.
Syntax
boolean := ?DocChanged ()
See Also
?DocModified
?DocModified
Purpose
Return True if the active document has been modified since the last time it was saved, False if not.
Syntax
boolean := ?DocModified ()
See Also
?DocChanged
?DocNeedsGenerating
Purpose
Return True if the active document needs to be generated, False if not.
Syntax
boolean := ?DocNeedsGenerating ()
See Also
GenerateDoc
?DocNumber
Purpose
Return the active document number (1-9), or returns 0 if the insertion point is in a document substructure such as a comment, header, or watermark.
Syntax
numeric := ?DocNumber ()
?DocReadOnly
Purpose
Return True if the current document is read-only, False if not.
Syntax
boolean := ?DocReadOnly ()
See Also
FileChangeAttributes
?DocumentFont
Purpose
Return the document initial font name.
Syntax
string := ?DocumentFont ()
See Also
DocInitialFont
?DocumentInformation
Purpose
Return the number of characters in the active document.
Syntax
numeric := ?DocumentInformation ()
See Also
WordCountDlg
?DOSName
Purpose
Return the active DOS filename.
Syntax
string := ?DOSName ()
See Also
?DOSPath
?DOSPath
Purpose
Return the active DOS file path, not including the filename.
Syntax
string := ?DOSPath ()
See Also
?DOSName
?DotLeader
Purpose
Return the active dot leader character.
Syntax
string := ?DotLeader ()
See Also
DotLeader
?DoubleSmartQuote
Purpose
Return True if QuickCorrect changes double quotes to double smart quotes, False if not.
Syntax
boolean := ?DoubleSmartQuote ()
See Also
DoubleSmartQuote
?DropCapBorderStyle
Purpose
Return the active drop cap border style. Precede with DropCapBegin and end with DropCapEnd.
Syntax
any := ?DropCapBorderStyle ()
See Also
DropCapBorderStyle
?DropCapCharacters
Purpose
Return the number of characters in a drop cap.
Syntax
numeric := ?DropCapCharacters ()
See Also
DropCapCharacters
?DropCapCharacterSize
Purpose
Return the active drop cap character size relative to a line of text.
Syntax
numeric := ?DropCapCharacterSize ()
See Also
DropCapCharacterSize
?DropCapContourWrap
Purpose
Return the state of Wrap Text around Drop Cap.
Syntax
boolean := ?DropCapContourWrap ()
See Also
?DropCapNoWrap, DropCapContourWrap
?DropCapFillStyle
Purpose
Return the active drop cap fill style.
Syntax
any := ?DropCapFillStyle ()
See Also
DropCapFillStyle
?DropCapHorizontalAdjustment
Purpose
Return the percent a drop cap extends into the left margin.
Syntax
numeric := ?DropCapHorizontalAdjustment ()
See Also
?DropCapVerticalAdjustment, DropCapHorizontalAdjustment
?DropCapIncludeDescender
Purpose
Return the state of Allow for Descender.
Syntax
boolean := ?DropCapIncludeDescender ()
See Also
DropCapIncludeDescender
?DropCapIncludeDiacritic
Purpose
Return the selection of Allow for Diacritic.
Syntax
boolean := ?DropCapIncludeDiacritic ()
See Also
DropCapIncludeDiacritic
?DropCapInParagraph
Purpose
Return True if the current paragraph contains [Dropcap Definition], False if not.
Syntax
boolean := ?DropCapInParagraph ()
See Also
DropCapBegin, DropCapEnd
?DropCapKerning
Purpose
Return the kerning distance between a drop cap and the text to the right. The default kerning is 0, and the measurement is expressed in WordPerfect units. A negative value reduces the distance; a positive value increases it.
Syntax
measurement := ?DropCapKerning ()
See Also
DropCapKerning
?DropCapNoWrap
Purpose
Return the state of Wrap Text around Drop Cap.
Syntax
boolean := ?DropCapNoWrap ()
See Also
?DropCapContourWrap, DropCapNoWrap
?DropCapState
Purpose
Return the state of the Drop Cap feature bar.
Syntax
boolean := ?DropCapState ()
See Also
DropCapBegin, DropCapEnd
?DropCapUseColor
Purpose
Return information about whether the text color or a different color is used in a drop cap character.
Syntax
boolean := ?DropCapUseColor ()
See Also
TextColor
?DropCapVerticalAdjustment
Purpose
Return the number of lines to extend a drop cap.
Syntax
numeric := ?DropCapVerticalAdjustment ()
See Also
?DropCapHorizontalAdjustment, DropCapVerticalAdjustment
?EditScreen
Purpose
Return True if the current screen is an editing screen, False if not.
Syntax
boolean := ?EditScreen ()
?Endnote
Purpose
Return the number of the endnote to the left of the insertion point.
Syntax
numeric := ?Endnote ()
See Also
EndnoteNumberDisplay
?EndnoteMinimum
Purpose
Return the amount of endnote text to be kept together.
Syntax
measurement := ?EndnoteMinimum ()
See Also
EndnoteMinimum
?EndnoteSpace
Purpose
Return the distance between endnotes.
Syntax
measurement := ?EndnoteSpace ()
See Also
EndnotesSpaceBetween
?EndOfSentenceSpacing
Purpose
Return a value indicating the currently selected end of sentence spacing option.
Syntax
numeric := ?EndOfSentenceSpacing ()
See Also
EndOfSentenceSpacing
?FeatureBar
Purpose
Return the active feature bar.
Syntax
numeric := ?FeatureBar ()
?Fill
Purpose
Return the active fill style. Precede with a command which specifies a fill style, such as FillStyleEdit, and follow with a closing command such as FillStyleEnd.
Syntax
any := ?Fill ()
See Also
?FillType, FillStyleName
?FillGradientSteps
Purpose
Return the calculation of steps in a gradient.
Syntax
any := ?FillGradientSteps ()
See Also
?FillGradientType, FillSetGradient
?FillGradientType
Purpose
Return the active gradient fill type. The fill type can be linear, radial, or rectangular.
Syntax
any := ?FillGradientType ()
See Also
?FillGradientSteps, FillSetGradient
?FillType
Purpose
Return the active fill style type. The type can be either a pattern or a gradient.
Syntax
any := ?FillType ()
See Also
?Fill, FillStyleName
?FillWPG2Pattern
Purpose
Return the Corel WordPerfect fill pattern. Precede with FillStyleCreate or FillStyleEdit and follow with FillStyleEnd, or precede with BoxCreate or BoxEdit and follow with BoxEnd.
Syntax
any := ?FillWPG2Pattern ()
See Also
?Fill, FillStyleName
?FirstLineIndent
Purpose
Return the indentation of the first line of a new paragraph.
Syntax
measurement := ?FirstLineIndent ()
See Also
FirstLineIndent
?FirstPrintLineNum
Purpose
Return the first line number to print.
Syntax
numeric := ?FirstPrintLineNum ()
See Also
PrintSettings
?Font
Purpose
Return the active font name, or the original font name when a font has been substituted.
Syntax
string := ?Font ()
See Also
Font
?FontBold
Purpose
Return True if the active font attribute is Bold, False if not.
Syntax
boolean := ?FontBold ()
See Also
BoldKey, Font
?FontDoubleUnderline
Purpose
Return True if the active font attribute is Double Underline, False if not.
Syntax
boolean := ?FontDoubleUnderline ()
See Also
Font, FontDoubleUnderlineToggle
?FontExtraLarge
Purpose
Return True if the active font attribute is Extra Large, False if not.
Syntax
boolean := ?FontExtraLarge ()
See Also
Font, FontExtraLargeToggle
?FontFine
Purpose
Return True if the active font attribute is Fine, False if not.
Syntax
boolean := ?FontFine ()
See Also
Font, FontFineToggle
?FontItalics
Purpose
Return True if the active font attribute is Italics, False if not.
Syntax
boolean := ?FontItalics ()
See Also
Font, FontItalicToggle
?FontLarge
Purpose
Return True if the active font attribute is Large, False if not.
Syntax
boolean := ?FontLarge ()
See Also
Font, FontLargeToggle
?FontOutline
Purpose
Return True if the active font attribute is Outline, False if not.
Syntax
boolean := ?FontOutline ()
See Also
Font, FontOutlineToggle
?FontRedline
Purpose
Return True if the active font attribute is Redline, False if not.
Syntax
boolean := ?FontRedline ()
See Also
Font, FontRedlineToggle
?FontShadow
Purpose
Return True if the active font attribute is Shadow, False if not.
Syntax
boolean := ?FontShadow ()
See Also
Font, FontShadowToggle
?FontSize
Purpose
Return the active font size in WordPerfect units (1200ths of an inch).
Syntax
measurement := ?FontSize ()
See Also
Font, FontSize
?FontSmall
Purpose
Return True if the active font size is small, False if not.
Syntax
boolean := ?FontSmall ()
See Also
Font, FontSmallToggle
?FontSmallCaps
Purpose
Return True if the active font attribute is small caps, False if not.
Syntax
boolean := ?FontSmallCaps ()
See Also
Font, FontSmallCapsToggle
?FontStrikeout
Purpose
Return True if the active font attribute is strikeout, False if not.
Syntax
boolean := ?FontStrikeout ()
See Also
Font, FontStrikeoutToggle
?FontSubscript
Purpose
Return True if the active font attribute is subscript, False if not.
Syntax
boolean := ?FontSubscript ()
See Also
Font, FontSubscriptToggle
?FontSuperscript
Purpose
Return True if the active font attribute is superscript, False if not.
Syntax
boolean := ?FontSuperscript ()
See Also
Font, FontSuperscriptToggle
?FontUnderline
Purpose
Return True if the active font attribute is underline, False if not.
Syntax
boolean := ?FontUnderline ()
See Also
Font, FontUnderlineToggle
?FontVeryLarge
Purpose
Return True if the active font size is very large, False if not.
Syntax
boolean := ?FontVeryLarge ()
See Also
Font, FontVeryLargeToggle
?FooterAInParagraph
Purpose
Return whether a Footer A code is in the active paragraph.
Syntax
boolean := ?FooterAInParagraph ()
See Also
?FooterAOccur, ?FooterBInParagraph, ?FooterBOccur, FooterA
?FooterAOccur
Purpose
Return the pages on which Footer A appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?FooterAOccur ()
See Also
?FooterAInParagraph, ?FooterBInParagraph, ?FooterBOccur, FooterA
?FooterBInParagraph
Purpose
Return whether a Footer B code is in the active paragraph.
Syntax
boolean := ?FooterBInParagraph ()
See Also
?FooterAInParagraph, ?FooterAOccur, ?FooterBOccur, FooterB
?FooterBOccur
Purpose
Return the pages on which Footer B appears. It can be printed on odd-numbered pages, even-numbered pages, or all pages.
Syntax
numeric := ?FooterBOccur ()
See Also
?FooterAInParagraph, ?FooterAOccur, ?FooterBInParagraph, FooterB
?FooterSeparator
Purpose
Return the distance between text and a footer.
Syntax
any := ?FooterSeparator ()
See Also
FooterSeparationDistance
?Footnote
Purpose
Return the footnote number that is to the left of the insertion point.
Syntax
numeric := ?Footnote ()
See Also
FootnoteNumberDisplay
?FootnoteContinued
Purpose
Return whether the current setting inserts a (continued . . .) message in footnotes that continue to the next page.
Syntax
boolean := ?FootnoteContinued ()
See Also
FootnoteContinuedMessage
?FootnoteMinimum
Purpose
Return the minimum amount of footnote text to be kept together.
Syntax
measurement := ?FootnoteMinimum ()
See Also
FootnoteMinimum
?FootnotePosition
Purpose
Return whether footnotes print at the bottom of the page or just below the last line of text.
Syntax
numeric := ?FootnotePosition ()
See Also
FootnotePosition
?FootnoteRestartsPage
Purpose
Return whether footnote numbering restarts on every page.
Syntax
boolean := ?FootnoteRestartsPage ()
See Also
FootnoteRestartEachPage
?FootnoteSpace
Purpose
Return the distance between footnotes.
Syntax
measurement := ?FootnoteSpace ()
See Also
FootnoteSpaceBetween
?FormatForDefaultPrinter
Purpose
Return True if Reformat documents for the Corel WordPerfect default printer on open is selected in Environment Settings, False if not.
Syntax
boolean := ?FormatForDefaultPrinter ()
See Also
PrefPrintEnvironment