Class AngleFormatClass
- Namespace
- ESRI.ArcGIS.esriSystem
- Assembly
- ESRI.Server.System.dll
[Guid("7E4F471E-8E54-11D2-AAD8-000000000000")]
[ClassInterface(ClassInterfaceType.None)]
public class AngleFormatClass : AngleFormat, INumberFormat, INumericFormat, INumberFormatOperations, IAngleFormat, IClone, IPersistStream, IPersist, IDocumentVersionSupportGEN
- Inheritance
-
AngleFormatClass
- Implements
- Inherited Members
Constructors
AngleFormatClass()
public AngleFormatClass()
Explicit Interface Implementations
AlignmentOption
The alignment option applied to the ValueToString method.
virtual esriNumericAlignmentEnum AlignmentOption { get; set; }
Returns
AlignmentWidth
The alignment width applied to the ValueToString method.
virtual int AlignmentWidth { get; set; }
Returns
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.
AngleInDegrees
Indicates if the ValueToString argument is in degrees.
virtual bool AngleInDegrees { get; set; }
Returns
Assign(IClone)
Assigns the properties of src to the receiver.
virtual void Assign(IClone src)
Parameters
srcIClone
Clone()
Clones the receiver and assigns the result to *clone.
virtual IClone Clone()
Returns
ConvertToSupportedObject(esriArcGISVersion)
Convert the object to another object that is supported.
virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
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.
DisplayDegrees
Indicates if the formatted number is an angle in degrees.
virtual bool DisplayDegrees { get; set; }
Returns
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
IPersistStream_GetClassID(out Guid)
virtual void IPersistStream_GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
Increment(double)
Increments a value according to the numbers format.
virtual double Increment(double Value)
Parameters
Valuedouble
Returns
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.
IsDirty()
virtual void IsDirty()
IsEqual(IClone)
Indicates if the receiver and other have the same properties.
virtual bool IsEqual(IClone other)
Parameters
otherIClone
Returns
IsIdentical(IClone)
Indicates if the receiver and other are the same object.
virtual bool IsIdentical(IClone other)
Parameters
otherIClone
Returns
IsSupportedAtVersion(esriArcGISVersion)
Is this object valid at the given document version.
virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
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.
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
RoundingOption
The rounding option applied to the ValueToString method.
virtual esriRoundingOptionEnum RoundingOption { get; set; }
Returns
RoundingValue
The rounding value, whose meaning depends on the rounding option.
virtual int RoundingValue { get; set; }
Returns
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
ShowPlusSign
Indicates if formatted numbers contain a plus sign for positive numbers.
virtual bool ShowPlusSign { get; set; }
Returns
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.
StringToValue(string)
Converts a formatted string to a numeric value.
virtual double StringToValue(string str)
Parameters
strstring
Returns
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).
UseSeparator
Indicates if formatted numbers contain digit grouping symbols.
virtual bool UseSeparator { get; set; }
Returns
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.
ValueToString(double)
Converts a numeric value to a formatted string.
virtual string ValueToString(double Value)
Parameters
Valuedouble
Returns
ZeroPad
Indicates if formatted numbers contain padded zeros to the right of the decimal.
virtual bool ZeroPad { get; set; }
Returns
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.