com.esri.arcgis.arcmapui
Class GettingStartedWindow

java.lang.Object
  extended by com.esri.arcgis.arcmapui.GettingStartedWindow
All Implemented Interfaces:
IStartupDialog, IStartupDialog2, IStartupDialog3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GettingStartedWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStartupDialog, IStartupDialog2, IStartupDialog3

Getting Started Window

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Constructor Summary
GettingStartedWindow()
          Constructs a GettingStartedWindow using ArcGIS Engine.
GettingStartedWindow(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GettingStartedWindow theGettingStartedWindow = (GettingStartedWindow) obj;
 
Method Summary
 void doModal(int parentHWnd)
          Shows the startup dialog.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IWorkspaceName getDatabase()
          The database for the document.
 String getFilePath()
          An initial file name (may be blank).
 IUID getInitialCommand()
          An initial command to run (may be nothing).
 int hashCode()
          the hashcode for this object
 boolean isTemplate()
          Gets the value determining if file path is a template.
 
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

GettingStartedWindow

public GettingStartedWindow()
                     throws IOException,
                            UnknownHostException
Constructs a GettingStartedWindow using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GettingStartedWindow

public GettingStartedWindow(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GettingStartedWindow theGettingStartedWindow = (GettingStartedWindow) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
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

doModal

public void doModal(int parentHWnd)
             throws IOException,
                    AutomationException
Shows the startup dialog.

Description

DoModal is where the code you want to execute when the Mx Application launches.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
doModal in interface IStartupDialog
Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilePath

public String getFilePath()
                   throws IOException,
                          AutomationException
An initial file name (may be blank).

Description

FilePath is the filename that will be opened (assumed to be a .mxd or .mxt).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getFilePath in interface IStartupDialog
Returns:
The fileName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInitialCommand

public IUID getInitialCommand()
                       throws IOException,
                              AutomationException
An initial command to run (may be nothing).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getInitialCommand in interface IStartupDialog2
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatabase

public IWorkspaceName getDatabase()
                           throws IOException,
                                  AutomationException
The database for the document.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDatabase in interface IStartupDialog3
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTemplate

public boolean isTemplate()
                   throws IOException,
                          AutomationException
Gets the value determining if file path is a template.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isTemplate in interface IStartupDialog3
Returns:
The pIsTemplate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.