com.esri.arcgis.arcglobe
Interface IGMxDefaultLayers

All Superinterfaces:

Serializable

All Known Implementing Classes:

Application, IGMxDefaultLayersProxy

public interface IGMxDefaultLayers
extends Serializable

Provides access to Default Layers for New Documents.

Description

The IGMxDefaultLayers interface contains methods/properties to customize the default layers which are loaded on opening a new ArcGlobe document.

NewDocumentDefaultLayersSetting property sets the type of default layers for new documents to be custom supplied (any user specified layers in the TOC), system supplied (default layers, which ship with ArcGlobe), or none. The UseTOCAsCustomDefaultLayersForNewDocuments method sets the custom supplied default layers for new documents to be same as layers in the TOC of the currently open document. This allows the user's to provide layers of their choice to be displayed when a new ArcGlobe is opened up. The user can also change or overwrite the default layers, shipped with ArcGlobe, by using the UseTOCAsSystemDefaultLayersForNewDocuments method. This method sets the system supplied default layers for new documents to be same as layers in the TOC of the currently open document.

You can also set the system supplied default layers to be the same as layers in the TOC of a document by running the following command in the MSDOS prompt command line.

<path to install location> <space> /Arcglobe.exe <space> /SystemDefaultLayers <space> <Full document path>

For e.g., "C:\Program Files\arcgis\bin\ArcGlobe.exe" /SystemDefaultLayers "C:\Program Files\arcgis\ArcGlobeData\Default_Document.3dd"

The example above can be used to revert back to the system supplied default layers shipped with ArcGlobe. The default document (Default_Document.3dd) used, can be found in the ArcGlobeData folder, which is parallel to the "Bin" folder.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

int	getNewDocumentDefaultLayersSetting() The selected layer in the layer control.
void	setNewDocumentDefaultLayersSetting(int pValue) The selected layer in the layer control.
void	useTOCAsCustomDefaultLayersForNewDocuments() Use Current Document TOC as Custom Default Layers for New Documents.
void	useTOCAsSystemDefaultLayersForNewDocuments() Use Current Document TOC as System Default Layers for New Documents.

Method Detail

getNewDocumentDefaultLayersSetting

int getNewDocumentDefaultLayersSetting()
                                       throws IOException,
                                              AutomationException

The selected layer in the layer control.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.arcglobe.esriDefaultLayersMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNewDocumentDefaultLayersSetting

void setNewDocumentDefaultLayersSetting(int pValue)
                                        throws IOException,
                                               AutomationException

The selected layer in the layer control.

Remarks

The NewDocumenDefaultLayersSetting allows you to set the default layers option to display system supplied layers (esriDefaultLayersSystem), custom user-supplied layers (esriDefaultLayersCustom), or no layers (esriDefaultLayersNone), when a new ArcGlobe document is opened up.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

pValue - A com.esri.arcgis.arcglobe.esriDefaultLayersMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

useTOCAsSystemDefaultLayersForNewDocuments

void useTOCAsSystemDefaultLayersForNewDocuments()
                                                throws IOException,
                                                       AutomationException

Use Current Document TOC as System Default Layers for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

useTOCAsCustomDefaultLayersForNewDocuments

void useTOCAsCustomDefaultLayersForNewDocuments()
                                                throws IOException,
                                                       AutomationException

Use Current Document TOC as Custom Default Layers for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.