Gets the default FormatOptions for a unit type.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since: 2014

Syntax

C#
[ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")] public FormatOptions GetFormatOptions( UnitType unitType )

[ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")]
public FormatOptions GetFormatOptions(
	UnitType unitType
)

Visual Basic

Visual Basic
<ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")> _ Public Function GetFormatOptions ( _ unitType As UnitType _ ) As FormatOptions

<ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")> _
Public Function GetFormatOptions ( _
	unitType As UnitType _
) As FormatOptions

Visual C++

Visual C++
[ObsoleteAttribute(L"This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")] public: FormatOptions^ GetFormatOptions( UnitType unitType )

[ObsoleteAttribute(L"This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `GetFormatOptions(ForgeTypeId)` overload instead.")]
public:
FormatOptions^ GetFormatOptions(
	UnitType unitType
)

Parameters

unitType: Type: Autodesk.Revit.DB UnitType
The unit type.

Return Value

A copy of the FormatOptions.

Exceptions

Exception	Condition
Autodesk.Revit.Exceptions ArgumentException	unitType is an invalid unit type. See UnitUtils.IsValidUnitType() and UnitUtils.GetValidUnitTypes().
Autodesk.Revit.Exceptions ArgumentOutOfRangeException	A value passed for an enumeration argument is not a member of that enumeration

GetFormatOptions Method

Syntax

Parameters

Return Value

Exceptions

See Also

Put AI to work inside Revit.