Package com.altova.automation.StyleVision

Class Documents

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.StyleVision.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.
Document	getActiveDocument()	method ActiveDocument
COMIDispatchObject	getApplication()	property Application
int	getCount()
GUID	getInterfaceIID()
Document	getItem(int n)
COMIDispatchObject	getParent()	property Parent
java.util.Iterator<Document>	iterator()
Document	newDocument()	method NewDocument
Document	openDocument(java.lang.String strPath)	method OpenDocument

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

getApplication

public COMIDispatchObject getApplication() throws AutomationException

property Application

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

property Parent

Throws:

AutomationException

openDocument

public Document openDocument(java.lang.String strPath) throws AutomationException

method OpenDocument

Throws:

AutomationException

newDocument

public Document newDocument() throws AutomationException

method NewDocument

Throws:

AutomationException

getActiveDocument

public Document getActiveDocument() throws AutomationException

method ActiveDocument

Throws:

AutomationException

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Document>