|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.system.PercentageFormat
public class PercentageFormat
An object for formatting numbers in a percentage format.
PercentageFormat is the IPercentageFormat interface coclass whose members determine how the ValueToString method in the associated INumberFormat interface formats numbers in a percentage format.
PercentageFormat also inherits the INumericFormat interface, so both these interface's properties determine how numbers are formatted.
The PercentageFormat coclass allows the conversion between values and strings that represent percentages. For example, 56 is formatted to 56%, with an optional conversion from a fraction to a percentage, for example, 0.5 to 50%.
ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
,
Serialized FormConstructor Summary | |
---|---|
PercentageFormat()
Constructs a PercentageFormat using ArcGIS Engine. |
|
PercentageFormat(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. PercentageFormat thePercentageFormat = (PercentageFormat) obj; |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
int |
getAlignmentOption()
The alignment option applied to the ValueToString method. |
int |
getAlignmentWidth()
The alignment width applied to the ValueToString method. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
int |
getRoundingOption()
The rounding option applied to the ValueToString method. |
int |
getRoundingValue()
The rounding value, whose meaning depends on the rounding option. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
double |
increment(double value)
Increments a value according to the numbers format. |
boolean |
isAdjustPercentage()
Indicates if ValueToString agument is treated as a fraction or a percentage. |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isShowPlusSign()
Indicates if formatted numbers contain a plus sign for positive numbers. |
boolean |
isUseSeparator()
Indicates if formatted numbers contain digit grouping symbols. |
boolean |
isZeroPad()
Indicates if formatted numbers contain padded zeros to the right of the decimal. |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAdjustPercentage(boolean adjust)
Indicates if ValueToString agument is treated as a fraction or a percentage. |
void |
setAlignmentOption(int option)
The alignment option applied to the ValueToString method. |
void |
setAlignmentWidth(int width)
The alignment width applied to the ValueToString method. |
void |
setRoundingOption(int pption)
The rounding option applied to the ValueToString method. |
void |
setRoundingValue(int value)
The rounding value, whose meaning depends on the rounding option. |
void |
setShowPlusSign(boolean show)
Indicates if formatted numbers contain a plus sign for positive numbers. |
void |
setUseSeparator(boolean sep)
Indicates if formatted numbers contain digit grouping symbols. |
void |
setZeroPad(boolean pad)
Indicates if formatted numbers contain padded zeros to the right of the decimal. |
double |
stringToValue(String str)
Converts a formatted string to a numeric value. |
String |
valueToString(double value)
Converts a numeric value to a formatted string. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public PercentageFormat() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic PercentageFormat(Object obj) throws IOException
PercentageFormat thePercentageFormat = (PercentageFormat) obj;
obj
to PercentageFormat
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String valueToString(double value) throws IOException, AutomationException
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.
valueToString
in interface INumberFormat
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public double stringToValue(String str) throws IOException, AutomationException
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.
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).
stringToValue
in interface INumberFormat
str
- The str (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setRoundingOption(int pption) throws IOException, AutomationException
The RoundingOption property sets or returns the rounding option to be used when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for RoundingOption are:
Setting | Description |
esriRoundNumberOfDecimals |
(Default) Numbers are rounded to the number of decimal places defined in the RoundingValue property. If ZeroPad is also set True, decimal zeros are appended at the right up to the number of places indicated in the RoundingValue property. |
esriRoundNumberOfSignificantDigits |
Numbers are rounded to the number of significant digits indicated in the RoundingValue property. To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345. |
setRoundingOption
in interface INumericFormat
pption
- A com.esri.arcgis.system.esriRoundingOptionEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public int getRoundingOption() throws IOException, AutomationException
The RoundingOption property sets or returns the rounding option to be used when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for RoundingOption are:
Setting | Description |
esriRoundNumberOfDecimals |
(Default) Numbers are rounded to the number of decimal places defined in the RoundingValue property. If ZeroPad is also set True, decimal zeros are appended at the right up to the number of places indicated in the RoundingValue property. |
esriRoundNumberOfSignificantDigits |
Numbers are rounded to the number of significant digits indicated in the RoundingValue property. To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345. |
getRoundingOption
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setRoundingValue(int value) throws IOException, AutomationException
The RoundingValue property sets or returns the number of decimal places or significant digits (default: 6) to round a number to when the ValueToString method in the associated INumberFormat interface formats numbers.
setRoundingValue
in interface INumericFormat
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public int getRoundingValue() throws IOException, AutomationException
The RoundingValue property sets or returns the number of decimal places or significant digits (default: 6) to round a number to when the ValueToString method in the associated INumberFormat interface formats numbers.
getRoundingValue
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setAlignmentOption(int option) throws IOException, AutomationException
The AlignmentOption property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface how to align formatted numbers
The settings for AlignmentOption are:
Setting | Description |
esriAlignRight |
(Default) Numbers are aligned to the right. If the AlignmentWidth property is wider than the resulting formatted number, spaces are padded at the left to make the output AlignmentWidth characters wide. If the formatted number is wider than AlignmentWidth, the number is not truncated (the same as it would be if AlignmentOption were set to esriAlignLeft). |
esriAlignLeft |
Numbers are aligned to the left. No spaces are padded either at the left or right. If AlignmentOption is set to esriAlignLeft, the AlignmentWidth property is ignored. |
setAlignmentOption
in interface INumericFormat
option
- A com.esri.arcgis.system.esriNumericAlignmentEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public int getAlignmentOption() throws IOException, AutomationException
The AlignmentOption property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface how to align formatted numbers. For example, the value 0.34, formatted as a string with an AlignmentWidth of 5, is returned as 0.34 with an AlignmentOption of esriAlignRight and 0.34 with an AlignmentOption of esriAlignLeft.
The settings for AlignmentOption are:
Setting | Description |
esriAlignRight |
(Default) Numbers are aligned to the right. If the AlignmentWidth property is wider than the resulting formatted number, spaces are padded at the left to make the output AlignmentWidth characters wide. If the formatted number is wider than AlignmentWidth, the number is not truncated (the same as it would be if AlignmentOption were set to esriAlignLeft). |
esriAlignLeft |
Numbers are aligned to the left. No spaces are padded either at the left or right. If AlignmentOption is set to esriAlignLeft, the AlignmentWidth property is ignored. |
getAlignmentOption
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setAlignmentWidth(int width) throws IOException, AutomationException
The AlignmentWidth property sets or returns the width (default: 12) of the resulting string the ValueToString method in the associated INumberFormat interface produces.
If the AlignmentOption property is set to esriAlignRight, the formatted number will be AlignmentWidth characters wide, padding spaces to the left of the number as needed. If AlignmentOption = esriAlignLeft, the AlignmentWidth property is ignored.
If AlignmentOption = esriAlignRight, make sure AlignmentWidth is set wide enough to handle the resulting formatted number. If it is not, the number will not be truncated, but the length of the formatted number will be longer than the AlignmentWidth.
setAlignmentWidth
in interface INumericFormat
width
- The width (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public int getAlignmentWidth() throws IOException, AutomationException
The AlignmentWidth property sets or returns the width (default: 12) of the resulting string the ValueToString method in the associated INumberFormat interface produces.
If the AlignmentOption property is set to esriAlignRight, the formatted number will be AlignmentWidth characters wide, padding spaces to the left of the number as needed. If AlignmentOption = esriAlignLeft, the AlignmentWidth property is ignored. The width includes plus signs and any decimal points. For example, +1,234.56 has a width of 9.
If AlignmentOption = esriAlignRight, make sure AlignmentWidth is set wide enough to handle the resulting formatted number. If it is not, the number will not be truncated, but the length of the formatted number will be longer than the AlignmentWidth.
getAlignmentWidth
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setUseSeparator(boolean sep) throws IOException, AutomationException
The UseSeparator property sets or returns an indicator that tells whether to include a digit grouping symbol when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for UseSeparator are:
Setting | Description |
False |
(Default) Numbers are formatted without a digit grouping symbol, for example, 1234567.89. |
True |
Numbers are formatted with a digit grouping symbol, for example, 1,234,567.89. |
Numbers are formatted using the current regional settings defined for the system at runtime. To change the separator symbol or where the separator appears in the formatted number, change the settings on the Number tab of Control Panel's Regional Settings applet.
setUseSeparator
in interface INumericFormat
sep
- The sep (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public boolean isUseSeparator() throws IOException, AutomationException
The UseSeparator property sets or returns an indicator that tells whether to include a digit grouping symbol when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for UseSeparator are:
Setting | Description |
False |
(Default) Numbers are formatted without a digit grouping symbol, for example, 1234567.89. |
True |
Numbers are formatted with a digit grouping symbol, for example, 1,234,567.89. |
Numbers are formatted using the current regional settings defined for the system at runtime. To change the separator symbol or where the separator appears in the formatted number, change the settings on the Number tab of Control Panel's Regional Settings applet.
isUseSeparator
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setZeroPad(boolean pad) throws IOException, AutomationException
The ZeroPad property sets or returns an indicator that tells whether to pad zeros at the right of the decimal when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ZeroPad are:
Setting | Description |
False |
(Default) Numbers are formatted without padding decimal zeros. The last decimal digit is a non-zero digit. |
True |
Decimal zeros or significant digit zeros are appended at the right of the decimal point up to the number of places indicated in the RoundingValue property. The RoundingOption setting determines whether decimal zeros or significant digit zeros are appended. |
To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345.
setZeroPad
in interface INumericFormat
pad
- The pad (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public boolean isZeroPad() throws IOException, AutomationException
The ZeroPad property sets or returns an indicator that tells whether to pad zeros at the right of the decimal when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ZeroPad are:
Setting | Description |
False |
(Default) Numbers are formatted without padding decimal zeros. The last decimal digit (to the right of the decimal point) is a non-zero digit. |
True |
Decimal zeros or significant digit zeros are appended at the right of the decimal point up to the number of places indicated in the RoundingValue property. The RoundingOption setting determines whether decimal zeros or significant digit zeros are appended. |
To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345.
isZeroPad
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setShowPlusSign(boolean show) throws IOException, AutomationException
The ShowPlusSign property sets or returns an indicator that tells whether or not a plus sign symbol is used for positive numbers when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowPlusSign are:
Setting | Description |
False |
(Default) Positive numbers and zero values are formatted without a plus sign. Negative values are formatted with a minus (-) sign. |
True |
Positive numbers are formatted with a plus (+) sign. Zero values are formatted without a plus sign. Negative numbers are formatted with a minus (-) sign. |
Using ShowPlusSign can be useful in conjunction with IFormattedGridLabel, where a user might not know if the number is above or below the Equator, or east or west of the Central Meridian.
Also see the ShowDirections property in ILatLonFormat.
setShowPlusSign
in interface INumericFormat
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public boolean isShowPlusSign() throws IOException, AutomationException
The ShowPlusSign property sets or returns an indicator that tells whether or not a plus sign symbol (+) is to be prefixed to positive numbers when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowPlusSign are:
Setting |
Description |
False |
(Default) Positive numbers and zero values are formatted without a plus sign. Negative values are formatted with a minus (-) sign. |
True |
Positive numbers are formatted with a plus (+) sign. Zero values are formatted without a plus sign. Negative numbers are formatted with a minus (-) sign. |
Using ShowPlusSign can be useful in conjunction with IFormattedGridLabel, where a user might not know if the number is above or below the Equator, or east or west of the Central Meridian.
Also see the ShowDirections property in ILatLonFormat.
isShowPlusSign
in interface INumericFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public void setAdjustPercentage(boolean adjust) throws IOException, AutomationException
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. |
setAdjustPercentage
in interface IPercentageFormat
adjust
- The adjust (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public boolean isAdjustPercentage() throws IOException, AutomationException
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. |
isAdjustPercentage
in interface IPercentageFormat
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILatLonFormat2
,
CustomNumberFormat
,
IRateFormat
,
IAngleFormat
,
NumericFormat
,
LatLonFormat
,
CurrencyFormat
,
INumericFormat
,
IFractionFormat
,
RateFormat
,
IScientificNumberFormat
,
ICustomNumberFormat
,
ILatLonFormat
,
IPercentageFormat
,
INumberFormat
,
ScientificFormat
,
FractionFormat
,
PercentageFormat
,
AngleFormat
public double increment(double value) throws IOException, AutomationException
The Increment method reacts differently depending on the number format object used and how that object is configured. A NumericFormat configured for a specific number of decimal places will increment to the last decimal place. For example, if two decimal places are specified, 22.533 would increment to 22.54; if the object is configured for two significant digits, 22.533 would increment to 24. For an AngleFormat, the input value is converted to the display format first then the same rules apply as for a NumericFormat.
increment
in interface INumberFormatOperations
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |