com.esri.arcgis.carto
Interface IMapSurroundFrame

All Superinterfaces:

IFrameElement, java.io.Serializable

All Known Implementing Classes:

IMapSurroundFrameProxy, MapSurroundFrame

public interface IMapSurroundFrame
extends IFrameElement, java.io.Serializable

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

Description: 'Provides access to the members that control the map surround element interface.' 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	IID9b00131c_9ed7_11d0_859e_0800091a2a72
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.carto.IFrameElement

IID9b00131a_9ed7_11d0_859e_0800091a2a72

Method Summary

IMapFrame	getMapFrame() The frame element of the map associated with this object's map surround.
IMapSurround	getMapSurround() The map surround displayed by this frame element.
void	setMapFrameByRef(IMapFrame mapFrame) The frame element of the map associated with this object's map surround.
void	setMapSurroundByRef(IMapSurround mapSurround) The map surround displayed by this frame element.

Methods inherited from interface com.esri.arcgis.carto.IFrameElement

getBackground, getBorder, getObject, getThumbnail, isDraftMode, setBackground, setBorder, setDraftMode

Field Detail

IID9b00131c_9ed7_11d0_859e_0800091a2a72

static final int IID9b00131c_9ed7_11d0_859e_0800091a2a72

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

getMapSurround

IMapSurround getMapSurround()
                            throws java.io.IOException,
                                   AutomationException

The map surround displayed by this frame element.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapSurroundByRef

void setMapSurroundByRef(IMapSurround mapSurround)
                         throws java.io.IOException,
                                AutomationException

The map surround displayed by this frame element.

Parameters:

mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapFrame

IMapFrame getMapFrame()
                      throws java.io.IOException,
                             AutomationException

The frame element of the map associated with this object's map surround.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapFrameByRef

void setMapFrameByRef(IMapFrame mapFrame)
                      throws java.io.IOException,
                             AutomationException

The frame element of the map associated with this object's map surround.

Parameters:

mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.