Namespace: Autodesk.Revit.DB Class: UnitUtils

UnitUtils.GetTypeCatalogStringForUnit

Method

Description:
Gets the string used in type catalogs to identify a given unit.

Syntax

public static string GetTypeCatalogStringForUnit(
	ForgeTypeId unitTypeId
)

Public Shared Function GetTypeCatalogStringForUnit ( 
	unitTypeId As ForgeTypeId
) As String

public:
static String^ GetTypeCatalogStringForUnit(
	ForgeTypeId^ unitTypeId
)

static member GetTypeCatalogStringForUnit : 
        unitTypeId : ForgeTypeId -> string

Parameters

Parameter	Type	Description
unitTypeId	ForgeTypeId	Identifier of the unit.

Return Value

Type	Description
String	The type catalog string, or an empty string if the unit cannot be used in type catalogs.

Exceptions

Exception	Condition
ArgumentException	unitTypeId is not a unit identifier. See UnitUtils.IsUnit(ForgeTypeId) and UnitUtils.GetUnitTypeId(DisplayUnitType).
ArgumentNullException	A non-optional argument was null