com.togethersoft.openapi.ide
Interface IdeContext

public interface IdeContext

Contains information about selected elements at the moment the script was called.

IdeContext is passed as a parameter to script's run method. This allows the script to extract information about the selection at the moment the script was called, because at the moment the run method starts, the selection might be changed.

Author:

TogetherSoft

See Also: IdeScript.run(com.togethersoft.openapi.ide.IdeContext)

public IdeDiagram getDiagram()

Returns an IdeDiagram containing selected elements.

Returns: IdeDiagram containing selected elements

public IdeElement[] getElements()

public Object getUserParameter(String parameterName)

Returns the value of the specified user parameter. User parameters are usually defined in the config files.

Parameters:

parameterName - String name of the user parameter

Returns: Object value of this user parameter