ITGIS_CSUnits.AsAreal method

Convert units as areal to string representation with proper units symbol.

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

Syntax

// C#
public WideString AsAreal(
  double _value,
  WordBool _prec,
  WideString _format
);

' VisualBasic
Public Function AsAreal(
  ByVal _value As Double,
  ByVal _prec As WordBool,
  ByVal _format As WideString
) As WideString

// Oxygene
public
  function AsAreal(
    _value : Double;
    _prec : WordBool;
    _format : WideString
  ) : WideString;

Name	Type	Description
_value	double Double	units in base metric
_prec	WordBool	if true then fixed decimal digits will be presented; if false then only significant digits (no trailing zeros) will be presented
_format	WideString	hint of how to present linear symbols: for example by providing 'sq. %s' linear symbols will be presented as '1 sq. km'

Type	Description
WideString	Units converted to string.

Linear units will be autoconverted to areal.

Units of returned string will be autoselected to choose the most adequate is unit is a type of TGIS_CSUnitsType.Auto.