ArcObjects Library Reference  (System)    

IRateFormat Interface

Provides access to members that format rates.

Product Availability

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

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.

When To Use

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

Members

Description
Read/write property RateFactor The rate factor applied to the ValueToSring and StringToValue methods.
Read/write property RateString The label appended to the formatted rate number.

CoClasses that implement IRateFormat

CoClasses and Classes Description
RateFormat An object for formatting numbers in a rate format.

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.

See Also

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

Example

RateFormat Example