This document is archived and information here might be outdated.  Recommended version.


ICadastralUnitTools.FormattedArea Property (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (GeoDatabaseExtensions)  

ICadastralUnitTools.FormattedArea Property

Converts a metric area value into a formated area string. isUSFoot applies to imperial output. If decimalPlaces=-1, the decimal places is automatically calculated from areaSQMeters.

[Visual Basic .NET]
Public Function get_FormattedArea ( _
    ByVal areaSQMeters As Double, _
    ByVal eOutputAreaTypeDisplay As esriCadastralAreaUnits, _
    ByVal isUSFoot As Boolean, _
    ByVal decimalPlaces As Integer _
) As String
[C#]
public string get_FormattedArea (
    double areaSQMeters,
    esriCadastralAreaUnits eOutputAreaTypeDisplay,
    bool isUSFoot,
    int decimalPlaces
);
[C++]
HRESULT get_FormattedArea(
  double areaSQMeters,
  esriCadastralAreaUnits eOutputAreaTypeDisplay,
  VARIANT_BOOL isUSFoot,
  long decimalPlaces,
  System.String* formatedArea
);
[C++]

Parameters areaSQMeters [in]
areaSQMeters is a parameter of type double eOutputAreaTypeDisplay [in]
eOutputAreaTypeDisplay is a parameter of type esriCadastralAreaUnits isUSFoot [in]
isUSFoot is a parameter of type bool decimalPlaces [in]
decimalPlaces is a parameter of type long formatedArea [out, retval]
formatedArea is a parameter of type BSTR*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also

ICadastralUnitTools Interface