Chapter 2
Corel® WordPerfect® Product Commands
S
SaveAll
Purpose
Save all unsaved documents.
Syntax
SaveAll ()
SaveAllShippingMacro
Purpose
Play the shipping macro SAVEALL.WCM to display a list of open documents to select for saving. SAVEALL.WCM must be installed.
Syntax
SaveAllShippingMacro ()
SaveToDriveAMacro
Purpose
Play the shipping macro SAVETOA.WCM to save the current document and make a copy of it on drive A. SAVETOA.WCM must be installed.
Syntax
SaveToDriveAMacro ()
SaveUndoInformation
Purpose
Save Undo and Redo information with the current document. Saving Undo/Redo information increases the document size.
Syntax
SaveUndoInformation (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
SetUndoLevels
ScrollScreenLeft
Purpose
Scroll to the left side of the document window.
Syntax
ScrollScreenLeft ()
See Also
ScrollScreenRight
ScrollScreenRight
Purpose
Scroll to the right side of the document window.
Syntax
ScrollScreenRight ()
See Also
ScrollScreenLeft
SearchCaseSensitive
Purpose
Make Find case-sensitive.
Syntax
SearchCaseSensitive (State: enumeration)
Parameters
State
enumeration
No!
Yes!
See Also
SearchString
SearchFindWholeWordsOnly
Purpose
Specify whether Find matches only a whole word (Yes!) or also matches partial words (No!).
Syntax
SearchFindWholeWordsOnly (State: enumeration)
Parameters
State
enumeration
No!
Yes!
SearchInSelection
Purpose
Restrict the search to the selected text.
Syntax
SearchInSelection (State: enumeration)
Parameters
State
enumeration
No!
Yes!
SearchNext
Purpose
Search forward to find the next occurrence of the last search performed.
Syntax
SearchNext (SearchMode: enumeration)
Parameters
SearchMode
enumeration (optional) An extended search includes substructures such as headers and footnotes.
Extended!
Regular!
See Also
SearchPrevious, SearchString
SearchNextCurrentWord
Purpose
Find the next occurrence of the current selection or word.
Syntax
SearchNextCurrentWord (SearchMode: enumeration)
Parameters
SearchMode
enumeration (optional)
Extended!
Regular!
SearchPrevious
Purpose
Search backward to find the previous occurrence of the last search.
Syntax
SearchPrevious (SearchMode: enumeration)
Parameters
SearchMode
enumeration (optional) An extended search includes substructures such as headers and footnotes.
Extended!
Regular!
See Also
SearchNext, SearchString
SearchPreviousCurrentWord
Purpose
Find the previous occurrence of the current selection or word.
Syntax
SearchPreviousCurrentWord (SearchMode: enumeration)
Parameters
SearchMode
enumeration (optional)
Extended!
Regular!
SearchString
Purpose
Specify a search string. Follow with SearchNext or SearchPrevious.
Syntax
SearchString (StrgToLookFor: string)
Parameters
StrgToLookFor
string The text and/or codes to search for.
See Also
SearchNext, SearchPrevious
SearchWordForms
Purpose
Find and/or replace word forms.
Syntax
SearchWordForms (State: enumeration)
Parameters
State
enumeration
No!
Yes!
SearchWrap
Purpose
Specify whether Find searches from the beginning of a document after it reaches the end of a document.
Syntax
SearchWrap (State: enumeration)
Parameters
State
enumeration
No!
Yes!
SecondaryPageNumber
Purpose
Specify a secondary page number and insert the code into a document. The code is inserted at the beginning of the page where the insertion point is located.
Syntax
SecondaryPageNumber (Page: numeric)
Parameters
Page
numeric
See Also
?SecondaryPageNumber, PageNumber
SecondaryPageNumberDecrement
Purpose
Decrease the current secondary page number by one.
Syntax
SecondaryPageNumberDecrement ()
SecondaryPageNumberDisplay
Purpose
Insert a code at the insertion point that displays the current secondary page number. The number is updated as the document is modified.
Syntax
SecondaryPageNumberDisplay ()
SecondaryPageNumberIncrement
Purpose
Increase the current secondary page number by one.
Syntax
SecondaryPageNumberIncrement ()
SecondaryPageNumberMethod
Purpose
Specify a numbering method for secondary page numbers.
Syntax
SecondaryPageNumberMethod (NumberingMethod: enumeration)
Parameters
NumberingMethod
enumeration
LowerLetters!
LowerRoman!
Numbers!
UpperLetters!
UpperRoman!
See Also
?SecondaryPageNumberMethod
SelectAll
Purpose
Select all text and graphics in the current document.
Syntax
SelectAll ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectCell
Purpose
Select the current cell. Not valid for floating cells.
Syntax
SelectCell ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectCellDown
Purpose
Select from insertion point down one row. In the bottom row, it does not select text or codes below a table.
Syntax
SelectCellDown ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDownArrow, SelectCellUp
SelectCellDownArrow
Purpose
Select the current cell and one cell down. In the bottom row, it selects the current cell down to the line below the table. Not valid for floating cells.
Syntax
SelectCellDownArrow ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDown, SelectCellUp
SelectCellLeft
Purpose
Select the current cell (cell containing the insertion point) and extend the selection to the previous cell. If the current cell is the first cell in the first row (A1), select the current cell. If the current cell is in the first column (column A) and not in the first row, select the current cell, extend the selection up one row, then continue to extend the selection to the rightmost column. The resulting selection includes the current row and the previous row with the insertion point in the last column of the previous row.
Syntax
SelectCellLeft ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellRight
SelectCellRight
Purpose
Select the current cell and the next cell to the right. In the farthest right cell, select the entire current row and the row below.
Syntax
SelectCellRight ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellLeft
SelectCellUp
Purpose
Select the current cell and one cell above. In the top row of a table, do not select text or codes above the table.
Syntax
SelectCellUp ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectCellUpArrow
Purpose
Select the current cell and one cell above. In the top row of a table, select from the insertion point to the line above the table.
Syntax
SelectCellUpArrow ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCellDownArrow, SelectCellUp
SelectCharNext
Purpose
Select the text or code one character position to the right of the insertion point.
Syntax
SelectCharNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCharPrevious
SelectCharPrevious
Purpose
Select the text or code one character position to the left of the insertion point.
Syntax
SelectCharPrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectCharNext
SelectColumnBottom
Purpose
Select the text and codes from the insertion point to the bottom of the current column.
Syntax
SelectColumnBottom ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnTop
SelectColumnNext
Purpose
Select the text and codes from the insertion point to the right one column. In the farthest right column, select the text and codes from the insertion point to the beginning of the current line.
Syntax
SelectColumnNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnPrevious
SelectColumnPrevious
Purpose
Select the text and codes from the insertion point to the top of the current column and from the bottom up to and including the corresponding line in the column to the left. In the farthest left column, select the text and codes from the insertion point to the beginning of the current line.
Syntax
SelectColumnPrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnNext
SelectColumnTop
Purpose
Select the text and codes from the insertion point to the top of the current column.
Syntax
SelectColumnTop ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectColumnBottom
SelectDelete
Purpose
Delete the selected text.
Syntax
SelectDelete ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectDocBottom
Purpose
Select the text and codes from the insertion point to the end of the document.
Syntax
SelectDocBottom ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocTop
SelectDocTop
Purpose
Select the text and codes from the insertion point to the beginning of the document.
Syntax
SelectDocTop ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocBottom, SelectDocVeryTop
SelectDocVeryTop
Purpose
Select the text and codes from the insertion point to the very beginning of the document, before all codes.
Syntax
SelectDocVeryTop ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectDocBottom, SelectDocTop
SelectedReplaceString
Purpose
Replace a search string with specified text.
Syntax
SelectedReplaceString (RplcString: string; State: enumeration)
Parameters
RplcString
string
State
enumeration (optional)
UseAlways!
See Also
ReplaceString
SelectLineBegin
Purpose
Select the text and codes from the insertion point to the beginning of the current line.
Syntax
SelectLineBegin ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineEnd
SelectLineDown
Purpose
Select the text and codes from the insertion point down one line.
Syntax
SelectLineDown ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineUp
SelectLineEnd
Purpose
Select the text and codes from the insertion point to the end of the current line.
Syntax
SelectLineEnd ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineBegin
SelectLineUp
Purpose
Select the text and codes from the insertion point backward to the corresponding position on the line above.
Syntax
SelectLineUp ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectLineDown
SelectLineVeryBegin
Purpose
Select the text and codes from the insertion point to the beginning of the current line, before any codes.
Syntax
SelectLineVeryBegin ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, PosLineVeryBeg, SelectLineBegin, SelectLineVeryEnd
SelectLineVeryEnd
Purpose
Select the text and codes from the insertion point to the end of the current line, after all text and codes.
Syntax
SelectLineVeryEnd ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, PosLineVeryEnd, SelectLineBegin, SelectLineEnd, SelectLineVeryBegin
SelectMode
Purpose
Turn Select on or off. Default: toggle. Use the Arrow keys to extend a selection.
Syntax
SelectMode (State: enumeration)
Parameters
State
enumeration (optional)
Off!
On!
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectOff
Purpose
Turn off Select.
Syntax
SelectOff ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectOn
Purpose
Turn on Select and specify the mode.
Syntax
SelectOn (SelectMode: enumeration)
Parameters
SelectMode
enumeration
CharMode!
CharNoCellMode!
DocMode!
PageMode!
ParagraphMode!
RectangleMode!
SentenceMode!
TabularColumnsMode!
WordMode!
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectOnEmptyDoc
Purpose
Activate Select and specify a Select mode in an empty document.
Syntax
SelectOnEmptyDoc (SelectMode: enumeration)
Parameters
SelectMode
enumeration
CharMode!
CharNoCellMode!
DocMode!
PageMode!
ParagraphMode!
RectangleMode!
SentenceMode!
TabularColumnsMode!
WordMode!
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectPage
Purpose
Select everything on the current page.
Syntax
SelectPage ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectPageNext
Purpose
Select the text and codes from the insertion point to the beginning of the next page. On the last page, select text and codes from the insertion point to the end of the document.
Syntax
SelectPageNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectPagePrevious
SelectPagePrevious
Purpose
Select the text and codes from the insertion point to the beginning of the previous page. On the first page, select the text and codes from the insertion point to the beginning of the document.
Syntax
SelectPagePrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectPageNext
SelectParagraph
Purpose
Select the current paragraph and the subsequent codes until the text resumes.
Syntax
SelectParagraph ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectParagraphNext
Purpose
Select the text and codes from the insertion point to the beginning of the next paragraph. In the last paragraph, select the text and codes from the insertion point to the end.
Syntax
SelectParagraphNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectParagraphPrevious
SelectParagraphPrevious
Purpose
Select the text and codes from the insertion point to the beginning of the current paragraph. At the beginning of a paragraph, select the text and codes from the insertion point to the beginning of the preceding paragraph.
Syntax
SelectParagraphPrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectParagraphNext
SelectRectangle
Purpose
Select a rectangle. SelectMode must be on (press F8) to record. Use the positioning keys to extend the selection.
Syntax
SelectRectangle ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectSave
Purpose
Save the selected text as a new file.
Syntax
SelectSave (Filename: string)
Parameters
Filename
string
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectScreenDown
Purpose
Select the text and codes from the insertion point to the bottom of the screen. If the insertion point is already at the bottom of the screen, select the text and codes from the insertion point to the bottom of the next screen.
Syntax
SelectScreenDown ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectScreenUp
SelectScreenLeft
Purpose
Select the current line from the insertion point to the left side of the screen. If the insertion point is already at the left side, select the current line from the insertion point to the left side of the next screen, or to the left margin of a document. Not recordable.
Syntax
SelectScreenLeft ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, PosScreenLeft, SelectScreenRight
SelectScreenRight
Purpose
Select the current line from the insertion point to the right side of the screen. If the insertion point is already at the right side, select the current line from the insertion point to the right side of the next screen, or to the right margin of a document. Not recordable.
Syntax
SelectScreenRight ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, PosScreenRight, SelectScreenLeft
SelectScreenUp
Purpose
Select the text and codes from the insertion point to the top of the screen. If the insertion point is already at the top of the screen, select the text and codes from the insertion point to the top of the next screen.
Syntax
SelectScreenUp ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectScreenDown
SelectSentence
Purpose
Select the current sentence.
Syntax
SelectSentence ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectSentenceNext
Purpose
Select the text and codes from the insertion point to the beginning of the next sentence.
Syntax
SelectSentenceNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectSentencePrevious
SelectSentencePrevious
Purpose
Select the text and codes from the insertion point to the end of the previous sentence.
Syntax
SelectSentencePrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectSentenceNext
SelectTable
Purpose
Select all cells in the current table. If the insertion point is not in a table, the macro ends or goes to the ONERROR label.
Syntax
SelectTable ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumn, SelectTableRow
SelectTableColumn
Purpose
Select all cells in the current column of a table.
Syntax
SelectTableColumn ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTable, SelectTableRow
SelectTableColumnExtendLeft
Purpose
Select the text and codes from the insertion point to the beginning of the current row.
Syntax
SelectTableColumnExtendLeft ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumnExtendRight
SelectTableColumnExtendRight
Purpose
Select the text and codes from the insertion point to the beginning of the last column.
Syntax
SelectTableColumnExtendRight ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTableColumnExtendLeft
SelectTableRow
Purpose
Select all cells in the current row.
Syntax
SelectTableRow ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize, SelectTable, SelectTableColumn
SelectTabularColumn
Purpose
Select one or more tabular columns. SelectMode must be on to record (press F8). Use the positioning keys to extend the selection.
Syntax
SelectTabularColumn ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectToggle
Purpose
Toggle Select mode.
Syntax
SelectToggle ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectWord
Purpose
Select the current word.
Syntax
SelectWord ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectWordNext
Purpose
Select the text and codes from the insertion point to the beginning of the next word.
Syntax
SelectWordNext ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SelectWordPrevious
Purpose
Select the text and codes from the insertion point to the end of the previous word.
Syntax
SelectWordPrevious ()
See Also
?BlockActive, ?SelectedText, ?SelectedTextSize
SetDocumentMapping
Purpose
Specify a character map for one-byte characters, as opposed to extended characters, when additional character maps are installed.
Syntax
SetDocumentMapping (MapName: string; Location: enumeration; Filename: string)
Parameters
MapName
string
Location
enumeration
MapExternal!
MapInternal!
Filename
string (optional)
SettingsDlg
Purpose
Display the Settings dialog box.
Syntax
SettingsDlg ()
SetUndoLevels
Purpose
Specify the number of Undo/Redo items to maintain in the document.
Syntax
SetUndoLevels (Levels: numeric)
Parameters
Levels
numeric Value: 0-300.
See Also
SaveUndoInformation
SGMLAddToAttrList
Purpose
Append a value to an existing attribute value. The attribute named must be present in the previous start tag. The value in the previous start tag is appended with a space followed by the value. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLAddToAttrList (Name: string; Value: string)
Parameters
Name
string
Value
string
See Also
SGMLReplaceAttribute, SGMLBoxAddToAttrList
SGMLBoxAddToAttrList
Purpose
Append a value to an existing graphics box element attribute value. The element and attribute name must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLBoxAddToAttrList (Element: string; Name: string; Value: string)
Parameters
Element
string
Name
string
Value
string
See Also
SGMLAddToAttrList, SGMLBoxMarkup
SGMLBoxAttribute
Purpose
Set the attribute value of a graphics box element. The element must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLBoxAttribute (Element: string; Name: string; Value: string)
Parameters
Element
string
Name
string
Value
string
See Also
SGMLNewAttribute, SGMLReplaceAttribute, SGMLBoxMarkup
SGMLBoxDeleteAttribute
Purpose
Delete a graphics box element attribute. The element and named attribute must be present in the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLBoxDeleteAttribute (Element: string; Name: string)
Parameters
Element
string
Name
string
See Also
SGMLDeleteAttribute, SGMLBoxMarkup
SGMLBoxDeleteMarkup
Purpose
Delete an element of the selected graphics box. This command is valid only if the Corel WordPerfet SGML program component is installed.
Syntax
SGMLBoxDeleteMarkup (Type: enumeration)
Parameters
Type
enumeration
Box!
Caption!
Content!
See Also
SGMLBoxMarkup
SGMLBoxElementDlg
Purpose
Select SGML elements for the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLBoxElementDlg ()
SGMLBoxMarkup
Purpose
Set the element for a graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLBoxMarkup (Type: enumeration; Name: string)
Parameters
Type
enumeration
Box!
Caption!
Content!
Name
string
See Also
SGMLBoxAddToAttrList, SGMLBoxAttribute, SGMLBoxDeleteAttribute, SGMLBoxDeleteMarkup
SGMLCharRef
Purpose
Insert a character reference. The character needs to be mapped as an 8-bit ASCII character in the document type. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLCharRef (Character: string)
Parameters
Character
string
SGMLContentModelDlg
Purpose
Display the Element Content dialog box, which allows you to view an element's content model. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLContentModelDlg (Element: string)
Parameters
Element
string (optional)
SGMLCreateDocType
Purpose
Create a document type entry. You must include at least a document type name and a logic filename. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLCreateDocType (DocTypeName: string; LogicFile: string; LayoutFile: string; AliasFile: string; OptFile1: string; OptFile2: string; OptFile3: string; OptFile4: string; OptFile5: string; OptFile6: string; OptFile7: string; OptFile8: string; OptFile9: string; OptFile10: string)
Parameters
DocTypeName
string
LogicFile
string
LayoutFile
string (optional)
AliasFile
string (optional)
OptFile1
string (optional)
OptFile2
string (optional)
OptFile3
string (optional)
OptFile4
string (optional)
OptFile5
string (optional)
OptFile6
string (optional)
OptFile7
string (optional)
OptFile8
string (optional)
OptFile9
string (optional)
OptFile10
string (optional)
SGMLDeleteAttribute
Purpose
Delete an attribute. The attribute must be present in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLDeleteAttribute (Name: string)
Parameters
Name
string
See Also
SGMLAddToAttrList, SGMLBoxDeleteAttribute
SGMLDeleteDocType
Purpose
Delete a document type entry. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLDeleteDocType (DocTypeName: string)
Parameters
DocTypeName
string
SGMLDocTypeDlg
Purpose
Display the Document Types dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLDocTypeDlg ()
SGMLEditAttributeDlg
Purpose
Display the Edit Attribute dialog box. This command differs from SGMLEditAttributesDlg in that it allows you to edit a specific attribute of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLEditAttributeDlg (Name: string)
Parameters
Name
string
See Also
SGMLEditAttributesDlg, SGMLEditBoxAttributeDlg
SGMLEditAttributesDlg
Purpose
Display the Edit Attributes dialog box. This command differs from SGMLEditAttributeDlg in that it allows you to edit all the attributes of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLEditAttributesDlg ()
See Also
SGMLEditAttributeDlg, SGMLEditBoxAttributeDlg
SGMLEditBoxAttributeDlg
Purpose
Display the Edit Attribute dialog box. This command differs from SGMLEditBoxAttributesDlg in that it allows you to edit a specific attribute of an element of the selected graphics box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLEditBoxAttributeDlg (Element: string; Name: string)
Parameters
Element
string
Name
string
See Also
SGMLEditAttributesDlg, SGMLEditAttributeDlg
SGMLEditBoxAttributesDlg
Purpose
Edit the attributes of a box element.
Syntax
SGMLEditBoxAttributesDlg (Element: string)
Parameters
Element
string
SGMLElementsDlg
Purpose
Display the SGML Elements dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLElementsDlg ()
SGMLEntityRef
Purpose
Insert an entity reference. For text references, entity references must be declared in the document type. For file references, entity references must be user declared or declared in the document type. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLEntityRef (Name: string)
Parameters
Name
string
See Also
SGMLFileRefNew
SGMLFileRefDataType
Purpose
Specify the data type of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefDataType (FileRefName: string; DataType: enumeration)
Parameters
FileRefName
string
DataType
enumeration
CDATA!
NDATA!
None!
SDATA!
SUBDOC!
SGMLFileRefDelAttribute
Purpose
Delete a file reference notation attribute. Can be used only if a user-declared file reference exists for the specified FileRefName. An attribute of the specified Name must already exist for the file reference. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefDelAttribute (FileRefName: string; Name: string)
Parameters
FileRefName
string
Name
string
SGMLFileRefDelete
Purpose
Delete a file reference declaration and all entity references that use the file reference declaration. Only user-declared file references can be deleted. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefDelete (Name: string)
Parameters
Name
string
SGMLFileRefDlg
Purpose
Display the File References dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefDlg ()
SGMLFileRefFilePath
Purpose
Specify the file path of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefFilePath (FileRefName: string; FilePath: string)
Parameters
FileRefName
string
FilePath
string
SGMLFileRefNew
Purpose
Create a file reference declaration. A file reference of the Name cannot already exist. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefNew (Name: string; PublicID: string; FilePath: string; DataType: enumeration; NotationName: string)
Parameters
Name
string
PublicID
string
FilePath
string (optional)
DataType
enumeration (optional)
CDATA!
NDATA!
None!
SDATA!
SUBDOC!
NotationName
string (optional)
SGMLFileRefNewAttribute
Purpose
Create a file reference notation attribute. Can be used only if a user-declared file reference exists for the specified FileRefName. An attribute of the specified Name cannot already exist for the file reference. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefNewAttribute (FileRefName: string; Name: string; Value: string)
Parameters
FileRefName
string
Name
string
Value
string
SGMLFileRefNotation
Purpose
Specify the notation for a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefNotation (FileRefName: string; Notation: string)
Parameters
FileRefName
string
Notation
string
SGMLFileRefPubID
Purpose
Specify the public identifier for a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefPubID (FileRefName: string; PublicID: string)
Parameters
FileRefName
string
PublicID
string
SGMLFileRefRename
Purpose
Change the name of a file reference. Can be used only with user-declared file references. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFileRefRename (OldName: string; NewName: string)
Parameters
OldName
string
NewName
string
SGMLFindElementEnd
Purpose
Position the insertion point after the current element's end tag. If the element is defined by the layout file to be a Corel WordPerfect type (for example, a header, footer, or image), and the element's end is located at the end of the WordPerfect type, the type is also exited. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFindElementEnd ()
SGMLFindElementStart
Purpose
Position the insertion point at the beginning of the current element. This command is valid only if the Corel WordPerfect SGML program component is installed.
Syntax
SGMLFindElementStart (CursorPos: enumeration)
Parameters
CursorPos
enumeration (optional)
After!
Before!