com.esri.arcgis.system
Interface INumberFormat

All Superinterfaces:

Serializable

All Known Implementing Classes:

AngleFormat, CurrencyFormat, CustomNumberFormat, DirectionFormat, FractionFormat, LatLonFormat, NumericFormat, PercentageFormat, RateFormat, ScientificFormat

public interface INumberFormat
extends Serializable

Provides access to members that format numbers.

Description

The INumberFormat interface exposes the two number formatting methods used by several interfaces and coclass objects. The ValueToString method formats numerical values in a variety of formats depending on the interface used and its property settings. The StringToValue method returns values from formatted strings.

Remarks

In some cases, the format produced by the ValueToString method depends on two interface's property settings. These are the coclass objects that inherit the INumericFormat interface in addition to their own default interface. These objects are the AngleFormat, LatLonFormat, PercentageFormat, and RateFormat.

When To Use

Use the ValueToString method to format numbers with any of the objects listed under CoClasses below. Use the StringToValue method to convert formatted strings to numeric values.

Product Availability

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

See Also:

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

Method Summary

double	stringToValue(String str) Converts a formatted string to a numeric value.
String	valueToString(double value) Converts a numeric value to a formatted string.

Method Detail

valueToString

String valueToString(double value)
                     throws IOException,
                            AutomationException

Converts a numeric value to a formatted string.

Description

The ValueToString method expresses a numeric value as a formatted string. The string is formatted based on the property settings of the number formatting interface that is used. See the particular number formatting interface you're interested in under See Also above for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Returns:

The str

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

stringToValue

double stringToValue(String str)
                     throws IOException,
                            AutomationException

Converts a formatted string to a numeric value.

Description

The StringToValue method obtains a numerical value from a formatted string. The string doesn't necessarily need to have been formatted with the ValueToString method, but the string needs to look like it would be if it was formatted with the associated interface's implementation of the ValueToString method. See the particular number formatting interface you're interested in under See Also above for more information.

Remarks

When using the StringToValue method to obtain a ValueToString argument value, the properties in the associated interface must be set the same as they were when the ValueToString method was used. This applies in cases where ValueToString may perform a numerical conversion (in the IAngleFormat, IFractionFormat, IPercentageFormat, and IRateFormat interfaces).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

str - The str (in)

Returns:

The value

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