com.esri.arcgis.schematic
Interface ISchematicXmlBuilderContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicXmlBuilderContextProxy

public interface ISchematicXmlBuilderContext
extends Serializable

Provides access to members that control information related to the context when the Xml builder runs.

Description

This interface is new at ArcGIS 9.3.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

Object	getApplicationHook() ESRI application hook (desktop application or engine application) for the XML plugin component.
Object	getXmlSource() Xml Source to parse for generating/updating the diagram.
void	setApplicationHookByRef(Object hook) ESRI application hook (desktop application or engine application) for the XML plugin component.
void	setXmlSource(Object xmlSource) Xml Source to parse for generating/updating the diagram.

Method Detail

setXmlSource

void setXmlSource(Object xmlSource)
                  throws IOException,
                         AutomationException

Xml Source to parse for generating/updating the diagram. This may be an URL (String/BSTR) that specifies the location of the XML file, a DOMDocument object, a SAFEARRAY of bytes (VT_ARRAY|VT_UI1), or any object that supports IStream, ISequentialStream, or IPer?Y??&

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

xmlSource - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXmlSource

Object getXmlSource()
                    throws IOException,
                           AutomationException

Xml Source to parse for generating/updating the diagram. This may be an URL (String/BSTR) that specifies the location of the XML file, a DOMDocument object, a SAFEARRAY of bytes (VT_ARRAY|VT_UI1), or any object that supports IStream, ISequentialStream, or IPer?Y??&

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplicationHookByRef

void setApplicationHookByRef(Object hook)
                             throws IOException,
                                    AutomationException

ESRI application hook (desktop application or engine application) for the XML plugin component. Useful only when the XMLSource is not provided.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getApplicationHook

Object getApplicationHook()
                          throws IOException,
                                 AutomationException

ESRI application hook (desktop application or engine application) for the XML plugin component. Useful only when the XMLSource is not provided.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.