AIXMLDocumentSuite Struct Reference
[API Suite List]

An Illustrator document can store an XML document element in its dictionary. More...

#include <AIXMLElement.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetDocumentElement )(AIXMLNodeRef *element)
	Retrieves the XML document for the current Illustrator document, creating one if none exists.
AIAPI AIErr(*	GetDocumentMetadata )(AIXMLNodeRef *element)
	Retrieves the metadata element from the XML document for the current Illustrator document, creating one if none exists.
AIAPI AIErr(*	CreateElement )(AIXMLName name, AIXMLNodeRef *element)
	Creates a new metadata element.
AIAPI AIErr(*	CreateAttribute )(AIXMLName name, AIXMLString value, AIXMLNodeRef *attribute)
	Creates a new metadata attribute.
AIAPI AIErr(*	CreateTextNode )(AIXMLString string, AIXMLNodeRef *text)
	Creates a new metadata text node.
AIAPI AIErr(*	CreateComment )(AIXMLString string, AIXMLNodeRef *comment)
	Creates a new metadata comment node.
AIAPI AIErr(*	CreateCDATASection )(AIXMLString string, AIXMLNodeRef *cdata)
	Creates a new metadata CDATA node.
AIAPI AIErr(*	GetElementsByTagName )(AIXMLNodeRef node, AIXMLName name, ai::int32 *count, AIXMLNodeRef *match)
	Retrieves XML elements at or under a node that match a name pattern.

---

Detailed Description

An Illustrator document can store an XML document element in its dictionary.

This suite allows you to create and access the XML document and its contained metadata element.

When an Illustrator document is exported to SVG, the metadata element is written to the SVG file. Before writing the file, Illustrator sends the kAIMetadataSyncNotifier to ensure that the metadata is updated. When Illustrator reads an SVG file, the metadata in the SVG becomes the document metadata element.

This suite provides an approximate implementation of the XML Level 1 DOM interface for documents. See http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#i-Document

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIXMLDocumentSuite and kAIXMLDocumentVersion.

---

Member Data Documentation

AIAPI AIErr(* AIXMLDocumentSuite::CreateAttribute)(AIXMLName name, AIXMLString value, AIXMLNodeRef *attribute)

Creates a new metadata attribute.

Parameters:

	name	The attribute name.
	value	The attribute value.
	attribute	[out] A buffer in which to return the new attribute.

AIAPI AIErr(* AIXMLDocumentSuite::CreateCDATASection)(AIXMLString string, AIXMLNodeRef *cdata)

Creates a new metadata CDATA node.

Parameters:

	string	The CDATA string.
	cdata	[out] A buffer in which to return the new CDATA node.

AIAPI AIErr(* AIXMLDocumentSuite::CreateComment)(AIXMLString string, AIXMLNodeRef *comment)

Creates a new metadata comment node.

Parameters:

	string	The comment string.
	comment	[out] A buffer in which to return the new comment node.

AIAPI AIErr(* AIXMLDocumentSuite::CreateElement)(AIXMLName name, AIXMLNodeRef *element)

Creates a new metadata element.

Parameters:

	name	The element name.
	element	[out] A buffer in which to return the new element.

AIAPI AIErr(* AIXMLDocumentSuite::CreateTextNode)(AIXMLString string, AIXMLNodeRef *text)

Creates a new metadata text node.

Parameters:

	string	The text string.
	text	[out] A buffer in which to return the new text node.

AIAPI AIErr(* AIXMLDocumentSuite::GetDocumentElement)(AIXMLNodeRef *element)

Retrieves the XML document for the current Illustrator document, creating one if none exists.

Parameters:

element

[out] A buffer in which to return the XML document element.

Note:

This is not a part of the XML DOM specification.

AIAPI AIErr(* AIXMLDocumentSuite::GetDocumentMetadata)(AIXMLNodeRef *element)

Retrieves the metadata element from the XML document for the current Illustrator document, creating one if none exists.

Parameters:

element

[out] A buffer in which to return the metadata element.

Note:

This is not a part of the XML DOM specification.

AIAPI AIErr(* AIXMLDocumentSuite::GetElementsByTagName)(AIXMLNodeRef node, AIXMLName name, ai::int32 *count, AIXMLNodeRef *match)

Retrieves XML elements at or under a node that match a name pattern.

The matching elements are determined by a pre-order traversal.

Parameters:

	node	A node at any level of the XML tree.
	name	The name pattern to match. The special name "*" matches all elements.
	count	[in, out] On input, the maximum number of matches to return. On return, the number of array elements actually filled.
[in,out]	An	array of nodes of size count, in which to return matching nodes.

Note:

This implementation differs from the XML DOM specification.

---

The documentation for this struct was generated from the following file:

• AIXMLElement.h