List of enumerated values that can be used as Extensibility Interface argument types.

AccessMode

string

The access mode for the current document. AccessMode is available in an (embedded)
OLE Word Document. When an OLE Word Document is the active document, this is the access
mode of the parent XML Author document that owns the OLE Word Document.

DeleteNodes

2-d array of DeleteNode-ParentNode pairs:

XmlNode[element,parent]

Special argument type that is only valid for an EI method specified under the BeforeComponentDelete
and ComponentDelete events. It holds a list of elements that either will be deleted
(when used with BeforeComponentDelete) or have been deleted (when used with ComponentDelete)
and their parent nodes. For example, suppose you were to delete <Title/> and <Para/>
from:

<Section>

  <Title/>

  <Para/>

</Section>

DeleteNodes would supply an array containing the following:

• Title-Section

• Para-Section

Note that when DeleteNodes is used as an argument for an EI method under BeforeComponentDelete,
the first element in each pair is still part of the XOM.

When DeleteNodes is used with ComponentDelete, the first element in each pair is no
longer part of the XOM.

DocNumber

Int

The repository document number for a checked out document. A new document will have
a DocNumber of 0. Used by Xpress Server[1].

DocumentType

string

This argument may be assigned a value by the Xpress Server based on taxonomy (document
classification) or catalog information. For example, this would allow a process to
differentiate between ‘Document’ and ‘Template’ document types.

ExportedCurrentNode

XML Node

With this argument type, only the currently selected element is serialized. In other
words, a new XmlNode is created that will contain element content, but will not have
references to parent or child nodes.

ExportedCurrentNodeTree

XML Node

This argument has the same characteristics as ExportedCurrentNode, but also includes
all descendent elements.

ExportedRoot

XML Node

Indicates a schema-valid XML document. This document contains element content and
is fully de-referenced including CALS-standard tables. Because this argument type
requires normalizing the Quark XML Author and Word object models, it may require processing
time for larger documents.

Filename

string

Provides an EI method with the currently active document’s full name, including paths.

PasteNode

XML Node

Special argument type used exclusively by any BeforePaste and InsertComponent EI methods.
Contains the node being pasted (for any EI methods in BeforePaste event) or the node
after it has been pasted (for any EI methods inside InsertComponent event).

Revision

int

The repository revision number for a checked out document. When a document is checked
in, it will be assigned a Revision 1 greater than this value. A new document will
have a Revision of 0. Used by Xpress Server.

StyleList

ArrayList of strings

Special argument type used exclusively by the BuildStyleList EI methods. Contains
a list of currently insertable elements. Used to facilitate business rules that cannot
be supported by configuration. For example, a business rule states that only one instance
of a certain content element can exist in a given document.

ToggleState

boolean

Special argument type used exclusively for external method wired to a toggle menu
item. Indicates the current state of the toggle button.

Pressed=true

Depressed=false)

UserName

string

The username of the individual authoring or revising the document as specified in
the document header. As is the case with all Quark XML Author header information,
it is populated by the Xpress Server (servlet).

WordUserName

string

The UserName property of the Word application.

XomCurrentNode

XML Node

The XOM node corresponding to the user’s current selection. If the current selection
is on an empty style or it spans multiple paragraphs, XomCurrentNode will be null.
See section 6.3.1, “XOM Defined” for a definition of XOM.

XOMCurrentNode is available in an (embedded) OLE Word Document. When an OLE Word Document
is the active document, the XOM node corresponds to a node within the Psuedo XOM of
the OLE Word Document.

XomRoot

XML Node

The XOM node corresponding to the current document root. See section 6.3.1, “XOM Defined”
for a definition of XOM. XOMRoot is available in an (embedded) OLE Word Document.
When an OLE Word Document is the active document, the XOM node corresponds to the
root of the parent XML Author document that owns the OLE Word Document.

XomSelectedNodes

XML Node

The XOM nodes corresponding to the user’s current selection when the selection spans
multiple elements. Note that only nodes with a defined relationship to the external
method are included. To define a relationship with the external method, the method
must be referenced in the ElementDef’s ExtensibilityMethods section. See Section 14.10
for more information about the ExtensiblityMethods section of ElementDef. See section
6.3.1, “XOM Defined” for a definition of XOM.

XomPreviousNode

XML Node

The XOM node corresponding to the previous visible node if selection is on an empty.
Otherwise null. See section 6.3.1, “XOM Defined” for a definition of XOM.

StyleListParents

Arraylist of XML Node

A special argument type to be used exclusively by the BuildStyleList EI methods. This
contains a list of parents of currently insertable elements provided by the styleList
argument with a one–on–one linkage with stylelist items. This argument can help the
EI developer to distinguish between insertables under different parents with the same
name.