Class DirectionFormatClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("36D7E361-B440-4FEB-B2AC-FEDE1A2FD7A7")]
public class DirectionFormatClass : DirectionFormat, INumberFormat, INumberFormatOperations, IDirectionFormat, IDirectionFormatDestination, IAngularConverter2, IClone, IPersistStream, IPersist
Inheritance
DirectionFormatClass
Implements
Inherited Members

Constructors

DirectionFormatClass()

public DirectionFormatClass()

Explicit Interface Implementations

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

DecimalPlaces

The number of decimal digits in a seconds part of the formatted number.

virtual int DecimalPlaces { get; set; }

Returns

int

DestinationStringToValue(string)

Converts a formatted string to a numeric value using unit/type in destination and polar/radians as source

virtual double DestinationStringToValue(string str)

Parameters

str string

Returns

double

DestinationValueToString(double)

Converts a numeric value to a formatted string using unit/type in destination and polar/radians as source.

virtual string DestinationValueToString(double Value)

Parameters

Value double

Returns

string

DirectionType

Indicates the direction of the argument in ValueToString.

virtual esriDirectionType DirectionType { get; set; }

Returns

esriDirectionType

DirectionUnits

Indicates Direction Unit for the ValueToString argument.

virtual esriDirectionUnits DirectionUnits { get; set; }

Returns

esriDirectionUnits

DisplayFormat

Indicates how to display the direction value.

virtual esriDirectionFormatEnum DisplayFormat { get; set; }

Returns

esriDirectionFormatEnum

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

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

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

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

NegativeAngles

Allow an angle to be converted from one direction unit to another.

virtual bool NegativeAngles { get; set; }

Returns

bool

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

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).

ValueToString(double)

Converts a numeric value to a formatted string.

virtual string ValueToString(double Value)

Parameters

Value double

Returns

string