com.esri.arcgis.system
Interface IPercentageFormat

All Superinterfaces:
Serializable
All Known Implementing Classes:
PercentageFormat

public interface IPercentageFormat
extends Serializable

Provides access to members that format percentages.

Description

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

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

When To Use

Use the IPercentageFormat interface to format numbers that represent percentages.

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 isAdjustPercentage()
          Indicates if ValueToString agument is treated as a fraction or a percentage.
 void setAdjustPercentage(boolean adjust)
          Indicates if ValueToString agument is treated as a fraction or a percentage.
 

Method Detail

setAdjustPercentage

void setAdjustPercentage(boolean adjust)
                         throws IOException,
                                AutomationException
Indicates if ValueToString agument is treated as a fraction or a percentage.

Description

The AdjustPercentage property sets or returns an indicator that tells how the ValueToString method's argument is treated in the associated INumberFormat interface.

The settings for AdjustPercentage are:

Setting Description

False

(Default) The argument to the ValueToString method is assumed to be a percentage. A percentage symbol (%) is appended to the value.

True

The argument to the ValueToString method is treated as a fraction. The value is multiplied by 100 and a percent symbol (%) is appended.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAdjustPercentage

boolean isAdjustPercentage()
                           throws IOException,
                                  AutomationException
Indicates if ValueToString agument is treated as a fraction or a percentage.

Description

The AdjustPercentage property allows the conversion to and from fractions and sets or returns an indicator that tells how the ValueToString method's argument is treated in the associated INumberFormat interface.

The settings for AdjustPercentage are:

Setting Description

False

(Default) The arguments to the ValueToString and StrinToValue methods are assumed to be in percentage format already. For ValueToString, a percentage symbol (%) is appended to the value, and for StringToValue, this is removed.

True

The argument to the ValueToString method is treated as a fraction. The value is multiplied by 100 and a percent symbol (%) is appended. For StringToValue, the output is converted to a fraction (from a percentage)—it is divided by 100, and any percentage symbol is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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