com.esri.arcgis.arcmapui
Interface IStartupDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

GettingStartedWindow, TemplateStartupDialog

public interface IStartupDialog
extends Serializable

Provides access to members that control the Startup Dialog.

Description

The IStartupDialog interface defines the startup dialog for the ArcMap application. This interface provides a method that allows the startup dialog to be displayed.

Remarks

To create a startup dialog you would create a form that contains the controls you want on the startup dialog. You also need to create a class that implements IStartupDialog. Write code for the DoModel method to display this dialog when the ArcMap application starts.

The following registry key is used to specify which startup dialog is to be used by ArcMap.

HKEY_LOCAL_MACHINE\SOFTWARE\ESRI\ArcMap\Settings
StartupProgID "Map.Start"

The datatype for StartupProgID is a string. The StartupProgID string is composed of two parts that are separated by a ".". The first part is the name of the Visual Basic Project used to create the startup dll (Do not confuse this with the Application Title of the project, which is found in the Project Properties dialog's Make tab). The second part is the name of the startup class. For example if you have a VB project called Map with a class called Start, then the ProgID would be called "Map.Start".

Instead editing the registry to set the StartupProgID, you can use the ArcMap user interface. In ArcMap, click Tools and then click Options. Click the Application tab. Enter your ProgID in the Startup script: textbox.

There is also another registry used to specify whether the startup dialog is turned on.

HKEY_CURRENT_USER\Software\ESRI\ArcMap\Settings
ShowStartup 0x00000001 (1)

A value of 1 means that the startup dialog will be shown on ArcMap startup; a value of 0 means that the startup dialog will not be shown. Note, this registry key does not exist unless you check "Do not show this dialog again" in the default startup dialog for ArcMap or uncheck "Show startup dialog" on the Application tab of the Options dialog.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	doModal(int parentHWnd) Shows the startup dialog.
String	getFilePath() An initial file name (may be blank).

Method Detail

doModal

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

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilePath

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

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.