Return the state of the Baseline placement for typesetting option.
Return Value
0 Off
1 On
boolean:=?BetweenTableCodes
Syntax
()
Description
Return True if the insertion point is in a table, False if not.
numeric:=?Binding
Syntax
()
Description
Return the binding edge for the current page. Return the current document settings only, regardless of the print-time settings.
Return Value
0 Left edge
1 Right edge
2 Top edge
3 Bottom edge
boolean:=?BlockActive
Syntax
()
Description
Return the current select mode, or 0 if select is not active.
Return Value
0 Select not active
1 Character mode
2 Word mode
4 Sentence mode
8 Paragraph mode
16 Page mode
32 Rectangle mode
64 Tabular Column mode
128 Document mode
256 Character no cell mode
string:=?BookmarkList
Syntax
()
Description
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.
any:=?Border
Syntax
()
Description
Return the current paragraph, column, or page border style. Precede with TextBorderEdit or TextBorderCreate and follow with TextBorderEnd.
Return Value
Returns a value representing the current border style. If the current border style is not in the list below, the current border name is returned.
0 Spacing only
1 Single border
2 Double border
3 Dashed border
4 Dotted border
5 Thick border
6 Extra thick border
7 Thin thick border
8 Thick thin border
9 Thick top bottom border
10 Button border
11 Column border between
12 Column border all
127 No border
any:=?BorderBottomLine
Syntax
()
Description
Return the bottom line style of a border. Precede with TextBorderCreate or TextBorderEdit and follow with TextBorderEnd.
Return Value
A string specifies a user-defined line style.
0 Single line
1 Double line
2 Dashed line
3 Dotted line
4 Thick line
5 Extra-thick line
6 Thin-thick line
7 Thick-thin line
8 Button top-left line
9 Button bottom-right line
126 Table default line
127 No line
numeric:=?BorderColorBlue
Syntax
()
Description
Return the blue value of a border color style. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Return Value
Value: 0-255.
numeric:=?BorderColorGreen
Syntax
()
Description
Return the green value of a border color. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Return Value
Value: 0-255.
numeric:=?BorderColorRed
Syntax
()
Description
Return the red value of a border color. Precede with BorderStyleCreate or BorderStyleEdit and follow with BorderStyleEnd.
Return Value
Value: 0-255.
numeric:=?BorderColorShading
Syntax
()
Description
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.
Return Value
Percent: 0-100.
numeric:=?BorderCornerRadius
Syntax
()
Description
Return the corner radius of a border.
any:=?BorderInsideSpacingBottom
Syntax
()
Description
Return the bottom spacing inside a border.
any:=?BorderInsideSpacingTop
Syntax
()
Description
Return the top spacing inside a border.
any:=?BorderLeftLine
Syntax
()
Description
Return the left line style of a border.
Return Value
A string specifies a user-defined line style.
0 Single line
1 Double line
2 Dashed line
3 Dotted line
4 Thick line
5 Extra-thick line
6 Thin-thick line
7 Thick-thin line
8 Button top-left line
9 Button bottom-right line
126 Table default line
127 No line
any:=?BorderRightLine
Syntax
()
Description
Return the right line style of a border.
Return Value
A string specifies a user-defined line style.
0 Single line
1 Double line
2 Dashed line
3 Dotted line
4 Thick line
5 Extra-thick line
6 Thin-thick line
7 Thick-thin line
8 Button top-left line
9 Button bottom-right line
126 Table default line
127 No line
any:=?BorderSeparatorLine
Syntax
()
Description
Return the separator line style of a border.
Return Value
A string specifies a user-defined line style.
0 Single line
1 Double line
2 Dashed line
3 Dotted line
4 Thick line
5 Extra-thick line
6 Thin-thick line
7 Thick-thin line
8 Button top-left line
9 Button bottom-right line
126 Table default line
127 No line
any:=?BorderSetSpacing
Syntax
()
Description
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.
Return Value
0 Auto spacing on
1 Set spacing is on
any:=?BorderTopLine
Syntax
()
Description
Return the top line style of a border.
Return Value
A string specifies a user-defined line style.
0 Single line
1 Double line
2 Dashed line
3 Dotted line
4 Thick line
5 Extra-thick line
6 Thin-thick line
7 Thick-thin line
8 Button top-left line
9 Button bottom-right line
126 Table default line
127 No line
any:=?BorderUseBorderColor
Sytnax
()
Description
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.
Return Value
0 Use the line style color
1 Use the border color
any:=?BoxAttachTo
Sytnax
()
Description
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.
Return Value
2 Page
3 Paragraph
64 Character
any:=?BoxCaptionDefaultInitialStyle
Sytnax
()
Description
Return the initial style of the current caption.
Return Value
0 Normal
16 Footnote number in document
17 Endnote number in document
18 Figure number
19 Table-box number
20 Text-box number
21 User-box number
22 Equation number
23 Hypertext
24 ToC 1
25 ToC 2
26 ToC 3
27 ToC 4
28 ToC 5
29 Index 1
30 Index 2
31 List
32 ToA
33 Doc
34 Box text
35 Caption
36 Footnote
37 Endnote
38 Comment
39 Header A
40 Header B
41 Footer A
42 Footer B
43 Watermark A
44 Watermark B
45 Paragraph outline
46 Outline
47 Legal outline
48 Bullets outline
49 Headings outline
50 Legal 2 outline
51 Numbers outline
52 Level 1
53 Level 2
54 Level 3
55 Level 4
56 Level 5
57 Level 6
58 Level 7
59 Level 8
60 Legal 1
61 Legal 2
62 Legal 3
63 Legal 4
64 Legal 5
65 Legal 6
66 Legal 7
67 Legal 8
68 Heading 1
69 Heading 2
70 Heading 3
71 Heading 4
72 Heading 5
73 Heading 6
74 Heading 7
75 Heading 8
any:=?BoxCaptionDefaultNumberStyle
Syntax
()
Description
Return the current caption number style.
Return Value
0 Normal
16 Footnote number in document
17 Endnote number in document
18 Figure number
19 Table-box number
20 Text-box number
21 User-box number
22 Equation number
23 Hypertext
24 ToC 1
25 ToC 2
26 ToC 3
27 ToC 4
28 ToC 5
29 Index 1
30 Index 2
31 List
32 ToA
33 Doc
34 Box text
35 Caption
36 Footnote
37 Endnote
38 Comment
39 Header A
40 Header B
41 Footer A
42 Footer B
43 Watermark A
44 Watermark B
45 Paragraph outline
46 Outline
47 Legal outline
48 Bullets outline
49 Headings outline
50 Legal 2 outline
51 Numbers outline
52 Level 1
53 Level 2
54 Level 3
55 Level 4
56 Level 5
57 Level 6
58 Level 7
59 Level 8
60 Legal 1
61 Legal 2
62 Legal 3
63 Legal 4
64 Legal 5
65 Legal 6
66 Legal 7
67 Legal 8
68 Heading 1
69 Heading 2
70 Heading 3
71 Heading 4
72 Heading 5
73 Heading 6
74 Heading 7
75 Heading 8
any:=?BoxCaptionFormatting
Syntax
()
Description
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.
any:=?BoxCaptionPositionAlignment
Syntax
()
Description
Return the caption alignment.
Return Value
0 Left
1 Top
2 Center
3 Right
4 Bottom
any:=?BoxCaptionPositionBorder
Syntax
()
Description
Return the caption position relative to the border.
Return Value
0 Outside border
1 Inside border
2 On border
any:=?BoxCaptionPositionOffset
Syntax
()
Description
Return the caption offset or a percent of the box width or height.
any:=?BoxCaptionPositionSide
Syntax
()
Description
Return the side of a box where a caption is located.
Return Value
0 Left
1 Top
3 Right
4 Bottom
any:=?BoxCaptionRotation
Syntax
()
Description
Return the degree of caption rotation.
Return Value
0 None
1 90 degrees
2 180 degrees
3 270 degrees
any:=?BoxChangeLineHeight
Syntax
()
Description
Return whether a box attached to a character automatically adjusts to fit the text-line height.
Return Value
0 No change
1 Change
any:=?BoxContentFilename
Syntax
()
Description
Return the name of a text or image file in the current box.
any:=?BoxContentHorizontalPosition
Syntax
()
Description
Return the horizontal position of the current box contents.
Return Value
0 Left
2 Center
3 Right
any:=?BoxContentInternal
Syntax
()
Description
Return the location of an image used in a graphics box.
Return Value
0 In document
1 On disk
any:=?BoxContentPreserveAspectRatio
Syntax
()
Description
Return whether the width/height ratio of an image is preserved when the box size changes.
Return Value
0 Not preserved
1 Preserved
any:=?BoxContentType
Syntax
()
Description
Return the current box content type.
Return Value
1 Text
2 Linked text
3 Image
4 Equation
5 Presentation
6 Video
7 Macro
8 External
127 Empty
any:=?BoxContentVerticalPosition
Syntax
()
Description
Return the vertical position of box contents.
Return Value
1 Top
2 Center
4 Bottom
any:=?BoxCount
Syntax
()
Description
Return the number of boxes in the current document.
any:=?BoxCounter
Syntax
()
Description
Return the current counter type.
Return Value
0 None
1 Image box counter
2 Table box counter
3 Text box counter
4 User box counter
5 Equation counter
any:=?BoxEquationColorBlue
Syntax
()
Description
Return the blue value of the current equation color.
Return Value
Value: 0-255.
any:=?BoxEquationColorGreen
Syntax
()
Description
Return the green value of the current equation color.
Return Value
Value: 0-255.
any:=?BoxEquationColorRed
Syntax
()
Description
Return the red value of the current equation color.
Return Value
Value: 0-255.
any:=?BoxEquationColorShading
Syntax
()
Description
Return the shade of the current equation color.
Return Value
Percent: 0-100.
any:=?BoxEquationFont
Syntax
()
Description
Return the name of the font used in the current equation box.
any:=?BoxEquationFontSize
Syntax
()
Description
Return the font size used in the current equation box.
any:=?BoxHeight
Syntax
()
Description
Return the box height. If the height is Auto, the value is 2. Otherwise, the value is expressed in WordPerfect units (1200ths of an inch).
any:=?BoxHorizontalAlignment
Syntax
()
Description
Return the horizontal position of a box attached to a page or a paragraph.
Return Value
0 Left
2 Center
3 Right
7 Full align
any:=?BoxHorizontalAlignTo
Syntax
()
Description
Return whether a box attached to a page is aligned to the margins or to a column or columns.
Return Value
1 Align margins
2 Align columns
any:=?BoxHorizontalOffset
Syntax
()
Description
Return the right or left position of a box relative to an alignment point in WordPerfect units (1200ths of an inch).
any:=?BoxImageBlackWhiteThreshold
Syntax
()
Description
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.
Return Value
Value: 1-255. Default: 127.
any:=?BoxImageBrightness
Syntax
()
Description
Return the brightness of an image color.
Return Value
Value: -1.0 (black) to 1.0 (white).
any:=?BoxImageContrast
Syntax
()
Description
Return the image contrast value.
Return Value
Value: -1.0 (slight) to 1.0 (substantial).
any:=?BoxImageDitherMethod
Syntax
()
Description
Return the dither method.
Return Value
1 Halftoning
2 Ordered dither
3 Error diffusion dither
6 Default
any:=?BoxImageDitherSource
Syntax
()
Description
Return the dither source.
Return Value
0 WordPerfect
1 Printer
6 Default
8 External
any:=?BoxImageFill
Syntax
()
Description
Return the image fill type.
Return Value
0 Normal
1 Transparent
2 White
any:=?BoxImageFlipX
Syntax
()
Description
Return whether an image is reversed on its horizontal axis.
Return Value
0 Not reversed
1 Reversed
any:=?BoxImageFlipY
Syntax
()
Description
Return whether an image is flipped on its vertical axis.
Return Value
0 Not reversed
1 Reversed
any:=?BoxImageHalftoneAngle0
Syntax
()
Description
Return the image halftone angle. The default is generally 45, but it depends upon the selected printer.
any:=?BoxImageHalftoneAngle1
Syntax
()
Description
Return the image halftone angle 1.
any:=?BoxImageHalftoneAngle2
Syntax
()
Description
Return the image halftone angle 2.
any:=?BoxImageHalftoneAngle3
Syntax
()
Description
Return the image halftone angle 3.
any:=?BoxImageHalftoneScreenLPI
Syntax
()
Description
Return the halftone lines per inch (LPI).
Return Value
Default: 60.
any:=?BoxImageInvertColors
Syntax
()
Description
Return whether image colors have been inverted to their respective complementary colors.
Return Value
0 Not inverted
1 Inverted
any:=?BoxImageMonochrome
Syntax
()
Description
Return whether a color image converts to black and white.
Return Value
0 Not monochrome
1 Monochrome
any:=?BoxImagePageBackground
Syntax
()
Description
Return whether any background colors or gradients saved with an image are visible.
Return Value
0 Background not visible
1 Background visible
any:=?BoxImageRotation
Syntax
()
Description
Return the degree of rotation for a graphics box.
Return Value
Value: 0.0 to 359.0.
any:=?BoxImageScalingX
Syntax
()
Description
Return the scaling width.
Return Value
Value: 0.01 to 9.99.
any:=?BoxImageScalingY
Syntax
()
Description
Return the scaling height.
Return Value
Value: 0.01 to 9.99.
any:=?BoxImageTranslationX
Syntax
()
Description
Return the horizontal position of an image within a box.
Return Value
Value: -5.0 to 5.0. Default: 0.0.
any:=?BoxImageTranslationY
Syntax
()
Description
Return the vertical position of an image within a box.
Return Value
Value: -5.0 to 5.0. Default: 0.0.
any:=?BoxLeftColumn
Syntax
()
Description
Return the number of the left column to which a graphics box aligns.
any:=?BoxNumber
Syntax
()
Description
Return the number of the box after the insertion point.
any:=?BoxOverlap
Syntax
()
Description
Return whether a graphics box may overlap other boxes.
Return Value
0 No overlap
1 Overlap
any:=?BoxRightColumn
Syntax
()
Description
Return number of the right column to which a graphics box aligns.
boolean:=?BoxSizeIsNotLimited
Syntax
()
Description
Return whether the box is limited by table boundaries.
Return Value
0 The box is limited by table boundaries.
1 The box is not limited by table boundaries.
Note
New command
boolean:=?BoxStaysOnPage
Syntax
()
Description
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.
Return Value
0 Moves with text.
1 Stays on a specific page.
any:=?BoxStyleName
Syntax
()
Description
Return the name of a box style.
Return Value
A string specifies a user-created style.
0 Figure box
1 Table box
2 Text box
3 User box
4 Equation box
5 Button box
6 Watermark image box
7 Inline equation box
127 No box
boolean:=?BoxSuppressed
Syntax
()
Description
Return whether the box is suppressed.
Return Value
0 The box is not suppressed.
1 The box is suppressed.
Note
New command
any:=?BoxTextAngle
Syntax
()
Description
Return the degree of rotation for text in a box.
Return Value
0 None
1 90 degrees
2 180 degrees
3 270 degrees
any:=?BoxTextDefaultStyle
Syntax
()
Description
Return the default style of box text.
Return Value
0 Normal style
16 Footnote number in document style
17 Endnote number in document style
18 Figure number style
19 Table-box number style
20 Text-box number style
21 User-box number style
22 Equation number style
23 Hypertext style
24 TOC 1 style
25 TOC 2 style
26 TOC 3 style
27 TOC 4 style
28 TOC 5 style
29 Index 1 style
30 Index 2 style
31 List style
32 TOA style
33 Doc style
34 Box text style
35 Caption style
36 Footnote style
37 Endnote style
38 Comment style
39 Header A style
40 Header B style
41 Footer A style
42 Footer B style
43 Watermark A style
44 Watermark B style
45 Paragraph outline style
46 Outline style
47 Legal outline style
48 Bullets outline style
49 Headings outline style
50 Legal 2 outline style
51 Numbers outline style
52 Level 1 style
53 Level 2 style
54 Level 3 style
55 Level 4 style
56 Level 5 style
57 Level 6 style
58 Level 7 style
59 Level 8 style
60 Legal 1 style
61 Legal 2 style
62 Legal 3 style
63 Legal 4 style
64 Legal 5 style
65 Legal 6 style
66 Legal 7 style
67 Legal 8 style
68 Heading 1 style
69 Heading 2 style
70 Heading 3 style
71 Heading 4 style
72 Heading 5 style
73 Heading 6 style
74 Heading 7 style
75 Heading 8 style
any:=?BoxVerticalAlignment
Syntax
()
Description
Return the vertical alignment of a box attached to a page or character.
Return Value
1 Top
2 Center
4 Bottom
6 Baseline
7 Full
any:=?BoxVerticalAlignTo
Syntax
()
Description
Return the alignment of a box to the margins.
Return Value
1 Aligned to margins
2 Fixed position
any:=?BoxVerticalOffset
Syntax
()
Description
Return the vertical position of a box relative to an alignment point in WordPerfect units (1200ths of an inch).
any:=?BoxWidth
Syntax
()
Description
Return the width of a graphics box.
Return Value
If the width is Auto, the value is 2. Otherwise, the value is in WordPerfect units.
any:=?BoxWrapping
Syntax
()
Description
Return the direction of text wrapping around a box.
Return Value
0 Largest side
1 Left side
2 Right side
3 Neither side
8 Both sides
9 Columnar
15 No wrapping
any:=?BoxWrappingType
Syntax
()
Description
Return whether the text outside a box wraps around an image.
Return Value
4 Not contoured
5 Contoured
boolean:=?ButtonBarActive
Syntax
()
Description
Return True if the toolbar is active, False if not.