com.esri.arcgis.carto
Interface IDMSGridLabel

All Superinterfaces:
Serializable
All Known Subinterfaces:
IDMSGridLabel2
All Known Implementing Classes:
DMSGridLabel

public interface IDMSGridLabel
extends Serializable

Provides access to members that control the DMS Grid Label.

Superseded By

IDMSGridLabel3

Description

IDMSGridLabel is an interface for creating labels to display coordinate system information in various displays of degrees, minutes, and seconds, including as decimal degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), IDMSGridLabel, esriDMSGridLabelType, ILatLonFormat

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.
 IColor getSecondsColor()
          The color used to display the seconds.
 Font getSecondsFont()
          The font used to display the seconds.
 boolean isShowZeroMinutes()
          Indicates if zero minutes are shown.
 boolean isShowZeroSeconds()
          Indicates if zero seconds are shown.
 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 setSecondsColor(IColor color)
          The color used to display the seconds.
 void setSecondsFont(Font font)
          The font used to display the seconds.
 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.

Description

LabelType is the presentation type that the degrees, minutes, and seconds will be displayed in.

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.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), IDMSGridLabel, esriDMSGridLabelType, ILatLonFormat

setLabelType

void setLabelType(int labelType)
                  throws IOException,
                         AutomationException
The type of the DMS grid label.

Description

LabelType is the presentation type that the degrees, minutes, and seconds will be displayed in.

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.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), IDMSGridLabel, esriDMSGridLabelType, ILatLonFormat

getLatLonFormat

ILatLonFormat getLatLonFormat()
                              throws IOException,
                                     AutomationException
The format with which the latitudes and longitudes are displayed.

Description

LatLonFormat is the ILatLonFormat interface for the IDMSGridLabel .

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.

Description

LatLonFormat is the ILatLonFormat interface for the IDMSGridLabel .

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.

Description

ShowZeroMinutes is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroMinutes was set to False , but would be 30 00 if set to True .

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.

Description

ShowZeroMinutes is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroMinutes was set to False , but would be 30 00 if set to True .

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.

Description

ShowZeroSeconds is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroSeconds was set to False , but would be 30 00 00 if set to True .

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.

Description

ShowZeroSeconds is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroSeconds was set to False , but would be 30 00 00 if set to True .

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.

Description

MinutesFont is the font used to display the minutes value.

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.

Description

MinutesFont is the font used to display the minutes value.

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.

Description

MinutesColor is the color used to display the minutes value.

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.

Description

MinutesColor is the color used to display the minutes value.
.

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.

Description

SecondsFont is the font used to display the seconds value.

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.

Description

SecondsFont is the font used to display the seconds value.

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.

Description

SecondsColor is the color used to display the seconds value.

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.

Description

SecondsColor is the color used to display the seconds value.

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.