com.esri.arcgis.schematic
Class NgProject

java.lang.Object
  com.esri.arcgis.schematic.NgProject

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, INgProject, INgProjectAlgorithm, INgProjectAnalyst, INgProjectBuilder, INgProjectTool, INgProjectViews, ISchematicAlgorithmEvents, ISupportErrorInfo, Serializable, EventListener

public class NgProject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgProject, INgProjectBuilder, INgProjectAlgorithm, INgProjectAnalyst, INgProjectTool, INgProjectViews, ISupportErrorInfo, IConnectionPointContainer, ISchematicAlgorithmEvents

Project object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

NgProject()
Constructs a NgProject using ArcGIS Engine.

NgProject(Object obj)
Construct a NgProject using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addAlgorithm(String cLSID, ISchematicAlgorithm algorithm) Adds the specified schematic algorithm to the project.
void	addDataSource(INgDataSource dataSource) Adds the specified data source into the project.
void	addINgProjectEventsListener(INgProjectEvents theListener) addINgProjectEventsListener.
void	addISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener) addISchematicAlgorithmEventsListener.
void	addTrace(String cLSID, ISchematicAlgorithm algorithm) Adds the specified schematic network trace analyst to the project.
void	addUserAttributes(Object userAttributes, String attributesSetName) Adds the specified attributes set into the project.
void	addUserProcedures(Object userProcedures, String proceduresSetName) Adds the specified procedures set into the project.
void	afterExecuteAlgorithm(ISchematicAlgorithmEventsAfterExecuteAlgorithmEvent theEvent) Fires after any schematic algorithm execution on any view.
boolean	beforeExecuteAlgorithm(ISchematicAlgorithmEventsBeforeExecuteAlgorithmEvent theEvent) Fires before any schematic algorithm execution on any view.
void	beginWaitCursor() Enables the wait cursor.
void	close() Closes the currently opened schematic session.
INgBehavior	createBehavior(String evtName, int metaType, String objectType) Creates the behavior to respond to the event 'evtName' on the metatype 'metaType' for the object type named 'objectType'.
INgDiagramType	createDiagramType(String diagTypeName, INgDiagramType parent) Creates a new diagram type named 'diagTypeName'.
INgElementType	createElementType(String eltTypeName, int type, INgElementType parent, boolean createGroup) Creates a new element type named 'eltTypeName' whose type is 'Type'.
INgFlagModel	createFlagModel(String flagModelName) Creates a new flag mode named 'flagModelName' for the project.
INgPatternModel	createPatternModel(String patternModelName, int type, String text) Creates a new pattern model named 'patternModelName' for the project.
void	dblClick(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser) Occurs when a mouse button is double clicked when the project tool is active.
void	deleteAttributeSets() Deletes all the attribute sets associated with the project.
void	deleteDataSources() Deletes all the data sources associated with the project.
void	deleteProcedureSets() Deletes all the procedure sets associated with the project.
void	endWaitCursor() Disables the wait cursor.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
INgView	getActiveView() Current active view in the project.
ISchematicAlgorithm	getAlgorithm(String cLSID) Returns the specified schematic algorithm defined for the project.
ISchematicAlgorithms	getAlgorithms() List of the schematic algorithms defined for the project.
ISchematicAlgorithmSheet	getAlgorithmSheet() Properties page of the schematic algorithm.
ISchematicAlgorithmSheet	getAnalystSheet() Properties page of the schematic network trace analyst.
INgBehaviors	getBehaviors() List of the behaviors defined for the project.
INgBehaviors	getBehaviors2(int metaType, String objTypeName) Returns the list of the behaviors defined for the metatype 'metaType'.
static String	getClsid() getClsid.
void	getColorIndex(short red, short green, short blue, int[] colorIndex) Returns the color index corresponding to the specified RGB values in the project.
INgDataSource	getDataSource(String dataSourceName) Returns the datasource named 'dataSourceName'.
INgDataSources	getDataSources() List of the datasources defined for the project.
INgDiagramType	getDiagramType(String dgTypeName) Returns the diagram type named 'dgTypeName' implemented by the project.
INgDiagramTypes	getDiagramTypes() List of the diagram types associated with the project.
Object	getEffect(int effect) Returns the effect 'effect' set for the project (see esriNgProjectEffect).
INgElementType	getElementType(String eltTypeName) Returns the element type named 'eltTypeName' implemented by the project.
INgElementTypes	getElementTypes() List of the element types associated with the project.
INgFlagModel	getFlagModel(String flagModelName) Returns the flag model named 'flagModelName' implemented by the project.
INgFlagModels	getFlagModels() List of the flag models implemented by the project.
void	getFontIndex(String fontName, int[] fontIndex) Returns the font index corresponding to font named 'fontName' in the project.
String	getHelpFile() Name of the online help file.
Object	getHighlightingEffect(int effect) Returns the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
int	getInteractorMode() Returns the currently active interaction (see esriNgInteractorMode).
INgDiagrams	getOpenedDiagrams() List of the diagrams currently opened in the project.
INgViews	getOpenedViews() List of the views that are currently open in the project.
INgPatternModel	getPatternModel(String patternModelName) Returns the pattern model named 'patternModelName' implemented by the project.
INgPatternModels	getPatternModels() List of the pattern models implemented by the project.
void	getPrintableArea(double[] width, double[] height) Returns the current printing area defined in the printer configuration dialog box.
String	getProjectFileName() Full pathname of the '.ini' file used to initialize the project.
int	getSaveMode() Saving mode for the schematic session.
void	getScreenSize(int[] width, int[] height) Returns the screen 'width' and 'height' in pixels units.
INgElements	getSelectedElements() List of the elements currently selected in the project.
INgFlags	getSelectedFlags() List of the flags currently selected in the project.
INgSymbol	getSymbol(String symbolName) Returns the symbol named 'symbolName'.
void	getTileArea(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points enclosing the area used to position the schematic windows.
ISchematicAlgorithm	getTrace(String cLSID) Returns the specified schematic network trace analyst defined for the project.
ISchematicAlgorithms	getTraces() List of the schematic network trace analysts defined for the project.
INgUserAttributeSets	getUserAttributeSets() List of the user attibute sets defined for the project.
INgUserProcedureSets	getUserProcedureSets() List of the user procedure sets defined for the project.
int	hashCode() the hashcode for this object
void	initialize(String fName) Initializes the project based on the parameters contained in the file 'fName'.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the project is set (see esriNgProjectEffect).
boolean	isHighlightingEffectSet(int effect) Indicates if the effect 'effect' used for highlighting the elements when they are selected is set.
boolean	isProjectOpen() Indicates if the schematic session is open.
boolean	isSpatialEnvironment() Indicates if the event occured in ArcMap.
void	keyDown(INgView view, int keyCode, int shift) Occurs when a key on the keyboard is pressed when the project tool is active.
void	keyUp(INgView view, int keyCode, int shift) Occurs when a key on the keyboard is released when the project tool is active.
void	mouseDown(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser) Occurs when a mouse button is pressed when the project tool is active.
void	mouseMove(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser) Occurs when the mouse is moved when the project tool is active.
void	mouseUp(INgView view, int button, int shift, int xScreen, int yScreen, int xWindow, int yWindow, double xUser, double yUser) Occurs when a mouse button is released when the project tool is active.
void	open(boolean restoreSession, boolean selectIfNotSet) Opens the schematic session associated with the project.
INgDiagram	openDiagram(INgDiagramType diagType, String diagramName, boolean restore) Opens the diagram named 'diagramName' implemented by the specified diagram type.
void	openDiagramForm() Opens the predefined Schematics dialog-box that allows to select a type of diagram and a diagram.
void	printSetup() Opens the default printer configuration dialog box.
void	refreshToolbars() Triggers the 'OnRefreshToolbar' predefined callback.
void	reloadSymbol(String symbolName) Reloads the symbol named 'symbolName' in the project.
void	removeAlgorithm(String cLSID) Removes the specified schematic algorithm from the project.
void	removeAlgorithms() Remove all the schematic algorithms from the project.
void	removeHighlightingEffect(int effect) Removes the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
void	removeINgProjectEventsListener(INgProjectEvents theListener) removeINgProjectEventsListener.
void	removeISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener) removeISchematicAlgorithmEventsListener.
void	removeTrace(String cLSID) Removes the specified schematic network trace analyst to the project.
void	removeTraces() Remove all the schematic network trace analysts from the project.
void	replaceDataSource(INgDataSource oldDataSource, INgDataSource newDataSource) Changes the specified old datasource by the specified new datasource in the project.
void	restoreSession(String sessionName) Restores the session named 'sessionName'; that is, restores the views to their last saved position and display state.
void	save(String projectFilePath, String projectFileName) Saves all the parameters that define the project.
void	saveSession(String sessionName) Saves the schematic session associated with the project.
void	sendEvent(String evtName, int metaType, String objectType, String objectName) Sends the event 'eventName' to the object named 'objectName' that is implemented by the object type named 'objectType' of the 'metatype' metatype.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the project (see esriNgProjectEffect).
void	setHelpFile(String pVal) Name of the online help file.
void	setHighlightingEffect(int effect, Object effValue) Modifies the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
void	setInteractorMode(int mode, INgElementType typeToDigit, int digitType) Enables the interaction mode 'mode' (see esriNgInteractorMode).
void	setProjectFileName(String pVal) Full pathname of the '.ini' file used to initialize the project.
void	setSaveMode(int pVal) Saving mode for the schematic session.
void	setSpatialEnvironment(boolean pVal) Indicates if the event occured in ArcMap.
void	setStatus(String status) Triggers the OnStatusChange' predefined callback.
void	setTileArea(INgPoint upperLeftCorner, INgPoint lowerRightCorner) Defines the area enclosed between the 'upperLeftCorner' and 'lowerRightCorner' points that will be used to position the schematic windows.
void	setTraceLevel(int level) Enable the program tracing in 'level' mode.
void	terminate() Puts an end to the schematic session and removes all the schematic components created in memory.
void	tileViews(int mode) Arranges the views according to the 'mode' tile views option (see esriNgTileViewMode).
void	unselectAll() Deselects all elements that are currently selected in all the opened views.
void	unsetTileArea() Restores the default area used to position the view windows.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NgProject

public NgProject()
          throws IOException,
                 UnknownHostException

Constructs a NgProject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NgProject

public NgProject(Object obj)
          throws IOException

Construct a NgProject using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgProject.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgProject theNgProject = (NgProject) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addINgProjectEventsListener

public void addINgProjectEventsListener(INgProjectEvents theListener)
                                 throws IOException

addINgProjectEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.schematic.INgProjectEvents interface.

Throws:

IOException - If there are communications problems.

removeINgProjectEventsListener

public void removeINgProjectEventsListener(INgProjectEvents theListener)
                                    throws IOException

removeINgProjectEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.schematic.INgProjectEvents interface.

Throws:

IOException - If there are communications problems.

addISchematicAlgorithmEventsListener

public void addISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
                                          throws IOException

addISchematicAlgorithmEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.schematic.ISchematicAlgorithmEvents interface.

Throws:

IOException - If there are communications problems.

removeISchematicAlgorithmEventsListener

public void removeISchematicAlgorithmEventsListener(ISchematicAlgorithmEvents theListener)
                                             throws IOException

removeISchematicAlgorithmEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.schematic.ISchematicAlgorithmEvents interface.

Throws:

IOException - If there are communications problems.

getActiveView

public INgView getActiveView()
                      throws IOException,
                             AutomationException

Current active view in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getActiveView in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOpenedDiagrams

public INgDiagrams getOpenedDiagrams()
                              throws IOException,
                                     AutomationException

List of the diagrams currently opened in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getOpenedDiagrams in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgDiagrams

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.getOpenedViews()

getSelectedElements

public INgElements getSelectedElements()
                                throws IOException,
                                       AutomationException

List of the elements currently selected in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelectedElements in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgElements

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getSelectedElements()

getDiagramTypes

public INgDiagramTypes getDiagramTypes()
                                throws IOException,
                                       AutomationException

List of the diagram types associated with the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDiagramTypes in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgDiagramTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getDiagramType(String)

getElementTypes

public INgElementTypes getElementTypes()
                                throws IOException,
                                       AutomationException

List of the element types associated with the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getElementTypes in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgElementTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getElementType(String)

initialize

public void initialize(String fName)
                throws IOException,
                       AutomationException

Initializes the project based on the parameters contained in the file 'fName'.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

initialize in interface INgProject

Parameters:

fName - The fName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.terminate()

terminate

public void terminate()
               throws IOException,
                      AutomationException

Puts an end to the schematic session and removes all the schematic components created in memory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

terminate in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.initialize(String)

addDataSource

public void addDataSource(INgDataSource dataSource)
                   throws IOException,
                          AutomationException

Adds the specified data source into the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addDataSource in interface INgProject

Parameters:

dataSource - A reference to a com.esri.arcgis.schematic.INgDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getDataSource(String), INgProject.getDataSources()

addUserProcedures

public void addUserProcedures(Object userProcedures,
                              String proceduresSetName)
                       throws IOException,
                              AutomationException

Adds the specified procedures set into the project.

Description

The name of that set of procedures is proceduresSetName; it is that name that Schematics uses to reference this set of associated procedures.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addUserProcedures in interface INgProject

Parameters:

userProcedures - A reference to another Automation Object (IDispatch) (in)

proceduresSetName - The proceduresSetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getUserProcedureSets()

addUserAttributes

public void addUserAttributes(Object userAttributes,
                              String attributesSetName)
                       throws IOException,
                              AutomationException

Adds the specified attributes set into the project.

Description

The name of that set of attributes is attributesSetName; it is that name that Schematics uses to reference this set of associated attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addUserAttributes in interface INgProject

Parameters:

userAttributes - A reference to another Automation Object (IDispatch) (in)

attributesSetName - The attributesSetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getUserAttributeSets()

open

public void open(boolean restoreSession,
                 boolean selectIfNotSet)
          throws IOException,
                 AutomationException

Opens the schematic session associated with the project.

Description

If the project is not already initialized (Initialize method), either the selectIfNotSet parameter value is TRUE and Schematics opens the Open MS Window dialog box so that the user can indicate the full pathname of the desired Schematics .ini file that contains the project definition, or the selectIfNotSet parameter value is FALSE and Schematics creates a new empty .ini file in the application's currently active directory.

If the restoreSession parameter is set to TRUE, this method restores all the views to their last saved position and display state (scale, text and symbol sizes...).

Note: If you did not save the diagrams that were open when the session was last saved, the layout of the elements in these diagrams is not restored when the session is opened: the elements associated with the diagrams are positioned based on their database coordinates or on their last saved positions. Indeed, when you save your schematic session, you save the current position and display state of the schematic windows, but their contents (that make up the diagrams) is not saved.

Remarks

About events managed during the project opening...

When the INgProject’s Open method is triggered, several Schematics event procedures are successively fired:

(1) BeforeInitProject

(2) BeforeOpenProject

(3) (OnInitApplication)

(4) AfterOpenProject

(5) OnRefreshToolbar

The following lines detail the Schematics running way during the project opening:

(1) The BeforeInitProject event is fired.

(2) If no .ini file has been set (that is, the ProjectFileName INgProject property is not set) or if the .ini file doesn't exist and if the selectIfNotSet parameter of the Open method is True (default value), the Open MS window form automatically opens allowing you to select the desired .ini file.

When the .ini file is known, the BeforeOpenProject event is fired

(3) Then, the schematic project opens: That is, the project parameters file is loaded. If an error happens during the project parameters file reading, Schematics sets the session status to Closed and the session opening is interrupted.

If no error happens, and if an OnInitApplication event has been declared in the project parameters file, the associated treatments are executed. At the end of this step, Schematics sets the session status to Open.

(4) Then, the AfterOpenProject event is fired

(5) If the restoreSession parameter of the INgProject’s Open method is True (default value), the session is restored according to its last saving: all the views are opened to their last saved position and display state (scale, text and symbol sizes...).

The OnRefreshToolbar event is fired.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

open in interface INgProject

Parameters:

restoreSession - The restoreSession (in, optional, pass true if not required)

selectIfNotSet - The selectIfNotSet (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.restoreSession(String), INgProject.isProjectOpen()

close

public void close()
           throws IOException,
                  AutomationException

Closes the currently opened schematic session.

Description

If you have changed a diagram since the beginning of the session and have not saved it yet, depending on the SaveMode property value of this diagram, you may be asked if you want to save the changes. If you have not saved the current schematic session, depending on the SaveMode property value set for your project, you may be asked to do so before closing.

Note also that the Schematics BeforeCloseProject and AfterCloseProject events automatically fire when you use this method.

Remarks

About events managed during the project closure

When the INgProject’s Close method is triggered is triggered, several Schematics event procedures are successively fired:

(1) BeforeCloseProject

(2) IsDiagramSavedByFramework

(3) IsSessionSavedByFramework

(4) BeforeCloseDiagram , BeforeCloseView, IsViewDestroyedByFramework

(5) AfterCloseProject

The following lines detail the Schematics running way during the project closure:

(1) If the session is already closed, the running is interrupted. The BeforeCloseProject event is fired.

(2) If diagrams are opened, for each opened diagram, Schematics checks its SaveMode property:

. Either the SaveMode INgDiagram property returns esriNgNotSaveByFramework, or the IsDiagramSavedByFramework event procedure returns False, and in these both cases, Schematics doesn’t charge of the diagram saving.

. Either the SaveMode INgDiagram property returns esriNgSaveByFramework, or it returns esriNgSaveUndefined but the IsDiagramSavedByFramework event procedure returns True, and in these both cases, Schematics charges of the diagram saving: a predefined form is automatically opened and end-user is asked if he wants to save the changes for the current diagram.

(3) Next, Schematics takes interest about the session saving:

- Either the SaveMode INgProjectViews property returns esriNgNotSaveByFramework, or the IsSessionSavedByFramework event procedure returns False, and in these both cases, Schematics doesn’t charge of the session saving.

- Or the SaveMode INgProjectViews property returns esriNgSaveByFramework, or it returns esriNgSaveUndefined but the IsSessionSavedByFramework event procedure returns True, and in these both cases, Schematics charges of the session saving: a predefined form is automatically opened and end-user is asked if he wants to save the currently open session.

(4) Then, the running concerns the closing of all the open diagrams (if such open diagrams exists.).

For each open diagram,

The BeforeCloseDiagram event is fired.

Next, the diagram's elements are removed. Then, for each its related opened views, the BeforeCloseView event is fired. If the legend sub-window is displayed in the view, it is deleted.

If the IsViewDestroyedByFramework event procedure returns True, Schematics charges of the view destruction.

(5) The AfterCloseProject event is triggered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

close in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDiagramForm

public void openDiagramForm()
                     throws IOException,
                            AutomationException

Opens the predefined Schematics dialog-box that allows to select a type of diagram and a diagram.

Description

The diagrams available from the dialog’s dropdown lists are those defined in the schematic project parameters file. You select them by their type and name.

- If the diagram chosen was saved during a previous session for instance, it is loaded and restored with the page layout thus and then saved.

- If elements relating to this diagram were created or removed in the database since it was last saved, these modifications are reflected in the display (those elements that were removed no longer appear in the diagram and those that were created are displayed).

Note that when this method is triggered, the IsDiagramOpenedByFramework event function is automatically called. If this event returns FALSE, the Schematics predefined ‘Select diagram to open’ dialog box is not brought up.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

openDiagramForm in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.openDiagram(com.esri.arcgis.schematic.INgDiagramType, String, boolean), INgProjectEvents.isDiagramOpenedByFramework(com.esri.arcgis.schematic.INgProjectEventsIsDiagramOpenedByFrameworkEvent)

unselectAll

public void unselectAll()
                 throws IOException,
                        AutomationException

Deselects all elements that are currently selected in all the opened views.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

unselectAll in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.unselectAll(boolean)

getDiagramType

public INgDiagramType getDiagramType(String dgTypeName)
                              throws IOException,
                                     AutomationException

Returns the diagram type named 'dgTypeName' implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDiagramType in interface INgProject

Parameters:

dgTypeName - The dgTypeName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgDiagramType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getDiagramTypes(), INgProjectBuilder.createDiagramType(String, com.esri.arcgis.schematic.INgDiagramType)

getElementType

public INgElementType getElementType(String eltTypeName)
                              throws IOException,
                                     AutomationException

Returns the element type named 'eltTypeName' implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getElementType in interface INgProject

Parameters:

eltTypeName - The eltTypeName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgElementType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getElementTypes(), INgProjectBuilder.createElementType(String, int, com.esri.arcgis.schematic.INgElementType, boolean)

getFlagModel

public INgFlagModel getFlagModel(String flagModelName)
                          throws IOException,
                                 AutomationException

Returns the flag model named 'flagModelName' implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFlagModel in interface INgProject

Parameters:

flagModelName - The flagModelName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgFlagModel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getFlagModels(), INgProjectBuilder.createFlagModel(String)

getInteractorMode

public int getInteractorMode()
                      throws IOException,
                             AutomationException

Returns the currently active interaction (see esriNgInteractorMode).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getInteractorMode in interface INgProject

Returns:

A com.esri.arcgis.schematic.esriNgInteractorMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.setInteractorMode(int, com.esri.arcgis.schematic.INgElementType, int)

setInteractorMode

public void setInteractorMode(int mode,
                              INgElementType typeToDigit,
                              int digitType)
                       throws IOException,
                              AutomationException

Enables the interaction mode 'mode' (see esriNgInteractorMode).

Description

In the case of the esriNgModeDigit interactor mode, the method also allows specifying the type of elements to be digitized and the digitizing mode (see esriNgDigitType list).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setInteractorMode in interface INgProject

Parameters:

mode - A com.esri.arcgis.schematic.esriNgInteractorMode constant (in)

typeToDigit - A reference to a com.esri.arcgis.schematic.INgElementType (in, optional, pass 0 if not required)

digitType - A com.esri.arcgis.schematic.esriNgDigitType constant (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getInteractorMode()

setTraceLevel

public void setTraceLevel(int level)
                   throws IOException,
                          AutomationException

Enable the program tracing in 'level' mode.

Description

The trace function can be run at three levels:

- esriNgErrorLevel; that is the program is traced and returned errors only.

- esriNgWarningLevel; that is the program is traced and returned errors and warning messages.

- esriNgInformationLevel; that is the program is traced and returned errors, warning messages and information messages (for instance, messages indicating the end of a procedure).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTraceLevel in interface INgProject

Parameters:

level - A com.esri.arcgis.schematic.esriNgTraceLevel constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectEvents.onTrace(com.esri.arcgis.schematic.INgProjectEventsOnTraceEvent)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' set for the project (see esriNgProjectEffect).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setEffect in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.isEffectSet(int), INgProject.setHighlightingEffect(int, java.lang.Object), INgProject.getEffect(int)

openDiagram

public INgDiagram openDiagram(INgDiagramType diagType,
                              String diagramName,
                              boolean restore)
                       throws IOException,
                              AutomationException

Opens the diagram named 'diagramName' implemented by the specified diagram type.

Description

The diagramType INgDiagramType interface must already exist.

The diagramName parameter must be consistent with the diagram name identifier definition for its associated diagram type.

If the query returning all the diagrams of this type is set to NULL (that is, if there is only one diagram of this type), any diagramName can be used: all the associated diagrams represent the same network.

If there is more than one diagram of this type, the diagramName parameter syntax must follow that of the identifier defined for this diagram type otherwise the diagram that will be opened, will be empty!

Note that if the chosen open diagram was previously saved, it is loaded and restored with the page layout thus and then saved.

Remarks

Several Schematic event procedures are automatically chained during a diagram opening. For more details on these events' chaining, please see the Remarks section available from the INgDiagram Open method help-page.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

openDiagram in interface INgProject

Parameters:

diagType - A reference to a com.esri.arcgis.schematic.INgDiagramType (in)

diagramName - The diagramName (in)

restore - The restore (in, optional, pass true if not required)

Returns:

A reference to a com.esri.arcgis.schematic.INgDiagram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.openDiagramForm(), INgDiagramType.openDiagram(String, boolean)

getPatternModel

public INgPatternModel getPatternModel(String patternModelName)
                                throws IOException,
                                       AutomationException

Returns the pattern model named 'patternModelName' implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPatternModel in interface INgProject

Parameters:

patternModelName - The patternModelName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgPatternModel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getPatternModels(), INgProjectBuilder.createPatternModel(String, int, String)

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the project (see esriNgProjectEffect).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getEffect in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.isEffectSet(int), INgProject.setEffect(int, java.lang.Object), INgProject.getHighlightingEffect(int)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the project is set (see esriNgProjectEffect).

Description

By default, Schematics automatically sets default values for some project effects (see the List of the project effect default values, below). For all these effects, the IsEffectSet method returns True. For the others effects (those that are not automatically set), the IsEffectSet method returns True only if the effect has been set:

- Either when defining the project's characteristics through ArcGIS Schematics Designer,

- Or by calling the SetEffect method in the program code.

List of the project effect default values

esriNgProjectFitMargin: 0.05.

esriNgProjectFitAllMargin: 0.02.

esriNgProjectFitMarginMode: esriNgRelativeMargin.

esriNgProjectFitAllMarginMode: esriNgRelativeMargin.

esriNgProjectFolderPath: Folder named "GraphicFolder" according to the ".ini" file location

esriNgProjectBackupPath: Folder named "GraphicBackup" according to the ".ini" file location

esriNgProjectSymbolPath: Folder named "Cgm" according to the ".ini" file location

esriNgProjectSymbolClipping: False

esriNgProjectSymbolScaling: 1

esriNgProjectLinkLabelDistance: 1

esriNgProjectInterlineSpacing: 0.1

esriNgProjectLineColor: 1 (red)

esriNgProjectLineStyle: esriNgSolid

esriNgProjectLineWidth: 1

esriNgprojectFillColor: 1 (red)

esriNgProjectFillStyle: esriNgSolid

esriNgProjectHatchStyle: esriNgHatchHorizontal

esriNgProjectTextAlignment: esriNgBottomLeft

esriNgProjectTextAngle: 0

esriNgProjectTextColor: 1 (red)

esriNgProjectTextSize: 1

For more details, see Project Effects Definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEffectSet in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.setEffect(int, java.lang.Object), INgProject.isHighlightingEffectSet(int), INgProject.getEffect(int)

isProjectOpen

public boolean isProjectOpen()
                      throws IOException,
                             AutomationException

Indicates if the schematic session is open.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isProjectOpen in interface INgProject

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.close(), INgProject.open(boolean, boolean)

beginWaitCursor

public void beginWaitCursor()
                     throws IOException,
                            AutomationException

Enables the wait cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginWaitCursor in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.endWaitCursor()

endWaitCursor

public void endWaitCursor()
                   throws IOException,
                          AutomationException

Disables the wait cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endWaitCursor in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.beginWaitCursor()

getSymbol

public INgSymbol getSymbol(String symbolName)
                    throws IOException,
                           AutomationException

Returns the symbol named 'symbolName'.

Description

The specified symbolName CGM file must be located in the CGM folder. If it is not, the GetSymbol function returns Nothing.

Note: The symbolName parameter must be passed to the function without the .cgm extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSymbol in interface INgProject

Parameters:

symbolName - The symbolName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendEvent

public void sendEvent(String evtName,
                      int metaType,
                      String objectType,
                      String objectName)
               throws IOException,
                      AutomationException

Sends the event 'eventName' to the object named 'objectName' that is implemented by the object type named 'objectType' of the 'metatype' metatype.

Description

The event eventName must be already defined (eventName is the UserEventName defined for a behavior).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

sendEvent in interface INgProject

Parameters:

evtName - The evtName (in)

metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)

objectType - The objectType (in)

objectName - The objectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlagModels

public INgFlagModels getFlagModels()
                            throws IOException,
                                   AutomationException

List of the flag models implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFlagModels in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgFlagModels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getFlagModel(String)

getPatternModels

public INgPatternModels getPatternModels()
                                  throws IOException,
                                         AutomationException

List of the pattern models implemented by the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPatternModels in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgPatternModels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getPatternModel(String)

getSelectedFlags

public INgFlags getSelectedFlags()
                          throws IOException,
                                 AutomationException

List of the flags currently selected in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelectedFlags in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgFlags

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getSelectedFlags()

getDataSources

public INgDataSources getDataSources()
                              throws IOException,
                                     AutomationException

List of the datasources defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDataSources in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgDataSources

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getDataSource(String)

getUserAttributeSets

public INgUserAttributeSets getUserAttributeSets()
                                          throws IOException,
                                                 AutomationException

List of the user attibute sets defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUserAttributeSets in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgUserAttributeSets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.addUserAttributes(java.lang.Object, String)

getUserProcedureSets

public INgUserProcedureSets getUserProcedureSets()
                                          throws IOException,
                                                 AutomationException

List of the user procedure sets defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUserProcedureSets in interface INgProject

Returns:

A reference to a com.esri.arcgis.schematic.INgUserProcedureSets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.addUserProcedures(java.lang.Object, String)

getDataSource

public INgDataSource getDataSource(String dataSourceName)
                            throws IOException,
                                   AutomationException

Returns the datasource named 'dataSourceName'.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDataSource in interface INgProject

Parameters:

dataSourceName - The dataSourceName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgDataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource), INgProject.getDataSources()

getProjectFileName

public String getProjectFileName()
                          throws IOException,
                                 AutomationException

Full pathname of the '.ini' file used to initialize the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getProjectFileName in interface INgProject

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProjectFileName

public void setProjectFileName(String pVal)
                        throws IOException,
                               AutomationException

Full pathname of the '.ini' file used to initialize the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setProjectFileName in interface INgProject

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHighlightingEffect

public Object getHighlightingEffect(int effect)
                             throws IOException,
                                    AutomationException

Returns the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getHighlightingEffect in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.isHighlightingEffectSet(int), INgProject.getEffect(int), INgProject.setHighlightingEffect(int, java.lang.Object)

setHighlightingEffect

public void setHighlightingEffect(int effect,
                                  Object effValue)
                           throws IOException,
                                  AutomationException

Modifies the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setHighlightingEffect in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.setEffect(int, java.lang.Object), INgProject.isHighlightingEffectSet(int), INgProject.getHighlightingEffect(int)

removeHighlightingEffect

public void removeHighlightingEffect(int effect)
                              throws IOException,
                                     AutomationException

Removes the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeHighlightingEffect in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.isHighlightingEffectSet(int), INgProject.setHighlightingEffect(int, java.lang.Object), INgProject

isHighlightingEffectSet

public boolean isHighlightingEffectSet(int effect)
                                throws IOException,
                                       AutomationException

Indicates if the effect 'effect' used for highlighting the elements when they are selected is set.

Description

The 'effect' effect has been set:

- Either through ArcGIS Schematics Designer when defining the Highlight tab parameters for the open project,

- Or by calling the SetHighlightingEffect method in your program code.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isHighlightingEffectSet in interface INgProject

Parameters:

effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.isEffectSet(int), INgProject.getHighlightingEffect(int), INgProject.setHighlightingEffect(int, java.lang.Object)

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

Name of the online help file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getHelpFile in interface INgProject

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpFile

public void setHelpFile(String pVal)
                 throws IOException,
                        AutomationException

Name of the online help file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setHelpFile in interface INgProject

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshToolbars

public void refreshToolbars()
                     throws IOException,
                            AutomationException

Triggers the 'OnRefreshToolbar' predefined callback.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

refreshToolbars in interface INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectEvents.onRefreshToolbar(com.esri.arcgis.schematic.INgProjectEventsOnRefreshToolbarEvent)

setStatus

public void setStatus(String status)
               throws IOException,
                      AutomationException

Triggers the OnStatusChange' predefined callback.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setStatus in interface INgProject

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBehaviors

public INgBehaviors getBehaviors()
                          throws IOException,
                                 AutomationException

List of the behaviors defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBehaviors in interface INgProjectBuilder

Returns:

A reference to a com.esri.arcgis.schematic.INgBehaviors

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectBuilder.getBehaviors()

createFlagModel

public INgFlagModel createFlagModel(String flagModelName)
                             throws IOException,
                                    AutomationException

Creates a new flag mode named 'flagModelName' for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createFlagModel in interface INgProjectBuilder

Parameters:

flagModelName - The flagModelName (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgFlagModel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getFlagModels()

createPatternModel

public INgPatternModel createPatternModel(String patternModelName,
                                          int type,
                                          String text)
                                   throws IOException,
                                          AutomationException

Creates a new pattern model named 'patternModelName' for the project. The 'type' parameter specifies the pattern type (see esriNgPatternType).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createPatternModel in interface INgProjectBuilder

Parameters:

patternModelName - The patternModelName (in)

type - A com.esri.arcgis.schematic.esriNgPatternType constant (in)

text - The text (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgPatternModel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getPatternModels()

createElementType

public INgElementType createElementType(String eltTypeName,
                                        int type,
                                        INgElementType parent,
                                        boolean createGroup)
                                 throws IOException,
                                        AutomationException

Creates a new element type named 'eltTypeName' whose type is 'Type'.

Description

This element type can inherit the ‘parent’ element type (optional parameter). The createGroup parameter specifies if the associated element group must be created or not. The default value for the createGroup parameter is True; that is by default, all newly created element type is directly related to its own graphic group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createElementType in interface INgProjectBuilder

Parameters:

eltTypeName - The eltTypeName (in)

type - A com.esri.arcgis.schematic.esriNgElementTypeEnum constant (in)

parent - A reference to a com.esri.arcgis.schematic.INgElementType (in, optional, pass 0 if not required)

createGroup - The createGroup (in, optional, pass true if not required)

Returns:

A reference to a com.esri.arcgis.schematic.INgElementType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getElementTypes()

createDiagramType

public INgDiagramType createDiagramType(String diagTypeName,
                                        INgDiagramType parent)
                                 throws IOException,
                                        AutomationException

Creates a new diagram type named 'diagTypeName'. This new diagram type can inherit from an existing 'parent' diagram type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createDiagramType in interface INgProjectBuilder

Parameters:

diagTypeName - The diagTypeName (in)

parent - A reference to a com.esri.arcgis.schematic.INgDiagramType (in, optional, pass 0 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.INgDiagramType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.getDiagramTypes()

createBehavior

public INgBehavior createBehavior(String evtName,
                                  int metaType,
                                  String objectType)
                           throws IOException,
                                  AutomationException

Creates the behavior to respond to the event 'evtName' on the metatype 'metaType' for the object type named 'objectType'.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createBehavior in interface INgProjectBuilder

Parameters:

evtName - The evtName (in)

metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)

objectType - The objectType (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgBehavior

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectBuilder.getBehaviors()

save

public void save(String projectFilePath,
                 String projectFileName)
          throws IOException,
                 AutomationException

Saves all the parameters that define the project.

Description

The parameters projectFilePath and projectFileName are optional. By default if they are not specified, Schematics overwrites the current session's parameters file.

Note that the specified projectFilePath must already exist because Schematics does not create nonexistent folders.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

save in interface INgProjectBuilder

Parameters:

projectFilePath - The projectFilePath (in, optional, pass if not required)

projectFileName - The projectFileName (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBehaviors2

public INgBehaviors getBehaviors2(int metaType,
                                  String objTypeName)
                           throws IOException,
                                  AutomationException

Returns the list of the behaviors defined for the metatype 'metaType'. To obtain the list of the behaviors defined for a given object type only, specify the name of that object type using the 'objTypeName' parameter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBehaviors2 in interface INgProjectBuilder

Parameters:

metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)

objTypeName - The objTypeName (in, optional, pass if not required)

Returns:

A reference to a com.esri.arcgis.schematic.INgBehaviors

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteDataSources

public void deleteDataSources()
                       throws IOException,
                              AutomationException

Deletes all the data sources associated with the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

deleteDataSources in interface INgProjectBuilder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectBuilder.replaceDataSource(com.esri.arcgis.schematic.INgDataSource, com.esri.arcgis.schematic.INgDataSource), INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource)

deleteAttributeSets

public void deleteAttributeSets()
                         throws IOException,
                                AutomationException

Deletes all the attribute sets associated with the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

deleteAttributeSets in interface INgProjectBuilder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.addUserAttributes(java.lang.Object, String)

deleteProcedureSets

public void deleteProcedureSets()
                         throws IOException,
                                AutomationException

Deletes all the procedure sets associated with the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

deleteProcedureSets in interface INgProjectBuilder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.addUserProcedures(java.lang.Object, String)

replaceDataSource

public void replaceDataSource(INgDataSource oldDataSource,
                              INgDataSource newDataSource)
                       throws IOException,
                              AutomationException

Changes the specified old datasource by the specified new datasource in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

replaceDataSource in interface INgProjectBuilder

Parameters:

oldDataSource - A reference to a com.esri.arcgis.schematic.INgDataSource (in)

newDataSource - A reference to a com.esri.arcgis.schematic.INgDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectBuilder.deleteDataSources(), INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource)

getColorIndex

public void getColorIndex(short red,
                          short green,
                          short blue,
                          int[] colorIndex)
                   throws IOException,
                          AutomationException

Returns the color index corresponding to the specified RGB values in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getColorIndex in interface INgProjectBuilder

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

colorIndex - The colorIndex (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontIndex

public void getFontIndex(String fontName,
                         int[] fontIndex)
                  throws IOException,
                         AutomationException

Returns the font index corresponding to font named 'fontName' in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFontIndex in interface INgProjectBuilder

Parameters:

fontName - The fontName (in)

fontIndex - The fontIndex (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reloadSymbol

public void reloadSymbol(String symbolName)
                  throws IOException,
                         AutomationException

Reloads the symbol named 'symbolName' in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

reloadSymbol in interface INgProjectBuilder

Parameters:

symbolName - The symbolName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlgorithmSheet

public ISchematicAlgorithmSheet getAlgorithmSheet()
                                           throws IOException,
                                                  AutomationException

Properties page of the schematic algorithm.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAlgorithmSheet in interface INgProjectAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithmSheet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.getAnalystSheet()

addAlgorithm

public void addAlgorithm(String cLSID,
                         ISchematicAlgorithm algorithm)
                  throws IOException,
                         AutomationException

Adds the specified schematic algorithm to the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addAlgorithm in interface INgProjectAlgorithm

Parameters:

cLSID - The cLSID (in)

algorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAlgorithm

public void removeAlgorithm(String cLSID)
                     throws IOException,
                            AutomationException

Removes the specified schematic algorithm from the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeAlgorithm in interface INgProjectAlgorithm

Parameters:

cLSID - The cLSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.removeAlgorithms()

getAlgorithms

public ISchematicAlgorithms getAlgorithms()
                                   throws IOException,
                                          AutomationException

List of the schematic algorithms defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAlgorithms in interface INgProjectAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithms

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.getAlgorithm(String)

removeAlgorithms

public void removeAlgorithms()
                      throws IOException,
                             AutomationException

Remove all the schematic algorithms from the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeAlgorithms in interface INgProjectAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.removeAlgorithm(String)

getAlgorithm

public ISchematicAlgorithm getAlgorithm(String cLSID)
                                 throws IOException,
                                        AutomationException

Returns the specified schematic algorithm defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAlgorithm in interface INgProjectAlgorithm

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.getAlgorithms()

getAnalystSheet

public ISchematicAlgorithmSheet getAnalystSheet()
                                         throws IOException,
                                                AutomationException

Properties page of the schematic network trace analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAnalystSheet in interface INgProjectAnalyst

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithmSheet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.getAlgorithmSheet()

addTrace

public void addTrace(String cLSID,
                     ISchematicAlgorithm algorithm)
              throws IOException,
                     AutomationException

Adds the specified schematic network trace analyst to the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addTrace in interface INgProjectAnalyst

Parameters:

cLSID - The cLSID (in)

algorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.getTraces()

removeTrace

public void removeTrace(String cLSID)
                 throws IOException,
                        AutomationException

Removes the specified schematic network trace analyst to the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeTrace in interface INgProjectAnalyst

Parameters:

cLSID - The cLSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.removeTraces()

getTraces

public ISchematicAlgorithms getTraces()
                               throws IOException,
                                      AutomationException

List of the schematic network trace analysts defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTraces in interface INgProjectAnalyst

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithms

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.getTrace(String)

removeTraces

public void removeTraces()
                  throws IOException,
                         AutomationException

Remove all the schematic network trace analysts from the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeTraces in interface INgProjectAnalyst

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.removeTrace(String)

getTrace

public ISchematicAlgorithm getTrace(String cLSID)
                             throws IOException,
                                    AutomationException

Returns the specified schematic network trace analyst defined for the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTrace in interface INgProjectAnalyst

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.getTraces()

mouseDown

public void mouseDown(INgView view,
                      int button,
                      int shift,
                      int xScreen,
                      int yScreen,
                      int xWindow,
                      int yWindow,
                      double xUser,
                      double yUser)
               throws IOException,
                      AutomationException

Occurs when a mouse button is pressed when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

mouseDown in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

button - The button (in)

shift - The shift (in)

xScreen - The xScreen (in)

yScreen - The yScreen (in)

xWindow - The xWindow (in)

yWindow - The yWindow (in)

xUser - The xUser (in)

yUser - The yUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectTool.mouseUp(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseMove(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

mouseMove

public void mouseMove(INgView view,
                      int button,
                      int shift,
                      int xScreen,
                      int yScreen,
                      int xWindow,
                      int yWindow,
                      double xUser,
                      double yUser)
               throws IOException,
                      AutomationException

Occurs when the mouse is moved when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

mouseMove in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

button - The button (in)

shift - The shift (in)

xScreen - The xScreen (in)

yScreen - The yScreen (in)

xWindow - The xWindow (in)

yWindow - The yWindow (in)

xUser - The xUser (in)

yUser - The yUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectTool.mouseDown(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseUp(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

mouseUp

public void mouseUp(INgView view,
                    int button,
                    int shift,
                    int xScreen,
                    int yScreen,
                    int xWindow,
                    int yWindow,
                    double xUser,
                    double yUser)
             throws IOException,
                    AutomationException

Occurs when a mouse button is released when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

mouseUp in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

button - The button (in)

shift - The shift (in)

xScreen - The xScreen (in)

yScreen - The yScreen (in)

xWindow - The xWindow (in)

yWindow - The yWindow (in)

xUser - The xUser (in)

yUser - The yUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectTool.mouseDown(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double), INgProjectTool.mouseMove(com.esri.arcgis.schematic.INgView, int, int, int, int, int, int, double, double)

dblClick

public void dblClick(INgView view,
                     int button,
                     int shift,
                     int xScreen,
                     int yScreen,
                     int xWindow,
                     int yWindow,
                     double xUser,
                     double yUser)
              throws IOException,
                     AutomationException

Occurs when a mouse button is double clicked when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

dblClick in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

button - The button (in)

shift - The shift (in)

xScreen - The xScreen (in)

yScreen - The yScreen (in)

xWindow - The xWindow (in)

yWindow - The yWindow (in)

xUser - The xUser (in)

yUser - The yUser (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

keyDown

public void keyDown(INgView view,
                    int keyCode,
                    int shift)
             throws IOException,
                    AutomationException

Occurs when a key on the keyboard is pressed when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

keyDown in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

keyCode - The keyCode (in)

shift - The shift (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectTool.keyUp(com.esri.arcgis.schematic.INgView, int, int)

keyUp

public void keyUp(INgView view,
                  int keyCode,
                  int shift)
           throws IOException,
                  AutomationException

Occurs when a key on the keyboard is released when the project tool is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

keyUp in interface INgProjectTool

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in)

keyCode - The keyCode (in)

shift - The shift (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectTool.keyDown(com.esri.arcgis.schematic.INgView, int, int)

isSpatialEnvironment

public boolean isSpatialEnvironment()
                             throws IOException,
                                    AutomationException

Indicates if the event occured in ArcMap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSpatialEnvironment in interface INgProjectTool

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialEnvironment

public void setSpatialEnvironment(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the event occured in ArcMap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSpatialEnvironment in interface INgProjectTool

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrintableArea

public void getPrintableArea(double[] width,
                             double[] height)
                      throws IOException,
                             AutomationException

Returns the current printing area defined in the printer configuration dialog box.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPrintableArea in interface INgProjectViews

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.printView(String, boolean)

getScreenSize

public void getScreenSize(int[] width,
                          int[] height)
                   throws IOException,
                          AutomationException

Returns the screen 'width' and 'height' in pixels units.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getScreenSize in interface INgProjectViews

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileArea

public void getTileArea(INgPoint[] upperLeftCorner,
                        INgPoint[] lowerRightCorner)
                 throws IOException,
                        AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points enclosing the area used to position the schematic windows.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTileArea in interface INgProjectViews

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.unsetTileArea(), INgProjectViews.tileViews(int)

setTileArea

public void setTileArea(INgPoint upperLeftCorner,
                        INgPoint lowerRightCorner)
                 throws IOException,
                        AutomationException

Defines the area enclosed between the 'upperLeftCorner' and 'lowerRightCorner' points that will be used to position the schematic windows.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTileArea in interface INgProjectViews

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (in)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.getTileArea(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[]), INgProjectViews.unsetTileArea(), INgProjectViews.tileViews(int)

getOpenedViews

public INgViews getOpenedViews()
                        throws IOException,
                               AutomationException

List of the views that are currently open in the project.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getOpenedViews in interface INgProjectViews

Returns:

A reference to a com.esri.arcgis.schematic.INgViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreSession

public void restoreSession(String sessionName)
                    throws IOException,
                           AutomationException

Restores the session named 'sessionName'; that is, restores the views to their last saved position and display state.

Description

The sessionName parameter is optional. By default, if that name is not specified, the RestoreSession method restores the session associated with the .ini file specified at the time the application was opened.

Note that if you did not save the diagrams that were open when the session was last saved, the layout of the elements in these diagrams is not restored when the session is opened: the elements associated with the diagrams positioned based on their database coordinates or on their last saved positions. Indeed, when you save a schematic session, you save the current position and display state of the schematic windows (scale, text and symbol sizes…), but their contents (that make up the diagrams) are not saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

restoreSession in interface INgProjectViews

Parameters:

sessionName - The sessionName (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveSession

public void saveSession(String sessionName)
                 throws IOException,
                        AutomationException

Saves the schematic session associated with the project.

Description

This method saves all open schematic views with their characteristics (diagram name, window size and position, zoom factor, text and symbol sizes).The next time the session is opened again, all the views will be restored to the display state they were saved in.

The sessionName parameter is optional. By default, if that name is not specified, Schematics saves the current opened session under the session file which name is as your .ini file (that is, as your project's file name) with the .ses extension.

Saving session under another session name allows you to save different display states and schematic windows positions.

Note: When you save a session, the contents of the diagrams (position of the elements, page layout) is not saved. Only the positions of the schematic windows and their current display state are saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

saveSession in interface INgProjectViews

Parameters:

sessionName - The sessionName (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

printSetup

public void printSetup()
                throws IOException,
                       AutomationException

Opens the default printer configuration dialog box.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

printSetup in interface INgProjectViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaveMode

public int getSaveMode()
                throws IOException,
                       AutomationException

Saving mode for the schematic session.

Description

By default, saving mode value is "esriNgSaveUndefined".

- With the esriNgSaveUndefined mode, when you close your session, you are asked if you want to save it.

- With the esriNgSaveByFramework mode, Schematics automatically saves your session without asking you if you want to save changes.

- With the esriNgNotSaveByFramework mode, Schematics doesn't save the changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSaveMode in interface INgProjectViews

Returns:

A com.esri.arcgis.schematic.esriNgSaveModeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveMode

public void setSaveMode(int pVal)
                 throws IOException,
                        AutomationException

Saving mode for the schematic session.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSaveMode in interface INgProjectViews

Parameters:

pVal - A com.esri.arcgis.schematic.esriNgSaveModeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

tileViews

public void tileViews(int mode)
               throws IOException,
                      AutomationException

Arranges the views according to the 'mode' tile views option (see esriNgTileViewMode).

Description

Note#1: Whatever the mode chosen, if the area used to tile the schematic view windows has not been defined before (by calling the SetTileArea method), Schematics looks for the largest free area remaining on the screen in relation to your application's main window to determine the available space for tiling the schematic views.

Note#2: The TileViews method ignores minimized view windows.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

tileViews in interface INgProjectViews

Parameters:

mode - A com.esri.arcgis.schematic.esriNgTileViewMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.unsetTileArea()

unsetTileArea

public void unsetTileArea()
                   throws IOException,
                          AutomationException

Restores the default area used to position the view windows. Cancels the area previously defined by triggering the 'SetTileArea' method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

unsetTileArea in interface INgProjectViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.getTileArea(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[]), INgProjectViews.tileViews(int)

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeExecuteAlgorithm

public boolean beforeExecuteAlgorithm(ISchematicAlgorithmEventsBeforeExecuteAlgorithmEvent theEvent)
                               throws IOException,
                                      AutomationException

Fires before any schematic algorithm execution on any view. Returns TRUE if the schematic algorithm must be interrupted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beforeExecuteAlgorithm in interface ISchematicAlgorithmEvents

Parameters:

theEvent - The event

Returns:

The pCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgorithmEvents.afterExecuteAlgorithm(com.esri.arcgis.schematic.ISchematicAlgorithmEventsAfterExecuteAlgorithmEvent)

afterExecuteAlgorithm

public void afterExecuteAlgorithm(ISchematicAlgorithmEventsAfterExecuteAlgorithmEvent theEvent)
                           throws IOException,
                                  AutomationException

Fires after any schematic algorithm execution on any view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

afterExecuteAlgorithm in interface ISchematicAlgorithmEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgorithmEvents.beforeExecuteAlgorithm(com.esri.arcgis.schematic.ISchematicAlgorithmEventsBeforeExecuteAlgorithmEvent)