An object for formatting numbers in an angle format.
Product Availability
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.
Supported Platforms
Interfaces
| Interfaces | Description |
|---|---|
| IAngleFormat | Provides access to members that format angles. |
| IClone | Provides access to members that control cloning of objects. |
| IDocumentVersionSupportGEN | Provides access to extend the IObjectStream interface with methods to hande saving objects that did not exist in previous versions of the software. |
| INumberFormat | Provides access to members that format numbers. |
| INumberFormatOperations | Provides access to common operations on formatted numbers. |
| INumericFormat | Provides access to members that format numbers. |
| IPersist (esriSystem) | Defines the single method GetClassID, which is designed to supply the CLSID of an object that can be stored persistently in the system. IPersist is the base interface for three other interfaces: IPersistStorage, IPersistStream, and IPersistFile. |
| IPersistStream |
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.
See Also
ILatLonFormat2 Interface | RateFormat Class | IFractionFormat Interface | ICustomNumberFormat Interface | IAngleFormat Interface | ScientificFormat Class | INumberFormat Interface | AngleFormat Class | LatLonFormat Class | INumericFormat Interface | PercentageFormat Class | CustomNumberFormat Class | IRateFormat Interface | IPercentageFormat Interface | NumericFormat Class | CurrencyFormat Class | ILatLonFormat Interface | IScientificNumberFormat Interface | FractionFormat Class