Package com.altova.automation.libs

Class COMIDispatchObject

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

Direct Known Subclasses:

AppOutputLine, AppOutputLines, AppOutputLineSymbol, AuthenticContextMenu, AuthenticDataTransfer, AuthenticEvent, AuthenticEventContext, AuthenticRange, AuthenticSelection, AuthenticView, AutomationServer, CodeGeneratorDlg, DatabaseConnection, Dialogs, Document, Documents, DTDSchemaGeneratorDlg, ElementList, ElementListItem, ExportSettings, FileSelectionDlg, FindInFilesDlg, FindInFilesResult, FindInFilesResultMatch, FindInFilesResults, GenerateSampleXMLDlg, GridView, JSONSchemaDocumentationDlg, OldAuthenticView, RaptorXMLCommand, RaptorXMLCommands, RaptorXMLConfiguration, RaptorXMLConfigurations, RaptorXMLServer, RaptorXMLServers, SchemaDocumentationDlg, SpyProject, SpyProjectItem, SpyProjectItems, TextImportExportSettings, TextView, WSDL20DocumentationDlg, WSDLDocumentationDlg, XBRLDocumentationDlg, XMLData

public class COMIDispatchObject
extends COMIUnknownObject

Represents a COM object implementing IDispatch. Only for IDispatch objects COM methods can be invoked and events be received.

Since:

2011 Rel. 3

Field Summary

Fields

Modifier and Type	Field	Description
static short	DISPATCH_METHOD
static short	DISPATCH_PROPERTYGET
static short	DISPATCH_PROPERTYPUT
static short	DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
boolean	addListener(COMDispatchEvent i_listener)	Add a new listener to events received for this COM object.
JVariant	getProperty(int dispIdMember)	Convenience wrapper to retrieve a COM property value,
JVariant	getProperty(int dispIdMember, JVariant[] pDispParams)	Convenience wrapper to retrieve a COM property value,
JVariant	invoke(int dispIdMember, int dwFlags, JVariant[] pDispParams)	Invoke any member of a COM IDispatch object.
boolean	removeListener(COMDispatchEvent i_listener)	Remove a specific listener form COM event receivers.
void	setProperty(int dispIdMember, JVariant newValue)	Convenience method to set the value of a COM property.
void	setProperty(int dispIdMember, JVariant[] newValueArray)	Convenience method to set the value of a COM property for setter functions that require additional parameters.

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

Field Details

DISPATCH_METHOD

public static final short DISPATCH_METHOD

See Also:

Constant Field Values

DISPATCH_PROPERTYGET

public static final short DISPATCH_PROPERTYGET

See Also:

Constant Field Values

DISPATCH_PROPERTYPUT

public static final short DISPATCH_PROPERTYPUT

See Also:

Constant Field Values

DISPATCH_PROPERTYPUTREF

public static final short DISPATCH_PROPERTYPUTREF

See Also:

Constant Field Values

Method Details

getProperty

public JVariant getProperty(int dispIdMember) throws AutomationException

Convenience wrapper to retrieve a COM property value,

Parameters:

dispIdMember - - the property's COM ID

Returns:

the property's value as a JVariant.

Throws:

AutomationException

getProperty

public JVariant getProperty(int dispIdMember, JVariant[] pDispParams) throws AutomationException

Convenience wrapper to retrieve a COM property value,

Parameters:

dispIdMember - - the property's COM ID

pDispParams - - additional parameters that the property access requires (as used for the Item property).

Returns:

the property's value as a JVariant.

Throws:

AutomationException

setProperty

public void setProperty(int dispIdMember, JVariant newValue) throws AutomationException

Convenience method to set the value of a COM property.

Parameters:

dispIdMember - - the property's COM ID

newValue - - the new value for the property as JVariant.

Throws:

AutomationException

setProperty

public void setProperty(int dispIdMember, JVariant[] newValueArray) throws AutomationException

Convenience method to set the value of a COM property for setter functions that require additional parameters.

Parameters:

dispIdMember - - the property's COM ID

newValueArray - - the new value for the property as JVariant and any additional parameters.

Throws:

AutomationException

invoke

public JVariant invoke(int dispIdMember, int dwFlags, JVariant[] pDispParams) throws AutomationException

Invoke any member of a COM IDispatch object.

Parameters:

dispIdMember - - COM ID of the member as defined in the IDL.

dwFlags - - invocation flags selecting method call or setting or getting a property value.

pDispParams - - parameters to the call. Mark out parameters with {JVariant.SetByRefFlag}.

Returns:

parameter marked as [out,retval] in COM IDL.

Throws:

AutomationException

addListener

public boolean addListener(COMDispatchEvent i_listener)

Add a new listener to events received for this COM object.

removeListener

public boolean removeListener(COMDispatchEvent i_listener)

Remove a specific listener form COM event receivers.