com.esri.arcgis.carto

Interface IMapServerInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapServerInfoProxy, MapServerInfo

public interface IMapServerInfo
extends java.io.Serializable

COM Interface 'IMapServerInfo'. Generated 9/21/2023 10:01:50 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description: 'Provides access to the available properties of a map server info object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID47dd2772_2f22_44df_919b_0d16d8672626
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
IColorDescription	getBackgroundColor() The background color of the map (data frame).
IMapServerBookmarks	getBookmarks() The published bookmarks for the map.
java.lang.String	getCopyrightText() Copyright information associated with the layer.
IMapDescription	getDefaultMapDescription() The default map settings.
java.lang.String	getDescription() The description of the map (data frame).
IEnvelope	getExtent() The current extent of the map (data frame).
IEnvelope	getFullExtent() The full extent of the map (data frame).
IMapLayerInfos	getMapLayerInfos() A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).
int	getMapUnits() The units for the map (data frame).
double	getMaxScale() The maximum visible scale for the service.
double	getMinScale() The minimum visible scale for the service.
java.lang.String	getName() The name of the map (data frame).
IStandaloneTableDescriptions	getStandaloneTableDescriptions() Standalone tables descriptions that can passed in to other methods.
IStandaloneTableInfos	getStandaloneTableInfos() Standalone tables infromation in a given map.

Field Detail

IID47dd2772_2f22_44df_919b_0d16d8672626

static final int IID47dd2772_2f22_44df_919b_0d16d8672626

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws java.io.IOException,
                         AutomationException

The name of the map (data frame).

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                         throws java.io.IOException,
                                AutomationException

The description of the map (data frame). This property is set in the General tab of the Data Frame Properties dialog.

Returns:

The desc

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                 throws java.io.IOException,
                        AutomationException

The full extent of the map (data frame).

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
             throws java.io.IOException,
                    AutomationException

The current extent of the map (data frame).

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapLayerInfos

IMapLayerInfos getMapLayerInfos()
                         throws java.io.IOException,
                                AutomationException

A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).

Returns:

A reference to a com.esri.arcgis.carto.IMapLayerInfos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColorDescription getBackgroundColor()
                              throws java.io.IOException,
                                     AutomationException

The background color of the map (data frame).

Returns:

A reference to a com.esri.arcgis.carto.IColorDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarks

IMapServerBookmarks getBookmarks()
                          throws java.io.IOException,
                                 AutomationException

The published bookmarks for the map.

Returns:

A reference to a com.esri.arcgis.carto.IMapServerBookmarks

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapDescription

IMapDescription getDefaultMapDescription()
                                  throws java.io.IOException,
                                         AutomationException

The default map settings.

Returns:

A reference to a com.esri.arcgis.carto.IMapDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

int getMapUnits()
         throws java.io.IOException,
                AutomationException

The units for the map (data frame).

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

java.lang.String getCopyrightText()
                           throws java.io.IOException,
                                  AutomationException

Copyright information associated with the layer.

Returns:

The copyright

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableInfos

IStandaloneTableInfos getStandaloneTableInfos()
                                       throws java.io.IOException,
                                              AutomationException

Standalone tables infromation in a given map.

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTableInfos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableDescriptions

IStandaloneTableDescriptions getStandaloneTableDescriptions()
                                                     throws java.io.IOException,
                                                            AutomationException

Standalone tables descriptions that can passed in to other methods.

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTableDescriptions

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinScale

double getMinScale()
            throws java.io.IOException,
                   AutomationException

The minimum visible scale for the service.

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxScale

double getMaxScale()
            throws java.io.IOException,
                   AutomationException

The maximum visible scale for the service.

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.