Specify a Fancy Border for the current page. This method places a Fancy Border code in the current document at the beginning of the paragraph where the insertion point is located.
Parameters
Filename: string The filename of the graphic you want to use as a page border.
FancyPageBorderInParagraph
Syntax
FancyPageBorderInParagraph() As Boolean
Description
Return a value indicating whether the current paragraph contains a Fancy Border code. The current paragraph is the paragraph where the insertion point is located. (This method returns 0 if the current paragraph contains a Fancy Border code following the insertion point. Since the Fancy Border code is always inserted at the beginning of the current paragraph when created or edited, this condition could exist only if the code was moved manually.)
Return Value
0 Fancy Border code not in current paragraph
1 Fancy Border code in current paragraph
FancyPageBorderOccur
Syntax
FancyPageBorderOccur() As Boolean
Description
Return True if Fancy Page Borders are active at the insertion point, False if not. This method will return False if there is no Fancy Border code in the document before the insertion point, even if a Fancy Border code follows the insertion point on the same page.
FancyPageBorderOff
Syntax
FancyPageBorderOff()
Description
Turn off Fancy Page Borders. This method inserts a Fancy Border End code at the insertion point. If the insertion point is located following the Fancy Border definition code and on the same page, rather than inserting a Fancy Border End code, the Fancy Border definition code is removed.
FigurePaletteDlg
Syntax
FigurePaletteDlg()
Description
Display the Image Tools palette in order to edit an image.
FigurePaletteDlgEnd
Syntax
FigurePaletteDlgEnd()
Description
Close the Image Tools palette.
FigureRetrieveDlg
Syntax
FigureRetrieveDlg()
Description
Display the Insert Image dialog box.
FileChangeAttributes
Syntax
FileChangeAttributes(Filename As String, [Attributes])
Description
Rename a file and specify a file type.
Parameters
Filename: string The name of the file whose attributes you want to change.
Attributes: enumeration (optional) Archive!
Hidden!
Normal!
ReadOnly!
System!
FileChangeDir
Syntax
FileChangeDir(Directory As String)
Description
Change the Documents or Graphics Files directory.
Parameters
Directory: string The directory to which you want to move the file.
FileCopy
Syntax
FileCopy(SourceFile As String, DestinationFile As String)
Description
Copy a source file to a destination file.
Parameters
SourceFile: string The path and filename of the original file.
DestinationFile: string The path and filename of the copy.
FileDelete
Syntax
FileDelete([Filename As String])
Description
Delete a specific file.
Parameters
Filename: string (optional) The name of the file to delete.
FileExists
Syntax
FileExists(Variable, Filename As String)
Description
Return whether a specified file exists.
Parameters
Variable: variable True (exists) or False (not exist).
Filename: string The name of the file.
FileInsert
Syntax
FileInsert([Filename As String], [AutoDetect As _FileInsert_AutoDetect_enum], [InsertIntoDoc As _FileInsert_InsertIntoDoc_enum])
Description
Retrieve a file into the current document at the insertion point.
Parameters
Filename: string (optional) The name of the file to insert.
AutoDetect: enumeration (optional) No!
Yes!
InsertIntoDoc: enumeration (optional) Display a prompt before a file is inserted. Default: Insert! - insert file without prompt.
Insert!
Prompt!
FileInsertDlg
Syntax
FileInsertDlg()
Description
Display the Insert File dialog box, which allows you to retrieve an existing file.
FileMove
Syntax
FileMove([SourceFile As String], [DestinationFile As String])
Description
Rename and move a file.
Parameters
SourceFile: string (optional) The original filename and/or location.
DestinationFile: string (optional) The new filename and/or location.
FileNew
Syntax
FileNew()
Description
Create a new document based on the default template. If the maximum nine documents are open, the macro ends or goes to the ONERROR label.
Example
In the following example, three WordPerfect documents are saved in the 'C:\'. The code in the 'For' loop will be executed three times. A new WordPerfect document is created as a result of calling FileNew(). The name of the string variable is file.Notice that the value of i, which is the loop index, is added to the name of the file. This will ensure that each file has a unique name and is not overwritten. The BodyAll() is responsible for populating the WordPerfect document (This method is a User Defined Method and is not a member of the PerfectScript class). After the file is saved, the WordPerfect document is closed. The PS object is the PerfectScript object.
'****** Declare all variables
Dim mypath as String
Dim myfile as String
'****** Declare a PerfectScript Object
Dim PS as PerfectScript
'****** Allocate memory to the PerfectScript object
Set PS = new PerfectScript
'***** Create and Save three documents. Begin the For loop
For i = 1 To 3
'****** Create a new WordPerfect Document
PS.FileNew
PS.ClearDoc
'***** Define the path and file
mypath = "C:\Letter"
'***** Define the file to save
myfile = mypath & i & ".wpd"
'***** Populate the WordPerfect document
BodyAll
'***** Save the WordPerfect Document
PS.FileSave myfile
'***** Close the File
PS.Close No_Close_Save
'***** End the For loop
Next i
FileOpen
Syntax
FileOpen(Filename As String, [Format As _FileOpen_Format_enum])
Description
Retrieve a specified file into a new document window. If the maximum nine document windows are open, the macro ends or goes to the ONERROR label.
Parameters
Filename: string
Format: enumeration(optional) AmiPro_12!
AmiPro_12A!
AmiPro_12B!
AmiPro_20!
AmiPro_30!
ANSIDelimitedTextWindows!
ANSIGenericWordProcessor_Windows!
ANSIText_Windows!
AreAHangol!
Aruga_23!
ASCIIStandard!
ASCIIStripped!
DelimitedText!
DisplayWrite_40!
DisplayWrite_42!
DisplayWrite_50!
Excel_40!
FFT!
Hana!
HTML!
Ichitaro_3x!
Ichitaro_4x!
Ichitaro_5x!
Kermit_7bit_Transfer!
Matu_4!
Matu_5!
Matu_6!
MicroSoftWord_40!
MicroSoftWord_50!
MicroSoftWord_55!
MultiMate_33!
MultiMate_40!
MultiMateAdvantage_36!
MultiMateAdvantageII_10!
NavyDIF!
OfficeWriter_60!
OfficeWriter_61!
OfficeWriter_611!
OfficeWriter_62!
P1EXE!
RFT!
RTF!
RTFJ!
SGML!
WaiSing_251!
WindowsWrite!
WordForWindows_10!
WordForWindows_11!
WordForWindows_12!
WordForWindows_1A!
WordForWindows_20!
WordForWindows_20a!
WordForWindows_20b!
WordForWindows_20c!
WordForWindows_50!
WordForWindows_60!
WordPerfect_42!
WordPerfect_50!
WordPerfect_51!
WordPerfect_5xA!
WordPerfect_60!
WordPerfect_7!
WordStar_33!
WordStar_331!
WordStar_34!
WordStar_40!
WordStar_50!
WordStar_55!
WordStar_60!
WordStar2000_10!
WordStar2000_20!
WordStar2000_30!
WPS_Chinese!
XyWriteIIIPlus_355!
XyWriteIIIPlus_356!
FileOpenDlg
Syntax
FileOpenDlg()
Description
Display the Open File dialog box.
FileRemoveDirectory
Syntax
FileRemoveDirectory(Directory As String)
Description
Remove a directory.
Parameters
Directory: string The directory to remove.
FileSave
Syntax
FileSave([Filename As String], [ExportType As _FileSave_ExportType_enum], [Overwrite As _FileSave_Overwrite_enum])
Description
Save the current file or display the Save As dialog box for a new document.
Parameters
Filename: string (optional)
ExportType: enumeration (optional) AmiPro_12!
AmiPro_12A!
AmiPro_12B!
AmiPro_20!
AmiPro_30!
ANSIDelimitedTextWindows!
ANSIGeneratedWordProcessor_Windows!
ANSIText_Windows!
AreAHangol!
Aruga_23!
ASCIIStandard!
ASCIIStripped!
DelimitedText!
DisplayWrite_40!
DisplayWrite_42!
DisplayWrite_50!
EDGAR!
Excel_40!
FFT!
Hana!
HTML!
Ichitaro_3x!
Ichitaro_4x!
Ichitaro_5x!
Kermit_7bit_Transfer!
Matu_4!
Matu_5!
Matu_6!
MicroSoftWord_40!
MicroSoftWord_50!
MicroSoftWord_55!
MultiMate_33!
MultiMate_40!
MultiMateAdvantage_36!
MultiMateAdvantageII_10!
NavyDIF!
OfficeWriter_60!
OfficeWriter_61!
OfficeWriter_611!
OfficeWriter_62!
P1EXE!
RFT!
RTF!
RTFJ!
SGML!
WaiSing_251!
WindowsWrite!
WordForWindows_10!
WordForWindows_11!
WordForWindows_12!
WordForWindows_1A!
WordForWindows_20!
WordForWindows_20a!
WordForWindows_20b!
WordForWindows_20c!
WordForWindows_50!
WordForWindows_60!
WordPerfect_42!
WordPerfect_50!
WordPerfect_51!
WordPerfect_5xA!
WordPerfect_60!
WordPerfect_7!
WordStar_33!
WordStar_331!
WordStar_34!
WordStar_40!
WordStar_50!
WordStar_55!
WordStar_60!
WordStar2000_10!
WordStar2000_20!
WordStar2000_30!
WPS_Chinese!
XyWriteIIIPlus_355!
XyWriteIIIPlus_356!
Overwrite: enumeration (optional) Automatically overwrite a file with the same name, or prompt the user to enter a new filename.
No!
Prompt!
Yes!
Example
In the following example, three WordPerfect documents are saved in the 'C:\'. The code in the 'For' loop will be executed three times. The name of the string variable is file.Notice that the value of i, which is the loop index, is added to the name of the file. This will ensure that each file has a unique name and is not overwritten. The BodyAll method is responsible for populating the WordPerfect document. After the file is saved, the WordPerfect document is closed. The PS object is the PerfectScript object.
'****** Declare all variables
Dim mypath as String
Dim myfile as String
'****** Declare a PerfectScript Object
Dim PS as PerfectScript
'****** Allocate memory to the PerfectScript object
Set PS = new PerfectScript
'***** Create and Save three documents. Begin the For loop
For i = 1 To 3
PS.FileNew
PS.ClearDoc
'***** Define the path and file
mypath = "C:\Letter"
'***** Define the file to save
myfile = mypath & i & ".wpd"
'***** Populate the WordPerfect document
BodyAll
'***** Save the WordPerfect Document
PS.FileSave myfile
'***** Close the File
PS.Close No_Close_Save
'***** End the For loop
Next i
FileSaveAsDlg
Syntax
FileSaveAsDlg()
Description
Display the Save As dialog box, which allows you to save a file.
FileStampShippingMacro
Syntax
FileStampShippingMacro()
Description
Play the shipping macro FILESTMP.WCM to display the File Stamp Options dialog box. The dialog box allows you to insert the path and filename of a document in a header or footer. FILESTMP.WCM must be installed.
FillColors
Syntax
FillColors([ForeColorName As String], [ForeRed As Integer], [ForeGreen As Integer], [ForeBlue As Integer], [ForeShade As Integer], [BackColorName As String], [BackRed As Integer], [BackGreen As Integer], [BackBlue As Integer], [BackShade As Integer])
Description
Specify a fill color for boxes and tables. Precede with methods such as BoxFill(), FillStyleCreate(), or TableBorderEditBegin(), and end with methods such as BoxUpdateDisplay() and BoxEnd(), FillStyleEnd(), or TableBorderEditEnd().
Parameters
ForeColorName: string (optional)
ForeRed: numeric (optional) Value: 0-255.
ForeGreen: numeric (optional) Value: 0-255.
ForeBlue: numeric (optional) Value: 0-255.
ForeShade: numeric (optional) Percent: 0-100.
BackColorName: string (optional)
BackRed: numeric (optional) Value: 0-255.
BackGreen: numeric (optional) Value: 0-255.
BackBlue: numeric (optional) Value: 0-255.
BackShade: numeric (optional) Percent: 0-100.
FillSetGradient
Syntax
FillSetGradient(Gradient As _FillSetGradient_Gradient_enum, [Angle As Double], [XLocation As Double], [YLocation As Double], [Calculate As Integer], [State As _FillSetGradient_State_enum])
Description
Customize a gradient fill. Precede with FillStyleCreate() or FillStyleEdit() and end with FillStyleEnd().
Parameters
Gradient: enumeration LinearGradient!
RadialGradient!
RectangularGradient!
Angle: numeric (optional) The angle of the gradient.
XLocation: numeric (optional) The percentage of horizontal offset. A 10% offset places the center of the gradient effect toward the left edge; 50% centers it horizontally.
YLocation: numeric (optional) The percentage of vertical offset. A 10% offset places the center of the gradient effect toward the top edge; 50% centers it vertically.
Calculate: numeric (optional) The number of steps to create a gradient. Default: 30. Both maximum (999) and minimum (1) produce a solid appearance. The optimum is approximately 120.
State: enumeration (optional) Turn the gradient fill on or off.
No!
Yes!
FillSetWPG2
Syntax
FillSetWPG2(PatternSet As Integer, index As _FillSetWPG2_Index_enum)
Description
Specify a pattern set and a pattern from the set. Precede with methods such as BoxFill(), FillStyleCreate(), or TableBorderEditBegin() and end with methods such as BoxUpdateDisplay(), FillStyleEnd(), or TableBorderEditEnd().
Parameters
PatternSet: numeric Only 0 is available.
Index: enumeration Specify a pattern:
WPG2_12Gray!
WPG2_25Gray!
WPG2_50Gray!
WPG2_Arch!
WPG2_Balls!
WPG2_Bricks1!
WPG2_Bricks2!
WPG2_Chainlink!
WPG2_Checkboard1!
WPG2_Checkboard2!
WPG2_Crosses!
WPG2_Crosshatch1!
WPG2_Crosshatch2!
WPG2_Crosshatch3!
WPG2_Crosshatch4!
WPG2_Fishscale!
WPG2_Honeycomb!
WPG2_Lines1!
WPG2_Lines2!
WPG2_Lines3!
WPG2_Lines4!
WPG2_Lines5!
WPG2_Lines6!
WPG2_Lines7!
WPG2_Lines8!
WPG2_Mesh!
WPG2_Patio!
WPG2_Plaid!
WPG2_Solid!
WPG2_Triangles!
WPG2_Waves!
WPG2_Weave!
FillStyleCopy
Syntax
FillStyleCopy(StyleName, FromLibrary As _FillStyleCopy_FromLibrary_enum, ToLibrary As _FillStyleCopy_ToLibrary_enum, [DestName As String])
Description
Copy a fill style. You must pass the numeric value of the StyleName.
Parameters
StyleName: any Fill10!
Fill100!
Fill20!
Fill30!
Fill40!
Fill50!
Fill60!
Fill70!
Fill80!
Fill90!
FillButton!
NoFill! 10
100
20
30
40
50
60
70
80
90
0
127
FromLibrary: enumeration CurrentDocument!
PersonalLibrary!
SharedLibrary! N/A
ToLibrary: enumeration CurrentDocument!
PersonalLibrary!
SharedLibrary! N/A
DestName: string(optional) Rename a copied fill style. N/A
FillStyleCreate
Syntax
FillStyleCreate(TemplateName As String, Library As _FillStyleCreate_Library_enum)
Description
Create a fill style.
Parameters
TemplateName: string The name for the template.
Library: enumeration CurrentDoc!
PersonalLibrary!
SharedLibrary!
FillStyleDelete
Syntax
FillStyleDelete(StyleName, [Library As _FillStyleDelete_Library_enum])
Description
Delete a fill style. You must pass the numeric value that corresponds to the StyleName.
Parameters
StyleName: any Fill10!
Fill100!
Fill20!
Fill30!
Fill40!
Fill50!
Fill60!
Fill70!
Fill80!
Fill90!
FillButton!
NoFill! 10
100
20
30
40
50
60
70
80
90
0
127
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
FillStyleEdit
Syntax
FillStyleEdit(Style, [Library As _FillStyleEdit_Library_enum])
Description
Begin a FillStyleEdit()-FillStyleEnd() statement.
Parameters
StyleName: any Fill10!
Fill100!
Fill20!
Fill30!
Fill40!
Fill50!
Fill60!
Fill70!
Fill80!
Fill90!
FillButton!
NoFill! 10
100
20
30
40
50
60
70
80
90
0
127
Library: enumeration (optional) CurrentDoc!
PersonalLibrary!
SharedLibrary!
FillStyleEnd
Syntax
FillStyleEnd(State As _FillStyleEnd_State_enum)
Description
Save or cancel changes to a fill style.
Parameters
State: enumeration Cancel!
Save! 0
1
FillStyleName
Syntax
FillStyleEdit(Style, [Library As _FillStyleEdit_Library_enum])
Description
Name a user-created fill style. Precede with FillStyleEdit() and end with FillStyleEnd().
Parameters
FillName: string The name of the new fill style.
FillStyleRetrieve
Syntax
FillStyleRetrieve(Filename As String, Library As _FillStyleRetrieve_Library_enum)
Description
Retrieve all fill 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 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!
FillStyleSave
Syntax
FillStyleSave(Filename As String, Library As _FillStyleSave_Library_enum)
Description
Save a fill style.
Parameters
Filename: string The name for the fill style.
Library: enumeration CurrentDoc!
PersonalLibrary!
SharedLibrary!
FindDlg
Syntax
FindDlg()
Description
Display the Find and Replace Text dialog box.
FirstLineIndent
Syntax
FirstLineIndent(Width As Integer)
Description
Specify the distance between the left margin and the first word of indented text.
Parameters
Width: measurement The length of the indention.
FloatingCellBegin
Syntax
FloatingCellBegin()
Description
Move the insertion point in a floating cell to the beginning of the cell.
FloatingCellCreate
Syntax
FloatingCellCreate()
Description
Create a floating cell.
FloatingCellEdit
Syntax
FloatingCellEdit()
Description
Search backward for a floating cell and move the insertion point to the beginning of the first one found. If not found searching backward, the search continues from the insertion point forward.
FloatingCellEnd
Syntax
FloatingCellEnd()
Description
Move the insertion point in a floating cell to the end of the cell.
FloatingCellFormula
Syntax
FloatingCellFormula(Formula As String)
Description
Specify a floating-cell formula. Precede with FloatingCellCreate() or FloatingCellEdit().
Parameters
Formula: string The floating cell formula.
FloatingCellNumAlignCurrency
Syntax
FloatingCellNumAlignCurrency(Align As _FloatingCellNumAlignCurrency_Align_enum)
Description
Align the currency symbols in a floating cell. Precede with FloatingCellCreate() or FloatingCellEdit().
Parameters
Align: enumeration No!
Yes!
FloatingCellNumberDateFormat
Syntax
FloatingCellNumberDateFormat(Format As Integer)
Description
Specify a floating-cell date format.
Parameters
Format: numeric 1 March 5, 1993
2 3/5/93
3 Mar 5, 1993
4 5 March 1993
5 Friday, March 5, 1993
6 4:18 pm
7 05Mar93
8 March 5, 1993 (4:18pm)
9 1993-03-05
10 3/05
11 Mar 05
12 04:18:53 (hh:mm:ss)
FloatingCellNumberDecDigits
Syntax
FloatingCellNumberDecDigits(Number As Integer)
Description
Specify the number of digits after the decimal point in a floating cell. The insertion point must be between floating cell codes (Flt Cell).
Parameters
Number: numeric The number of decimal places after the decimal point.
FloatingCellNumberFormat
Syntax
FloatingCellNumberFormat(CellNumType As _FloatingCellNumberFormat_CellNumType_enum)
Description
Specify a number type for floating cells.
Parameters
CellNumType: enumeration Accounting!
Commas!
Currency!
DateFormat!
Fixed2!
General!
Integer!
Percent!
Scientific!
TextOnly!
FloatingCellNumberNegNumber
Syntax
FloatingCellNumberNegNumber(NegDisplay As _FloatingCellNumberNegNumber_NegDisplay_enum)
Description
Specify how to display negative numbers in a floating cell.
Parameters
NegDisplay: enumeration CRDR!
Minus!
Parentheses!
FloatingCellNumberRound
Syntax
FloatingCellNumberRound(Round As _FloatingCellNumberRound_Round_enum)
Description
Round numbers for calculation in a floating cell.
Parameters
Round: enumeration No!
Yes!
FloatingCellNumberUseCommas
Syntax
FloatingCellNumberUseCommas(Commas As _FloatingCellNumberUseCommas_Commas_enum)
Description
Use commas in floating-cell numbers.
Parameters
Commas: enumeration No!
Yes!
FloatingCellNumberUseCurrency
Syntax
FloatingCellNumberUseCurrency(Currency As _FloatingCellNumberUseCurrency_Currency_enum)
Description
Use currency symbols in a floating cell.
Parameters
Currency: enumeration No!
Yes!
FloatingCellNumSelectCurrency
Syntax
FloatingCellNumSelectCurrency(IntlCurrency As _FloatingCellNumSelectCurrency_IntlCurrency_enum)
Description
Specify a currency symbol for floating cells.
Parameters
IntlCurrency: enumeration Austria!
Belgium!
BelgiumFrench!
Brazil!
Canada!
China!
Croatia!
CzechRepublic!
DefaultCurrency!
Denmark!
Dollar!
Ecuador!
ElSalvador!
Euro!
Finland!
FinlandIntl!
France!
FrenchCanada!
Germany!
Greece!
Guatemala!
Honduras!
HongKong!
Hungary!
Iceland!
Israel!
Italy!
Japan!
Korea!
Netherlands!
Norway!
NorwayIntl!
Paraguay!
Peseta!
Peso!
Poland!
Portugal!
Ruble!
RussianRuble!
Singapore!
SlovakRepublic!
Slovenia!
SouthAfrica!
Sweden!
Switzerland!
Taiwan!
Turkey!
UnitedKingdom!
Venezuela!
FlushRight
Syntax
FlushRight()
Description
Align text at the right margin.
FlushRightWithDotLeaders
Syntax
FlushRightWithDotLeaders()
Description
Right justify a line of text with dot leaders.
Font
Syntax
Font(Name As String, [Family As _Font_Family_enum], [Attributes As _Font_Attributes_enum], [Weight As _Font_Weight_enum], [Width As _Font_Width_enum], [Source As _Font_Source_enum], [Type As _Font_Type_enum], [CharacterSet As _Font_CharacterSet_enum])
Play the shipping macro FONTDN.WCM to reduce the font size of the selected text by two points. FONTDN.WCM must be installed.
FontDoubleUnderlineToggle
Syntax
FontDoubleUnderlineToggle()
Description
Toggle Double Underline at the insertion point.
FontExtraLargeToggle
Syntax
FontExtraLargeToggle()
Description
Toggle Extra Large at the insertion point.
FontFineToggle
Syntax
FontFineToggle()
Description
Toggle Fine at the insertion point. Recordable substitute: AttributeRelativeSizeToggle.
FontHiddenToggle
Syntax
FontHiddenToggle()
Description
Toggle Hidden at the insertion point.
FontItalicToggle
Syntax
FontItalicToggle()
Description
Toggle Italic at the insertion point.
FontLargeToggle
Syntax
FontLargeToggle()
Description
Toggle Large at the insertion point.
FontOutlineToggle
Syntax
FontOutlineToggle()
Description
Toggle the Outline font attribute at the insertion point.
FontRedlineToggle
Syntax
FontRedlineToggle()
Description
Toggle Redline at the insertion point.
FontShadowToggle
Syntax
FontShadowToggle()
Description
Toggle Shadow at the insertion point.
FontSize
Syntax
FontSize(FontSize As Integer)
Description
Specify the size of a selected font at the insertion point.
Parameters
FontSize: measurement
FontSmallCapsToggle
Syntax
FontSmallCapsToggle()
Description
Toggle Small Caps at the insertion point.
FontSmallToggle
Syntax
FontSmallToggle()
Description
Toggle Small at the insertion point.
FontStrikeoutToggle
Syntax
FontStrikeoutToggle()
Description
Toggle Strikeout at the insertion point.
FontSubscriptToggle
Syntax
FontSubscriptToggle()
Description
Toggle Subscript at the insertion point.
FontSuperscriptToggle
Syntax
FontSuperscriptToggle()
Description
Toggle Superscript at the insertion point.
FontUnderlineToggle
Syntax
FontUnderlineToggle()
Description
Toggle Underline at the insertion point.
FontUpShippingMacro
Syntax
FontUpShippingMacro()
Description
Play the shipping macro FONTUP.WCM to increase the font size of the selected text by two points. FONTUP.WCM must be installed.
FontVeryLargeToggle
Syntax
FontVeryLargeToggle()
Description
Toggle Very Large at the insertion point.
FooterA
Syntax
FooterA(Action As _FooterA_Action_enum, [Occurrence As _FooterA_Occurrence_enum])
Description
Create, edit, or discontinue Footer A, and specify footer position.
Parameters
Action: enumeration Create!
Edit!
Off!
Occurrence: enumeration (optional) AllPages!
EvenPages!
NoPages!
OddPages!
FooterB
Syntax
FooterB(Action As _FooterB_Action_enum, [Occurrence As _FooterB_Occurrence_enum])
Description
Create, edit, or discontinue Footer B, and specify footer position.
Parameters
Action: enumeration Create!
Edit!
Off!
Occurrence: enumeration (optional) AllPages!
EvenPages!
NoPages!
OddPages!
FooterSeparationDistance
Syntax
FooterSeparationDistance(Distance As Integer)
Description
Specify the distance between text and footers.
Parameters
Distance: measurement Default: .167".
FootnoteContinuedMessage
Syntax
FootnoteContinuedMessage(State As _FootnoteContinuedMessage_State_enum)
Description
Print "(continued...)" when a footnote continues on the next page.
Parameters
State: enumeration No!
Yes!
FootnoteCreate
Syntax
FootnoteCreate()
Description
Open a footnote window, in order to create a footnote. Subsequent methods insert text and codes. SubstructureExit closes the window and places a reference to the footnote at the insertion point.
FootnoteEdit
Syntax
FootnoteEdit([FootnoteNumber As String])
Description
Open a specified footnote window in order to edit the footnote. Subsequent methods apply to the footnote window until SubstructureExit.
Parameters
FootnoteNumber: string (optional) Footnotes can be numbered with arabic numerals, roman numerals, or letters.
FootnoteEditDlg
Syntax
FootnoteEditDlg()
Description
Display the Edit Footnote dialog box.
FootnoteEndnoteDlg
Syntax
FootnoteEndnoteDlg()
Description
Display the Footnote/Endnote dialog box.
FootnoteMinimum
Syntax
FootnoteMinimum([Width As Integer]) As Integer
Description
Specify the amount of footnote text to keep together on a page.
Parameters
Width: measurement The space available for footnotes on a page.
FootnoteNewNumber
Syntax
FootnoteNewNumber(FootnoteNumber As String)
Description
Specify a new footnote number, and increment subsequent footnotes from that number.
Parameters
FootnoteNumber: string The starting footnote number.
FootnoteNewNumberDlg
Syntax
FootnoteNewNumberDlg()
Description
Display the Footnote Number dialog box.
FootnoteNumberDecrement
Syntax
FootnoteNumberDecrement()
Description
Decrease the last footnote number by one.
FootnoteNumberDisplay
Syntax
FootnoteNumberDisplay()
Description
Insert the current footnote number at the insertion point. This is a 0-based index. Therefore the value of the first footnote is 0.
FootnoteNumberIncrement
Syntax
FootnoteNumberIncrement()
Description
Increase the last footnote number by one.
FootnoteNumberMethod
Syntax
FootnoteNumberMethod(NumberingMethod As _FootnoteNumberMethod_NumberingMethod_enum, [Character As String])
Description
Specify a footnote numbering method.
Parameters
NumberingMethod: enumeration Characters!
LowerLetters!
LowerRoman!
Numbers!
UpperLetters!
UpperRoman!
Character: string (optional) Use up to five characters when the numbering method is Characters!.
FootnoteOptions
Syntax
FootnoteOptions([NumberingMethod As _FootnoteOptions_NumberingMethod_enum], [Characters As String], [BetweenSpacing As Integer], [MinimumHeight As Integer], [Restart As _FootnoteOptions_Restart_enum], [PrintContinued As _FootnoteOptions_PrintContinued_enum], [FootnotePosition As _FootnoteOptions_FootnotePosition_enum], [Separator As _FootnoteOptions_Separator_enum])
Description
Specify the footnote options from the insertion point forward.
Characters: string (optional) Use up to five characters when the numbering method is Characters!.
BetweenSpacing: measurement (optional) The amount of space between footnotes.
MinimumHeight: measurement (optional) How much of a footnote to keep together on a page.
Restart: enumeration (optional) Restart the footnote numbers on every page.
Off!
On!
PrintContinued: enumeration (optional) Print "(continued)..." on the last footnote line of the first page and "...(continued)" on the first footnote line of the next page.
FootnotePosition(Position As _FootnotePosition_Position_enum)
Description
Print footnotes at the bottom of the page or just below the last line of text.
Parameters
Position: enumeration AfterText!
BottomOfPage!
FootnoteRestartEachPage
Syntax
FootnoteRestartEachPage(State As _FootnoteRestartEachPage_State_enum)
Description
Restart the footnote numbering on each page.
Parameters
State: enumeration No!
Yes!
FootnoteSeparatorLine
Syntax
FootnoteSeparatorLine(Style, SpaceAboveLine As Integer, SpaceBelowLine As Integer, Alignment As _FootnoteSeparatorLine_Alignment_enum, [Width As Integer], [Position As Integer])
Description
Specify a separator line between text and footnotes.
Parameters
Style: any 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
SpaceAboveLine: measurement The space between the separator line and the last line of text.
SpaceBelowLine: measurement The space between the separator line and the first footnote.
Alignment: enumeration Center!
Full!
Left!
Right!
SetPosition!
Width: measurement (optional) The separator line width.
Position: measurement (optional) The distance of a separator line from the left edge of the page.
FootnoteSpaceBetween
Syntax
FootnoteSpaceBetween([Space As Integer]) As Integer
Description
Specify the amount of blank space between footnotes.
Parameters
Space: measurement Default: .167".
FootnoteToEndnoteShippingMacro
Syntax
FootnoteToEndnoteShippingMacro()
Description
Play the shipping macro FOOTEND.WCM, which converts footnotes to endnotes in the current document or selected text. FOOTEND.WCM must be installed.
ForcePage
Syntax
ForcePage(EvenOddNew As _ForcePage_EvenOddNew_enum)
Description
Force a page break or specify that a certain page always has an odd or even number.
