home *** CD-ROM | disk | FTP | other *** search
/ Chip: 25 Years Anniversary / CHIP_25Jahre_Jubilaeum.iso / downloads / 401065 / WPO11 / Data1.cab / _3672D93FBBBC4B7BB4AA2B35F1FE1348 < prev    next >
Text File  |  2003-03-07  |  35KB  |  1,498 lines

  1. SetDocumentMapping
  2.  
  3. Syntax
  4.  
  5. SetDocumentMapping(MapName As String, Location As _SetDocumentMapping_Location_enum, [Filename As String])
  6.  
  7. Description
  8.  
  9. Specify a character map for one-byte characters, as opposed to extended characters, when additional character maps are installed.
  10.  
  11. Parameters
  12.  
  13. MapName: string    The name of the character map.
  14.  
  15. Location: enumeration    MapExternal!
  16.  
  17. MapInternal!
  18.  
  19. Filename: string (optional)    The filename of the character map.
  20.  
  21. SetSelEx
  22.  
  23. Syntax
  24.  
  25.  SetSelEx(Start As Long, End As Long)
  26.  
  27. Description
  28.  
  29. Lets you set up a selection. This method enables the user to set the size of the selection in characters.
  30.  
  31. Parameters
  32.  
  33. Start: numeric    The start of the selection
  34.  
  35. End: numeric    The end of the selection.
  36.  
  37. SettingsDlg
  38.  
  39. Syntax
  40.  
  41. SettingsDlg()
  42.  
  43. Description
  44.  
  45. Display the Settings dialog box.
  46.  
  47. SetUndoLevels
  48.  
  49. Syntax
  50.  
  51.  SetUndoLevels(Levels As Integer)
  52.  
  53. Description
  54.  
  55. Specify the number of Undo/Redo items to maintain in the document.
  56.  
  57. Parameters
  58.  
  59. Levels: numeric    Value: 0-300.
  60.  
  61. SGMLAddToAttrList
  62.  
  63. Syntax
  64.  
  65. SGMLAddToAttrList(Name As String, Value As String)
  66.  
  67. Description
  68.  
  69. 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 method is valid only if the WordPerfect SGML program component is installed.
  70.  
  71. Parameters
  72.  
  73. Name: string    The name of the attribute.
  74.  
  75. Value: string    The value to append to the attribute.
  76.  
  77. SGMLBoxAddToAttrList
  78.  
  79. Syntax
  80.  
  81. SGMLBoxAddToAttrList(Element As String, Name As String, Value As String)
  82.  
  83. Description
  84.  
  85. 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 method is valid only if the WordPerfect SGML program component is installed.
  86.  
  87. Parameters
  88.  
  89. Element: string    The name of the element.
  90.  
  91. Name: string    The name of the attribute.
  92.  
  93. Value: string    The value to append to the attribute.
  94.  
  95. SGMLBoxAttribute
  96.  
  97. Syntax
  98.  
  99.  SGMLBoxAttribute(Element As String, Name As String, Value As String)
  100.  
  101. Description
  102.  
  103. Set the attribute value of a graphics box element. The element must be present in the selected graphics box. This method is valid only if the WordPerfect SGML program component is installed.
  104.  
  105. Parameters
  106.  
  107. Element: string    The name of the element.
  108.  
  109. Name: string    The name of the attribute.
  110.  
  111. Value: string    The value to set.
  112.  
  113. SGMLBoxDeleteAttribute
  114.  
  115. Syntax
  116.  
  117.  SGMLBoxDeleteAttribute(Element As String, Name As String)
  118.  
  119. Description
  120.  
  121. Delete a graphics box element attribute. The element and named attribute must be present in the selected graphics box. This method is valid only if the WordPerfect SGML program component is installed.
  122.  
  123. Parameters
  124.  
  125. Element: string    The name of the element.
  126.  
  127. Name: string    The name of the attribute.
  128.  
  129. SGMLBoxDeleteMarkup
  130.  
  131. Syntax
  132.  
  133.  SGMLBoxDeleteMarkup(Type As _SGMLBoxDeleteMarkup_Type_enum)
  134.  
  135. Description
  136.  
  137. Delete an element of the selected graphics box. This method is valid only if the Corel WordPerfet SGML program component is installed.
  138.  
  139. Parameters
  140.  
  141. Type: enumeration    Box!
  142.  
  143. Caption!
  144.  
  145. Content!
  146.  
  147. SGMLBoxElementDlg
  148.  
  149. Syntax
  150.  
  151. SGMLBoxElementDlg()
  152.  
  153. Description
  154.  
  155. Select SGML elements for the selected graphics box. This method is valid only if the WordPerfect SGML program component is installed.
  156.  
  157. SGMLBoxMarkup
  158.  
  159. Syntax
  160.  
  161.  SGMLBoxMarkup(Type As _SGMLBoxMarkup_Type_enum, Name As String)
  162.  
  163. Description
  164.  
  165. Set the element for a graphics box. This method is valid only if the WordPerfect SGML program component is installed.
  166.  
  167. Parameters
  168.  
  169. Type: enumeration    Box!
  170.  
  171. Caption!
  172.  
  173. Content!
  174.  
  175. Name: string    The name of the element.
  176.  
  177. SGMLCDATASection
  178.  
  179. Syntax
  180.  
  181. SGMLCDATASection()
  182.  
  183. Description
  184.  
  185. Insert an XML CDATA section.
  186.  
  187. SGMLCharRef
  188.  
  189. Syntax
  190.  
  191. SGMLCharRef(Character As String, [Type As _SGMLCharRef_Type_enum])
  192.  
  193. Description
  194.  
  195. Insert a character reference. The character needs to be mapped as an 8-bit ASCII character in the document type. This method is valid only if the WordPerfect SGML program component is installed.
  196.  
  197. Parameters
  198.  
  199. Character: string    The character to use.
  200.  
  201. Type: enumeration (optional)    Decimal!
  202.  
  203. Hexadecimal!
  204.  
  205. SGMLContentModelDlg
  206.  
  207. Syntax
  208.  
  209. SGMLContentModelDlg([Element As String])
  210.  
  211. Description
  212.  
  213. Display the Element Content dialog box, which allows you to view an element's content model. This method is valid only if the WordPerfect SGML program component is installed.
  214.  
  215. Parameters
  216.  
  217. Element: string (optional)    The name of the element.
  218.  
  219. SGMLCreateDocType
  220.  
  221. Syntax
  222.  
  223.  SGMLCreateDocType(DocTypeName As String, LogicFile As String, [LayoutFile As String], [AliasFile As String], [OptFile1 As String], [OptFile2 As String], [OptFile3 As String], [OptFile4 As String], [OptFile5 As String], [OptFile6 As String], [OptFile7 As String], [OptFile8 As String], [OptFile9 As String], [OptFile10 As String])
  224.  
  225. Description
  226.  
  227. Create a document-type entry. You must include at least a document-type name and a logic filename. This method is valid only if the WordPerfect SGML program component is installed.
  228.  
  229. Parameters
  230.  
  231. DocTypeName: string    The name for the document type.
  232.  
  233. LogicFile: string    The filename of the logic file.
  234.  
  235. LayoutFile: string (optional)    The filename of the layout file.
  236.  
  237. AliasFile: string (optional)    The filename of the alias file.
  238.  
  239. OptFile1: string (optional)    The filename of an optional file.
  240.  
  241. OptFile2: string (optional)    The filename of an optional file.
  242.  
  243. OptFile3: string (optional)    The filename of an optional file.
  244.  
  245. OptFile4: string (optional)    The filename of an optional file.
  246.  
  247. OptFile5: string (optional)    The filename of an optional file.
  248.  
  249. OptFile6: string (optional)    The filename of an optional file.
  250.  
  251. OptFile7: string (optional)    The filename of an optional file.
  252.  
  253. OptFile8: string (optional)    The filename of an optional file.
  254.  
  255. OptFile9: string (optional)    The filename of an optional file.
  256.  
  257. OptFile10: string (optional)    The filename of an optional file.
  258.  
  259. SGMLDeleteAttribute
  260.  
  261. Syntax
  262.  
  263. SGMLDeleteAttribute(Name As String)
  264.  
  265. Description
  266.  
  267. Delete an attribute. The attribute must be present in the previous start tag. This method is valid only if the WordPerfect SGML program component is installed.
  268.  
  269. Parameters
  270.  
  271. Name: string    The name of the attribute to delete.
  272.  
  273. SGMLDeleteDocType
  274.  
  275. Syntax
  276.  
  277. SGMLDeleteDocType(DocTypeName As String)
  278.  
  279. Description
  280.  
  281. Delete a document-type entry. This method is valid only if the WordPerfect SGML program component is installed.
  282.  
  283. Parameters
  284.  
  285. DocTypeName: string    The name of the document type to delete.
  286.  
  287. SGMLDocTypeDlg
  288.  
  289. Syntax
  290.  
  291. SGMLDocTypeDlg()
  292.  
  293. Description
  294.  
  295. Display the Document Types dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  296.  
  297. SGMLEditAttributeDlg
  298.  
  299. Syntax
  300.  
  301. SGMLEditAttributeDlg(Name As String)
  302.  
  303. Description
  304.  
  305. Display the Edit Attribute dialog box. This method differs from SGMLEditAttributesDlg() in that it allows you to edit a specific attribute of an element. This method is valid only if the WordPerfect SGML program component is installed.
  306.  
  307. Parameters
  308.  
  309. Name: string    The name of the attribute to edit.
  310.  
  311. SGMLEditAttributesDlg
  312.  
  313. Syntax
  314.  
  315. SGMLEditAttributesDlg()
  316.  
  317. Description
  318.  
  319. Display the Edit Attributes dialog box. This method differs from SGMLEditAttributeDlg() in that it allows you to edit all the attributes of an element. This method is valid only if the WordPerfect SGML program component is installed.
  320.  
  321. SGMLEditBoxAttributeDlg
  322.  
  323. Syntax
  324.  
  325. SGMLEditBoxAttributeDlg(Element As String, Name As String)
  326.  
  327. Description
  328.  
  329. Display the Edit Attribute dialog box. This method differs from SGMLEditBoxAttributesDlg() in that it allows you to edit a specific attribute of an element of the selected graphics box. This method is valid only if the WordPerfect SGML program component is installed.
  330.  
  331. Parameters
  332.  
  333. Element: string    The name of the element.
  334.  
  335. Name: string    The name of the attribute to edit.
  336.  
  337. SGMLEditBoxAttributesDlg
  338.  
  339. Syntax
  340.  
  341. SGMLEditBoxAttributesDlg(Element As String)
  342.  
  343. Description
  344.  
  345. Edit the attributes of a box element.
  346.  
  347. Parameters
  348.  
  349. Element: string    The name of the element to edit.
  350.  
  351. SGMLEditLayout
  352.  
  353. Syntax
  354.  
  355. SGMLEditLayout([Name As String], [CreateGenericLayout As _SGMLEditLayout_CreateGenericLayout_enum])
  356.  
  357. Description
  358.  
  359. Lets you edit Layout from XML Project Template.
  360.  
  361. Parameters
  362.  
  363. Name: string (optional)    The name of the layout
  364.  
  365. CreateGenericLayout: enumeration (optional)    No!
  366.  
  367. Yes!
  368.  
  369. SGMLElementDlg
  370.  
  371. Syntax
  372.  
  373.  SGMLElementDlg()
  374.  
  375. Description
  376.  
  377. Lets you insert an XML element.
  378.  
  379. Note
  380.  
  381.   New method
  382.   
  383. SGMLElementEditDlg
  384.  
  385. Syntax
  386.  
  387. SGMLElementEditDlg()
  388.  
  389. Description
  390.  
  391. Lets you edit an XML element.
  392.  
  393. SGMLElementList
  394.  
  395. Syntax
  396.  
  397. SGMLElementList()
  398.  
  399. Description
  400.  
  401. Lets you display valid elements in an XML document.
  402.  
  403. SGMLElementsDlg
  404.  
  405. Syntax
  406.  
  407. SGMLElementsDlg()
  408.  
  409. Description
  410.  
  411. Display the SGML Elements dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  412.  
  413. SGMLEndElement
  414.  
  415. Syntax
  416.  
  417. SGMLEndElement()
  418.  
  419. Description
  420.  
  421. Lets you end the current XML element.
  422.  
  423. SGMLEntityRef
  424.  
  425. Syntax
  426.  
  427. SGMLEntityRef(Name As String)
  428.  
  429. Description
  430.  
  431. 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 method is valid only if the WordPerfect SGML program component is installed.
  432.  
  433. Parameters
  434.  
  435. Name: string    The name of the entity.
  436.  
  437. SGMLExportImport
  438.  
  439. Syntax
  440.  
  441.  SGMLExportImport(Name As String, [DocType As String])
  442.  
  443. Description
  444.  
  445. Lets you export or import XML files.
  446.  
  447. Parameters
  448.  
  449. Name: string    The name of the XML file.
  450.  
  451. DocType: string (optional)    
  452.  
  453. SGMLFileRefDataType
  454.  
  455. Syntax
  456.  
  457.  SGMLFileRefDataType(FileRefName As String, DataType As _SGMLFileRefDataType_DataType_enum)
  458.  
  459. Description
  460.  
  461. Specify the data type of a file reference. Can be used only with user-declared file references. This method is valid only if the WordPerfect SGML program component is installed.
  462.  
  463. Parameters
  464.  
  465. FileRefName: string    The filename of the reference file.
  466.  
  467. DataType: enumeration    CDATA!
  468.  
  469. NDATA!
  470.  
  471. None!
  472.  
  473. SDATA!
  474.  
  475. SUBDOC!
  476.  
  477. SGMLFileRefDelAttribute
  478.  
  479. Syntax
  480.  
  481. SGMLFileRefDelAttribute(FileRefName As String, Name As String)
  482.  
  483. Description
  484.  
  485. 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 method is valid only if the WordPerfect SGML program component is installed.
  486.  
  487. Parameters
  488.  
  489. FileRefName: string    The filename of the reference file.
  490.  
  491. Name: string    The file reference notation attribute to delete.
  492.  
  493. SGMLFileRefDelete
  494.  
  495. Syntax
  496.  
  497. SGMLFileRefDelete(Name As String)
  498.  
  499. Description
  500.  
  501. Delete a file reference declaration and all entity references that use the file reference declaration. Only user-declared file references can be deleted. This method is valid only if the WordPerfect SGML program component is installed.
  502.  
  503. Parameters
  504.  
  505. Name: string    The file reference declaration to delete.
  506.  
  507. SGMLFileRefDlg
  508.  
  509. Syntax
  510.  
  511. SGMLFileRefDlg()
  512.  
  513. Description
  514.  
  515. Display the File References dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  516.  
  517. SGMLFileRefFilePath
  518.  
  519. Syntax
  520.  
  521. SGMLFileRefFilePath(FileRefName As String, FilePath As String)
  522.  
  523. Description
  524.  
  525. Specify the file path of a file reference. Can be used only with user-declared file references. This method is valid only if the WordPerfect SGML program component is installed.
  526.  
  527. Parameters
  528.  
  529. FileRefName: string    The filename of the reference file.
  530.  
  531. FilePath: string    The path of the reference file.
  532.  
  533. SGMLFileRefNew
  534.  
  535. Syntax
  536.  
  537. SGMLFileRefNew(Name As String, [PublicID As String], [FilePath As String], [DataType As _SGMLFileRefNew_DataType_enum], [NotationName As String])
  538.  
  539. Description
  540.  
  541. Create a file reference declaration. A file reference of the Name cannot already exist. This method is valid only if the WordPerfect SGML program component is installed.
  542.  
  543. Parameters
  544.  
  545. Name: string    The name of the reference file.
  546.  
  547. PublicID: string    The ID of the reference file.
  548.  
  549. FilePath: string (optional)    The path of the reference file.
  550.  
  551. DataType: enumeration (optional)    CDATA!
  552.  
  553. NDATA!
  554.  
  555. None!
  556.  
  557. SDATA!
  558.  
  559. SUBDOC!
  560.  
  561. NotationName: string (optional)    The name of the reference file notation.
  562.  
  563. SGMLFileRefNewAttribute
  564.  
  565. Syntax
  566.  
  567.  SGMLFileRefNewAttribute(FileRefName As String, Name As String, Value As String)
  568.  
  569. Description
  570.  
  571. 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 method is valid only if the WordPerfect SGML program component is installed.
  572.  
  573. Parameters
  574.  
  575. FileRefName: string    The name of the reference file.
  576.  
  577. Name: string    The name of the file reference notation.
  578.  
  579. Value: string    The value of the file reference notation.
  580.  
  581. SGMLFileRefNotation
  582.  
  583. Syntax
  584.  
  585. SGMLFileRefNotation(FileRefName As String, Notation As String)
  586.  
  587. Description
  588.  
  589. Specify the notation for a file reference. Can be used only with user-declared file references. This method is valid only if the WordPerfect SGML program component is installed.
  590.  
  591. Parameters
  592.  
  593. FileRefName: string    The name of the reference file.
  594.  
  595. Notation: string    The file reference notation.
  596.  
  597. SGMLFileRefPubID
  598.  
  599. Syntax
  600.  
  601. SGMLFileRefPubID(FileRefName As String, PublicID As String)
  602.  
  603. Description
  604.  
  605. Specify the public identifier for a file reference. Can be used only with user-declared file references. This method is valid only if the WordPerfect SGML program component is installed.
  606.  
  607. Parameters
  608.  
  609. FileRefName: string    The name of the reference file.
  610.  
  611. PublicID: string    The ID of the file reference.
  612.  
  613. SGMLFileRefRename
  614.  
  615. Syntax
  616.  
  617.  SGMLFileRefRename(OldName As String, NewName As String)
  618.  
  619. Description
  620.  
  621. Change the name of a file reference. Can be used only with user-declared file references. This method is valid only if the WordPerfect SGML program component is installed.
  622.  
  623. Parameters
  624.  
  625. OldName: string    The original name of the file reference.
  626.  
  627. NewName: string    The new name of the file reference.
  628.  
  629. SGMLFindElementEnd
  630.  
  631. Syntax
  632.  
  633. SGMLFindElementEnd()
  634.  
  635. Description
  636.  
  637. 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 method is valid only if the WordPerfect SGML program component is installed.
  638.  
  639. SGMLFindElementStart
  640.  
  641. Syntax
  642.  
  643. SGMLFindElementStart([CursorPos As _SGMLFindElementStart_CursorPos_enum])
  644.  
  645. Description
  646.  
  647. Position the insertion point at the beginning of the current element. This method is valid only if the WordPerfect SGML program component is installed.
  648.  
  649. Parameters
  650.  
  651. CursorPos: enumeration (optional)    After!
  652.  
  653. Before!
  654.  
  655. SGMLFindNextTable
  656.  
  657. Syntax
  658.  
  659. SGMLFindNextTable()
  660.  
  661. Description
  662.  
  663. Position the insertion point in the next table. Can be used only with a document type that allows table tagging. This method is valid only if the WordPerfect SGML program component is installed.
  664.  
  665. SGMLFindStartTag
  666.  
  667. Syntax
  668.  
  669.  SGMLFindStartTag([Name As String], [Direction As _SGMLFindStartTag_Direction_enum], [AttributeEditFind As SGMLFindStartTag_AttributeEditFind_enum])
  670.  
  671. Description
  672.  
  673. Find the start of an element. This method is valid only if the WordPerfect SGML program component is installed.
  674.  
  675. Parameters
  676.  
  677. Name: string (optional)    The name of the element.
  678.  
  679. Direction: enumeration (optional)    Either! Searches backward first, then forward for the start tag.
  680.  
  681. Next!
  682.  
  683. Previous!
  684.  
  685. AttributeEditFind: enumeration (optional)    No!
  686.  
  687. Yes! Limits the find to start tags with attributes present, or start tags with attributes declared in the document type.
  688.  
  689. SGMLGetAttributeData
  690.  
  691. Syntax
  692.  
  693. SGMLGetAttributeData(Variable, Item As _SGMLGetAttributeData_Item_enum, Type As SGMLGetAttributeData_Type_enum, Element As _SGMLGetAttributeData_Element_enum, [ItemNum As Integer])
  694.  
  695. Description
  696.  
  697. Assign information to a variable about the attributes of the current element. The macro uses the variable with other methods to retrieve information, or to determine whether to perform specified actions. This method is valid only if the WordPerfect SGML program component is installed.
  698.  
  699. Parameters
  700.  
  701. Variable: variable    The name of the variable.
  702.  
  703. Item: enumeration    Count! Returns a count of all the attributes of a given type.
  704.  
  705. 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.
  706.  
  707. ErrorType! Returns one of the following values, representing the type of error for the attribute:
  708.  
  709.  0 No error
  710.  
  711.  1 Unknown attribute
  712.  
  713.  2 Invalid character in NAME attribute
  714.  
  715.  3 Invalid character in NMTOKEN attribute
  716.  
  717.  4 Invalid character in NUMBER attribute
  718.  
  719.  5 Invalid character in NUTOKEN attribute
  720.  
  721.  6 An attribute value exceeds NAMELEN
  722.  
  723.  7 Only one value is allowed
  724.  
  725.  8 Attribute length exceeds LITLEN
  726.  
  727.  9 No mapping for an attribute extended character
  728.  
  729.  10 Attribute has no value assigned
  730.  
  731.  11 Entity open (&...) in the attribute is not validated
  732.  
  733.  12 Char Ref (&#...) in the attribute is not validated
  734.  
  735.  13 An attribute value is not in the declared list
  736.  
  737.  14 Attribute is not the declared FIXED value
  738.  
  739.  15 Attribute is not a declared entity
  740.  
  741.  16 Attribute is not a data or SUBDOC entity
  742.  
  743.  17 More than one attribute has the same name
  744.  
  745. Name! Returns the name of the attribute specified by ItemNum.
  746.  
  747. Status! Returns one of the following values, representing the statue of the attribute:
  748.  
  749.  0 Does not have a value currently specified
  750.  
  751.  1 Has a value
  752.  
  753.  2 Has a value but is in error
  754.  
  755. Type! Returns one of the following values:
  756.  
  757.  0 Unknown
  758.  
  759.  1 FIXED
  760.  
  761.  2 The declared type was a list
  762.  
  763.  3 CDATA
  764.  
  765.  4 ENTITIES
  766.  
  767.  5 ENTITY
  768.  
  769.  6 ID
  770.  
  771.  7 IDREF
  772.  
  773.  8 IDREFS
  774.  
  775.  9 NAME
  776.  
  777.  10 NAMES
  778.  
  779.  11 NMTOKEN
  780.  
  781.  12 NMTOKENS
  782.  
  783.  13 NOTATION
  784.  
  785.  14 NUMBER
  786.  
  787.  15 NUMBERS
  788.  
  789.  16 NUTOKEN
  790.  
  791.  17 NUTOKENS
  792.  
  793. 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.)
  794.  
  795. Type: enumeration    Specify the type of attribute a variable belongs to.
  796.  
  797. All! Returns information about all attributes available in the open or previous element, relative to the insertion point.
  798.  
  799. InTag! Returns information about the attributes that have been given a value in the open or previous element, relative to the insertion point.
  800.  
  801. Invalid! Returns information about the attributes that have been given an invalid value in the open or previous element, relative to the insertion point.
  802.  
  803. NotInTag! Returns information about the attributes that have not been given a value in the open or previous element, relative to the insertion point.
  804.  
  805. Element: enumeration    Specify which element to act on. Previous elements are used for empty elements.
  806.  
  807. Open!
  808.  
  809. Previous!
  810.  
  811. ItemNum: numeric (optional)    Specify the number of the item from which the Item parameter extracts information.
  812.  
  813. SGMLGetElementData
  814.  
  815. Syntax
  816.  
  817. SGMLGetElementData(Variable, Item As _SGMLGetElementData_Item_enum, Type As SGMLGetElementData_Type_enum, [ItemNum As Integer])
  818.  
  819. Description
  820.  
  821. Assign information to a variable about the elements available in a WordPerfect document. The macro uses the variable with other methods to retrieve information or to determine whether to perform specified actions. This method is valid only if the WordPerfect SGML program component is installed.
  822.  
  823. Parameters
  824.  
  825. Variable: variable    The name of the variable.
  826.  
  827. Item: enumeration    Count! Returns a count of all the elements of a given type.
  828.  
  829. LSIType! Returns one of the following values:
  830.  
  831.  0 Watermark B
  832.  
  833.  1 Endnote
  834.  
  835.  2 Header A
  836.  
  837.  3 Header B
  838.  
  839.  4 Footer A
  840.  
  841.  5 Footer B
  842.  
  843.  6 Footnote
  844.  
  845.  7 Image Box
  846.  
  847.  8 Watermark A
  848.  
  849.  9 Table
  850.  
  851.  10 Text Box
  852.  
  853.  11 Equation Box
  854.  
  855.  12 Normal (unspecified)
  856.  
  857. Name! Returns the name of the element specified by ItemNum.
  858.  
  859. Type: enumeration    All! Returns information about all elements available in the document.
  860.  
  861. Open! Returns information about all elements that are open at the insertion point.
  862.  
  863. Previous!
  864.  
  865. Valid! Returns information about elements that are valid to insert at the insertion point (with the exception of inclusions).
  866.  
  867. ItemNum: numeric (optional)    Specify the number of the item from which the Item parameter extracts information.
  868.  
  869. SGMLGetFileRefData
  870.  
  871. Syntax
  872.  
  873. SGMLGetFileRefData(Variable, Item As _SGMLGetFileRefData_Item_enum, Type As SGMLGetFileRefData_Type_enum, [ItemNum As Intege
  874.  
  875. Description
  876.  
  877. Assign information to a variable about the external file references available in a WordPerfect document. The macro uses the variable with other methods to retrieve information or to determine whether to perform specified actions. This method is valid only if the WordPerfect SGML program component is installed.
  878.  
  879. Parameters
  880.  
  881. Variable: variable    The name of the variable.
  882.  
  883. Item: enumeration    Count! Returns a count of all the file references of a given type.
  884.  
  885. DataType! Returns one of the following values:
  886.  
  887.  0 None
  888.  
  889.  1 CDATA
  890.  
  891.  2 NDATA
  892.  
  893.  3 SDATA
  894.  
  895.  4 SUBDOC
  896.  
  897. FilePath! Returns the file path of the file reference.
  898.  
  899. Name! Returns the name of the file reference.
  900.  
  901. Notation! Returns the notation type of the file reference.
  902.  
  903. PublicID! Returns the public identifier of the file reference.
  904.  
  905. Type: enumeration    DTD! Returns information about all file references declared in the document type.
  906.  
  907. User! Returns information about all file references the user has defined in the document.
  908.  
  909. ItemNum: numeric (optional)    Specify the number of the item from which the Item parameter extracts information.
  910.  
  911. SGMLIDIDREFListDlg
  912.  
  913. Syntax
  914.  
  915.  SGMLIDIDREFListDlg()
  916.  
  917. Description
  918.  
  919. Display the list of ID and IDREF attributes. This method is valid only if the WordPerfect SGML program component is installed.
  920.  
  921. SGMLIgnore
  922.  
  923. Syntax
  924.  
  925. SGMLIgnore()
  926.  
  927. Description
  928.  
  929. 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 method is valid only if the WordPerfect SGML program component is installed.
  930.  
  931. SGMLInsertElement
  932.  
  933. Syntax
  934.  
  935. SGMLInsertElement(Name As String, [Options As _SGMLInsertElement_Options_enum], [Attribute], [Value])
  936.  
  937. Description
  938.  
  939. 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 method is valid only if the WordPerfect SGML program component is installed.
  940.  
  941. Parameters
  942.  
  943. Name: string    The name of the element.
  944.  
  945. Options: enumeration (optional)    None!
  946.  
  947. Spawn!
  948.  
  949. Empty!
  950.  
  951. Attribute: string (optional)    The attribute of the element.
  952.  
  953. Value: string (optional)    The value of the element.
  954.  
  955. SGMLLoadDocType
  956.  
  957. Syntax
  958.  
  959. SGMLLoadDocType(DocTypeName As String)
  960.  
  961. Description
  962.  
  963. 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 method is valid only if the WordPerfect program component is installed.
  964.  
  965. Parameters
  966.  
  967. DocTypeName: string    The document type.
  968.  
  969. SGMLLogicErrorDlg
  970.  
  971. Syntax
  972.  
  973. SGMLLogicErrorDlg()
  974.  
  975. Description
  976.  
  977. Display the Logic Errors dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  978.  
  979. SGMLMarkedSecParamEntity
  980.  
  981. Syntax
  982.  
  983. SGMLMarkedSecParamEntity(Name As String, [Keyword As _SGMLMarkedSecParamEntity_Keyword_enum])
  984.  
  985. Description
  986.  
  987. Lets you create or replace a marked section parameter entity declaration.
  988.  
  989. Parameters
  990.  
  991. Name: string    The name of the marked section parameter entity declaration.
  992.  
  993. Keyword: enumeration (optional)    None!
  994.  
  995. CDATA!
  996.  
  997. RCDATA!
  998.  
  999. IGNORE!
  1000.  
  1001. INCLUDE!
  1002.  
  1003. TEMP!
  1004.  
  1005. SGMLMarkedSection
  1006.  
  1007. Syntax
  1008.  
  1009. SGMLMarkedSection([Keyword As _SGMLMarkedSection_Keyword_enum], [Name])
  1010.  
  1011. Description
  1012.  
  1013. Lets you insert a marked section.
  1014.  
  1015. Parameters
  1016.  
  1017. Keyword: enumeration (optional)    The keyword
  1018.  
  1019. Name: string (optional)    The name
  1020.  
  1021. SGMLMarkedSectionDlg
  1022.  
  1023. Syntax
  1024.  
  1025. SGMLMarkedSectionDlg()
  1026.  
  1027. Description
  1028.  
  1029. Lets you insert a marked section.
  1030.  
  1031. SGMLMrkSecPEDelete
  1032.  
  1033. Syntax
  1034.  
  1035. SGMLMrkSecPEDelete(Name As String)
  1036.  
  1037. Description
  1038.  
  1039. Lets you delete a marked section parameter entity declaration.
  1040.  
  1041. Parameter
  1042.  
  1043. Name: string    The marked section parameter entity declaration
  1044.  
  1045. SGMLMrkSecPERename
  1046.  
  1047. Syntax
  1048.  
  1049. SGMLMrkSecPERename(Name As String, NewName As String)
  1050.  
  1051. Description
  1052.  
  1053. Lets you create an attribute.
  1054.  
  1055. Parameters
  1056.  
  1057. Name: string    The name
  1058.  
  1059. Value: string    The value
  1060.  
  1061. SGMLNewAttribute
  1062.  
  1063. Syntax
  1064.  
  1065. SGMLNewAttribute(Name As String, Value As String)
  1066.  
  1067. Description
  1068.  
  1069. Create an attribute value. The name of the attribute must be different from any attribute in the previous start tag. This method is valid only if the WordPerfect SGML program component is installed.
  1070.  
  1071. Parameters
  1072.  
  1073. Name: string    The name of the attribute.
  1074.  
  1075. Value: string    The value of the attribute.
  1076.  
  1077. SGMLOpenFileDlg
  1078.  
  1079. Syntax
  1080.  
  1081. SGMLOpenFileDlg()
  1082.  
  1083. Description
  1084.  
  1085. Display the Open SGML File dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  1086.  
  1087. SGMLPreferences
  1088.  
  1089. Syntax
  1090.  
  1091. SGMLPreferences([DocTypeDir As String], [Show As _SGMLPreferences_Show_enum], [RevealCode As _SGMLPreferences_RevealCode_enum], [Red As Integer], [Green As Integer], [Blue As Integer], [FontSize As Integer], [HTMLImport As _SGMLPreferences_HTMLImport_enum], [ImportPrompt As _SGMLPreferences_ImportPrompt_enum], [OmitTagsImport As _SGMLPreferences_OmitTagsImport_enum], [DefaultSaveAsXML As _SGMLPreferences_DefaultSaveAsXML_enum], [TemplateFolder As String], [ProjBaseTemplate As String], [GraphicsFolder As String], [CatalogFile])
  1092.  
  1093. Description
  1094.  
  1095. Specify a default directory for the document-type files and the display preferences for tags in the document and in Reveal Codes. This method is valid only if the WordPerfect SGML program component is installed.
  1096.  
  1097. Parameters
  1098.  
  1099. DocTypeDir: string (optional)    The directory for the document type files.
  1100.  
  1101. Show: enumeration (optional)    Hide!
  1102.  
  1103. Show!
  1104.  
  1105. ShowAsMarkers!
  1106.  
  1107. RevealCode: enumeration (optional)    ShowLayout!
  1108.  
  1109. ShowAttributes!
  1110.  
  1111. Red: numeric (optional)    Value: 0-255.
  1112.  
  1113. Green: numeric (optional)    Value: 0-255.
  1114.  
  1115. Blue: numeric (optional)    Value: 0-255.
  1116.  
  1117. FontSize: measurement (optional)    The size of the font.
  1118.  
  1119. HTMLImport: enumeration (optional)    No!
  1120.  
  1121. Yes!
  1122.  
  1123. ImportPrompt: enumeration (optional)    No!
  1124.  
  1125. Yes!
  1126.  
  1127. OmitTagsImport: enumeration (optional)    No!
  1128.  
  1129. Yes!
  1130.  
  1131. DefaultSaveAsXML: enumeration (optional)    No!
  1132.  
  1133. Yes!
  1134.  
  1135. TemplateFolder: string (optional)    The template folder.
  1136.  
  1137. ProjBaseTemplate: string (optional)    
  1138.  
  1139. GraphicsFolder: string (optional)    The graphics folder.
  1140.  
  1141. SGMLProcessingInstruction
  1142.  
  1143. Syntax
  1144.  
  1145. SGMLProcessingInstruction([Name As String])
  1146.  
  1147. Description
  1148.  
  1149. Lets you insert an XML processing instruction.
  1150.  
  1151. Parameter
  1152.  
  1153. Name: string (optional)    The name of the instruction
  1154.  
  1155. SGMLProcessingInstructionDlg
  1156.  
  1157. Syntax
  1158.  
  1159. SGMLProcessingInstructionDlg()
  1160.  
  1161. Description
  1162.  
  1163. Lets you insert an XML processing instruction.
  1164.  
  1165. SGMLProcessTarget
  1166.  
  1167. Syntax
  1168.  
  1169. SGMLProcessTarget(Name As String, [PublicID As String], [FilePath As String])
  1170.  
  1171. Description
  1172.  
  1173. Lets you create a process target declaration.
  1174.  
  1175. Parameters
  1176.  
  1177. Name: string    The name of the target
  1178.  
  1179. PublicID: string (optional)    The ID
  1180.  
  1181. FilePath: string (optional)    The file path
  1182.  
  1183. SGMLProcessTargetDelete
  1184.  
  1185. Syntax
  1186.  
  1187. SGMLProcessTargetDelete(Name As String)
  1188.  
  1189. Description
  1190.  
  1191. Lets you delete a process target.
  1192.  
  1193. Parameter
  1194.  
  1195. Name: string    The name of the target
  1196.  
  1197. SGMLProcessTargetFilePath
  1198.  
  1199. Syntax
  1200.  
  1201. SGMLProcessTargetFilePath(TargetName As String, FilePath As String)
  1202.  
  1203. Description
  1204.  
  1205. Lets you set the file path of a process target.
  1206.  
  1207. Parameters
  1208.  
  1209. TargetName: string    The name of the target
  1210.  
  1211. FilePath: string    The file path
  1212.  
  1213. SGMLProcessTargetPubID
  1214.  
  1215. Syntax
  1216.  
  1217. SGMLProcessTargetPubID(TargetName As String, PublicID As String)
  1218.  
  1219. Description
  1220.  
  1221. Lets you change the public ID of a process target.
  1222.  
  1223. Parameters
  1224.  
  1225. TargetName: string    The name of the target
  1226.  
  1227. FilePath: string    The file path
  1228.  
  1229. SGMLProcessTargetRename
  1230.  
  1231. Syntax
  1232.  
  1233. SGMLProcessTargetRename(OldName As String, NewName As String)
  1234.  
  1235. Description
  1236.  
  1237. Lets you change the name of a process target.
  1238.  
  1239. Parameters
  1240.  
  1241. OldName: string    The old name
  1242.  
  1243. NewName: string    The new name
  1244.  
  1245. SGMLRenameElement
  1246.  
  1247. Syntax
  1248.  
  1249. SGMLRenameElement(Name As String)
  1250.  
  1251. Description
  1252.  
  1253. Rename the element previous to the insertion point. Does not change the element attributes. This method is valid only if the WordPerfect SGML program component is installed.
  1254.  
  1255. Parameters
  1256.  
  1257. Name: string    The new name for the element.
  1258.  
  1259. SGMLReplaceAttribute
  1260.  
  1261. Syntax
  1262.  
  1263. SGMLReplaceAttribute(Name As String, Value As String)
  1264.  
  1265. Description
  1266.  
  1267. Replace the current attribute value. The attribute must be present in the previous start tag. This method is valid only if the WordPerfect SGML program component is installed.
  1268.  
  1269. Parameters
  1270.  
  1271. Name: string    The name of the attribute.
  1272.  
  1273. Value: string    The value of the attribute.
  1274.  
  1275. SGMLRootElement
  1276.  
  1277. Syntax
  1278.  
  1279. SGMLRootElement(Element As String)
  1280.  
  1281. Description
  1282.  
  1283. Change the root element of the current document type. This method is valid only if the WordPerfect SGML program component is installed.
  1284.  
  1285. Parameters
  1286.  
  1287. Element: string    The name of the root element.
  1288.  
  1289. SGMLRootElementDlg
  1290.  
  1291. Syntax
  1292.  
  1293. SGMLRootElementDlg()
  1294.  
  1295. Description
  1296.  
  1297. Display the Select Root Element dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  1298.  
  1299. SGMLSaveAsOptions
  1300.  
  1301. Syntax
  1302.  
  1303. SGMLSaveAsOptions(DocTypeDeclaration As _SGMLSaveAsOptions_DocTypeDeclaration_enum, [SGMLDeclaration As _SGMLSaveAsOptions_SGMLDeclaration_enum], [WrapText As SGMLSaveAsOptions_WrapText_enum])
  1304.  
  1305. Description
  1306.  
  1307. Set options for saving a document in SGML format. This method is valid only if the WordPerfect SGML program component is installed.
  1308.  
  1309. Parameters
  1310.  
  1311. DocTypeDeclaration: enumeration    Include the Document Type Declaration in the saved SGML document. Default: Yes!
  1312.  
  1313. No!
  1314.  
  1315. Yes!
  1316.  
  1317. SGMLDeclaration: enumeration (optional)    Include the SGML declaration at the beginning of the file. Default: No!
  1318.  
  1319. No!
  1320.  
  1321. Yes!
  1322.  
  1323. ConvertSRT: enumeration (optional)    Convert soft returns in the document to hard returns in the saved SGML document. This method is obsolete in version 9; it has been left in for backwards compatibility.
  1324.  
  1325. No!
  1326.  
  1327. Yes!
  1328.  
  1329. SGMLSelectElement
  1330.  
  1331. Syntax
  1332.  
  1333. SGMLSelectElement()
  1334.  
  1335. Description
  1336.  
  1337. Select the open element at the insertion point. This method is valid only if the WordPerfect SGML program component is installed.
  1338.  
  1339. SGMLSelectLayout
  1340.  
  1341. Syntax
  1342.  
  1343. SGMLSelectLayout([LayoutFile As String])
  1344.  
  1345. Description
  1346.  
  1347. Change the layout of the SGML elements. This method is valid only if the WordPerfect SGML program component is installed.
  1348.  
  1349. Parameters
  1350.  
  1351. LayoutFile: string (optional)    The filename of the layout file.
  1352.  
  1353. SGMLSelectLayoutDlg
  1354.  
  1355. Syntax
  1356.  
  1357. SGMLSelectLayoutDlg()
  1358.  
  1359. Description
  1360.  
  1361. Display the Select Layouts dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  1362.  
  1363. SGMLSetValidation
  1364.  
  1365. Syntax
  1366.  
  1367. SGMLSetValidation([Options])
  1368.  
  1369. Description
  1370.  
  1371. Specify the types of errors to find during validation. This method is valid only if the WordPerfect SGML program component is installed.
  1372.  
  1373. Parameters
  1374.  
  1375. Options: enumeration (optional)    CharMap!
  1376.  
  1377. Entity!
  1378.  
  1379. EntityDecl!
  1380.  
  1381. IdIdref!
  1382.  
  1383. Logic!
  1384.  
  1385. TextSeq!
  1386.  
  1387. SGMLSplitElement
  1388.  
  1389. Syntax
  1390.  
  1391. SGMLSplitElement()
  1392.  
  1393. Description
  1394.  
  1395. Split the current SGML element into two separate elements of the same type. The attribute values will be duplicated for each element created. This method is valid only if the WordPerfect SGML program component is installed.
  1396.  
  1397. SGMLTagAllTables
  1398.  
  1399. Syntax
  1400.  
  1401. SGMLTagAllTables()
  1402.  
  1403. Description
  1404.  
  1405. Tag all tables in a document. Can be used only with a document type that allows table tagging. This method is valid only if the WordPerfect SGML program component is installed.
  1406.  
  1407. SGMLTagBox
  1408.  
  1409. Syntax
  1410.  
  1411. SGMLTagBox()
  1412.  
  1413. Description
  1414.  
  1415. Tag the selected box based on the mappings specified in the layout (.LSI) file. This method is valid only if the WordPerfect SGML program component is installed.
  1416.  
  1417. SGMLTagCurrentTable
  1418.  
  1419. Syntax
  1420.  
  1421. SGMLTagCurrentTable()
  1422.  
  1423. Description
  1424.  
  1425. 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.
  1426.  
  1427. Basic Table Structure:
  1428.  
  1429. For CALS: colspec, entry, row, spanspec, table, tbody, tgroup, thead, and title.
  1430.  
  1431. For AAP: ctbf, ctbl, ctby, ctc, cte, cth, cthd, cthr, ctr, ctsb1, ctsb2, ctsb3, ctsb4, and ctsh.
  1432.  
  1433. For HTML: table, tr, td, th.
  1434.  
  1435. For WP6: table, cell, colinf, and row.
  1436.  
  1437. For WP6MIN: table, cell, and row.
  1438.  
  1439. For WP: wpcell, wprow, and wptable.
  1440.  
  1441. This method is valid only if the WordPerfect SGML program component is installed.
  1442.  
  1443. SGMLTagTablesDlg
  1444.  
  1445. Syntax
  1446.  
  1447. SGMLTagTablesDlg()
  1448.  
  1449. Description
  1450.  
  1451. Display the Tag Tables dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  1452.  
  1453. SGMLTextRefDlg
  1454.  
  1455. Syntax
  1456.  
  1457. SGMLTextRefDlg()
  1458.  
  1459. Description
  1460.  
  1461. Display the Text References dialog box. This method is valid only if the WordPerfect SGML program component is installed. Not recordable.
  1462.  
  1463. SGMLUnloadDocType
  1464.  
  1465. Syntax
  1466.  
  1467. SGMLUnloadDocType()
  1468.  
  1469. Description
  1470.  
  1471. 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 method is valid only if the WordPerfect SGML program component is installed.
  1472.  
  1473. SGMLValidate
  1474.  
  1475. Syntax
  1476.  
  1477. SGMLValidate()
  1478.  
  1479. Description
  1480.  
  1481. Find the next validation error. This method is valid only if the WordPerfect SGML program component is installed.
  1482.  
  1483. SGMLValidationDlg
  1484.  
  1485. Syntax
  1486.  
  1487. SGMLValidationDlg()
  1488.  
  1489. Description
  1490.  
  1491. Display the Validation dialog box. This method is valid only if the WordPerfect SGML program component is installed.
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.  
  1498.