Chapter 3
Corel® WordPerfect® System Variables
A - B
?ActivateHypertext
Purpose
Return True if Activate hyperlinks on open is selected in Environment Settings, False if not.
Syntax
boolean := ?ActivateHypertext ()
See Also
Hypertext, PrefEnvironment, PrefEnvSettingsDlg
?AddressBookSelection
Purpose
Return the number of entries most recently selected in the Address Book.
Syntax
numeric := ?AddressBookSelection ()
See Also
AddressBookDlg, AddressBookInsertAddr
?Align
Purpose
Return the current character justification.
Syntax
numeric := ?Align ()
See Also
?Justification, Justification
?AutoUpdate
Purpose
Return the state of the Update on retrieve option for spreadsheet/database links.
Syntax
boolean := ?AutoUpdate ()
See Also
SpreadsheetUpdateOnRetrieve
?AutoWordSelect
Purpose
Return the state of the Automatically select words option in Environment Settings.
Syntax
boolean := ?AutoWordSelect ()
See Also
PrefEnvironment
?BaselineMode
Purpose
Return the state of the Baseline placement for typesetting option.
Syntax
boolean := ?BaselineMode ()
See Also
BaselinePlacement
?BetweenTableCodes
Purpose
Return True if the insertion point is in a table, False if not.
Syntax
boolean := ?BetweenTableCodes ()
See Also
?TableInTable, TableCreate
?Binding
Purpose
Return the binding edge for the current page. Return the current document settings only, regardless of the print-time settings.
Syntax
numeric := ?Binding ()
See Also
Binding
?BlockActive
Purpose
Return the current select mode, or 0 if select is not active.
Syntax
boolean := ?BlockActive ()
See Also
?SelectedText, ?SelectedTextSize, SelectOn
?BlockProtect
Purpose
Return True if Block Protect is on at the insertion point, False if not.
Syntax
boolean := ?BlockProtect ()
See Also
BlockProtect
?BookmarkList
Purpose
Return the name of the earliest-created bookmark that still exists in the current document. Return 0 if no bookmarks exist in the current document.
Syntax
string := ?BookmarkList ()
See Also
BookmarkCreate
?Border
Purpose
Return the current paragraph, column, or page border style. Precede with TextBorderEdit or TextBorderCreate and follow with TextBorderEnd.
Syntax
any := ?Border ()
See Also
?ColumnBorder, ?PageBorder, ?ParagraphBorder, BorderStyleCreate, TextBorderCreate, TextBorderStyle
?BorderBottomLine
Purpose
Return the bottom line style of a border. Precede with TextBorderCreate or TextBorderEdit and follow with TextBorderEnd.
Syntax
any := ?BorderBottomLine ()
See Also
?BorderLeftLine, ?BorderRightLine, ?BorderTopLine, BorderBottomLine
?BorderColorBlue
Purpose
Return the blue value of a border color style. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Syntax
numeric := ?BorderColorBlue ()
See Also
?BorderColorGreen, ?BorderColorRed, ?BorderColorShading, ?BorderUseBorderColor, BorderColor
?BorderColorGreen
Purpose
Return the green value of a border color. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Syntax
numeric := ?BorderColorGreen ()
See Also
?BorderColorBlue, ?BorderColorRed, ?BorderColorShading, ?BorderUseBorderColor, BorderColor
?BorderColorRed
Purpose
Return the red value of a border color. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Syntax
numeric := ?BorderColorRed ()
See Also
?BorderColorBlue, ?BorderColorGreen, ?BorderColorShading, ?BorderUseBorderColor, BorderColor
?BorderColorShading
Purpose
Return the color shading percent of a border. Precede with a command that identifies a specific border, such as BorderStyleCreate, BorderStyleEdit, or TextBorderEdit; follow with a corresponding command like BorderStyleEnd or TextBorderEnd.
Syntax
numeric := ?BorderColorShading ()
See Also
BorderColor
?BorderCornerRadius
Purpose
Return the corner radius of a border.
Syntax
numeric := ?BorderCornerRadius ()
See Also
BorderCornerRadius
?BorderInsideSpacingBottom
Purpose
Return the bottom spacing inside a border.
Syntax
any := ?BorderInsideSpacingBottom ()
See Also
?BorderInsideSpacingTop, BorderInsideSpacing
?BorderInsideSpacingTop
Purpose
Return the top spacing inside a border.
Syntax
any := ?BorderInsideSpacingTop ()
See Also
?BorderInsideSpacingBottom, BorderInsideSpacing
?BorderLeftLine
Purpose
Return the left line style of a border.
Syntax
any := ?BorderLeftLine ()
See Also
?BorderBottomLine, ?BorderRightLine, ?BorderTopLine, BorderLeftLine
?BorderRightLine
Purpose
Return the right line style of a border.
Syntax
any := ?BorderRightLine ()
See Also
?BorderBottomLine, ?BorderLeftLine, ?BorderTopLine, BorderRightLine
?BorderSeparatorLine
Purpose
Return the separator line style of a border.
Syntax
any := ?BorderSeparatorLine ()
See Also
BorderSeparatorLine
?BorderSetSpacing
Purpose
Return whether auto spacing or set spacing is active in the current border. Precede with a command that specifies a specific border, such as TextBorderEdit, TextBorderCreate, BorderStyleEdit, or BorderStyleCreate; follow with a corresponding command such as TextBorderEnd or BorderStyleEnd.
Syntax
any := ?BorderSetSpacing ()
See Also
BorderSetSpacing
?BorderTopLine
Purpose
Return the top line style of a border.
Syntax
any := ?BorderTopLine ()
See Also
?BorderBottomLine, ?BorderLeftLine, ?BorderRightLine, BorderTopLine
?BorderUseBorderColor
Purpose
Return whether the line style color or the border color is used for the current border. Precede with a command that specifies a specific border, such as TextBorderEdit, TextBorderCreate, BorderStyleEdit, or BorderStyleCreate; follow with a corresponding command such as TextBorderEnd or BorderStyleEnd.
Syntax
any := ?BorderUseBorderColor ()
See Also
BorderUseBorderColor
?BoxAttachTo
Purpose
Return the structure a graphics box is attached to. Precede with BoxCreate or BoxEdit and follow with BoxEnd to specify a box to return the information on. This command will also return information on the currently selected box.
Syntax
any := ?BoxAttachTo ()
See Also
BoxAttachTo, BoxCreate, BoxEdit, BoxEnd
?BoxCaptionDefaultInitialStyle
Purpose
Return the initial style of the current caption.
Syntax
any := ?BoxCaptionDefaultInitialStyle ()
See Also
BoxCaptionInitialStyle
?BoxCaptionDefaultNumberStyle
Purpose
Return the current caption number style.
Syntax
any := ?BoxCaptionDefaultNumberStyle ()
See Also
BoxCaptionNumberStyle
?BoxCaptionFormatting
Purpose
Return the caption width. If the width is Auto, the value is 2. Otherwise, the value is a measurement or a percent of the box width or height.
Syntax
any := ?BoxCaptionFormatting ()
See Also
BoxCaptionFormatting
?BoxCaptionPositionAlignment
Purpose
Return the caption alignment.
Syntax
any := ?BoxCaptionPositionAlignment ()
See Also
BoxCaptionPosition
?BoxCaptionPositionBorder
Purpose
Return the caption position relative to the border.
Syntax
any := ?BoxCaptionPositionBorder ()
See Also
BoxCaptionPosition
?BoxCaptionPositionOffset
Purpose
Return the caption offset or a percent of the box width or height.
Syntax
any := ?BoxCaptionPositionOffset ()
See Also
BoxCaptionPosition
?BoxCaptionPositionSide
Purpose
Return the side of a box where a caption is located.
Syntax
any := ?BoxCaptionPositionSide ()
See Also
BoxCaptionPosition
?BoxCaptionRotation
Purpose
Return the degree of caption rotation.
Syntax
any := ?BoxCaptionRotation ()
See Also
BoxCaptionRotation
?BoxChangeLineHeight
Purpose
Return whether a box attached to a character automatically adjusts to fit the text line height.
Syntax
any := ?BoxChangeLineHeight ()
See Also
BoxChangeLineHeight
?BoxContentFilename
Purpose
Return the name of a text or image file in the current box.
Syntax
any := ?BoxContentFilename ()
See Also
BoxContentEdit
?BoxContentHorizontalPosition
Purpose
Return the horizontal position of the current box contents.
Syntax
any := ?BoxContentHorizontalPosition ()
See Also
?BoxContentVerticalPosition, BoxContentPosition
?BoxContentInternal
Purpose
Return the location of an image used in a graphics box.
Syntax
any := ?BoxContentInternal ()
See Also
BoxContentEdit
?BoxContentPreserveAspectRatio
Purpose
Return whether the width/height ratio of an image is preserved when the box size changes.
Syntax
any := ?BoxContentPreserveAspectRatio ()
See Also
BoxContentPreserveAspectRatio
?BoxContentType
Purpose
Return the current box content type.
Syntax
any := ?BoxContentType ()
See Also
BoxContentType
?BoxContentVerticalPosition
Purpose
Return the vertical position of box contents.
Syntax
any := ?BoxContentVerticalPosition ()
See Also
?BoxContentHorizontalPosition, BoxContentPosition
?BoxCount
Purpose
Return the number of boxes in the current document.
Syntax
any := ?BoxCount ()
?BoxCounter
Purpose
Return the current counter type.
Syntax
any := ?BoxCounter ()
See Also
BoxCounter
?BoxEquationColorBlue
Purpose
Return the blue value of the current equation color.
Syntax
any := ?BoxEquationColorBlue ()
See Also
?BoxEquationColorGreen, ?BoxEquationColorRed, ?BoxEquationColorShading, BoxEquationColor
?BoxEquationColorGreen
Purpose
Return the green value of the current equation color.
Syntax
any := ?BoxEquationColorGreen ()
See Also
?BoxEquationColorBlue, ?BoxEquationColorRed, ?BoxEquationColorShading, BoxEquationColor
?BoxEquationColorRed
Purpose
Return the red value of the current equation color.
Syntax
any := ?BoxEquationColorRed ()
See Also
?BoxEquationColorBlue, ?BoxEquationColorGreen, ?BoxEquationColorShading, BoxEquationColor
?BoxEquationColorShading
Purpose
Return the shade of the current equation color.
Syntax
any := ?BoxEquationColorShading ()
See Also
BoxEquationColor
?BoxEquationFont
Purpose
Return the name of the font used in the current equation box.
Syntax
any := ?BoxEquationFont ()
See Also
?BoxEquationFontSize, BoxEquationFont
?BoxEquationFontSize
Purpose
Return the font size used in the current equation box.
Syntax
any := ?BoxEquationFontSize ()
See Also
?BoxEquationFont, BoxEquationFontSize
?BoxHeight
Purpose
Return the box height. If the height is Auto, the value is 2. Otherwise, the value is expressed in WordPerfect units.
Syntax
any := ?BoxHeight ()
See Also
?BoxWidth, BoxHeight
?BoxHorizontalAlignment
Purpose
Return the horizontal position of a box attached to a page or a paragraph.
Syntax
any := ?BoxHorizontalAlignment ()
See Also
?BoxHorizontalAlignTo, ?BoxHorizontalOffset, ?BoxVerticalAlignment, BoxHorizontalAlignment
?BoxHorizontalAlignTo
Purpose
Return whether a box attached to a page is aligned to the margins or to a column or columns.
Syntax
any := ?BoxHorizontalAlignTo ()
See Also
?BoxHorizontalAlignment, ?BoxHorizontalOffset, ?BoxVerticalAlignTo, BoxHorizontalAlignment, BoxHorizontalPosition
?BoxHorizontalOffset
Purpose
Return the right or left position of a box relative to an alignment point in WordPerfect units.
Syntax
any := ?BoxHorizontalOffset ()
See Also
?BoxHorizontalAlignment, ?BoxHorizontalAlignTo, ?BoxVerticalOffset, BoxHorizontalAlignment, BoxHorizontalPosition
?BoxImageBlackWhiteThreshold
Purpose
Return the threshold where image colors and/or grays convert to black or white. Colors or grays below the threshold convert to black; those above convert to white.
Syntax
any := ?BoxImageBlackWhiteThreshold ()
See Also
?BoxImageBrightness, ?BoxImageContrast, ?BoxImageDitherMethod, ?BoxImageDitherSource, BoxImageBlackWhiteThreshold
?BoxImageBrightness
Purpose
Return the brightness of an image color.
Syntax
any := ?BoxImageBrightness ()
See Also
?BoxImageBlackWhiteThreshold, ?BoxImageContrast, ?BoxImageDitherMethod, ?BoxImageDitherSource, BoxImageBrightness
?BoxImageContrast
Purpose
Return the image contrast value.
Syntax
any := ?BoxImageContrast ()
See Also
?BoxImageBlackWhiteThreshold, ?BoxImageBrightness, ?BoxImageDitherMethod, ?BoxImageDitherSource, BoxImageContrast
?BoxImageDitherMethod
Purpose
Return the dither method.
Syntax
any := ?BoxImageDitherMethod ()
See Also
?BoxImageBlackWhiteThreshold, ?BoxImageBrightness, ?BoxImageContrast, ?BoxImageDitherSource, BoxImageDitherMethod
?BoxImageDitherSource
Purpose
Return the dither source.
Syntax
any := ?BoxImageDitherSource ()
See Also
?BoxImageBlackWhiteThreshold, ?BoxImageBrightness, ?BoxImageContrast, ?BoxImageDitherMethod
?BoxImageFill
Purpose
Return the image fill type.
Syntax
any := ?BoxImageFill ()
See Also
BoxImageFill
?BoxImageFlipX
Purpose
Return whether an image is reversed on its horizontal axis.
Syntax
any := ?BoxImageFlipX ()
See Also
?BoxImageFlipY, BoxImageFlipX
?BoxImageFlipY
Purpose
Return whether an image is flipped on its vertical axis.
Syntax
any := ?BoxImageFlipY ()
See Also
?BoxImageFlipX, BoxImageFlipY
?BoxImageHalftoneAngle0
Purpose
Return the image halftone angle. The default is generally 45, but it depends upon the selected printer.
Syntax
any := ?BoxImageHalftoneAngle0 ()
See Also
?BoxImageHalftoneAngle1, ?BoxImageHalftoneAngle2, ?BoxImageHalftoneAngle3, ?BoxImageHalftoneScreenLPI, BoxImageHalfToneOptions
?BoxImageHalftoneAngle1
Purpose
Return the image halftone angle 1.
Syntax
any := ?BoxImageHalftoneAngle1 ()
See Also
?BoxImageHalftoneAngle0, ?BoxImageHalftoneAngle2, ?BoxImageHalftoneAngle3, ?BoxImageHalftoneScreenLPI, BoxImageHalfToneOptions
?BoxImageHalftoneAngle2
Purpose
Return the image halftone angle 2.
Syntax
any := ?BoxImageHalftoneAngle2 ()
See Also
?BoxImageHalftoneAngle0, ?BoxImageHalftoneAngle1, ?BoxImageHalftoneAngle3, ?BoxImageHalftoneScreenLPI, BoxImageHalfToneOptions
?BoxImageHalftoneAngle3
Purpose
Return the image halftone angle 3.
Syntax
any := ?BoxImageHalftoneAngle3 ()
See Also
?BoxImageHalftoneAngle0, ?BoxImageHalftoneAngle1, ?BoxImageHalftoneAngle2, ?BoxImageHalftoneScreenLPI, BoxImageHalfToneOptions
?BoxImageHalftoneScreenLPI
Purpose
Return the halftone lines per inch (LPI).
Syntax
any := ?BoxImageHalftoneScreenLPI ()
See Also
?BoxImageHalftoneAngle0, ?BoxImageHalftoneAngle1, ?BoxImageHalftoneAngle2, ?BoxImageHalftoneAngle3, BoxImageHalfToneOptions
?BoxImageInvertColors
Purpose
Return whether image colors have been inverted to their respective complementary colors.
Syntax
any := ?BoxImageInvertColors ()
See Also
BoxImageInvertColors
?BoxImageMonochrome
Purpose
Return whether a color image converts to black and white.
Syntax
any := ?BoxImageMonochrome ()
See Also
BoxImageMonochrome
?BoxImagePageBackground
Purpose
Return whether any background colors or gradients saved with an image are visible.
Syntax
any := ?BoxImagePageBackground ()
?BoxImageRotation
Purpose
Return the degree of rotation for a graphics box.
Syntax
any := ?BoxImageRotation ()
See Also
BoxImageRotate
?BoxImageScalingX
Purpose
Return the scaling width.
Syntax
any := ?BoxImageScalingX ()
See Also
?BoxImageScalingY, BoxImageScaling
?BoxImageScalingY
Purpose
Return the scaling height.
Syntax
any := ?BoxImageScalingY ()
See Also
?BoxImageScalingX, BoxImageScaling
?BoxImageTranslationX
Purpose
Return the horizontal position of an image within a box.
Syntax
any := ?BoxImageTranslationX ()
See Also
?BoxImageTranslationY
?BoxImageTranslationY
Purpose
Return the vertical position of an image within a box.
Syntax
any := ?BoxImageTranslationY ()
See Also
?BoxImageTranslationX
?BoxLeftColumn
Purpose
Return the number of the left column to which a graphics box aligns.
Syntax
any := ?BoxLeftColumn ()
See Also
?BoxRightColumn
?BoxNumber
Purpose
Return the number of the box after the insertion point.
Syntax
any := ?BoxNumber ()
?BoxOverlap
Purpose
Return whether a graphics box may overlap other boxes.
Syntax
any := ?BoxOverlap ()
See Also
BoxOverlap
?BoxRightColumn
Purpose
Return number of the right column to which a graphics box aligns.
Syntax
any := ?BoxRightColumn ()
See Also
?BoxLeftColumn
?BoxStaysOnPage
Purpose
Return whether the current box will stay on a specific page or move with the surrounding text. This command must be preceded by BoxCreate, BoxEdit, BoxEditByCounter, BoxEditNext, or BoxEditPrevious, and it must be followed by BoxEnd.
Syntax
boolean := ?BoxStaysOnPage ()
See Also
BoxStaysOnPage
?BoxStyleName
Purpose
Return the name of a box style.
Syntax
any := ?BoxStyleName ()
See Also
BoxStyleName
?BoxTextAngle
Purpose
Return the degree of rotation for text in a box.
Syntax
any := ?BoxTextAngle ()
See Also
BoxTextAngle
?BoxTextDefaultStyle
Purpose
Return the default style of box text.
Syntax
any := ?BoxTextDefaultStyle ()
See Also
BoxTextDefaultStyle
?BoxVerticalAlignment
Purpose
Return the vertical alignment of a box attached to a page or character.
Syntax
any := ?BoxVerticalAlignment ()
See Also
?BoxHorizontalAlignment, ?BoxVerticalAlignTo, ?BoxVerticalOffset, BoxVerticalAlignment
?BoxVerticalAlignTo
Purpose
Return the alignment of a box to the margins.
Syntax
any := ?BoxVerticalAlignTo ()
See Also
?BoxHorizontalAlignTo, ?BoxVerticalAlignment, ?BoxVerticalOffset, BoxVerticalAlignment, BoxVerticalPosition
?BoxVerticalOffset
Purpose
Return the vertical position of a box relative to an alignment point in WordPerfect units.
Syntax
any := ?BoxVerticalOffset ()
See Also
?BoxHorizontalOffset, ?BoxVerticalAlignment, ?BoxVerticalAlignTo, BoxVerticalAlignment, BoxVerticalPosition
?BoxWidth
Purpose
Return the width of a graphics box.
Syntax
any := ?BoxWidth ()
See Also
?BoxHeight, BoxWidth
?BoxWrapping
Purpose
Return the direction of text wrapping around a box.
Syntax
any := ?BoxWrapping ()
See Also
?BoxWrappingType, BoxWrapDlg
?BoxWrappingType
Purpose
Return whether the text outside a box wraps around an image.
Syntax
any := ?BoxWrappingType ()
See Also
?BoxWrapping, BoxWrapDlg
?ButtonBarActive
Purpose
Return True if the toolbar is active, False if not.
Syntax
boolean := ?ButtonBarActive ()
See Also
ButtonBarShow