com.esri.arcgis.system
Interface IAngleFormat

All Superinterfaces:
Serializable
All Known Implementing Classes:
AngleFormat

public interface IAngleFormat
extends Serializable

Provides access to members that format angles.

Description

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

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

Remarks

If the AngleInDegrees property is not set the same as the DisplayDegrees property (both of these are Boolean [True/False] properties), a radian-to-degree conversion (or vice versa) will take place when the ValueToString method formats the value.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True. If AngleInDegrees is False, the argument is assumed to be a radian value.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. A degree symbol () is also appended to the resulting formatted number. If DisplayDegrees is False, the formatted number is a radian value and no degree symbol is appended.

The corresponding StringToValue method also uses these two properties. To obtain the numerical value that was used as a parameter to the ValueToString method, make sure the AngleInDegrees and DisplayDegrees properties are set are the same as they were when the ValueToString method was used. These settings may seem like they work in reverse when using the StringToValue method, but if you consider that StringToValue is intended to obtain numerical values from formatted strings, this makes more sense.

When To Use

Use the IAngleFormat interface to format numbers that represent angles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

Method Summary
 boolean isAngleInDegrees()
          Indicates if the ValueToString argument is in degrees.
 boolean isDisplayDegrees()
          Indicates if the formatted number is an angle in degrees.
 void setAngleInDegrees(boolean deg)
          Indicates if the ValueToString argument is in degrees.
 void setDisplayDegrees(boolean deg)
          Indicates if the formatted number is an angle in degrees.
 

Method Detail

setAngleInDegrees

void setAngleInDegrees(boolean deg)
                       throws IOException,
                              AutomationException
Indicates if the ValueToString argument is in degrees.

Description

The AngleInDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the ingoing parameter value is in degrees or radians.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True.

The settings for AngleInDegrees are:

Setting Description

False

(Default) The ValueToString argument is assumed to be a radian value.

True

The ValueToString argument is assumed to be a degree value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
deg - The deg (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

isAngleInDegrees

boolean isAngleInDegrees()
                         throws IOException,
                                AutomationException
Indicates if the ValueToString argument is in degrees.

Description

The AngleInDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the ingoing parameter value is in degrees or radians.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True.

The settings for AngleInDegrees are:

Setting Description
False (Default) The ValueToString argument is assumed to be a radian value.
True The ValueToString argument is assumed to be a degree value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The deg
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

setDisplayDegrees

void setDisplayDegrees(boolean deg)
                       throws IOException,
                              AutomationException
Indicates if the formatted number is an angle in degrees.

Description

The DisplayDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the resulting formatted expression is in degrees or radians.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. If DisplayDegrees is False, the formatted number is a radian value.

The settings for DisplayDegrees are:

Setting Description

False

(Default) The resulting format is a radian value. A degree symbol is not appended.

True

The resulting format is a degree value. A degree symbol () is appended to the format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
deg - The deg (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

isDisplayDegrees

boolean isDisplayDegrees()
                         throws IOException,
                                AutomationException
Indicates if the formatted number is an angle in degrees.

Description

The DisplayDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the resulting formatted expression is in degrees or radians.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. If DisplayDegrees is False, the formatted number is a radian value.

The settings for DisplayDegrees are:

Setting Description
False (Default) The resulting format is a radian value. A degree symbol is not appended.
True The resulting format is a degree value. A degree symbol () is appended to the format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The deg
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