CreateAreaUnit(String) Method

In This Topic

Convenience method to create a AreaUnit from well-known test. This method is useful for creating custom units.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Shared Function CreateAreaUnit( _
   ByVal unitWkt As String _
) As AreaUnit

public static AreaUnit CreateAreaUnit( 
   string unitWkt
)

Parameters

unitWkt: Well-known text of the unit.

Return Value

An AreaUnit.

Example

AreaUnit - Create an AreaUnit

{
  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 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

AreaUnit Class
AreaUnit Members
Overload List

Send feedback