Class LatLonFormatClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("7E4F471D-8E54-11D2-AAD8-000000000000")]
public class LatLonFormatClass : LatLonFormat, INumberFormat, INumericFormat, INumberFormatOperations, ILatLonFormat, ILatLonFormat2, IClone, IPersistStream, IPersist
Inheritance
LatLonFormatClass
Implements
Inherited Members

Constructors

LatLonFormatClass()

public LatLonFormatClass()

Explicit Interface Implementations

AlignmentOption

The alignment option applied to the ValueToString method.

virtual esriNumericAlignmentEnum AlignmentOption { get; set; }

Returns

esriNumericAlignmentEnum

AlignmentWidth

The alignment width applied to the ValueToString method.

virtual int AlignmentWidth { get; set; }

Returns

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.

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetDMS(double, out int, out int, out double)

Obtains the degrees, minutes, and seconds for a lat/lon number.

virtual void GetDMS(double Value, out int degrees, out int Minutes, out double Seconds)

Parameters

Value double
degrees int
Minutes int
Seconds double

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

ILatLonFormat2_GetDMS(double, out int, out int, out double)

Obtains the degrees, minutes, and seconds for a lat/lon number.

virtual void ILatLonFormat2_GetDMS(double Value, out int degrees, out int Minutes, out double Seconds)

Parameters

Value double
degrees int
Minutes int
Seconds double

ILatLonFormat2_IsLatitude

Indicates if a formatted number is a latitude or not.

virtual bool ILatLonFormat2_IsLatitude { get; set; }

Returns

bool

Remarks

When used with the IDMSGridLabel interface, it sets an indicator to specify that latitude labels will be placed on top of the data frame border, and longitude labels will be placed to the left of the data frame border. If True, the directional letter will be either N or S; with IDMSGridLabel, latitude labels are placed below the data frame border and longitude labels are placed to the right.

ILatLonFormat2_ShowDirections

Indicates if a directional letter (N-S-E-W) is appended to the formatted number.

virtual bool ILatLonFormat2_ShowDirections { get; set; }

Returns

bool

Remarks

As an alternative, the ShowPlusSign property from INumericFormat can be used to show similar information since the LatLonFormat coclass also supports this interface.

ILatLonFormat2_ShowZeroMinutes

Indicates if zero minutes are included in formatted output.

virtual bool ILatLonFormat2_ShowZeroMinutes { get; set; }

Returns

bool

ILatLonFormat2_ShowZeroSeconds

Indicates if zero seconds are included in formatted output.

virtual bool ILatLonFormat2_ShowZeroSeconds { get; set; }

Returns

bool

Remarks

If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.

IPersistStream_GetClassID(out Guid)

virtual void IPersistStream_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

Increment(double)

Increments a value according to the numbers format.

virtual double Increment(double Value)

Parameters

Value double

Returns

double

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

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

IsLatitude

Indicates if a formatted number is a latitude or not.

virtual bool IsLatitude { set; }

Returns

bool

Remarks

When used with the IDMSGridLabel interface, it sets an indicator to specify that latitude labels will be placed on top of the data frame border, and longitude labels will be placed to the left of the data frame border. If True, the directional letter will be either N or S; with IDMSGridLabel, latitude labels are placed below the data frame border and longitude labels are placed to the right.

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

RoundingOption

The rounding option applied to the ValueToString method.

virtual esriRoundingOptionEnum RoundingOption { get; set; }

Returns

esriRoundingOptionEnum

RoundingValue

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

virtual int RoundingValue { get; set; }

Returns

int

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

ShowDirections

Indicates if a directional letter (N-S-E-W) is appended to the formatted number.

virtual bool ShowDirections { get; set; }

Returns

bool

Remarks

As an alternative, the ShowPlusSign property from INumericFormat can be used to show similar information since the LatLonFormat coclass also supports this interface.

ShowPlusSign

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

virtual bool ShowPlusSign { get; set; }

Returns

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.

ShowZeroMinutes

Indicates if zero minutes are included in formatted output.

virtual bool ShowZeroMinutes { get; set; }

Returns

bool

ShowZeroSeconds

Indicates if zero seconds are included in formatted output.

virtual bool ShowZeroSeconds { get; set; }

Returns

bool

Remarks

If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.

StringToValue(string)

Converts a formatted string to a numeric value.

virtual double StringToValue(string str)

Parameters

str string

Returns

double

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

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.

ValueToString(double)

Converts a numeric value to a formatted string.

virtual string ValueToString(double Value)

Parameters

Value double

Returns

string

ZeroPad

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

virtual bool ZeroPad { get; set; }

Returns

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.