com.esri.arcgis.schematic
Interface INgProjectViews

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgProjectViewsProxy, NgProject

public interface INgProjectViews
extends Serializable

Provides access to members that control the view windows positioning and the printer configuration.

Product Availability

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

See Also:
INgProject

Method Summary
 INgViews getOpenedViews()
          List of the views that are currently open in the project.
 void getPrintableArea(double[] width, double[] height)
          Returns the current printing area defined in the printer configuration dialog box.
 int getSaveMode()
          Saving mode for the schematic session.
 void getScreenSize(int[] width, int[] height)
          Returns the screen 'width' and 'height' in pixels units.
 void getTileArea(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner)
          Returns the 'upperLeftCorner' and 'lowerRightCorner' points enclosing the area used to position the schematic windows.
 void printSetup()
          Opens the default printer configuration dialog box.
 void restoreSession(String sessionName)
          Restores the session named 'sessionName'; that is, restores the views to their last saved position and display state.
 void saveSession(String sessionName)
          Saves the schematic session associated with the project.
 void setSaveMode(int pVal)
          Saving mode for the schematic session.
 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 tileViews(int mode)
          Arranges the views according to the 'mode' tile views option (see esriNgTileViewMode).
 void unsetTileArea()
          Restores the default area used to position the view windows.
 

Method Detail

getPrintableArea

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

void printSetup()
                throws IOException,
                       AutomationException
Opens the default printer configuration dialog box.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSaveMode

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.

Returns:
A com.esri.arcgis.schematic.esriNgSaveModeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSaveMode

void setSaveMode(int pVal)
                 throws IOException,
                        AutomationException
Saving mode for the schematic session.

Product Availability

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

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

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.

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

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.

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)