com.esri.arcgis.carto
Interface IMapServerInfo3

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMapServerInfo3Proxy, MapServerInfo

public interface IMapServerInfo3
extends java.io.Serializable

COM Interface 'IMapServerInfo3'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the MapServerInfo.' 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
static java.lang.String IID
          Deprecated. Internal use only
static int IID012a4036_5c4d_4677_bb19_ed4e3ded3d75
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IColor getBackgroundColor()
          The background color of the map (data frame).
 IFillSymbol getBackgroundSymbol()
          Background symbol 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).
 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

IID012a4036_5c4d_4677_bb19_ed4e3ded3d75

static final int IID012a4036_5c4d_4677_bb19_ed4e3ded3d75
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

IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
The background color of the map (data frame).

Returns:
A reference to a com.esri.arcgis.display.IColor
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.

getBackgroundSymbol

IFillSymbol getBackgroundSymbol()
                                throws java.io.IOException,
                                       AutomationException
Background symbol of the map (data frame).

Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
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.