Insert a [Hd Back Tab] code at the insertion point. This code will move the current line of text left one tab from the insertion point.
Backup
Syntax
Backup([State As _Backup_State_enum]) As Boolean
Description
Turn Timed Document Backup on or off and return the current state.
Return Value
Returns True if Timed Document Backup is on, False if not. If the State parameter is omitted, its current value is returned. If it is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) Off!
On!
BackupMinutes
Syntax
BackupMinutes(Minutes As Integer)
Description
Specify the number of minutes between timed backups.
Parameters
Minutes: numeric Number of minutes between timed backups.
BackupOriginalDoc
Syntax
BackupOriginalDoc(State As _BackupOriginalDoc_State_enum)
Description
Turn Original Document Backup on or off.
Parameters
State: enumeration Off!
On!
BarcodeDlg
Syntax
BarcodeDlg()
Description
Display the POSTNET Barcode dialog box.
BarcodePOSTNET
Syntax
BarcodePOSTNET(Zip As String, [State As _BarcodePOSTNET_State_enum])
Description
Specify a ZIP Code or merge field containing a ZIP Code.
Parameters
Zip: string A five, nine, or eleven-digit ZIP Code. If the ZIP Code is in a merge field, the parameter can be a string that specifies the field.
State: enumeration (optional) Enable a merge field to provide a ZIP Code. Required only when a merge field is specified in the ZIP parameter.
MergeFieldAllowed!
BaselinePlacement
Syntax
BaselinePlacement(State As _BaselinePlacement_State_enum)
Description
Turn the Baseline placement for typesetting option on or off.
Parameters
State: enumeration Off!
On!
Binding
Syntax
Binding(Edge As _Binding_Edge_enum, Offset As Integer)
Description
Specify a binding offset for a specified paper edge. Use this method to specify two-sided document settings. This method inserts a [Binding Width] code at the beginning of the current page.
Parameters
Edge: enumeration BottomEdge!
LeftEdge!
RightEdge!
TopEdge!
Offset: measurement Amount of binding offset.
BindingOptionsDlg
Syntax
BindingOptionsDlg()
Description
Display the Print dialog box with the Two-Sided Printing tab active.
BlockProtect
Syntax
BlockProtect([State As _BlockProtect_State_enum]) As Boolean
Description
Turn Block Protect on or off.
Parameters
State: enumeration Off!
On!
BlockProtectToggle
Syntax
BlockProtectToggle()
Description
Toggle Block Protect on or off. You must select objects or text in order to block protect them.
BoldKey
Syntax
BoldKey()
Description
Toggle Bold on or off at the insertion point.
BookmarkBlock
Syntax
BookmarkBlock([Name As String])
Description
Find and select a specified bookmark. If the type of the specified bookmark is not selected, the insertion point is moved to the bookmark and select mode is activated, but nothing is selected.
Parameters
Name: string (optional)
BookmarkCreate
Syntax
BookmarkCreate(Name As String, [Selected As _BookmarkCreate_Selected_enum])
Description
Create a bookmark.
Parameters
Name: string
Selected: enumeration (optional) No!
Yes!
BookmarkDelete
Syntax
BookmarkDelete([Name As String])
Description
Delete a specified bookmark.
Parameters
Name: string (optional)
BookmarkDlg
Syntax
BookmarkDlg()
Description
Display the Bookmark dialog box.
BookmarkFind
Syntax
BookmarkFind([Name As String])
Description
Find a specified bookmark.
Parameters
Name: string (optional)
BookmarkMove
Syntax
BookmarkMove([Name As String])
Description
Move a bookmark to the insertion point.
Parameters
Name: string (optional)
BookmarkRename
Syntax
BookmarkRename(OldName As String, NewName As String)
Description
Rename a bookmark.
Parameters
OldName: string
NewName: string
BorderBottomLine
Syntax
BorderStyleCopy(Style, [FromLibrary As _BorderStyleCopy_FromLibrary_enum], [ToLibrary As _BorderStyleCopy_ToLibrary_enum], [DestName As String])
Description
Specify the style of a bottom border line. Precede with BorderStyleCreate() or BorderStyleEdit(), and end with BorderStyleEnd(). You must pass the numeric value which corresponds to the style.
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Example
In the following example, a text box is created. All sides of the border have the 'HeavyDoubleLine' style. The PS object references the PerfectScript class.
BorderColor([ColorName As String], [Red As Integer], [Green As Integer], [Blue As Integer], [Shade As Integer])
Description
Specify the color of a graphics box, paragraph, page, or column border. Empty parameters use current program settings. Precede with BorderStyleCreate() or BorderStyleEdit() and BorderUseBorderColor(), and end with BorderStyleEnd(). The values of a selected color are displayed in the Define Color Printing Palette dialog box.
Parameters
ColorName: string (optional) This parameter has been left in for backward compatibility with previous versions of WordPerfect. To specify a color in WordPerfect 8, use the Red, Green, and Blue parameters.
Red: numeric (optional) Value: 0-255.
Green: numeric (optional) Value: 0-255.
Blue: numeric (optional) Value: 0-255.
Shade: numeric (optional) Percent: 0-100.
Example
In the following example, a text box is created. All sides of the border have the 'HeavyDoubleLine' style. The color of the border is set to 'Red'. The PS object references the PerfectScript class.
Radius: measurement Higher measurements produce more rounded corners.
BorderDropShadow
Syntax
Sub BorderDropShadow([Location As _BorderDropShadow_Location_enum], [Size As Integer], [ColorName As String], [Red As Integer], [Green As Integer], [Blue As Integer], [Shade As Integer], [VerticalSize As Integer])
Description
Specify the location, size, and color of a border shadow. The values of a selected color are displayed in the Define Color Printing Palette dialog box.
Parameters
Location: enumeration (optional) NoShadow!
UpperLeft!
LowerLeft!
LowerRight!
UpperRight!
Size: measurement (optional) Default: .125"
ColorName: string (optional) This parameter has been left in for backward compatibility with previous versions of WordPerfect. To specify a color in WordPerfect 10, use the Red, Green, and Blue parameters.
Red: numeric (optional) Value: 0-255.
Green: numeric (optional) Value: 0-255.
Blue: numeric (optional) Value: 0-255.
Shade: numeric (optional) Percent: 0-100.
VerticalSize: numeric (optional) The vertical size
BorderInsideSpacing
Syntax
BorderInsideSpacing([Bottom As Integer], [Left As Integer], [Right As Integer], [Top As Integer])
Description
Specify the inside border spacing. Not available for page borders. Precede with BorderStyleCreate() or BorderStyleEdit() and follow with BorderStyleEnd().
Parameters
Bottom: measurement (optional) Specify spacing between the bottom of the text and border.
Left: measurement (optional) Specify spacing between the left side of the text and the border.
Right: measurement (optional) Specify spacing between the right side of the text and the border.
Top: measurement (optional) Specify the spacing between the top of the text and the border.
BorderLeftLine
Syntax
BorderLeftLine(Style)
Description
Specify the left line style of a border. You must pass the numeric value that corresponds to the style.
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Example
In the following example, a text box is created. All sides of the border have the 'HeavyDoubleLine' style. The PS object references the PerfectScript class.
BorderOutsideSpacing(Left As Integer, Right As Integer, Top As Integer, Bottom As Integer)
Description
Specify the outside border spacing.
Parameters
Left: measurement Specify the amount of space to the left of the border.
Right: measurement Specify the amount of space to the right of the border.
Top: measurement Specify the amount of space above the top of the border.
Bottom: measurement Specify the amount of space below the bottom of the border.
BorderRightLine
Syntax
BorderRightLine(Style)
Description
Specify a right line border style.
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Example
In the following example, a text box is created. All sides of the border have the 'HeavyDoubleLine' style. The PS object references the PerfectScript class.
DestName: string (optional) The new name for a style.
BorderStyleCreate
Syntax
BorderStyleCreate(Style As String, [Library As _BorderStyleCreate_Library_enum])
Description
Create a new border style. After you have finished setting the attributes of the border, you must call BorderStyleEnd().
Parameters
Style: string The name of the new style.
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
Example
In the following example, a new border style is created called 'One'. After the attributes are defined,.BorderStyleEnd() is called. The PS object references the PerfectScript class.
BorderStyleDelete(Style, [Library As _BorderStyleDelete_Library_enum])
Description
Deletes a border style. You have to pass the numeric value of the border style.
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
BorderStyleEdit
Syntax
BorderStyleEdit(Style, [Library As _BorderStyleEdit_Library_enum])
Description
Specify a border style to edit. You have to pass the numeric value that corresponds to the style After all the changes are implemented, you must call BorderStyleEnd().
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
Example
In the following example, the border style 'One' is amended. After the changes are implemented,.BorderStyleEnd() is called. The PS object references the PerfectScript class.
PS.BoxCreate 2
PS.BorderStyleEdit One PersonalLibrary BorderStyleCreate Library
PS.BorderBottomLine 11
PS.BorderTopLine 11
PS.BorderRightLine 11
PS.BorderLeftLine 11
PS.BorderStyleEnd Save_BorderStyleEnd_State
PS.BoxEnd Save_BoxEnd_State
BorderStyleEnd
Syntax
BorderStyleEnd(State As _BorderStyleEnd_State_enum)
Description
Exit border style create or edit mode with or without saving changes. Precede this method with BorderStyleCreate() or BorderStyleEdit().
Parameters
State: enumeration Cancel!
Save!
Example
In the following example, the border style 'One' is amended. After the changes are implemented,.BorderStyleEnd() is called. The PS object references the PerfectScript class.
Rename a user-defined border style. Precede with BorderStyleEdit().
Parameters
Style: string
BorderStyleRetrieve
Syntax
BorderStyleRetrieve(Filename As String, FromLibrary As _BorderStyleRetrieve_FromLibrary_enum)
Description
Retrieve all border graphics styles from the specified document or template and add to the specified style list.
Parameters
Filename: string The path and filename of a document or template containing the styles to retrieve.
FromLibrary: enumeration The destination for the retrieved styles. Use CurrentDoc! to add the styles to the current document style list. Use PersonalLibrary! to add the styles to the default template style list. Use SharedLibrary! to add the styles to the additional objects template style list. If an additional objects template is not specified in Files Preferences and SharedLibrary! is used here, the method does nothing.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
BorderStyleSave
Syntax
BorderStyleSave(Filename As String, Library As _BorderStyleSave_Library_enum)
Description
Save border styles to a specified library.
Parameters
Filename: string The full path required.
Library: enumeration CurrentDoc!
PersonalLibrary!
SharedLibrary!
BorderTopLine
Syntax
BorderTopLine(Style)
Description
Specify the top-line style of a border. Precede with BorderStyleCreate() or BorderStyleEdit() and end with BorderStyleEnd(). You must pass the numeric value that corresponds to the style.
Parameters
Style: any Use a string for user-defined styles.
ButtonBottomRightLine!
ButtonTopLeftLine!
DashedLine!
DottedLine!
DoubleLine!
ExtraThickLine!
HeavyDoubleLine!
HeavySingleLine!
NoLine!
SingleLine!
TableDefaultLine!
ThickLine!
ThickThinLine!
ThinThickLine!
9
8
2
3
1
5
11
10
127
0
126
4
7
6
Example
In the following example, a text box is created. All sides of the border have the 'HeavyDoubleLine' style. The PS object references the PerfectScript class.
BorderUseBorderColor(State As _BorderUseBorderColor_State_enum)
Description
Specify whether the current border uses the line-style color or the border color. Precede with BorderStyleCreate() or BorderStyleEdit(), follow with BorderColor(), and end with BorderStyleEnd().
Parameters
State: enumeration No! = Use line style color
Yes! = Use border color
BoxAddText
Syntax
BoxAddText()
Description
Lets you add a text box to a shape.
BoxAttachTo
Syntax
BoxAttachTo(Anchor As _BoxAttachTo_Anchor_enum)
Description
Anchor a graphics box to a page, paragraph, or character. Precede with BoxCreate() or BoxEdit() and end with BoxEnd().
Parameters
Anchor: enumeration Character!
Page!
Paragraph!
BoxBackwardOne
Syntax
BoxBackwardOne()
Description
Move the selected object(s) back one layer. Precede with BoxCreate() or BoxEdit().
BoxBorder
Syntax
BoxBorder(Style)
Description
Specify a box border style. Precede with BoxCreate() or BoxEdit() and end with BoxEnd(). You have to pass the numeric value that corresponds to the border style.
Parameters
Style: any ButtonBorder!
ColumnBorderAll!
ColumnBorderBetween!
DashedBorder!
DottedBorder!
DoubleBorder!
ExtraThickBorder!
HeavyDoubleBorder!
HeavySingleBorder!
NoBorder!
SingleBorder!
SpacingOnly!
ThickBorder!
ThickThinBorder!
ThickTopBottomBorder!
ThinThickBorder! 0
12
11
3
4
2
6
14
13
127
1
0
5
8
9
7
Example
The following example demonstrates the border of a box being set to a 'HeavySingleBorder' style. The PS object references the PerfectScript class.
Call this method to insert a caption for a Box. Follow with PerfectScript methods such as KeyType() and BoxCaptionEditEnd().
Example
In the following example, a caption is inserted for the Box created. The style of the box caption corresponds to the 'Caption' style. You have to call BoxCaptionEdit(), define the caption style, type the caption and call BoxCaptionEditEnd(). The PS object references the PerfectScript class.
Call this method to end the process of inserting a caption for a box. Precede this method with BoxCaptionEdit() and KeyType(), which inserts the caption.
Example
In the following example, a caption is inserted for the Box created. The style of the box caption corresponds to the 'Caption' style. You have to call BoxCaptionEdit(), define the caption style, type the caption and call BoxCaptionEditEnd(). The PS object references the PerfectScript class.
SizeAuto: any To base the width on the current unit of measure, use a measurement expression. To base the width on a percent of the box width, use a number. To set the width automatically, use AutoWidth!.
BoxCaptionInitialStyle
Syntax
BoxCaptionInitialStyle(Style)
Description
Specify an initial caption style. You must pass the numeric value that corresponds to the style you want.
Parameters
Style: any NormalStyle!
FootnoteNumberInDocumentStyle!
EndnoteNumberInDocumentStyle!
FigureNumberStyle!
TableBoxNumberStyle!
TextBoxNumberStyle!
UserBoxNumberStyle!
EquationNumberStyle!
HypertextStyle!
ToC1Style!
ToC2Style!
ToC3Style!
ToC4Style!
ToC5Style!
Index1Style!
Index2Style!
ListStyle!
ToAStyle!
DocStyle!
BoxTextStyle!
CaptionStyle!
FootnoteStyle!
EndnoteStyle!
CommentStyle!
HeaderAStyle!
HeaderBStyle!
FooterAStyle!
FooterBStyle!
WatermarkAStyle!
WatermarkBStyle!AddressStyle!
ParagraphOutlnStyle!
OutlineStyle!
LegalOutlnStyle!
BulletsOutlnStyle!
HeadingsOutlnStyle!
Legal_2OutlnStyle!
NumbersOutlnStyle!
Level1Style!
Level2Style!
Level3Style!
Level4Style!
Level5Style!
Level6Style!
Level7Style!
Level8Style!
Legal1Style!
Legal2Style!
Legal3Style!
Legal4Style!
Legal5Style!
Legal6Style!
Legal7Style!
Legal8Style!
Heading1Style!
Heading2Style!
Heading3Style!
Heading4Style!
Heading5Style!
Heading6Style!
Heading7Style!
Heading8Style!
MonospacedStyle!
CustomHTMLStyle!
PreformattedStyle!
AddressStyle!
QuotationsOutlnStyle!
DefinitionsOutlnStyle!
Quotation1Style!
Quotation2Style!
Quotation3Style!
Quotation4Style!
Quotation5Style!
Quotation6Style!
Quotation7Style!
Quotation8Style!
Definition1Style!
Definition2Style!
Definition3Style!
Definition4Style!
Definition5Style!
Definition6Style!
Definition7Style!
Definition8Style!
Level9Style!
Legal9Style!
Heading9Style!
Quotation9Style!
DefinitionStyle! 0
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
111
112
113
114
115
Example
In the following example, a caption is inserted for the Box created. The style of the box caption corresponds to the 'Caption' style. You have to call BoxCaptionEdit(), ,define the caption style, type the caption and call BoxCaptionEditEnd(). The PS object references the PerfectScript class.
Specify a caption numbering style. Precede with BoxCreate() or BoxEdit() and end with BoxEnd(). You must pass the numeric value that corresponds to the style.
Parameters
Style: any NormalStyle!
FootnoteNumberInDocumentStyle!
EndnoteNumberInDocumentStyle!
FigureNumberStyle!
TableBoxNumberStyle!
TextBoxNumberStyle!
UserBoxNumberStyle!
EquationNumberStyle!
HypertextStyle!
ToC1Style!
ToC2Style!
ToC3Style!
ToC4Style!
ToC5Style!
Index1Style!
Index2Style!
ListStyle!
ToAStyle!
DocStyle!
BoxTextStyle!
CaptionStyle!
FootnoteStyle!
EndnoteStyle!
CommentStyle!
HeaderAStyle!
HeaderBStyle!
FooterAStyle!
FooterBStyle!
WatermarkAStyle!
WatermarkBStyle!AddressStyle!
ParagraphOutlnStyle!
OutlineStyle!
LegalOutlnStyle!
BulletsOutlnStyle!
HeadingsOutlnStyle!
Legal_2OutlnStyle!
NumbersOutlnStyle!
Level1Style!
Level2Style!
Level3Style!
Level4Style!
Level5Style!
Level6Style!
Level7Style!
Level8Style!
Legal1Style!
Legal2Style!
Legal3Style!
Legal4Style!
Legal5Style!
Legal6Style!
Legal7Style!
Legal8Style!
Heading1Style!
Heading2Style!
Heading3Style!
Heading4Style!
Heading5Style!
Heading6Style!
Heading7Style!
Heading8Style!
MonospacedStyle!
CustomHTMLStyle!
PreformattedStyle!
AddressStyle!
QuotationsOutlnStyle!
DefinitionsOutlnStyle!
Quotation1Style!
Quotation2Style!
Quotation3Style!
Quotation4Style!
Quotation5Style!
Quotation6Style!
Quotation7Style!
Quotation8Style!
Definition1Style!
Definition2Style!
Definition3Style!
Definition4Style!
Definition5Style!
Definition6Style!
Definition7Style!
Definition8Style!
Level9Style!
Legal9Style!
Heading9Style!
Quotation9Style!
DefinitionStyle! 0
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
111
112
Example
In the following example, a caption is inserted for the Box created. The caption numbering style corresponds to the 'normal' style You have to call BoxCaptionEdit(), ,define the caption style, type the caption and call BoxCaptionEditEnd(). The PS object references the PerfectScript class.
Sub BoxCaptionPosition(Side As _BoxCaptionPosition_Side_enum, Border As _BoxCaptionPosition_Border_enum, [Alignment As _BoxCaptionPosition_Alignment_enum], [AlignmentOffset])
Description
Specify the caption position.
Parameters
Side: enumeration Specify the side of the box on which the caption appears.
Bottom! 4
Left! 0
Right! 3
Top! 4
Border: enumeration Specify where the caption is in relation to the border.
InsideBorder! 1
OnBorder! 2
OutsideBorder! 0
Alignment: enumeration (optional) Specify the caption position.
Bottom! 4
Center! 2
Left! 0
Right! 3
Top! 4
AlignmentOffset: any (optional) Specify the alignment for the caption text.
BoxCaptionRotation
Syntax
BoxCaptionRotation(Rotation As _BoxCaptionRotation_Rotation_enum)
Description
Rotate the captions. Precede with a methods such as BoxCreate() and BoxUpdateDisplay(), and end with BoxEnd().
Parameters
Rotation: enumeration Degrees180!
Degrees270!
Degrees90!
None!
BoxChangeLineHeight
Syntax
BoxChangeLineHeight(State As _BoxChangeLineHeight_State_enum)
Description
Specify whether line height changes when a box is attached to a character. Default: Yes!
Parameters
State: enumeration No!
Yes!
BoxChangeStyle
Syntax
BoxChangeStyle(BoxType)
Description
You can change the style of the box. You must pass the numeric value that corresponds to the style. After you have set the attributes of the box, you must call BoxEnd().
Parameters
BoxType: any Enclose user-defined styles in quotation marks.
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
5
4
0
7
127
1
2
3
6
Example
In the following example, the style of the box is changed to 'WatermarkImageBox', therefore the value 6 must be passed. The method BoxImageRetrive() is called which sets the watermark's image. In this case, the image is a bitmap called 'rideau1'.
Create and edit graphics box contents. Follow with the methods that furnish the box contents.
BoxContentPosition
Syntax
BoxContentPosition(Horizontal As _BoxContentPosition_Horizontal_enum, Vertical As _BoxContentPosition_Vertical_enum)
Description
You can position the box contents inside the box.
Parameters
Horizontal: enumeration Center!
Left!
Right!
Vertical: enumeration Bottom!
Center!
Top!
BoxContentPreserveAspectRatio
Syntax
BoxContentPreserveAspectRatio(State As _BoxContentPreserveAspectRatio_State_enum)
Description
Preserve the image width/height ratio when the box changes.
Parameters
State: enumeration No!
Yes!
BoxContentType
Syntax
BoxContentType(Content As _BoxContentType_Content_enum)
Description
Specify the graphics box content type.
Parameters
Content: enumeration Empty!
Equation!
External!
Image!
LinkedText!
Macro!
Presentation!
Text!
Video!
BoxCounter
Syntax
BoxCounter(CounterName)
Description
Assign a new counter to the current box or box style. You must pass the numeric value that corresponds to the style.
Parameters
CounterName: any EquationCounter!
FigureCounter!
None!
TableBoxCounter!
TextBoxCounter!
UserBoxCounter! 5
1
0
2
3
4
BoxCreate
Syntax
BoxCreate(BoxType)
Description
You can use this method to create a graphic box. You have to call BoxEnd() after you have set the attributes of the box. You must pass the numeric value that corresponds to the style.
Parameters
BoxType: any ButtonBox!
EquationBox!
FigureBox!
InLineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox! 5
4
0
7
127
1
2
3
6
Example
In the following example, the style of the new box is 'WatermarkImageBox', therefore the value 6 must be passed. The method BoxImageRetrive() is called which sets the watermark's image. In this case, the image is a bitmap called 'rideau1'. Afer all attributes are set, BoxEnd() is called.
Specify the counter name and number of a graphics box to edit. You must pass the numeric value that corresponds to the CounterName.
Parameters
CounterName: any EquationCounter!
FigureCounter!
None!
TableBoxCounter!
TextBoxCounter!
UserBoxCounter! 5
1
0
2
3
4
CounterLevelNumber: numeric (optional) Repeat for each counter level.
BoxEditNext
Syntax
BoxEditNext([BoxType As _BoxEditNext_BoxType_enum]
Description
Begin the editing methods for the next box or a specified box type. Follow with box-editing methods and BoxEnd().
Parameters
BoxType: enumeration (optional) Default: box after the insertion point, regardless of type.
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
BoxEditPrevious
Syntax
BoxEditPrevious([BoxType As _BoxEditPrevious_BoxType_enum])
Description
Begin the editing methods for the previous box or a specified box type.
Parameters
BoxType: enumeration (optional) Default: box immediately before the insertion point, regardless of type.
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
BoxEnd
Syntax
BoxEnd([State As _BoxEnd_State_enum], [BoxOptionsBar As _BoxEnd_BoxOptionsBar_enum])
Description
Save the editing changes to a graphics box and display or hide the Graphics Box Property Bar.
Parameters
State: enumeration (optional) Cancel!
Save!
BoxOptionsBar: enumeration (optional) Display or hide the Graphics Property Bar.
DontHide!
Hide!
Example
In the following example, the style of the new box is 'WatermarkImageBox', therefore the value 6 must be passed. The method BoxImageRetrive() is called which sets the watermark's image. In this case, the image is a bitmap called 'rideau1'. Afer all attributes are set, BoxEnd() is called. The PS object references the PerfectScipt class.
BoxEquationColor([ColorName As String], [Red As Integer], [Green As Integer], [Blue As Integer], [Shade As Integer])
Description
Specify a box equation color and shading value. Precede with BoxCreate() or BoxEdit() and end with BoxEnd().
Parameters
ColorName: string (optional) This parameter has been left in for backward compatability with previous versions of WordPerfect. To specify a color in WordPerfect 8, use the Red, Green, and Blue parameters.
Red: numeric (optional) Value: 0-255.
Green: numeric (optional) Value: 0-255.
Blue: numeric (optional) Value: 0-255.
Shade: numeric (optional) Percent: 0-100.
BoxEquationDefaultFont
Syntax
BoxEquationDefaultFont(FontSize)
Description
Specify a default font and size.
Parameters
FontSize: any DefaultSize! - 0
BoxEquationFilename
Syntax
BoxEquationFilename(Filename As String)
Description
Specify the name of an equation file and designate the box contents as an equation. To retrieve an equation file, use FileOpen.
Parameters
Filename: string The name of the equation file.
BoxEquationFont
Syntax
BoxEquationFont(FontName As String, [FontSize As Integer], [Family As _BoxEquationFont_Family_enum], [Attributes As _BoxEquationFont_Attributes_enum], [Weight As _BoxEquationFont_Weight_enum], [Width As _BoxEquationFont_Width_enum], [Source As _BoxEquationFont_Source_enum], [Type As _BoxEquationFont_Type_enum], [CharacterSet As _BoxEquationFont_CharacterSet_enum])
Description
Specify an equation font. Use with BoxEquationFontSize().
Parameters
FontName: string The name of the font.
FontSize: measurement (optional) The point size of the font.
Zoom: numeric (optional) Amount to reduce or enlarge equation display.
BoxEquationSaveAsGraphic
Syntax
BoxEquationSaveAsGraphic(Filename As String, [Format As _BoxEquationSaveAsGraphic_Format_enum])
Description
Save an equation box as a graphics file.
Parameters
Filename: string Name for the graphics file.
Format: enumeration (optional) Default: current graphics format.
Presentations_20!
WordPerfectGraphic_10!
WordPerfectGraphic_20!
BoxFill
Syntax
BoxFill(FillStyleName)
Description
Select a box fill style.
Parameters
FillStyleName: any Fill10 0
Fill20 1
Fill30 2
Fill40 3
Fill50 4
Fill60 5
Fill70 6
Fill80 7
Fill90 8
Fill100 9
FillButton 10
Fill5 11
NoFill 127
BoxForwardOne
Syntax
BoxForwardOne()
Description
Move the selected object(s) forward one layer.
BoxHeight
Syntax
BoxHeight(Height)
Description
Specify the box height according to the height of box contents or a fixed measurement.
Parameters
Height: any Lets you specify whether the height of the box is determined by the height of the box contents or by a minimum box height.
AutoHeight!
MinHeight!
BoxHorizontalAlignment
Syntax
BoxHorizontalAlignment(Alignment As _BoxHorizontalAlignment_Alignment_enum, Position As _BoxHorizontalAlignment_Position_enum, [Offset As Integer], [LeftColumn As Integer], [RightColumn As Integer])
Description
Specify the alignment of a box attached to a page or paragraph.
Parameters
Alignment: enumeration AlignColumns!
AlignMargins!
Position: enumeration The horizontal position after alignment to margins or columns.
Center!
FullAlign!
Left!
Right!
Offset: measurement (optional) The image position relative to the alignment point. Left is a negative number, right is positive
LeftColumn: numeric (optional) Use when a box aligns to columns.
RightColumn: numeric (optional) Use when a box aligns to columns.
BoxHorizontalPosition
Syntax
BoxHorizontalPosition(Position As Integer)
Description
Specify the horizontal position of a box relative to the left edge of the page.
Parameters
Position: measurement Specify how far the box should be from the left edge of the page.
BoxImageBlackWhiteThreshold
Syntax
BoxImageBlackWhiteThreshold(Threshold As Integer)
Description
Specify the point at which colors and/or grays in the current image convert to black and white.
Parameters
Threshold: numeric Value: 1-255. Values below the threshold convert to black, those above convert to white. Default: 127.
BoxImageBrightness
Syntax
BoxImageBrightness(Amount As Double)
Description
Adjust the brightness (saturation) of a color or black and white image.
Parameters
Amount: numeric Value: -1.0 to 1.0. Black: -1.0. White: 1.0.
BoxImageContrast
Syntax
BoxImageContrast(Contrast As Double)
Description
Specify the contrast between light and dark areas of an image.
Parameters
Contrast: numeric Value: -1.0 to 1.0. Slight: -1.0. Strong: 1.0.
BoxImageDitherMethod
Syntax
BoxImageDitherMethod(Method As _BoxImageDitherMethod_Method_enum, Source As _BoxImageDitherMethod_Source_enum)
Description
Specify a dither method and source.
Parameters
Method: enumeration Default!
ErrorDiffusionDither!
Halftoning!
OrderedDither!
Source: enumeration Default!
External!
Printer!
WordPerfect!
BoxImageFill
Syntax
BoxImageFill(ImageFillType As _BoxImageFill_ImageFillType_enum)
Description
Specify an image fill type. Images can have normal fill, no fill, or white fill.
Parameters
ImageFillType: enumeration Normal!
Transparent!
White!
BoxImageFlipX
Syntax
BoxImageFlipX(State As _BoxImageFlipX_State_enum)
Description
Flip an image box on its X (horizontal) axis, turning the image upside down.
Parameters
State: enumeration No!
Yes!
BoxImageFlipY
Syntax
BoxImageFlipY(State As _BoxImageFlipY_State_enum)
Description
Reverse an image box on its Y (vertical) axis, turning the image from side to side.
Parameters
State: enumeration No!
Yes!
BoxImageHalfToneOptions
Syntax
BoxImageHalfToneOptions(HalfTone As _BoxImageHalfToneOptions_HalfTone_enum, [LPI As Double], [Plane0 As Double], [Plane1 As Double], [Plane2 As Double], [Plane3 As Double])
Description
Specify the default or user-defined halftone values for the current printer.
Parameters
HalfTone: enumeration DefaultValues!
SetValues!
LPI: numeric (optional) The number of lines per inch for user-defined values.
Plane0: numeric (optional) The first halftone angle for user-defined values.
Plane1: numeric (optional) The second halftone angle for user-defined values.
Plane2: numeric (optional) The third halftone angle for user-defined values.
Plane3: numeric (optional) The fourth halftone angle for user-defined values.
BoxImageInvertColors
Syntax
BoxImageInvertColors(State As _BoxImageInvertColors_State_enum)
Description
Convert the image colors to their complements.
Parameters
State: enumeration No!
Yes!
BoxImageMonochrome
Syntax
BoxImageMonochrome(State As _BoxImageMonochrome_State_enum)
Description
Convert a color image to black and white, and specify the threshold for blackness.
Parameters
State: enumeration No!
Yes!
BoxImageMove
Syntax
BoxImageMove(XPosition As Double, YPosition As Double)
Description
Move an image within a box.
Parameters
XPosition: numeric The horizontal position. Value: -5.0 to 5.0. Default: 0 (centered).
YPosition: numeric The vertical position. Value: -5.0 to 5.0. Default: 0 (centered).
BoxImageRetrieve
Syntax
BoxImageRetrieve(Action As _BoxImageRetrieve_Action_enum, Filename As String, [FileFormat As _BoxImageRetrieve_FileFormat_enum])
Description
Retrieve an image.
Parameters
Action: enumeration LeaveExternal!
MakeInternal!
UseInternal!
Filename: string Specify the filename of the image you want to insert into the box.
BoxImageSave(Filename As String, Format As _BoxImageSave_Format_enum)
Description
Save an image, and optionally rename it and specify a graphics format.
Parameters
Filename: string Specify a filename for the newly saved graphic.
Format: enumeration Presentations_20!
WordPerfectGraphic_10!
WordPerfectGraphic_20!
BoxImageScaling
Syntax
BoxImageScaling(XScale As Double, YScale As Double)
Description
Scale an image within a box.
Parameters
XScale: numeric The image width. Value: 0.01 to 9.99. Default: 1.0.
YScale: numeric The image height. Value: 0.01 to 9.99. Default: 1.0.
BoxImageShowBackground
Syntax
BoxImageShowBackground(State As _BoxImageShowBackground_State_enum)
Description
Display the background colors or gradient saved with an image.
Parameters
State: enumeration No!
Yes!
BoxInitialStyleDlg
Syntax
BoxInitialStyleDlg()
Description
Display the Text Box Initial Style dialog box. Specify a box before this method.
BoxOLEEditObject
Syntax
BoxOLEEditObject()
Description
Edit the graphics box contents with the OLE server.
BoxOverlap
Syntax
BoxOverlap(State As _BoxOverlap_State_enum)
Description
Allow a box to overlap other boxes. Precede with BoxCreate() or BoxEdit() and follow with BoxEnd(). This method takes effect only for boxes that are attached to a page or a paragraph.
Parameters
State: enumeration No!
Yes!
BoxPosDlg
Syntax
BoxPosDlg()
Description
Display the Box Position dialog box.
BoxResetBorder
Syntax
BoxResetBorder()
Description
Reset the border values for the current box to the values of the corresponding box style. For example, border changes made to a specific figure box reset to the default border values assigned to the Figure Box style. Precede with BoxCreate() or BoxEdit() and end with BoxEnd().
BoxResetCaption
Syntax
BoxResetCaption()
Description
Reset the caption values for the current box to the caption values of the corresponding box style. For example, caption changes made to a specific text box are reset to the default caption values assigned to the Text Box style. Precede with BoxEdit() and end with BoxEnd().
BoxResetContent
Syntax
BoxResetContent()
Description
Reset the content values for the current box to the content values of the corresponding box style. For example, content changes made to a specific user box are reset to the values assigned to the User Box style. Precede with BoxEdit() and end with BoxEnd().
BoxResetContentRender
Syntax
BoxResetContentRender()
Description
Reset the content render values for the current box to the values of the corresponding box style. For example, content render changes made to a specific equation box are reset to the default content render values assigned to the Equation Box style.
BoxResetCounter
Syntax
BoxResetCounter()
Description
Reset the counter values for the current box to the values of the corresponding box style. For example, counter changes made to an equation box are reset to the default counter values of the Equation Box style.
BoxResetFill
Syntax
BoxResetFill()
Description
Reset the fill values for the current box to the values of the corresponding box style. For example, fill style changes made to a figure box are reset to the fill values of the Figure Box style.
BoxResetPosition
Syntax
BoxResetPosition()
Description
Reset the position values for the current box to the position values for the corresponding box style. For example, position changes made to a figure box are reset to default position values of the Figure Box style.
BoxResetTextFlow
Syntax
BoxResetTextFlow()
Description
Reset the text-wrapping values for the current box to the values of the corresponding box style. For example, text-wrapping changes made to a user box are reset to the text-flow values of the User Box style.
BoxSaveLookAsStyle
Syntax
BoxSaveLookAsStyle(Style As String, Library As _BoxSaveLookAsStyle_Library_enum)
Description
Save the settings for the current box as a style. This method must be preceded by BoxCreate(), BoxEdit(), BoxEditByCounter(), BoxEditNext(), or BoxEditPrevious(), and followed by BoxEnd().
Parameters
Style: string Specify the name of the box style.
Library: enumeration CurrentDoc!
PersonalLibrary!
SharedLibrary!
BoxStaysOnPage
Syntax
BoxStaysOnPage(State As _BoxStaysOnPage_State_enum)
Description
Specify whether a graphics box is allowed to move with the surrounding text. Although you may use BoxStaysOnPage to set this option for boxes that are attached to a paragraph or character, it takes effect only for boxes that are attached to a page. This method must be preceded by BoxCreate(), BoxEdit(), BoxEditByCounter(), BoxEditNext(), or BoxEditPrevious(), and followed by BoxEnd().
Parameters
State: enumeration No!
Yes!
BoxStyleCopy
Syntax
BoxStyleCopy(Style, FromLibrary As _BoxStyleCopy_FromLibrary_enum, ToLibrary As _BoxStyleCopy_ToLibrary_enum, [DestName As String])
Description
Copy a box style from one library to another and/or rename the style.
Parameters
Style: any FigureBox 0
TableBox 1
TextBox 2
UserBox 3
EquationBox 4
ButtonBox 5
WatermarkImageBox 6
InlineEquationBox 7
NoBox 127
FromLibrary: enumeration CurrentDocument!
PersonalLibrary!
SharedLibrary!
ToLibrary: enumeration CurrentDocument!
PersonalLibrary!
SharedLibrary!
DestName: string (optional) Specify a new name for the style.
BoxStyleCreate
Syntax
BoxStyleCreate(Style, [Library As _BoxStyleCreate_Library_enum])
Description
Create a box style and specify the library where it resides.
Parameters
Style: any Specify a name for the new box style.
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
BoxStyleDelete
Syntax
BoxStyleDelete(Style, [Library As _BoxStyleDelete_Library_enum])
Description
Delete a user-defined box style.
Parameters
Style: any FigureBox 0
TableBox 1
TextBox 2
UserBox 3
EquationBox 4
ButtonBox 5
WatermarkImageBox 6
InlineEquationBox 7
NoBox 127
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
BoxStyleEdit
Syntax
BoxStyleEdit(Style, [Library As _BoxStyleEdit_Library_enum])
Description
Begin box style editing.
Parameters
Style: any Enclose user-defined styles in quotation marks.
ButtonBox!
EquationBox!
FigureBox!
InlineEquationBox!
NoBox!
TableBox!
TextBox!
UserBox!
WatermarkImageBox!
5
4
0
7
127
1
2
3
6
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
BoxStyleEnd
Syntax
BoxStyleEnd(State As _BoxStyleEnd_State_enum)
Description
Exit the graphics style create or edit mode with or without saving changes. Precede this method with BoxStyleCreate() or BoxStyleEdit().
Parameters
State: enumeration Cancel!
Save!
BoxStyleName
Syntax
BoxStyleName(StyleName As String)
Description
Specify a box style name. Precede with BoxStyleCreate().
Parameters
StyleName: string Type in a name for the new box style.
BoxStyleRetrieve
Syntax
BoxStyleRetrieve(Filename As String, Library As _BoxStyleRetrieve_Library_enum)
Description
Retrieve all box graphics styles from the specified document or template and add to the specified style list.
Parameters
Filename: string The path and filename of a document or template containing the styles to retrieve.
Library: enumeration Destination for the retrieved styles. Use CurrentDoc! to add the styles to the current document style list. Use PersonalLibrary! to add the styles to the default template style list. Use SharedLibrary! to add the styles to the additional objects template style list. If an additional objects template is not specified in Files Preferences, and SharedLibrary! is used here, the method does nothing.
CurrentDoc!
PersonalLibrary!
SharedLibrary! Not used.
BoxStyleSave
Syntax
BoxStyleSave(Filename As String, Library As _BoxStyleSave_Library_enum)
Description
Save all styles in the current document or a specified style library to another style library, replacing all styles already in it.
Parameters
Filename: string The style library to save to.
Library: enumeration The current style location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
BoxTextAngle
Syntax
BoxTextAngle(Angle As _BoxTextAngle_Angle_enum)
Description
Rotate the text in a text box.
Parameters
Angle: enumeration Degrees180!
Degrees270!
Degrees90!
None!
BoxTextDefaultStyle
Syntax
BoxTextDefaultStyle(Style)
Description
Specify the default text box style. You must pass the numeric value that corresponds to the style.
Parameters
Style: any NormalStyle!
FootnoteNumberInDocumentStyle!
EndnoteNumberInDocumentStyle!
FigureNumberStyle!
TableBoxNumberStyle!
TextBoxNumberStyle!
UserBoxNumberStyle!
EquationNumberStyle!
HypertextStyle!
ToC1Style!
ToC2Style!
ToC3Style!
ToC4Style!
ToC5Style!
Index1Style!
Index2Style!
ListStyle!
ToAStyle!
DocStyle!
BoxTextStyle!
CaptionStyle!
FootnoteStyle!
EndnoteStyle!
CommentStyle!
HeaderAStyle!
HeaderBStyle!
FooterAStyle!
FooterBStyle!
WatermarkAStyle!
WatermarkBStyle!AddressStyle!
ParagraphOutlnStyle!
OutlineStyle!
LegalOutlnStyle!
BulletsOutlnStyle!
HeadingsOutlnStyle!
Legal_2OutlnStyle!
NumbersOutlnStyle!
Level1Style!
Level2Style!
Level3Style!
Level4Style!
Level5Style!
Level6Style!
Level7Style!
Level8Style!
Legal1Style!
Legal2Style!
Legal3Style!
Legal4Style!
Legal5Style!
Legal6Style!
Legal7Style!
Legal8Style!
Heading1Style!
Heading2Style!
Heading3Style!
Heading4Style!
Heading5Style!
Heading6Style!
Heading7Style!
Heading8Style!
MonospacedStyle!
CustomHTMLStyle!
PreformattedStyle!
AddressStyle!
QuotationsOutlnStyle!
DefinitionsOutlnStyle!
Quotation1Style!
Quotation2Style!
Quotation3Style!
Quotation4Style!
Quotation5Style!
Quotation6Style!
Quotation7Style!
Quotation8Style!
Definition1Style!
Definition2Style!
Definition3Style!
Definition4Style!
Definition5Style!
Definition6Style!
Definition7Style!
Definition8Style!
Level9Style!
Legal9Style!
Heading9Style!
Quotation9Style!
DefinitionStyle! 0
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
111
112
113
114
115
Example
In the following example, a Textbox is created. The style used in 'NormalStyle', therefore the value 0 must be passed. after the bos is created BoxEnd() is called.
'**** Create a Text Box
PS.BoxCreate 2
PS.BoxTextDefaultStyle 0
PS.BoxEnd Save_BoxEnd_State
BoxTextEdit
Syntax
BoxTextEdit()
Description
Begin the text box-editing methods. Follow with methods that modify box contents such as KeyType(), and complete the process by calling BoxTextEditEnd().
Example
In the following example, a Text Box is created. The string "Hello There" is inserted into the text box. The PS object references the PerfectScript class.
'***** Create a TextBox
PS.BoxCreate 2
PS.BoxTextDefaultStyle 0
PS.BoxTextEdit
PS.KeyType "Hello There"
PS.BoxTextEditEnd
PS.BoxEnd Save_BoxEnd_State
BoxTextEditEnd
Syntax
BoxTextEditEnd()
Description
End the text box-editing methods. Precede with BoxTextEdit() and methods such as KeyType().
Example
In the following example, a Text Box is created. The string "Hello There" is inserted into the text box. The PS object references the PerfectScript class.
'***** Create a TextBox
PS.BoxCreate 2
PS.BoxTextDefaultStyle 0
PS.BoxTextEdit
PS.KeyType "Hello There"
PS.BoxTextEditEnd
PS.BoxEnd Save_BoxEnd_State
BoxTextFilename
Syntax
BoxTextFilename(Filename As String)
Description
Specify a file to insert into a text box.
Parameters
Filename: string Name of the file to insert into the text box.
BoxTextFlow
Syntax
BoxTextFlow(Wrap As _BoxTextFlow_Wrap_enum)
Description
Specify the side(s) of a box to wrap text around.
Parameters
Wrap: enumeration BothSides!
Columnar!
LargestSide!
LeftSide!
NeitherSide!
NoWrapping!
RightSide!
BoxTextFlowContour
Syntax
BoxTextFlowContour()
Description
Contour the text outside a box to the shape of an image inside the box.
BoxTextFlowSquare
Syntax
BoxTextFlowSquare()
Description
Contour the text outside a box evenly around all sides of the box. Precede with BoxTextFlowContour.
BoxToBack
Syntax
BoxToBack()
Description
Move the selected object(s) to the back.
BoxToFront
Syntax
BoxToFront()
Description
Move the selected object(s) to the front.
BoxUpdateDisplay
Syntax
BoxUpdateDisplay()
Description
Update the appearance of a box after editing changes. This method must be preceded by BoxCreate(), BoxEdit(), BoxEditByCounter(), BoxEditNext(), or BoxEditPrevious(), and followed by BoxEnd().
Example
In the following example a watermark box is created. This method is called after the image is inserted. The PS object references the PerfectScript class.
BoxVerticalAlignment(Alignment As _BoxVerticalAlignment_Alignment_enum, [Offset])
Description
Align a box with the page or character it is attached to. This method is not valid with paragraph-attached boxes. Precede with BoxCreate() or BoxEdit() and follow with BoxEnd().
Parameters
Alignment: enumeration Top!
Center!
Bottom!
Baseline!
FullAlign!
BaseOffset!
ForceLeftMargin!
ForceRightMargin!
CenteredOnBaseline!
BottomOnBottom!
Offset: any (optional) Lets you specify how much to move the box in relation to the text to which it is attached.
BoxVerticalPosition
Syntax
BoxVerticalPosition(Alignment)
Description
Specify the vertical position of a box attached to a page or paragraph. For example, the distance from the top of the page (or top margin) to the top of the box. Not valid for boxes attached to characters.
Parameters
Alignment: any Specify how much space should be between the box and the top of the page or margin.
BoxWidth
Syntax
BoxWidth(Width)
Description
Base the box width on the width of box contents, or specify a fixed measurement.
Parameters
Width: any Use a number to specify a fixed width.
AutoWidth!
Example
In the following example. a text box is created. The width of the Text Box is set to 6400 pixels. You should experiment to find a value that matches your needs. The PS object references the PerfectScript class.
'******* Create a TextBox
PS.BoxCreate 2
PS.BoxTextDefaultStyle 0
'***** Set the width of the box to 64oo pixels
PS.BoxWidth 6400
PS.BoxTextEdit
PS.KeyType "Hello There"
PS.BoxTextEditEnd
PS.BoxEnd Save_BoxEnd_State
BoxWrapDlg
Syntax
BoxWrapDlg()
Description
Displays the Wrap Text dialog box.
BulletDlg
Syntax
BulletDlg()
Description
Displays the Bullets & Numbers dialog box.
BulletSetCounter
Syntax
BulletSetCounter(CounterName As String, Value As Integer)
Description
Specify a bullet-style name and counter value.
Parameters
CounterName: string Specify the name of the counter.
Value: numeric Specify the value you want the counter to use.
ButtonBarAddItem
Syntax
ButtonBarAddItem(ButtonBarName As String, Template As _ButtonBarAddItem_Template_enum, ItemName As String, Offset As Integer, Type As _ButtonBarAddItem_Type_enum, [MacroName As String], [ItemText As String], [Prompt As String], [HelpFile As String], [HelpId As String], [Script As String]
Description
Add items such as macros, buttons, and separators to a toolbar. Use any combination of parameters to identify an item.
Parameters
ButtonBarName: string The toolbar to edit.
Template: enumeration (optional) The toolbar location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
ItemName: string For predefined items, use a macro method name.
Offset: numeric (optional) The position of an added item. First position: 0. Default: last.
Type: enumeration Feature!
Launch!
Macro!
Script!
Separator!
MacroName: string (optional) The name of the macro file.
ItemText: string (optional) The text to display on a user-defined item.
Prompt: string (optional) The text to display for the new item on the Application Bar.
HelpFile: string (optional) The Help file to use if Help is the added item. Not used in the current version of the application.
HelpId: string (optional) The ID number of the Help file specified in the HelpFile parameter. Not used in the current version of the application.
Script: string (optional) The keyboard script.
ButtonBarCreateDlg
Syntax
ButtonBarCreateDlg()
Description
Display the Create Toolbar dialog box.
ButtonBarDeleteItem
Syntax
ButtonBarDeleteItem(ButtonBarName As String, [Template As _ButtonBarDeleteItem_Template_enum], [ItemName As String], [Offset As Integer])
Description
Remove an item from a toolbar. Default: Last item on the current toolbar. Use any combination of parameters to identify an item.
Parameters
ButtonBarName: string The toolbar name.
Template: enumeration (optional) The toolbar location.
CurrentDoc!
PersonalLibrary!
SharedLibrary!
ItemName: string (optional) For predefined items, use a macro method name.
Offset: numeric (optional) The position of the item to remove. First position: 0.
ButtonBarEditDlg
Syntax
()
Description
Display the Toolbar Editor dialog box.
ButtonBarOptionsDlg
Syntax
()
Description
Display the Toolbar Options dialog box.
ButtonBarScrollbarToggle
Syntax
ButtonBarScrollbarToggle(State As _ButtonBarScrollbarToggle_State_enum, ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarScrollbarToggle_LoadedFromDefaultTemplate_enum)
Description
Turn the toolbar scroll bar on or off.
Parameters
State: enumeration (optional) Default = On!
Off!
On!
ButtonBarName: string The name of the toolbar.
LoadedFromDefaultTemplate: enumeration No!
Yes!
ButtonBarSelect
Syntax
ButtonBarSelect(ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarSelect_LoadedFromDefaultTemplate_enum)
Description
Select a toolbar.
Parameters
ButtonBarName: string The name of the toolbar.
LoadedFromDefaultTemplate: enumeration No!
Yes!
ButtonBarSetFont
Syntax
ButtonBarSetFont(Font As String, Size As Integer)
Description
Specify a toolbar font face and size.
Parameters
Font: string The font face for toolbar text.
Size: numeric The point size of the toolbar text font.
ButtonBarSetLocation
Syntax
ButtonBarSetLocation(Location As _ButtonBarSetLocation_Location_enum, ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarSetLocation_LoadedFromDefaultTemplate_enum)
Description
Specify a toolbar position.
Parameters
Location: enumeration Bottom!
Left!
Palette!
Right!
Top!
ButtonBarName: string The name of the toolbar.
LoadedFromDefaultTemplate: enumeration No!
Yes!
ButtonBarSetRows
Syntax
ButtonBarSetRows(Rows As Integer, ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarSetRows_LoadedFromDefaultTemplate_enum)
Description
Specify the number of rows on a toolbar.
Parameters
Rows: numeric The number of rows displayed.
ButtonBarName: string The name of the toolbar.
LoadedFromDefaultTemplate: enumeration No!
Yes!
ButtonBarSetStyle
Syntax
ButtonBarSetStyle(Style As _ButtonBarSetStyle_Style_enum, ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarSetStyle_LoadedFromDefaultTemplate_enum)
Description
Specify a toolbar style.
Parameters
Style: enumeration Picture!
PictureAndText!
Text!
ButtonBarName: string The name of the toolbar.
LoadedFromDefaultTemplate: enumeration No!
Yes!
ButtonBarShow
Syntax
ButtonBarShow(State As _ButtonBarShow_State_enum, ButtonBarName As String, LoadedFromDefaultTemplate As _ButtonBarShow_LoadedFromDefaultTemplate_enum)
