com.esri.arcgis.carto
Interface ILocatorRectangle2

All Superinterfaces:
Serializable
All Known Implementing Classes:
LocatorRectangle

public interface ILocatorRectangle2
extends Serializable

Provides access to the members that control the map frame locator rectangle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 void draw(IDisplay display, IMapFrame parent)
          Obsolete.
 void drawExtent(IDisplay mapDisplay, IMapFrame parent)
          Draws the locator shape on the Map display.
 void drawLeader(IDisplay layoutDisplay, IMapFrame parent)
          Draws the leader line on the Layout display.
 IBackground getBackground()
          The page background.
 IBorder getBorder()
          The page border.
 ISymbol getLeaderSymbol()
          The symbol used to render the leader line.
 IMapFrame getMapFrame()
          The map frame being referenced.
 boolean isShowLeader()
          Indicates if leader lines should be drawn.
 boolean isUseSimpleExtent()
          Use other data frame extent even if clipping is set or data driven pages are enabled.
 void queryBounds(IDisplay display, IMapFrame parent, IEnvelope bounds)
          Returns the bounds of the locator.
 void setBackground(IBackground background)
          The page background.
 void setBorder(IBorder border)
          The page border.
 void setLeaderSymbol(ISymbol symbol)
          The symbol used to render the leader line.
 void setMapFrameByRef(IMapFrame mapFrame)
          The map frame being referenced.
 void setShowLeader(boolean flag)
          Indicates if leader lines should be drawn.
 void setUseSimpleExtent(boolean flag)
          Use other data frame extent even if clipping is set or data driven pages are enabled.
 

Method Detail

setMapFrameByRef

void setMapFrameByRef(IMapFrame mapFrame)
                      throws IOException,
                             AutomationException
The map frame being referenced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapFrame

IMapFrame getMapFrame()
                      throws IOException,
                             AutomationException
The map frame being referenced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.carto.IMapFrame
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorder

IBorder getBorder()
                  throws IOException,
                         AutomationException
The page border.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.carto.IBorder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorder

void setBorder(IBorder border)
               throws IOException,
                      AutomationException
The page border.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
border - A reference to a com.esri.arcgis.carto.IBorder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

IBackground getBackground()
                          throws IOException,
                                 AutomationException
The page background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.carto.IBackground
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(IBackground background)
                   throws IOException,
                          AutomationException
The page background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
background - A reference to a com.esri.arcgis.carto.IBackground (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderSymbol

void setLeaderSymbol(ISymbol symbol)
                     throws IOException,
                            AutomationException
The symbol used to render the leader line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderSymbol

ISymbol getLeaderSymbol()
                        throws IOException,
                               AutomationException
The symbol used to render the leader line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLeader

boolean isShowLeader()
                     throws IOException,
                            AutomationException
Indicates if leader lines should be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLeader

void setShowLeader(boolean flag)
                   throws IOException,
                          AutomationException
Indicates if leader lines should be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IMapFrame parent,
                 IEnvelope bounds)
                 throws IOException,
                        AutomationException
Returns the bounds of the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IMapFrame parent)
          throws IOException,
                 AutomationException
Obsolete. Use DrawExtent and DrawLeader instead.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseSimpleExtent

boolean isUseSimpleExtent()
                          throws IOException,
                                 AutomationException
Use other data frame extent even if clipping is set or data driven pages are enabled. By default, the clip or DDP shape is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseSimpleExtent

void setUseSimpleExtent(boolean flag)
                        throws IOException,
                               AutomationException
Use other data frame extent even if clipping is set or data driven pages are enabled. By default, the clip or DDP shape is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawExtent

void drawExtent(IDisplay mapDisplay,
                IMapFrame parent)
                throws IOException,
                       AutomationException
Draws the locator shape on the Map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
mapDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawLeader

void drawLeader(IDisplay layoutDisplay,
                IMapFrame parent)
                throws IOException,
                       AutomationException
Draws the leader line on the Layout display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
layoutDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.