Chapter 2
Corel® WordPerfect® Product Commands
P
PrefDocSummary
Purpose
Specify subject search text and default descriptive type for a document summary, and whether to create the summary automatically when saving a document.
Syntax
PrefDocSummary (SubjectSearchText: string; DefaultDescriptiveType: string; CreateOnExit: enumeration; UseDescrOnOpen: enumeration; MakeFilenameDescrOnSaveAs: enumeration)
Parameters
SubjectSearchText
string (optional) The text before the subject line.
DefaultDescriptiveType
string (optional)
CreateOnExit
enumeration (optional)
No!
Yes!
UseDescrOnOpen
enumeration (optional)
No!
Yes!
MakeFilenameDescrOnSaveAs
enumeration (optional)
No!
Yes!
See Also
?SaveDocumentSummaryOnExit, PrefDocSummaryDlg, PrefSave
PrefDocSummaryDlg
Purpose
Display the Document Summary Settings dialog box.
Syntax
PrefDocSummaryDlg ()
See Also
PrefDocSummary
PrefEnvironment
Purpose
Specify environment Settings.
Syntax
PrefEnvironment (UserName: string; UserInitials: string; UserColorRed: numeric; UserColorGreen: numeric; UserColorBlue: numeric; ConfirmCodeDeletion: enumeration; ConfirmTableFormulaDeletion: enumeration; SetQuickMarkOnSave: enumeration; ActivateHypertext: enumeration; FormatForDefaultPrinter: enumeration; SaveWorkSpace: enumeration; AutoWordSelect: enumeration; GoToQuickMarkOnOpen: enumeration)
Parameters
UserName
string (optional)
UserInitials
string (optional) The user ID.
UserColorRed
numeric (optional) Value: 0-255.
UserColorGreen
numeric (optional) Value: 0-255.
UserColorBlue
numeric (optional) Value: 0-255.
ConfirmCodeDeletion
enumeration (optional)
No!
Yes!
ConfirmTableFormulaDeletion
enumeration (optional)
No!
Yes!
SetQuickMarkOnSave
enumeration (optional)
No!
Yes!
ActivateHypertext
enumeration (optional)
Off!
On!
FormatForDefaultPrinter
enumeration (optional)
No!
Yes!
SaveWorkSpace
enumeration (optional) Save the current WorkSpace on exit.
Always!
Never!
PromptOnExit!
AutoWordSelect
enumeration (optional)
Off!
On!
GoToQuickMarkOnOpen
enumeration (optional)
No!
Yes!
See Also
?ActivateHypertext, ?AutoWordSelect
PrefEnvSettingsDlg
Purpose
Display the Environment Settings dialog box.
Syntax
PrefEnvSettingsDlg ()
PrefHyphenation
Purpose
Turn on Hyphenation and specify prompt conditions.
Syntax
PrefHyphenation (Prompt: enumeration)
Parameters
Prompt
enumeration (optional)
Always!
Never!
WhenRequired!
See Also
PrefEnvSettingsDlg, PrefSave
PrefImportDlg
Purpose
Display the Convert Settings dialog box.
Syntax
PrefImportDlg ()
PrefImportOptions
Purpose
Specify how certain characters are interpreted during document imports.
Syntax
PrefImportOptions (FieldDelimiters: string; RecordDelimiters: string; StripCharacter: string; EncapsulationCharacter: string)
Parameters
FieldDelimiters
string (optional)
RecordDelimiters
string (optional)
StripCharacter
string (optional)
EncapsulationCharacter
string (optional)
PrefLanguageSet
Purpose
Specify a language.
Syntax
PrefLanguageSet (LanguageCode: string)
Parameters
LanguageCode
string
PrefLiteCodes
Purpose
Display document symbols in new and current document windows.
Syntax
PrefLiteCodes (Show: enumeration; Space: enumeration; HardReturn: enumeration; Tab: enumeration; Indent: enumeration; SoftHyphen: enumeration; Advance: enumeration; Center: enumeration; CenterPage: enumeration; FlushRight: enumeration)
Parameters
Show
enumeration (optional) Display document symbols.
No!
Yes!
Space
enumeration (optional)
No!
Yes!
HardReturn
enumeration (optional)
No!
Yes!
Tab
enumeration (optional)
No!
Yes!
Indent
enumeration (optional)
No!
Yes!
SoftHyphen
enumeration (optional)
No!
Yes!
Advance
enumeration (optional)
No!
Yes!
Center
enumeration (optional)
No!
Yes!
CenterPage
enumeration (optional)
No!
Yes!
FlushRight
enumeration (optional)
No!
Yes!
PrefLocationDlg
Purpose
Display the File Settings dialog box.
Syntax
PrefLocationDlg ()
PrefLocationOfDocuments
Purpose
Specify the location of document and backup files and the default file format.
Syntax
PrefLocationOfDocuments (Path: string; UseDefExt: enumeration; DefExt: string; UpdateQuickList: enumeration; DefFormat: string; UseExplorerStyleFileDialogs: enumeration)
Parameters
Path
string (optional)
UseDefExt
enumeration (optional) Use the default extension on Open and Save.
No!
Yes!
DefExt
string (optional) The default filename extension.
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
DefFormat
string (optional) The default document file format.
UseExplorerStyleFileDialogs
enumeration (optional)
No!
Yes!
PrefLocationOfGraphicsFiles
Purpose
Specify the location of graphics files.
Syntax
PrefLocationOfGraphicsFiles (GraphicsDir: string; GraphicsSupplDir: string; UpdateQuickList: enumeration; GraphicsFancyBordersDir: string)
Parameters
GraphicsDir
string (optional)
GraphicsSupplDir
string (optional) The graphics supplemental directory.
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
GraphicsFancyBordersDir
string (optional)
PrefLocationOfMacroFiles
Purpose
Specify the location of macro files.
Syntax
PrefLocationOfMacroFiles (MacroDir: string; MacroSupplDir: string; UpdateQuickList: enumeration)
Parameters
MacroDir
string (optional)
MacroSupplDir
string (optional) The macro supplemental directory.
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
PrefLocationOfPrinterFiles
Purpose
Specify the location of label files and set related options.
Syntax
PrefLocationOfPrinterFiles (PrinterDir: string; PrinterSupplDir: string; LabelFile: string; LabelsDisplay: enumeration; UpdateQuickList: enumeration)
Parameters
PrinterDir
string (optional) Formerly, the Printer directory was used to store
Corel WordPerfect printer driver and label files. Corel WordPerfect printer driver files were not used in Corel WordPerfect 8 and 7. Therefore, this directory is used for label files only.
PrinterSupplDir
string (optional) This parameter is obsolete.
LabelFile
string (optional) The label filename, including the full path.
LabelsDisplay
enumeration (optional)
DisplayBoth!
DisplayLaser!
DisplayTractorFed!
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
See Also
?PathLabels, ?PathPrinters
PrefLocationOfSpreadsheetFiles
Purpose
Specify the location of spreadsheet and database files.
Syntax
PrefLocationOfSpreadsheetFiles (SpreadsheetDir: string; SpreadsheetSupplDir: string; DatabaseDir: string; DatabaseSupplDir: string; UpdateQuickList: enumeration)
Parameters
SpreadsheetDir
string (optional)
SpreadsheetSupplDir
string (optional) The supplemental spreadsheet directory.
DatabaseDir
string (optional)
DatabaseSupplDir
string (optional) The supplemental database directory.
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
PrefLocationOfTemplates
Purpose
Specify the location of template files.
Syntax
PrefLocationOfTemplates (TemplateDir: string; TemplateSupplPath: string; File: string; SupplFile: string; DefExt: string; UpdateQuickList: enumeration; UpdateDefaultTemplate: enumeration)
Parameters
TemplateDir
string (optional)
TemplateSupplPath
string (optional) The supplemental directory.
File
string (optional) The templates filename.
SupplFile
string (optional) The supplemental filename.
DefExt
string (optional) The default filename extension.
UpdateQuickList
enumeration (optional) Update the QuickList with changes.
No!
Yes!
UpdateDefaultTemplate
enumeration (optional)
No!
Yes!
PrefMenu
Purpose
Display Quick Tips, shortcut keys next to menu items, and the most recently opened documents at the bottom of the File menu.
Syntax
PrefMenu (DisplayShortcuts: enumeration; DisplayLastOpened: enumeration; DisplayHelpPrompts: enumeration)
Parameters
DisplayShortcuts
enumeration (optional)
No!
Yes!
DisplayLastOpened
enumeration (optional)
No!
Yes!
DisplayHelpPrompts
enumeration (optional)
No!
Yes!
See Also
PrefEnvSettingsDlg, PrefSave
PrefMergeCodes
Purpose
Change how merge codes appear in the document.
Syntax
PrefMergeCodes (Show: enumeration)
Parameters
Show
enumeration
Hide!
Show!
ShowAsBars!
ShowAsMarkers!
PrefMergeExtensions
Purpose
Specify merge form and data file extension options.
Syntax
PrefMergeExtensions (UseDefaultFormExt: enumeration; FormFileExt: string; UseDefaultDataExt: enumeration; DataFileExt: string)
Parameters
UseDefaultFormExt
enumeration (optional)
No!
Yes!
FormFileExt
string (optional)
UseDefaultDataExt
enumeration (optional)
No!
Yes!
DataFileExt
string (optional)
See Also
MergeFileType, PrefSave
PrefMetafileOptions
Purpose
Specify what format to use for imported graphics files.
Syntax
PrefMetafileOptions (State: enumeration)
Parameters
State
enumeration Convert to Corel WordPerfect (.WPG) format, retain both formats, or retain Metafile (.WMF) format.
ConvertToWPG!
RetainWindowsAndWPG!
RetainWindowsFormat!
PrefPowerBar
Purpose
Specify how the Power Bar looks.
Syntax
PrefPowerBar (Font: string; Size: numeric; Style: enumeration; ShowQuickTips: enumeration)
Parameters
Font
string (optional) The font face.
Size
numeric (optional) The font size.
Style
enumeration (optional) A button style.
Picture!
PictureAndText!
Text!
ShowQuickTips
enumeration (optional)
No!
Yes!
PrefPowerBarEdit
Purpose
Open and close the Power Bar Settings dialog box.
Syntax
PrefPowerBarEdit (Action: enumeration)
Parameters
Action
enumeration (optional)
Enter!
Exit!
PrefPrintEnvironment
Purpose
Turn Reformat documents for the WordPerfect default printer on open on or off.
Syntax
PrefPrintEnvironment (FormatForDefaultPrinter: enumeration)
Parameters
FormatForDefaultPrinter
enumeration
No!
Yes!
See Also
?FormatForDefaultPrinter
PrefPrintRedline
Purpose
Specify the default method and character of redlined text for new documents. Follow this command with PrefSave to save the setting for future Corel WordPerfect sessions. Use RedlineMethod and RedlineCharacter to change the redline method and/or character of the current document.
Syntax
PrefPrintRedline (Method: enumeration; Character: string)
Parameters
Method
enumeration (optional) Accept the printer setting, or specify a column of characters down the right, left, or alternating sides of redlined text.
Alternating!
Left!
PrinterDependent!
Right!
Character
string (optional) The character to display down the side of redlined text. Omit if Method parameter is PrinterDependent!.
See Also
PrefSave, RedlineCharacter, RedlineMethod
PrefPrintSizeRatio
Purpose
Specify the size for each font attribute as a percent of the selected font size.
Syntax
PrefPrintSizeRatio (Fine: numeric; Small: numeric; Large: numeric; VeryLarge: numeric; ExtraLarge: numeric; SuperSubscript: numeric)
Parameters
Fine
numeric (optional) Value: 1-100.
Small
numeric (optional) Value: 1-100.
Large
numeric (optional) Value: 1-100.
VeryLarge
numeric (optional) Value: 1-100.
ExtraLarge
numeric (optional) Value: 1-100.
SuperSubscript
numeric (optional) Value: 1-100.
See Also
PrefSave
PrefRevealCodes
Purpose
Specify Reveal Code Settings.
Syntax
PrefRevealCodes (FontFace: string; FontSize: numeric; WindowSize: numeric; ShowOnNew: enumeration; ShowSpacesAsBullets: enumeration; WrapAtWindow: enumeration; ShowInDetail: enumeration; Sculptured: enumeration; ForeColorRed: numeric; ForeColorGreen: numeric; ForeColorBlue: numeric; BackColorRed: numeric; BackColorGreen: numeric; BackColorBlue: numeric; ShowHelpPrompts: enumeration; UseSystemColors: enumeration)
Parameters
FontFace
string (optional)
FontSize
numeric (optional)
WindowSize
numeric (optional) A percent of the screen.
ShowOnNew
enumeration (optional) Display the codes in current and new documents.
No!
Yes!
ShowSpacesAsBullets
enumeration (optional)
No!
Yes!
WrapAtWindow
enumeration (optional) Wrap the lines at the window edge.
No!
Yes!
ShowInDetail
enumeration (optional)
No!
Yes!
Sculptured
enumeration (optional)
No!
Yes!
ForeColorRed
numeric (optional) Value: 0-255.
ForeColorGreen
numeric (optional) Value: 0-255.
ForeColorBlue
numeric (optional) Value: 0-255.
BackColorRed
numeric (optional) Value: 0-255.
BackColorGreen
numeric (optional) Value: 0-255.
BackColorBlue
numeric (optional) Value: 0-255.
ShowHelpPrompts
enumeration (optional)
No!
Yes!
UseSystemColors
enumeration (optional)
No!
Yes!
See Also
PrefRevealCodesDlg
PrefRevealCodesDlg
Purpose
Display the Display Settings dialog box with Reveal Codes selected.
Syntax
PrefRevealCodesDlg ()
See Also
PrefRevealCodes
PrefRuler
Purpose
Specify how the Ruler looks.
Syntax
PrefRuler (RulerOnNew: enumeration; TabsToGrid: enumeration; ShowRulerGuides: enumeration; SculpturedRuler: enumeration)
Parameters
RulerOnNew
enumeration (optional)
No!
Yes!
TabsToGrid
enumeration (optional) Tabs “snap” to invisible grid lines every 1/16th of an inch or 1/5th of a centimeter.
No!
Yes!
ShowRulerGuides
enumeration (optional) Display a Ruler Bar guide when tab stops move.
No!
Yes!
SculpturedRuler
enumeration (optional)
No!
Yes!
See Also
PrefEnvSettingsDlg, PrefSave
PrefSave
Purpose
Save preference command changes as defaults for future sessions.
Syntax
PrefSave ()
See Also
PrefPrintRedline
PrefStatusBar
Purpose
Specify default status bar items, their position, and their width. Precede and follow with PrefStatusBarEdit.
Syntax
PrefStatusBar ({Box: enumeration; Position: numeric; Width: numeric; })
Parameters
Box
enumeration (optional) Specify an item to display or hide on the status bar. Repeat Box, Position, and Width parameters for each item. Enclose repeated parameters in braces ({}) separated by semicolons.
|
AlignChar! |
Outline! |
|
CapsLockState! |
Page! |
|
CombinedAbsPosition! |
Position! |
|
CombinedPosition! |
Printer! |
|
Date! |
ScrollLockState! |
|
Font! |
Select! |
|
GeneralStatus! |
Time! |
|
InsertMode! |
Time12! |
|
Keyboard! |
Time24! |
|
Line! |
Zoom! |
|
NumLockState! |
Position
numeric (optional)
Width
numeric (optional)
PrefStatusBarEdit
Purpose
Edit the default status bar. Precede with PrefStatusBar. Default: toggle.
Syntax
PrefStatusBarEdit (State: enumeration)
Parameters
State
enumeration (optional)
Off!
On!
PrefStatusBarOptions
Purpose
Specify the size and font of the status bar text.
Syntax
PrefStatusBarOptions (FontFace: string; FontSize: numeric; Bold: enumeration; BoxStyle: enumeration; EvenSpaced: enumeration)
Parameters
FontFace
string (optional)
FontSize
numeric (optional)
Bold
enumeration (optional) Bold status bar font.
No!
Yes!
BoxStyle
enumeration (optional)
Flat!
Inset!
Raised!
EvenSpaced
enumeration (optional) Space items evenly.
No!
Yes!
See Also
PrefStatusBarEdit
PrefStatusBarOptionsDlg
Purpose
Display the Status Bar Options dialog box.
Syntax
PrefStatusBarOptionsDlg ()
See Also
PrefStatusBar
PrefTaskBar
Purpose
Specify the items for the Application Bar, and their position and width.
Syntax
PrefTaskBar ({Box: enumeration; Width: numeric; TextOrIcon: numeric; })
Parameters
Box
enumeration (optional)
|
AlignChar! |
Keyboard! |
|
CapsLockState! |
LGCName! |
|
CombinedAbsPosition! |
NumLockState! |
|
CombinedPosition! |
Printer! |
|
CurrentTag! |
ScrollLockState! |
|
Date! |
Select! |
|
Font! |
Time! |
|
GeneralStatus! |
Zoom! |
|
InsertMode! |
Width
numeric (optional)
TextOrIcon
numeric (optional)
PrefTOA
Purpose
Specify a table of authorities format.
Syntax
PrefTOA (Underlining: enumeration; Runs: enumeration)
Parameters
Underlining
enumeration (optional) Allow underlining in the full form.
Allowed!
NotAllowed!
Runs
enumeration (optional)
Allowed!
NotAllowed!
PrefUnitsOfMeasure
Purpose
Specify the unit of measure settings.
Syntax
PrefUnitsOfMeasure (DisplayUnits: enumeration; StatusBarUnits: enumeration)
Parameters
DisplayUnits
enumeration (optional)
Centimeters!
InchesI!
InchesQuote!
Millimeter!
Point!
Wpu!
StatusBarUnits
enumeration (optional) The unit of measure for the status bar and Ruler.
Centimeters!
InchesI!
InchesQuote!
Millimeter!
Point!
Wpu!
PrefZoom
Purpose
Specify the document window view.
Syntax
PrefZoom (Type: enumeration; Percent: numeric)
Parameters
Type
enumeration
FixedPercent!
FullPage!
MarginWidth!
PageWidth!
Percent
numeric (optional) Normal: 100.
See Also
DraftZoom100
Purpose
Print according to specified options. If no print-time commands are used prior to this command, the document will be printed according to the current default settings. If the Action parameter is left blank, the document will be printed using the current print action.
Syntax
Print (Action: enumeration)
Parameters
Action
enumeration (optional)
AdvancedMultiplePages!
CurrentPage!
DocumentOnDisk!
DocumentSummary!
FullDocument!
MultiplePages!
SelectedText! Print selected text. If nothing is selected, the command does nothing. If a partial line of text is selected, the entire line prints.
See Also
DocSummaryPrint, PrintAction
PrintAction
Purpose
Specify a print action and return the current print action.
Syntax
numeric := PrintAction (Action: enumeration)
Parameters
Action
enumeration (optional)
AdvancedMultiplePages!
CurrentPage!
DocumentOnDisk!
DocumentSummary!
FullDocument!
MultiplePages!
SelectedText!
See Also
PrintAdvancedRangeData
Purpose
Specify the pages to print. Follow this command with Print(AdvancedMultiplePages!).The following rules apply to all PrintAdvancedRangeData parameter specifications:1. To specify all Pages, Secondary Pages, Chapters, or Volumes use (“all”).2. Use the same numbering method as the document uses. For example, if the current Page number method is (A,B,C,...) and you want to print the first three pages, use (“A-C”) in the Pages parameter, not (“1-3").3. If you do not wish to specify a range or value for a parameter, use a null string (”").
Syntax
PrintAdvancedRangeData (Pages: string; SecondaryPages: string; Chapters: string; Volumes: string)
Parameters
Pages
string
SecondaryPages
string
Chapters
string
Volumes
string
See Also
PrintBooklet
Purpose
Turn booklet printing on or off.
Syntax
numeric := PrintBooklet (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
PrintCopies
Purpose
Specify the number of copies to print.
Syntax
numeric := PrintCopies (NumberOfCopies: numeric)
Parameters
NumberOfCopies
numeric
See Also
PrintDestination
Purpose
Specify to print to a printer, file, or printer port.
Syntax
any := PrintDestination (Destination: any)
Parameters
Destination
any (optional) Use a string specifying a path and filename to print to a file. Use a string specifying the name of a printer to print to a specific printer. Use PromptForFilename! to prompt the user for a filename to print to. Use DriverPort! to print to the current printer port.
DriverPort!
PromptForFilename!
See Also
?CurrentPrinterPort, Print
PrintDlg
Purpose
Display the Print dialog box.
Syntax
PrintDlg ()
See Also
BindingOptionsDlg, Print
PrinterCommand
Purpose
Insert a [Ptr Cmnd] code at the insertion point.
Syntax
PrinterCommand (Flag: enumeration; Command: string)
Parameters
Flag
enumeration Specify whether the Command parameter contains a printer command or filename.
Command!
File!
Command
string The printer command or name of a file that contains one or more printer commands.
See Also
PrinterCommandDlg, Print
PrinterCommandDlg
Purpose
Display the Printer Command dialog box.
Syntax
PrinterCommandDlg ()
See Also
PrinterCommand, Print
PrinterPause
Purpose
Insert a [Pause Ptr] code at the insertion point, in order to pause the current print job.
Syntax
PrinterPause ()
See Also
PrinterSelectByName
Purpose
Specify a printer to print to.
Syntax
string := PrinterSelectByName (PrinterName: any)
Parameters
PrinterName
any (optional) The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.
Default!
See Also
Print, PrinterSelectDlg
PrinterSelectDlg
Purpose
Display the Print to dialog box with the Printer tab selected.
Syntax
PrinterSelectDlg ()
See Also
Print, PrinterSelectByName
PrintGraphically
Purpose
Turn the Print graphically option on or off.
Syntax
boolean := PrintGraphically (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
PrintGraphics
Purpose
Turn graphics printing on or off.
Syntax
boolean := PrintGraphics (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
PrintHistoryDlg
Purpose
Display the Print Status and History dialog box.
Syntax
PrintHistoryDlg ()
See Also
PrintImageBinding
Purpose
Specify the binding edge. Use this command with PrintImageOffset and PrintTwoSided. This is a print-time option and does not insert a code in the document.
Syntax
numeric := PrintImageBinding (Edge: enumeration)
Parameters
Edge
enumeration (optional)
BottomEdge!
InsideEdge!
LeftEdge!
OutsideEdge!
RightEdge!
TopEdge!
See Also
PrintTwoSided, PrintUseTwoSidedDocCodes, PrintImageOffset, Print
PrintImageOffset
Purpose
Specify the binding edge offset. Use this command with PrintImageBinding. This is a print-time option and does not insert a code in the document.
Syntax
measurement := PrintImageOffset (Offset: measurement)
Parameters
Offset
measurement (optional) The distance to shift a page image. WordPerfect Units (1/1200 in) are assumed unless the DefaultUnits command precedes this command, or the units of the parameter are specified. To specify units for this parameter, include a unit indicator following the value. For example, PrintImageOffset(Offset: 1") specifies the value 1 as inches.
See Also
PrintImageBinding, Print
PrintInColor
Purpose
Turn color printing on or off. This is a print-time option and does not insert a code in the document. PrintInColor takes effect only when the current printer is capable of color printing, regardless of the value returned.
Syntax
boolean := PrintInColor (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
PrintInReverseOrder
Purpose
Turn reverse order printing on or off. This is a print-time option and does not insert a code in the document.
Syntax
boolean := PrintInReverseOrder (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
PrintRangeFrom
Purpose
Specify the first page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeTo and Print(Action: MultiplePages!).
Syntax
numeric := PrintRangeFrom (Page: numeric)
Parameters
Page
numeric (optional)
See Also
Print, PrintRangeTo
PrintRangeTo
Purpose
Specify the last page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeFrom and Print(Action: MultiplePages!).
Syntax
numeric := PrintRangeTo (Page: numeric)
Parameters
Page
numeric (optional) If this parameter equals zero, print to the end of the document.
See Also
Print, PrintRangeFrom
PrintResolution
Purpose
Specify the print resolution (quality).
Syntax
numeric := PrintResolution (Quality: enumeration)
Parameters
Quality
enumeration (optional) The print quality. Some printers allow more levels of print quality. To specify print quality on those printers, use 0-10. Refer to the specific printer documentation for print quality levels.
High!
Low!
Medium!
See Also
Print, PrintResolutionDpiY, PrintResolutionDpiX
PrintResolutionDpiX
Purpose
Specify the horizontal dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIY. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.
Syntax
numeric := PrintResolutionDpiX (DPI: numeric)
Parameters
DPI
numeric (optional)
See Also
Print, PrintResolution, PrintResolutionDpiY
PrintResolutionDpiY
Purpose
Specify the vertical dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIX. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.
Syntax
numeric := PrintResolutionDpiY (DPI: numeric)
Parameters
DPI
numeric (optional)
See Also
Print, PrintResolution, PrintResolutionDpiX
PrintSettings
Purpose
Add, delete, update, and use printer named settings. Use other print option commands to set current options. Then use this command to save those options as a named setting.
Syntax
PrintSettings (Action: enumeration; SettingName: any)
Parameters
Action
enumeration
Add!
Delete!
Update!
Use!
SettingName
any (optional) The name of the driver Named Setting. To apply the action specified in the Action parameter to the default setting, use Default!.
Default!
DriverSettings!
See Also
PrintSortOrder
Purpose
Specify how to sort the pages of multiple-copy print jobs.
Syntax
numeric := PrintSortOrder (Order: enumeration)
Parameters
Order
enumeration (optional)
Collate!
Group!
See Also
PrintSourceFileName
Purpose
Specify a document on disk to print.
Syntax
string := PrintSourceFileName (Filename: string)
Parameters
Filename
string (optional)
See Also
PrintTwoSided, PrintAdvancedRangeData, PrintBooklet, PrintWithDocumentSummary, PrintUseTwoSidedDocCodes, Print, PrintInReverseOrder
PrintTo
Purpose
Print a specified file on disk to a specified printer.
Syntax
PrintTo (Filename: string; PrinterName: string; PrinterDevice: string; PrinterPort: string)
Parameters
Filename
string The path and filename of the file to print.
PrinterName
string The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.
PrinterDevice
string Not used.
PrinterPort
string Not used.
See Also
PrintDestination, Print
PrintTwoSided
Purpose
Turn two-sided printing on or off and specify options. Use PrintTwoSided with PrintUseTwoSidedDocCodes(State: False!) to ensure predictable results. This is a print-time option and does not insert a code in the document.
Syntax
numeric := PrintTwoSided (Option: enumeration)
Parameters
Option
enumeration (optional)
EvenOnly!
LongEdge!
None!
OddOnly!
ShortEdge!
See Also
Binding, DoubleSidedPrint, PrintTwoSidedDocCodesDlg, PrintUseTwoSidedDocCodes, PrintImageBinding, Print
PrintTwoSidedDocCodesDlg
Purpose
Display the Two-Sided Document Settings dialog box.
Syntax
PrintTwoSidedDocCodesDlg ()
See Also
Binding, DoubleSidedPrint, PrintTwoSided, Print
PrintUseTwoSidedDocCodes
Purpose
Turn Use two-sided document settings on or off.
Syntax
boolean := PrintUseTwoSidedDocCodes (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
?Binding, Binding, DoubleSidedPrint, PrintTwoSided, PrintTwoSidedDocCodesDlg, PrintImageBinding
PrintWithDocumentSummary
Purpose
Turn document summary printing on or off.
Syntax
boolean := PrintWithDocumentSummary (State: enumeration)
Parameters
State
enumeration (optional)
False!
True!
See Also
ProofReadAsYouGoOff
Purpose
Turn off Spell-As-You-Go and Grammar-As-You-Go.
Syntax
ProofReadAsYouGoOff ()
See Also
ProofReadGrammar
ProofReadGrammar
Purpose
Mark and correct grammar errors as you type.
Syntax
ProofReadGrammar ()
See Also
ProofReadAsYouGoOff
PublishToBaristaDlg
Purpose
Display the Publish to Barista dialog box and specify a filename.
Syntax
PublishToBaristaDlg (FileName: string)
Parameters
FileName
string
PublishToEnvoyDlg
Purpose
Publish the current document to the Envoy viewer and display it in Envoy.
Syntax
PublishToEnvoyDlg ()