•  

SetUnitsFormatOptions Method

Sets the FormatOptions to optionally override the default settings in the Units class for the units value.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2017 Subscription Update

Syntax

C# 
public void SetUnitsFormatOptions(
	FormatOptions formatOptions
)
Visual Basic 
Public Sub SetUnitsFormatOptions ( _
	formatOptions As FormatOptions _
)
Visual C++ 
public:
void SetUnitsFormatOptions(
	FormatOptions^ formatOptions
)

Parameters

formatOptions
Type: Autodesk.Revit.DB FormatOptions
The FormatOptions.

Remarks

See the UnitType property to determine the unit type of this dimension style.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException The display unit in formatOptions is not a valid display unit for the unit type of this DimensionType, or the rounding method in formatOptions is not set to Nearest. See UnitUtils.IsValidDisplayUnit(UnitType, DisplayUnitType), UnitUtils.GetValidDisplayUnits(UnitType) and FormatOptions.RoundingMethod.
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →