com.esri.arcgis.carto
Interface IMgrsGrid

All Superinterfaces:
Serializable
All Known Implementing Classes:
MgrsGrid

public interface IMgrsGrid
extends Serializable

Provides access to members that control the properties of an MGRS grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 ILineSymbol getGridSquareBoundarySymbol()
          The line symbol used to display the boundaries of the grid squares.
 IColor getGridSquareLabelColor()
          The color used to display the grid square labels.
 Font getGridSquareLabelFont()
          The font used to display the grid square labels.
 double getGridSquareLabelSize()
          The font size used to display the grid square labels.
 int getGridSquareLabelStyle()
          The style used to display the grid square labels.
 double getInteriorTickLength()
          The length of the interior grid ticks.
 ILineSymbol getInteriorTickSymbol()
          The line symbol used to show interior grid ticks.
 boolean isShowGridSquareIdentifiers()
          Indicates if the square identifiers should be displayed.
 void setGridSquareBoundarySymbol(ILineSymbol symbol)
          The line symbol used to display the boundaries of the grid squares.
 void setGridSquareLabelColor(IColor color)
          The color used to display the grid square labels.
 void setGridSquareLabelFont(Font font)
          The font used to display the grid square labels.
 void setGridSquareLabelSize(double size)
          The font size used to display the grid square labels.
 void setGridSquareLabelStyle(int style)
          The style used to display the grid square labels.
 void setInteriorTickLength(double lengthPts)
          The length of the interior grid ticks.
 void setInteriorTickSymbol(ILineSymbol symbol)
          The line symbol used to show interior grid ticks.
 void setShowGridSquareIdentifiers(boolean show)
          Indicates if the square identifiers should be displayed.
 

Method Detail

isShowGridSquareIdentifiers

boolean isShowGridSquareIdentifiers()
                                    throws IOException,
                                           AutomationException
Indicates if the square identifiers should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShowGridSquareIdentifiers

void setShowGridSquareIdentifiers(boolean show)
                                  throws IOException,
                                         AutomationException
Indicates if the square identifiers should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGridSquareLabelFont

Font getGridSquareLabelFont()
                            throws IOException,
                                   AutomationException
The font used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelFont

void setGridSquareLabelFont(Font font)
                            throws IOException,
                                   AutomationException
The font used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelSize

double getGridSquareLabelSize()
                              throws IOException,
                                     AutomationException
The font size used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGridSquareLabelSize

void setGridSquareLabelSize(double size)
                            throws IOException,
                                   AutomationException
The font size used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGridSquareLabelColor

IColor getGridSquareLabelColor()
                               throws IOException,
                                      AutomationException
The color used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGridSquareLabelColor

void setGridSquareLabelColor(IColor color)
                             throws IOException,
                                    AutomationException
The color used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGridSquareLabelStyle

int getGridSquareLabelStyle()
                            throws IOException,
                                   AutomationException
The style used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelStyle

void setGridSquareLabelStyle(int style)
                             throws IOException,
                                    AutomationException
The style used to display the grid square labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
style - A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridSquareBoundarySymbol

ILineSymbol getGridSquareBoundarySymbol()
                                        throws IOException,
                                               AutomationException
The line symbol used to display the boundaries of the grid squares.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGridSquareBoundarySymbol

void setGridSquareBoundarySymbol(ILineSymbol symbol)
                                 throws IOException,
                                        AutomationException
The line symbol used to display the boundaries of the grid squares.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getInteriorTickSymbol

ILineSymbol getInteriorTickSymbol()
                                  throws IOException,
                                         AutomationException
The line symbol used to show interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setInteriorTickSymbol

void setInteriorTickSymbol(ILineSymbol symbol)
                           throws IOException,
                                  AutomationException
The line symbol used to show interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getInteriorTickLength

double getInteriorTickLength()
                             throws IOException,
                                    AutomationException
The length of the interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setInteriorTickLength

void setInteriorTickLength(double lengthPts)
                           throws IOException,
                                  AutomationException
The length of the interior grid ticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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