com.esri.arcgis.carto
Interface IMgrsGrid

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMgrsGridProxy, MgrsGrid

public interface IMgrsGrid
extends java.io.Serializable

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

Description: 'Provides access to members that control the properties of an MGRS grid.' 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	IID46240e54_b526_47f3_80a4_a7e2f2e1c262
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID46240e54_b526_47f3_80a4_a7e2f2e1c262

static final int IID46240e54_b526_47f3_80a4_a7e2f2e1c262

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

isShowGridSquareIdentifiers

boolean isShowGridSquareIdentifiers()
                                    throws java.io.IOException,
                                           AutomationException

Indicates if the square identifiers should be displayed.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowGridSquareIdentifiers

void setShowGridSquareIdentifiers(boolean show)
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the square identifiers should be displayed.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelFont

Font getGridSquareLabelFont()
                            throws java.io.IOException,
                                   AutomationException

The font used to display the grid square labels.

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelFont

void setGridSquareLabelFont(Font font)
                            throws java.io.IOException,
                                   AutomationException

The font used to display the grid square labels.

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:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelSize

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

The font size used to display the grid square labels.

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelSize

void setGridSquareLabelSize(double size)
                            throws java.io.IOException,
                                   AutomationException

The font size used to display the grid square labels.

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelColor

IColor getGridSquareLabelColor()
                               throws java.io.IOException,
                                      AutomationException

The color used to display the grid square labels.

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.

setGridSquareLabelColor

void setGridSquareLabelColor(IColor color)
                             throws java.io.IOException,
                                    AutomationException

The color used to display the grid square labels.

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareLabelStyle

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

The style used to display the grid square labels.

Returns:

A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareLabelStyle

void setGridSquareLabelStyle(int style)
                             throws java.io.IOException,
                                    AutomationException

The style used to display the grid square labels.

Parameters:

style - A com.esri.arcgis.carto.esriGridSquareLabelStyleEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGridSquareBoundarySymbol

ILineSymbol getGridSquareBoundarySymbol()
                                        throws java.io.IOException,
                                               AutomationException

The line symbol used to display the boundaries of the grid squares.

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGridSquareBoundarySymbol

void setGridSquareBoundarySymbol(ILineSymbol symbol)
                                 throws java.io.IOException,
                                        AutomationException

The line symbol used to display the boundaries of the grid squares.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInteriorTickSymbol

ILineSymbol getInteriorTickSymbol()
                                  throws java.io.IOException,
                                         AutomationException

The line symbol used to show interior grid ticks.

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInteriorTickSymbol

void setInteriorTickSymbol(ILineSymbol symbol)
                           throws java.io.IOException,
                                  AutomationException

The line symbol used to show interior grid ticks.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInteriorTickLength

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

The length of the interior grid ticks.

Returns:

The lengthPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInteriorTickLength

void setInteriorTickLength(double lengthPts)
                           throws java.io.IOException,
                                  AutomationException

The length of the interior grid ticks.

Parameters:

lengthPts - The lengthPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.