com.esri.arcgis.system
Interface ILatLonFormat

All Superinterfaces:
Serializable
All Known Implementing Classes:
LatLonFormat

public interface ILatLonFormat
extends Serializable

Provides access to members that format Latitudes and Longitudes.

Description

The members in the ILatLonFormat interface define how the ValueToString method in the associated INumberFormat interface formats numbers.

The LatLonFormat coclass also inherits the INumericFormat interface, so both these interface's properties determine how numbers are formatted.

When To Use

Use the ILatLonFormat interface to format numbers that represent a latitude or longitude.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, IDMSGridLabel, esriDMSGridLabelType, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

Method Summary
 void getDMS(double value, int[] degrees, int[] minutes, double[] seconds)
          Returns the degrees, minutes, and seconds for a lat/lon number.
 boolean isShowDirections()
          Indicates if a directional letter (N-S-E-W) is appended to the formatted number.
 boolean isShowZeroMinutes()
          Indicates if zero minutes are included in formatted output.
 boolean isShowZeroSeconds()
          Indicates if zero seconds are included in formatted output.
 void setIsLatitude(boolean rhs1)
          Indicates if a formatted number is a latitude or not.
 void setShowDirections(boolean show)
          Indicates if a directional letter (N-S-E-W) is appended to the formatted number.
 void setShowZeroMinutes(boolean show)
          Indicates if zero minutes are included in formatted output.
 void setShowZeroSeconds(boolean show)
          Indicates if zero seconds are included in formatted output.
 

Method Detail

setShowDirections

void setShowDirections(boolean show)
                       throws IOException,
                              AutomationException
Indicates if a directional letter (N-S-E-W) is appended to the formatted number.

Description

The ShowDirections property sets or returns an indicator that tells whether to append a directional letter designation (N, S, E, or W) when the ValueToString method in the associated INumberFormat interface formats numbers.

The settings for ShowDirections are:

Setting Description

False

(Default) A directional letter designation is not appended to the format, for example, 270.

True

A directional letter designation is appended to the format, for example, 270E.

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.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, IDMSGridLabel, esriDMSGridLabelType, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

isShowDirections

boolean isShowDirections()
                         throws IOException,
                                AutomationException
Indicates if a directional letter (N-S-E-W) is appended to the formatted number.

Description

The ShowDirections property sets or returns an indicator that tells whether to append a directional letter designation (N, S, E, or W) when the ValueToString method in the associated INumberFormat interface formats numbers.

The settings for ShowDirections are:

Setting Description

False

(Default) A directional letter designation is not appended to the format, for example, 270.

True

A directional letter designation is appended to the format, for example, 270E.

Remarks

As an alternative, the ShowPlusSign property from INumericFormat can be used to show similar information since the LatLonFormat coclass also supports this interface.

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.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, IDMSGridLabel, esriDMSGridLabelType, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

setIsLatitude

void setIsLatitude(boolean rhs1)
                   throws IOException,
                          AutomationException
Indicates if a formatted number is a latitude or not.

Description

The IsLatitude property sets an indicator that tells whether the curvature of the coordinate system causes latitude labels to be placed on top or below the dataframe border, or for longitude labels that appear to the right or left of the dataframe border. It also determines the directional label appended to the format when the ValueToString method in the associated INumberFormat interface formats numbers.

The settings for ShowDirections are:

Setting Description

False

(Default) Latitude labels are placed on top of the dataframe border. Longitude labels are placed to the left of the dataframe border.

If ShowDirections is True, a directional letter designation of either E or W is appended to the format, for example, 23E.

True

Latitude labels are placed below the dataframe border. Longitude labels are placed to the right of the dataframe border.

If ShowDirections is True, a directional letter designation of either N or S is appended to the format, for example, 17N.

Remarks

When used with the IDMSGridLabel interface, it sets an indicator to specify that latitude labels will be placed on top of the data frame border, and longitude labels will be placed to the left of the data frame border. If True, the directional letter will be either N or S; with IDMSGridLabel, latitude labels are placed below the data frame border and longitude labels are placed to the right.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, IDMSGridLabel, esriDMSGridLabelType, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

getDMS

void getDMS(double value,
            int[] degrees,
            int[] minutes,
            double[] seconds)
            throws IOException,
                   AutomationException
Returns the degrees, minutes, and seconds for a lat/lon number.

Description

The GetDMS method returns the degrees, minutes, and seconds values for a given decimal degree latitudinal or longitudinal value.

To use it you should pass in the input decimal degree value and also pass in three double values representing the output degrees, minutes, and seconds that will be populated by the method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
degrees - The degrees (out: use single element array)
minutes - The minutes (out: use single element array)
seconds - The seconds (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILatLonFormat2, IDMSGridLabel.getLabelType(), CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, IDMSGridLabel, esriDMSGridLabelType, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

setShowZeroMinutes

void setShowZeroMinutes(boolean show)
                        throws IOException,
                               AutomationException
Indicates if zero minutes are included in formatted output.

Description

The ShowZeroMinutes property sets or returns an indicator that tells whether or not a zero value in the minutes location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.

The settings for ShowZeroMinutes are:

Setting Description

False

(Default) Zero values in the minutes location are not shown, for example 17N .

True

Zero values in the minutes location are shown, for example 170'N .

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.
See Also:
ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

isShowZeroMinutes

boolean isShowZeroMinutes()
                          throws IOException,
                                 AutomationException
Indicates if zero minutes are included in formatted output.

Description

The ShowZeroMinutes property sets or returns an indicator that tells whether or not a zero value in the minutes location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.

The settings for ShowZeroMinutes are:

Setting Description

False

(Default) Zero values in the minutes location are not shown, for example 17N.

True

Zero values in the minutes location are shown, for example 170'N.

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.
See Also:
ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

setShowZeroSeconds

void setShowZeroSeconds(boolean show)
                        throws IOException,
                               AutomationException
Indicates if zero seconds are included in formatted output.

Description

The ShowZeroSeconds property sets or returns an indicator that tells whether or not a zero value in the seconds location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.

The settings for ShowZeroSeconds are:

Setting Description

False

(Default) Zero values in the seconds location are not shown, for example 17N .

True

Zero values in the seconds location are shown, for example 170'0"N .

Remarks

If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.

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.
See Also:
ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

isShowZeroSeconds

boolean isShowZeroSeconds()
                          throws IOException,
                                 AutomationException
Indicates if zero seconds are included in formatted output.

Description

The ShowZeroSeconds property sets or returns an indicator that tells whether or not a zero value in the seconds location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.

The settings for ShowZeroSeconds are:

Setting Description

False

(Default) Zero values in the seconds location are not shown, for example 17N .

True

Zero values in the seconds location are shown, for example 170'0"N .

Remarks

If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.

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.
See Also:
ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat