com.esri.arcgis.system
Class AngleFormat

java.lang.Object
  com.esri.arcgis.system.AngleFormat

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAngleFormat, IClone, IDocumentVersionSupportGEN, INumberFormat, INumberFormatOperations, INumericFormat, IPersist, IPersistStream, Externalizable, Serializable

public class AngleFormat
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INumberFormat, INumericFormat, INumberFormatOperations, IAngleFormat, IClone, IPersist, IPersistStream, IDocumentVersionSupportGEN, Externalizable

An object for formatting numbers in an angle format.

Description

AngleFormat is the IAngleFormat interface coclass whose members determine how the ValueToString method in the associated INumberFormat interface formats numbers in an angular format.

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

The AngleFormat object is used for formatting numeric values that represent angles, such as
69°. It also allows the conversion between radians and degrees.

Remarks

If the AngleInDegrees property is not set the same as the DisplayDegrees property (both of these are Boolean [True/False] properties), a radian-to-degree conversion or vice versa will take place when the ValueToString method formats the number.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True. If AngleInDegrees is False, the argument is assumed to be a radian value.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. A degree symbol (°) is also appended to the resulting formatted number. If DisplayDegrees is False, the formatted number is a radian value and no degree symbol is appended.

The corresponding StringToValue method also uses these two properties. To obtain the numerical value that was used as a parameter to the ValueToString method, make sure the AngleInDegrees and DisplayDegrees properties are set the same as they were when the ValueToString method was used. These settings may seem like they work in reverse when using the StringToValue method, but if you consider that StringToValue is intended to obtain numerical values from formatted strings, this makes more sense.

The DisplayDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the resulting formatted expression is in degrees or radians. If this property is set to False, the default, then the resulting format is a radian value, and a degree symbol is not appended. If the property is set to True, however, the resulting format is displayed as a degree value with a degree symbol appended to it.

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, Serialized Form

Constructor Summary

AngleFormat()
Constructs a AngleFormat using ArcGIS Engine.

AngleFormat(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AngleFormat theAngleFormat = (AngleFormat) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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	isAngleInDegrees() Indicates if the ValueToString argument is in degrees.
void	isDirty() isDirty
boolean	isDisplayDegrees() Indicates if the formatted number is an angle in degrees.
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	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
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	setAlignmentOption(int option) The alignment option applied to the ValueToString method.
void	setAlignmentWidth(int width) The alignment width applied to the ValueToString method.
void	setAngleInDegrees(boolean deg) Indicates if the ValueToString argument is in degrees.
void	setDisplayDegrees(boolean deg) Indicates if the formatted number is an angle in degrees.
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

AngleFormat

public AngleFormat()
            throws IOException,
                   UnknownHostException

Constructs a AngleFormat using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AngleFormat

public AngleFormat(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AngleFormat theAngleFormat = (AngleFormat) obj;

Construct a AngleFormat using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AngleFormat.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

valueToString

public 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

Specified by:

valueToString in interface INumberFormat

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

public 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

Specified by:

stringToValue in interface INumberFormat

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

setRoundingOption

public void setRoundingOption(int pption)
                       throws IOException,
                              AutomationException

The rounding option applied to the ValueToString method.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRoundingOption in interface INumericFormat

Parameters:

pption - A com.esri.arcgis.system.esriRoundingOptionEnum constant (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

getRoundingOption

public int getRoundingOption()
                      throws IOException,
                             AutomationException

The rounding option applied to the ValueToString method.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRoundingOption in interface INumericFormat

Returns:

A com.esri.arcgis.system.esriRoundingOptionEnum constant

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

setRoundingValue

public void setRoundingValue(int value)
                      throws IOException,
                             AutomationException

The rounding value, whose meaning depends on the rounding option.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRoundingValue in interface INumericFormat

Parameters:

value - The value (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

getRoundingValue

public int getRoundingValue()
                     throws IOException,
                            AutomationException

The rounding value, whose meaning depends on the rounding option.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRoundingValue in interface INumericFormat

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

setAlignmentOption

public void setAlignmentOption(int option)
                        throws IOException,
                               AutomationException

The alignment option applied to the ValueToString method.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAlignmentOption in interface INumericFormat

Parameters:

option - A com.esri.arcgis.system.esriNumericAlignmentEnum constant (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

getAlignmentOption

public int getAlignmentOption()
                       throws IOException,
                              AutomationException

The alignment option applied to the ValueToString method.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAlignmentOption in interface INumericFormat

Returns:

A com.esri.arcgis.system.esriNumericAlignmentEnum constant

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

setAlignmentWidth

public void setAlignmentWidth(int width)
                       throws IOException,
                              AutomationException

The alignment width applied to the ValueToString method.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAlignmentWidth in interface INumericFormat

Parameters:

width - The width (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

getAlignmentWidth

public int getAlignmentWidth()
                      throws IOException,
                             AutomationException

The alignment width applied to the ValueToString method.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAlignmentWidth in interface INumericFormat

Returns:

The width

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

setUseSeparator

public void setUseSeparator(boolean sep)
                     throws IOException,
                            AutomationException

Indicates if formatted numbers contain digit grouping symbols.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseSeparator in interface INumericFormat

Parameters:

sep - The sep (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

isUseSeparator

public boolean isUseSeparator()
                       throws IOException,
                              AutomationException

Indicates if formatted numbers contain digit grouping symbols.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseSeparator in interface INumericFormat

Returns:

The sep

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

setZeroPad

public void setZeroPad(boolean pad)
                throws IOException,
                       AutomationException

Indicates if formatted numbers contain padded zeros to the right of the decimal.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZeroPad in interface INumericFormat

Parameters:

pad - The pad (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

isZeroPad

public boolean isZeroPad()
                  throws IOException,
                         AutomationException

Indicates if formatted numbers contain padded zeros to the right of the decimal.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isZeroPad in interface INumericFormat

Returns:

The pad

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

setShowPlusSign

public void setShowPlusSign(boolean show)
                     throws IOException,
                            AutomationException

Indicates if formatted numbers contain a plus sign for positive numbers.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowPlusSign in interface INumericFormat

Parameters:

show - The show (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

isShowPlusSign

public boolean isShowPlusSign()
                       throws IOException,
                              AutomationException

Indicates if formatted numbers contain a plus sign for positive numbers.

Description

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.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowPlusSign in interface INumericFormat

Returns:

The show

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

increment

public double increment(double value)
                 throws IOException,
                        AutomationException

Increments a value according to the numbers format.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

increment in interface INumberFormatOperations

Parameters:

value - The value (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngleInDegrees

public void setAngleInDegrees(boolean deg)
                       throws IOException,
                              AutomationException

Indicates if the ValueToString argument is in degrees.

Description

The AngleInDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the ingoing parameter value is in degrees or radians.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True.

The settings for AngleInDegrees are:

Setting	Description
False	(Default) The ValueToString argument is assumed to be a radian value.
True	The ValueToString argument is assumed to be a degree value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAngleInDegrees in interface IAngleFormat

Parameters:

deg - The deg (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

isAngleInDegrees

public boolean isAngleInDegrees()
                         throws IOException,
                                AutomationException

Indicates if the ValueToString argument is in degrees.

Description

The AngleInDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the ingoing parameter value is in degrees or radians.

AngleInDegrees has to do with the ValueToString argument value. If the value is in degrees, set AngleInDegrees True.

The settings for AngleInDegrees are:

Setting	Description
False	(Default) The ValueToString argument is assumed to be a radian value.
True	The ValueToString argument is assumed to be a degree value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAngleInDegrees in interface IAngleFormat

Returns:

The deg

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

setDisplayDegrees

public void setDisplayDegrees(boolean deg)
                       throws IOException,
                              AutomationException

Indicates if the formatted number is an angle in degrees.

Description

The DisplayDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the resulting formatted expression is in degrees or radians.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. If DisplayDegrees is False, the formatted number is a radian value.

The settings for DisplayDegrees are:

Setting	Description
False	(Default) The resulting format is a radian value. A degree symbol is not appended.
True	The resulting format is a degree value. A degree symbol (°) is appended to the format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayDegrees in interface IAngleFormat

Parameters:

deg - The deg (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

isDisplayDegrees

public boolean isDisplayDegrees()
                         throws IOException,
                                AutomationException

Indicates if the formatted number is an angle in degrees.

Description

The DisplayDegrees property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface whether or not the resulting formatted expression is in degrees or radians.

DisplayDegrees has to do with the ValueToString result. If you want the resulting formatted number to be a degree value, set DisplayDegrees True. If DisplayDegrees is False, the formatted number is a radian value.

The settings for DisplayDegrees are:

Setting	Description
False	(Default) The resulting format is a radian value. A degree symbol is not appended.
True	The resulting format is a degree value. A degree symbol (°) is appended to the format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDisplayDegrees in interface IAngleFormat

Returns:

The deg

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

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException