CreateAreaUnit(String,Double) Method

Convenience method to quickly create a custom AreaUnit instance.

Syntax

C#
Visual Basic (Declaration)

public static AreaUnit CreateAreaUnit( 
   string name,
   double conversionFactor
)

Public Overloads Shared Function CreateAreaUnit( _
   ByVal name As String, _
   ByVal conversionFactor As Double _
) As AreaUnit

Parameters

name: Name for the area unit
conversionFactor: Conversion factor. Square meters per unit

Return Value

An AreaUnit.

Example

try
{

  var myFactoryCodeInit = AreaUnit.CreateAreaUnit(109439);     // 109439 is the factory code for square miles

  var myWktUnit = AreaUnit.CreateAreaUnit("HECTARE_AREAUNIT[\"H\",10000.0]");

  var myCustomUnit = AreaUnit.CreateAreaUnit("myAreaUnit", 12);
}
catch (ArgumentException)
{
  // ArgumentException will be thrown by CreateAreaUnit in the following scenarios
  // - if the factory code used is a non-areal factory code  (i.e. it corresponds to degrees which is an angular unit code)
  // - if the factory code used is invalid (i.e. it is negative or doesn't correspond to any factory code)
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 7

Reference

AreaUnit Class
AreaUnit Members
Overload List