Chapter 2

Corel® WordPerfect® Product Commands
I
ImportCreateDlg
Purpose
Display the Create Data Link dialog box.
Syntax
ImportCreateDlg ()
ImportDlg
Purpose
Display the Import Data dialog box.
Syntax
ImportDlg ()
ImportDoEdit
Purpose
Modify and perform an existing link between a spreadsheet or database and the current document.
Syntax
ImportDoEdit ()
See Also
ImportDoImport, ImportDoLink, ImportDoUpdate
ImportDoImport
Purpose
Import ASCII text, ANSI text, table data, spreadsheet data, or database data.
Syntax
ImportDoImport ()
See Also
ImportDoEdit, ImportDoLink, ImportDoUpdate
ImportDoLink
Purpose
Create and perform a link between a spreadsheet or database and the current document.
Syntax
ImportDoLink ()
See Also
ImportDoEdit, ImportDoImport, ImportDoUpdate
ImportDoUpdate
Purpose
Update linked data in the current document to match the data in linked spreadsheet or database files.
Syntax
ImportDoUpdate ()
See Also
ImportDoEdit, ImportDoImport, ImportDoLink
ImportEditDlg
Purpose
Display the Edit Data Link dialog box.
Syntax
ImportEditDlg ()
ImportOptionsDlg
Purpose
Display the Link Options dialog box.
Syntax
ImportOptionsDlg ()
ImportSetAsciiEncap
Purpose
Specify an ASCII encapsulation character for importing spreadsheet or database data saved as ASCII delimited text.
Syntax
ImportSetAsciiEncap (EncapsulationChar: string)
Parameters
EncapsulationChar
string
See Also
ImportSetAsciiFieldDelimiter, ImportSetAsciiRecordDelimiter, ImportSetAsciiStrip
ImportSetAsciiFieldDelimiter
Purpose
Specify the characters to mark the beginning or end of a field when importing spreadsheet or database data saved as ASCII delimited text.
Syntax
ImportSetAsciiFieldDelimiter (FieldDelimiter: string)
Parameters
FieldDelimiter
string
See Also
ImportSetAsciiEncap, ImportSetAsciiRecordDelimiter, ImportSetAsciiStrip
ImportSetAsciiRecordDelimiter
Purpose
Specify the characters to mark the beginning or end of a record when importing spreadsheet or database data saved as ASCII delimited text.
Syntax
ImportSetAsciiRecordDelimiter (RecordDelimiter: string)
Parameters
RecordDelimiter
string
See Also
ImportSetAsciiEncap, ImportSetAsciiFieldDelimiter, ImportSetAsciiStrip
ImportSetAsciiStrip
Purpose
Delete extra characters when importing spreadsheet or database data saved as ASCII delimited text.
Syntax
ImportSetAsciiStrip (StripChars: string)
Parameters
StripChars
string
See Also
ImportSetAsciiEncap, ImportSetAsciiFieldDelimiter, ImportSetAsciiRecordDelimiter
ImportSetDataSource
Purpose
Specify the data source for an ODBC import.
Syntax
ImportSetDataSource (Source: string)
Parameters
Source
string
ImportSetDestination
Purpose
Specify a format for linked or imported spreadsheet or database data.
Syntax
ImportSetDestination (DestinationType: enumeration)
Parameters
DestinationType
enumeration
MergeData!
TabbedText!
WPTable!
See Also
ImportSetSource
ImportSetDictPath
Purpose
Specify the Novell NetWare SQL dictionary path for imported spreadsheet or database data. Available only for Pioneer Q+E drivers.
Syntax
ImportSetDictPath (DictionaryPath: string)
Parameters
DictionaryPath
string
See Also
ImportSetFilePath, ImportSetPassword, ImportSetUserID
ImportSetFields
Purpose
Specify the database fields to import.
Syntax
ImportSetFields (FieldNames: string)
Parameters
FieldNames
string Separate fields with a comma, enclosed in quotation marks.
See Also
ImportSetFileName, ImportSetIncludeNames
ImportSetFileName
Purpose
Specify a source file to link to or import from.
Syntax
ImportSetFileName (Filename: string)
Parameters
Filename
string
See Also
ImportSetFields
ImportSetFilePath
Purpose
Specify a NetWare SQL file path. Available only for Pioneer Q+E drivers.
Syntax
ImportSetFilePath (FilePath: string)
Parameters
FilePath
string
See Also
ImportSetDictPath, ImportSetPassword, ImportSetUserID
ImportSetIncludeNames
Purpose
Use the field names as headings for imported database data.
Syntax
ImportSetIncludeNames (State: enumeration)
Parameters
State
enumeration
Off!
On!
See Also
ImportSetFields
ImportSetPanel
Purpose
Specify a Corel DataPerfect panel to retrieve.
Syntax
ImportSetPanel (PanelName: string)
Parameters
PanelName
string
See Also
ImportSetFields, ImportSetFileName
ImportSetPassword
Purpose
Specify a password to import SQL data. Available only for Pioneer Q+E drivers.
Syntax
ImportSetPassword (Password: string)
Parameters
Password
string
ImportSetQuery
Purpose
Specify the field conditions for a database import query. For examples of valid conditions, choose Example from the Define Selection Conditions dialog box.
Syntax
ImportSetQuery (FieldName1: string; FieldName2: string; FieldName3: string; Condition1Field1: string; Condition1Field2: string; Condition1Field3: string; Condition2Field1: string; Condition2Field2: string; Condition2Field3: string; Condition3Field1: string; Condition3Field2: string; Condition3Field3: string; Condition4Field1: string; Condition4Field2: string; Condition4Field3: string)
Parameters
FieldName1
string (optional)
FieldName2
string (optional)
FieldName3
string (optional)
Condition1Field1
string (optional)
Condition1Field2
string (optional)
Condition1Field3
string (optional)
Condition2Field1
string (optional)
Condition2Field2
string (optional)
Condition2Field3
string (optional)
Condition3Field1
string (optional)
Condition3Field2
string (optional)
Condition3Field3
string (optional)
Condition4Field1
string (optional)
Condition4Field2
string (optional)
Condition4Field3
string (optional)
ImportSetRange
Purpose
Specify a range of spreadsheet cells to import.
Syntax
ImportSetRange (Range: string)
Parameters
Range
string
ImportSetServer
Purpose
Specify a server for a NetWare SQL database import. Available only for Pioneer Q+E drivers.
Syntax
ImportSetServer (ServerName: string)
Parameters
ServerName
string
ImportSetSizeToFit
Purpose
Size table columns to fit data after it is imported.
Syntax
ImportSetSizeToFit (State: enumeration)
Parameters
State
enumeration
No!
Yes!
ImportSetSource
Purpose
Specify the format of spreadsheet or database data to import.
Syntax
ImportSetSource (SourceType: enumeration)
Parameters
SourceType
enumeration
|
ANSIText! |
ODBC! |
|
ASCII! |
ODBC_NO_SQL! |
|
Clipper! |
Oracle! |
|
DataPerfect! |
Paradox! |
|
DB2! |
Spreadsheet! |
|
dBase! |
SQLBase! |
|
FoxPro! |
SQLServer! |
|
InFormix! |
Sybase! |
|
NetWare! |
XDB! |
ImportSetSQLQuery
Purpose
Specify the conditions for a database link or import query. For examples of valid conditions, choose Example from the Define Selection Conditions dialog box.
Syntax
ImportSetSQLQuery (SQLQuery: string)
Parameters
SQLQuery
string
ImportSetTable
Purpose
Specify a table to import.
Syntax
ImportSetTable (TableName: string)
Parameters
TableName
string
ImportSetUserID
Purpose
Specify a NetWare SQL database user identification. Available only for Pioneer Q+E drivers.
Syntax
ImportSetUserID (UserId: string)
Parameters
UserId
string
See Also
ImportSetDictPath, ImportSetFilePath, ImportSetPassword
ImportUpdateDlg
Purpose
Display the Update import dialog box.
Syntax
ImportUpdateDlg ()
Indent
Purpose
Indent a paragraph one tab stop to the right without changing the margins.
Syntax
Indent ()
See Also
?Indent
IndentLeftRight
Purpose
Indent both sides of a paragraph equally from the left and right margin.
Syntax
IndentLeftRight ()
IndexDefineDlg
Purpose
Display the Define Index dialog box.
Syntax
IndexDefineDlg ()
IndexDefinition
Purpose
Create and insert an index definition.
Syntax
IndexDefinition (Heading: any; Subheading: any; NumMode: enumeration; PgCombine: enumeration; Concordance: string; UserFormat: string)
Parameters
Heading
any
|
AddressStyle! |
Legal4Style! |
|
BoxTextStyle! |
Legal5Style! |
|
BulletsOutlnStyle! |
Legal6Style! |
|
CaptionStyle! |
Legal7Style! |
|
CommentStyle! |
Legal8Style! |
|
CustomHTMLStyle! |
LegalOutlnStyle! |
|
Definition1Style! |
Level1Style! |
|
Definition2Style! |
Level2Style! |
|
Definition3Style! |
Level3Style! |
|
Definition4Style! |
Level4Style! |
|
Definition5Style! |
Level5Style! |
|
Definition6Style! |
Level6Style! |
|
Definition7Style! |
Level7Style! |
|
Definition8Style! |
Level8Style! |
|
DefinitionsOutlnStyle! |
ListStyle! |
|
DocStyle! |
MonospacedStyle! |
|
EndnoteNumberInDocumentStyle! |
NormalStyle! |
|
EndnoteStyle! |
NumbersOutlnStyle! |
|
EquationNumberStyle! |
OutlineStyle! |
|
FigureNumberStyle! |
ParagraphOutlnStyle! |
|
FooterAStyle! |
PreformattedStyle! |
|
FooterBStyle! |
Quotation1Style! |
|
FootnoteNumberInDocumentStyle! |
Quotation2Style! |
|
FootnoteStyle! |
Quotation3Style! |
|
HeaderAStyle! |
Quotation4Style! |
|
HeaderBStyle! |
Quotation5Style! |
|
Heading1Style! |
Quotation6Style! |
|
Heading2Style! |
Quotation7Style! |
|
Heading3Style! |
Quotation8Style! |
|
Heading4Style! |
QuotationsOutlnStyle! |
|
Heading5Style! |
TableBoxNumberStyle! |
|
Heading6Style! |
TextBoxNumberStyle! |
|
Heading7Style! |
ToAStyle! |
|
Heading8Style! |
ToC1Style! |
|
HeadingsOutlnStyle! |
ToC2Style! |
|
HypertextStyle! |
ToC3Style! |
|
Index1Style! |
ToC4Style! |
|
Index2Style! |
ToC5Style! |
|
Legal_2OutlnStyle! |
UserBoxNumberStyle! |
|
Legal1Style! |
WatermarkAStyle! |
|
Legal2Style! |
WatermarkBStyle! |
|
Legal3Style! |
Subheading
any The subheading style.
|
AddressStyle! |
Legal4Style! |
|
BoxTextStyle! |
Legal5Style! |
|
BulletsOutlnStyle! |
Legal6Style! |
|
CaptionStyle! |
Legal7Style! |
|
CommentStyle! |
Legal8Style! |
|
CustomHTMLStyle! |
LegalOutlnStyle! |
|
Definition1Style! |
Level1Style! |
|
Definition2Style! |
Level2Style! |
|
Definition3Style! |
Level3Style! |
|
Definition4Style! |
Level4Style! |
|
Definition5Style! |
Level5Style! |
|
Definition6Style! |
Level6Style! |
|
Definition7Style! |
Level7Style! |
|
Definition8Style! |
Level8Style! |
|
DefinitionsOutlnStyle! |
ListStyle! |
|
DocStyle! |
MonospacedStyle! |
|
EndnoteNumberInDocumentStyle! |
NormalStyle! |
|
EndnoteStyle! |
NumbersOutlnStyle! |
|
EquationNumberStyle! |
OutlineStyle! |
|
FigureNumberStyle! |
ParagraphOutlnStyle! |
|
FooterAStyle! |
PreformattedStyle! |
|
FooterBStyle! |
Quotation1Style! |
|
FootnoteNumberInDocumentStyle! |
Quotation2Style! |
|
FootnoteStyle! |
Quotation3Style! |
|
HeaderAStyle! |
Quotation4Style! |
|
HeaderBStyle! |
Quotation5Style! |
|
Heading1Style! |
Quotation6Style! |
|
Heading2Style! |
Quotation7Style! |
|
Heading3Style! |
Quotation8Style! |
|
Heading4Style! |
QuotationsOutlnStyle! |
|
Heading5Style! |
TableBoxNumberStyle! |
|
Heading6Style! |
TextBoxNumberStyle! |
|
Heading7Style! |
ToAStyle! |
|
Heading8Style! |
ToC1Style! |
|
HeadingsOutlnStyle! |
ToC2Style! |
|
HypertextStyle! |
ToC3Style! |
|
Index1Style! |
ToC4Style! |
|
Index2Style! |
ToC5Style! |
|
Legal_2OutlnStyle! |
UserBoxNumberStyle! |
|
Legal1Style! |
WatermarkAStyle! |
|
Legal2Style! |
WatermarkBStyle! |
|
Legal3Style! |
NumMode
enumeration The page numbering method after a heading.
DefFlushRight!
DefFollows!
DefLeader!
DefNone!
DefParentheses!
PgCombine
enumeration Combine sequential page numbers (for example, 51-53) or not (51, 52, 53).
Combine!
NoCombine!
Concordance
string (optional)
UserFormat
string (optional) The page number format. Default: document format.
See Also
?IndexDefinition, IndexMark
IndexMark
Purpose
Mark the text to be indexed. You can specify both a heading and a subheading.
Syntax
IndexMark (Heading: string; Subheading: string)
Parameters
Heading
string (optional)
Subheading
string (optional)
See Also
IndexDefinition
InhibitInput
Purpose
Enable or disable keyboard and menu input during macro execution.
Syntax
boolean := InhibitInput (State: enumeration)
Parameters
State
enumeration (optional)
Off!
On!
See Also
Display
InitialCapShippingMacro
Purpose
Play the shipping macro CAPITAL.WCM to capitalize the first letter of the current word. CAPITAL.WCM must be installed.
Syntax
InitialCapShippingMacro ()
InitialCodesDoc
Purpose
Begin initial codes. All codes between InitialCodesDoc and SubstructureExit are placed in initial codes.
Syntax
InitialCodesDoc ()
InitialCodesStyleDlg
Purpose
Display the Styles Editor dialog box. Recordable equivalent: Format, Document, Initial Codes Style.
Syntax
InitialCodesStyleDlg ()
InsertDefaultBullet
Purpose
Insert another bullet or number of the last type inserted.
Syntax
InsertDefaultBullet ()
InsertFilename
Purpose
Insert the filename of the current document.
Syntax
InsertFilename ()
See Also
InsertFilenameWithPath
InsertFilenameWithPath
Purpose
Insert the path and filename of the current document.
Syntax
InsertFilenameWithPath ()
See Also
InsertFilename
InsertOtherCodesDlg
Purpose
Display the Other Codes dialog box.
Syntax
InsertOtherCodesDlg ()
InternetPublisherDlg
Purpose
Display the Internet Publisher dialog box.
Syntax
InternetPublisherDlg ()
See Also
WebNewDlg, WebViewInWebBrowser, WebPublish, WebFormatAsWebDocument
InvokeDialog
Purpose
Display a specified dialog box but do not pause the macro for input.
Syntax
InvokeDialog (Dialog: command name)
Parameters
Dialog
command name
IrregularCap
Purpose
Corrects two consecutive uppercase letters followed by a lowercase letter at the beginning of a word. The second uppercase letter is made lowercase.
Syntax
IrregularCap (State: enumeration)
Parameters
State
enumeration
Off!
On!
IsTokenValid
Purpose
Indicate whether a specified macro command can be executed given the current state of the program. For example, when the Clipboard is empty, the EditPaste command is invalid. This command is equivalent to checking whether an option grayed is in the interface. Menu items and dialog boxes are represented by the macro commands that execute them. For example, to check the Open dialog, use FileOpenDlg.
Syntax
boolean := IsTokenValid (Variable: variable; Token: command name)
Parameters
Variable
variable The value of the variable specified in this parameter is set to True if token specified in the Token parameter is available, False if not.
Token
command name The macro command (token) specifying item or dialog to check.