EventItem

Inheritance: java.lang.Object

public class EventItem

Encapsulates an event code. An EventItem element can trigger two kinds of actions: it can run an add-on, or it can send a notification of the event to the calling program.

Constructors

ConstructorDescription
EventItem()Constructor.

Methods

MethodDescription
equals(Object arg0)
getAction()Specifies the action code of the parent EventItem element.For an EventItem element to be saved in a DatadiagramML file, it must be persistable.
getClass()
getEnabled()Represents a flag indicating if the event is enabled or disabled.
getEventCode()A code indicating the event that triggers the add-on.
getID()The ID of the event.
getTarget()Specifies the target of an event.
getTargetArgs()Specifies a string containing arguments to be sent to the target of an event.
hashCode()
notify()
notifyAll()
setAction(int value)For the description of this property, please see getAction()
setEnabled(int value)For the description of this property, please see getEnabled()
setEventCode(int value)For the description of this property, please see getEventCode()
setID(int value)For the description of this property, please see getID()
setTarget(String value)For the description of this property, please see getTarget()
setTargetArgs(String value)For the description of this property, please see getTargetArgs()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

EventItem()

public EventItem()

Constructor.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getAction()

public int getAction()

Specifies the action code of the parent EventItem element.For an EventItem element to be saved in a DatadiagramML file, it must be persistable. Currently, the only valid action code a persistable event can have is 1 (ONEVENT_ACT_RUNADDON).

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEnabled()

public int getEnabled()

Represents a flag indicating if the event is enabled or disabled.

Returns: int

getEventCode()

public int getEventCode()

A code indicating the event that triggers the add-on. For more information on event codes, see Event Codes in the Microsoft Visio 2007 Automation Reference.

Returns: int

getID()

public int getID()

The ID of the event.

Returns: int

getTarget()

public String getTarget()

Specifies the target of an event.

Returns: java.lang.String

getTargetArgs()

public String getTargetArgs()

Specifies a string containing arguments to be sent to the target of an event.

Returns: java.lang.String

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAction(int value)

public void setAction(int value)

For the description of this property, please see getAction()

Parameters:

ParameterTypeDescription
valueint

setEnabled(int value)

public void setEnabled(int value)

For the description of this property, please see getEnabled()

Parameters:

ParameterTypeDescription
valueint

setEventCode(int value)

public void setEventCode(int value)

For the description of this property, please see getEventCode()

Parameters:

ParameterTypeDescription
valueint

setID(int value)

public void setID(int value)

For the description of this property, please see getID()

Parameters:

ParameterTypeDescription
valueint

setTarget(String value)

public void setTarget(String value)

For the description of this property, please see getTarget()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setTargetArgs(String value)

public void setTargetArgs(String value)

For the description of this property, please see getTargetArgs()

Parameters:

ParameterTypeDescription
valuejava.lang.String

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int