com.esri.arcgis.system
Interface IRateFormat

All Superinterfaces:
Serializable
All Known Implementing Classes:
RateFormat

public interface IRateFormat
extends Serializable

Provides access to members that format rates.

Description

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

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

Remarks

The string defined in the RateString property is appended to the format returned from the ValueToString method.

The value in the RateFactor property is divided into the ValueToString argument value. For example, ValueToString(300) with a RateFactor of 3 returns a formatted string of 100. The corresponding StringToValue method also uses this property. The value in its argument is multiplied by the value in the RateFactor property when StringToValue converts the number back. To obtain the numerical value that was used as an argument to the ValueToString method, make sure the RateFactor property is the same as it was when the ValueToString method was originally used.

When To Use

Use the IRateFormat interface to format numeric values according to a given rate factor.

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
 double getRateFactor()
          The rate factor applied to the ValueToSring and StringToValue methods.
 String getRateString()
          The label appended to the formatted rate number.
 void setRateFactor(double factor)
          The rate factor applied to the ValueToSring and StringToValue methods.
 void setRateString(String str)
          The label appended to the formatted rate number.
 

Method Detail

setRateFactor

void setRateFactor(double factor)
                   throws IOException,
                          AutomationException
The rate factor applied to the ValueToSring and StringToValue methods.

Description

The RateFactor property sets or returns a value (default: 1000) that is used as a divisor in the ValueToString method and as a multiplier in the StringToValue method in the associated INumberFormat interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRateFactor

double getRateFactor()
                     throws IOException,
                            AutomationException
The rate factor applied to the ValueToSring and StringToValue methods.

Description

The RateFactor property sets or returns a value (default: 1000) that is used as a divisor in the ValueToString method and as a multiplier in the StringToValue method in the associated INumberFormat interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRateString

void setRateString(String str)
                   throws IOException,
                          AutomationException
The label appended to the formatted rate number.

Description

The RateString property sets or returns a string value (default: null) that is appended to the formatted output returned from the ValueToString method in the associated INumberFormat interface. The StringToValue method strips the RateString out and returns only the numerical value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRateString

String getRateString()
                     throws IOException,
                            AutomationException
The label appended to the formatted rate number.

Description

The RateString property sets or returns a string value (default: null) that is appended to the formatted output returned from the ValueToString method in the associated INumberFormat interface. The StringToValue method strips the RateString out and returns only the numerical value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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