com.esri.arcgis.carto
Interface IDMSGridLabel3

All Superinterfaces:

Serializable

All Known Implementing Classes:

DMSGridLabel

public interface IDMSGridLabel3
extends Serializable

Provides access to members that control the DMS Grid Label.

Product Availability

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

Method Summary

int	getLabelType() The type of the DMS grid label.
ILatLonFormat	getLatLonFormat() The format with which the latitudes and longitudes are displayed.
IColor	getMinutesColor() The color used to display the minutes.
Font	getMinutesFont() The font used to display the minutes.
double	getMinutesFontSize() The font size used to display the minutes.
IColor	getSecondsColor() The color used to display the seconds.
Font	getSecondsFont() The font used to display the seconds.
double	getSecondsFontSize() The font size used to display the seconds.
boolean	isAbbreviateLabels() Indicates if the DMS labels should be abbreviated when the value is not a whole degree.
boolean	isShowMinusSign() Indicates if the DMS labels should show the minus sign (if format is not showing direction).
boolean	isShowZeroMinutes() Indicates if zero minutes are shown.
boolean	isShowZeroSeconds() Indicates if zero seconds are shown.
void	setAbbreviateLabels(boolean abbrev) Indicates if the DMS labels should be abbreviated when the value is not a whole degree.
void	setLabelType(int labelType) The type of the DMS grid label.
void	setLatLonFormat(ILatLonFormat format) The format with which the latitudes and longitudes are displayed.
void	setMinutesColor(IColor color) The color used to display the minutes.
void	setMinutesFont(Font font) The font used to display the minutes.
void	setMinutesFontSize(double size) The font size used to display the minutes.
void	setSecondsColor(IColor color) The color used to display the seconds.
void	setSecondsFont(Font font) The font used to display the seconds.
void	setSecondsFontSize(double size) The font size used to display the seconds.
void	setShowMinusSign(boolean showMinus) Indicates if the DMS labels should show the minus sign (if format is not showing direction).
void	setShowZeroMinutes(boolean show) Indicates if zero minutes are shown.
void	setShowZeroSeconds(boolean show) Indicates if zero seconds are shown.

Method Detail

getLabelType

int getLabelType()
                 throws IOException,
                        AutomationException

The type of the DMS grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDMSGridLabelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelType

void setLabelType(int labelType)
                  throws IOException,
                         AutomationException

The type of the DMS grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

labelType - A com.esri.arcgis.carto.esriDMSGridLabelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLatLonFormat

ILatLonFormat getLatLonFormat()
                              throws IOException,
                                     AutomationException

The format with which the latitudes and longitudes are displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.ILatLonFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLatLonFormat

void setLatLonFormat(ILatLonFormat format)
                     throws IOException,
                            AutomationException

The format with which the latitudes and longitudes are displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowZeroMinutes

boolean isShowZeroMinutes()
                          throws IOException,
                                 AutomationException

Indicates if zero minutes are shown.

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.

setShowZeroMinutes

void setShowZeroMinutes(boolean show)
                        throws IOException,
                               AutomationException

Indicates if zero minutes are shown.

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.

isShowZeroSeconds

boolean isShowZeroSeconds()
                          throws IOException,
                                 AutomationException

Indicates if zero seconds are shown.

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.

setShowZeroSeconds

void setShowZeroSeconds(boolean show)
                        throws IOException,
                               AutomationException

Indicates if zero seconds are shown.

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.

getMinutesFont

Font getMinutesFont()
                    throws IOException,
                           AutomationException

The font used to display the minutes.

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.

setMinutesFont

void setMinutesFont(Font font)
                    throws IOException,
                           AutomationException

The font used to display the minutes.

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.

getMinutesColor

IColor getMinutesColor()
                       throws IOException,
                              AutomationException

The color used to display the minutes.

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.

setMinutesColor

void setMinutesColor(IColor color)
                     throws IOException,
                            AutomationException

The color used to display the minutes.

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.

getSecondsFont

Font getSecondsFont()
                    throws IOException,
                           AutomationException

The font used to display the seconds.

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.

setSecondsFont

void setSecondsFont(Font font)
                    throws IOException,
                           AutomationException

The font used to display the seconds.

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.

getSecondsColor

IColor getSecondsColor()
                       throws IOException,
                              AutomationException

The color used to display the seconds.

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.

setSecondsColor

void setSecondsColor(IColor color)
                     throws IOException,
                            AutomationException

The color used to display the seconds.

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.

isAbbreviateLabels

boolean isAbbreviateLabels()
                           throws IOException,
                                  AutomationException

Indicates if the DMS labels should be abbreviated when the value is not a whole degree.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The abbrev

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbbreviateLabels

void setAbbreviateLabels(boolean abbrev)
                         throws IOException,
                                AutomationException

Indicates if the DMS labels should be abbreviated when the value is not a whole degree.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

abbrev - The abbrev (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinutesFontSize

double getMinutesFontSize()
                          throws IOException,
                                 AutomationException

The font size used to display the minutes.

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.

setMinutesFontSize

void setMinutesFontSize(double size)
                        throws IOException,
                               AutomationException

The font size used to display the minutes.

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.

getSecondsFontSize

double getSecondsFontSize()
                          throws IOException,
                                 AutomationException

The font size used to display the seconds.

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.

setSecondsFontSize

void setSecondsFontSize(double size)
                        throws IOException,
                               AutomationException

The font size used to display the seconds.

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.

isShowMinusSign

boolean isShowMinusSign()
                        throws IOException,
                               AutomationException

Indicates if the DMS labels should show the minus sign (if format is not showing direction).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The showMinus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowMinusSign

void setShowMinusSign(boolean showMinus)
                      throws IOException,
                             AutomationException

Indicates if the DMS labels should show the minus sign (if format is not showing direction).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

showMinus - The showMinus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.