Specify a character map for one-byte characters, as opposed to extended characters, when additional character maps are installed.
Parameters
MapName: string The name of the character map.
Location: enumeration MapExternal!
MapInternal!
Filename: string (optional) The filename of the character map.
SetSelEx
Syntax
(Start: numeric; End: numeric)
Description
Lets you set up a selection. This product command enables the user to set the size of the selection in characters.
Parameters
Start: numeric The start of the selection
End: numeric The end of the selection.
Note
New command
SettingsDlg
Syntax
()
Description
Display the Settings dialog box.
SetUndoLevels
Syntax
(Levels: numeric)
Description
Specify the number of Undo/Redo items to maintain in the document.
Parameters
Levels: numeric Value: 0-300.
SGMLAddToAttrList
Syntax
(Name: string; Value: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Name: string The name of the attribute.
Value: string The value to append to the attribute.
SGMLBoxAddToAttrList
Syntax
(Element: string; Name: string; Value: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Element: string The name of the element.
Name: string The name of the attribute.
Value: string The value to append to the attribute.
SGMLBoxAttribute
Syntax
(Element: string; Name: string; Value: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Element: string The name of the element.
Name: string The name of the attribute.
Value: string The value to set.
SGMLBoxDeleteAttribute
Syntax
(Element: string; Name: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Element: string The name of the element.
Name: string The name of the attribute.
SGMLBoxDeleteMarkup
Syntax
(Type: enumeration)
Description
Delete an element of the selected graphics box. This command is valid only if the Corel WordPerfet SGML program component is installed.
Parameters
Type: enumeration Box!
Caption!
Content!
SGMLBoxElementDlg
Syntax
()
Description
Select SGML elements for the selected graphics box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLBoxMarkup
Syntax
(Type: enumeration; Name: string)
Description
Set the element for a graphics box. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Type: enumeration Box!
Caption!
Content!
Name: string The name of the element.
SGMLCDATASection
Syntax
()
Description
Insert an XML CDATA section.
Note
New command
SGMLCharRef
Syntax
(Character: string[; Type: enumeration])
Description
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 WordPerfect SGML program component is installed.
Parameters
Character: string The character to use.
Type: enumeration (optional) Decimal!
Hexadecimal!
SGMLContentModelDlg
Syntax
(Element: string)
Description
Display the Element Content dialog box, which allows you to view an element's content model. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Element: string (optional) The name of the element.
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 WordPerfect SGML program component is installed.
Parameters
DocTypeName: string The name for the document type.
LogicFile: string The filename of the logic file.
LayoutFile: string (optional) The filename of the layout file.
AliasFile: string (optional) The filename of the alias file.
OptFile1: string (optional) The filename of an optional file.
OptFile2: string (optional) The filename of an optional file.
OptFile3: string (optional) The filename of an optional file.
OptFile4: string (optional) The filename of an optional file.
OptFile5: string (optional) The filename of an optional file.
OptFile6: string (optional) The filename of an optional file.
OptFile7: string (optional) The filename of an optional file.
OptFile8: string (optional) The filename of an optional file.
OptFile9: string (optional) The filename of an optional file.
OptFile10: string (optional) The filename of an optional file.
SGMLDeleteAttribute
Syntax
(Name: string)
Description
Delete an attribute. The attribute must be present in the previous start tag. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Name: string The name of the attribute to delete.
SGMLDeleteDocType
Syntax
(DocTypeName: string)
Description
Delete a document-type entry. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
DocTypeName: string The name of the document type to delete.
SGMLDocTypeDlg
Syntax
()
Description
Display the Document Types dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLEditAttributeDlg
Syntax
(Name: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Name: string The name of the attribute to edit.
SGMLEditAttributesDlg
Syntax
()
Description
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 WordPerfect SGML program component is installed.
SGMLEditBoxAttributeDlg
Syntax
(Element: string; Name: string)
Description
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 WordPerfect SGML program component is installed.
Lets you display valid elements in an XML document.
SGMLElementsDlg
Syntax
()
Description
Display the SGML Elements dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLEndElement
Syntax
()
Description
Lets you end the current XML element.
Note
New command
SGMLEntityRef
Syntax
(Name: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Name: string The name of the entity.
SGMLExportImport
Syntax
(Name: string; DocType: string)
Description
Lets you export or import XML files.
Parameters
Name: string The name of the XML file.
DocType: string (optional)
SGMLFileRefDataType
Syntax
(FileRefName: string; DataType: enumeration)
Description
Specify the data type of a file reference. Can be used only with user-declared file references. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
FileRefName: string The filename of the reference file.
DataType: enumeration CDATA!
NDATA!
None!
SDATA!
SUBDOC!
SGMLFileRefDelAttribute
Syntax
(FileRefName: string; Name: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
FileRefName: string The filename of the reference file.
Name: string The file reference notation attribute to delete.
SGMLFileRefDelete
Syntax
(Name: string)
Description
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 WordPerfect SGML program component is installed.
Parameters
Name: string The file reference declaration to delete.
SGMLFileRefDlg
Syntax
()
Description
Display the File References dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLFileRefFilePath
Syntax
(FileRefName: string; FilePath: string)
Description
Specify the file path of a file reference. Can be used only with user-declared file references. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
FileRefName: string The filename of the reference file.
Create a file reference declaration. A file reference of the Name cannot already exist. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Name: string The name of the reference file.
PublicID: string The ID of the reference file.
FilePath: string (optional) The path of the reference file.
DataType: enumeration (optional) CDATA!
NDATA!
None!
SDATA!
SUBDOC!
NotationName: string (optional) The name of the reference file notation.
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 WordPerfect SGML program component is installed.
Parameters
FileRefName: string The name of the reference file.
Name: string The name of the file reference notation.
Value: string The value of the file reference notation.
SGMLFileRefNotation
Syntax
(FileRefName: string; Notation: string)
Description
Specify the notation for a file reference. Can be used only with user-declared file references. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
FileRefName: string The name of the reference file.
Notation: string The file reference notation.
SGMLFileRefPubID
Syntax
(FileRefName: string; PublicID: string)
Description
Specify the public identifier for a file reference. Can be used only with user-declared file references. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
FileRefName: string The name of the reference file.
PublicID: string The ID of the file reference.
SGMLFileRefRename
Syntax
(OldName: string; NewName: string)
Description
Change the name of a file reference. Can be used only with user-declared file references. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
OldName: string The original name of the file reference.
NewName: string The new name of the file reference.
SGMLFindElementEnd
Syntax
()
Description
Position the insertion point after the current element's end tag. If the element is defined by the layout file to be a 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 WordPerfect SGML program component is installed.
SGMLFindElementStart
Syntax
(CursorPos: enumeration)
Description
Position the insertion point at the beginning of the current element. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
CursorPos: enumeration (optional) After!
Before!
SGMLFindNextTable
Syntax
()
Description
Position the insertion point in the next table. Can be used only with a document type that allows table tagging. This command is valid only if the WordPerfect SGML program component is installed.
Assign information to a variable about the attributes of the current element. The macro uses the variable with other commands to retrieve information, or to determine whether to perform specified actions. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Variable: variable The name of the variable.
Item: enumeration Count! Returns a count of all the attributes of a given type.
DefaultValue! Returns the default value for the attribute specified in the document type. The string returned can be CONREF, CURRENT, IMPLIED, REQUIRED, or a string up to 1000 characters.
ErrorType! Returns one of the following values, representing the type of error for the attribute:
0 No error
1 Unknown attribute
2 Invalid character in NAME attribute
3 Invalid character in NMTOKEN attribute
4 Invalid character in NUMBER attribute
5 Invalid character in NUTOKEN attribute
6 An attribute value exceeds NAMELEN
7 Only one value is allowed
8 Attribute length exceeds LITLEN
9 No mapping for an attribute extended character
10 Attribute has no value assigned
11 Entity open (&...) in the attribute is not validated
12 Char Ref (&#...) in the attribute is not validated
13 An attribute value is not in the declared list
14 Attribute is not the declared FIXED value
15 Attribute is not a declared entity
16 Attribute is not a data or SUBDOC entity
17 More than one attribute has the same name
Name! Returns the name of the attribute specified by ItemNum.
Status! Returns one of the following values, representing the statue of the attribute:
0 Does not have a value currently specified
1 Has a value
2 Has a value but is in error
Type! Returns one of the following values:
0 Unknown
1 FIXED
2 The declared type was a list
3 CDATA
4 ENTITIES
5 ENTITY
6 ID
7 IDREF
8 IDREFS
9 NAME
10 NAMES
11 NMTOKEN
12 NMTOKENS
13 NOTATION
14 NUMBER
15 NUMBERS
16 NUTOKEN
17 NUTOKENS
Value! Returns the value of an attribute specified in the tag. (Value! always returns an error if the attribute has not been given a value.)
Type: enumeration Specify the type of attribute a variable belongs to.
All! Returns information about all attributes available in the open or previous element, relative to the insertion point.
InTag! Returns information about the attributes that have been given a value in the open or previous element, relative to the insertion point.
Invalid! Returns information about the attributes that have been given an invalid value in the open or previous element, relative to the insertion point.
NotInTag! Returns information about the attributes that have not been given a value in the open or previous element, relative to the insertion point.
Element: enumeration Specify which element to act on. Previous elements are used for empty elements.
Open!
Previous!
ItemNum: numeric (optional) Specify the number of the item from which the Item parameter extracts information.
Assign information to a variable about the elements available in a WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Variable: variable The name of the variable.
Item: enumeration Count! Returns a count of all the elements of a given type.
LSIType! Returns one of the following values:
0 Watermark B
1 Endnote
2 Header A
3 Header B
4 Footer A
5 Footer B
6 Footnote
7 Image Box
8 Watermark A
9 Table
10 Text Box
11 Equation Box
12 Normal (unspecified)
Name! Returns the name of the element specified by ItemNum.
Type: enumeration All! Returns information about all elements available in the document.
Open! Returns information about all elements that are open at the insertion point.
Previous!
Valid! Returns information about elements that are valid to insert at the insertion point (with the exception of inclusions).
ItemNum: numeric (optional) Specify the number of the item from which the Item parameter extracts information.
Assign information to a variable about the external file references available in a WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Variable: variable The name of the variable.
Item: enumeration Count! Returns a count of all the file references of a given type.
DataType! Returns one of the following values:
0 None
1 CDATA
2 NDATA
3 SDATA
4 SUBDOC
FilePath! Returns the file path of the file reference.
Name! Returns the name of the file reference.
Notation! Returns the notation type of the file reference.
PublicID! Returns the public identifier of the file reference.
Type: enumeration DTD! Returns information about all file references declared in the document type.
User! Returns information about all file references the user has defined in the document.
ItemNum: numeric (optional) Specify the number of the item from which the Item parameter extracts information.
SGMLIDIDREFListDlg
Syntax
()
Description
Display the list of ID and IDREF attributes. This command is valid only if the WordPerfect SGML program component is installed.
SGMLIgnore
Syntax
()
Description
Insert SGML IGNORE codes. If you insert IGNORE codes around selected text that includes start and end tags, other SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the WordPerfect SGML program component is installed.
Insert an element. If you insert an element around selected text that includes start and end tags, SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Name: string The name of the element.
Options: enumeration (optional) None!
Spawn!
Empty!
Attribute: string (optional) The attribute of the element.
Value: string (optional) The value of the element.
SGMLLoadDocType
Syntax
(DocTypeName: string)
Description
Select a document type for the current document. The document-type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI), and an alias file (.LNM). This command is valid only if the WordPerfect program component is installed.
Parameters
DocTypeName: string The document type.
SGMLLogicErrorDlg
Syntax
()
Description
Display the Logic Errors dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLMarkedSecParamEntity
Syntax
(Name: string[; Keyword: enumeration])
Description
Lets you create or replace a marked section parameter entity declaration.
Parameters
Name: string The name of the marked section parameter entity declaration.
Keyword: enumeration (optional) None!
CDATA!
RCDATA!
IGNORE!
INCLUDE!
TEMP!
Note
New command
SGMLMarkedSection
Syntax
([Keyword: enumeration][; Name: string])
Description
Lets you insert a marked section.
Parameters
Keyword: enumeration (optional) The keyword
Name: string (optional) The name
SGMLMarkedSectionDlg
Syntax
()
Description
Lets you insert a marked section.
Note
New command
SGMLMrkSecPEDelete
Syntax
(Name: string)
Description
Lets you delete a marked section parameter entity declaration.
Parameter
Name: string The marked section parameter entity declaration
Note
New command
SGMLMrkSecPERename
Syntax
(Name: string; Value: string)
Description
Lets you create an attribute.
Parameters
Name: string The name
Value: string The value
Note
New command
SGMLNewAttribute
Syntax
(Name: string; Value: string)
Description
Create an attribute value. The name of the attribute must be different from any attribute in the previous start tag. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Name: string The name of the attribute.
Value: string The value of the attribute.
SGMLOpenFileDlg
Syntax
()
Description
Display the Open SGML File dialog box. This command is valid only if the WordPerfect SGML program component is installed.
Specify the document type and options for retrieving an SGML document. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
WhiteSpaceConvert: enumeration (optional) This parameter is obsolete, but it has been left in the program for compatibility with previous versions of WordPerfect.
No!
Yes!
OmitTags: enumeration No!
Yes!
DocTypeName: string The document type.
SGMLPrefDlg
Syntax
()
Description
Display the SGML Preferences dialog box. This command is valid only if the WordPerfect SGML program component is installed.
Specify a default directory for the document-type files and the display preferences for tags in the document and in Reveal Codes. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
DocTypeDir: string (optional) The directory for the document type files.
Show: enumeration (optional) Hide!
Show!
ShowAsMarkers!
RevealCode: enumeration (optional) ShowLayout!
ShowAttributes!
Red: numeric (optional) Value: 0-255.
Green: numeric (optional) Value: 0-255.
Blue: numeric (optional) Value: 0-255.
FontSize: measurement (optional) The size of the font.
HTMLImport: enumeration (optional) No!
Yes!
ImportPrompt: enumeration (optional) No!
Yes!
OmitTagsImport: enumeration (optional) No!
Yes!
DefaultSaveAsXML: enumeration (optional) No!
Yes!
TemplateFolder: string (optional) The template folder.
ProjBaseTemplate: string (optional)
GraphicsFolder: string (optional) The graphics folder.
SGMLProcessingInstruction
Syntax
([Name: string])
Description
Lets you insert an XML processing instruction.
Parameter
Name: string (optional) The name of the instruction
Rename the element previous to the insertion point. Does not change the element attributes. This command is valid only if the WordPerfect SGML program component is installed. Not recordable.
Parameters
Name: string The new name for the element.
SGMLReplaceAttribute
Syntax
(Name: string; Value: string)
Description
Replace the current attribute value. The attribute must be present in the previous start tag. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Name: string The name of the attribute.
Value: string The value of the attribute.
SGMLRootElement
Syntax
(Element: string)
Description
Change the root element of the current document type. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Element: string The name of the root element.
SGMLRootElementDlg
Syntax
()
Description
Display the Select Root Element dialog box. This command is valid only if the WordPerfect SGML program component is installed.
Set options for saving a document in SGML format. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
DocTypeDeclaration: enumeration Include the Document Type Declaration in the saved SGML document. Default: Yes!
No!
Yes!
SGMLDeclaration: enumeration (optional) Include the SGML declaration at the beginning of the file. Default: No!
No!
Yes!
ConvertSRT: enumeration (optional) Convert soft returns in the document to hard returns in the saved SGML document. This command is obsolete in version 8; it has been left in the program for backwards compatibility.
No!
Yes!
SGMLSelectElement
Syntax
()
Description
Select the open element at the insertion point. This command is valid only if the WordPerfect SGML program component is installed.
SGMLSelectLayout
Syntax
(LayoutFile: string)
Description
Change the layout of the SGML elements. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
LayoutFile: string (optional) The filename of the layout file.
SGMLSelectLayoutDlg
Syntax
()
Description
Display the Select Layouts dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLSetValidation
Syntax
({Options: enumeration})
Description
Specify the types of errors to find during validation. This command is valid only if the WordPerfect SGML program component is installed.
Parameters
Options: enumeration (optional) CharMap!
Entity!
EntityDecl!
IdIdref!
Logic!
TextSeq!
SGMLSplitElement
Syntax
()
Description
Split the current SGML element into two separate elements of the same type. The attribute values will be duplicated for each element created. This command is valid only if the WordPerfect SGML program component is installed.
SGMLTagAllTables
Syntax
()
Description
Tag all tables in a document. Can be used only with a document type that allows table tagging. This command is valid only if the WordPerfect SGML program component is installed.
SGMLTagBox
Syntax
()
Description
Tag the selected box based on the mappings specified in the layout (.LSI) file. This command is valid only if the WordPerfect SGML program component is installed.
SGMLTagCurrentTable
Syntax
()
Description
Tag the current table. Your document type must use one of the table methods supported by the SGML edition of WordPerfect. For more information about the supported table methods, see Tag Tables in the main Help file. Any elements that are not part of the basic table structure (see below) must start and end within a single table cell. Any elements that are part of the basic table structure must start within the table.
Basic Table Structure:
For CALS: colspec, entry, row, spanspec, table, tbody, tgroup, thead, and title.
For AAP: ctbf, ctbl, ctby, ctc, cte, cth, cthd, cthr, ctr, ctsb1, ctsb2, ctsb3, ctsb4, and ctsh.
For HTML: table, tr, td, th.
For WP6: table, cell, colinf, and row.
For WP6MIN: table, cell, and row.
For WP: wpcell, wprow, and wptable.
This command is valid only if the WordPerfect SGML program component is installed.
SGMLTagTablesDlg
Syntax
()
Description
Display the Tag Tables dialog box. This command is valid only if the WordPerfect SGML program component is installed.
SGMLTextRefDlg
Syntax
()
Description
Display the Text References dialog box. This command is valid only if the WordPerfect SGML program component is installed. Not recordable.
SGMLUnloadDocType
Syntax
()
Description
Deselect a document type for the current document. The document type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI) and an alias file (.LNM). This command is valid only if the WordPerfect SGML program component is installed.
SGMLValidate
Syntax
()
Description
Find the next validation error. This command is valid only if the WordPerfect SGML program component is installed.
SGMLValidationDlg
Syntax
()
Description
Display the Validation dialog box. This command is valid only if the WordPerfect SGML program component is installed.
