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


IDisplayTransformation.Units Property (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Display)  

IDisplayTransformation.Units Property

Units used by world coordinates.

[Visual Basic .NET]
Public Property Units As esriUnits

[C#]
public esriUnits Units {get; set;}

[C++]
HRESULT get_Units(
  esriUnits* unitsCode
);

[C++]
HRESULT put_Units(
  esriUnits unitsCode
);

[C++]

Parameters
unitsCode [out, retval]

  unitsCode is a parameter of type esriUnits*
unitsCode [in]

  unitsCode is a parameter of type esriUnits

Product Availability

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

Remarks

Units is the type of esriUnits used by the DisplayTransformation. For example, the Map object stores its map units in this property and the units are based on the current coordinate system.  See IMap::MapUnits for more details.  Also, the PageLayout's Page object stores its units in this property and it uses inches by default.  See IPage::Units for more details. 

You should not change the units of your Map or Page using this property.  Instead, use the related properties mentioned above.   Although setting the Map's or Page's Units property will set its DisplayTransform Units property, the reverse is not always true.

Setting the Units property fires the ITransformEvents::UnitsUpdated event.

See Also

IDisplayTransformation Interface