Package com.altova.automation.XMLSpy

Class Documents

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.Documents

All Implemented Interfaces:

COMIDispatchConstList<Document>, java.lang.Iterable<Document>

public class Documents
extends COMIDispatchObject
implements COMIDispatchConstList<Document>

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
java.lang.Object	get_NewEnum()	Not used in this context.
int	getCount()
GUID	getInterfaceIID()
Document	getItem(int n)
java.util.Iterator<Document>	iterator()
Document	newAuthenticFile(java.lang.String strSPSPath, java.lang.String strXMLPath)	NewAuthenticFile creates a new XML file and opens it in Authentic View using SPS design strSPSPath.
Document	newFile(java.lang.String strFile, java.lang.String strType)	NewFile creates a new file of type strType (i.e.
Document	newFileFromText(java.lang.String strText, java.lang.String strType)	method NewFileFromText
Document	openAuthenticFile(java.lang.String strSPSPath, java.lang.String strXMLPath)	OpenAuthenticFile opens an XML file or database in Authentic View using SPS design strSPSPath.
Document	openFile(java.lang.String strPath, boolean bDialog)	OpenFile opens the file strPath.
Document	openURL(java.lang.String strURL, Enums.SPYURLTypes nURLType, Enums.SPYLoading nLoading, java.lang.String strUser, java.lang.String strPassword)	method OpenURL
Document	openURLDialog(java.lang.String strURL, Enums.SPYURLTypes nURLType, Enums.SPYLoading nLoading, java.lang.String strUser, java.lang.String strPassword)	method OpenURLDialog

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

addListener, getProperty, getProperty, invoke, removeListener, setProperty, setProperty

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

dispose, equals, getCOMInterfacePointer, isNull

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

getInterfaceIID

public GUID getInterfaceIID()

getCount

public int getCount() throws AutomationException

Specified by:

getCount in interface COMIDispatchConstList<Document>

Returns:

number of elements in the list.

Throws:

AutomationException - on COM error.

getItem

public Document getItem(int n) throws AutomationException

Specified by:

getItem in interface COMIDispatchConstList<Document>

Parameters:

n - get element at specified index. COM lists typically are 1-based!

Returns:

element at index

Throws:

AutomationException - on COM error

get_NewEnum

public java.lang.Object get_NewEnum() throws AutomationException

Description copied from interface: COMIDispatchConstList

Not used in this context. Lists get iterated based on indices.

Specified by:

get_NewEnum in interface COMIDispatchConstList<Document>

Returns:

COM enumerator for the list.

Throws:

AutomationException - on COM error

openFile

public Document openFile(java.lang.String strPath, boolean bDialog) throws AutomationException

OpenFile opens the file strPath. If bDialog is TRUE, a file-dialog will be displayed.

Throws:

AutomationException

newFile

public Document newFile(java.lang.String strFile, java.lang.String strType) throws AutomationException

NewFile creates a new file of type strType (i.e. xml).

Throws:

AutomationException

openURL

public Document openURL(java.lang.String strURL, Enums.SPYURLTypes nURLType, Enums.SPYLoading nLoading, java.lang.String strUser, java.lang.String strPassword) throws AutomationException

method OpenURL

Throws:

AutomationException

openURLDialog

public Document openURLDialog(java.lang.String strURL, Enums.SPYURLTypes nURLType, Enums.SPYLoading nLoading, java.lang.String strUser, java.lang.String strPassword) throws AutomationException

method OpenURLDialog

Throws:

AutomationException

newFileFromText

public Document newFileFromText(java.lang.String strText, java.lang.String strType) throws AutomationException

method NewFileFromText

Throws:

AutomationException

openAuthenticFile

public Document openAuthenticFile(java.lang.String strSPSPath, java.lang.String strXMLPath) throws AutomationException

OpenAuthenticFile opens an XML file or database in Authentic View using SPS design strSPSPath.

Throws:

AutomationException

newAuthenticFile

public Document newAuthenticFile(java.lang.String strSPSPath, java.lang.String strXMLPath) throws AutomationException

NewAuthenticFile creates a new XML file and opens it in Authentic View using SPS design strSPSPath.

Throws:

AutomationException

iterator

public java.util.Iterator<Document> iterator()

Specified by:

iterator in interface java.lang.Iterable<Document>