TGIS_CSUnits.AsAreal method

Convert an areal value to a string representation with the appropriate unit symbol.

Available also on: Delphi | .NET | ActiveX | Python.

Syntax

// Java
public java.lang.String AsAreal(
  double _value,
  bool _prec,
  java.lang.String _format
);

// Oxygene
public
  function AsAreal(
    _value : Double;
    _prec : Boolean;
    _format : String
  ) : String;

Name	Type	Description
_value	double Double	Value in base areal units.
_prec	bool Boolean	If True, fixed decimal digits are used; if False, only significant digits are shown without trailing zeros.
_format	java.lang.String String	Formatting pattern for areal symbols, for example 'sq. %s' to produce values such as '1 sq. km'.

Type	Description
java.lang.String String	Formatted value with unit symbol.

Linear units are automatically converted to areal form.

If the unit type is TGIS_CSUnitsType.Auto, the returned string uses an automatically selected areal subunit.