Interface INumericFormat

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll

Provides access to members that format numbers.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("7E4F4710-8E54-11D2-AAD8-000000000000")]
public interface INumericFormat

Remarks

The format produced with the NumericFormat coclass object is determined solely on the INumericFormat interface property settings. Formats produced with other objects listed under CoClasses depend on two interface's property settings. These objects inherit the INumericFormat interface in addition to their own default interface.

Properties

AlignmentOption

The alignment option applied to the ValueToString method.

esriNumericAlignmentEnum AlignmentOption { get; set; }

Property Value

esriNumericAlignmentEnum

AlignmentWidth

The alignment width applied to the ValueToString method.

int AlignmentWidth { get; set; }

Property Value

int

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.

RoundingOption

The rounding option applied to the ValueToString method.

esriRoundingOptionEnum RoundingOption { get; set; }

Property Value

esriRoundingOptionEnum

RoundingValue

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

int RoundingValue { get; set; }

Property Value

int

ShowPlusSign

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

bool ShowPlusSign { get; set; }

Property Value

bool

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.

UseSeparator

Indicates if formatted numbers contain digit grouping symbols.

bool UseSeparator { get; set; }

Property Value

bool

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.

ZeroPad

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

bool ZeroPad { get; set; }

Property Value

bool

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.